changedInput schema / properties / body / anyOf
Previous value: -[
- {
- "additionalProperties": false,
- "properties": {
- "agreement": {
- "additionalProperties": {},
- "properties": {
- "amendment_attributes": {
- "additionalProperties": false,
- "description": "Override amendment terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "amended_terms_attributes": {
- "additionalProperties": {
- "additionalProperties": false,
- "properties": {
- "description": {
- "type": "string"
- },
- "term": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "description": "Amended terms. Use string keys such as \"0\", \"1\".",
- "propertyNames": {
- "type": "string"
- },
- "type": "object"
- },
- "amendment_date": {
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "amendment_date_type": {
- "enum": [
- "signature",
- "date"
- ],
- "type": "string"
- },
- "framework_terms_type": {
- "type": "string"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "parent_agreement_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "underlying_agreement_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "underlying_agreement_type": {
- "type": "string"
- },
- "underlying_agreement_val": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "baa_attributes": {
- "additionalProperties": false,
- "description": "Override baa terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "aggregation_limitations_permitted": {
- "type": "boolean"
- },
- "aggregation_limitations_permitted_val": {
- "type": "string"
- },
- "breach_notification_unit": {
- "enum": [
- "hours",
- "business days",
- "calendar days"
- ],
- "type": "string"
- },
- "breach_notification_val": {
- "type": "number"
- },
- "business_associate_relationship_type": {
- "enum": [
- "provider",
- "company"
- ],
- "type": "string"
- },
- "deidentification_limitations_include_purpose": {
- "type": "boolean"
- },
- "deidentification_limitations_include_requirements": {
- "type": "boolean"
- },
- "deidentification_limitations_permitted": {
- "type": "boolean"
- },
- "deidentification_limitations_purpose_val": {
- "type": "string"
- },
- "deidentification_limitations_requirements_val": {
- "type": "string"
- },
- "designated_record_set_provider_maintains": {
- "type": "boolean"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_aggregation_limitations": {
- "type": "boolean"
- },
- "include_deidentification_limitations": {
- "type": "boolean"
- },
- "include_limitations": {
- "type": "boolean"
- },
- "include_offshore_limitations": {
- "type": "boolean"
- },
- "include_subcontract_limitations": {
- "type": "boolean"
- },
- "offshore_limitations_permitted": {
- "type": "boolean"
- },
- "offshore_limitations_permitted_val": {
- "type": "string"
- },
- "subcontract_limitations_include_notice": {
- "type": "boolean"
- },
- "subcontract_limitations_include_permission": {
- "type": "boolean"
- },
- "subcontract_limitations_notice_val": {
- "type": "string"
- },
- "subcontract_limitations_permission_val": {
- "type": "string"
- },
- "subcontract_limitations_permitted": {
- "type": "boolean"
- },
- "underlying_agreement_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "underlying_agreement_type": {
- "enum": [
- "internal",
- "external",
- "none"
- ],
- "type": "string"
- },
- "underlying_agreement_val": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "billing_email": {
- "description": "Email of the billing contact. Used when include_billing_info is true.",
- "format": "email",
- "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
- "type": "string"
- },
- "billing_name": {
- "description": "Name of the billing contact. Used when include_billing_info is true.",
- "type": "string"
- },
- "billing_workflow_type": {
- "description": "The type of billing workflow. Use \"link\" to provide a payment_link_url, or \"stripe\" for Stripe-managed billing.",
- "enum": [
- "link",
- "stripe"
- ],
- "type": "string"
- },
- "chosen_courts_country": {
- "description": "The country in which disputes will be resolved.",
- "type": "string"
- },
- "chosen_courts_region": {
- "description": "The state or region in which disputes will be resolved.",
- "type": "string"
- },
- "csa_attributes": {
- "additionalProperties": false,
- "description": "Override csa terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "customer_description": {
- "type": "string"
- },
- "effective_date": {
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "effective_date_marketplace": {
- "enum": [
- "AWS",
- "GCP",
- "Azure"
- ],
- "type": "string"
- },
- "effective_date_type": {
- "enum": [
- "signature",
- "date",
- "marketplace_acceptance"
- ],
- "type": "string"
- },
- "general_cap_amount": {
- "type": "number"
- },
- "general_cap_amount_type": {
- "enum": [
- "preceding",
- "base",
- "period"
- ],
- "type": "string"
- },
- "general_cap_period_currency": {
- "type": "number"
- },
- "general_cap_period_qty": {
- "type": "number"
- },
- "general_cap_preceding_amount": {
- "type": "number"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_acceptable_use_policy": {
- "type": "boolean"
- },
- "include_acceptable_use_policy_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_acceptable_use_policy_location": {
- "type": "string"
- },
- "include_acceptable_use_policy_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_additional_warranties": {
- "type": "boolean"
- },
- "include_additional_warranties_by_customer": {
- "type": "string"
- },
- "include_additional_warranties_by_provider": {
- "type": "string"
- },
- "include_additional_warranties_include_by_customer": {
- "type": "boolean"
- },
- "include_additional_warranties_include_by_provider": {
- "type": "boolean"
- },
- "include_ai_addendum": {
- "type": "boolean"
- },
- "include_ai_addendum_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_covered_claims": {
- "type": "boolean"
- },
- "include_covered_claims_customer_claims": {
- "type": "string"
- },
- "include_covered_claims_include_customer_claims": {
- "type": "boolean"
- },
- "include_covered_claims_include_provider_claims": {
- "type": "boolean"
- },
- "include_covered_claims_provider_claims": {
- "type": "string"
- },
- "include_dpa": {
- "type": "boolean"
- },
- "include_dpa_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_dpa_location": {
- "type": "string"
- },
- "include_dpa_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_increased_cap_amount": {
- "type": "boolean"
- },
- "include_increased_claims": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_confidentiality": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_confidentiality_negligence": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_privsec": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_privsec_negligence": {
- "type": "boolean"
- },
- "include_increased_claims_include_other": {
- "type": "boolean"
- },
- "include_increased_claims_indemnification_obligation": {
- "type": "boolean"
- },
- "include_increased_claims_other": {
- "type": "string"
- },
- "include_insurance_minimums": {
- "type": "boolean"
- },
- "include_insurance_minimums_add_customer": {
- "type": "boolean"
- },
- "include_insurance_minimums_add_customer_com_gen_liability": {
- "type": "boolean"
- },
- "include_insurance_minimums_add_customer_cyber_liability": {
- "type": "boolean"
- },
- "include_insurance_minimums_add_customer_errors_omissions": {
- "type": "boolean"
- },
- "include_insurance_minimums_additional_information": {
- "type": "boolean"
- },
- "include_insurance_minimums_additional_information_text": {
- "type": "string"
- },
- "include_insurance_minimums_cyber_liability_aggregate": {
- "type": "number"
- },
- "include_insurance_minimums_cyber_liability_minimum": {
- "type": "number"
- },
- "include_insurance_minimums_employer_liability_aggregate": {
- "type": "number"
- },
- "include_insurance_minimums_employer_liability_minimum": {
- "type": "number"
- },
- "include_insurance_minimums_general_liability_aggregate": {
- "type": "number"
- },
- "include_insurance_minimums_general_liability_minimum": {
- "type": "number"
- },
- "include_insurance_minimums_include_cyber_liability": {
- "type": "boolean"
- },
- "include_insurance_minimums_include_employer_liability": {
- "type": "boolean"
- },
- "include_insurance_minimums_include_general_liability": {
- "type": "boolean"
- },
- "include_insurance_minimums_include_workers_compensation": {
- "type": "boolean"
- },
- "include_publicity_rights": {
- "type": "boolean"
- },
- "include_publicity_rights_type": {
- "enum": [
- "public",
- "non-public"
- ],
- "type": "string"
- },
- "include_security_policy": {
- "type": "boolean"
- },
- "include_security_policy_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_security_policy_fedramp_auth": {
- "type": "boolean"
- },
- "include_security_policy_hipaa": {
- "type": "boolean"
- },
- "include_security_policy_hitrust": {
- "type": "boolean"
- },
- "include_security_policy_include_annual_maintenance": {
- "type": "boolean"
- },
- "include_security_policy_include_location": {
- "type": "boolean"
- },
- "include_security_policy_include_other": {
- "type": "boolean"
- },
- "include_security_policy_include_reasonable_efforts": {
- "type": "boolean"
- },
- "include_security_policy_iso27001": {
- "type": "boolean"
- },
- "include_security_policy_location": {
- "type": "string"
- },
- "include_security_policy_other": {
- "type": "string"
- },
- "include_security_policy_pci1": {
- "type": "boolean"
- },
- "include_security_policy_pci2": {
- "type": "boolean"
- },
- "include_security_policy_penetration_testing": {
- "type": "boolean"
- },
- "include_security_policy_soc2": {
- "type": "boolean"
- },
- "include_security_policy_soc2_type2": {
- "type": "boolean"
- },
- "include_security_policy_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_supercap": {
- "description": "CSA 3.0 renamed `include_increased_cap_amount` to `include_supercap`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_increased_cap_amount`. Sending the other spelling returns a 422.",
- "type": "boolean"
- },
- "include_uncapped_claims": {
- "description": "CSA 3.0 renamed `include_unlimited_claims` to `include_uncapped_claims`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims`. Sending the other spelling returns a 422.",
- "type": "boolean"
- },
- "include_uncapped_claims_breach_of_confidentiality": {
- "description": "CSA 3.0 renamed `include_unlimited_claims_breach_of_confidentiality` to `include_uncapped_claims_breach_of_confidentiality`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_breach_of_confidentiality`. Sending the other spelling returns a 422.",
- "type": "boolean"
- },
- "include_uncapped_claims_breach_of_confidentiality_negligence": {
- "description": "CSA 3.0 renamed `include_unlimited_claims_breach_of_confidentiality_negligence` to `include_uncapped_claims_breach_of_confidentiality_negligence`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_breach_of_confidentiality_negligence`. Sending the other spelling returns a 422.",
- "type": "boolean"
- },
- "include_uncapped_claims_breach_of_privsec": {
- "description": "CSA 3.0 renamed `include_unlimited_claims_breach_of_privsec` to `include_uncapped_claims_breach_of_privsec`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_breach_of_privsec`. Sending the other spelling returns a 422.",
- "type": "boolean"
- },
- "include_uncapped_claims_breach_of_privsec_negligence": {
- "description": "CSA 3.0 renamed `include_unlimited_claims_breach_of_privsec_negligence` to `include_uncapped_claims_breach_of_privsec_negligence`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_breach_of_privsec_negligence`. Sending the other spelling returns a 422.",
- "type": "boolean"
- },
- "include_uncapped_claims_include_other": {
- "description": "CSA 3.0 renamed `include_unlimited_claims_include_other` to `include_uncapped_claims_include_other`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_include_other`. Sending the other spelling returns a 422.",
- "type": "boolean"
- },
- "include_uncapped_claims_indemnification_obligation": {
- "description": "CSA 3.0 renamed `include_unlimited_claims_indemnification_obligation` to `include_uncapped_claims_indemnification_obligation`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_indemnification_obligation`. Sending the other spelling returns a 422.",
- "type": "boolean"
- },
- "include_uncapped_claims_other": {
- "description": "CSA 3.0 renamed `include_unlimited_claims_other` to `include_uncapped_claims_other`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_other`. Sending the other spelling returns a 422.",
- "type": "boolean"
- },
- "include_unlimited_claims": {
- "type": "boolean"
- },
- "include_unlimited_claims_breach_of_confidentiality": {
- "type": "boolean"
- },
- "include_unlimited_claims_breach_of_confidentiality_negligence": {
- "type": "boolean"
- },
- "include_unlimited_claims_breach_of_privsec": {
- "type": "boolean"
- },
- "include_unlimited_claims_breach_of_privsec_negligence": {
- "type": "boolean"
- },
- "include_unlimited_claims_include_other": {
- "type": "boolean"
- },
- "include_unlimited_claims_indemnification_obligation": {
- "type": "boolean"
- },
- "include_unlimited_claims_other": {
- "type": "string"
- },
- "increased_cap_amount_currency": {
- "type": "number"
- },
- "increased_cap_amount_period_currency": {
- "type": "number"
- },
- "increased_cap_amount_period_qty": {
- "type": "number"
- },
- "increased_cap_amount_qty": {
- "type": "number"
- },
- "increased_cap_amount_type": {
- "enum": [
- "qty",
- "currency",
- "period"
- ],
- "type": "string"
- },
- "provider": {
- "type": "string"
- },
- "supercap_currency": {
- "description": "CSA 3.0 renamed `increased_cap_amount_currency` to `supercap_currency`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `increased_cap_amount_currency`. Sending the other spelling returns a 422.",
- "type": "number"
- },
- "supercap_period_currency": {
- "description": "CSA 3.0 renamed `increased_cap_amount_period_currency` to `supercap_period_currency`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `increased_cap_amount_period_currency`. Sending the other spelling returns a 422.",
- "type": "number"
- },
- "supercap_period_qty": {
- "description": "CSA 3.0 renamed `increased_cap_amount_period_qty` to `supercap_period_qty`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `increased_cap_amount_period_qty`. Sending the other spelling returns a 422.",
- "type": "number"
- },
- "supercap_qty": {
- "description": "CSA 3.0 renamed `increased_cap_amount_qty` to `supercap_qty`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `increased_cap_amount_qty`. Sending the other spelling returns a 422.",
- "type": "number"
- },
- "supercap_type": {
- "description": "CSA 3.0 renamed `increased_cap_amount_type` to `supercap_type`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `increased_cap_amount_type`. Sending the other spelling returns a 422.",
- "type": "number"
- }
- },
- "type": "object"
- },
- "csa_order_form_attributes": {
- "additionalProperties": false,
- "description": "Override csa order form terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "additional_changes": {
- "type": "string"
- },
- "additional_parameters_or_limitations": {
- "type": "string"
- },
- "affiliates_as_users": {
- "type": "boolean"
- },
- "cloud_service_description": {
- "type": "string"
- },
- "consumption_units": {
- "type": "string"
- },
- "fee_amount": {
- "type": "number"
- },
- "fee_custom_unit": {
- "type": "string"
- },
- "fee_period": {
- "enum": [
- "Subscription Period",
- "month",
- "year",
- "User",
- "Custom unit"
- ],
- "type": "string"
- },
- "fees_attributes": {
- "additionalProperties": {
- "anyOf": [
- {
- "additionalProperties": false,
- "description": "Fees::Flat (fee_type \"flat\"). A fixed recurring fee, e.g. a platform subscription. Set type to \"Fees::Flat\" or fee_type to \"flat\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "Fixed amount in the order form's fees_currency, charged per fee_period. A plain amount, not cents: 20 means 20.00.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"flat\". Alternative to type.",
- "enum": [
- "flat"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Flat\". Optional when fee_type is set.",
- "enum": [
- "Fees::Flat"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Discount (fee_type \"discount\"). A discount, as a fixed amount or a percentage, applied forever, once, or for a number of months. Set type to \"Fees::Discount\" or fee_type to \"discount\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "Discount size: an amount in fees_currency when discount_type is fixed_amount (a plain amount, not cents: 20 means 20.00), or a percentage (e.g. 10 for 10%) when it is percentage.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "discount_duration_amount": {
- "description": "Number of months the discount applies. Required when discount_duration_type is multiple_months.",
- "type": "number"
- },
- "discount_duration_type": {
- "description": "How long the discount applies. multiple_months also needs discount_duration_amount.",
- "enum": [
- "forever",
- "once",
- "multiple_months"
- ],
- "type": "string"
- },
- "discount_type": {
- "description": "Whether cost is a currency amount or a percentage.",
- "enum": [
- "fixed_amount",
- "percentage"
- ],
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"discount\". Alternative to type.",
- "enum": [
- "discount"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Discount\". Optional when fee_type is set.",
- "enum": [
- "Fees::Discount"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Cost (fee_type \"cost\"). A per-unit fee: price per unit times quantity, e.g. seats. Set type to \"Fees::Cost\" or fee_type to \"cost\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "Price per unit in fees_currency. The row total is quantity x cost. A plain amount, not cents: 20 means 20.00.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"cost\". Alternative to type.",
- "enum": [
- "cost"
- ],
- "type": "string"
- },
- "quantity": {
- "description": "Number of units.",
- "type": "number"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Cost\". Optional when fee_type is set.",
- "enum": [
- "Fees::Cost"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Attachment (fee_type \"attachment\"). A fee described in an uploaded attachment instead of in the table. Set type to \"Fees::Attachment\" or fee_type to \"attachment\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "attachment_id": {
- "description": "ID of an attachment uploaded with upload-attachment.",
- "type": "string"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"attachment\". Alternative to type.",
- "enum": [
- "attachment"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Attachment\". Optional when fee_type is set.",
- "enum": [
- "Fees::Attachment"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Graduated (fee_type \"graduated\"). Tiered pricing, with the price set per tier in graduated_fee_tiers_attributes. Set type to \"Fees::Graduated\" or fee_type to \"graduated\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"graduated\". Alternative to type.",
- "enum": [
- "graduated"
- ],
- "type": "string"
- },
- "graduated_fee_tiers_attributes": {
- "additionalProperties": {
- "additionalProperties": false,
- "properties": {
- "flat_price": {
- "type": "number"
- },
- "price_per_unit": {
- "type": "string"
- },
- "upper_limit": {
- "type": "number"
- }
- },
- "type": "object"
- },
- "description": "Graduated fee tiers. Use string keys such as \"0\", \"1\".",
- "propertyNames": {
- "type": "string"
- },
- "type": "object"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Graduated\". Optional when fee_type is set.",
- "enum": [
- "Fees::Graduated"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Included (fee_type \"included\"). An item included at no charge. Set type to \"Fees::Included\" or fee_type to \"included\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"included\". Alternative to type.",
- "enum": [
- "included"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Included\". Optional when fee_type is set.",
- "enum": [
- "Fees::Included"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Metered (fee_type \"metered\"). Usage-based pricing, billed per unit used. Set type to \"Fees::Metered\" or fee_type to \"metered\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "Price per unit of usage in fees_currency. A plain amount, not cents: 20 means 20.00.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"metered\". Alternative to type.",
- "enum": [
- "metered"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Metered\". Optional when fee_type is set.",
- "enum": [
- "Fees::Metered"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::OneTime (fee_type \"one_time\"). A one-time charge, such as a setup fee. Set type to \"Fees::OneTime\" or fee_type to \"one_time\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "One-time amount in fees_currency, charged once rather than per fee_period. A plain amount, not cents: 20 means 20.00.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"one_time\". Alternative to type.",
- "enum": [
- "one_time"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::OneTime\". Optional when fee_type is set.",
- "enum": [
- "Fees::OneTime"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Text (fee_type \"text\"). A fee term described in free text. Set type to \"Fees::Text\" or fee_type to \"text\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"text\". Alternative to type.",
- "enum": [
- "text"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Text\". Optional when fee_type is set.",
- "enum": [
- "Fees::Text"
- ],
- "type": "string"
- }
- },
- "type": "object"
- }
- ]
- },
- "description": "Fee table rows, keyed by string index (\"0\", \"1\", ...). Replaces the template's fees when provided. Each row sets type or fee_type to pick the fee class. Amounts are in the order form's fees_currency and, for recurring fees, are charged per fee_period.",
- "examples": [
- {
- "0": {
- "cost": 2000,
- "description": "Platform subscription",
- "type": "Fees::Flat"
- }
- },
- {
- "0": {
- "cost": 50,
- "description": "Seats",
- "fee_type": "cost",
- "quantity": 10
- },
- "1": {
- "cost": 10,
- "description": "Launch discount",
- "discount_duration_amount": 3,
- "discount_duration_type": "multiple_months",
- "discount_type": "percentage",
- "fee_type": "discount"
- }
- }
- ],
- "propertyNames": {
- "type": "string"
- },
- "type": "object"
- },
- "fees_currency": {
- "enum": [
- "USD",
- "EUR",
- "GBP",
- "CAD",
- "AUD",
- "SGD",
- "ILS",
- "JPY",
- "CHF",
- "HKD"
- ],
- "type": "string"
- },
- "fees_include_fee_increase_upon_renewal": {
- "type": "boolean"
- },
- "fees_include_fee_increase_upon_renewal_fee": {
- "type": "number"
- },
- "fees_include_fee_increase_upon_renewal_type": {
- "enum": [
- "will",
- "may"
- ],
- "type": "string"
- },
- "fees_inclusive_of_taxes": {
- "type": "boolean"
- },
- "framework_terms_type": {
- "enum": [
- "new",
- "existing",
- "description"
- ],
- "type": "string"
- },
- "free_trial_days": {
- "type": "number"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_additional_changes": {
- "type": "boolean"
- },
- "include_additional_parameters_or_limitations": {
- "type": "boolean"
- },
- "include_consumption": {
- "type": "boolean"
- },
- "include_fees": {
- "type": "boolean"
- },
- "include_fees_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_fees_include_attachment": {
- "type": "boolean"
- },
- "include_fees_other": {
- "type": "boolean"
- },
- "include_fees_other_val": {
- "type": "string"
- },
- "include_fees_table": {
- "type": "boolean"
- },
- "include_fees_table_period": {
- "enum": [
- "Subscription Period",
- "month",
- "year",
- "User"
- ],
- "type": "string"
- },
- "include_free_trial": {
- "type": "boolean"
- },
- "include_max_users": {
- "type": "boolean"
- },
- "include_pilot_period": {
- "type": "boolean"
- },
- "include_pilot_period_duration_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_pilot_period_duration_type": {
- "enum": [
- "day",
- "week",
- "month"
- ],
- "type": "string"
- },
- "include_pilot_period_include_fees": {
- "type": "boolean"
- },
- "include_pilot_period_include_fees_amount": {
- "type": "number"
- },
- "include_pilot_period_include_modifications": {
- "type": "boolean"
- },
- "include_pilot_period_include_modifications_description": {
- "type": "string"
- },
- "include_product_support": {
- "type": "boolean"
- },
- "include_product_support_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_product_support_description": {
- "type": "string"
- },
- "include_product_support_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_professional_services": {
- "type": "boolean"
- },
- "include_professional_services_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_professional_services_custom_name": {
- "type": "string"
- },
- "include_professional_services_description": {
- "type": "string"
- },
- "include_professional_services_end_date": {
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "include_professional_services_fees_description": {
- "type": "string"
- },
- "include_professional_services_include_end_date": {
- "type": "boolean"
- },
- "include_professional_services_include_fees_description": {
- "type": "boolean"
- },
- "include_professional_services_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_sla": {
- "type": "boolean"
- },
- "include_sla_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_sla_description": {
- "type": "string"
- },
- "include_sla_include_response_time": {
- "type": "boolean"
- },
- "include_sla_include_response_time_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_sla_include_response_time_credit": {
- "type": "number"
- },
- "include_sla_include_response_time_duration": {
- "enum": [
- "hour",
- "day",
- "week",
- "month",
- "hours"
- ],
- "type": "string"
- },
- "include_sla_include_response_time_support_channel": {
- "type": "string"
- },
- "include_sla_include_target_uptime": {
- "type": "boolean"
- },
- "include_sla_maintenance_notice": {
- "type": "boolean"
- },
- "include_sla_maintenance_window": {
- "type": "boolean"
- },
- "include_sla_maintenance_window_type": {
- "enum": [
- "standard",
- "none"
- ],
- "type": "string"
- },
- "include_sla_standard_maintenance_notice_qty": {
- "type": "number"
- },
- "include_sla_standard_maintenance_notice_unit": {
- "enum": [
- "hour",
- "day",
- "week",
- "month"
- ],
- "type": "string"
- },
- "include_sla_standard_maintenance_window_end_time": {
- "type": "string"
- },
- "include_sla_standard_maintenance_window_friday": {
- "type": "boolean"
- },
- "include_sla_standard_maintenance_window_monday": {
- "type": "boolean"
- },
- "include_sla_standard_maintenance_window_saturday": {
- "type": "boolean"
- },
- "include_sla_standard_maintenance_window_start_time": {
- "type": "string"
- },
- "include_sla_standard_maintenance_window_sunday": {
- "type": "boolean"
- },
- "include_sla_standard_maintenance_window_thursday": {
- "type": "boolean"
- },
- "include_sla_standard_maintenance_window_time_zone": {
- "type": "string"
- },
- "include_sla_standard_maintenance_window_tuesday": {
- "type": "boolean"
- },
- "include_sla_standard_maintenance_window_wednesday": {
- "type": "boolean"
- },
- "include_sla_standard_target_uptime": {
- "type": "number"
- },
- "include_sla_type": {
- "enum": [
- "description",
- "standard",
- "attachment"
- ],
- "type": "string"
- },
- "include_subscription_start_date": {
- "type": "boolean"
- },
- "include_subscription_start_date_date": {
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "include_usage_review": {
- "type": "boolean"
- },
- "include_usage_review_val": {
- "type": "string"
- },
- "include_use_limitations": {
- "type": "boolean"
- },
- "include_use_limitations_val": {
- "type": "string"
- },
- "invoice_period": {
- "enum": [
- "monthly",
- "quarterly",
- "semiannually",
- "annually",
- "Custom unit",
- "Monthly",
- "Quarterly",
- "Semiannually",
- "Annually"
- ],
- "type": "string"
- },
- "invoice_period_custom_unit": {
- "type": "string"
- },
- "max_consumption": {
- "type": "number"
- },
- "max_users": {
- "type": "number"
- },
- "negotiations_allowed": {
- "description": "When true, the recipient can propose changes to the order form, even when the agreement-level `negotiations_allowed` is false. This only covers the order form.",
- "type": "boolean"
- },
- "order_date_date": {
- "type": "string"
- },
- "order_date_other": {
- "type": "string"
- },
- "order_date_type": {
- "enum": [
- "signature",
- "date",
- "other"
- ],
- "type": "string"
- },
- "payment_period": {
- "type": "number"
- },
- "payment_period_timeframe": {
- "enum": [
- "Customer's receipt of invoice",
- "date of invoice"
- ],
- "type": "string"
- },
- "payment_period_unit": {
- "enum": [
- "day(s)",
- "week(s)",
- "month(s)",
- "marketplace_acceptance"
- ],
- "type": "string"
- },
- "payment_process_automatic_frequency": {
- "enum": [
- "monthly",
- "quarterly",
- "semiannually",
- "annually"
- ],
- "type": "string"
- },
- "payment_process_type": {
- "enum": [
- "automatic",
- "invoice",
- "custom",
- "marketplace_acceptance"
- ],
- "type": "string"
- },
- "payment_process_type_custom_val": {
- "type": "string"
- },
- "payment_process_type_invoice_amount": {
- "type": "number"
- },
- "payment_process_type_invoice_custom_unit": {
- "type": "string"
- },
- "payment_process_type_invoice_duration": {
- "enum": [
- "day",
- "week",
- "month",
- "year",
- "day(s)",
- "week(s)",
- "month(s)",
- "year(s)"
- ],
- "type": "string"
- },
- "payment_process_type_invoice_duration_start": {
- "enum": [
- "Customer's receipt of invoice",
- "date of invoice"
- ],
- "type": "string"
- },
- "payment_process_type_invoice_type": {
- "enum": [
- "monthly",
- "quarterly",
- "semiannually",
- "annually",
- "Custom unit"
- ],
- "type": "string"
- },
- "pilot_period_stripe_product_id": {
- "type": "string"
- },
- "service_credits_attributes": {
- "additionalProperties": {
- "additionalProperties": false,
- "properties": {
- "credit": {
- "type": "number"
- },
- "max": {
- "type": "number"
- },
- "min": {
- "type": "number"
- }
- },
- "type": "object"
- },
- "description": "Service credits. Use string keys such as \"0\", \"1\".",
- "propertyNames": {
- "type": "string"
- },
- "type": "object"
- },
- "subscription_auto_renew": {
- "enum": [
- "days",
- "subscription_end"
- ],
- "type": "string"
- },
- "subscription_period": {
- "type": "number"
- },
- "subscription_period_unit": {
- "type": "string"
- },
- "subscription_renewal_notice_days": {
- "type": "number"
- },
- "subscription_start_date": {
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "subscription_start_date_type": {
- "enum": [
- "effective_date",
- "date"
- ],
- "type": "string"
- },
- "underlying_agreement_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "use_limitations_attributes": {
- "additionalProperties": {
- "additionalProperties": false,
- "properties": {
- "amount": {
- "type": "number"
- },
- "limitation_type": {
- "type": "string"
- },
- "unit": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "description": "Use limitations. Use string keys such as \"0\", \"1\".",
- "propertyNames": {
- "type": "string"
- },
- "type": "object"
- }
- },
- "type": "object"
- },
- "custom_field_values": {
- "description": "Values for a custom template's fields, keyed by the field keys defined in the template's YAML definition. Only used when template_id is a custom template. Template defaults fill any fields you omit; a required field with no default and no submitted value returns a 400 naming the field. Values are validated against the field's input type: select and radio values must be one of the field's options, multiselect values are an array of selections each of which must be one of the field's options, number and currency values must be numeric, date values must be YYYY-MM-DD, and email values must be valid addresses. An invalid value returns a 400 naming the field."
- },
- "design_partner_attributes": {
- "additionalProperties": false,
- "description": "Override design partner terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "customer_description": {
- "type": "string"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_fees": {
- "type": "boolean"
- },
- "include_fees_amount": {
- "type": "number"
- },
- "include_fees_description": {
- "type": "string"
- },
- "include_fees_pay_by_amount": {
- "type": "string"
- },
- "include_fees_type": {
- "enum": [
- "default_language",
- "description"
- ],
- "type": "string"
- },
- "include_fees_unit": {
- "enum": [
- "month",
- "quarter",
- "year",
- "Term"
- ],
- "type": "string"
- },
- "include_program_appear_as_customer_private": {
- "type": "boolean"
- },
- "include_program_appear_as_customer_public": {
- "type": "boolean"
- },
- "include_program_case_study": {
- "type": "boolean"
- },
- "include_program_develop_functionality": {
- "type": "boolean"
- },
- "include_program_develop_functionality_val": {
- "type": "string"
- },
- "include_program_discount": {
- "type": "boolean"
- },
- "include_program_discount_amount": {
- "type": "number"
- },
- "include_program_discount_unit": {
- "enum": [
- "U.S. Dollars",
- "percent"
- ],
- "type": "string"
- },
- "include_program_participation_feedback": {
- "type": "boolean"
- },
- "include_program_participation_feedback_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_program_participation_feedback_unit": {
- "enum": [
- "month",
- "quarter",
- "year",
- "Term"
- ],
- "type": "string"
- },
- "include_program_partner_other": {
- "type": "boolean"
- },
- "include_program_partner_other_val": {
- "type": "string"
- },
- "include_program_provider_other": {
- "type": "boolean"
- },
- "include_program_provider_other_val": {
- "type": "string"
- },
- "include_program_reference": {
- "type": "boolean"
- },
- "product_description": {
- "type": "string"
- },
- "term_amount": {
- "type": "number"
- },
- "term_unit": {
- "enum": [
- "day(s)",
- "week(s)",
- "month(s)",
- "quarter(s)",
- "year(s)"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- "district_or_county": {
- "description": "The district or county for dispute resolution.",
- "type": "string"
- },
- "dpa_attributes": {
- "additionalProperties": false,
- "description": "Override dpa terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "approved_subprocessor_type": {
- "description": "`internal` lists approved subprocessors in the agreement (`subprocessors_attributes`); `external` points to a list published elsewhere.",
- "enum": [
- "internal",
- "external"
- ],
- "type": "string"
- },
- "cloud_service_product_name": {
- "type": "string"
- },
- "competent_supervisory_authority": {
- "type": "string"
- },
- "customer_description": {
- "type": "string"
- },
- "data_exporter_address_city": {
- "type": "string"
- },
- "data_exporter_address_country": {
- "type": "string"
- },
- "data_exporter_address_state": {
- "type": "string"
- },
- "data_exporter_address_street_address": {
- "type": "string"
- },
- "data_exporter_address_zipcode": {
- "type": "string"
- },
- "data_exporter_contact_details": {
- "type": "string"
- },
- "data_exporter_contact_name": {
- "type": "string"
- },
- "data_exporter_contact_position": {
- "type": "string"
- },
- "data_exporter_role": {
- "description": "Role of the data exporter. Overwritten to `Controller` when the agreement is created from a template.",
- "enum": [
- "Controller",
- "Processor"
- ],
- "type": "string"
- },
- "data_importer_address": {
- "type": "string"
- },
- "data_importer_address_city": {
- "type": "string"
- },
- "data_importer_address_country": {
- "type": "string"
- },
- "data_importer_address_state": {
- "type": "string"
- },
- "data_importer_address_street_address": {
- "type": "string"
- },
- "data_importer_address_zipcode": {
- "type": "string"
- },
- "data_importer_contact_details": {
- "type": "string"
- },
- "data_importer_contact_name": {
- "type": "string"
- },
- "data_importer_contact_position": {
- "type": "string"
- },
- "duration_of_processing": {
- "type": "string"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_covered_claim": {
- "type": "boolean"
- },
- "include_covered_claim_external_val": {
- "type": "string"
- },
- "include_covered_claim_internal_val": {
- "type": "string"
- },
- "include_covered_claim_type": {
- "description": "Which covered-claim text applies: `internal` uses `include_covered_claim_internal_val`, `external` uses `include_covered_claim_external_val`. Required when `include_covered_claim` is true.",
- "enum": [
- "internal",
- "external"
- ],
- "type": "string"
- },
- "include_data_subjects_custom": {
- "type": "boolean"
- },
- "include_data_subjects_custom_val": {
- "type": "string"
- },
- "include_data_subjects_employees": {
- "type": "boolean"
- },
- "include_data_subjects_end_users": {
- "type": "boolean"
- },
- "include_external_subprocessor_location": {
- "type": "string"
- },
- "include_frequency_of_transfer_continuous": {
- "type": "boolean"
- },
- "include_frequency_of_transfer_custom": {
- "type": "boolean"
- },
- "include_frequency_of_transfer_custom_val": {
- "type": "string"
- },
- "include_governing_country_eu": {
- "type": "boolean"
- },
- "include_governing_country_eu_val": {
- "type": "string"
- },
- "include_governing_country_uk": {
- "type": "boolean"
- },
- "include_governing_country_uk_val": {
- "type": "string"
- },
- "include_governing_law": {
- "type": "boolean"
- },
- "include_governing_law_country": {
- "type": "string"
- },
- "include_governing_law_state": {
- "type": "string"
- },
- "include_increased_claim_amount": {
- "description": "Legacy field. Stored but not shown on the DPA; use the `include_liability_cap*` fields instead.",
- "type": "boolean"
- },
- "include_increased_claim_amount_currency": {
- "description": "Legacy field. Stored but not shown on the DPA; use the `include_liability_cap*` fields instead."
- },
- "include_increased_claim_amount_qty": {
- "description": "Legacy field. Stored but not shown on the DPA; use the `include_liability_cap*` fields instead."
- },
- "include_increased_claim_amount_type": {
- "description": "Legacy field. Stored but not shown on the DPA; use the `include_liability_cap*` fields instead.",
- "type": "string"
- },
- "include_liability_cap": {
- "type": "boolean"
- },
- "include_liability_cap_amount_constant_external": {
- "type": "string"
- },
- "include_liability_cap_amount_constant_internal": {
- "type": "string"
- },
- "include_liability_cap_amount_currency_external": {
- "description": "Currency amount. Numbers and numeric strings (commas allowed) are both accepted."
- },
- "include_liability_cap_amount_currency_internal": {
- "description": "Currency amount. Numbers and numeric strings (commas allowed) are both accepted."
- },
- "include_liability_cap_csa_type": {
- "description": "Which liability cap values apply: the `_internal` or `_external` amount fields. Required when `include_liability_cap` is true.",
- "enum": [
- "internal",
- "external"
- ],
- "type": "string"
- },
- "include_personal_data_biographic_info": {
- "type": "boolean"
- },
- "include_personal_data_contact_info": {
- "type": "boolean"
- },
- "include_personal_data_custom": {
- "type": "boolean"
- },
- "include_personal_data_custom_val": {
- "type": "string"
- },
- "include_personal_data_employment_info": {
- "type": "boolean"
- },
- "include_personal_data_financial_info": {
- "type": "boolean"
- },
- "include_personal_data_location": {
- "type": "boolean"
- },
- "include_personal_data_name": {
- "type": "boolean"
- },
- "include_personal_data_transactional_info": {
- "type": "boolean"
- },
- "include_personal_data_user_activity_info": {
- "type": "boolean"
- },
- "include_processing_purpose_custom": {
- "type": "boolean"
- },
- "include_processing_purpose_custom_val": {
- "type": "string"
- },
- "include_processing_purpose_erasing": {
- "type": "boolean"
- },
- "include_processing_purpose_holding": {
- "type": "boolean"
- },
- "include_processing_purpose_protecting": {
- "type": "boolean"
- },
- "include_processing_purpose_receiving": {
- "type": "boolean"
- },
- "include_processing_purpose_returning": {
- "type": "boolean"
- },
- "include_processing_purpose_sharing": {
- "type": "boolean"
- },
- "include_processing_purpose_updating": {
- "type": "boolean"
- },
- "include_processing_purpose_using": {
- "type": "boolean"
- },
- "include_provider_security_contact_address": {
- "type": "boolean"
- },
- "include_provider_security_contact_address_city": {
- "type": "string"
- },
- "include_provider_security_contact_address_country": {
- "type": "string"
- },
- "include_provider_security_contact_address_state": {
- "type": "string"
- },
- "include_provider_security_contact_address_street_address": {
- "type": "string"
- },
- "include_provider_security_contact_address_zipcode": {
- "type": "string"
- },
- "include_provider_security_contact_email": {
- "type": "boolean"
- },
- "include_provider_security_contact_email_val": {
- "format": "email",
- "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
- "type": "string"
- },
- "include_security_measures_accountability": {
- "type": "boolean"
- },
- "include_security_measures_accountability_val": {
- "type": "string"
- },
- "include_security_measures_certification_or_assurance": {
- "type": "boolean"
- },
- "include_security_measures_certification_or_assurance_val": {
- "type": "string"
- },
- "include_security_measures_confidentiality_integrity": {
- "type": "boolean"
- },
- "include_security_measures_confidentiality_integrity_val": {
- "type": "string"
- },
- "include_security_measures_data_at_rest": {
- "type": "boolean"
- },
- "include_security_measures_data_at_rest_val": {
- "type": "string"
- },
- "include_security_measures_data_minimization": {
- "type": "boolean"
- },
- "include_security_measures_data_minimization_val": {
- "type": "string"
- },
- "include_security_measures_data_quality": {
- "type": "boolean"
- },
- "include_security_measures_data_quality_val": {
- "type": "string"
- },
- "include_security_measures_data_retention": {
- "type": "boolean"
- },
- "include_security_measures_data_retention_val": {
- "type": "string"
- },
- "include_security_measures_data_transmission": {
- "type": "boolean"
- },
- "include_security_measures_data_transmission_val": {
- "type": "string"
- },
- "include_security_measures_event_logging": {
- "type": "boolean"
- },
- "include_security_measures_event_logging_val": {
- "type": "string"
- },
- "include_security_measures_identity_auth": {
- "type": "boolean"
- },
- "include_security_measures_identity_auth_val": {
- "type": "string"
- },
- "include_security_measures_it_security_governance": {
- "type": "boolean"
- },
- "include_security_measures_it_security_governance_val": {
- "type": "string"
- },
- "include_security_measures_physical_security": {
- "type": "boolean"
- },
- "include_security_measures_physical_security_val": {
- "type": "string"
- },
- "include_security_measures_portability_and_erasure": {
- "type": "boolean"
- },
- "include_security_measures_portability_and_erasure_val": {
- "type": "string"
- },
- "include_security_measures_pseudonym_encryption": {
- "type": "boolean"
- },
- "include_security_measures_pseudonym_encryption_val": {
- "type": "string"
- },
- "include_security_measures_restore_data_access": {
- "type": "boolean"
- },
- "include_security_measures_restore_data_access_val": {
- "type": "string"
- },
- "include_security_measures_security_policy": {
- "type": "boolean"
- },
- "include_security_measures_system_configuration": {
- "type": "boolean"
- },
- "include_security_measures_system_configuration_val": {
- "type": "string"
- },
- "include_security_measures_testing_assessment": {
- "type": "boolean"
- },
- "include_security_measures_testing_assessment_val": {
- "type": "string"
- },
- "include_security_policy": {
- "type": "boolean"
- },
- "include_security_policy_fedramp_auth": {
- "type": "boolean"
- },
- "include_security_policy_hipaa": {
- "type": "boolean"
- },
- "include_security_policy_hitrust": {
- "type": "boolean"
- },
- "include_security_policy_include_other": {
- "type": "boolean"
- },
- "include_security_policy_iso27001": {
- "type": "boolean"
- },
- "include_security_policy_other": {
- "type": "string"
- },
- "include_security_policy_pci1": {
- "type": "boolean"
- },
- "include_security_policy_pci2": {
- "type": "boolean"
- },
- "include_security_policy_penetration_testing": {
- "type": "boolean"
- },
- "include_security_policy_soc2": {
- "type": "boolean"
- },
- "include_security_policy_soc2_type2": {
- "type": "boolean"
- },
- "include_sensitive_data_restrictions_custom": {
- "type": "boolean"
- },
- "include_sensitive_data_restrictions_custom_val": {
- "type": "string"
- },
- "include_sensitive_data_restrictions_security_policy": {
- "type": "boolean"
- },
- "include_service_provider_relationship": {
- "type": "boolean"
- },
- "include_special_category_data": {
- "type": "boolean"
- },
- "provider": {
- "type": "string"
- },
- "security_policy_available_at": {
- "type": "string"
- },
- "security_policy_type": {
- "description": "Where the Security Policy is defined. For `external`, set `security_policy_available_at`.",
- "enum": [
- "defined in agreement",
- "provider service",
- "external"
- ],
- "type": "string"
- },
- "subprocessors_attributes": {
- "additionalProperties": {
- "additionalProperties": false,
- "properties": {
- "_destroy": {
- "description": "Set to true with `id` to remove that subprocessor.",
- "type": "boolean"
- },
- "country": {
- "type": "string"
- },
- "id": {
- "description": "ID of an existing subprocessor to update or remove. Omit to add a new subprocessor.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "name": {
- "type": "string"
- },
- "processing_task": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "description": "Subprocessors, keyed by string index such as \"0\", \"1\". On create these are added to the template's subprocessors. On a draft update, an entry without `id` adds a new subprocessor; pass `id` to change one and `id` with `_destroy: true` to remove one.",
- "propertyNames": {
- "type": "string"
- },
- "type": "object"
- },
- "underlying_agreement_id": {
- "description": "ID of the CSA this DPA supplements when `underlying_agreement_type` is `internal`.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "underlying_agreement_type": {
- "description": "`internal` links a CSA in Common Paper (`underlying_agreement_id`); `external` describes another agreement in `underlying_agreement_val` (required). Omit for none.",
- "enum": [
- "internal",
- "external"
- ],
- "type": "string"
- },
- "underlying_agreement_val": {
- "description": "Description of the agreement this DPA supplements. Required when `underlying_agreement_type` is `external`.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "framework_terms_description": {
- "description": "Custom framework terms description. Only used when framework_terms_type is \"description\".",
- "type": "string"
- },
- "framework_terms_type": {
- "description": "How framework terms are specified. Use \"new\" for standard terms or \"description\" to provide a custom framework_terms_description.",
- "enum": [
- "new",
- "description"
- ],
- "type": "string"
- },
- "governing_law_country": {
- "description": "The country whose laws govern the agreement.",
- "type": "string"
- },
- "governing_law_region": {
- "description": "The state or region whose laws govern the agreement.",
- "type": "string"
- },
- "include_automated_payment_reminders": {
- "description": "When true, automatically sends payment reminder emails.",
- "type": "boolean"
- },
- "include_billing_info": {
- "description": "When true, billing contact information (billing_name, billing_email) is included.",
- "type": "boolean"
- },
- "include_billing_workflow": {
- "description": "When true, enables a billing workflow after signing.",
- "type": "boolean"
- },
- "include_expiration_date": {
- "description": "Expiration date in YYYY-MM-DD format. Use when include_expiration_type is \"date\".",
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "include_expiration_days": {
- "description": "Number of days until the agreement expires. Use when include_expiration_type is \"days\".",
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_expiration_type": {
- "description": "How to set expiration: \"none\" (default), \"days\" (use include_expiration_days), or \"date\" (use include_expiration_date).",
- "enum": [
- "none",
- "days",
- "date"
- ],
- "type": "string"
- },
- "include_terms": {
- "description": "When true, the standard terms are included with the agreement.",
- "type": "boolean"
- },
- "loi_attributes": {
- "additionalProperties": false,
- "description": "Override loi terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "confidentiality_custom": {
- "type": "string"
- },
- "confidentiality_mutual_include_loi": {
- "type": "boolean"
- },
- "confidentiality_nda_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "confidentiality_nda_description": {
- "type": "string"
- },
- "confidentiality_nda_include_loi": {
- "type": "boolean"
- },
- "confidentiality_nda_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "confidentiality_type": {
- "enum": [
- "mutual",
- "nda",
- "provider",
- "custom"
- ],
- "type": "string"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_custom_details": {
- "type": "boolean"
- },
- "include_custom_details_val": {
- "type": "string"
- },
- "include_fees": {
- "type": "boolean"
- },
- "include_fees_amount": {
- "type": "number"
- },
- "include_fees_amount_duration": {
- "enum": [
- "month",
- "year",
- "quarter"
- ],
- "type": "string"
- },
- "include_fees_include_amount": {
- "type": "boolean"
- },
- "include_fees_include_other": {
- "type": "boolean"
- },
- "include_fees_other": {
- "type": "string"
- },
- "include_functionality": {
- "type": "boolean"
- },
- "include_functionality_val": {
- "type": "string"
- },
- "include_launch_date": {
- "type": "boolean"
- },
- "include_launch_date_custom": {
- "type": "string"
- },
- "include_launch_date_date": {
- "format": "date-time",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$",
- "type": "string"
- },
- "include_launch_date_type": {
- "enum": [
- "date",
- "custom"
- ],
- "type": "string"
- },
- "product_name": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "manual_send": {
- "description": "When true, the agreement is marked as manually sent outside the platform.",
- "type": "boolean"
- },
- "message": {
- "type": "string"
- },
- "negotiations_allowed": {
- "description": "When true, the recipient can propose changes to the legal terms. For agreement types without separate business terms, that covers every term. CSA order forms, PSA statements of work, partnership business terms and software license order forms have their own `negotiations_allowed` flag.",
- "type": "boolean"
- },
- "partnership_attributes": {
- "additionalProperties": false,
- "description": "Override partnership terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "effective_date": {
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "effective_date_type": {
- "enum": [
- "signature",
- "date"
- ],
- "type": "string"
- },
- "general_cap_amount_currency_val": {
- "type": "number"
- },
- "general_cap_amount_either_currency": {
- "type": "number"
- },
- "general_cap_amount_either_multiple": {
- "type": "number"
- },
- "general_cap_amount_multiple_val": {
- "type": "number"
- },
- "general_cap_amount_type": {
- "enum": [
- "multiple",
- "currency",
- "either",
- "base"
- ],
- "type": "string"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_additional_warranties": {
- "type": "boolean"
- },
- "include_additional_warranties_include_company": {
- "type": "boolean"
- },
- "include_additional_warranties_include_company_val": {
- "type": "string"
- },
- "include_additional_warranties_include_partner": {
- "type": "boolean"
- },
- "include_additional_warranties_include_partner_val": {
- "type": "string"
- },
- "include_brand_guidelines": {
- "type": "boolean"
- },
- "include_brand_guidelines_include_company": {
- "type": "boolean"
- },
- "include_brand_guidelines_include_company_val": {
- "type": "string"
- },
- "include_brand_guidelines_include_partner": {
- "type": "boolean"
- },
- "include_brand_guidelines_include_partner_val": {
- "type": "string"
- },
- "include_covered_claims": {
- "type": "boolean"
- },
- "include_covered_claims_company_claims": {
- "type": "string"
- },
- "include_covered_claims_include_company_claims": {
- "type": "boolean"
- },
- "include_covered_claims_include_partner_claims": {
- "type": "boolean"
- },
- "include_covered_claims_partner_claims": {
- "type": "string"
- },
- "include_dpa": {
- "type": "boolean"
- },
- "include_dpa_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_dpa_location": {
- "type": "string"
- },
- "include_dpa_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_increased_cap_amount": {
- "type": "boolean"
- },
- "include_increased_cap_amount_currency": {
- "type": "number"
- },
- "include_increased_cap_amount_either_currency": {
- "type": "number"
- },
- "include_increased_cap_amount_either_multiple": {
- "type": "string"
- },
- "include_increased_cap_amount_multiple": {
- "type": "string"
- },
- "include_increased_cap_amount_type": {
- "enum": [
- "multiple",
- "currency",
- "either"
- ],
- "type": "string"
- },
- "include_increased_claims": {
- "type": "boolean"
- },
- "include_increased_claims_include_confidentiality": {
- "type": "boolean"
- },
- "include_increased_claims_include_confidentiality_misconduct": {
- "type": "boolean"
- },
- "include_increased_claims_include_covered_claims": {
- "type": "boolean"
- },
- "include_increased_claims_include_misconduct": {
- "type": "boolean"
- },
- "include_increased_claims_include_other": {
- "type": "boolean"
- },
- "include_increased_claims_include_other_val": {
- "type": "string"
- },
- "include_unlimited_claims": {
- "type": "boolean"
- },
- "include_unlimited_claims_confidentiality": {
- "type": "boolean"
- },
- "include_unlimited_claims_confidentiality_misconduct": {
- "type": "boolean"
- },
- "include_unlimited_claims_covered_claims": {
- "type": "boolean"
- },
- "include_unlimited_claims_misconduct": {
- "type": "boolean"
- },
- "include_unlimited_claims_other": {
- "type": "boolean"
- },
- "include_unlimited_claims_other_val": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "partnership_business_terms_attributes": {
- "additionalProperties": false,
- "description": "Override partnership business terms terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "end_date_after_effective_date_amount": {
- "type": "number"
- },
- "end_date_after_effective_date_unit": {
- "enum": [
- "month(s)",
- "quarter(s)",
- "year(s)"
- ],
- "type": "string"
- },
- "end_date_date": {
- "type": "string"
- },
- "end_date_type": {
- "enum": [
- "date",
- "effective date"
- ],
- "type": "string"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_obligations_company_brand": {
- "type": "boolean"
- },
- "include_obligations_company_promotion": {
- "type": "boolean"
- },
- "include_obligations_company_promotion_include_activities": {
- "type": "boolean"
- },
- "include_obligations_company_promotion_include_activities_val": {
- "type": "string"
- },
- "include_obligations_company_promotion_include_materials": {
- "type": "boolean"
- },
- "include_obligations_company_promotion_include_materials_val": {
- "type": "string"
- },
- "include_obligations_company_referral": {
- "type": "boolean"
- },
- "include_obligations_company_referral_include_criteria": {
- "type": "boolean"
- },
- "include_obligations_company_referral_include_criteria_val": {
- "type": "string"
- },
- "include_obligations_company_referral_include_pay_sch": {
- "type": "boolean"
- },
- "include_obligations_company_referral_include_pay_sch_amount": {
- "type": "number"
- },
- "include_obligations_company_referral_include_pay_sch_custom": {
- "type": "string"
- },
- "include_obligations_company_referral_include_pay_sch_unit": {
- "enum": [
- "U.S. Dollars",
- "percent"
- ],
- "type": "string"
- },
- "include_obligations_company_sponsorship": {
- "type": "boolean"
- },
- "include_obligations_company_sponsorship_include_benefits": {
- "type": "boolean"
- },
- "include_obligations_company_sponsorship_include_benefits_val": {
- "type": "string"
- },
- "include_obligations_company_sponsorship_include_payments": {
- "type": "boolean"
- },
- "include_obligations_company_sponsorship_include_payments_amount": {
- "type": "number"
- },
- "include_obligations_company_sponsorship_include_payments_unit": {
- "enum": [
- "U.S. Dollars",
- "percent"
- ],
- "type": "string"
- },
- "include_obligations_partner_brand": {
- "type": "boolean"
- },
- "include_obligations_partner_promotion": {
- "type": "boolean"
- },
- "include_obligations_partner_promotion_include_activities": {
- "type": "boolean"
- },
- "include_obligations_partner_promotion_include_activities_val": {
- "type": "string"
- },
- "include_obligations_partner_promotion_include_materials": {
- "type": "boolean"
- },
- "include_obligations_partner_promotion_include_materials_val": {
- "type": "string"
- },
- "include_obligations_partner_referral": {
- "type": "boolean"
- },
- "include_obligations_partner_referral_include_criteria": {
- "type": "boolean"
- },
- "include_obligations_partner_referral_include_criteria_val": {
- "type": "string"
- },
- "include_obligations_partner_referral_include_pay_sch": {
- "type": "boolean"
- },
- "include_obligations_partner_referral_include_pay_sch_amount": {
- "type": "number"
- },
- "include_obligations_partner_referral_include_pay_sch_custom": {
- "type": "string"
- },
- "include_obligations_partner_referral_include_pay_sch_unit": {
- "enum": [
- "U.S. Dollars",
- "percent"
- ],
- "type": "string"
- },
- "include_obligations_partner_sponsorship": {
- "type": "boolean"
- },
- "include_obligations_partner_sponsorship_include_benefits": {
- "type": "boolean"
- },
- "include_obligations_partner_sponsorship_include_benefits_val": {
- "type": "string"
- },
- "include_obligations_partner_sponsorship_include_payments": {
- "type": "boolean"
- },
- "include_obligations_partner_sponsorship_include_payments_amount": {
- "type": "number"
- },
- "include_obligations_partner_sponsorship_include_payments_unit": {
- "enum": [
- "U.S. Dollars",
- "percent"
- ],
- "type": "string"
- },
- "include_payment_process": {
- "type": "boolean"
- },
- "include_payment_process_company": {
- "type": "boolean"
- },
- "include_payment_process_company_include_address": {
- "type": "boolean"
- },
- "include_payment_process_company_include_address_city": {
- "type": "string"
- },
- "include_payment_process_company_include_address_country": {
- "type": "string"
- },
- "include_payment_process_company_include_address_state": {
- "type": "string"
- },
- "include_payment_process_company_include_address_street_address": {
- "type": "string"
- },
- "include_payment_process_company_include_address_zipcode": {
- "type": "string"
- },
- "include_payment_process_company_include_email": {
- "type": "boolean"
- },
- "include_payment_process_company_include_email_val": {
- "type": "string"
- },
- "include_payment_process_partner": {
- "type": "boolean"
- },
- "include_payment_process_partner_include_address": {
- "type": "boolean"
- },
- "include_payment_process_partner_include_address_city": {
- "type": "string"
- },
- "include_payment_process_partner_include_address_country": {
- "type": "string"
- },
- "include_payment_process_partner_include_address_state": {
- "type": "string"
- },
- "include_payment_process_partner_include_address_street_address": {
- "type": "string"
- },
- "include_payment_process_partner_include_address_zipcode": {
- "type": "string"
- },
- "include_payment_process_partner_include_email": {
- "type": "boolean"
- },
- "include_payment_process_partner_include_email_val": {
- "type": "string"
- },
- "include_payment_schedule": {
- "type": "boolean"
- },
- "include_payment_schedule_custom": {
- "type": "string"
- },
- "include_payment_schedule_specified_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_payment_schedule_specified_timeframe": {
- "enum": [
- "receipt",
- "date"
- ],
- "type": "string"
- },
- "include_payment_schedule_specified_unit": {
- "enum": [
- "day(s)",
- "week(s)",
- "month(s)",
- "quarter(s)",
- "year(s)"
- ],
- "type": "string"
- },
- "include_payment_schedule_type": {
- "enum": [
- "specified",
- "custom"
- ],
- "type": "string"
- },
- "negotiations_allowed": {
- "description": "When true, the recipient can propose changes to the business terms, even when the agreement-level `negotiations_allowed` is false. This only covers the business terms.",
- "type": "boolean"
- },
- "territory_type": {
- "enum": [
- "worldwide",
- "custom"
- ],
- "type": "string"
- },
- "territory_type_val": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "payment_link_url": {
- "description": "A payment URL shown to the recipient after signing. Requires include_billing_workflow to be true and billing_workflow_type to be \"link\".",
- "type": "string"
- },
- "pilot_attributes": {
- "additionalProperties": false,
- "description": "Override pilot terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "fees_type": {
- "enum": [
- "free",
- "pilot_period_fees"
- ],
- "type": "string"
- },
- "general_cap_amount": {
- "type": "number"
- },
- "general_cap_amount_type": {
- "enum": [
- "preceding",
- "base",
- "period"
- ],
- "type": "string"
- },
- "general_cap_period_currency": {
- "type": "number"
- },
- "general_cap_period_qty": {
- "type": "number"
- },
- "general_cap_preceding_amount": {
- "type": "number"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_dpa": {
- "type": "boolean"
- },
- "include_dpa_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_dpa_location": {
- "type": "string"
- },
- "include_dpa_type": {
- "enum": [
- "description",
- "attachment",
- "standard"
- ],
- "type": "string"
- },
- "include_payment_process": {
- "type": "boolean"
- },
- "include_technical_support": {
- "type": "boolean"
- },
- "payment_process_automatic_frequency": {
- "enum": [
- "monthly",
- "quarterly",
- "annually",
- "once_per_period"
- ],
- "type": "string"
- },
- "payment_process_invoice_days": {
- "type": "number"
- },
- "payment_process_invoice_from": {
- "enum": [
- "receipt",
- "date"
- ],
- "type": "string"
- },
- "payment_process_invoice_timeframe": {
- "enum": [
- "days",
- "weeks",
- "months",
- "quarters",
- "years"
- ],
- "type": "string"
- },
- "payment_process_type": {
- "enum": [
- "automatic",
- "invoice"
- ],
- "type": "string"
- },
- "pilot_period_description": {
- "type": "string"
- },
- "pilot_period_fees_description": {
- "type": "string"
- },
- "product_description": {
- "type": "string"
- },
- "technical_support_description": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "psa_attributes": {
- "additionalProperties": false,
- "description": "Override psa terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "additional_changes": {
- "type": "string"
- },
- "customer_description": {
- "type": "string"
- },
- "effective_date": {
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "effective_date_type": {
- "enum": [
- "signature",
- "date"
- ],
- "type": "string"
- },
- "general_cap_amount": {
- "type": "number"
- },
- "general_cap_amount_type": {
- "enum": [
- "preceding",
- "base",
- "period"
- ],
- "type": "string"
- },
- "general_cap_period_currency": {
- "type": "number"
- },
- "general_cap_period_qty": {
- "type": "number"
- },
- "general_cap_preceding_amount": {
- "type": "number"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_additional_changes": {
- "type": "boolean"
- },
- "include_additional_warranties": {
- "type": "boolean"
- },
- "include_additional_warranties_by_customer": {
- "type": "string"
- },
- "include_additional_warranties_by_provider": {
- "type": "string"
- },
- "include_additional_warranties_include_by_customer": {
- "type": "boolean"
- },
- "include_additional_warranties_include_by_provider": {
- "type": "boolean"
- },
- "include_covered_claims": {
- "type": "boolean"
- },
- "include_covered_claims_customer_claims": {
- "type": "string"
- },
- "include_covered_claims_include_customer_claims": {
- "type": "boolean"
- },
- "include_covered_claims_include_provider_claims": {
- "type": "boolean"
- },
- "include_covered_claims_provider_claims": {
- "type": "string"
- },
- "include_customer_insurance_min": {
- "type": "boolean"
- },
- "include_customer_insurance_min_add_provider_com_gen_liability": {
- "type": "boolean"
- },
- "include_customer_insurance_min_add_provider_cyber_liability": {
- "type": "boolean"
- },
- "include_customer_insurance_min_add_provider_errors_omissions": {
- "type": "boolean"
- },
- "include_customer_insurance_min_auto_liability_aggregate": {
- "type": "number"
- },
- "include_customer_insurance_min_auto_liability_minimum": {
- "type": "number"
- },
- "include_customer_insurance_min_cyber_liability_aggregate": {
- "type": "number"
- },
- "include_customer_insurance_min_cyber_liability_minimum": {
- "type": "number"
- },
- "include_customer_insurance_min_employer_liability_aggregate": {
- "type": "number"
- },
- "include_customer_insurance_min_employer_liability_minimum": {
- "type": "number"
- },
- "include_customer_insurance_min_general_liability_aggregate": {
- "type": "number"
- },
- "include_customer_insurance_min_general_liability_minimum": {
- "type": "number"
- },
- "include_customer_insurance_min_include_add_provider": {
- "type": "boolean"
- },
- "include_customer_insurance_min_include_auto_liability": {
- "type": "boolean"
- },
- "include_customer_insurance_min_include_cyber_liability": {
- "type": "boolean"
- },
- "include_customer_insurance_min_include_employer_liability": {
- "type": "boolean"
- },
- "include_customer_insurance_min_include_general_liability": {
- "type": "boolean"
- },
- "include_customer_insurance_min_include_workers_comp": {
- "type": "boolean"
- },
- "include_customer_policies": {
- "type": "boolean"
- },
- "include_customer_policies_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_customer_policies_location": {
- "type": "string"
- },
- "include_customer_policies_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_dpa": {
- "type": "boolean"
- },
- "include_dpa_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_dpa_location": {
- "type": "string"
- },
- "include_dpa_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_increased_cap_amount": {
- "type": "boolean"
- },
- "include_increased_claims": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_confidentiality": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_confidentiality_negligence": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_privsec": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_privsec_negligence": {
- "type": "boolean"
- },
- "include_increased_claims_include_other": {
- "type": "boolean"
- },
- "include_increased_claims_indemnification_obligation": {
- "type": "boolean"
- },
- "include_increased_claims_negligence": {
- "type": "boolean"
- },
- "include_increased_claims_other": {
- "type": "string"
- },
- "include_provider_insurance_min": {
- "type": "boolean"
- },
- "include_provider_insurance_min_add_customer_com_gen_liability": {
- "type": "boolean"
- },
- "include_provider_insurance_min_add_customer_cyber_liability": {
- "type": "boolean"
- },
- "include_provider_insurance_min_add_customer_errors_omissions": {
- "type": "boolean"
- },
- "include_provider_insurance_min_auto_liability_aggregate": {
- "type": "number"
- },
- "include_provider_insurance_min_auto_liability_minimum": {
- "type": "number"
- },
- "include_provider_insurance_min_cyber_liability_aggregate": {
- "type": "number"
- },
- "include_provider_insurance_min_cyber_liability_minimum": {
- "type": "number"
- },
- "include_provider_insurance_min_employer_liability_aggregate": {
- "type": "number"
- },
- "include_provider_insurance_min_employer_liability_minimum": {
- "type": "number"
- },
- "include_provider_insurance_min_general_liability_aggregate": {
- "type": "number"
- },
- "include_provider_insurance_min_general_liability_minimum": {
- "type": "number"
- },
- "include_provider_insurance_min_include_add_customer": {
- "type": "boolean"
- },
- "include_provider_insurance_min_include_auto_liability": {
- "type": "boolean"
- },
- "include_provider_insurance_min_include_cyber_liability": {
- "type": "boolean"
- },
- "include_provider_insurance_min_include_employer_liability": {
- "type": "boolean"
- },
- "include_provider_insurance_min_include_general_liability": {
- "type": "boolean"
- },
- "include_provider_insurance_min_include_workers_comp": {
- "type": "boolean"
- },
- "include_publicity_rights": {
- "type": "boolean"
- },
- "include_publicity_rights_type": {
- "enum": [
- "public",
- "non-public"
- ],
- "type": "string"
- },
- "include_security_policy": {
- "type": "boolean"
- },
- "include_security_policy_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_security_policy_fedramp_auth": {
- "type": "boolean"
- },
- "include_security_policy_hitrust": {
- "type": "boolean"
- },
- "include_security_policy_include_annual_maintenance": {
- "type": "boolean"
- },
- "include_security_policy_include_other": {
- "type": "boolean"
- },
- "include_security_policy_include_other_val": {
- "type": "string"
- },
- "include_security_policy_iso27001": {
- "type": "boolean"
- },
- "include_security_policy_location": {
- "type": "string"
- },
- "include_security_policy_pci1": {
- "type": "boolean"
- },
- "include_security_policy_pci2": {
- "type": "boolean"
- },
- "include_security_policy_penetration_testing": {
- "type": "boolean"
- },
- "include_security_policy_soc2_type1": {
- "type": "boolean"
- },
- "include_security_policy_soc2_type2": {
- "type": "boolean"
- },
- "include_security_policy_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_unlimited_claims": {
- "type": "boolean"
- },
- "include_unlimited_claims_breach_of_confidentiality": {
- "type": "boolean"
- },
- "include_unlimited_claims_breach_of_confidentiality_negligence": {
- "type": "boolean"
- },
- "include_unlimited_claims_breach_of_privsec": {
- "type": "boolean"
- },
- "include_unlimited_claims_breach_of_privsec_negligence": {
- "type": "boolean"
- },
- "include_unlimited_claims_include_other": {
- "type": "boolean"
- },
- "include_unlimited_claims_indemnification_obligation": {
- "type": "boolean"
- },
- "include_unlimited_claims_negligence": {
- "type": "boolean"
- },
- "include_unlimited_claims_other": {
- "type": "string"
- },
- "increased_cap_amount_currency": {
- "type": "number"
- },
- "increased_cap_amount_period_currency": {
- "type": "number"
- },
- "increased_cap_amount_period_qty": {
- "type": "number"
- },
- "increased_cap_amount_qty": {
- "type": "number"
- },
- "increased_cap_amount_type": {
- "enum": [
- "qty",
- "currency",
- "period"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- "psa_statement_of_work_attributes": {
- "additionalProperties": false,
- "description": "Override psa statement of work terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "additional_changes": {
- "type": "string"
- },
- "cost": {
- "type": "number"
- },
- "description": {
- "type": "string"
- },
- "fee_type": {
- "type": "string"
- },
- "fees_attributes": {
- "additionalProperties": {
- "anyOf": [
- {
- "additionalProperties": false,
- "description": "Fees::Flat (fee_type \"flat\"). A fixed recurring fee, e.g. a platform subscription. Set type to \"Fees::Flat\" or fee_type to \"flat\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "Fixed amount in the order form's fees_currency, charged per fee_period. A plain amount, not cents: 20 means 20.00.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"flat\". Alternative to type.",
- "enum": [
- "flat"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Flat\". Optional when fee_type is set.",
- "enum": [
- "Fees::Flat"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Discount (fee_type \"discount\"). A discount, as a fixed amount or a percentage, applied forever, once, or for a number of months. Set type to \"Fees::Discount\" or fee_type to \"discount\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "Discount size: an amount in fees_currency when discount_type is fixed_amount (a plain amount, not cents: 20 means 20.00), or a percentage (e.g. 10 for 10%) when it is percentage.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "discount_duration_amount": {
- "description": "Number of months the discount applies. Required when discount_duration_type is multiple_months.",
- "type": "number"
- },
- "discount_duration_type": {
- "description": "How long the discount applies. multiple_months also needs discount_duration_amount.",
- "enum": [
- "forever",
- "once",
- "multiple_months"
- ],
- "type": "string"
- },
- "discount_type": {
- "description": "Whether cost is a currency amount or a percentage.",
- "enum": [
- "fixed_amount",
- "percentage"
- ],
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"discount\". Alternative to type.",
- "enum": [
- "discount"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Discount\". Optional when fee_type is set.",
- "enum": [
- "Fees::Discount"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Cost (fee_type \"cost\"). A per-unit fee: price per unit times quantity, e.g. seats. Set type to \"Fees::Cost\" or fee_type to \"cost\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "Price per unit in fees_currency. The row total is quantity x cost. A plain amount, not cents: 20 means 20.00.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"cost\". Alternative to type.",
- "enum": [
- "cost"
- ],
- "type": "string"
- },
- "quantity": {
- "description": "Number of units.",
- "type": "number"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Cost\". Optional when fee_type is set.",
- "enum": [
- "Fees::Cost"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Attachment (fee_type \"attachment\"). A fee described in an uploaded attachment instead of in the table. Set type to \"Fees::Attachment\" or fee_type to \"attachment\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "attachment_id": {
- "description": "ID of an attachment uploaded with upload-attachment.",
- "type": "string"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"attachment\". Alternative to type.",
- "enum": [
- "attachment"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Attachment\". Optional when fee_type is set.",
- "enum": [
- "Fees::Attachment"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Graduated (fee_type \"graduated\"). Tiered pricing, with the price set per tier in graduated_fee_tiers_attributes. Set type to \"Fees::Graduated\" or fee_type to \"graduated\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"graduated\". Alternative to type.",
- "enum": [
- "graduated"
- ],
- "type": "string"
- },
- "graduated_fee_tiers_attributes": {
- "additionalProperties": {
- "additionalProperties": false,
- "properties": {
- "flat_price": {
- "type": "number"
- },
- "price_per_unit": {
- "type": "string"
- },
- "upper_limit": {
- "type": "number"
- }
- },
- "type": "object"
- },
- "description": "Graduated fee tiers. Use string keys such as \"0\", \"1\".",
- "propertyNames": {
- "type": "string"
- },
- "type": "object"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Graduated\". Optional when fee_type is set.",
- "enum": [
- "Fees::Graduated"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Included (fee_type \"included\"). An item included at no charge. Set type to \"Fees::Included\" or fee_type to \"included\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"included\". Alternative to type.",
- "enum": [
- "included"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Included\". Optional when fee_type is set.",
- "enum": [
- "Fees::Included"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Metered (fee_type \"metered\"). Usage-based pricing, billed per unit used. Set type to \"Fees::Metered\" or fee_type to \"metered\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "Price per unit of usage in fees_currency. A plain amount, not cents: 20 means 20.00.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"metered\". Alternative to type.",
- "enum": [
- "metered"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Metered\". Optional when fee_type is set.",
- "enum": [
- "Fees::Metered"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::OneTime (fee_type \"one_time\"). A one-time charge, such as a setup fee. Set type to \"Fees::OneTime\" or fee_type to \"one_time\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "One-time amount in fees_currency, charged once rather than per fee_period. A plain amount, not cents: 20 means 20.00.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"one_time\". Alternative to type.",
- "enum": [
- "one_time"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::OneTime\". Optional when fee_type is set.",
- "enum": [
- "Fees::OneTime"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Text (fee_type \"text\"). A fee term described in free text. Set type to \"Fees::Text\" or fee_type to \"text\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"text\". Alternative to type.",
- "enum": [
- "text"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Text\". Optional when fee_type is set.",
- "enum": [
- "Fees::Text"
- ],
- "type": "string"
- }
- },
- "type": "object"
- }
- ]
- },
- "description": "Fee line items. Use string keys such as \"0\", \"1\". Replaces template fees when provided.",
- "propertyNames": {
- "type": "string"
- },
- "type": "object"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_additional_changes": {
- "type": "boolean"
- },
- "include_customer_obligation": {
- "type": "boolean"
- },
- "include_customer_obligation_val": {
- "type": "string"
- },
- "include_deliverables": {
- "type": "boolean"
- },
- "include_deliverables_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_deliverables_description": {
- "type": "string"
- },
- "include_deliverables_include_acceptance": {
- "type": "boolean"
- },
- "include_deliverables_include_attachment": {
- "type": "boolean"
- },
- "include_deliverables_include_draft_deliverables": {
- "type": "boolean"
- },
- "include_deliverables_rejection_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_deliverables_rejection_unit": {
- "enum": [
- "hours",
- "days",
- "weeks",
- "months"
- ],
- "type": "string"
- },
- "include_deliverables_resubmission_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_deliverables_resubmission_unit": {
- "enum": [
- "hours",
- "days",
- "weeks",
- "months"
- ],
- "type": "string"
- },
- "include_fees_other": {
- "type": "boolean"
- },
- "include_fees_other_val": {
- "type": "string"
- },
- "include_fees_table": {
- "type": "boolean"
- },
- "include_fees_table_total": {
- "type": "boolean"
- },
- "include_fees_travel": {
- "type": "boolean"
- },
- "include_fees_travel_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_fees_travel_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_fees_travel_val": {
- "type": "string"
- },
- "include_third_party_customer": {
- "type": "boolean"
- },
- "include_third_party_include_description": {
- "type": "boolean"
- },
- "include_third_party_include_description_val": {
- "type": "string"
- },
- "include_third_party_materials": {
- "type": "boolean"
- },
- "include_third_party_provider": {
- "type": "boolean"
- },
- "include_time_of_assignment": {
- "type": "boolean"
- },
- "include_time_of_assignment_type": {
- "enum": [
- "created",
- "paid"
- ],
- "type": "string"
- },
- "invoice_period_description": {
- "type": "string"
- },
- "negotiations_allowed": {
- "description": "When true, the recipient can propose changes to the statement of work, even when the agreement-level `negotiations_allowed` is false. This only covers the statement of work.",
- "type": "boolean"
- },
- "payment_period": {
- "type": "number"
- },
- "payment_period_other": {
- "type": "string"
- },
- "payment_period_timeframe": {
- "enum": [
- "receipt",
- "invoice",
- "Customer's receipt of invoice",
- "date of invoice"
- ],
- "type": "string"
- },
- "payment_period_type": {
- "enum": [
- "standard",
- "other"
- ],
- "type": "string"
- },
- "payment_period_unit": {
- "enum": [
- "day(s)",
- "week(s)",
- "month(s)",
- "quarter(s)",
- "year(s)"
- ],
- "type": "string"
- },
- "quantity": {
- "type": "number"
- },
- "services_description": {
- "type": "string"
- },
- "sow_date": {
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "sow_date_type": {
- "enum": [
- "signature",
- "date"
- ],
- "type": "string"
- },
- "sow_term_amount": {
- "type": "number"
- },
- "sow_term_date": {
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "sow_term_type": {
- "enum": [
- "deliverables",
- "period",
- "date"
- ],
- "type": "string"
- },
- "sow_term_unit": {
- "enum": [
- "month(s)",
- "quarter(s)",
- "year(s)"
- ],
- "type": "string"
- },
- "type": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "recipient_email": {
- "format": "email",
- "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
- "type": "string"
- },
- "recipient_name": {
- "type": "string"
- },
- "recipient_notice_email_address": {
- "description": "Email address for legal notices to the recipient.",
- "format": "email",
- "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
- "type": "string"
- },
- "recipient_organization": {
- "type": "string"
- },
- "recipient_role": {
- "description": "PSA only. The recipient's role: `Customer` (the default) or `Provider`. Send it with `sender_role`; the two must be one `Provider` and one `Customer`. Other standard agreement types ignore it.",
- "type": "string"
- },
- "sender_last_to_sign": {
- "description": "When true, your signer signs after the recipient.",
- "type": "boolean"
- },
- "sender_notice_email_address": {
- "description": "Email address for legal notices to the sender.",
- "format": "email",
- "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
- "type": "string"
- },
- "sender_role": {
- "description": "PSA only. Your company's role: `Provider` (the default) or `Customer` when you hire the recipient to provide the services. Send it with `recipient_role`; the two must be one `Provider` and one `Customer`. When reading a PSA, an empty `sender_role` means `Provider`. Other standard agreement types ignore it.",
- "type": "string"
- },
- "software_license_attributes": {
- "additionalProperties": false,
- "description": "Override software license terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "effective_date": {
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "effective_date_type": {
- "enum": [
- "signature",
- "date"
- ],
- "type": "string"
- },
- "general_cap_amount": {
- "type": "number"
- },
- "general_cap_amount_type": {
- "enum": [
- "preceding",
- "base",
- "period"
- ],
- "type": "string"
- },
- "general_cap_period_currency": {
- "type": "number"
- },
- "general_cap_period_qty": {
- "type": "number"
- },
- "general_cap_preceding_amount": {
- "type": "number"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_additional_warranties": {
- "type": "boolean"
- },
- "include_additional_warranties_by_customer": {
- "type": "string"
- },
- "include_additional_warranties_by_provider": {
- "type": "string"
- },
- "include_additional_warranties_include_by_customer": {
- "type": "boolean"
- },
- "include_additional_warranties_include_by_provider": {
- "type": "boolean"
- },
- "include_ai_addendum": {
- "type": "boolean"
- },
- "include_ai_addendum_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_covered_claims": {
- "type": "boolean"
- },
- "include_covered_claims_customer_claims": {
- "type": "string"
- },
- "include_covered_claims_include_customer_claims": {
- "type": "boolean"
- },
- "include_covered_claims_include_provider_claims": {
- "type": "boolean"
- },
- "include_covered_claims_provider_claims": {
- "type": "string"
- },
- "include_dpa": {
- "type": "boolean"
- },
- "include_dpa_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_dpa_location": {
- "type": "string"
- },
- "include_dpa_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_increased_cap_amount": {
- "type": "boolean"
- },
- "include_increased_claims": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_confidentiality": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_confidentiality_negligence": {
- "type": "boolean"
- },
- "include_increased_claims_include_other": {
- "type": "boolean"
- },
- "include_increased_claims_indemnification_obligation": {
- "type": "boolean"
- },
- "include_increased_claims_negligence": {
- "type": "boolean"
- },
- "include_increased_claims_other": {
- "type": "string"
- },
- "include_increased_claims_restrictions": {
- "type": "boolean"
- },
- "include_unlimited_claims": {
- "type": "boolean"
- },
- "include_unlimited_claims_breach_of_confidentiality": {
- "type": "boolean"
- },
- "include_unlimited_claims_breach_of_confidentiality_negligence": {
- "type": "boolean"
- },
- "include_unlimited_claims_include_other": {
- "type": "boolean"
- },
- "include_unlimited_claims_indemnification_obligation": {
- "type": "boolean"
- },
- "include_unlimited_claims_license_or_restrictions": {
- "type": "boolean"
- },
- "include_unlimited_claims_negligence": {
- "type": "boolean"
- },
- "include_unlimited_claims_other": {
- "type": "string"
- },
- "increased_cap_amount_currency": {
- "type": "number"
- },
- "increased_cap_amount_period_currency": {
- "type": "number"
- },
- "increased_cap_amount_period_qty": {
- "type": "number"
- },
- "increased_cap_amount_qty": {
- "type": "number"
- },
- "increased_cap_amount_type": {
- "enum": [
- "qty",
- "currency",
- "period"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- "software_license_order_form_attributes": {
- "additionalProperties": false,
- "description": "Override software license order form terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "additional_changes": {
- "type": "string"
- },
- "deletion_procedure_include_custom": {
- "type": "boolean"
- },
- "deletion_procedure_include_custom_description": {
- "type": "string"
- },
- "deletion_procedure_include_customer_disable": {
- "type": "boolean"
- },
- "deletion_procedure_include_customer_proof": {
- "type": "boolean"
- },
- "deletion_procedure_include_provider_disable": {
- "type": "boolean"
- },
- "fee_custom_unit": {
- "type": "string"
- },
- "fee_period": {
- "enum": [
- "Subscription Period",
- "month",
- "year",
- "Custom unit"
- ],
- "type": "string"
- },
- "fees_attributes": {
- "additionalProperties": {
- "anyOf": [
- {
- "additionalProperties": false,
- "description": "Fees::Flat (fee_type \"flat\"). A fixed recurring fee, e.g. a platform subscription. Set type to \"Fees::Flat\" or fee_type to \"flat\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "Fixed amount in the order form's fees_currency, charged per fee_period. A plain amount, not cents: 20 means 20.00.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"flat\". Alternative to type.",
- "enum": [
- "flat"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Flat\". Optional when fee_type is set.",
- "enum": [
- "Fees::Flat"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Discount (fee_type \"discount\"). A discount, as a fixed amount or a percentage, applied forever, once, or for a number of months. Set type to \"Fees::Discount\" or fee_type to \"discount\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "Discount size: an amount in fees_currency when discount_type is fixed_amount (a plain amount, not cents: 20 means 20.00), or a percentage (e.g. 10 for 10%) when it is percentage.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "discount_duration_amount": {
- "description": "Number of months the discount applies. Required when discount_duration_type is multiple_months.",
- "type": "number"
- },
- "discount_duration_type": {
- "description": "How long the discount applies. multiple_months also needs discount_duration_amount.",
- "enum": [
- "forever",
- "once",
- "multiple_months"
- ],
- "type": "string"
- },
- "discount_type": {
- "description": "Whether cost is a currency amount or a percentage.",
- "enum": [
- "fixed_amount",
- "percentage"
- ],
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"discount\". Alternative to type.",
- "enum": [
- "discount"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Discount\". Optional when fee_type is set.",
- "enum": [
- "Fees::Discount"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Cost (fee_type \"cost\"). A per-unit fee: price per unit times quantity, e.g. seats. Set type to \"Fees::Cost\" or fee_type to \"cost\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "Price per unit in fees_currency. The row total is quantity x cost. A plain amount, not cents: 20 means 20.00.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"cost\". Alternative to type.",
- "enum": [
- "cost"
- ],
- "type": "string"
- },
- "quantity": {
- "description": "Number of units.",
- "type": "number"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Cost\". Optional when fee_type is set.",
- "enum": [
- "Fees::Cost"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Attachment (fee_type \"attachment\"). A fee described in an uploaded attachment instead of in the table. Set type to \"Fees::Attachment\" or fee_type to \"attachment\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "attachment_id": {
- "description": "ID of an attachment uploaded with upload-attachment.",
- "type": "string"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"attachment\". Alternative to type.",
- "enum": [
- "attachment"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Attachment\". Optional when fee_type is set.",
- "enum": [
- "Fees::Attachment"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Graduated (fee_type \"graduated\"). Tiered pricing, with the price set per tier in graduated_fee_tiers_attributes. Set type to \"Fees::Graduated\" or fee_type to \"graduated\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"graduated\". Alternative to type.",
- "enum": [
- "graduated"
- ],
- "type": "string"
- },
- "graduated_fee_tiers_attributes": {
- "additionalProperties": {
- "additionalProperties": false,
- "properties": {
- "flat_price": {
- "type": "number"
- },
- "price_per_unit": {
- "type": "string"
- },
- "upper_limit": {
- "type": "number"
- }
- },
- "type": "object"
- },
- "description": "Graduated fee tiers. Use string keys such as \"0\", \"1\".",
- "propertyNames": {
- "type": "string"
- },
- "type": "object"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Graduated\". Optional when fee_type is set.",
- "enum": [
- "Fees::Graduated"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Included (fee_type \"included\"). An item included at no charge. Set type to \"Fees::Included\" or fee_type to \"included\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"included\". Alternative to type.",
- "enum": [
- "included"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Included\". Optional when fee_type is set.",
- "enum": [
- "Fees::Included"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Metered (fee_type \"metered\"). Usage-based pricing, billed per unit used. Set type to \"Fees::Metered\" or fee_type to \"metered\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "Price per unit of usage in fees_currency. A plain amount, not cents: 20 means 20.00.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"metered\". Alternative to type.",
- "enum": [
- "metered"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Metered\". Optional when fee_type is set.",
- "enum": [
- "Fees::Metered"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::OneTime (fee_type \"one_time\"). A one-time charge, such as a setup fee. Set type to \"Fees::OneTime\" or fee_type to \"one_time\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "One-time amount in fees_currency, charged once rather than per fee_period. A plain amount, not cents: 20 means 20.00.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"one_time\". Alternative to type.",
- "enum": [
- "one_time"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::OneTime\". Optional when fee_type is set.",
- "enum": [
- "Fees::OneTime"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Text (fee_type \"text\"). A fee term described in free text. Set type to \"Fees::Text\" or fee_type to \"text\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"text\". Alternative to type.",
- "enum": [
- "text"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Text\". Optional when fee_type is set.",
- "enum": [
- "Fees::Text"
- ],
- "type": "string"
- }
- },
- "type": "object"
- }
- ]
- },
- "description": "Fee line items. Use string keys such as \"0\", \"1\". Replaces template fees when provided.",
- "propertyNames": {
- "type": "string"
- },
- "type": "object"
- },
- "fees_currency": {
- "enum": [
- "USD",
- "EUR",
- "GBP",
- "CAD",
- "AUD",
- "SGD",
- "ILS",
- "JPY",
- "CHF",
- "HKD"
- ],
- "type": "string"
- },
- "fees_include_fee_increase_upon_renewal": {
- "type": "boolean"
- },
- "fees_include_fee_increase_upon_renewal_fee": {
- "type": "number"
- },
- "fees_include_fee_increase_upon_renewal_type": {
- "enum": [
- "will",
- "may"
- ],
- "type": "string"
- },
- "fees_inclusive_of_taxes": {
- "type": "boolean"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_additional_changes": {
- "type": "boolean"
- },
- "include_license_compliance_verification": {
- "type": "boolean"
- },
- "include_license_compliance_verification_description": {
- "type": "string"
- },
- "include_license_limits": {
- "type": "boolean"
- },
- "include_license_limits_description": {
- "type": "string"
- },
- "include_payment_process_include_billing_email": {
- "type": "boolean"
- },
- "include_pilot_period": {
- "type": "boolean"
- },
- "include_pilot_period_duration_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_pilot_period_duration_type": {
- "enum": [
- "day",
- "week",
- "month"
- ],
- "type": "string"
- },
- "include_pilot_period_include_fees": {
- "type": "boolean"
- },
- "include_pilot_period_include_fees_amount": {
- "type": "number"
- },
- "include_pilot_period_include_modifications": {
- "type": "boolean"
- },
- "include_pilot_period_include_modifications_description": {
- "type": "string"
- },
- "include_services": {
- "type": "boolean"
- },
- "include_services_description": {
- "type": "string"
- },
- "negotiations_allowed": {
- "description": "When true, the recipient can propose changes to the order form, even when the agreement-level `negotiations_allowed` is false. This only covers the order form.",
- "type": "boolean"
- },
- "order_date_date": {
- "type": "string"
- },
- "order_date_type": {
- "enum": [
- "signature",
- "date",
- "other"
- ],
- "type": "string"
- },
- "payment_process_automatic_frequency": {
- "enum": [
- "monthly",
- "quarterly",
- "semiannually",
- "annually"
- ],
- "type": "string"
- },
- "payment_process_type": {
- "enum": [
- "automatic",
- "invoice",
- "custom"
- ],
- "type": "string"
- },
- "payment_process_type_custom_val": {
- "type": "string"
- },
- "payment_process_type_invoice_amount": {
- "type": "number"
- },
- "payment_process_type_invoice_custom_unit": {
- "type": "string"
- },
- "payment_process_type_invoice_duration": {
- "enum": [
- "day",
- "week",
- "month",
- "year",
- "day(s)",
- "week(s)",
- "month(s)",
- "year(s)"
- ],
- "type": "string"
- },
- "payment_process_type_invoice_duration_start": {
- "enum": [
- "Customer's receipt of invoice",
- "date of invoice"
- ],
- "type": "string"
- },
- "payment_process_type_invoice_type": {
- "enum": [
- "monthly",
- "quarterly",
- "semiannually",
- "annually",
- "Custom unit"
- ],
- "type": "string"
- },
- "permitted_uses_include_custom": {
- "type": "boolean"
- },
- "permitted_uses_include_custom_description": {
- "type": "string"
- },
- "permitted_uses_include_customers_affiliates": {
- "type": "boolean"
- },
- "permitted_uses_include_internal_business": {
- "type": "boolean"
- },
- "pilot_period_stripe_product_id": {
- "type": "string"
- },
- "software_description": {
- "type": "string"
- },
- "subscription_auto_renew": {
- "enum": [
- "days",
- "subscription_end"
- ],
- "type": "string"
- },
- "subscription_period": {
- "type": "number"
- },
- "subscription_period_unit": {
- "type": "string"
- },
- "subscription_renewal_notice_days": {
- "type": "number"
- },
- "warranty_period_description_amount": {
- "type": "number"
- },
- "warranty_period_description_duration": {
- "enum": [
- "day",
- "week",
- "month",
- "year"
- ],
- "type": "string"
- },
- "warranty_period_description_duration_start": {
- "enum": [
- "initial delivery of the Software",
- "delivery of the Software and each subsequent Update",
- "the Order Date"
- ],
- "type": "string"
- },
- "warranty_period_type": {
- "enum": [
- "description",
- "none"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- "test_agreement": {
- "description": "When true, marks the agreement as a test. Test agreements do not count against your monthly limit.",
- "type": "boolean"
- }
- },
- "required": [
- "recipient_name",
- "recipient_email"
- ],
- "type": "object"
- },
- "cc_users": {
- "items": {
- "format": "email",
- "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
- "type": "string"
- },
- "type": "array"
- },
- "draft": {
- "description": "When true, the agreement is saved as a draft and not sent to the recipient. Use POST /v1/agreements/{id}/send to send a draft agreement later.",
- "type": "boolean"
- },
- "owner_email": {
- "description": "Email address of the agreement owner (sender).",
- "type": "string"
- },
- "signer_email": {
- "description": "Email address of the signer from the owner's organization.",
- "format": "email",
- "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
- "type": "string"
- },
- "template_id": {
- "description": "UUID of a template from `GET /v1/templates`. Accepts both Common Paper standard templates and uploaded PDF templates (`type` `uploaded_template`).",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- }
- },
- "required": [
- "template_id",
- "owner_email",
- "signer_email",
- "agreement"
- ],
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "agreement": {
- "additionalProperties": {},
- "properties": {
- "amendment_attributes": {
- "additionalProperties": false,
- "description": "Override amendment terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "amended_terms_attributes": {
- "additionalProperties": {
- "additionalProperties": false,
- "properties": {
- "description": {
- "type": "string"
- },
- "term": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "description": "Amended terms. Use string keys such as \"0\", \"1\".",
- "propertyNames": {
- "type": "string"
- },
- "type": "object"
- },
- "amendment_date": {
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "amendment_date_type": {
- "enum": [
- "signature",
- "date"
- ],
- "type": "string"
- },
- "framework_terms_type": {
- "type": "string"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "parent_agreement_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "underlying_agreement_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "underlying_agreement_type": {
- "type": "string"
- },
- "underlying_agreement_val": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "baa_attributes": {
- "additionalProperties": false,
- "description": "Override baa terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "aggregation_limitations_permitted": {
- "type": "boolean"
- },
- "aggregation_limitations_permitted_val": {
- "type": "string"
- },
- "breach_notification_unit": {
- "enum": [
- "hours",
- "business days",
- "calendar days"
- ],
- "type": "string"
- },
- "breach_notification_val": {
- "type": "number"
- },
- "business_associate_relationship_type": {
- "enum": [
- "provider",
- "company"
- ],
- "type": "string"
- },
- "deidentification_limitations_include_purpose": {
- "type": "boolean"
- },
- "deidentification_limitations_include_requirements": {
- "type": "boolean"
- },
- "deidentification_limitations_permitted": {
- "type": "boolean"
- },
- "deidentification_limitations_purpose_val": {
- "type": "string"
- },
- "deidentification_limitations_requirements_val": {
- "type": "string"
- },
- "designated_record_set_provider_maintains": {
- "type": "boolean"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_aggregation_limitations": {
- "type": "boolean"
- },
- "include_deidentification_limitations": {
- "type": "boolean"
- },
- "include_limitations": {
- "type": "boolean"
- },
- "include_offshore_limitations": {
- "type": "boolean"
- },
- "include_subcontract_limitations": {
- "type": "boolean"
- },
- "offshore_limitations_permitted": {
- "type": "boolean"
- },
- "offshore_limitations_permitted_val": {
- "type": "string"
- },
- "subcontract_limitations_include_notice": {
- "type": "boolean"
- },
- "subcontract_limitations_include_permission": {
- "type": "boolean"
- },
- "subcontract_limitations_notice_val": {
- "type": "string"
- },
- "subcontract_limitations_permission_val": {
- "type": "string"
- },
- "subcontract_limitations_permitted": {
- "type": "boolean"
- },
- "underlying_agreement_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "underlying_agreement_type": {
- "enum": [
- "internal",
- "external",
- "none"
- ],
- "type": "string"
- },
- "underlying_agreement_val": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "billing_email": {
- "description": "Email of the billing contact. Used when include_billing_info is true.",
- "format": "email",
- "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
- "type": "string"
- },
- "billing_name": {
- "description": "Name of the billing contact. Used when include_billing_info is true.",
- "type": "string"
- },
- "billing_workflow_type": {
- "description": "The type of billing workflow. Use \"link\" to provide a payment_link_url, or \"stripe\" for Stripe-managed billing.",
- "enum": [
- "link",
- "stripe"
- ],
- "type": "string"
- },
- "chosen_courts_country": {
- "description": "The country in which disputes will be resolved.",
- "type": "string"
- },
- "chosen_courts_region": {
- "description": "The state or region in which disputes will be resolved.",
- "type": "string"
- },
- "csa_attributes": {
- "additionalProperties": false,
- "description": "Override csa terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "customer_description": {
- "type": "string"
- },
- "effective_date": {
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "effective_date_marketplace": {
- "enum": [
- "AWS",
- "GCP",
- "Azure"
- ],
- "type": "string"
- },
- "effective_date_type": {
- "enum": [
- "signature",
- "date",
- "marketplace_acceptance"
- ],
- "type": "string"
- },
- "general_cap_amount": {
- "type": "number"
- },
- "general_cap_amount_type": {
- "enum": [
- "preceding",
- "base",
- "period"
- ],
- "type": "string"
- },
- "general_cap_period_currency": {
- "type": "number"
- },
- "general_cap_period_qty": {
- "type": "number"
- },
- "general_cap_preceding_amount": {
- "type": "number"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_acceptable_use_policy": {
- "type": "boolean"
- },
- "include_acceptable_use_policy_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_acceptable_use_policy_location": {
- "type": "string"
- },
- "include_acceptable_use_policy_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_additional_warranties": {
- "type": "boolean"
- },
- "include_additional_warranties_by_customer": {
- "type": "string"
- },
- "include_additional_warranties_by_provider": {
- "type": "string"
- },
- "include_additional_warranties_include_by_customer": {
- "type": "boolean"
- },
- "include_additional_warranties_include_by_provider": {
- "type": "boolean"
- },
- "include_ai_addendum": {
- "type": "boolean"
- },
- "include_ai_addendum_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_covered_claims": {
- "type": "boolean"
- },
- "include_covered_claims_customer_claims": {
- "type": "string"
- },
- "include_covered_claims_include_customer_claims": {
- "type": "boolean"
- },
- "include_covered_claims_include_provider_claims": {
- "type": "boolean"
- },
- "include_covered_claims_provider_claims": {
- "type": "string"
- },
- "include_dpa": {
- "type": "boolean"
- },
- "include_dpa_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_dpa_location": {
- "type": "string"
- },
- "include_dpa_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_increased_cap_amount": {
- "type": "boolean"
- },
- "include_increased_claims": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_confidentiality": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_confidentiality_negligence": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_privsec": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_privsec_negligence": {
- "type": "boolean"
- },
- "include_increased_claims_include_other": {
- "type": "boolean"
- },
- "include_increased_claims_indemnification_obligation": {
- "type": "boolean"
- },
- "include_increased_claims_other": {
- "type": "string"
- },
- "include_insurance_minimums": {
- "type": "boolean"
- },
- "include_insurance_minimums_add_customer": {
- "type": "boolean"
- },
- "include_insurance_minimums_add_customer_com_gen_liability": {
- "type": "boolean"
- },
- "include_insurance_minimums_add_customer_cyber_liability": {
- "type": "boolean"
- },
- "include_insurance_minimums_add_customer_errors_omissions": {
- "type": "boolean"
- },
- "include_insurance_minimums_additional_information": {
- "type": "boolean"
- },
- "include_insurance_minimums_additional_information_text": {
- "type": "string"
- },
- "include_insurance_minimums_cyber_liability_aggregate": {
- "type": "number"
- },
- "include_insurance_minimums_cyber_liability_minimum": {
- "type": "number"
- },
- "include_insurance_minimums_employer_liability_aggregate": {
- "type": "number"
- },
- "include_insurance_minimums_employer_liability_minimum": {
- "type": "number"
- },
- "include_insurance_minimums_general_liability_aggregate": {
- "type": "number"
- },
- "include_insurance_minimums_general_liability_minimum": {
- "type": "number"
- },
- "include_insurance_minimums_include_cyber_liability": {
- "type": "boolean"
- },
- "include_insurance_minimums_include_employer_liability": {
- "type": "boolean"
- },
- "include_insurance_minimums_include_general_liability": {
- "type": "boolean"
- },
- "include_insurance_minimums_include_workers_compensation": {
- "type": "boolean"
- },
- "include_publicity_rights": {
- "type": "boolean"
- },
- "include_publicity_rights_type": {
- "enum": [
- "public",
- "non-public"
- ],
- "type": "string"
- },
- "include_security_policy": {
- "type": "boolean"
- },
- "include_security_policy_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_security_policy_fedramp_auth": {
- "type": "boolean"
- },
- "include_security_policy_hipaa": {
- "type": "boolean"
- },
- "include_security_policy_hitrust": {
- "type": "boolean"
- },
- "include_security_policy_include_annual_maintenance": {
- "type": "boolean"
- },
- "include_security_policy_include_location": {
- "type": "boolean"
- },
- "include_security_policy_include_other": {
- "type": "boolean"
- },
- "include_security_policy_include_reasonable_efforts": {
- "type": "boolean"
- },
- "include_security_policy_iso27001": {
- "type": "boolean"
- },
- "include_security_policy_location": {
- "type": "string"
- },
- "include_security_policy_other": {
- "type": "string"
- },
- "include_security_policy_pci1": {
- "type": "boolean"
- },
- "include_security_policy_pci2": {
- "type": "boolean"
- },
- "include_security_policy_penetration_testing": {
- "type": "boolean"
- },
- "include_security_policy_soc2": {
- "type": "boolean"
- },
- "include_security_policy_soc2_type2": {
- "type": "boolean"
- },
- "include_security_policy_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_supercap": {
- "description": "CSA 3.0 renamed `include_increased_cap_amount` to `include_supercap`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_increased_cap_amount`. Sending the other spelling returns a 422.",
- "type": "boolean"
- },
- "include_uncapped_claims": {
- "description": "CSA 3.0 renamed `include_unlimited_claims` to `include_uncapped_claims`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims`. Sending the other spelling returns a 422.",
- "type": "boolean"
- },
- "include_uncapped_claims_breach_of_confidentiality": {
- "description": "CSA 3.0 renamed `include_unlimited_claims_breach_of_confidentiality` to `include_uncapped_claims_breach_of_confidentiality`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_breach_of_confidentiality`. Sending the other spelling returns a 422.",
- "type": "boolean"
- },
- "include_uncapped_claims_breach_of_confidentiality_negligence": {
- "description": "CSA 3.0 renamed `include_unlimited_claims_breach_of_confidentiality_negligence` to `include_uncapped_claims_breach_of_confidentiality_negligence`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_breach_of_confidentiality_negligence`. Sending the other spelling returns a 422.",
- "type": "boolean"
- },
- "include_uncapped_claims_breach_of_privsec": {
- "description": "CSA 3.0 renamed `include_unlimited_claims_breach_of_privsec` to `include_uncapped_claims_breach_of_privsec`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_breach_of_privsec`. Sending the other spelling returns a 422.",
- "type": "boolean"
- },
- "include_uncapped_claims_breach_of_privsec_negligence": {
- "description": "CSA 3.0 renamed `include_unlimited_claims_breach_of_privsec_negligence` to `include_uncapped_claims_breach_of_privsec_negligence`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_breach_of_privsec_negligence`. Sending the other spelling returns a 422.",
- "type": "boolean"
- },
- "include_uncapped_claims_include_other": {
- "description": "CSA 3.0 renamed `include_unlimited_claims_include_other` to `include_uncapped_claims_include_other`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_include_other`. Sending the other spelling returns a 422.",
- "type": "boolean"
- },
- "include_uncapped_claims_indemnification_obligation": {
- "description": "CSA 3.0 renamed `include_unlimited_claims_indemnification_obligation` to `include_uncapped_claims_indemnification_obligation`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_indemnification_obligation`. Sending the other spelling returns a 422.",
- "type": "boolean"
- },
- "include_uncapped_claims_other": {
- "description": "CSA 3.0 renamed `include_unlimited_claims_other` to `include_uncapped_claims_other`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_other`. Sending the other spelling returns a 422.",
- "type": "boolean"
- },
- "include_unlimited_claims": {
- "type": "boolean"
- },
- "include_unlimited_claims_breach_of_confidentiality": {
- "type": "boolean"
- },
- "include_unlimited_claims_breach_of_confidentiality_negligence": {
- "type": "boolean"
- },
- "include_unlimited_claims_breach_of_privsec": {
- "type": "boolean"
- },
- "include_unlimited_claims_breach_of_privsec_negligence": {
- "type": "boolean"
- },
- "include_unlimited_claims_include_other": {
- "type": "boolean"
- },
- "include_unlimited_claims_indemnification_obligation": {
- "type": "boolean"
- },
- "include_unlimited_claims_other": {
- "type": "string"
- },
- "increased_cap_amount_currency": {
- "type": "number"
- },
- "increased_cap_amount_period_currency": {
- "type": "number"
- },
- "increased_cap_amount_period_qty": {
- "type": "number"
- },
- "increased_cap_amount_qty": {
- "type": "number"
- },
- "increased_cap_amount_type": {
- "enum": [
- "qty",
- "currency",
- "period"
- ],
- "type": "string"
- },
- "provider": {
- "type": "string"
- },
- "supercap_currency": {
- "description": "CSA 3.0 renamed `increased_cap_amount_currency` to `supercap_currency`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `increased_cap_amount_currency`. Sending the other spelling returns a 422.",
- "type": "number"
- },
- "supercap_period_currency": {
- "description": "CSA 3.0 renamed `increased_cap_amount_period_currency` to `supercap_period_currency`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `increased_cap_amount_period_currency`. Sending the other spelling returns a 422.",
- "type": "number"
- },
- "supercap_period_qty": {
- "description": "CSA 3.0 renamed `increased_cap_amount_period_qty` to `supercap_period_qty`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `increased_cap_amount_period_qty`. Sending the other spelling returns a 422.",
- "type": "number"
- },
- "supercap_qty": {
- "description": "CSA 3.0 renamed `increased_cap_amount_qty` to `supercap_qty`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `increased_cap_amount_qty`. Sending the other spelling returns a 422.",
- "type": "number"
- },
- "supercap_type": {
- "description": "CSA 3.0 renamed `increased_cap_amount_type` to `supercap_type`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `increased_cap_amount_type`. Sending the other spelling returns a 422.",
- "type": "number"
- }
- },
- "type": "object"
- },
- "csa_order_form_attributes": {
- "additionalProperties": false,
- "description": "Override csa order form terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "additional_changes": {
- "type": "string"
- },
- "additional_parameters_or_limitations": {
- "type": "string"
- },
- "affiliates_as_users": {
- "type": "boolean"
- },
- "cloud_service_description": {
- "type": "string"
- },
- "consumption_units": {
- "type": "string"
- },
- "fee_amount": {
- "type": "number"
- },
- "fee_custom_unit": {
- "type": "string"
- },
- "fee_period": {
- "enum": [
- "Subscription Period",
- "month",
- "year",
- "User",
- "Custom unit"
- ],
- "type": "string"
- },
- "fees_attributes": {
- "additionalProperties": {
- "anyOf": [
- {
- "additionalProperties": false,
- "description": "Fees::Flat (fee_type \"flat\"). A fixed recurring fee, e.g. a platform subscription. Set type to \"Fees::Flat\" or fee_type to \"flat\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "Fixed amount in the order form's fees_currency, charged per fee_period. A plain amount, not cents: 20 means 20.00.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"flat\". Alternative to type.",
- "enum": [
- "flat"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Flat\". Optional when fee_type is set.",
- "enum": [
- "Fees::Flat"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Discount (fee_type \"discount\"). A discount, as a fixed amount or a percentage, applied forever, once, or for a number of months. Set type to \"Fees::Discount\" or fee_type to \"discount\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "Discount size: an amount in fees_currency when discount_type is fixed_amount (a plain amount, not cents: 20 means 20.00), or a percentage (e.g. 10 for 10%) when it is percentage.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "discount_duration_amount": {
- "description": "Number of months the discount applies. Required when discount_duration_type is multiple_months.",
- "type": "number"
- },
- "discount_duration_type": {
- "description": "How long the discount applies. multiple_months also needs discount_duration_amount.",
- "enum": [
- "forever",
- "once",
- "multiple_months"
- ],
- "type": "string"
- },
- "discount_type": {
- "description": "Whether cost is a currency amount or a percentage.",
- "enum": [
- "fixed_amount",
- "percentage"
- ],
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"discount\". Alternative to type.",
- "enum": [
- "discount"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Discount\". Optional when fee_type is set.",
- "enum": [
- "Fees::Discount"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Cost (fee_type \"cost\"). A per-unit fee: price per unit times quantity, e.g. seats. Set type to \"Fees::Cost\" or fee_type to \"cost\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "Price per unit in fees_currency. The row total is quantity x cost. A plain amount, not cents: 20 means 20.00.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"cost\". Alternative to type.",
- "enum": [
- "cost"
- ],
- "type": "string"
- },
- "quantity": {
- "description": "Number of units.",
- "type": "number"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Cost\". Optional when fee_type is set.",
- "enum": [
- "Fees::Cost"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Attachment (fee_type \"attachment\"). A fee described in an uploaded attachment instead of in the table. Set type to \"Fees::Attachment\" or fee_type to \"attachment\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "attachment_id": {
- "description": "ID of an attachment uploaded with upload-attachment.",
- "type": "string"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"attachment\". Alternative to type.",
- "enum": [
- "attachment"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Attachment\". Optional when fee_type is set.",
- "enum": [
- "Fees::Attachment"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Graduated (fee_type \"graduated\"). Tiered pricing, with the price set per tier in graduated_fee_tiers_attributes. Set type to \"Fees::Graduated\" or fee_type to \"graduated\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"graduated\". Alternative to type.",
- "enum": [
- "graduated"
- ],
- "type": "string"
- },
- "graduated_fee_tiers_attributes": {
- "additionalProperties": {
- "additionalProperties": false,
- "properties": {
- "flat_price": {
- "type": "number"
- },
- "price_per_unit": {
- "type": "string"
- },
- "upper_limit": {
- "type": "number"
- }
- },
- "type": "object"
- },
- "description": "Graduated fee tiers. Use string keys such as \"0\", \"1\".",
- "propertyNames": {
- "type": "string"
- },
- "type": "object"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Graduated\". Optional when fee_type is set.",
- "enum": [
- "Fees::Graduated"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Included (fee_type \"included\"). An item included at no charge. Set type to \"Fees::Included\" or fee_type to \"included\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"included\". Alternative to type.",
- "enum": [
- "included"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Included\". Optional when fee_type is set.",
- "enum": [
- "Fees::Included"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Metered (fee_type \"metered\"). Usage-based pricing, billed per unit used. Set type to \"Fees::Metered\" or fee_type to \"metered\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "Price per unit of usage in fees_currency. A plain amount, not cents: 20 means 20.00.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"metered\". Alternative to type.",
- "enum": [
- "metered"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Metered\". Optional when fee_type is set.",
- "enum": [
- "Fees::Metered"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::OneTime (fee_type \"one_time\"). A one-time charge, such as a setup fee. Set type to \"Fees::OneTime\" or fee_type to \"one_time\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "One-time amount in fees_currency, charged once rather than per fee_period. A plain amount, not cents: 20 means 20.00.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"one_time\". Alternative to type.",
- "enum": [
- "one_time"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::OneTime\". Optional when fee_type is set.",
- "enum": [
- "Fees::OneTime"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Text (fee_type \"text\"). A fee term described in free text. Set type to \"Fees::Text\" or fee_type to \"text\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"text\". Alternative to type.",
- "enum": [
- "text"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Text\". Optional when fee_type is set.",
- "enum": [
- "Fees::Text"
- ],
- "type": "string"
- }
- },
- "type": "object"
- }
- ]
- },
- "description": "Fee table rows, keyed by string index (\"0\", \"1\", ...). Replaces the template's fees when provided. Each row sets type or fee_type to pick the fee class. Amounts are in the order form's fees_currency and, for recurring fees, are charged per fee_period.",
- "examples": [
- {
- "0": {
- "cost": 2000,
- "description": "Platform subscription",
- "type": "Fees::Flat"
- }
- },
- {
- "0": {
- "cost": 50,
- "description": "Seats",
- "fee_type": "cost",
- "quantity": 10
- },
- "1": {
- "cost": 10,
- "description": "Launch discount",
- "discount_duration_amount": 3,
- "discount_duration_type": "multiple_months",
- "discount_type": "percentage",
- "fee_type": "discount"
- }
- }
- ],
- "propertyNames": {
- "type": "string"
- },
- "type": "object"
- },
- "fees_currency": {
- "enum": [
- "USD",
- "EUR",
- "GBP",
- "CAD",
- "AUD",
- "SGD",
- "ILS",
- "JPY",
- "CHF",
- "HKD"
- ],
- "type": "string"
- },
- "fees_include_fee_increase_upon_renewal": {
- "type": "boolean"
- },
- "fees_include_fee_increase_upon_renewal_fee": {
- "type": "number"
- },
- "fees_include_fee_increase_upon_renewal_type": {
- "enum": [
- "will",
- "may"
- ],
- "type": "string"
- },
- "fees_inclusive_of_taxes": {
- "type": "boolean"
- },
- "framework_terms_type": {
- "enum": [
- "new",
- "existing",
- "description"
- ],
- "type": "string"
- },
- "free_trial_days": {
- "type": "number"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_additional_changes": {
- "type": "boolean"
- },
- "include_additional_parameters_or_limitations": {
- "type": "boolean"
- },
- "include_consumption": {
- "type": "boolean"
- },
- "include_fees": {
- "type": "boolean"
- },
- "include_fees_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_fees_include_attachment": {
- "type": "boolean"
- },
- "include_fees_other": {
- "type": "boolean"
- },
- "include_fees_other_val": {
- "type": "string"
- },
- "include_fees_table": {
- "type": "boolean"
- },
- "include_fees_table_period": {
- "enum": [
- "Subscription Period",
- "month",
- "year",
- "User"
- ],
- "type": "string"
- },
- "include_free_trial": {
- "type": "boolean"
- },
- "include_max_users": {
- "type": "boolean"
- },
- "include_pilot_period": {
- "type": "boolean"
- },
- "include_pilot_period_duration_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_pilot_period_duration_type": {
- "enum": [
- "day",
- "week",
- "month"
- ],
- "type": "string"
- },
- "include_pilot_period_include_fees": {
- "type": "boolean"
- },
- "include_pilot_period_include_fees_amount": {
- "type": "number"
- },
- "include_pilot_period_include_modifications": {
- "type": "boolean"
- },
- "include_pilot_period_include_modifications_description": {
- "type": "string"
- },
- "include_product_support": {
- "type": "boolean"
- },
- "include_product_support_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_product_support_description": {
- "type": "string"
- },
- "include_product_support_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_professional_services": {
- "type": "boolean"
- },
- "include_professional_services_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_professional_services_custom_name": {
- "type": "string"
- },
- "include_professional_services_description": {
- "type": "string"
- },
- "include_professional_services_end_date": {
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "include_professional_services_fees_description": {
- "type": "string"
- },
- "include_professional_services_include_end_date": {
- "type": "boolean"
- },
- "include_professional_services_include_fees_description": {
- "type": "boolean"
- },
- "include_professional_services_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_sla": {
- "type": "boolean"
- },
- "include_sla_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_sla_description": {
- "type": "string"
- },
- "include_sla_include_response_time": {
- "type": "boolean"
- },
- "include_sla_include_response_time_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_sla_include_response_time_credit": {
- "type": "number"
- },
- "include_sla_include_response_time_duration": {
- "enum": [
- "hour",
- "day",
- "week",
- "month",
- "hours"
- ],
- "type": "string"
- },
- "include_sla_include_response_time_support_channel": {
- "type": "string"
- },
- "include_sla_include_target_uptime": {
- "type": "boolean"
- },
- "include_sla_maintenance_notice": {
- "type": "boolean"
- },
- "include_sla_maintenance_window": {
- "type": "boolean"
- },
- "include_sla_maintenance_window_type": {
- "enum": [
- "standard",
- "none"
- ],
- "type": "string"
- },
- "include_sla_standard_maintenance_notice_qty": {
- "type": "number"
- },
- "include_sla_standard_maintenance_notice_unit": {
- "enum": [
- "hour",
- "day",
- "week",
- "month"
- ],
- "type": "string"
- },
- "include_sla_standard_maintenance_window_end_time": {
- "type": "string"
- },
- "include_sla_standard_maintenance_window_friday": {
- "type": "boolean"
- },
- "include_sla_standard_maintenance_window_monday": {
- "type": "boolean"
- },
- "include_sla_standard_maintenance_window_saturday": {
- "type": "boolean"
- },
- "include_sla_standard_maintenance_window_start_time": {
- "type": "string"
- },
- "include_sla_standard_maintenance_window_sunday": {
- "type": "boolean"
- },
- "include_sla_standard_maintenance_window_thursday": {
- "type": "boolean"
- },
- "include_sla_standard_maintenance_window_time_zone": {
- "type": "string"
- },
- "include_sla_standard_maintenance_window_tuesday": {
- "type": "boolean"
- },
- "include_sla_standard_maintenance_window_wednesday": {
- "type": "boolean"
- },
- "include_sla_standard_target_uptime": {
- "type": "number"
- },
- "include_sla_type": {
- "enum": [
- "description",
- "standard",
- "attachment"
- ],
- "type": "string"
- },
- "include_subscription_start_date": {
- "type": "boolean"
- },
- "include_subscription_start_date_date": {
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "include_usage_review": {
- "type": "boolean"
- },
- "include_usage_review_val": {
- "type": "string"
- },
- "include_use_limitations": {
- "type": "boolean"
- },
- "include_use_limitations_val": {
- "type": "string"
- },
- "invoice_period": {
- "enum": [
- "monthly",
- "quarterly",
- "semiannually",
- "annually",
- "Custom unit",
- "Monthly",
- "Quarterly",
- "Semiannually",
- "Annually"
- ],
- "type": "string"
- },
- "invoice_period_custom_unit": {
- "type": "string"
- },
- "max_consumption": {
- "type": "number"
- },
- "max_users": {
- "type": "number"
- },
- "negotiations_allowed": {
- "description": "When true, the recipient can propose changes to the order form, even when the agreement-level `negotiations_allowed` is false. This only covers the order form.",
- "type": "boolean"
- },
- "order_date_date": {
- "type": "string"
- },
- "order_date_other": {
- "type": "string"
- },
- "order_date_type": {
- "enum": [
- "signature",
- "date",
- "other"
- ],
- "type": "string"
- },
- "payment_period": {
- "type": "number"
- },
- "payment_period_timeframe": {
- "enum": [
- "Customer's receipt of invoice",
- "date of invoice"
- ],
- "type": "string"
- },
- "payment_period_unit": {
- "enum": [
- "day(s)",
- "week(s)",
- "month(s)",
- "marketplace_acceptance"
- ],
- "type": "string"
- },
- "payment_process_automatic_frequency": {
- "enum": [
- "monthly",
- "quarterly",
- "semiannually",
- "annually"
- ],
- "type": "string"
- },
- "payment_process_type": {
- "enum": [
- "automatic",
- "invoice",
- "custom",
- "marketplace_acceptance"
- ],
- "type": "string"
- },
- "payment_process_type_custom_val": {
- "type": "string"
- },
- "payment_process_type_invoice_amount": {
- "type": "number"
- },
- "payment_process_type_invoice_custom_unit": {
- "type": "string"
- },
- "payment_process_type_invoice_duration": {
- "enum": [
- "day",
- "week",
- "month",
- "year",
- "day(s)",
- "week(s)",
- "month(s)",
- "year(s)"
- ],
- "type": "string"
- },
- "payment_process_type_invoice_duration_start": {
- "enum": [
- "Customer's receipt of invoice",
- "date of invoice"
- ],
- "type": "string"
- },
- "payment_process_type_invoice_type": {
- "enum": [
- "monthly",
- "quarterly",
- "semiannually",
- "annually",
- "Custom unit"
- ],
- "type": "string"
- },
- "pilot_period_stripe_product_id": {
- "type": "string"
- },
- "service_credits_attributes": {
- "additionalProperties": {
- "additionalProperties": false,
- "properties": {
- "credit": {
- "type": "number"
- },
- "max": {
- "type": "number"
- },
- "min": {
- "type": "number"
- }
- },
- "type": "object"
- },
- "description": "Service credits. Use string keys such as \"0\", \"1\".",
- "propertyNames": {
- "type": "string"
- },
- "type": "object"
- },
- "subscription_auto_renew": {
- "enum": [
- "days",
- "subscription_end"
- ],
- "type": "string"
- },
- "subscription_period": {
- "type": "number"
- },
- "subscription_period_unit": {
- "type": "string"
- },
- "subscription_renewal_notice_days": {
- "type": "number"
- },
- "subscription_start_date": {
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "subscription_start_date_type": {
- "enum": [
- "effective_date",
- "date"
- ],
- "type": "string"
- },
- "underlying_agreement_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "use_limitations_attributes": {
- "additionalProperties": {
- "additionalProperties": false,
- "properties": {
- "amount": {
- "type": "number"
- },
- "limitation_type": {
- "type": "string"
- },
- "unit": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "description": "Use limitations. Use string keys such as \"0\", \"1\".",
- "propertyNames": {
- "type": "string"
- },
- "type": "object"
- }
- },
- "type": "object"
- },
- "custom_field_values": {
- "description": "Values for a custom template's fields, keyed by the field keys defined in the template's YAML definition. Only used when template_id is a custom template. Template defaults fill any fields you omit; a required field with no default and no submitted value returns a 400 naming the field. Values are validated against the field's input type: select and radio values must be one of the field's options, multiselect values are an array of selections each of which must be one of the field's options, number and currency values must be numeric, date values must be YYYY-MM-DD, and email values must be valid addresses. An invalid value returns a 400 naming the field."
- },
- "design_partner_attributes": {
- "additionalProperties": false,
- "description": "Override design partner terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "customer_description": {
- "type": "string"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_fees": {
- "type": "boolean"
- },
- "include_fees_amount": {
- "type": "number"
- },
- "include_fees_description": {
- "type": "string"
- },
- "include_fees_pay_by_amount": {
- "type": "string"
- },
- "include_fees_type": {
- "enum": [
- "default_language",
- "description"
- ],
- "type": "string"
- },
- "include_fees_unit": {
- "enum": [
- "month",
- "quarter",
- "year",
- "Term"
- ],
- "type": "string"
- },
- "include_program_appear_as_customer_private": {
- "type": "boolean"
- },
- "include_program_appear_as_customer_public": {
- "type": "boolean"
- },
- "include_program_case_study": {
- "type": "boolean"
- },
- "include_program_develop_functionality": {
- "type": "boolean"
- },
- "include_program_develop_functionality_val": {
- "type": "string"
- },
- "include_program_discount": {
- "type": "boolean"
- },
- "include_program_discount_amount": {
- "type": "number"
- },
- "include_program_discount_unit": {
- "enum": [
- "U.S. Dollars",
- "percent"
- ],
- "type": "string"
- },
- "include_program_participation_feedback": {
- "type": "boolean"
- },
- "include_program_participation_feedback_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_program_participation_feedback_unit": {
- "enum": [
- "month",
- "quarter",
- "year",
- "Term"
- ],
- "type": "string"
- },
- "include_program_partner_other": {
- "type": "boolean"
- },
- "include_program_partner_other_val": {
- "type": "string"
- },
- "include_program_provider_other": {
- "type": "boolean"
- },
- "include_program_provider_other_val": {
- "type": "string"
- },
- "include_program_reference": {
- "type": "boolean"
- },
- "product_description": {
- "type": "string"
- },
- "term_amount": {
- "type": "number"
- },
- "term_unit": {
- "enum": [
- "day(s)",
- "week(s)",
- "month(s)",
- "quarter(s)",
- "year(s)"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- "district_or_county": {
- "description": "The district or county for dispute resolution.",
- "type": "string"
- },
- "dpa_attributes": {
- "additionalProperties": false,
- "description": "Override dpa terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "approved_subprocessor_type": {
- "description": "`internal` lists approved subprocessors in the agreement (`subprocessors_attributes`); `external` points to a list published elsewhere.",
- "enum": [
- "internal",
- "external"
- ],
- "type": "string"
- },
- "cloud_service_product_name": {
- "type": "string"
- },
- "competent_supervisory_authority": {
- "type": "string"
- },
- "customer_description": {
- "type": "string"
- },
- "data_exporter_address_city": {
- "type": "string"
- },
- "data_exporter_address_country": {
- "type": "string"
- },
- "data_exporter_address_state": {
- "type": "string"
- },
- "data_exporter_address_street_address": {
- "type": "string"
- },
- "data_exporter_address_zipcode": {
- "type": "string"
- },
- "data_exporter_contact_details": {
- "type": "string"
- },
- "data_exporter_contact_name": {
- "type": "string"
- },
- "data_exporter_contact_position": {
- "type": "string"
- },
- "data_exporter_role": {
- "description": "Role of the data exporter. Overwritten to `Controller` when the agreement is created from a template.",
- "enum": [
- "Controller",
- "Processor"
- ],
- "type": "string"
- },
- "data_importer_address": {
- "type": "string"
- },
- "data_importer_address_city": {
- "type": "string"
- },
- "data_importer_address_country": {
- "type": "string"
- },
- "data_importer_address_state": {
- "type": "string"
- },
- "data_importer_address_street_address": {
- "type": "string"
- },
- "data_importer_address_zipcode": {
- "type": "string"
- },
- "data_importer_contact_details": {
- "type": "string"
- },
- "data_importer_contact_name": {
- "type": "string"
- },
- "data_importer_contact_position": {
- "type": "string"
- },
- "duration_of_processing": {
- "type": "string"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_covered_claim": {
- "type": "boolean"
- },
- "include_covered_claim_external_val": {
- "type": "string"
- },
- "include_covered_claim_internal_val": {
- "type": "string"
- },
- "include_covered_claim_type": {
- "description": "Which covered-claim text applies: `internal` uses `include_covered_claim_internal_val`, `external` uses `include_covered_claim_external_val`. Required when `include_covered_claim` is true.",
- "enum": [
- "internal",
- "external"
- ],
- "type": "string"
- },
- "include_data_subjects_custom": {
- "type": "boolean"
- },
- "include_data_subjects_custom_val": {
- "type": "string"
- },
- "include_data_subjects_employees": {
- "type": "boolean"
- },
- "include_data_subjects_end_users": {
- "type": "boolean"
- },
- "include_external_subprocessor_location": {
- "type": "string"
- },
- "include_frequency_of_transfer_continuous": {
- "type": "boolean"
- },
- "include_frequency_of_transfer_custom": {
- "type": "boolean"
- },
- "include_frequency_of_transfer_custom_val": {
- "type": "string"
- },
- "include_governing_country_eu": {
- "type": "boolean"
- },
- "include_governing_country_eu_val": {
- "type": "string"
- },
- "include_governing_country_uk": {
- "type": "boolean"
- },
- "include_governing_country_uk_val": {
- "type": "string"
- },
- "include_governing_law": {
- "type": "boolean"
- },
- "include_governing_law_country": {
- "type": "string"
- },
- "include_governing_law_state": {
- "type": "string"
- },
- "include_increased_claim_amount": {
- "description": "Legacy field. Stored but not shown on the DPA; use the `include_liability_cap*` fields instead.",
- "type": "boolean"
- },
- "include_increased_claim_amount_currency": {
- "description": "Legacy field. Stored but not shown on the DPA; use the `include_liability_cap*` fields instead."
- },
- "include_increased_claim_amount_qty": {
- "description": "Legacy field. Stored but not shown on the DPA; use the `include_liability_cap*` fields instead."
- },
- "include_increased_claim_amount_type": {
- "description": "Legacy field. Stored but not shown on the DPA; use the `include_liability_cap*` fields instead.",
- "type": "string"
- },
- "include_liability_cap": {
- "type": "boolean"
- },
- "include_liability_cap_amount_constant_external": {
- "type": "string"
- },
- "include_liability_cap_amount_constant_internal": {
- "type": "string"
- },
- "include_liability_cap_amount_currency_external": {
- "description": "Currency amount. Numbers and numeric strings (commas allowed) are both accepted."
- },
- "include_liability_cap_amount_currency_internal": {
- "description": "Currency amount. Numbers and numeric strings (commas allowed) are both accepted."
- },
- "include_liability_cap_csa_type": {
- "description": "Which liability cap values apply: the `_internal` or `_external` amount fields. Required when `include_liability_cap` is true.",
- "enum": [
- "internal",
- "external"
- ],
- "type": "string"
- },
- "include_personal_data_biographic_info": {
- "type": "boolean"
- },
- "include_personal_data_contact_info": {
- "type": "boolean"
- },
- "include_personal_data_custom": {
- "type": "boolean"
- },
- "include_personal_data_custom_val": {
- "type": "string"
- },
- "include_personal_data_employment_info": {
- "type": "boolean"
- },
- "include_personal_data_financial_info": {
- "type": "boolean"
- },
- "include_personal_data_location": {
- "type": "boolean"
- },
- "include_personal_data_name": {
- "type": "boolean"
- },
- "include_personal_data_transactional_info": {
- "type": "boolean"
- },
- "include_personal_data_user_activity_info": {
- "type": "boolean"
- },
- "include_processing_purpose_custom": {
- "type": "boolean"
- },
- "include_processing_purpose_custom_val": {
- "type": "string"
- },
- "include_processing_purpose_erasing": {
- "type": "boolean"
- },
- "include_processing_purpose_holding": {
- "type": "boolean"
- },
- "include_processing_purpose_protecting": {
- "type": "boolean"
- },
- "include_processing_purpose_receiving": {
- "type": "boolean"
- },
- "include_processing_purpose_returning": {
- "type": "boolean"
- },
- "include_processing_purpose_sharing": {
- "type": "boolean"
- },
- "include_processing_purpose_updating": {
- "type": "boolean"
- },
- "include_processing_purpose_using": {
- "type": "boolean"
- },
- "include_provider_security_contact_address": {
- "type": "boolean"
- },
- "include_provider_security_contact_address_city": {
- "type": "string"
- },
- "include_provider_security_contact_address_country": {
- "type": "string"
- },
- "include_provider_security_contact_address_state": {
- "type": "string"
- },
- "include_provider_security_contact_address_street_address": {
- "type": "string"
- },
- "include_provider_security_contact_address_zipcode": {
- "type": "string"
- },
- "include_provider_security_contact_email": {
- "type": "boolean"
- },
- "include_provider_security_contact_email_val": {
- "format": "email",
- "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
- "type": "string"
- },
- "include_security_measures_accountability": {
- "type": "boolean"
- },
- "include_security_measures_accountability_val": {
- "type": "string"
- },
- "include_security_measures_certification_or_assurance": {
- "type": "boolean"
- },
- "include_security_measures_certification_or_assurance_val": {
- "type": "string"
- },
- "include_security_measures_confidentiality_integrity": {
- "type": "boolean"
- },
- "include_security_measures_confidentiality_integrity_val": {
- "type": "string"
- },
- "include_security_measures_data_at_rest": {
- "type": "boolean"
- },
- "include_security_measures_data_at_rest_val": {
- "type": "string"
- },
- "include_security_measures_data_minimization": {
- "type": "boolean"
- },
- "include_security_measures_data_minimization_val": {
- "type": "string"
- },
- "include_security_measures_data_quality": {
- "type": "boolean"
- },
- "include_security_measures_data_quality_val": {
- "type": "string"
- },
- "include_security_measures_data_retention": {
- "type": "boolean"
- },
- "include_security_measures_data_retention_val": {
- "type": "string"
- },
- "include_security_measures_data_transmission": {
- "type": "boolean"
- },
- "include_security_measures_data_transmission_val": {
- "type": "string"
- },
- "include_security_measures_event_logging": {
- "type": "boolean"
- },
- "include_security_measures_event_logging_val": {
- "type": "string"
- },
- "include_security_measures_identity_auth": {
- "type": "boolean"
- },
- "include_security_measures_identity_auth_val": {
- "type": "string"
- },
- "include_security_measures_it_security_governance": {
- "type": "boolean"
- },
- "include_security_measures_it_security_governance_val": {
- "type": "string"
- },
- "include_security_measures_physical_security": {
- "type": "boolean"
- },
- "include_security_measures_physical_security_val": {
- "type": "string"
- },
- "include_security_measures_portability_and_erasure": {
- "type": "boolean"
- },
- "include_security_measures_portability_and_erasure_val": {
- "type": "string"
- },
- "include_security_measures_pseudonym_encryption": {
- "type": "boolean"
- },
- "include_security_measures_pseudonym_encryption_val": {
- "type": "string"
- },
- "include_security_measures_restore_data_access": {
- "type": "boolean"
- },
- "include_security_measures_restore_data_access_val": {
- "type": "string"
- },
- "include_security_measures_security_policy": {
- "type": "boolean"
- },
- "include_security_measures_system_configuration": {
- "type": "boolean"
- },
- "include_security_measures_system_configuration_val": {
- "type": "string"
- },
- "include_security_measures_testing_assessment": {
- "type": "boolean"
- },
- "include_security_measures_testing_assessment_val": {
- "type": "string"
- },
- "include_security_policy": {
- "type": "boolean"
- },
- "include_security_policy_fedramp_auth": {
- "type": "boolean"
- },
- "include_security_policy_hipaa": {
- "type": "boolean"
- },
- "include_security_policy_hitrust": {
- "type": "boolean"
- },
- "include_security_policy_include_other": {
- "type": "boolean"
- },
- "include_security_policy_iso27001": {
- "type": "boolean"
- },
- "include_security_policy_other": {
- "type": "string"
- },
- "include_security_policy_pci1": {
- "type": "boolean"
- },
- "include_security_policy_pci2": {
- "type": "boolean"
- },
- "include_security_policy_penetration_testing": {
- "type": "boolean"
- },
- "include_security_policy_soc2": {
- "type": "boolean"
- },
- "include_security_policy_soc2_type2": {
- "type": "boolean"
- },
- "include_sensitive_data_restrictions_custom": {
- "type": "boolean"
- },
- "include_sensitive_data_restrictions_custom_val": {
- "type": "string"
- },
- "include_sensitive_data_restrictions_security_policy": {
- "type": "boolean"
- },
- "include_service_provider_relationship": {
- "type": "boolean"
- },
- "include_special_category_data": {
- "type": "boolean"
- },
- "provider": {
- "type": "string"
- },
- "security_policy_available_at": {
- "type": "string"
- },
- "security_policy_type": {
- "description": "Where the Security Policy is defined. For `external`, set `security_policy_available_at`.",
- "enum": [
- "defined in agreement",
- "provider service",
- "external"
- ],
- "type": "string"
- },
- "subprocessors_attributes": {
- "additionalProperties": {
- "additionalProperties": false,
- "properties": {
- "_destroy": {
- "description": "Set to true with `id` to remove that subprocessor.",
- "type": "boolean"
- },
- "country": {
- "type": "string"
- },
- "id": {
- "description": "ID of an existing subprocessor to update or remove. Omit to add a new subprocessor.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "name": {
- "type": "string"
- },
- "processing_task": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "description": "Subprocessors, keyed by string index such as \"0\", \"1\". On create these are added to the template's subprocessors. On a draft update, an entry without `id` adds a new subprocessor; pass `id` to change one and `id` with `_destroy: true` to remove one.",
- "propertyNames": {
- "type": "string"
- },
- "type": "object"
- },
- "underlying_agreement_id": {
- "description": "ID of the CSA this DPA supplements when `underlying_agreement_type` is `internal`.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "underlying_agreement_type": {
- "description": "`internal` links a CSA in Common Paper (`underlying_agreement_id`); `external` describes another agreement in `underlying_agreement_val` (required). Omit for none.",
- "enum": [
- "internal",
- "external"
- ],
- "type": "string"
- },
- "underlying_agreement_val": {
- "description": "Description of the agreement this DPA supplements. Required when `underlying_agreement_type` is `external`.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "framework_terms_description": {
- "description": "Custom framework terms description. Only used when framework_terms_type is \"description\".",
- "type": "string"
- },
- "framework_terms_type": {
- "description": "How framework terms are specified. Use \"new\" for standard terms or \"description\" to provide a custom framework_terms_description.",
- "enum": [
- "new",
- "description"
- ],
- "type": "string"
- },
- "governing_law_country": {
- "description": "The country whose laws govern the agreement.",
- "type": "string"
- },
- "governing_law_region": {
- "description": "The state or region whose laws govern the agreement.",
- "type": "string"
- },
- "include_automated_payment_reminders": {
- "description": "When true, automatically sends payment reminder emails.",
- "type": "boolean"
- },
- "include_billing_info": {
- "description": "When true, billing contact information (billing_name, billing_email) is included.",
- "type": "boolean"
- },
- "include_billing_workflow": {
- "description": "When true, enables a billing workflow after signing.",
- "type": "boolean"
- },
- "include_expiration_date": {
- "description": "Expiration date in YYYY-MM-DD format. Use when include_expiration_type is \"date\".",
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "include_expiration_days": {
- "description": "Number of days until the agreement expires. Use when include_expiration_type is \"days\".",
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_expiration_type": {
- "description": "How to set expiration: \"none\" (default), \"days\" (use include_expiration_days), or \"date\" (use include_expiration_date).",
- "enum": [
- "none",
- "days",
- "date"
- ],
- "type": "string"
- },
- "include_terms": {
- "description": "When true, the standard terms are included with the agreement.",
- "type": "boolean"
- },
- "loi_attributes": {
- "additionalProperties": false,
- "description": "Override loi terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "confidentiality_custom": {
- "type": "string"
- },
- "confidentiality_mutual_include_loi": {
- "type": "boolean"
- },
- "confidentiality_nda_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "confidentiality_nda_description": {
- "type": "string"
- },
- "confidentiality_nda_include_loi": {
- "type": "boolean"
- },
- "confidentiality_nda_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "confidentiality_type": {
- "enum": [
- "mutual",
- "nda",
- "provider",
- "custom"
- ],
- "type": "string"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_custom_details": {
- "type": "boolean"
- },
- "include_custom_details_val": {
- "type": "string"
- },
- "include_fees": {
- "type": "boolean"
- },
- "include_fees_amount": {
- "type": "number"
- },
- "include_fees_amount_duration": {
- "enum": [
- "month",
- "year",
- "quarter"
- ],
- "type": "string"
- },
- "include_fees_include_amount": {
- "type": "boolean"
- },
- "include_fees_include_other": {
- "type": "boolean"
- },
- "include_fees_other": {
- "type": "string"
- },
- "include_functionality": {
- "type": "boolean"
- },
- "include_functionality_val": {
- "type": "string"
- },
- "include_launch_date": {
- "type": "boolean"
- },
- "include_launch_date_custom": {
- "type": "string"
- },
- "include_launch_date_date": {
- "format": "date-time",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$",
- "type": "string"
- },
- "include_launch_date_type": {
- "enum": [
- "date",
- "custom"
- ],
- "type": "string"
- },
- "product_name": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "manual_send": {
- "description": "When true, the agreement is marked as manually sent outside the platform.",
- "type": "boolean"
- },
- "message": {
- "type": "string"
- },
- "negotiations_allowed": {
- "description": "When true, the recipient can propose changes to the legal terms. For agreement types without separate business terms, that covers every term. CSA order forms, PSA statements of work, partnership business terms and software license order forms have their own `negotiations_allowed` flag.",
- "type": "boolean"
- },
- "partnership_attributes": {
- "additionalProperties": false,
- "description": "Override partnership terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "effective_date": {
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "effective_date_type": {
- "enum": [
- "signature",
- "date"
- ],
- "type": "string"
- },
- "general_cap_amount_currency_val": {
- "type": "number"
- },
- "general_cap_amount_either_currency": {
- "type": "number"
- },
- "general_cap_amount_either_multiple": {
- "type": "number"
- },
- "general_cap_amount_multiple_val": {
- "type": "number"
- },
- "general_cap_amount_type": {
- "enum": [
- "multiple",
- "currency",
- "either",
- "base"
- ],
- "type": "string"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_additional_warranties": {
- "type": "boolean"
- },
- "include_additional_warranties_include_company": {
- "type": "boolean"
- },
- "include_additional_warranties_include_company_val": {
- "type": "string"
- },
- "include_additional_warranties_include_partner": {
- "type": "boolean"
- },
- "include_additional_warranties_include_partner_val": {
- "type": "string"
- },
- "include_brand_guidelines": {
- "type": "boolean"
- },
- "include_brand_guidelines_include_company": {
- "type": "boolean"
- },
- "include_brand_guidelines_include_company_val": {
- "type": "string"
- },
- "include_brand_guidelines_include_partner": {
- "type": "boolean"
- },
- "include_brand_guidelines_include_partner_val": {
- "type": "string"
- },
- "include_covered_claims": {
- "type": "boolean"
- },
- "include_covered_claims_company_claims": {
- "type": "string"
- },
- "include_covered_claims_include_company_claims": {
- "type": "boolean"
- },
- "include_covered_claims_include_partner_claims": {
- "type": "boolean"
- },
- "include_covered_claims_partner_claims": {
- "type": "string"
- },
- "include_dpa": {
- "type": "boolean"
- },
- "include_dpa_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_dpa_location": {
- "type": "string"
- },
- "include_dpa_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_increased_cap_amount": {
- "type": "boolean"
- },
- "include_increased_cap_amount_currency": {
- "type": "number"
- },
- "include_increased_cap_amount_either_currency": {
- "type": "number"
- },
- "include_increased_cap_amount_either_multiple": {
- "type": "string"
- },
- "include_increased_cap_amount_multiple": {
- "type": "string"
- },
- "include_increased_cap_amount_type": {
- "enum": [
- "multiple",
- "currency",
- "either"
- ],
- "type": "string"
- },
- "include_increased_claims": {
- "type": "boolean"
- },
- "include_increased_claims_include_confidentiality": {
- "type": "boolean"
- },
- "include_increased_claims_include_confidentiality_misconduct": {
- "type": "boolean"
- },
- "include_increased_claims_include_covered_claims": {
- "type": "boolean"
- },
- "include_increased_claims_include_misconduct": {
- "type": "boolean"
- },
- "include_increased_claims_include_other": {
- "type": "boolean"
- },
- "include_increased_claims_include_other_val": {
- "type": "string"
- },
- "include_unlimited_claims": {
- "type": "boolean"
- },
- "include_unlimited_claims_confidentiality": {
- "type": "boolean"
- },
- "include_unlimited_claims_confidentiality_misconduct": {
- "type": "boolean"
- },
- "include_unlimited_claims_covered_claims": {
- "type": "boolean"
- },
- "include_unlimited_claims_misconduct": {
- "type": "boolean"
- },
- "include_unlimited_claims_other": {
- "type": "boolean"
- },
- "include_unlimited_claims_other_val": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "partnership_business_terms_attributes": {
- "additionalProperties": false,
- "description": "Override partnership business terms terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "end_date_after_effective_date_amount": {
- "type": "number"
- },
- "end_date_after_effective_date_unit": {
- "enum": [
- "month(s)",
- "quarter(s)",
- "year(s)"
- ],
- "type": "string"
- },
- "end_date_date": {
- "type": "string"
- },
- "end_date_type": {
- "enum": [
- "date",
- "effective date"
- ],
- "type": "string"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_obligations_company_brand": {
- "type": "boolean"
- },
- "include_obligations_company_promotion": {
- "type": "boolean"
- },
- "include_obligations_company_promotion_include_activities": {
- "type": "boolean"
- },
- "include_obligations_company_promotion_include_activities_val": {
- "type": "string"
- },
- "include_obligations_company_promotion_include_materials": {
- "type": "boolean"
- },
- "include_obligations_company_promotion_include_materials_val": {
- "type": "string"
- },
- "include_obligations_company_referral": {
- "type": "boolean"
- },
- "include_obligations_company_referral_include_criteria": {
- "type": "boolean"
- },
- "include_obligations_company_referral_include_criteria_val": {
- "type": "string"
- },
- "include_obligations_company_referral_include_pay_sch": {
- "type": "boolean"
- },
- "include_obligations_company_referral_include_pay_sch_amount": {
- "type": "number"
- },
- "include_obligations_company_referral_include_pay_sch_custom": {
- "type": "string"
- },
- "include_obligations_company_referral_include_pay_sch_unit": {
- "enum": [
- "U.S. Dollars",
- "percent"
- ],
- "type": "string"
- },
- "include_obligations_company_sponsorship": {
- "type": "boolean"
- },
- "include_obligations_company_sponsorship_include_benefits": {
- "type": "boolean"
- },
- "include_obligations_company_sponsorship_include_benefits_val": {
- "type": "string"
- },
- "include_obligations_company_sponsorship_include_payments": {
- "type": "boolean"
- },
- "include_obligations_company_sponsorship_include_payments_amount": {
- "type": "number"
- },
- "include_obligations_company_sponsorship_include_payments_unit": {
- "enum": [
- "U.S. Dollars",
- "percent"
- ],
- "type": "string"
- },
- "include_obligations_partner_brand": {
- "type": "boolean"
- },
- "include_obligations_partner_promotion": {
- "type": "boolean"
- },
- "include_obligations_partner_promotion_include_activities": {
- "type": "boolean"
- },
- "include_obligations_partner_promotion_include_activities_val": {
- "type": "string"
- },
- "include_obligations_partner_promotion_include_materials": {
- "type": "boolean"
- },
- "include_obligations_partner_promotion_include_materials_val": {
- "type": "string"
- },
- "include_obligations_partner_referral": {
- "type": "boolean"
- },
- "include_obligations_partner_referral_include_criteria": {
- "type": "boolean"
- },
- "include_obligations_partner_referral_include_criteria_val": {
- "type": "string"
- },
- "include_obligations_partner_referral_include_pay_sch": {
- "type": "boolean"
- },
- "include_obligations_partner_referral_include_pay_sch_amount": {
- "type": "number"
- },
- "include_obligations_partner_referral_include_pay_sch_custom": {
- "type": "string"
- },
- "include_obligations_partner_referral_include_pay_sch_unit": {
- "enum": [
- "U.S. Dollars",
- "percent"
- ],
- "type": "string"
- },
- "include_obligations_partner_sponsorship": {
- "type": "boolean"
- },
- "include_obligations_partner_sponsorship_include_benefits": {
- "type": "boolean"
- },
- "include_obligations_partner_sponsorship_include_benefits_val": {
- "type": "string"
- },
- "include_obligations_partner_sponsorship_include_payments": {
- "type": "boolean"
- },
- "include_obligations_partner_sponsorship_include_payments_amount": {
- "type": "number"
- },
- "include_obligations_partner_sponsorship_include_payments_unit": {
- "enum": [
- "U.S. Dollars",
- "percent"
- ],
- "type": "string"
- },
- "include_payment_process": {
- "type": "boolean"
- },
- "include_payment_process_company": {
- "type": "boolean"
- },
- "include_payment_process_company_include_address": {
- "type": "boolean"
- },
- "include_payment_process_company_include_address_city": {
- "type": "string"
- },
- "include_payment_process_company_include_address_country": {
- "type": "string"
- },
- "include_payment_process_company_include_address_state": {
- "type": "string"
- },
- "include_payment_process_company_include_address_street_address": {
- "type": "string"
- },
- "include_payment_process_company_include_address_zipcode": {
- "type": "string"
- },
- "include_payment_process_company_include_email": {
- "type": "boolean"
- },
- "include_payment_process_company_include_email_val": {
- "type": "string"
- },
- "include_payment_process_partner": {
- "type": "boolean"
- },
- "include_payment_process_partner_include_address": {
- "type": "boolean"
- },
- "include_payment_process_partner_include_address_city": {
- "type": "string"
- },
- "include_payment_process_partner_include_address_country": {
- "type": "string"
- },
- "include_payment_process_partner_include_address_state": {
- "type": "string"
- },
- "include_payment_process_partner_include_address_street_address": {
- "type": "string"
- },
- "include_payment_process_partner_include_address_zipcode": {
- "type": "string"
- },
- "include_payment_process_partner_include_email": {
- "type": "boolean"
- },
- "include_payment_process_partner_include_email_val": {
- "type": "string"
- },
- "include_payment_schedule": {
- "type": "boolean"
- },
- "include_payment_schedule_custom": {
- "type": "string"
- },
- "include_payment_schedule_specified_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_payment_schedule_specified_timeframe": {
- "enum": [
- "receipt",
- "date"
- ],
- "type": "string"
- },
- "include_payment_schedule_specified_unit": {
- "enum": [
- "day(s)",
- "week(s)",
- "month(s)",
- "quarter(s)",
- "year(s)"
- ],
- "type": "string"
- },
- "include_payment_schedule_type": {
- "enum": [
- "specified",
- "custom"
- ],
- "type": "string"
- },
- "negotiations_allowed": {
- "description": "When true, the recipient can propose changes to the business terms, even when the agreement-level `negotiations_allowed` is false. This only covers the business terms.",
- "type": "boolean"
- },
- "territory_type": {
- "enum": [
- "worldwide",
- "custom"
- ],
- "type": "string"
- },
- "territory_type_val": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "payment_link_url": {
- "description": "A payment URL shown to the recipient after signing. Requires include_billing_workflow to be true and billing_workflow_type to be \"link\".",
- "type": "string"
- },
- "pilot_attributes": {
- "additionalProperties": false,
- "description": "Override pilot terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "fees_type": {
- "enum": [
- "free",
- "pilot_period_fees"
- ],
- "type": "string"
- },
- "general_cap_amount": {
- "type": "number"
- },
- "general_cap_amount_type": {
- "enum": [
- "preceding",
- "base",
- "period"
- ],
- "type": "string"
- },
- "general_cap_period_currency": {
- "type": "number"
- },
- "general_cap_period_qty": {
- "type": "number"
- },
- "general_cap_preceding_amount": {
- "type": "number"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_dpa": {
- "type": "boolean"
- },
- "include_dpa_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_dpa_location": {
- "type": "string"
- },
- "include_dpa_type": {
- "enum": [
- "description",
- "attachment",
- "standard"
- ],
- "type": "string"
- },
- "include_payment_process": {
- "type": "boolean"
- },
- "include_technical_support": {
- "type": "boolean"
- },
- "payment_process_automatic_frequency": {
- "enum": [
- "monthly",
- "quarterly",
- "annually",
- "once_per_period"
- ],
- "type": "string"
- },
- "payment_process_invoice_days": {
- "type": "number"
- },
- "payment_process_invoice_from": {
- "enum": [
- "receipt",
- "date"
- ],
- "type": "string"
- },
- "payment_process_invoice_timeframe": {
- "enum": [
- "days",
- "weeks",
- "months",
- "quarters",
- "years"
- ],
- "type": "string"
- },
- "payment_process_type": {
- "enum": [
- "automatic",
- "invoice"
- ],
- "type": "string"
- },
- "pilot_period_description": {
- "type": "string"
- },
- "pilot_period_fees_description": {
- "type": "string"
- },
- "product_description": {
- "type": "string"
- },
- "technical_support_description": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "psa_attributes": {
- "additionalProperties": false,
- "description": "Override psa terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "additional_changes": {
- "type": "string"
- },
- "customer_description": {
- "type": "string"
- },
- "effective_date": {
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "effective_date_type": {
- "enum": [
- "signature",
- "date"
- ],
- "type": "string"
- },
- "general_cap_amount": {
- "type": "number"
- },
- "general_cap_amount_type": {
- "enum": [
- "preceding",
- "base",
- "period"
- ],
- "type": "string"
- },
- "general_cap_period_currency": {
- "type": "number"
- },
- "general_cap_period_qty": {
- "type": "number"
- },
- "general_cap_preceding_amount": {
- "type": "number"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_additional_changes": {
- "type": "boolean"
- },
- "include_additional_warranties": {
- "type": "boolean"
- },
- "include_additional_warranties_by_customer": {
- "type": "string"
- },
- "include_additional_warranties_by_provider": {
- "type": "string"
- },
- "include_additional_warranties_include_by_customer": {
- "type": "boolean"
- },
- "include_additional_warranties_include_by_provider": {
- "type": "boolean"
- },
- "include_covered_claims": {
- "type": "boolean"
- },
- "include_covered_claims_customer_claims": {
- "type": "string"
- },
- "include_covered_claims_include_customer_claims": {
- "type": "boolean"
- },
- "include_covered_claims_include_provider_claims": {
- "type": "boolean"
- },
- "include_covered_claims_provider_claims": {
- "type": "string"
- },
- "include_customer_insurance_min": {
- "type": "boolean"
- },
- "include_customer_insurance_min_add_provider_com_gen_liability": {
- "type": "boolean"
- },
- "include_customer_insurance_min_add_provider_cyber_liability": {
- "type": "boolean"
- },
- "include_customer_insurance_min_add_provider_errors_omissions": {
- "type": "boolean"
- },
- "include_customer_insurance_min_auto_liability_aggregate": {
- "type": "number"
- },
- "include_customer_insurance_min_auto_liability_minimum": {
- "type": "number"
- },
- "include_customer_insurance_min_cyber_liability_aggregate": {
- "type": "number"
- },
- "include_customer_insurance_min_cyber_liability_minimum": {
- "type": "number"
- },
- "include_customer_insurance_min_employer_liability_aggregate": {
- "type": "number"
- },
- "include_customer_insurance_min_employer_liability_minimum": {
- "type": "number"
- },
- "include_customer_insurance_min_general_liability_aggregate": {
- "type": "number"
- },
- "include_customer_insurance_min_general_liability_minimum": {
- "type": "number"
- },
- "include_customer_insurance_min_include_add_provider": {
- "type": "boolean"
- },
- "include_customer_insurance_min_include_auto_liability": {
- "type": "boolean"
- },
- "include_customer_insurance_min_include_cyber_liability": {
- "type": "boolean"
- },
- "include_customer_insurance_min_include_employer_liability": {
- "type": "boolean"
- },
- "include_customer_insurance_min_include_general_liability": {
- "type": "boolean"
- },
- "include_customer_insurance_min_include_workers_comp": {
- "type": "boolean"
- },
- "include_customer_policies": {
- "type": "boolean"
- },
- "include_customer_policies_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_customer_policies_location": {
- "type": "string"
- },
- "include_customer_policies_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_dpa": {
- "type": "boolean"
- },
- "include_dpa_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_dpa_location": {
- "type": "string"
- },
- "include_dpa_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_increased_cap_amount": {
- "type": "boolean"
- },
- "include_increased_claims": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_confidentiality": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_confidentiality_negligence": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_privsec": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_privsec_negligence": {
- "type": "boolean"
- },
- "include_increased_claims_include_other": {
- "type": "boolean"
- },
- "include_increased_claims_indemnification_obligation": {
- "type": "boolean"
- },
- "include_increased_claims_negligence": {
- "type": "boolean"
- },
- "include_increased_claims_other": {
- "type": "string"
- },
- "include_provider_insurance_min": {
- "type": "boolean"
- },
- "include_provider_insurance_min_add_customer_com_gen_liability": {
- "type": "boolean"
- },
- "include_provider_insurance_min_add_customer_cyber_liability": {
- "type": "boolean"
- },
- "include_provider_insurance_min_add_customer_errors_omissions": {
- "type": "boolean"
- },
- "include_provider_insurance_min_auto_liability_aggregate": {
- "type": "number"
- },
- "include_provider_insurance_min_auto_liability_minimum": {
- "type": "number"
- },
- "include_provider_insurance_min_cyber_liability_aggregate": {
- "type": "number"
- },
- "include_provider_insurance_min_cyber_liability_minimum": {
- "type": "number"
- },
- "include_provider_insurance_min_employer_liability_aggregate": {
- "type": "number"
- },
- "include_provider_insurance_min_employer_liability_minimum": {
- "type": "number"
- },
- "include_provider_insurance_min_general_liability_aggregate": {
- "type": "number"
- },
- "include_provider_insurance_min_general_liability_minimum": {
- "type": "number"
- },
- "include_provider_insurance_min_include_add_customer": {
- "type": "boolean"
- },
- "include_provider_insurance_min_include_auto_liability": {
- "type": "boolean"
- },
- "include_provider_insurance_min_include_cyber_liability": {
- "type": "boolean"
- },
- "include_provider_insurance_min_include_employer_liability": {
- "type": "boolean"
- },
- "include_provider_insurance_min_include_general_liability": {
- "type": "boolean"
- },
- "include_provider_insurance_min_include_workers_comp": {
- "type": "boolean"
- },
- "include_publicity_rights": {
- "type": "boolean"
- },
- "include_publicity_rights_type": {
- "enum": [
- "public",
- "non-public"
- ],
- "type": "string"
- },
- "include_security_policy": {
- "type": "boolean"
- },
- "include_security_policy_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_security_policy_fedramp_auth": {
- "type": "boolean"
- },
- "include_security_policy_hitrust": {
- "type": "boolean"
- },
- "include_security_policy_include_annual_maintenance": {
- "type": "boolean"
- },
- "include_security_policy_include_other": {
- "type": "boolean"
- },
- "include_security_policy_include_other_val": {
- "type": "string"
- },
- "include_security_policy_iso27001": {
- "type": "boolean"
- },
- "include_security_policy_location": {
- "type": "string"
- },
- "include_security_policy_pci1": {
- "type": "boolean"
- },
- "include_security_policy_pci2": {
- "type": "boolean"
- },
- "include_security_policy_penetration_testing": {
- "type": "boolean"
- },
- "include_security_policy_soc2_type1": {
- "type": "boolean"
- },
- "include_security_policy_soc2_type2": {
- "type": "boolean"
- },
- "include_security_policy_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_unlimited_claims": {
- "type": "boolean"
- },
- "include_unlimited_claims_breach_of_confidentiality": {
- "type": "boolean"
- },
- "include_unlimited_claims_breach_of_confidentiality_negligence": {
- "type": "boolean"
- },
- "include_unlimited_claims_breach_of_privsec": {
- "type": "boolean"
- },
- "include_unlimited_claims_breach_of_privsec_negligence": {
- "type": "boolean"
- },
- "include_unlimited_claims_include_other": {
- "type": "boolean"
- },
- "include_unlimited_claims_indemnification_obligation": {
- "type": "boolean"
- },
- "include_unlimited_claims_negligence": {
- "type": "boolean"
- },
- "include_unlimited_claims_other": {
- "type": "string"
- },
- "increased_cap_amount_currency": {
- "type": "number"
- },
- "increased_cap_amount_period_currency": {
- "type": "number"
- },
- "increased_cap_amount_period_qty": {
- "type": "number"
- },
- "increased_cap_amount_qty": {
- "type": "number"
- },
- "increased_cap_amount_type": {
- "enum": [
- "qty",
- "currency",
- "period"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- "psa_statement_of_work_attributes": {
- "additionalProperties": false,
- "description": "Override psa statement of work terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "additional_changes": {
- "type": "string"
- },
- "cost": {
- "type": "number"
- },
- "description": {
- "type": "string"
- },
- "fee_type": {
- "type": "string"
- },
- "fees_attributes": {
- "additionalProperties": {
- "anyOf": [
- {
- "additionalProperties": false,
- "description": "Fees::Flat (fee_type \"flat\"). A fixed recurring fee, e.g. a platform subscription. Set type to \"Fees::Flat\" or fee_type to \"flat\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "Fixed amount in the order form's fees_currency, charged per fee_period. A plain amount, not cents: 20 means 20.00.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"flat\". Alternative to type.",
- "enum": [
- "flat"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Flat\". Optional when fee_type is set.",
- "enum": [
- "Fees::Flat"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Discount (fee_type \"discount\"). A discount, as a fixed amount or a percentage, applied forever, once, or for a number of months. Set type to \"Fees::Discount\" or fee_type to \"discount\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "Discount size: an amount in fees_currency when discount_type is fixed_amount (a plain amount, not cents: 20 means 20.00), or a percentage (e.g. 10 for 10%) when it is percentage.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "discount_duration_amount": {
- "description": "Number of months the discount applies. Required when discount_duration_type is multiple_months.",
- "type": "number"
- },
- "discount_duration_type": {
- "description": "How long the discount applies. multiple_months also needs discount_duration_amount.",
- "enum": [
- "forever",
- "once",
- "multiple_months"
- ],
- "type": "string"
- },
- "discount_type": {
- "description": "Whether cost is a currency amount or a percentage.",
- "enum": [
- "fixed_amount",
- "percentage"
- ],
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"discount\". Alternative to type.",
- "enum": [
- "discount"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Discount\". Optional when fee_type is set.",
- "enum": [
- "Fees::Discount"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Cost (fee_type \"cost\"). A per-unit fee: price per unit times quantity, e.g. seats. Set type to \"Fees::Cost\" or fee_type to \"cost\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "Price per unit in fees_currency. The row total is quantity x cost. A plain amount, not cents: 20 means 20.00.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"cost\". Alternative to type.",
- "enum": [
- "cost"
- ],
- "type": "string"
- },
- "quantity": {
- "description": "Number of units.",
- "type": "number"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Cost\". Optional when fee_type is set.",
- "enum": [
- "Fees::Cost"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Attachment (fee_type \"attachment\"). A fee described in an uploaded attachment instead of in the table. Set type to \"Fees::Attachment\" or fee_type to \"attachment\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "attachment_id": {
- "description": "ID of an attachment uploaded with upload-attachment.",
- "type": "string"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"attachment\". Alternative to type.",
- "enum": [
- "attachment"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Attachment\". Optional when fee_type is set.",
- "enum": [
- "Fees::Attachment"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Graduated (fee_type \"graduated\"). Tiered pricing, with the price set per tier in graduated_fee_tiers_attributes. Set type to \"Fees::Graduated\" or fee_type to \"graduated\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"graduated\". Alternative to type.",
- "enum": [
- "graduated"
- ],
- "type": "string"
- },
- "graduated_fee_tiers_attributes": {
- "additionalProperties": {
- "additionalProperties": false,
- "properties": {
- "flat_price": {
- "type": "number"
- },
- "price_per_unit": {
- "type": "string"
- },
- "upper_limit": {
- "type": "number"
- }
- },
- "type": "object"
- },
- "description": "Graduated fee tiers. Use string keys such as \"0\", \"1\".",
- "propertyNames": {
- "type": "string"
- },
- "type": "object"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Graduated\". Optional when fee_type is set.",
- "enum": [
- "Fees::Graduated"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Included (fee_type \"included\"). An item included at no charge. Set type to \"Fees::Included\" or fee_type to \"included\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"included\". Alternative to type.",
- "enum": [
- "included"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Included\". Optional when fee_type is set.",
- "enum": [
- "Fees::Included"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Metered (fee_type \"metered\"). Usage-based pricing, billed per unit used. Set type to \"Fees::Metered\" or fee_type to \"metered\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "Price per unit of usage in fees_currency. A plain amount, not cents: 20 means 20.00.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"metered\". Alternative to type.",
- "enum": [
- "metered"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Metered\". Optional when fee_type is set.",
- "enum": [
- "Fees::Metered"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::OneTime (fee_type \"one_time\"). A one-time charge, such as a setup fee. Set type to \"Fees::OneTime\" or fee_type to \"one_time\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "One-time amount in fees_currency, charged once rather than per fee_period. A plain amount, not cents: 20 means 20.00.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"one_time\". Alternative to type.",
- "enum": [
- "one_time"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::OneTime\". Optional when fee_type is set.",
- "enum": [
- "Fees::OneTime"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Text (fee_type \"text\"). A fee term described in free text. Set type to \"Fees::Text\" or fee_type to \"text\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"text\". Alternative to type.",
- "enum": [
- "text"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Text\". Optional when fee_type is set.",
- "enum": [
- "Fees::Text"
- ],
- "type": "string"
- }
- },
- "type": "object"
- }
- ]
- },
- "description": "Fee line items. Use string keys such as \"0\", \"1\". Replaces template fees when provided.",
- "propertyNames": {
- "type": "string"
- },
- "type": "object"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_additional_changes": {
- "type": "boolean"
- },
- "include_customer_obligation": {
- "type": "boolean"
- },
- "include_customer_obligation_val": {
- "type": "string"
- },
- "include_deliverables": {
- "type": "boolean"
- },
- "include_deliverables_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_deliverables_description": {
- "type": "string"
- },
- "include_deliverables_include_acceptance": {
- "type": "boolean"
- },
- "include_deliverables_include_attachment": {
- "type": "boolean"
- },
- "include_deliverables_include_draft_deliverables": {
- "type": "boolean"
- },
- "include_deliverables_rejection_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_deliverables_rejection_unit": {
- "enum": [
- "hours",
- "days",
- "weeks",
- "months"
- ],
- "type": "string"
- },
- "include_deliverables_resubmission_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_deliverables_resubmission_unit": {
- "enum": [
- "hours",
- "days",
- "weeks",
- "months"
- ],
- "type": "string"
- },
- "include_fees_other": {
- "type": "boolean"
- },
- "include_fees_other_val": {
- "type": "string"
- },
- "include_fees_table": {
- "type": "boolean"
- },
- "include_fees_table_total": {
- "type": "boolean"
- },
- "include_fees_travel": {
- "type": "boolean"
- },
- "include_fees_travel_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_fees_travel_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_fees_travel_val": {
- "type": "string"
- },
- "include_third_party_customer": {
- "type": "boolean"
- },
- "include_third_party_include_description": {
- "type": "boolean"
- },
- "include_third_party_include_description_val": {
- "type": "string"
- },
- "include_third_party_materials": {
- "type": "boolean"
- },
- "include_third_party_provider": {
- "type": "boolean"
- },
- "include_time_of_assignment": {
- "type": "boolean"
- },
- "include_time_of_assignment_type": {
- "enum": [
- "created",
- "paid"
- ],
- "type": "string"
- },
- "invoice_period_description": {
- "type": "string"
- },
- "negotiations_allowed": {
- "description": "When true, the recipient can propose changes to the statement of work, even when the agreement-level `negotiations_allowed` is false. This only covers the statement of work.",
- "type": "boolean"
- },
- "payment_period": {
- "type": "number"
- },
- "payment_period_other": {
- "type": "string"
- },
- "payment_period_timeframe": {
- "enum": [
- "receipt",
- "invoice",
- "Customer's receipt of invoice",
- "date of invoice"
- ],
- "type": "string"
- },
- "payment_period_type": {
- "enum": [
- "standard",
- "other"
- ],
- "type": "string"
- },
- "payment_period_unit": {
- "enum": [
- "day(s)",
- "week(s)",
- "month(s)",
- "quarter(s)",
- "year(s)"
- ],
- "type": "string"
- },
- "quantity": {
- "type": "number"
- },
- "services_description": {
- "type": "string"
- },
- "sow_date": {
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "sow_date_type": {
- "enum": [
- "signature",
- "date"
- ],
- "type": "string"
- },
- "sow_term_amount": {
- "type": "number"
- },
- "sow_term_date": {
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "sow_term_type": {
- "enum": [
- "deliverables",
- "period",
- "date"
- ],
- "type": "string"
- },
- "sow_term_unit": {
- "enum": [
- "month(s)",
- "quarter(s)",
- "year(s)"
- ],
- "type": "string"
- },
- "type": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "recipient_email": {
- "format": "email",
- "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
- "type": "string"
- },
- "recipient_name": {
- "type": "string"
- },
- "recipient_notice_email_address": {
- "description": "Email address for legal notices to the recipient.",
- "format": "email",
- "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
- "type": "string"
- },
- "recipient_organization": {
- "type": "string"
- },
- "recipient_role": {
- "description": "PSA only. The recipient's role: `Customer` (the default) or `Provider`. Send it with `sender_role`; the two must be one `Provider` and one `Customer`. Other standard agreement types ignore it.",
- "type": "string"
- },
- "sender_last_to_sign": {
- "description": "When true, your signer signs after the recipient.",
- "type": "boolean"
- },
- "sender_notice_email_address": {
- "description": "Email address for legal notices to the sender.",
- "format": "email",
- "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
- "type": "string"
- },
- "sender_role": {
- "description": "PSA only. Your company's role: `Provider` (the default) or `Customer` when you hire the recipient to provide the services. Send it with `recipient_role`; the two must be one `Provider` and one `Customer`. When reading a PSA, an empty `sender_role` means `Provider`. Other standard agreement types ignore it.",
- "type": "string"
- },
- "software_license_attributes": {
- "additionalProperties": false,
- "description": "Override software license terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "effective_date": {
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "effective_date_type": {
- "enum": [
- "signature",
- "date"
- ],
- "type": "string"
- },
- "general_cap_amount": {
- "type": "number"
- },
- "general_cap_amount_type": {
- "enum": [
- "preceding",
- "base",
- "period"
- ],
- "type": "string"
- },
- "general_cap_period_currency": {
- "type": "number"
- },
- "general_cap_period_qty": {
- "type": "number"
- },
- "general_cap_preceding_amount": {
- "type": "number"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_additional_warranties": {
- "type": "boolean"
- },
- "include_additional_warranties_by_customer": {
- "type": "string"
- },
- "include_additional_warranties_by_provider": {
- "type": "string"
- },
- "include_additional_warranties_include_by_customer": {
- "type": "boolean"
- },
- "include_additional_warranties_include_by_provider": {
- "type": "boolean"
- },
- "include_ai_addendum": {
- "type": "boolean"
- },
- "include_ai_addendum_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_covered_claims": {
- "type": "boolean"
- },
- "include_covered_claims_customer_claims": {
- "type": "string"
- },
- "include_covered_claims_include_customer_claims": {
- "type": "boolean"
- },
- "include_covered_claims_include_provider_claims": {
- "type": "boolean"
- },
- "include_covered_claims_provider_claims": {
- "type": "string"
- },
- "include_dpa": {
- "type": "boolean"
- },
- "include_dpa_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_dpa_location": {
- "type": "string"
- },
- "include_dpa_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_increased_cap_amount": {
- "type": "boolean"
- },
- "include_increased_claims": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_confidentiality": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_confidentiality_negligence": {
- "type": "boolean"
- },
- "include_increased_claims_include_other": {
- "type": "boolean"
- },
- "include_increased_claims_indemnification_obligation": {
- "type": "boolean"
- },
- "include_increased_claims_negligence": {
- "type": "boolean"
- },
- "include_increased_claims_other": {
- "type": "string"
- },
- "include_increased_claims_restrictions": {
- "type": "boolean"
- },
- "include_unlimited_claims": {
- "type": "boolean"
- },
- "include_unlimited_claims_breach_of_confidentiality": {
- "type": "boolean"
- },
- "include_unlimited_claims_breach_of_confidentiality_negligence": {
- "type": "boolean"
- },
- "include_unlimited_claims_include_other": {
- "type": "boolean"
- },
- "include_unlimited_claims_indemnification_obligation": {
- "type": "boolean"
- },
- "include_unlimited_claims_license_or_restrictions": {
- "type": "boolean"
- },
- "include_unlimited_claims_negligence": {
- "type": "boolean"
- },
- "include_unlimited_claims_other": {
- "type": "string"
- },
- "increased_cap_amount_currency": {
- "type": "number"
- },
- "increased_cap_amount_period_currency": {
- "type": "number"
- },
- "increased_cap_amount_period_qty": {
- "type": "number"
- },
- "increased_cap_amount_qty": {
- "type": "number"
- },
- "increased_cap_amount_type": {
- "enum": [
- "qty",
- "currency",
- "period"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- "software_license_order_form_attributes": {
- "additionalProperties": false,
- "description": "Override software license order form terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "additional_changes": {
- "type": "string"
- },
- "deletion_procedure_include_custom": {
- "type": "boolean"
- },
- "deletion_procedure_include_custom_description": {
- "type": "string"
- },
- "deletion_procedure_include_customer_disable": {
- "type": "boolean"
- },
- "deletion_procedure_include_customer_proof": {
- "type": "boolean"
- },
- "deletion_procedure_include_provider_disable": {
- "type": "boolean"
- },
- "fee_custom_unit": {
- "type": "string"
- },
- "fee_period": {
- "enum": [
- "Subscription Period",
- "month",
- "year",
- "Custom unit"
- ],
- "type": "string"
- },
- "fees_attributes": {
- "additionalProperties": {
- "anyOf": [
- {
- "additionalProperties": false,
- "description": "Fees::Flat (fee_type \"flat\"). A fixed recurring fee, e.g. a platform subscription. Set type to \"Fees::Flat\" or fee_type to \"flat\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "Fixed amount in the order form's fees_currency, charged per fee_period. A plain amount, not cents: 20 means 20.00.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"flat\". Alternative to type.",
- "enum": [
- "flat"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Flat\". Optional when fee_type is set.",
- "enum": [
- "Fees::Flat"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Discount (fee_type \"discount\"). A discount, as a fixed amount or a percentage, applied forever, once, or for a number of months. Set type to \"Fees::Discount\" or fee_type to \"discount\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "Discount size: an amount in fees_currency when discount_type is fixed_amount (a plain amount, not cents: 20 means 20.00), or a percentage (e.g. 10 for 10%) when it is percentage.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "discount_duration_amount": {
- "description": "Number of months the discount applies. Required when discount_duration_type is multiple_months.",
- "type": "number"
- },
- "discount_duration_type": {
- "description": "How long the discount applies. multiple_months also needs discount_duration_amount.",
- "enum": [
- "forever",
- "once",
- "multiple_months"
- ],
- "type": "string"
- },
- "discount_type": {
- "description": "Whether cost is a currency amount or a percentage.",
- "enum": [
- "fixed_amount",
- "percentage"
- ],
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"discount\". Alternative to type.",
- "enum": [
- "discount"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Discount\". Optional when fee_type is set.",
- "enum": [
- "Fees::Discount"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Cost (fee_type \"cost\"). A per-unit fee: price per unit times quantity, e.g. seats. Set type to \"Fees::Cost\" or fee_type to \"cost\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "Price per unit in fees_currency. The row total is quantity x cost. A plain amount, not cents: 20 means 20.00.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"cost\". Alternative to type.",
- "enum": [
- "cost"
- ],
- "type": "string"
- },
- "quantity": {
- "description": "Number of units.",
- "type": "number"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Cost\". Optional when fee_type is set.",
- "enum": [
- "Fees::Cost"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Attachment (fee_type \"attachment\"). A fee described in an uploaded attachment instead of in the table. Set type to \"Fees::Attachment\" or fee_type to \"attachment\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "attachment_id": {
- "description": "ID of an attachment uploaded with upload-attachment.",
- "type": "string"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"attachment\". Alternative to type.",
- "enum": [
- "attachment"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Attachment\". Optional when fee_type is set.",
- "enum": [
- "Fees::Attachment"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Graduated (fee_type \"graduated\"). Tiered pricing, with the price set per tier in graduated_fee_tiers_attributes. Set type to \"Fees::Graduated\" or fee_type to \"graduated\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"graduated\". Alternative to type.",
- "enum": [
- "graduated"
- ],
- "type": "string"
- },
- "graduated_fee_tiers_attributes": {
- "additionalProperties": {
- "additionalProperties": false,
- "properties": {
- "flat_price": {
- "type": "number"
- },
- "price_per_unit": {
- "type": "string"
- },
- "upper_limit": {
- "type": "number"
- }
- },
- "type": "object"
- },
- "description": "Graduated fee tiers. Use string keys such as \"0\", \"1\".",
- "propertyNames": {
- "type": "string"
- },
- "type": "object"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Graduated\". Optional when fee_type is set.",
- "enum": [
- "Fees::Graduated"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Included (fee_type \"included\"). An item included at no charge. Set type to \"Fees::Included\" or fee_type to \"included\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"included\". Alternative to type.",
- "enum": [
- "included"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Included\". Optional when fee_type is set.",
- "enum": [
- "Fees::Included"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Metered (fee_type \"metered\"). Usage-based pricing, billed per unit used. Set type to \"Fees::Metered\" or fee_type to \"metered\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "Price per unit of usage in fees_currency. A plain amount, not cents: 20 means 20.00.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"metered\". Alternative to type.",
- "enum": [
- "metered"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Metered\". Optional when fee_type is set.",
- "enum": [
- "Fees::Metered"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::OneTime (fee_type \"one_time\"). A one-time charge, such as a setup fee. Set type to \"Fees::OneTime\" or fee_type to \"one_time\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "One-time amount in fees_currency, charged once rather than per fee_period. A plain amount, not cents: 20 means 20.00.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"one_time\". Alternative to type.",
- "enum": [
- "one_time"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::OneTime\". Optional when fee_type is set.",
- "enum": [
- "Fees::OneTime"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Text (fee_type \"text\"). A fee term described in free text. Set type to \"Fees::Text\" or fee_type to \"text\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"text\". Alternative to type.",
- "enum": [
- "text"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Text\". Optional when fee_type is set.",
- "enum": [
- "Fees::Text"
- ],
- "type": "string"
- }
- },
- "type": "object"
- }
- ]
- },
- "description": "Fee line items. Use string keys such as \"0\", \"1\". Replaces template fees when provided.",
- "propertyNames": {
- "type": "string"
- },
- "type": "object"
- },
- "fees_currency": {
- "enum": [
- "USD",
- "EUR",
- "GBP",
- "CAD",
- "AUD",
- "SGD",
- "ILS",
- "JPY",
- "CHF",
- "HKD"
- ],
- "type": "string"
- },
- "fees_include_fee_increase_upon_renewal": {
- "type": "boolean"
- },
- "fees_include_fee_increase_upon_renewal_fee": {
- "type": "number"
- },
- "fees_include_fee_increase_upon_renewal_type": {
- "enum": [
- "will",
- "may"
- ],
- "type": "string"
- },
- "fees_inclusive_of_taxes": {
- "type": "boolean"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_additional_changes": {
- "type": "boolean"
- },
- "include_license_compliance_verification": {
- "type": "boolean"
- },
- "include_license_compliance_verification_description": {
- "type": "string"
- },
- "include_license_limits": {
- "type": "boolean"
- },
- "include_license_limits_description": {
- "type": "string"
- },
- "include_payment_process_include_billing_email": {
- "type": "boolean"
- },
- "include_pilot_period": {
- "type": "boolean"
- },
- "include_pilot_period_duration_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_pilot_period_duration_type": {
- "enum": [
- "day",
- "week",
- "month"
- ],
- "type": "string"
- },
- "include_pilot_period_include_fees": {
- "type": "boolean"
- },
- "include_pilot_period_include_fees_amount": {
- "type": "number"
- },
- "include_pilot_period_include_modifications": {
- "type": "boolean"
- },
- "include_pilot_period_include_modifications_description": {
- "type": "string"
- },
- "include_services": {
- "type": "boolean"
- },
- "include_services_description": {
- "type": "string"
- },
- "negotiations_allowed": {
- "description": "When true, the recipient can propose changes to the order form, even when the agreement-level `negotiations_allowed` is false. This only covers the order form.",
- "type": "boolean"
- },
- "order_date_date": {
- "type": "string"
- },
- "order_date_type": {
- "enum": [
- "signature",
- "date",
- "other"
- ],
- "type": "string"
- },
- "payment_process_automatic_frequency": {
- "enum": [
- "monthly",
- "quarterly",
- "semiannually",
- "annually"
- ],
- "type": "string"
- },
- "payment_process_type": {
- "enum": [
- "automatic",
- "invoice",
- "custom"
- ],
- "type": "string"
- },
- "payment_process_type_custom_val": {
- "type": "string"
- },
- "payment_process_type_invoice_amount": {
- "type": "number"
- },
- "payment_process_type_invoice_custom_unit": {
- "type": "string"
- },
- "payment_process_type_invoice_duration": {
- "enum": [
- "day",
- "week",
- "month",
- "year",
- "day(s)",
- "week(s)",
- "month(s)",
- "year(s)"
- ],
- "type": "string"
- },
- "payment_process_type_invoice_duration_start": {
- "enum": [
- "Customer's receipt of invoice",
- "date of invoice"
- ],
- "type": "string"
- },
- "payment_process_type_invoice_type": {
- "enum": [
- "monthly",
- "quarterly",
- "semiannually",
- "annually",
- "Custom unit"
- ],
- "type": "string"
- },
- "permitted_uses_include_custom": {
- "type": "boolean"
- },
- "permitted_uses_include_custom_description": {
- "type": "string"
- },
- "permitted_uses_include_customers_affiliates": {
- "type": "boolean"
- },
- "permitted_uses_include_internal_business": {
- "type": "boolean"
- },
- "pilot_period_stripe_product_id": {
- "type": "string"
- },
- "software_description": {
- "type": "string"
- },
- "subscription_auto_renew": {
- "enum": [
- "days",
- "subscription_end"
- ],
- "type": "string"
- },
- "subscription_period": {
- "type": "number"
- },
- "subscription_period_unit": {
- "type": "string"
- },
- "subscription_renewal_notice_days": {
- "type": "number"
- },
- "warranty_period_description_amount": {
- "type": "number"
- },
- "warranty_period_description_duration": {
- "enum": [
- "day",
- "week",
- "month",
- "year"
- ],
- "type": "string"
- },
- "warranty_period_description_duration_start": {
- "enum": [
- "initial delivery of the Software",
- "delivery of the Software and each subsequent Update",
- "the Order Date"
- ],
- "type": "string"
- },
- "warranty_period_type": {
- "enum": [
- "description",
- "none"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- "test_agreement": {
- "description": "When true, marks the agreement as a test. Test agreements do not count against your monthly limit.",
- "type": "boolean"
- }
- },
- "required": [
- "recipient_name",
- "recipient_email"
- ],
- "type": "object"
- },
- "cc_users": {
- "items": {
- "format": "email",
- "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
- "type": "string"
- },
- "type": "array"
- },
- "draft": {
- "description": "When true, the agreement is saved as a draft and not sent to the recipient. Use POST /v1/agreements/{id}/send to send a draft agreement later.",
- "type": "boolean"
- },
- "owner_email": {
- "description": "Email address of the agreement owner (sender).",
- "type": "string"
- },
- "signer_id": {
- "description": "User id of the signer from the owner's organization.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "template_id": {
- "description": "UUID of a template from `GET /v1/templates`. Accepts both Common Paper standard templates and uploaded PDF templates (`type` `uploaded_template`).",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- }
- },
- "required": [
- "template_id",
- "owner_email",
- "signer_id",
- "agreement"
- ],
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "agreement": {
- "additionalProperties": {},
- "properties": {
- "amendment_attributes": {
- "additionalProperties": false,
- "description": "Override amendment terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "amended_terms_attributes": {
- "additionalProperties": {
- "additionalProperties": false,
- "properties": {
- "description": {
- "type": "string"
- },
- "term": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "description": "Amended terms. Use string keys such as \"0\", \"1\".",
- "propertyNames": {
- "type": "string"
- },
- "type": "object"
- },
- "amendment_date": {
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "amendment_date_type": {
- "enum": [
- "signature",
- "date"
- ],
- "type": "string"
- },
- "framework_terms_type": {
- "type": "string"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "parent_agreement_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "underlying_agreement_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "underlying_agreement_type": {
- "type": "string"
- },
- "underlying_agreement_val": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "baa_attributes": {
- "additionalProperties": false,
- "description": "Override baa terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "aggregation_limitations_permitted": {
- "type": "boolean"
- },
- "aggregation_limitations_permitted_val": {
- "type": "string"
- },
- "breach_notification_unit": {
- "enum": [
- "hours",
- "business days",
- "calendar days"
- ],
- "type": "string"
- },
- "breach_notification_val": {
- "type": "number"
- },
- "business_associate_relationship_type": {
- "enum": [
- "provider",
- "company"
- ],
- "type": "string"
- },
- "deidentification_limitations_include_purpose": {
- "type": "boolean"
- },
- "deidentification_limitations_include_requirements": {
- "type": "boolean"
- },
- "deidentification_limitations_permitted": {
- "type": "boolean"
- },
- "deidentification_limitations_purpose_val": {
- "type": "string"
- },
- "deidentification_limitations_requirements_val": {
- "type": "string"
- },
- "designated_record_set_provider_maintains": {
- "type": "boolean"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_aggregation_limitations": {
- "type": "boolean"
- },
- "include_deidentification_limitations": {
- "type": "boolean"
- },
- "include_limitations": {
- "type": "boolean"
- },
- "include_offshore_limitations": {
- "type": "boolean"
- },
- "include_subcontract_limitations": {
- "type": "boolean"
- },
- "offshore_limitations_permitted": {
- "type": "boolean"
- },
- "offshore_limitations_permitted_val": {
- "type": "string"
- },
- "subcontract_limitations_include_notice": {
- "type": "boolean"
- },
- "subcontract_limitations_include_permission": {
- "type": "boolean"
- },
- "subcontract_limitations_notice_val": {
- "type": "string"
- },
- "subcontract_limitations_permission_val": {
- "type": "string"
- },
- "subcontract_limitations_permitted": {
- "type": "boolean"
- },
- "underlying_agreement_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "underlying_agreement_type": {
- "enum": [
- "internal",
- "external",
- "none"
- ],
- "type": "string"
- },
- "underlying_agreement_val": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "billing_email": {
- "description": "Email of the billing contact. Used when include_billing_info is true.",
- "format": "email",
- "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
- "type": "string"
- },
- "billing_name": {
- "description": "Name of the billing contact. Used when include_billing_info is true.",
- "type": "string"
- },
- "billing_workflow_type": {
- "description": "The type of billing workflow. Use \"link\" to provide a payment_link_url, or \"stripe\" for Stripe-managed billing.",
- "enum": [
- "link",
- "stripe"
- ],
- "type": "string"
- },
- "chosen_courts_country": {
- "description": "The country in which disputes will be resolved.",
- "type": "string"
- },
- "chosen_courts_region": {
- "description": "The state or region in which disputes will be resolved.",
- "type": "string"
- },
- "csa_attributes": {
- "additionalProperties": false,
- "description": "Override csa terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "customer_description": {
- "type": "string"
- },
- "effective_date": {
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "effective_date_marketplace": {
- "enum": [
- "AWS",
- "GCP",
- "Azure"
- ],
- "type": "string"
- },
- "effective_date_type": {
- "enum": [
- "signature",
- "date",
- "marketplace_acceptance"
- ],
- "type": "string"
- },
- "general_cap_amount": {
- "type": "number"
- },
- "general_cap_amount_type": {
- "enum": [
- "preceding",
- "base",
- "period"
- ],
- "type": "string"
- },
- "general_cap_period_currency": {
- "type": "number"
- },
- "general_cap_period_qty": {
- "type": "number"
- },
- "general_cap_preceding_amount": {
- "type": "number"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_acceptable_use_policy": {
- "type": "boolean"
- },
- "include_acceptable_use_policy_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_acceptable_use_policy_location": {
- "type": "string"
- },
- "include_acceptable_use_policy_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_additional_warranties": {
- "type": "boolean"
- },
- "include_additional_warranties_by_customer": {
- "type": "string"
- },
- "include_additional_warranties_by_provider": {
- "type": "string"
- },
- "include_additional_warranties_include_by_customer": {
- "type": "boolean"
- },
- "include_additional_warranties_include_by_provider": {
- "type": "boolean"
- },
- "include_ai_addendum": {
- "type": "boolean"
- },
- "include_ai_addendum_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_covered_claims": {
- "type": "boolean"
- },
- "include_covered_claims_customer_claims": {
- "type": "string"
- },
- "include_covered_claims_include_customer_claims": {
- "type": "boolean"
- },
- "include_covered_claims_include_provider_claims": {
- "type": "boolean"
- },
- "include_covered_claims_provider_claims": {
- "type": "string"
- },
- "include_dpa": {
- "type": "boolean"
- },
- "include_dpa_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_dpa_location": {
- "type": "string"
- },
- "include_dpa_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_increased_cap_amount": {
- "type": "boolean"
- },
- "include_increased_claims": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_confidentiality": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_confidentiality_negligence": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_privsec": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_privsec_negligence": {
- "type": "boolean"
- },
- "include_increased_claims_include_other": {
- "type": "boolean"
- },
- "include_increased_claims_indemnification_obligation": {
- "type": "boolean"
- },
- "include_increased_claims_other": {
- "type": "string"
- },
- "include_insurance_minimums": {
- "type": "boolean"
- },
- "include_insurance_minimums_add_customer": {
- "type": "boolean"
- },
- "include_insurance_minimums_add_customer_com_gen_liability": {
- "type": "boolean"
- },
- "include_insurance_minimums_add_customer_cyber_liability": {
- "type": "boolean"
- },
- "include_insurance_minimums_add_customer_errors_omissions": {
- "type": "boolean"
- },
- "include_insurance_minimums_additional_information": {
- "type": "boolean"
- },
- "include_insurance_minimums_additional_information_text": {
- "type": "string"
- },
- "include_insurance_minimums_cyber_liability_aggregate": {
- "type": "number"
- },
- "include_insurance_minimums_cyber_liability_minimum": {
- "type": "number"
- },
- "include_insurance_minimums_employer_liability_aggregate": {
- "type": "number"
- },
- "include_insurance_minimums_employer_liability_minimum": {
- "type": "number"
- },
- "include_insurance_minimums_general_liability_aggregate": {
- "type": "number"
- },
- "include_insurance_minimums_general_liability_minimum": {
- "type": "number"
- },
- "include_insurance_minimums_include_cyber_liability": {
- "type": "boolean"
- },
- "include_insurance_minimums_include_employer_liability": {
- "type": "boolean"
- },
- "include_insurance_minimums_include_general_liability": {
- "type": "boolean"
- },
- "include_insurance_minimums_include_workers_compensation": {
- "type": "boolean"
- },
- "include_publicity_rights": {
- "type": "boolean"
- },
- "include_publicity_rights_type": {
- "enum": [
- "public",
- "non-public"
- ],
- "type": "string"
- },
- "include_security_policy": {
- "type": "boolean"
- },
- "include_security_policy_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_security_policy_fedramp_auth": {
- "type": "boolean"
- },
- "include_security_policy_hipaa": {
- "type": "boolean"
- },
- "include_security_policy_hitrust": {
- "type": "boolean"
- },
- "include_security_policy_include_annual_maintenance": {
- "type": "boolean"
- },
- "include_security_policy_include_location": {
- "type": "boolean"
- },
- "include_security_policy_include_other": {
- "type": "boolean"
- },
- "include_security_policy_include_reasonable_efforts": {
- "type": "boolean"
- },
- "include_security_policy_iso27001": {
- "type": "boolean"
- },
- "include_security_policy_location": {
- "type": "string"
- },
- "include_security_policy_other": {
- "type": "string"
- },
- "include_security_policy_pci1": {
- "type": "boolean"
- },
- "include_security_policy_pci2": {
- "type": "boolean"
- },
- "include_security_policy_penetration_testing": {
- "type": "boolean"
- },
- "include_security_policy_soc2": {
- "type": "boolean"
- },
- "include_security_policy_soc2_type2": {
- "type": "boolean"
- },
- "include_security_policy_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_supercap": {
- "description": "CSA 3.0 renamed `include_increased_cap_amount` to `include_supercap`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_increased_cap_amount`. Sending the other spelling returns a 422.",
- "type": "boolean"
- },
- "include_uncapped_claims": {
- "description": "CSA 3.0 renamed `include_unlimited_claims` to `include_uncapped_claims`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims`. Sending the other spelling returns a 422.",
- "type": "boolean"
- },
- "include_uncapped_claims_breach_of_confidentiality": {
- "description": "CSA 3.0 renamed `include_unlimited_claims_breach_of_confidentiality` to `include_uncapped_claims_breach_of_confidentiality`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_breach_of_confidentiality`. Sending the other spelling returns a 422.",
- "type": "boolean"
- },
- "include_uncapped_claims_breach_of_confidentiality_negligence": {
- "description": "CSA 3.0 renamed `include_unlimited_claims_breach_of_confidentiality_negligence` to `include_uncapped_claims_breach_of_confidentiality_negligence`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_breach_of_confidentiality_negligence`. Sending the other spelling returns a 422.",
- "type": "boolean"
- },
- "include_uncapped_claims_breach_of_privsec": {
- "description": "CSA 3.0 renamed `include_unlimited_claims_breach_of_privsec` to `include_uncapped_claims_breach_of_privsec`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_breach_of_privsec`. Sending the other spelling returns a 422.",
- "type": "boolean"
- },
- "include_uncapped_claims_breach_of_privsec_negligence": {
- "description": "CSA 3.0 renamed `include_unlimited_claims_breach_of_privsec_negligence` to `include_uncapped_claims_breach_of_privsec_negligence`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_breach_of_privsec_negligence`. Sending the other spelling returns a 422.",
- "type": "boolean"
- },
- "include_uncapped_claims_include_other": {
- "description": "CSA 3.0 renamed `include_unlimited_claims_include_other` to `include_uncapped_claims_include_other`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_include_other`. Sending the other spelling returns a 422.",
- "type": "boolean"
- },
- "include_uncapped_claims_indemnification_obligation": {
- "description": "CSA 3.0 renamed `include_unlimited_claims_indemnification_obligation` to `include_uncapped_claims_indemnification_obligation`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_indemnification_obligation`. Sending the other spelling returns a 422.",
- "type": "boolean"
- },
- "include_uncapped_claims_other": {
- "description": "CSA 3.0 renamed `include_unlimited_claims_other` to `include_uncapped_claims_other`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_other`. Sending the other spelling returns a 422.",
- "type": "boolean"
- },
- "include_unlimited_claims": {
- "type": "boolean"
- },
- "include_unlimited_claims_breach_of_confidentiality": {
- "type": "boolean"
- },
- "include_unlimited_claims_breach_of_confidentiality_negligence": {
- "type": "boolean"
- },
- "include_unlimited_claims_breach_of_privsec": {
- "type": "boolean"
- },
- "include_unlimited_claims_breach_of_privsec_negligence": {
- "type": "boolean"
- },
- "include_unlimited_claims_include_other": {
- "type": "boolean"
- },
- "include_unlimited_claims_indemnification_obligation": {
- "type": "boolean"
- },
- "include_unlimited_claims_other": {
- "type": "string"
- },
- "increased_cap_amount_currency": {
- "type": "number"
- },
- "increased_cap_amount_period_currency": {
- "type": "number"
- },
- "increased_cap_amount_period_qty": {
- "type": "number"
- },
- "increased_cap_amount_qty": {
- "type": "number"
- },
- "increased_cap_amount_type": {
- "enum": [
- "qty",
- "currency",
- "period"
- ],
- "type": "string"
- },
- "provider": {
- "type": "string"
- },
- "supercap_currency": {
- "description": "CSA 3.0 renamed `increased_cap_amount_currency` to `supercap_currency`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `increased_cap_amount_currency`. Sending the other spelling returns a 422.",
- "type": "number"
- },
- "supercap_period_currency": {
- "description": "CSA 3.0 renamed `increased_cap_amount_period_currency` to `supercap_period_currency`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `increased_cap_amount_period_currency`. Sending the other spelling returns a 422.",
- "type": "number"
- },
- "supercap_period_qty": {
- "description": "CSA 3.0 renamed `increased_cap_amount_period_qty` to `supercap_period_qty`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `increased_cap_amount_period_qty`. Sending the other spelling returns a 422.",
- "type": "number"
- },
- "supercap_qty": {
- "description": "CSA 3.0 renamed `increased_cap_amount_qty` to `supercap_qty`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `increased_cap_amount_qty`. Sending the other spelling returns a 422.",
- "type": "number"
- },
- "supercap_type": {
- "description": "CSA 3.0 renamed `increased_cap_amount_type` to `supercap_type`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `increased_cap_amount_type`. Sending the other spelling returns a 422.",
- "type": "number"
- }
- },
- "type": "object"
- },
- "csa_order_form_attributes": {
- "additionalProperties": false,
- "description": "Override csa order form terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "additional_changes": {
- "type": "string"
- },
- "additional_parameters_or_limitations": {
- "type": "string"
- },
- "affiliates_as_users": {
- "type": "boolean"
- },
- "cloud_service_description": {
- "type": "string"
- },
- "consumption_units": {
- "type": "string"
- },
- "fee_amount": {
- "type": "number"
- },
- "fee_custom_unit": {
- "type": "string"
- },
- "fee_period": {
- "enum": [
- "Subscription Period",
- "month",
- "year",
- "User",
- "Custom unit"
- ],
- "type": "string"
- },
- "fees_attributes": {
- "additionalProperties": {
- "anyOf": [
- {
- "additionalProperties": false,
- "description": "Fees::Flat (fee_type \"flat\"). A fixed recurring fee, e.g. a platform subscription. Set type to \"Fees::Flat\" or fee_type to \"flat\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "Fixed amount in the order form's fees_currency, charged per fee_period. A plain amount, not cents: 20 means 20.00.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"flat\". Alternative to type.",
- "enum": [
- "flat"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Flat\". Optional when fee_type is set.",
- "enum": [
- "Fees::Flat"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Discount (fee_type \"discount\"). A discount, as a fixed amount or a percentage, applied forever, once, or for a number of months. Set type to \"Fees::Discount\" or fee_type to \"discount\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "Discount size: an amount in fees_currency when discount_type is fixed_amount (a plain amount, not cents: 20 means 20.00), or a percentage (e.g. 10 for 10%) when it is percentage.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "discount_duration_amount": {
- "description": "Number of months the discount applies. Required when discount_duration_type is multiple_months.",
- "type": "number"
- },
- "discount_duration_type": {
- "description": "How long the discount applies. multiple_months also needs discount_duration_amount.",
- "enum": [
- "forever",
- "once",
- "multiple_months"
- ],
- "type": "string"
- },
- "discount_type": {
- "description": "Whether cost is a currency amount or a percentage.",
- "enum": [
- "fixed_amount",
- "percentage"
- ],
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"discount\". Alternative to type.",
- "enum": [
- "discount"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Discount\". Optional when fee_type is set.",
- "enum": [
- "Fees::Discount"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Cost (fee_type \"cost\"). A per-unit fee: price per unit times quantity, e.g. seats. Set type to \"Fees::Cost\" or fee_type to \"cost\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "Price per unit in fees_currency. The row total is quantity x cost. A plain amount, not cents: 20 means 20.00.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"cost\". Alternative to type.",
- "enum": [
- "cost"
- ],
- "type": "string"
- },
- "quantity": {
- "description": "Number of units.",
- "type": "number"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Cost\". Optional when fee_type is set.",
- "enum": [
- "Fees::Cost"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Attachment (fee_type \"attachment\"). A fee described in an uploaded attachment instead of in the table. Set type to \"Fees::Attachment\" or fee_type to \"attachment\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "attachment_id": {
- "description": "ID of an attachment uploaded with upload-attachment.",
- "type": "string"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"attachment\". Alternative to type.",
- "enum": [
- "attachment"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Attachment\". Optional when fee_type is set.",
- "enum": [
- "Fees::Attachment"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Graduated (fee_type \"graduated\"). Tiered pricing, with the price set per tier in graduated_fee_tiers_attributes. Set type to \"Fees::Graduated\" or fee_type to \"graduated\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"graduated\". Alternative to type.",
- "enum": [
- "graduated"
- ],
- "type": "string"
- },
- "graduated_fee_tiers_attributes": {
- "additionalProperties": {
- "additionalProperties": false,
- "properties": {
- "flat_price": {
- "type": "number"
- },
- "price_per_unit": {
- "type": "string"
- },
- "upper_limit": {
- "type": "number"
- }
- },
- "type": "object"
- },
- "description": "Graduated fee tiers. Use string keys such as \"0\", \"1\".",
- "propertyNames": {
- "type": "string"
- },
- "type": "object"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Graduated\". Optional when fee_type is set.",
- "enum": [
- "Fees::Graduated"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Included (fee_type \"included\"). An item included at no charge. Set type to \"Fees::Included\" or fee_type to \"included\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"included\". Alternative to type.",
- "enum": [
- "included"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Included\". Optional when fee_type is set.",
- "enum": [
- "Fees::Included"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Metered (fee_type \"metered\"). Usage-based pricing, billed per unit used. Set type to \"Fees::Metered\" or fee_type to \"metered\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "Price per unit of usage in fees_currency. A plain amount, not cents: 20 means 20.00.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"metered\". Alternative to type.",
- "enum": [
- "metered"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Metered\". Optional when fee_type is set.",
- "enum": [
- "Fees::Metered"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::OneTime (fee_type \"one_time\"). A one-time charge, such as a setup fee. Set type to \"Fees::OneTime\" or fee_type to \"one_time\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "One-time amount in fees_currency, charged once rather than per fee_period. A plain amount, not cents: 20 means 20.00.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"one_time\". Alternative to type.",
- "enum": [
- "one_time"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::OneTime\". Optional when fee_type is set.",
- "enum": [
- "Fees::OneTime"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Text (fee_type \"text\"). A fee term described in free text. Set type to \"Fees::Text\" or fee_type to \"text\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"text\". Alternative to type.",
- "enum": [
- "text"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Text\". Optional when fee_type is set.",
- "enum": [
- "Fees::Text"
- ],
- "type": "string"
- }
- },
- "type": "object"
- }
- ]
- },
- "description": "Fee table rows, keyed by string index (\"0\", \"1\", ...). Replaces the template's fees when provided. Each row sets type or fee_type to pick the fee class. Amounts are in the order form's fees_currency and, for recurring fees, are charged per fee_period.",
- "examples": [
- {
- "0": {
- "cost": 2000,
- "description": "Platform subscription",
- "type": "Fees::Flat"
- }
- },
- {
- "0": {
- "cost": 50,
- "description": "Seats",
- "fee_type": "cost",
- "quantity": 10
- },
- "1": {
- "cost": 10,
- "description": "Launch discount",
- "discount_duration_amount": 3,
- "discount_duration_type": "multiple_months",
- "discount_type": "percentage",
- "fee_type": "discount"
- }
- }
- ],
- "propertyNames": {
- "type": "string"
- },
- "type": "object"
- },
- "fees_currency": {
- "enum": [
- "USD",
- "EUR",
- "GBP",
- "CAD",
- "AUD",
- "SGD",
- "ILS",
- "JPY",
- "CHF",
- "HKD"
- ],
- "type": "string"
- },
- "fees_include_fee_increase_upon_renewal": {
- "type": "boolean"
- },
- "fees_include_fee_increase_upon_renewal_fee": {
- "type": "number"
- },
- "fees_include_fee_increase_upon_renewal_type": {
- "enum": [
- "will",
- "may"
- ],
- "type": "string"
- },
- "fees_inclusive_of_taxes": {
- "type": "boolean"
- },
- "framework_terms_type": {
- "enum": [
- "new",
- "existing",
- "description"
- ],
- "type": "string"
- },
- "free_trial_days": {
- "type": "number"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_additional_changes": {
- "type": "boolean"
- },
- "include_additional_parameters_or_limitations": {
- "type": "boolean"
- },
- "include_consumption": {
- "type": "boolean"
- },
- "include_fees": {
- "type": "boolean"
- },
- "include_fees_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_fees_include_attachment": {
- "type": "boolean"
- },
- "include_fees_other": {
- "type": "boolean"
- },
- "include_fees_other_val": {
- "type": "string"
- },
- "include_fees_table": {
- "type": "boolean"
- },
- "include_fees_table_period": {
- "enum": [
- "Subscription Period",
- "month",
- "year",
- "User"
- ],
- "type": "string"
- },
- "include_free_trial": {
- "type": "boolean"
- },
- "include_max_users": {
- "type": "boolean"
- },
- "include_pilot_period": {
- "type": "boolean"
- },
- "include_pilot_period_duration_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_pilot_period_duration_type": {
- "enum": [
- "day",
- "week",
- "month"
- ],
- "type": "string"
- },
- "include_pilot_period_include_fees": {
- "type": "boolean"
- },
- "include_pilot_period_include_fees_amount": {
- "type": "number"
- },
- "include_pilot_period_include_modifications": {
- "type": "boolean"
- },
- "include_pilot_period_include_modifications_description": {
- "type": "string"
- },
- "include_product_support": {
- "type": "boolean"
- },
- "include_product_support_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_product_support_description": {
- "type": "string"
- },
- "include_product_support_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_professional_services": {
- "type": "boolean"
- },
- "include_professional_services_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_professional_services_custom_name": {
- "type": "string"
- },
- "include_professional_services_description": {
- "type": "string"
- },
- "include_professional_services_end_date": {
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "include_professional_services_fees_description": {
- "type": "string"
- },
- "include_professional_services_include_end_date": {
- "type": "boolean"
- },
- "include_professional_services_include_fees_description": {
- "type": "boolean"
- },
- "include_professional_services_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_sla": {
- "type": "boolean"
- },
- "include_sla_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_sla_description": {
- "type": "string"
- },
- "include_sla_include_response_time": {
- "type": "boolean"
- },
- "include_sla_include_response_time_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_sla_include_response_time_credit": {
- "type": "number"
- },
- "include_sla_include_response_time_duration": {
- "enum": [
- "hour",
- "day",
- "week",
- "month",
- "hours"
- ],
- "type": "string"
- },
- "include_sla_include_response_time_support_channel": {
- "type": "string"
- },
- "include_sla_include_target_uptime": {
- "type": "boolean"
- },
- "include_sla_maintenance_notice": {
- "type": "boolean"
- },
- "include_sla_maintenance_window": {
- "type": "boolean"
- },
- "include_sla_maintenance_window_type": {
- "enum": [
- "standard",
- "none"
- ],
- "type": "string"
- },
- "include_sla_standard_maintenance_notice_qty": {
- "type": "number"
- },
- "include_sla_standard_maintenance_notice_unit": {
- "enum": [
- "hour",
- "day",
- "week",
- "month"
- ],
- "type": "string"
- },
- "include_sla_standard_maintenance_window_end_time": {
- "type": "string"
- },
- "include_sla_standard_maintenance_window_friday": {
- "type": "boolean"
- },
- "include_sla_standard_maintenance_window_monday": {
- "type": "boolean"
- },
- "include_sla_standard_maintenance_window_saturday": {
- "type": "boolean"
- },
- "include_sla_standard_maintenance_window_start_time": {
- "type": "string"
- },
- "include_sla_standard_maintenance_window_sunday": {
- "type": "boolean"
- },
- "include_sla_standard_maintenance_window_thursday": {
- "type": "boolean"
- },
- "include_sla_standard_maintenance_window_time_zone": {
- "type": "string"
- },
- "include_sla_standard_maintenance_window_tuesday": {
- "type": "boolean"
- },
- "include_sla_standard_maintenance_window_wednesday": {
- "type": "boolean"
- },
- "include_sla_standard_target_uptime": {
- "type": "number"
- },
- "include_sla_type": {
- "enum": [
- "description",
- "standard",
- "attachment"
- ],
- "type": "string"
- },
- "include_subscription_start_date": {
- "type": "boolean"
- },
- "include_subscription_start_date_date": {
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "include_usage_review": {
- "type": "boolean"
- },
- "include_usage_review_val": {
- "type": "string"
- },
- "include_use_limitations": {
- "type": "boolean"
- },
- "include_use_limitations_val": {
- "type": "string"
- },
- "invoice_period": {
- "enum": [
- "monthly",
- "quarterly",
- "semiannually",
- "annually",
- "Custom unit",
- "Monthly",
- "Quarterly",
- "Semiannually",
- "Annually"
- ],
- "type": "string"
- },
- "invoice_period_custom_unit": {
- "type": "string"
- },
- "max_consumption": {
- "type": "number"
- },
- "max_users": {
- "type": "number"
- },
- "negotiations_allowed": {
- "description": "When true, the recipient can propose changes to the order form, even when the agreement-level `negotiations_allowed` is false. This only covers the order form.",
- "type": "boolean"
- },
- "order_date_date": {
- "type": "string"
- },
- "order_date_other": {
- "type": "string"
- },
- "order_date_type": {
- "enum": [
- "signature",
- "date",
- "other"
- ],
- "type": "string"
- },
- "payment_period": {
- "type": "number"
- },
- "payment_period_timeframe": {
- "enum": [
- "Customer's receipt of invoice",
- "date of invoice"
- ],
- "type": "string"
- },
- "payment_period_unit": {
- "enum": [
- "day(s)",
- "week(s)",
- "month(s)",
- "marketplace_acceptance"
- ],
- "type": "string"
- },
- "payment_process_automatic_frequency": {
- "enum": [
- "monthly",
- "quarterly",
- "semiannually",
- "annually"
- ],
- "type": "string"
- },
- "payment_process_type": {
- "enum": [
- "automatic",
- "invoice",
- "custom",
- "marketplace_acceptance"
- ],
- "type": "string"
- },
- "payment_process_type_custom_val": {
- "type": "string"
- },
- "payment_process_type_invoice_amount": {
- "type": "number"
- },
- "payment_process_type_invoice_custom_unit": {
- "type": "string"
- },
- "payment_process_type_invoice_duration": {
- "enum": [
- "day",
- "week",
- "month",
- "year",
- "day(s)",
- "week(s)",
- "month(s)",
- "year(s)"
- ],
- "type": "string"
- },
- "payment_process_type_invoice_duration_start": {
- "enum": [
- "Customer's receipt of invoice",
- "date of invoice"
- ],
- "type": "string"
- },
- "payment_process_type_invoice_type": {
- "enum": [
- "monthly",
- "quarterly",
- "semiannually",
- "annually",
- "Custom unit"
- ],
- "type": "string"
- },
- "pilot_period_stripe_product_id": {
- "type": "string"
- },
- "service_credits_attributes": {
- "additionalProperties": {
- "additionalProperties": false,
- "properties": {
- "credit": {
- "type": "number"
- },
- "max": {
- "type": "number"
- },
- "min": {
- "type": "number"
- }
- },
- "type": "object"
- },
- "description": "Service credits. Use string keys such as \"0\", \"1\".",
- "propertyNames": {
- "type": "string"
- },
- "type": "object"
- },
- "subscription_auto_renew": {
- "enum": [
- "days",
- "subscription_end"
- ],
- "type": "string"
- },
- "subscription_period": {
- "type": "number"
- },
- "subscription_period_unit": {
- "type": "string"
- },
- "subscription_renewal_notice_days": {
- "type": "number"
- },
- "subscription_start_date": {
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "subscription_start_date_type": {
- "enum": [
- "effective_date",
- "date"
- ],
- "type": "string"
- },
- "underlying_agreement_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "use_limitations_attributes": {
- "additionalProperties": {
- "additionalProperties": false,
- "properties": {
- "amount": {
- "type": "number"
- },
- "limitation_type": {
- "type": "string"
- },
- "unit": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "description": "Use limitations. Use string keys such as \"0\", \"1\".",
- "propertyNames": {
- "type": "string"
- },
- "type": "object"
- }
- },
- "type": "object"
- },
- "custom_field_values": {
- "description": "Values for a custom template's fields, keyed by the field keys defined in the template's YAML definition. Only used when template_id is a custom template. Template defaults fill any fields you omit; a required field with no default and no submitted value returns a 400 naming the field. Values are validated against the field's input type: select and radio values must be one of the field's options, multiselect values are an array of selections each of which must be one of the field's options, number and currency values must be numeric, date values must be YYYY-MM-DD, and email values must be valid addresses. An invalid value returns a 400 naming the field."
- },
- "design_partner_attributes": {
- "additionalProperties": false,
- "description": "Override design partner terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "customer_description": {
- "type": "string"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_fees": {
- "type": "boolean"
- },
- "include_fees_amount": {
- "type": "number"
- },
- "include_fees_description": {
- "type": "string"
- },
- "include_fees_pay_by_amount": {
- "type": "string"
- },
- "include_fees_type": {
- "enum": [
- "default_language",
- "description"
- ],
- "type": "string"
- },
- "include_fees_unit": {
- "enum": [
- "month",
- "quarter",
- "year",
- "Term"
- ],
- "type": "string"
- },
- "include_program_appear_as_customer_private": {
- "type": "boolean"
- },
- "include_program_appear_as_customer_public": {
- "type": "boolean"
- },
- "include_program_case_study": {
- "type": "boolean"
- },
- "include_program_develop_functionality": {
- "type": "boolean"
- },
- "include_program_develop_functionality_val": {
- "type": "string"
- },
- "include_program_discount": {
- "type": "boolean"
- },
- "include_program_discount_amount": {
- "type": "number"
- },
- "include_program_discount_unit": {
- "enum": [
- "U.S. Dollars",
- "percent"
- ],
- "type": "string"
- },
- "include_program_participation_feedback": {
- "type": "boolean"
- },
- "include_program_participation_feedback_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_program_participation_feedback_unit": {
- "enum": [
- "month",
- "quarter",
- "year",
- "Term"
- ],
- "type": "string"
- },
- "include_program_partner_other": {
- "type": "boolean"
- },
- "include_program_partner_other_val": {
- "type": "string"
- },
- "include_program_provider_other": {
- "type": "boolean"
- },
- "include_program_provider_other_val": {
- "type": "string"
- },
- "include_program_reference": {
- "type": "boolean"
- },
- "product_description": {
- "type": "string"
- },
- "term_amount": {
- "type": "number"
- },
- "term_unit": {
- "enum": [
- "day(s)",
- "week(s)",
- "month(s)",
- "quarter(s)",
- "year(s)"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- "district_or_county": {
- "description": "The district or county for dispute resolution.",
- "type": "string"
- },
- "dpa_attributes": {
- "additionalProperties": false,
- "description": "Override dpa terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "approved_subprocessor_type": {
- "description": "`internal` lists approved subprocessors in the agreement (`subprocessors_attributes`); `external` points to a list published elsewhere.",
- "enum": [
- "internal",
- "external"
- ],
- "type": "string"
- },
- "cloud_service_product_name": {
- "type": "string"
- },
- "competent_supervisory_authority": {
- "type": "string"
- },
- "customer_description": {
- "type": "string"
- },
- "data_exporter_address_city": {
- "type": "string"
- },
- "data_exporter_address_country": {
- "type": "string"
- },
- "data_exporter_address_state": {
- "type": "string"
- },
- "data_exporter_address_street_address": {
- "type": "string"
- },
- "data_exporter_address_zipcode": {
- "type": "string"
- },
- "data_exporter_contact_details": {
- "type": "string"
- },
- "data_exporter_contact_name": {
- "type": "string"
- },
- "data_exporter_contact_position": {
- "type": "string"
- },
- "data_exporter_role": {
- "description": "Role of the data exporter. Overwritten to `Controller` when the agreement is created from a template.",
- "enum": [
- "Controller",
- "Processor"
- ],
- "type": "string"
- },
- "data_importer_address": {
- "type": "string"
- },
- "data_importer_address_city": {
- "type": "string"
- },
- "data_importer_address_country": {
- "type": "string"
- },
- "data_importer_address_state": {
- "type": "string"
- },
- "data_importer_address_street_address": {
- "type": "string"
- },
- "data_importer_address_zipcode": {
- "type": "string"
- },
- "data_importer_contact_details": {
- "type": "string"
- },
- "data_importer_contact_name": {
- "type": "string"
- },
- "data_importer_contact_position": {
- "type": "string"
- },
- "duration_of_processing": {
- "type": "string"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_covered_claim": {
- "type": "boolean"
- },
- "include_covered_claim_external_val": {
- "type": "string"
- },
- "include_covered_claim_internal_val": {
- "type": "string"
- },
- "include_covered_claim_type": {
- "description": "Which covered-claim text applies: `internal` uses `include_covered_claim_internal_val`, `external` uses `include_covered_claim_external_val`. Required when `include_covered_claim` is true.",
- "enum": [
- "internal",
- "external"
- ],
- "type": "string"
- },
- "include_data_subjects_custom": {
- "type": "boolean"
- },
- "include_data_subjects_custom_val": {
- "type": "string"
- },
- "include_data_subjects_employees": {
- "type": "boolean"
- },
- "include_data_subjects_end_users": {
- "type": "boolean"
- },
- "include_external_subprocessor_location": {
- "type": "string"
- },
- "include_frequency_of_transfer_continuous": {
- "type": "boolean"
- },
- "include_frequency_of_transfer_custom": {
- "type": "boolean"
- },
- "include_frequency_of_transfer_custom_val": {
- "type": "string"
- },
- "include_governing_country_eu": {
- "type": "boolean"
- },
- "include_governing_country_eu_val": {
- "type": "string"
- },
- "include_governing_country_uk": {
- "type": "boolean"
- },
- "include_governing_country_uk_val": {
- "type": "string"
- },
- "include_governing_law": {
- "type": "boolean"
- },
- "include_governing_law_country": {
- "type": "string"
- },
- "include_governing_law_state": {
- "type": "string"
- },
- "include_increased_claim_amount": {
- "description": "Legacy field. Stored but not shown on the DPA; use the `include_liability_cap*` fields instead.",
- "type": "boolean"
- },
- "include_increased_claim_amount_currency": {
- "description": "Legacy field. Stored but not shown on the DPA; use the `include_liability_cap*` fields instead."
- },
- "include_increased_claim_amount_qty": {
- "description": "Legacy field. Stored but not shown on the DPA; use the `include_liability_cap*` fields instead."
- },
- "include_increased_claim_amount_type": {
- "description": "Legacy field. Stored but not shown on the DPA; use the `include_liability_cap*` fields instead.",
- "type": "string"
- },
- "include_liability_cap": {
- "type": "boolean"
- },
- "include_liability_cap_amount_constant_external": {
- "type": "string"
- },
- "include_liability_cap_amount_constant_internal": {
- "type": "string"
- },
- "include_liability_cap_amount_currency_external": {
- "description": "Currency amount. Numbers and numeric strings (commas allowed) are both accepted."
- },
- "include_liability_cap_amount_currency_internal": {
- "description": "Currency amount. Numbers and numeric strings (commas allowed) are both accepted."
- },
- "include_liability_cap_csa_type": {
- "description": "Which liability cap values apply: the `_internal` or `_external` amount fields. Required when `include_liability_cap` is true.",
- "enum": [
- "internal",
- "external"
- ],
- "type": "string"
- },
- "include_personal_data_biographic_info": {
- "type": "boolean"
- },
- "include_personal_data_contact_info": {
- "type": "boolean"
- },
- "include_personal_data_custom": {
- "type": "boolean"
- },
- "include_personal_data_custom_val": {
- "type": "string"
- },
- "include_personal_data_employment_info": {
- "type": "boolean"
- },
- "include_personal_data_financial_info": {
- "type": "boolean"
- },
- "include_personal_data_location": {
- "type": "boolean"
- },
- "include_personal_data_name": {
- "type": "boolean"
- },
- "include_personal_data_transactional_info": {
- "type": "boolean"
- },
- "include_personal_data_user_activity_info": {
- "type": "boolean"
- },
- "include_processing_purpose_custom": {
- "type": "boolean"
- },
- "include_processing_purpose_custom_val": {
- "type": "string"
- },
- "include_processing_purpose_erasing": {
- "type": "boolean"
- },
- "include_processing_purpose_holding": {
- "type": "boolean"
- },
- "include_processing_purpose_protecting": {
- "type": "boolean"
- },
- "include_processing_purpose_receiving": {
- "type": "boolean"
- },
- "include_processing_purpose_returning": {
- "type": "boolean"
- },
- "include_processing_purpose_sharing": {
- "type": "boolean"
- },
- "include_processing_purpose_updating": {
- "type": "boolean"
- },
- "include_processing_purpose_using": {
- "type": "boolean"
- },
- "include_provider_security_contact_address": {
- "type": "boolean"
- },
- "include_provider_security_contact_address_city": {
- "type": "string"
- },
- "include_provider_security_contact_address_country": {
- "type": "string"
- },
- "include_provider_security_contact_address_state": {
- "type": "string"
- },
- "include_provider_security_contact_address_street_address": {
- "type": "string"
- },
- "include_provider_security_contact_address_zipcode": {
- "type": "string"
- },
- "include_provider_security_contact_email": {
- "type": "boolean"
- },
- "include_provider_security_contact_email_val": {
- "format": "email",
- "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
- "type": "string"
- },
- "include_security_measures_accountability": {
- "type": "boolean"
- },
- "include_security_measures_accountability_val": {
- "type": "string"
- },
- "include_security_measures_certification_or_assurance": {
- "type": "boolean"
- },
- "include_security_measures_certification_or_assurance_val": {
- "type": "string"
- },
- "include_security_measures_confidentiality_integrity": {
- "type": "boolean"
- },
- "include_security_measures_confidentiality_integrity_val": {
- "type": "string"
- },
- "include_security_measures_data_at_rest": {
- "type": "boolean"
- },
- "include_security_measures_data_at_rest_val": {
- "type": "string"
- },
- "include_security_measures_data_minimization": {
- "type": "boolean"
- },
- "include_security_measures_data_minimization_val": {
- "type": "string"
- },
- "include_security_measures_data_quality": {
- "type": "boolean"
- },
- "include_security_measures_data_quality_val": {
- "type": "string"
- },
- "include_security_measures_data_retention": {
- "type": "boolean"
- },
- "include_security_measures_data_retention_val": {
- "type": "string"
- },
- "include_security_measures_data_transmission": {
- "type": "boolean"
- },
- "include_security_measures_data_transmission_val": {
- "type": "string"
- },
- "include_security_measures_event_logging": {
- "type": "boolean"
- },
- "include_security_measures_event_logging_val": {
- "type": "string"
- },
- "include_security_measures_identity_auth": {
- "type": "boolean"
- },
- "include_security_measures_identity_auth_val": {
- "type": "string"
- },
- "include_security_measures_it_security_governance": {
- "type": "boolean"
- },
- "include_security_measures_it_security_governance_val": {
- "type": "string"
- },
- "include_security_measures_physical_security": {
- "type": "boolean"
- },
- "include_security_measures_physical_security_val": {
- "type": "string"
- },
- "include_security_measures_portability_and_erasure": {
- "type": "boolean"
- },
- "include_security_measures_portability_and_erasure_val": {
- "type": "string"
- },
- "include_security_measures_pseudonym_encryption": {
- "type": "boolean"
- },
- "include_security_measures_pseudonym_encryption_val": {
- "type": "string"
- },
- "include_security_measures_restore_data_access": {
- "type": "boolean"
- },
- "include_security_measures_restore_data_access_val": {
- "type": "string"
- },
- "include_security_measures_security_policy": {
- "type": "boolean"
- },
- "include_security_measures_system_configuration": {
- "type": "boolean"
- },
- "include_security_measures_system_configuration_val": {
- "type": "string"
- },
- "include_security_measures_testing_assessment": {
- "type": "boolean"
- },
- "include_security_measures_testing_assessment_val": {
- "type": "string"
- },
- "include_security_policy": {
- "type": "boolean"
- },
- "include_security_policy_fedramp_auth": {
- "type": "boolean"
- },
- "include_security_policy_hipaa": {
- "type": "boolean"
- },
- "include_security_policy_hitrust": {
- "type": "boolean"
- },
- "include_security_policy_include_other": {
- "type": "boolean"
- },
- "include_security_policy_iso27001": {
- "type": "boolean"
- },
- "include_security_policy_other": {
- "type": "string"
- },
- "include_security_policy_pci1": {
- "type": "boolean"
- },
- "include_security_policy_pci2": {
- "type": "boolean"
- },
- "include_security_policy_penetration_testing": {
- "type": "boolean"
- },
- "include_security_policy_soc2": {
- "type": "boolean"
- },
- "include_security_policy_soc2_type2": {
- "type": "boolean"
- },
- "include_sensitive_data_restrictions_custom": {
- "type": "boolean"
- },
- "include_sensitive_data_restrictions_custom_val": {
- "type": "string"
- },
- "include_sensitive_data_restrictions_security_policy": {
- "type": "boolean"
- },
- "include_service_provider_relationship": {
- "type": "boolean"
- },
- "include_special_category_data": {
- "type": "boolean"
- },
- "provider": {
- "type": "string"
- },
- "security_policy_available_at": {
- "type": "string"
- },
- "security_policy_type": {
- "description": "Where the Security Policy is defined. For `external`, set `security_policy_available_at`.",
- "enum": [
- "defined in agreement",
- "provider service",
- "external"
- ],
- "type": "string"
- },
- "subprocessors_attributes": {
- "additionalProperties": {
- "additionalProperties": false,
- "properties": {
- "_destroy": {
- "description": "Set to true with `id` to remove that subprocessor.",
- "type": "boolean"
- },
- "country": {
- "type": "string"
- },
- "id": {
- "description": "ID of an existing subprocessor to update or remove. Omit to add a new subprocessor.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "name": {
- "type": "string"
- },
- "processing_task": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "description": "Subprocessors, keyed by string index such as \"0\", \"1\". On create these are added to the template's subprocessors. On a draft update, an entry without `id` adds a new subprocessor; pass `id` to change one and `id` with `_destroy: true` to remove one.",
- "propertyNames": {
- "type": "string"
- },
- "type": "object"
- },
- "underlying_agreement_id": {
- "description": "ID of the CSA this DPA supplements when `underlying_agreement_type` is `internal`.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "underlying_agreement_type": {
- "description": "`internal` links a CSA in Common Paper (`underlying_agreement_id`); `external` describes another agreement in `underlying_agreement_val` (required). Omit for none.",
- "enum": [
- "internal",
- "external"
- ],
- "type": "string"
- },
- "underlying_agreement_val": {
- "description": "Description of the agreement this DPA supplements. Required when `underlying_agreement_type` is `external`.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "framework_terms_description": {
- "description": "Custom framework terms description. Only used when framework_terms_type is \"description\".",
- "type": "string"
- },
- "framework_terms_type": {
- "description": "How framework terms are specified. Use \"new\" for standard terms or \"description\" to provide a custom framework_terms_description.",
- "enum": [
- "new",
- "description"
- ],
- "type": "string"
- },
- "governing_law_country": {
- "description": "The country whose laws govern the agreement.",
- "type": "string"
- },
- "governing_law_region": {
- "description": "The state or region whose laws govern the agreement.",
- "type": "string"
- },
- "include_automated_payment_reminders": {
- "description": "When true, automatically sends payment reminder emails.",
- "type": "boolean"
- },
- "include_billing_info": {
- "description": "When true, billing contact information (billing_name, billing_email) is included.",
- "type": "boolean"
- },
- "include_billing_workflow": {
- "description": "When true, enables a billing workflow after signing.",
- "type": "boolean"
- },
- "include_expiration_date": {
- "description": "Expiration date in YYYY-MM-DD format. Use when include_expiration_type is \"date\".",
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "include_expiration_days": {
- "description": "Number of days until the agreement expires. Use when include_expiration_type is \"days\".",
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_expiration_type": {
- "description": "How to set expiration: \"none\" (default), \"days\" (use include_expiration_days), or \"date\" (use include_expiration_date).",
- "enum": [
- "none",
- "days",
- "date"
- ],
- "type": "string"
- },
- "include_terms": {
- "description": "When true, the standard terms are included with the agreement.",
- "type": "boolean"
- },
- "loi_attributes": {
- "additionalProperties": false,
- "description": "Override loi terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "confidentiality_custom": {
- "type": "string"
- },
- "confidentiality_mutual_include_loi": {
- "type": "boolean"
- },
- "confidentiality_nda_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "confidentiality_nda_description": {
- "type": "string"
- },
- "confidentiality_nda_include_loi": {
- "type": "boolean"
- },
- "confidentiality_nda_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "confidentiality_type": {
- "enum": [
- "mutual",
- "nda",
- "provider",
- "custom"
- ],
- "type": "string"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_custom_details": {
- "type": "boolean"
- },
- "include_custom_details_val": {
- "type": "string"
- },
- "include_fees": {
- "type": "boolean"
- },
- "include_fees_amount": {
- "type": "number"
- },
- "include_fees_amount_duration": {
- "enum": [
- "month",
- "year",
- "quarter"
- ],
- "type": "string"
- },
- "include_fees_include_amount": {
- "type": "boolean"
- },
- "include_fees_include_other": {
- "type": "boolean"
- },
- "include_fees_other": {
- "type": "string"
- },
- "include_functionality": {
- "type": "boolean"
- },
- "include_functionality_val": {
- "type": "string"
- },
- "include_launch_date": {
- "type": "boolean"
- },
- "include_launch_date_custom": {
- "type": "string"
- },
- "include_launch_date_date": {
- "format": "date-time",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$",
- "type": "string"
- },
- "include_launch_date_type": {
- "enum": [
- "date",
- "custom"
- ],
- "type": "string"
- },
- "product_name": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "manual_send": {
- "description": "When true, the agreement is marked as manually sent outside the platform.",
- "type": "boolean"
- },
- "message": {
- "type": "string"
- },
- "negotiations_allowed": {
- "description": "When true, the recipient can propose changes to the legal terms. For agreement types without separate business terms, that covers every term. CSA order forms, PSA statements of work, partnership business terms and software license order forms have their own `negotiations_allowed` flag.",
- "type": "boolean"
- },
- "partnership_attributes": {
- "additionalProperties": false,
- "description": "Override partnership terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "effective_date": {
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "effective_date_type": {
- "enum": [
- "signature",
- "date"
- ],
- "type": "string"
- },
- "general_cap_amount_currency_val": {
- "type": "number"
- },
- "general_cap_amount_either_currency": {
- "type": "number"
- },
- "general_cap_amount_either_multiple": {
- "type": "number"
- },
- "general_cap_amount_multiple_val": {
- "type": "number"
- },
- "general_cap_amount_type": {
- "enum": [
- "multiple",
- "currency",
- "either",
- "base"
- ],
- "type": "string"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_additional_warranties": {
- "type": "boolean"
- },
- "include_additional_warranties_include_company": {
- "type": "boolean"
- },
- "include_additional_warranties_include_company_val": {
- "type": "string"
- },
- "include_additional_warranties_include_partner": {
- "type": "boolean"
- },
- "include_additional_warranties_include_partner_val": {
- "type": "string"
- },
- "include_brand_guidelines": {
- "type": "boolean"
- },
- "include_brand_guidelines_include_company": {
- "type": "boolean"
- },
- "include_brand_guidelines_include_company_val": {
- "type": "string"
- },
- "include_brand_guidelines_include_partner": {
- "type": "boolean"
- },
- "include_brand_guidelines_include_partner_val": {
- "type": "string"
- },
- "include_covered_claims": {
- "type": "boolean"
- },
- "include_covered_claims_company_claims": {
- "type": "string"
- },
- "include_covered_claims_include_company_claims": {
- "type": "boolean"
- },
- "include_covered_claims_include_partner_claims": {
- "type": "boolean"
- },
- "include_covered_claims_partner_claims": {
- "type": "string"
- },
- "include_dpa": {
- "type": "boolean"
- },
- "include_dpa_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_dpa_location": {
- "type": "string"
- },
- "include_dpa_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_increased_cap_amount": {
- "type": "boolean"
- },
- "include_increased_cap_amount_currency": {
- "type": "number"
- },
- "include_increased_cap_amount_either_currency": {
- "type": "number"
- },
- "include_increased_cap_amount_either_multiple": {
- "type": "string"
- },
- "include_increased_cap_amount_multiple": {
- "type": "string"
- },
- "include_increased_cap_amount_type": {
- "enum": [
- "multiple",
- "currency",
- "either"
- ],
- "type": "string"
- },
- "include_increased_claims": {
- "type": "boolean"
- },
- "include_increased_claims_include_confidentiality": {
- "type": "boolean"
- },
- "include_increased_claims_include_confidentiality_misconduct": {
- "type": "boolean"
- },
- "include_increased_claims_include_covered_claims": {
- "type": "boolean"
- },
- "include_increased_claims_include_misconduct": {
- "type": "boolean"
- },
- "include_increased_claims_include_other": {
- "type": "boolean"
- },
- "include_increased_claims_include_other_val": {
- "type": "string"
- },
- "include_unlimited_claims": {
- "type": "boolean"
- },
- "include_unlimited_claims_confidentiality": {
- "type": "boolean"
- },
- "include_unlimited_claims_confidentiality_misconduct": {
- "type": "boolean"
- },
- "include_unlimited_claims_covered_claims": {
- "type": "boolean"
- },
- "include_unlimited_claims_misconduct": {
- "type": "boolean"
- },
- "include_unlimited_claims_other": {
- "type": "boolean"
- },
- "include_unlimited_claims_other_val": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "partnership_business_terms_attributes": {
- "additionalProperties": false,
- "description": "Override partnership business terms terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "end_date_after_effective_date_amount": {
- "type": "number"
- },
- "end_date_after_effective_date_unit": {
- "enum": [
- "month(s)",
- "quarter(s)",
- "year(s)"
- ],
- "type": "string"
- },
- "end_date_date": {
- "type": "string"
- },
- "end_date_type": {
- "enum": [
- "date",
- "effective date"
- ],
- "type": "string"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_obligations_company_brand": {
- "type": "boolean"
- },
- "include_obligations_company_promotion": {
- "type": "boolean"
- },
- "include_obligations_company_promotion_include_activities": {
- "type": "boolean"
- },
- "include_obligations_company_promotion_include_activities_val": {
- "type": "string"
- },
- "include_obligations_company_promotion_include_materials": {
- "type": "boolean"
- },
- "include_obligations_company_promotion_include_materials_val": {
- "type": "string"
- },
- "include_obligations_company_referral": {
- "type": "boolean"
- },
- "include_obligations_company_referral_include_criteria": {
- "type": "boolean"
- },
- "include_obligations_company_referral_include_criteria_val": {
- "type": "string"
- },
- "include_obligations_company_referral_include_pay_sch": {
- "type": "boolean"
- },
- "include_obligations_company_referral_include_pay_sch_amount": {
- "type": "number"
- },
- "include_obligations_company_referral_include_pay_sch_custom": {
- "type": "string"
- },
- "include_obligations_company_referral_include_pay_sch_unit": {
- "enum": [
- "U.S. Dollars",
- "percent"
- ],
- "type": "string"
- },
- "include_obligations_company_sponsorship": {
- "type": "boolean"
- },
- "include_obligations_company_sponsorship_include_benefits": {
- "type": "boolean"
- },
- "include_obligations_company_sponsorship_include_benefits_val": {
- "type": "string"
- },
- "include_obligations_company_sponsorship_include_payments": {
- "type": "boolean"
- },
- "include_obligations_company_sponsorship_include_payments_amount": {
- "type": "number"
- },
- "include_obligations_company_sponsorship_include_payments_unit": {
- "enum": [
- "U.S. Dollars",
- "percent"
- ],
- "type": "string"
- },
- "include_obligations_partner_brand": {
- "type": "boolean"
- },
- "include_obligations_partner_promotion": {
- "type": "boolean"
- },
- "include_obligations_partner_promotion_include_activities": {
- "type": "boolean"
- },
- "include_obligations_partner_promotion_include_activities_val": {
- "type": "string"
- },
- "include_obligations_partner_promotion_include_materials": {
- "type": "boolean"
- },
- "include_obligations_partner_promotion_include_materials_val": {
- "type": "string"
- },
- "include_obligations_partner_referral": {
- "type": "boolean"
- },
- "include_obligations_partner_referral_include_criteria": {
- "type": "boolean"
- },
- "include_obligations_partner_referral_include_criteria_val": {
- "type": "string"
- },
- "include_obligations_partner_referral_include_pay_sch": {
- "type": "boolean"
- },
- "include_obligations_partner_referral_include_pay_sch_amount": {
- "type": "number"
- },
- "include_obligations_partner_referral_include_pay_sch_custom": {
- "type": "string"
- },
- "include_obligations_partner_referral_include_pay_sch_unit": {
- "enum": [
- "U.S. Dollars",
- "percent"
- ],
- "type": "string"
- },
- "include_obligations_partner_sponsorship": {
- "type": "boolean"
- },
- "include_obligations_partner_sponsorship_include_benefits": {
- "type": "boolean"
- },
- "include_obligations_partner_sponsorship_include_benefits_val": {
- "type": "string"
- },
- "include_obligations_partner_sponsorship_include_payments": {
- "type": "boolean"
- },
- "include_obligations_partner_sponsorship_include_payments_amount": {
- "type": "number"
- },
- "include_obligations_partner_sponsorship_include_payments_unit": {
- "enum": [
- "U.S. Dollars",
- "percent"
- ],
- "type": "string"
- },
- "include_payment_process": {
- "type": "boolean"
- },
- "include_payment_process_company": {
- "type": "boolean"
- },
- "include_payment_process_company_include_address": {
- "type": "boolean"
- },
- "include_payment_process_company_include_address_city": {
- "type": "string"
- },
- "include_payment_process_company_include_address_country": {
- "type": "string"
- },
- "include_payment_process_company_include_address_state": {
- "type": "string"
- },
- "include_payment_process_company_include_address_street_address": {
- "type": "string"
- },
- "include_payment_process_company_include_address_zipcode": {
- "type": "string"
- },
- "include_payment_process_company_include_email": {
- "type": "boolean"
- },
- "include_payment_process_company_include_email_val": {
- "type": "string"
- },
- "include_payment_process_partner": {
- "type": "boolean"
- },
- "include_payment_process_partner_include_address": {
- "type": "boolean"
- },
- "include_payment_process_partner_include_address_city": {
- "type": "string"
- },
- "include_payment_process_partner_include_address_country": {
- "type": "string"
- },
- "include_payment_process_partner_include_address_state": {
- "type": "string"
- },
- "include_payment_process_partner_include_address_street_address": {
- "type": "string"
- },
- "include_payment_process_partner_include_address_zipcode": {
- "type": "string"
- },
- "include_payment_process_partner_include_email": {
- "type": "boolean"
- },
- "include_payment_process_partner_include_email_val": {
- "type": "string"
- },
- "include_payment_schedule": {
- "type": "boolean"
- },
- "include_payment_schedule_custom": {
- "type": "string"
- },
- "include_payment_schedule_specified_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_payment_schedule_specified_timeframe": {
- "enum": [
- "receipt",
- "date"
- ],
- "type": "string"
- },
- "include_payment_schedule_specified_unit": {
- "enum": [
- "day(s)",
- "week(s)",
- "month(s)",
- "quarter(s)",
- "year(s)"
- ],
- "type": "string"
- },
- "include_payment_schedule_type": {
- "enum": [
- "specified",
- "custom"
- ],
- "type": "string"
- },
- "negotiations_allowed": {
- "description": "When true, the recipient can propose changes to the business terms, even when the agreement-level `negotiations_allowed` is false. This only covers the business terms.",
- "type": "boolean"
- },
- "territory_type": {
- "enum": [
- "worldwide",
- "custom"
- ],
- "type": "string"
- },
- "territory_type_val": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "payment_link_url": {
- "description": "A payment URL shown to the recipient after signing. Requires include_billing_workflow to be true and billing_workflow_type to be \"link\".",
- "type": "string"
- },
- "pilot_attributes": {
- "additionalProperties": false,
- "description": "Override pilot terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "fees_type": {
- "enum": [
- "free",
- "pilot_period_fees"
- ],
- "type": "string"
- },
- "general_cap_amount": {
- "type": "number"
- },
- "general_cap_amount_type": {
- "enum": [
- "preceding",
- "base",
- "period"
- ],
- "type": "string"
- },
- "general_cap_period_currency": {
- "type": "number"
- },
- "general_cap_period_qty": {
- "type": "number"
- },
- "general_cap_preceding_amount": {
- "type": "number"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_dpa": {
- "type": "boolean"
- },
- "include_dpa_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_dpa_location": {
- "type": "string"
- },
- "include_dpa_type": {
- "enum": [
- "description",
- "attachment",
- "standard"
- ],
- "type": "string"
- },
- "include_payment_process": {
- "type": "boolean"
- },
- "include_technical_support": {
- "type": "boolean"
- },
- "payment_process_automatic_frequency": {
- "enum": [
- "monthly",
- "quarterly",
- "annually",
- "once_per_period"
- ],
- "type": "string"
- },
- "payment_process_invoice_days": {
- "type": "number"
- },
- "payment_process_invoice_from": {
- "enum": [
- "receipt",
- "date"
- ],
- "type": "string"
- },
- "payment_process_invoice_timeframe": {
- "enum": [
- "days",
- "weeks",
- "months",
- "quarters",
- "years"
- ],
- "type": "string"
- },
- "payment_process_type": {
- "enum": [
- "automatic",
- "invoice"
- ],
- "type": "string"
- },
- "pilot_period_description": {
- "type": "string"
- },
- "pilot_period_fees_description": {
- "type": "string"
- },
- "product_description": {
- "type": "string"
- },
- "technical_support_description": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "psa_attributes": {
- "additionalProperties": false,
- "description": "Override psa terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "additional_changes": {
- "type": "string"
- },
- "customer_description": {
- "type": "string"
- },
- "effective_date": {
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "effective_date_type": {
- "enum": [
- "signature",
- "date"
- ],
- "type": "string"
- },
- "general_cap_amount": {
- "type": "number"
- },
- "general_cap_amount_type": {
- "enum": [
- "preceding",
- "base",
- "period"
- ],
- "type": "string"
- },
- "general_cap_period_currency": {
- "type": "number"
- },
- "general_cap_period_qty": {
- "type": "number"
- },
- "general_cap_preceding_amount": {
- "type": "number"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_additional_changes": {
- "type": "boolean"
- },
- "include_additional_warranties": {
- "type": "boolean"
- },
- "include_additional_warranties_by_customer": {
- "type": "string"
- },
- "include_additional_warranties_by_provider": {
- "type": "string"
- },
- "include_additional_warranties_include_by_customer": {
- "type": "boolean"
- },
- "include_additional_warranties_include_by_provider": {
- "type": "boolean"
- },
- "include_covered_claims": {
- "type": "boolean"
- },
- "include_covered_claims_customer_claims": {
- "type": "string"
- },
- "include_covered_claims_include_customer_claims": {
- "type": "boolean"
- },
- "include_covered_claims_include_provider_claims": {
- "type": "boolean"
- },
- "include_covered_claims_provider_claims": {
- "type": "string"
- },
- "include_customer_insurance_min": {
- "type": "boolean"
- },
- "include_customer_insurance_min_add_provider_com_gen_liability": {
- "type": "boolean"
- },
- "include_customer_insurance_min_add_provider_cyber_liability": {
- "type": "boolean"
- },
- "include_customer_insurance_min_add_provider_errors_omissions": {
- "type": "boolean"
- },
- "include_customer_insurance_min_auto_liability_aggregate": {
- "type": "number"
- },
- "include_customer_insurance_min_auto_liability_minimum": {
- "type": "number"
- },
- "include_customer_insurance_min_cyber_liability_aggregate": {
- "type": "number"
- },
- "include_customer_insurance_min_cyber_liability_minimum": {
- "type": "number"
- },
- "include_customer_insurance_min_employer_liability_aggregate": {
- "type": "number"
- },
- "include_customer_insurance_min_employer_liability_minimum": {
- "type": "number"
- },
- "include_customer_insurance_min_general_liability_aggregate": {
- "type": "number"
- },
- "include_customer_insurance_min_general_liability_minimum": {
- "type": "number"
- },
- "include_customer_insurance_min_include_add_provider": {
- "type": "boolean"
- },
- "include_customer_insurance_min_include_auto_liability": {
- "type": "boolean"
- },
- "include_customer_insurance_min_include_cyber_liability": {
- "type": "boolean"
- },
- "include_customer_insurance_min_include_employer_liability": {
- "type": "boolean"
- },
- "include_customer_insurance_min_include_general_liability": {
- "type": "boolean"
- },
- "include_customer_insurance_min_include_workers_comp": {
- "type": "boolean"
- },
- "include_customer_policies": {
- "type": "boolean"
- },
- "include_customer_policies_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_customer_policies_location": {
- "type": "string"
- },
- "include_customer_policies_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_dpa": {
- "type": "boolean"
- },
- "include_dpa_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_dpa_location": {
- "type": "string"
- },
- "include_dpa_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_increased_cap_amount": {
- "type": "boolean"
- },
- "include_increased_claims": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_confidentiality": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_confidentiality_negligence": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_privsec": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_privsec_negligence": {
- "type": "boolean"
- },
- "include_increased_claims_include_other": {
- "type": "boolean"
- },
- "include_increased_claims_indemnification_obligation": {
- "type": "boolean"
- },
- "include_increased_claims_negligence": {
- "type": "boolean"
- },
- "include_increased_claims_other": {
- "type": "string"
- },
- "include_provider_insurance_min": {
- "type": "boolean"
- },
- "include_provider_insurance_min_add_customer_com_gen_liability": {
- "type": "boolean"
- },
- "include_provider_insurance_min_add_customer_cyber_liability": {
- "type": "boolean"
- },
- "include_provider_insurance_min_add_customer_errors_omissions": {
- "type": "boolean"
- },
- "include_provider_insurance_min_auto_liability_aggregate": {
- "type": "number"
- },
- "include_provider_insurance_min_auto_liability_minimum": {
- "type": "number"
- },
- "include_provider_insurance_min_cyber_liability_aggregate": {
- "type": "number"
- },
- "include_provider_insurance_min_cyber_liability_minimum": {
- "type": "number"
- },
- "include_provider_insurance_min_employer_liability_aggregate": {
- "type": "number"
- },
- "include_provider_insurance_min_employer_liability_minimum": {
- "type": "number"
- },
- "include_provider_insurance_min_general_liability_aggregate": {
- "type": "number"
- },
- "include_provider_insurance_min_general_liability_minimum": {
- "type": "number"
- },
- "include_provider_insurance_min_include_add_customer": {
- "type": "boolean"
- },
- "include_provider_insurance_min_include_auto_liability": {
- "type": "boolean"
- },
- "include_provider_insurance_min_include_cyber_liability": {
- "type": "boolean"
- },
- "include_provider_insurance_min_include_employer_liability": {
- "type": "boolean"
- },
- "include_provider_insurance_min_include_general_liability": {
- "type": "boolean"
- },
- "include_provider_insurance_min_include_workers_comp": {
- "type": "boolean"
- },
- "include_publicity_rights": {
- "type": "boolean"
- },
- "include_publicity_rights_type": {
- "enum": [
- "public",
- "non-public"
- ],
- "type": "string"
- },
- "include_security_policy": {
- "type": "boolean"
- },
- "include_security_policy_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_security_policy_fedramp_auth": {
- "type": "boolean"
- },
- "include_security_policy_hitrust": {
- "type": "boolean"
- },
- "include_security_policy_include_annual_maintenance": {
- "type": "boolean"
- },
- "include_security_policy_include_other": {
- "type": "boolean"
- },
- "include_security_policy_include_other_val": {
- "type": "string"
- },
- "include_security_policy_iso27001": {
- "type": "boolean"
- },
- "include_security_policy_location": {
- "type": "string"
- },
- "include_security_policy_pci1": {
- "type": "boolean"
- },
- "include_security_policy_pci2": {
- "type": "boolean"
- },
- "include_security_policy_penetration_testing": {
- "type": "boolean"
- },
- "include_security_policy_soc2_type1": {
- "type": "boolean"
- },
- "include_security_policy_soc2_type2": {
- "type": "boolean"
- },
- "include_security_policy_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_unlimited_claims": {
- "type": "boolean"
- },
- "include_unlimited_claims_breach_of_confidentiality": {
- "type": "boolean"
- },
- "include_unlimited_claims_breach_of_confidentiality_negligence": {
- "type": "boolean"
- },
- "include_unlimited_claims_breach_of_privsec": {
- "type": "boolean"
- },
- "include_unlimited_claims_breach_of_privsec_negligence": {
- "type": "boolean"
- },
- "include_unlimited_claims_include_other": {
- "type": "boolean"
- },
- "include_unlimited_claims_indemnification_obligation": {
- "type": "boolean"
- },
- "include_unlimited_claims_negligence": {
- "type": "boolean"
- },
- "include_unlimited_claims_other": {
- "type": "string"
- },
- "increased_cap_amount_currency": {
- "type": "number"
- },
- "increased_cap_amount_period_currency": {
- "type": "number"
- },
- "increased_cap_amount_period_qty": {
- "type": "number"
- },
- "increased_cap_amount_qty": {
- "type": "number"
- },
- "increased_cap_amount_type": {
- "enum": [
- "qty",
- "currency",
- "period"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- "psa_statement_of_work_attributes": {
- "additionalProperties": false,
- "description": "Override psa statement of work terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "additional_changes": {
- "type": "string"
- },
- "cost": {
- "type": "number"
- },
- "description": {
- "type": "string"
- },
- "fee_type": {
- "type": "string"
- },
- "fees_attributes": {
- "additionalProperties": {
- "anyOf": [
- {
- "additionalProperties": false,
- "description": "Fees::Flat (fee_type \"flat\"). A fixed recurring fee, e.g. a platform subscription. Set type to \"Fees::Flat\" or fee_type to \"flat\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "Fixed amount in the order form's fees_currency, charged per fee_period. A plain amount, not cents: 20 means 20.00.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"flat\". Alternative to type.",
- "enum": [
- "flat"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Flat\". Optional when fee_type is set.",
- "enum": [
- "Fees::Flat"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Discount (fee_type \"discount\"). A discount, as a fixed amount or a percentage, applied forever, once, or for a number of months. Set type to \"Fees::Discount\" or fee_type to \"discount\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "Discount size: an amount in fees_currency when discount_type is fixed_amount (a plain amount, not cents: 20 means 20.00), or a percentage (e.g. 10 for 10%) when it is percentage.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "discount_duration_amount": {
- "description": "Number of months the discount applies. Required when discount_duration_type is multiple_months.",
- "type": "number"
- },
- "discount_duration_type": {
- "description": "How long the discount applies. multiple_months also needs discount_duration_amount.",
- "enum": [
- "forever",
- "once",
- "multiple_months"
- ],
- "type": "string"
- },
- "discount_type": {
- "description": "Whether cost is a currency amount or a percentage.",
- "enum": [
- "fixed_amount",
- "percentage"
- ],
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"discount\". Alternative to type.",
- "enum": [
- "discount"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Discount\". Optional when fee_type is set.",
- "enum": [
- "Fees::Discount"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Cost (fee_type \"cost\"). A per-unit fee: price per unit times quantity, e.g. seats. Set type to \"Fees::Cost\" or fee_type to \"cost\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "Price per unit in fees_currency. The row total is quantity x cost. A plain amount, not cents: 20 means 20.00.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"cost\". Alternative to type.",
- "enum": [
- "cost"
- ],
- "type": "string"
- },
- "quantity": {
- "description": "Number of units.",
- "type": "number"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Cost\". Optional when fee_type is set.",
- "enum": [
- "Fees::Cost"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Attachment (fee_type \"attachment\"). A fee described in an uploaded attachment instead of in the table. Set type to \"Fees::Attachment\" or fee_type to \"attachment\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "attachment_id": {
- "description": "ID of an attachment uploaded with upload-attachment.",
- "type": "string"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"attachment\". Alternative to type.",
- "enum": [
- "attachment"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Attachment\". Optional when fee_type is set.",
- "enum": [
- "Fees::Attachment"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Graduated (fee_type \"graduated\"). Tiered pricing, with the price set per tier in graduated_fee_tiers_attributes. Set type to \"Fees::Graduated\" or fee_type to \"graduated\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"graduated\". Alternative to type.",
- "enum": [
- "graduated"
- ],
- "type": "string"
- },
- "graduated_fee_tiers_attributes": {
- "additionalProperties": {
- "additionalProperties": false,
- "properties": {
- "flat_price": {
- "type": "number"
- },
- "price_per_unit": {
- "type": "string"
- },
- "upper_limit": {
- "type": "number"
- }
- },
- "type": "object"
- },
- "description": "Graduated fee tiers. Use string keys such as \"0\", \"1\".",
- "propertyNames": {
- "type": "string"
- },
- "type": "object"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Graduated\". Optional when fee_type is set.",
- "enum": [
- "Fees::Graduated"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Included (fee_type \"included\"). An item included at no charge. Set type to \"Fees::Included\" or fee_type to \"included\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"included\". Alternative to type.",
- "enum": [
- "included"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Included\". Optional when fee_type is set.",
- "enum": [
- "Fees::Included"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Metered (fee_type \"metered\"). Usage-based pricing, billed per unit used. Set type to \"Fees::Metered\" or fee_type to \"metered\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "Price per unit of usage in fees_currency. A plain amount, not cents: 20 means 20.00.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"metered\". Alternative to type.",
- "enum": [
- "metered"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Metered\". Optional when fee_type is set.",
- "enum": [
- "Fees::Metered"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::OneTime (fee_type \"one_time\"). A one-time charge, such as a setup fee. Set type to \"Fees::OneTime\" or fee_type to \"one_time\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "One-time amount in fees_currency, charged once rather than per fee_period. A plain amount, not cents: 20 means 20.00.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"one_time\". Alternative to type.",
- "enum": [
- "one_time"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::OneTime\". Optional when fee_type is set.",
- "enum": [
- "Fees::OneTime"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Text (fee_type \"text\"). A fee term described in free text. Set type to \"Fees::Text\" or fee_type to \"text\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"text\". Alternative to type.",
- "enum": [
- "text"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Text\". Optional when fee_type is set.",
- "enum": [
- "Fees::Text"
- ],
- "type": "string"
- }
- },
- "type": "object"
- }
- ]
- },
- "description": "Fee line items. Use string keys such as \"0\", \"1\". Replaces template fees when provided.",
- "propertyNames": {
- "type": "string"
- },
- "type": "object"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_additional_changes": {
- "type": "boolean"
- },
- "include_customer_obligation": {
- "type": "boolean"
- },
- "include_customer_obligation_val": {
- "type": "string"
- },
- "include_deliverables": {
- "type": "boolean"
- },
- "include_deliverables_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_deliverables_description": {
- "type": "string"
- },
- "include_deliverables_include_acceptance": {
- "type": "boolean"
- },
- "include_deliverables_include_attachment": {
- "type": "boolean"
- },
- "include_deliverables_include_draft_deliverables": {
- "type": "boolean"
- },
- "include_deliverables_rejection_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_deliverables_rejection_unit": {
- "enum": [
- "hours",
- "days",
- "weeks",
- "months"
- ],
- "type": "string"
- },
- "include_deliverables_resubmission_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_deliverables_resubmission_unit": {
- "enum": [
- "hours",
- "days",
- "weeks",
- "months"
- ],
- "type": "string"
- },
- "include_fees_other": {
- "type": "boolean"
- },
- "include_fees_other_val": {
- "type": "string"
- },
- "include_fees_table": {
- "type": "boolean"
- },
- "include_fees_table_total": {
- "type": "boolean"
- },
- "include_fees_travel": {
- "type": "boolean"
- },
- "include_fees_travel_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_fees_travel_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_fees_travel_val": {
- "type": "string"
- },
- "include_third_party_customer": {
- "type": "boolean"
- },
- "include_third_party_include_description": {
- "type": "boolean"
- },
- "include_third_party_include_description_val": {
- "type": "string"
- },
- "include_third_party_materials": {
- "type": "boolean"
- },
- "include_third_party_provider": {
- "type": "boolean"
- },
- "include_time_of_assignment": {
- "type": "boolean"
- },
- "include_time_of_assignment_type": {
- "enum": [
- "created",
- "paid"
- ],
- "type": "string"
- },
- "invoice_period_description": {
- "type": "string"
- },
- "negotiations_allowed": {
- "description": "When true, the recipient can propose changes to the statement of work, even when the agreement-level `negotiations_allowed` is false. This only covers the statement of work.",
- "type": "boolean"
- },
- "payment_period": {
- "type": "number"
- },
- "payment_period_other": {
- "type": "string"
- },
- "payment_period_timeframe": {
- "enum": [
- "receipt",
- "invoice",
- "Customer's receipt of invoice",
- "date of invoice"
- ],
- "type": "string"
- },
- "payment_period_type": {
- "enum": [
- "standard",
- "other"
- ],
- "type": "string"
- },
- "payment_period_unit": {
- "enum": [
- "day(s)",
- "week(s)",
- "month(s)",
- "quarter(s)",
- "year(s)"
- ],
- "type": "string"
- },
- "quantity": {
- "type": "number"
- },
- "services_description": {
- "type": "string"
- },
- "sow_date": {
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "sow_date_type": {
- "enum": [
- "signature",
- "date"
- ],
- "type": "string"
- },
- "sow_term_amount": {
- "type": "number"
- },
- "sow_term_date": {
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "sow_term_type": {
- "enum": [
- "deliverables",
- "period",
- "date"
- ],
- "type": "string"
- },
- "sow_term_unit": {
- "enum": [
- "month(s)",
- "quarter(s)",
- "year(s)"
- ],
- "type": "string"
- },
- "type": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "recipient_email": {
- "format": "email",
- "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
- "type": "string"
- },
- "recipient_name": {
- "type": "string"
- },
- "recipient_notice_email_address": {
- "description": "Email address for legal notices to the recipient.",
- "format": "email",
- "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
- "type": "string"
- },
- "recipient_organization": {
- "type": "string"
- },
- "recipient_role": {
- "description": "PSA only. The recipient's role: `Customer` (the default) or `Provider`. Send it with `sender_role`; the two must be one `Provider` and one `Customer`. Other standard agreement types ignore it.",
- "type": "string"
- },
- "sender_last_to_sign": {
- "description": "When true, your signer signs after the recipient.",
- "type": "boolean"
- },
- "sender_notice_email_address": {
- "description": "Email address for legal notices to the sender.",
- "format": "email",
- "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
- "type": "string"
- },
- "sender_role": {
- "description": "PSA only. Your company's role: `Provider` (the default) or `Customer` when you hire the recipient to provide the services. Send it with `recipient_role`; the two must be one `Provider` and one `Customer`. When reading a PSA, an empty `sender_role` means `Provider`. Other standard agreement types ignore it.",
- "type": "string"
- },
- "software_license_attributes": {
- "additionalProperties": false,
- "description": "Override software license terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "effective_date": {
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "effective_date_type": {
- "enum": [
- "signature",
- "date"
- ],
- "type": "string"
- },
- "general_cap_amount": {
- "type": "number"
- },
- "general_cap_amount_type": {
- "enum": [
- "preceding",
- "base",
- "period"
- ],
- "type": "string"
- },
- "general_cap_period_currency": {
- "type": "number"
- },
- "general_cap_period_qty": {
- "type": "number"
- },
- "general_cap_preceding_amount": {
- "type": "number"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_additional_warranties": {
- "type": "boolean"
- },
- "include_additional_warranties_by_customer": {
- "type": "string"
- },
- "include_additional_warranties_by_provider": {
- "type": "string"
- },
- "include_additional_warranties_include_by_customer": {
- "type": "boolean"
- },
- "include_additional_warranties_include_by_provider": {
- "type": "boolean"
- },
- "include_ai_addendum": {
- "type": "boolean"
- },
- "include_ai_addendum_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_covered_claims": {
- "type": "boolean"
- },
- "include_covered_claims_customer_claims": {
- "type": "string"
- },
- "include_covered_claims_include_customer_claims": {
- "type": "boolean"
- },
- "include_covered_claims_include_provider_claims": {
- "type": "boolean"
- },
- "include_covered_claims_provider_claims": {
- "type": "string"
- },
- "include_dpa": {
- "type": "boolean"
- },
- "include_dpa_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_dpa_location": {
- "type": "string"
- },
- "include_dpa_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_increased_cap_amount": {
- "type": "boolean"
- },
- "include_increased_claims": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_confidentiality": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_confidentiality_negligence": {
- "type": "boolean"
- },
- "include_increased_claims_include_other": {
- "type": "boolean"
- },
- "include_increased_claims_indemnification_obligation": {
- "type": "boolean"
- },
- "include_increased_claims_negligence": {
- "type": "boolean"
- },
- "include_increased_claims_other": {
- "type": "string"
- },
- "include_increased_claims_restrictions": {
- "type": "boolean"
- },
- "include_unlimited_claims": {
- "type": "boolean"
- },
- "include_unlimited_claims_breach_of_confidentiality": {
- "type": "boolean"
- },
- "include_unlimited_claims_breach_of_confidentiality_negligence": {
- "type": "boolean"
- },
- "include_unlimited_claims_include_other": {
- "type": "boolean"
- },
- "include_unlimited_claims_indemnification_obligation": {
- "type": "boolean"
- },
- "include_unlimited_claims_license_or_restrictions": {
- "type": "boolean"
- },
- "include_unlimited_claims_negligence": {
- "type": "boolean"
- },
- "include_unlimited_claims_other": {
- "type": "string"
- },
- "increased_cap_amount_currency": {
- "type": "number"
- },
- "increased_cap_amount_period_currency": {
- "type": "number"
- },
- "increased_cap_amount_period_qty": {
- "type": "number"
- },
- "increased_cap_amount_qty": {
- "type": "number"
- },
- "increased_cap_amount_type": {
- "enum": [
- "qty",
- "currency",
- "period"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- "software_license_order_form_attributes": {
- "additionalProperties": false,
- "description": "Override software license order form terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "additional_changes": {
- "type": "string"
- },
- "deletion_procedure_include_custom": {
- "type": "boolean"
- },
- "deletion_procedure_include_custom_description": {
- "type": "string"
- },
- "deletion_procedure_include_customer_disable": {
- "type": "boolean"
- },
- "deletion_procedure_include_customer_proof": {
- "type": "boolean"
- },
- "deletion_procedure_include_provider_disable": {
- "type": "boolean"
- },
- "fee_custom_unit": {
- "type": "string"
- },
- "fee_period": {
- "enum": [
- "Subscription Period",
- "month",
- "year",
- "Custom unit"
- ],
- "type": "string"
- },
- "fees_attributes": {
- "additionalProperties": {
- "anyOf": [
- {
- "additionalProperties": false,
- "description": "Fees::Flat (fee_type \"flat\"). A fixed recurring fee, e.g. a platform subscription. Set type to \"Fees::Flat\" or fee_type to \"flat\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "Fixed amount in the order form's fees_currency, charged per fee_period. A plain amount, not cents: 20 means 20.00.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"flat\". Alternative to type.",
- "enum": [
- "flat"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Flat\". Optional when fee_type is set.",
- "enum": [
- "Fees::Flat"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Discount (fee_type \"discount\"). A discount, as a fixed amount or a percentage, applied forever, once, or for a number of months. Set type to \"Fees::Discount\" or fee_type to \"discount\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "Discount size: an amount in fees_currency when discount_type is fixed_amount (a plain amount, not cents: 20 means 20.00), or a percentage (e.g. 10 for 10%) when it is percentage.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "discount_duration_amount": {
- "description": "Number of months the discount applies. Required when discount_duration_type is multiple_months.",
- "type": "number"
- },
- "discount_duration_type": {
- "description": "How long the discount applies. multiple_months also needs discount_duration_amount.",
- "enum": [
- "forever",
- "once",
- "multiple_months"
- ],
- "type": "string"
- },
- "discount_type": {
- "description": "Whether cost is a currency amount or a percentage.",
- "enum": [
- "fixed_amount",
- "percentage"
- ],
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"discount\". Alternative to type.",
- "enum": [
- "discount"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Discount\". Optional when fee_type is set.",
- "enum": [
- "Fees::Discount"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Cost (fee_type \"cost\"). A per-unit fee: price per unit times quantity, e.g. seats. Set type to \"Fees::Cost\" or fee_type to \"cost\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "Price per unit in fees_currency. The row total is quantity x cost. A plain amount, not cents: 20 means 20.00.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"cost\". Alternative to type.",
- "enum": [
- "cost"
- ],
- "type": "string"
- },
- "quantity": {
- "description": "Number of units.",
- "type": "number"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Cost\". Optional when fee_type is set.",
- "enum": [
- "Fees::Cost"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Attachment (fee_type \"attachment\"). A fee described in an uploaded attachment instead of in the table. Set type to \"Fees::Attachment\" or fee_type to \"attachment\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "attachment_id": {
- "description": "ID of an attachment uploaded with upload-attachment.",
- "type": "string"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"attachment\". Alternative to type.",
- "enum": [
- "attachment"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Attachment\". Optional when fee_type is set.",
- "enum": [
- "Fees::Attachment"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Graduated (fee_type \"graduated\"). Tiered pricing, with the price set per tier in graduated_fee_tiers_attributes. Set type to \"Fees::Graduated\" or fee_type to \"graduated\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"graduated\". Alternative to type.",
- "enum": [
- "graduated"
- ],
- "type": "string"
- },
- "graduated_fee_tiers_attributes": {
- "additionalProperties": {
- "additionalProperties": false,
- "properties": {
- "flat_price": {
- "type": "number"
- },
- "price_per_unit": {
- "type": "string"
- },
- "upper_limit": {
- "type": "number"
- }
- },
- "type": "object"
- },
- "description": "Graduated fee tiers. Use string keys such as \"0\", \"1\".",
- "propertyNames": {
- "type": "string"
- },
- "type": "object"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Graduated\". Optional when fee_type is set.",
- "enum": [
- "Fees::Graduated"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Included (fee_type \"included\"). An item included at no charge. Set type to \"Fees::Included\" or fee_type to \"included\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"included\". Alternative to type.",
- "enum": [
- "included"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Included\". Optional when fee_type is set.",
- "enum": [
- "Fees::Included"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Metered (fee_type \"metered\"). Usage-based pricing, billed per unit used. Set type to \"Fees::Metered\" or fee_type to \"metered\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "Price per unit of usage in fees_currency. A plain amount, not cents: 20 means 20.00.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"metered\". Alternative to type.",
- "enum": [
- "metered"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Metered\". Optional when fee_type is set.",
- "enum": [
- "Fees::Metered"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::OneTime (fee_type \"one_time\"). A one-time charge, such as a setup fee. Set type to \"Fees::OneTime\" or fee_type to \"one_time\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "One-time amount in fees_currency, charged once rather than per fee_period. A plain amount, not cents: 20 means 20.00.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"one_time\". Alternative to type.",
- "enum": [
- "one_time"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::OneTime\". Optional when fee_type is set.",
- "enum": [
- "Fees::OneTime"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Text (fee_type \"text\"). A fee term described in free text. Set type to \"Fees::Text\" or fee_type to \"text\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"text\". Alternative to type.",
- "enum": [
- "text"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Text\". Optional when fee_type is set.",
- "enum": [
- "Fees::Text"
- ],
- "type": "string"
- }
- },
- "type": "object"
- }
- ]
- },
- "description": "Fee line items. Use string keys such as \"0\", \"1\". Replaces template fees when provided.",
- "propertyNames": {
- "type": "string"
- },
- "type": "object"
- },
- "fees_currency": {
- "enum": [
- "USD",
- "EUR",
- "GBP",
- "CAD",
- "AUD",
- "SGD",
- "ILS",
- "JPY",
- "CHF",
- "HKD"
- ],
- "type": "string"
- },
- "fees_include_fee_increase_upon_renewal": {
- "type": "boolean"
- },
- "fees_include_fee_increase_upon_renewal_fee": {
- "type": "number"
- },
- "fees_include_fee_increase_upon_renewal_type": {
- "enum": [
- "will",
- "may"
- ],
- "type": "string"
- },
- "fees_inclusive_of_taxes": {
- "type": "boolean"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_additional_changes": {
- "type": "boolean"
- },
- "include_license_compliance_verification": {
- "type": "boolean"
- },
- "include_license_compliance_verification_description": {
- "type": "string"
- },
- "include_license_limits": {
- "type": "boolean"
- },
- "include_license_limits_description": {
- "type": "string"
- },
- "include_payment_process_include_billing_email": {
- "type": "boolean"
- },
- "include_pilot_period": {
- "type": "boolean"
- },
- "include_pilot_period_duration_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_pilot_period_duration_type": {
- "enum": [
- "day",
- "week",
- "month"
- ],
- "type": "string"
- },
- "include_pilot_period_include_fees": {
- "type": "boolean"
- },
- "include_pilot_period_include_fees_amount": {
- "type": "number"
- },
- "include_pilot_period_include_modifications": {
- "type": "boolean"
- },
- "include_pilot_period_include_modifications_description": {
- "type": "string"
- },
- "include_services": {
- "type": "boolean"
- },
- "include_services_description": {
- "type": "string"
- },
- "negotiations_allowed": {
- "description": "When true, the recipient can propose changes to the order form, even when the agreement-level `negotiations_allowed` is false. This only covers the order form.",
- "type": "boolean"
- },
- "order_date_date": {
- "type": "string"
- },
- "order_date_type": {
- "enum": [
- "signature",
- "date",
- "other"
- ],
- "type": "string"
- },
- "payment_process_automatic_frequency": {
- "enum": [
- "monthly",
- "quarterly",
- "semiannually",
- "annually"
- ],
- "type": "string"
- },
- "payment_process_type": {
- "enum": [
- "automatic",
- "invoice",
- "custom"
- ],
- "type": "string"
- },
- "payment_process_type_custom_val": {
- "type": "string"
- },
- "payment_process_type_invoice_amount": {
- "type": "number"
- },
- "payment_process_type_invoice_custom_unit": {
- "type": "string"
- },
- "payment_process_type_invoice_duration": {
- "enum": [
- "day",
- "week",
- "month",
- "year",
- "day(s)",
- "week(s)",
- "month(s)",
- "year(s)"
- ],
- "type": "string"
- },
- "payment_process_type_invoice_duration_start": {
- "enum": [
- "Customer's receipt of invoice",
- "date of invoice"
- ],
- "type": "string"
- },
- "payment_process_type_invoice_type": {
- "enum": [
- "monthly",
- "quarterly",
- "semiannually",
- "annually",
- "Custom unit"
- ],
- "type": "string"
- },
- "permitted_uses_include_custom": {
- "type": "boolean"
- },
- "permitted_uses_include_custom_description": {
- "type": "string"
- },
- "permitted_uses_include_customers_affiliates": {
- "type": "boolean"
- },
- "permitted_uses_include_internal_business": {
- "type": "boolean"
- },
- "pilot_period_stripe_product_id": {
- "type": "string"
- },
- "software_description": {
- "type": "string"
- },
- "subscription_auto_renew": {
- "enum": [
- "days",
- "subscription_end"
- ],
- "type": "string"
- },
- "subscription_period": {
- "type": "number"
- },
- "subscription_period_unit": {
- "type": "string"
- },
- "subscription_renewal_notice_days": {
- "type": "number"
- },
- "warranty_period_description_amount": {
- "type": "number"
- },
- "warranty_period_description_duration": {
- "enum": [
- "day",
- "week",
- "month",
- "year"
- ],
- "type": "string"
- },
- "warranty_period_description_duration_start": {
- "enum": [
- "initial delivery of the Software",
- "delivery of the Software and each subsequent Update",
- "the Order Date"
- ],
- "type": "string"
- },
- "warranty_period_type": {
- "enum": [
- "description",
- "none"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- "test_agreement": {
- "description": "When true, marks the agreement as a test. Test agreements do not count against your monthly limit.",
- "type": "boolean"
- }
- },
- "required": [
- "recipient_name",
- "recipient_email"
- ],
- "type": "object"
- },
- "cc_users": {
- "items": {
- "format": "email",
- "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
- "type": "string"
- },
- "type": "array"
- },
- "draft": {
- "description": "When true, the agreement is saved as a draft and not sent to the recipient. Use POST /v1/agreements/{id}/send to send a draft agreement later.",
- "type": "boolean"
- },
- "owner_id": {
- "description": "User id of the agreement owner (sender).",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "signer_email": {
- "description": "Email address of the signer from the owner's organization.",
- "format": "email",
- "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
- "type": "string"
- },
- "template_id": {
- "description": "UUID of a template from `GET /v1/templates`. Accepts both Common Paper standard templates and uploaded PDF templates (`type` `uploaded_template`).",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- }
- },
- "required": [
- "template_id",
- "owner_id",
- "signer_email",
- "agreement"
- ],
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "agreement": {
- "additionalProperties": {},
- "properties": {
- "amendment_attributes": {
- "additionalProperties": false,
- "description": "Override amendment terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "amended_terms_attributes": {
- "additionalProperties": {
- "additionalProperties": false,
- "properties": {
- "description": {
- "type": "string"
- },
- "term": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "description": "Amended terms. Use string keys such as \"0\", \"1\".",
- "propertyNames": {
- "type": "string"
- },
- "type": "object"
- },
- "amendment_date": {
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "amendment_date_type": {
- "enum": [
- "signature",
- "date"
- ],
- "type": "string"
- },
- "framework_terms_type": {
- "type": "string"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "parent_agreement_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "underlying_agreement_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "underlying_agreement_type": {
- "type": "string"
- },
- "underlying_agreement_val": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "baa_attributes": {
- "additionalProperties": false,
- "description": "Override baa terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "aggregation_limitations_permitted": {
- "type": "boolean"
- },
- "aggregation_limitations_permitted_val": {
- "type": "string"
- },
- "breach_notification_unit": {
- "enum": [
- "hours",
- "business days",
- "calendar days"
- ],
- "type": "string"
- },
- "breach_notification_val": {
- "type": "number"
- },
- "business_associate_relationship_type": {
- "enum": [
- "provider",
- "company"
- ],
- "type": "string"
- },
- "deidentification_limitations_include_purpose": {
- "type": "boolean"
- },
- "deidentification_limitations_include_requirements": {
- "type": "boolean"
- },
- "deidentification_limitations_permitted": {
- "type": "boolean"
- },
- "deidentification_limitations_purpose_val": {
- "type": "string"
- },
- "deidentification_limitations_requirements_val": {
- "type": "string"
- },
- "designated_record_set_provider_maintains": {
- "type": "boolean"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_aggregation_limitations": {
- "type": "boolean"
- },
- "include_deidentification_limitations": {
- "type": "boolean"
- },
- "include_limitations": {
- "type": "boolean"
- },
- "include_offshore_limitations": {
- "type": "boolean"
- },
- "include_subcontract_limitations": {
- "type": "boolean"
- },
- "offshore_limitations_permitted": {
- "type": "boolean"
- },
- "offshore_limitations_permitted_val": {
- "type": "string"
- },
- "subcontract_limitations_include_notice": {
- "type": "boolean"
- },
- "subcontract_limitations_include_permission": {
- "type": "boolean"
- },
- "subcontract_limitations_notice_val": {
- "type": "string"
- },
- "subcontract_limitations_permission_val": {
- "type": "string"
- },
- "subcontract_limitations_permitted": {
- "type": "boolean"
- },
- "underlying_agreement_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "underlying_agreement_type": {
- "enum": [
- "internal",
- "external",
- "none"
- ],
- "type": "string"
- },
- "underlying_agreement_val": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "billing_email": {
- "description": "Email of the billing contact. Used when include_billing_info is true.",
- "format": "email",
- "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
- "type": "string"
- },
- "billing_name": {
- "description": "Name of the billing contact. Used when include_billing_info is true.",
- "type": "string"
- },
- "billing_workflow_type": {
- "description": "The type of billing workflow. Use \"link\" to provide a payment_link_url, or \"stripe\" for Stripe-managed billing.",
- "enum": [
- "link",
- "stripe"
- ],
- "type": "string"
- },
- "chosen_courts_country": {
- "description": "The country in which disputes will be resolved.",
- "type": "string"
- },
- "chosen_courts_region": {
- "description": "The state or region in which disputes will be resolved.",
- "type": "string"
- },
- "csa_attributes": {
- "additionalProperties": false,
- "description": "Override csa terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "customer_description": {
- "type": "string"
- },
- "effective_date": {
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "effective_date_marketplace": {
- "enum": [
- "AWS",
- "GCP",
- "Azure"
- ],
- "type": "string"
- },
- "effective_date_type": {
- "enum": [
- "signature",
- "date",
- "marketplace_acceptance"
- ],
- "type": "string"
- },
- "general_cap_amount": {
- "type": "number"
- },
- "general_cap_amount_type": {
- "enum": [
- "preceding",
- "base",
- "period"
- ],
- "type": "string"
- },
- "general_cap_period_currency": {
- "type": "number"
- },
- "general_cap_period_qty": {
- "type": "number"
- },
- "general_cap_preceding_amount": {
- "type": "number"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_acceptable_use_policy": {
- "type": "boolean"
- },
- "include_acceptable_use_policy_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_acceptable_use_policy_location": {
- "type": "string"
- },
- "include_acceptable_use_policy_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_additional_warranties": {
- "type": "boolean"
- },
- "include_additional_warranties_by_customer": {
- "type": "string"
- },
- "include_additional_warranties_by_provider": {
- "type": "string"
- },
- "include_additional_warranties_include_by_customer": {
- "type": "boolean"
- },
- "include_additional_warranties_include_by_provider": {
- "type": "boolean"
- },
- "include_ai_addendum": {
- "type": "boolean"
- },
- "include_ai_addendum_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_covered_claims": {
- "type": "boolean"
- },
- "include_covered_claims_customer_claims": {
- "type": "string"
- },
- "include_covered_claims_include_customer_claims": {
- "type": "boolean"
- },
- "include_covered_claims_include_provider_claims": {
- "type": "boolean"
- },
- "include_covered_claims_provider_claims": {
- "type": "string"
- },
- "include_dpa": {
- "type": "boolean"
- },
- "include_dpa_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_dpa_location": {
- "type": "string"
- },
- "include_dpa_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_increased_cap_amount": {
- "type": "boolean"
- },
- "include_increased_claims": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_confidentiality": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_confidentiality_negligence": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_privsec": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_privsec_negligence": {
- "type": "boolean"
- },
- "include_increased_claims_include_other": {
- "type": "boolean"
- },
- "include_increased_claims_indemnification_obligation": {
- "type": "boolean"
- },
- "include_increased_claims_other": {
- "type": "string"
- },
- "include_insurance_minimums": {
- "type": "boolean"
- },
- "include_insurance_minimums_add_customer": {
- "type": "boolean"
- },
- "include_insurance_minimums_add_customer_com_gen_liability": {
- "type": "boolean"
- },
- "include_insurance_minimums_add_customer_cyber_liability": {
- "type": "boolean"
- },
- "include_insurance_minimums_add_customer_errors_omissions": {
- "type": "boolean"
- },
- "include_insurance_minimums_additional_information": {
- "type": "boolean"
- },
- "include_insurance_minimums_additional_information_text": {
- "type": "string"
- },
- "include_insurance_minimums_cyber_liability_aggregate": {
- "type": "number"
- },
- "include_insurance_minimums_cyber_liability_minimum": {
- "type": "number"
- },
- "include_insurance_minimums_employer_liability_aggregate": {
- "type": "number"
- },
- "include_insurance_minimums_employer_liability_minimum": {
- "type": "number"
- },
- "include_insurance_minimums_general_liability_aggregate": {
- "type": "number"
- },
- "include_insurance_minimums_general_liability_minimum": {
- "type": "number"
- },
- "include_insurance_minimums_include_cyber_liability": {
- "type": "boolean"
- },
- "include_insurance_minimums_include_employer_liability": {
- "type": "boolean"
- },
- "include_insurance_minimums_include_general_liability": {
- "type": "boolean"
- },
- "include_insurance_minimums_include_workers_compensation": {
- "type": "boolean"
- },
- "include_publicity_rights": {
- "type": "boolean"
- },
- "include_publicity_rights_type": {
- "enum": [
- "public",
- "non-public"
- ],
- "type": "string"
- },
- "include_security_policy": {
- "type": "boolean"
- },
- "include_security_policy_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_security_policy_fedramp_auth": {
- "type": "boolean"
- },
- "include_security_policy_hipaa": {
- "type": "boolean"
- },
- "include_security_policy_hitrust": {
- "type": "boolean"
- },
- "include_security_policy_include_annual_maintenance": {
- "type": "boolean"
- },
- "include_security_policy_include_location": {
- "type": "boolean"
- },
- "include_security_policy_include_other": {
- "type": "boolean"
- },
- "include_security_policy_include_reasonable_efforts": {
- "type": "boolean"
- },
- "include_security_policy_iso27001": {
- "type": "boolean"
- },
- "include_security_policy_location": {
- "type": "string"
- },
- "include_security_policy_other": {
- "type": "string"
- },
- "include_security_policy_pci1": {
- "type": "boolean"
- },
- "include_security_policy_pci2": {
- "type": "boolean"
- },
- "include_security_policy_penetration_testing": {
- "type": "boolean"
- },
- "include_security_policy_soc2": {
- "type": "boolean"
- },
- "include_security_policy_soc2_type2": {
- "type": "boolean"
- },
- "include_security_policy_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_supercap": {
- "description": "CSA 3.0 renamed `include_increased_cap_amount` to `include_supercap`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_increased_cap_amount`. Sending the other spelling returns a 422.",
- "type": "boolean"
- },
- "include_uncapped_claims": {
- "description": "CSA 3.0 renamed `include_unlimited_claims` to `include_uncapped_claims`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims`. Sending the other spelling returns a 422.",
- "type": "boolean"
- },
- "include_uncapped_claims_breach_of_confidentiality": {
- "description": "CSA 3.0 renamed `include_unlimited_claims_breach_of_confidentiality` to `include_uncapped_claims_breach_of_confidentiality`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_breach_of_confidentiality`. Sending the other spelling returns a 422.",
- "type": "boolean"
- },
- "include_uncapped_claims_breach_of_confidentiality_negligence": {
- "description": "CSA 3.0 renamed `include_unlimited_claims_breach_of_confidentiality_negligence` to `include_uncapped_claims_breach_of_confidentiality_negligence`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_breach_of_confidentiality_negligence`. Sending the other spelling returns a 422.",
- "type": "boolean"
- },
- "include_uncapped_claims_breach_of_privsec": {
- "description": "CSA 3.0 renamed `include_unlimited_claims_breach_of_privsec` to `include_uncapped_claims_breach_of_privsec`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_breach_of_privsec`. Sending the other spelling returns a 422.",
- "type": "boolean"
- },
- "include_uncapped_claims_breach_of_privsec_negligence": {
- "description": "CSA 3.0 renamed `include_unlimited_claims_breach_of_privsec_negligence` to `include_uncapped_claims_breach_of_privsec_negligence`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_breach_of_privsec_negligence`. Sending the other spelling returns a 422.",
- "type": "boolean"
- },
- "include_uncapped_claims_include_other": {
- "description": "CSA 3.0 renamed `include_unlimited_claims_include_other` to `include_uncapped_claims_include_other`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_include_other`. Sending the other spelling returns a 422.",
- "type": "boolean"
- },
- "include_uncapped_claims_indemnification_obligation": {
- "description": "CSA 3.0 renamed `include_unlimited_claims_indemnification_obligation` to `include_uncapped_claims_indemnification_obligation`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_indemnification_obligation`. Sending the other spelling returns a 422.",
- "type": "boolean"
- },
- "include_uncapped_claims_other": {
- "description": "CSA 3.0 renamed `include_unlimited_claims_other` to `include_uncapped_claims_other`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_other`. Sending the other spelling returns a 422.",
- "type": "boolean"
- },
- "include_unlimited_claims": {
- "type": "boolean"
- },
- "include_unlimited_claims_breach_of_confidentiality": {
- "type": "boolean"
- },
- "include_unlimited_claims_breach_of_confidentiality_negligence": {
- "type": "boolean"
- },
- "include_unlimited_claims_breach_of_privsec": {
- "type": "boolean"
- },
- "include_unlimited_claims_breach_of_privsec_negligence": {
- "type": "boolean"
- },
- "include_unlimited_claims_include_other": {
- "type": "boolean"
- },
- "include_unlimited_claims_indemnification_obligation": {
- "type": "boolean"
- },
- "include_unlimited_claims_other": {
- "type": "string"
- },
- "increased_cap_amount_currency": {
- "type": "number"
- },
- "increased_cap_amount_period_currency": {
- "type": "number"
- },
- "increased_cap_amount_period_qty": {
- "type": "number"
- },
- "increased_cap_amount_qty": {
- "type": "number"
- },
- "increased_cap_amount_type": {
- "enum": [
- "qty",
- "currency",
- "period"
- ],
- "type": "string"
- },
- "provider": {
- "type": "string"
- },
- "supercap_currency": {
- "description": "CSA 3.0 renamed `increased_cap_amount_currency` to `supercap_currency`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `increased_cap_amount_currency`. Sending the other spelling returns a 422.",
- "type": "number"
- },
- "supercap_period_currency": {
- "description": "CSA 3.0 renamed `increased_cap_amount_period_currency` to `supercap_period_currency`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `increased_cap_amount_period_currency`. Sending the other spelling returns a 422.",
- "type": "number"
- },
- "supercap_period_qty": {
- "description": "CSA 3.0 renamed `increased_cap_amount_period_qty` to `supercap_period_qty`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `increased_cap_amount_period_qty`. Sending the other spelling returns a 422.",
- "type": "number"
- },
- "supercap_qty": {
- "description": "CSA 3.0 renamed `increased_cap_amount_qty` to `supercap_qty`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `increased_cap_amount_qty`. Sending the other spelling returns a 422.",
- "type": "number"
- },
- "supercap_type": {
- "description": "CSA 3.0 renamed `increased_cap_amount_type` to `supercap_type`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `increased_cap_amount_type`. Sending the other spelling returns a 422.",
- "type": "number"
- }
- },
- "type": "object"
- },
- "csa_order_form_attributes": {
- "additionalProperties": false,
- "description": "Override csa order form terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "additional_changes": {
- "type": "string"
- },
- "additional_parameters_or_limitations": {
- "type": "string"
- },
- "affiliates_as_users": {
- "type": "boolean"
- },
- "cloud_service_description": {
- "type": "string"
- },
- "consumption_units": {
- "type": "string"
- },
- "fee_amount": {
- "type": "number"
- },
- "fee_custom_unit": {
- "type": "string"
- },
- "fee_period": {
- "enum": [
- "Subscription Period",
- "month",
- "year",
- "User",
- "Custom unit"
- ],
- "type": "string"
- },
- "fees_attributes": {
- "additionalProperties": {
- "anyOf": [
- {
- "additionalProperties": false,
- "description": "Fees::Flat (fee_type \"flat\"). A fixed recurring fee, e.g. a platform subscription. Set type to \"Fees::Flat\" or fee_type to \"flat\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "Fixed amount in the order form's fees_currency, charged per fee_period. A plain amount, not cents: 20 means 20.00.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"flat\". Alternative to type.",
- "enum": [
- "flat"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Flat\". Optional when fee_type is set.",
- "enum": [
- "Fees::Flat"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Discount (fee_type \"discount\"). A discount, as a fixed amount or a percentage, applied forever, once, or for a number of months. Set type to \"Fees::Discount\" or fee_type to \"discount\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "Discount size: an amount in fees_currency when discount_type is fixed_amount (a plain amount, not cents: 20 means 20.00), or a percentage (e.g. 10 for 10%) when it is percentage.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "discount_duration_amount": {
- "description": "Number of months the discount applies. Required when discount_duration_type is multiple_months.",
- "type": "number"
- },
- "discount_duration_type": {
- "description": "How long the discount applies. multiple_months also needs discount_duration_amount.",
- "enum": [
- "forever",
- "once",
- "multiple_months"
- ],
- "type": "string"
- },
- "discount_type": {
- "description": "Whether cost is a currency amount or a percentage.",
- "enum": [
- "fixed_amount",
- "percentage"
- ],
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"discount\". Alternative to type.",
- "enum": [
- "discount"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Discount\". Optional when fee_type is set.",
- "enum": [
- "Fees::Discount"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Cost (fee_type \"cost\"). A per-unit fee: price per unit times quantity, e.g. seats. Set type to \"Fees::Cost\" or fee_type to \"cost\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "Price per unit in fees_currency. The row total is quantity x cost. A plain amount, not cents: 20 means 20.00.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"cost\". Alternative to type.",
- "enum": [
- "cost"
- ],
- "type": "string"
- },
- "quantity": {
- "description": "Number of units.",
- "type": "number"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Cost\". Optional when fee_type is set.",
- "enum": [
- "Fees::Cost"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Attachment (fee_type \"attachment\"). A fee described in an uploaded attachment instead of in the table. Set type to \"Fees::Attachment\" or fee_type to \"attachment\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "attachment_id": {
- "description": "ID of an attachment uploaded with upload-attachment.",
- "type": "string"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"attachment\". Alternative to type.",
- "enum": [
- "attachment"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Attachment\". Optional when fee_type is set.",
- "enum": [
- "Fees::Attachment"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Graduated (fee_type \"graduated\"). Tiered pricing, with the price set per tier in graduated_fee_tiers_attributes. Set type to \"Fees::Graduated\" or fee_type to \"graduated\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"graduated\". Alternative to type.",
- "enum": [
- "graduated"
- ],
- "type": "string"
- },
- "graduated_fee_tiers_attributes": {
- "additionalProperties": {
- "additionalProperties": false,
- "properties": {
- "flat_price": {
- "type": "number"
- },
- "price_per_unit": {
- "type": "string"
- },
- "upper_limit": {
- "type": "number"
- }
- },
- "type": "object"
- },
- "description": "Graduated fee tiers. Use string keys such as \"0\", \"1\".",
- "propertyNames": {
- "type": "string"
- },
- "type": "object"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Graduated\". Optional when fee_type is set.",
- "enum": [
- "Fees::Graduated"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Included (fee_type \"included\"). An item included at no charge. Set type to \"Fees::Included\" or fee_type to \"included\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"included\". Alternative to type.",
- "enum": [
- "included"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Included\". Optional when fee_type is set.",
- "enum": [
- "Fees::Included"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Metered (fee_type \"metered\"). Usage-based pricing, billed per unit used. Set type to \"Fees::Metered\" or fee_type to \"metered\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "Price per unit of usage in fees_currency. A plain amount, not cents: 20 means 20.00.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"metered\". Alternative to type.",
- "enum": [
- "metered"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Metered\". Optional when fee_type is set.",
- "enum": [
- "Fees::Metered"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::OneTime (fee_type \"one_time\"). A one-time charge, such as a setup fee. Set type to \"Fees::OneTime\" or fee_type to \"one_time\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "One-time amount in fees_currency, charged once rather than per fee_period. A plain amount, not cents: 20 means 20.00.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"one_time\". Alternative to type.",
- "enum": [
- "one_time"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::OneTime\". Optional when fee_type is set.",
- "enum": [
- "Fees::OneTime"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Text (fee_type \"text\"). A fee term described in free text. Set type to \"Fees::Text\" or fee_type to \"text\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"text\". Alternative to type.",
- "enum": [
- "text"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Text\". Optional when fee_type is set.",
- "enum": [
- "Fees::Text"
- ],
- "type": "string"
- }
- },
- "type": "object"
- }
- ]
- },
- "description": "Fee table rows, keyed by string index (\"0\", \"1\", ...). Replaces the template's fees when provided. Each row sets type or fee_type to pick the fee class. Amounts are in the order form's fees_currency and, for recurring fees, are charged per fee_period.",
- "examples": [
- {
- "0": {
- "cost": 2000,
- "description": "Platform subscription",
- "type": "Fees::Flat"
- }
- },
- {
- "0": {
- "cost": 50,
- "description": "Seats",
- "fee_type": "cost",
- "quantity": 10
- },
- "1": {
- "cost": 10,
- "description": "Launch discount",
- "discount_duration_amount": 3,
- "discount_duration_type": "multiple_months",
- "discount_type": "percentage",
- "fee_type": "discount"
- }
- }
- ],
- "propertyNames": {
- "type": "string"
- },
- "type": "object"
- },
- "fees_currency": {
- "enum": [
- "USD",
- "EUR",
- "GBP",
- "CAD",
- "AUD",
- "SGD",
- "ILS",
- "JPY",
- "CHF",
- "HKD"
- ],
- "type": "string"
- },
- "fees_include_fee_increase_upon_renewal": {
- "type": "boolean"
- },
- "fees_include_fee_increase_upon_renewal_fee": {
- "type": "number"
- },
- "fees_include_fee_increase_upon_renewal_type": {
- "enum": [
- "will",
- "may"
- ],
- "type": "string"
- },
- "fees_inclusive_of_taxes": {
- "type": "boolean"
- },
- "framework_terms_type": {
- "enum": [
- "new",
- "existing",
- "description"
- ],
- "type": "string"
- },
- "free_trial_days": {
- "type": "number"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_additional_changes": {
- "type": "boolean"
- },
- "include_additional_parameters_or_limitations": {
- "type": "boolean"
- },
- "include_consumption": {
- "type": "boolean"
- },
- "include_fees": {
- "type": "boolean"
- },
- "include_fees_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_fees_include_attachment": {
- "type": "boolean"
- },
- "include_fees_other": {
- "type": "boolean"
- },
- "include_fees_other_val": {
- "type": "string"
- },
- "include_fees_table": {
- "type": "boolean"
- },
- "include_fees_table_period": {
- "enum": [
- "Subscription Period",
- "month",
- "year",
- "User"
- ],
- "type": "string"
- },
- "include_free_trial": {
- "type": "boolean"
- },
- "include_max_users": {
- "type": "boolean"
- },
- "include_pilot_period": {
- "type": "boolean"
- },
- "include_pilot_period_duration_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_pilot_period_duration_type": {
- "enum": [
- "day",
- "week",
- "month"
- ],
- "type": "string"
- },
- "include_pilot_period_include_fees": {
- "type": "boolean"
- },
- "include_pilot_period_include_fees_amount": {
- "type": "number"
- },
- "include_pilot_period_include_modifications": {
- "type": "boolean"
- },
- "include_pilot_period_include_modifications_description": {
- "type": "string"
- },
- "include_product_support": {
- "type": "boolean"
- },
- "include_product_support_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_product_support_description": {
- "type": "string"
- },
- "include_product_support_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_professional_services": {
- "type": "boolean"
- },
- "include_professional_services_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_professional_services_custom_name": {
- "type": "string"
- },
- "include_professional_services_description": {
- "type": "string"
- },
- "include_professional_services_end_date": {
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "include_professional_services_fees_description": {
- "type": "string"
- },
- "include_professional_services_include_end_date": {
- "type": "boolean"
- },
- "include_professional_services_include_fees_description": {
- "type": "boolean"
- },
- "include_professional_services_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_sla": {
- "type": "boolean"
- },
- "include_sla_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_sla_description": {
- "type": "string"
- },
- "include_sla_include_response_time": {
- "type": "boolean"
- },
- "include_sla_include_response_time_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_sla_include_response_time_credit": {
- "type": "number"
- },
- "include_sla_include_response_time_duration": {
- "enum": [
- "hour",
- "day",
- "week",
- "month",
- "hours"
- ],
- "type": "string"
- },
- "include_sla_include_response_time_support_channel": {
- "type": "string"
- },
- "include_sla_include_target_uptime": {
- "type": "boolean"
- },
- "include_sla_maintenance_notice": {
- "type": "boolean"
- },
- "include_sla_maintenance_window": {
- "type": "boolean"
- },
- "include_sla_maintenance_window_type": {
- "enum": [
- "standard",
- "none"
- ],
- "type": "string"
- },
- "include_sla_standard_maintenance_notice_qty": {
- "type": "number"
- },
- "include_sla_standard_maintenance_notice_unit": {
- "enum": [
- "hour",
- "day",
- "week",
- "month"
- ],
- "type": "string"
- },
- "include_sla_standard_maintenance_window_end_time": {
- "type": "string"
- },
- "include_sla_standard_maintenance_window_friday": {
- "type": "boolean"
- },
- "include_sla_standard_maintenance_window_monday": {
- "type": "boolean"
- },
- "include_sla_standard_maintenance_window_saturday": {
- "type": "boolean"
- },
- "include_sla_standard_maintenance_window_start_time": {
- "type": "string"
- },
- "include_sla_standard_maintenance_window_sunday": {
- "type": "boolean"
- },
- "include_sla_standard_maintenance_window_thursday": {
- "type": "boolean"
- },
- "include_sla_standard_maintenance_window_time_zone": {
- "type": "string"
- },
- "include_sla_standard_maintenance_window_tuesday": {
- "type": "boolean"
- },
- "include_sla_standard_maintenance_window_wednesday": {
- "type": "boolean"
- },
- "include_sla_standard_target_uptime": {
- "type": "number"
- },
- "include_sla_type": {
- "enum": [
- "description",
- "standard",
- "attachment"
- ],
- "type": "string"
- },
- "include_subscription_start_date": {
- "type": "boolean"
- },
- "include_subscription_start_date_date": {
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "include_usage_review": {
- "type": "boolean"
- },
- "include_usage_review_val": {
- "type": "string"
- },
- "include_use_limitations": {
- "type": "boolean"
- },
- "include_use_limitations_val": {
- "type": "string"
- },
- "invoice_period": {
- "enum": [
- "monthly",
- "quarterly",
- "semiannually",
- "annually",
- "Custom unit",
- "Monthly",
- "Quarterly",
- "Semiannually",
- "Annually"
- ],
- "type": "string"
- },
- "invoice_period_custom_unit": {
- "type": "string"
- },
- "max_consumption": {
- "type": "number"
- },
- "max_users": {
- "type": "number"
- },
- "negotiations_allowed": {
- "description": "When true, the recipient can propose changes to the order form, even when the agreement-level `negotiations_allowed` is false. This only covers the order form.",
- "type": "boolean"
- },
- "order_date_date": {
- "type": "string"
- },
- "order_date_other": {
- "type": "string"
- },
- "order_date_type": {
- "enum": [
- "signature",
- "date",
- "other"
- ],
- "type": "string"
- },
- "payment_period": {
- "type": "number"
- },
- "payment_period_timeframe": {
- "enum": [
- "Customer's receipt of invoice",
- "date of invoice"
- ],
- "type": "string"
- },
- "payment_period_unit": {
- "enum": [
- "day(s)",
- "week(s)",
- "month(s)",
- "marketplace_acceptance"
- ],
- "type": "string"
- },
- "payment_process_automatic_frequency": {
- "enum": [
- "monthly",
- "quarterly",
- "semiannually",
- "annually"
- ],
- "type": "string"
- },
- "payment_process_type": {
- "enum": [
- "automatic",
- "invoice",
- "custom",
- "marketplace_acceptance"
- ],
- "type": "string"
- },
- "payment_process_type_custom_val": {
- "type": "string"
- },
- "payment_process_type_invoice_amount": {
- "type": "number"
- },
- "payment_process_type_invoice_custom_unit": {
- "type": "string"
- },
- "payment_process_type_invoice_duration": {
- "enum": [
- "day",
- "week",
- "month",
- "year",
- "day(s)",
- "week(s)",
- "month(s)",
- "year(s)"
- ],
- "type": "string"
- },
- "payment_process_type_invoice_duration_start": {
- "enum": [
- "Customer's receipt of invoice",
- "date of invoice"
- ],
- "type": "string"
- },
- "payment_process_type_invoice_type": {
- "enum": [
- "monthly",
- "quarterly",
- "semiannually",
- "annually",
- "Custom unit"
- ],
- "type": "string"
- },
- "pilot_period_stripe_product_id": {
- "type": "string"
- },
- "service_credits_attributes": {
- "additionalProperties": {
- "additionalProperties": false,
- "properties": {
- "credit": {
- "type": "number"
- },
- "max": {
- "type": "number"
- },
- "min": {
- "type": "number"
- }
- },
- "type": "object"
- },
- "description": "Service credits. Use string keys such as \"0\", \"1\".",
- "propertyNames": {
- "type": "string"
- },
- "type": "object"
- },
- "subscription_auto_renew": {
- "enum": [
- "days",
- "subscription_end"
- ],
- "type": "string"
- },
- "subscription_period": {
- "type": "number"
- },
- "subscription_period_unit": {
- "type": "string"
- },
- "subscription_renewal_notice_days": {
- "type": "number"
- },
- "subscription_start_date": {
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "subscription_start_date_type": {
- "enum": [
- "effective_date",
- "date"
- ],
- "type": "string"
- },
- "underlying_agreement_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "use_limitations_attributes": {
- "additionalProperties": {
- "additionalProperties": false,
- "properties": {
- "amount": {
- "type": "number"
- },
- "limitation_type": {
- "type": "string"
- },
- "unit": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "description": "Use limitations. Use string keys such as \"0\", \"1\".",
- "propertyNames": {
- "type": "string"
- },
- "type": "object"
- }
- },
- "type": "object"
- },
- "custom_field_values": {
- "description": "Values for a custom template's fields, keyed by the field keys defined in the template's YAML definition. Only used when template_id is a custom template. Template defaults fill any fields you omit; a required field with no default and no submitted value returns a 400 naming the field. Values are validated against the field's input type: select and radio values must be one of the field's options, multiselect values are an array of selections each of which must be one of the field's options, number and currency values must be numeric, date values must be YYYY-MM-DD, and email values must be valid addresses. An invalid value returns a 400 naming the field."
- },
- "design_partner_attributes": {
- "additionalProperties": false,
- "description": "Override design partner terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "customer_description": {
- "type": "string"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_fees": {
- "type": "boolean"
- },
- "include_fees_amount": {
- "type": "number"
- },
- "include_fees_description": {
- "type": "string"
- },
- "include_fees_pay_by_amount": {
- "type": "string"
- },
- "include_fees_type": {
- "enum": [
- "default_language",
- "description"
- ],
- "type": "string"
- },
- "include_fees_unit": {
- "enum": [
- "month",
- "quarter",
- "year",
- "Term"
- ],
- "type": "string"
- },
- "include_program_appear_as_customer_private": {
- "type": "boolean"
- },
- "include_program_appear_as_customer_public": {
- "type": "boolean"
- },
- "include_program_case_study": {
- "type": "boolean"
- },
- "include_program_develop_functionality": {
- "type": "boolean"
- },
- "include_program_develop_functionality_val": {
- "type": "string"
- },
- "include_program_discount": {
- "type": "boolean"
- },
- "include_program_discount_amount": {
- "type": "number"
- },
- "include_program_discount_unit": {
- "enum": [
- "U.S. Dollars",
- "percent"
- ],
- "type": "string"
- },
- "include_program_participation_feedback": {
- "type": "boolean"
- },
- "include_program_participation_feedback_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_program_participation_feedback_unit": {
- "enum": [
- "month",
- "quarter",
- "year",
- "Term"
- ],
- "type": "string"
- },
- "include_program_partner_other": {
- "type": "boolean"
- },
- "include_program_partner_other_val": {
- "type": "string"
- },
- "include_program_provider_other": {
- "type": "boolean"
- },
- "include_program_provider_other_val": {
- "type": "string"
- },
- "include_program_reference": {
- "type": "boolean"
- },
- "product_description": {
- "type": "string"
- },
- "term_amount": {
- "type": "number"
- },
- "term_unit": {
- "enum": [
- "day(s)",
- "week(s)",
- "month(s)",
- "quarter(s)",
- "year(s)"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- "district_or_county": {
- "description": "The district or county for dispute resolution.",
- "type": "string"
- },
- "dpa_attributes": {
- "additionalProperties": false,
- "description": "Override dpa terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "approved_subprocessor_type": {
- "description": "`internal` lists approved subprocessors in the agreement (`subprocessors_attributes`); `external` points to a list published elsewhere.",
- "enum": [
- "internal",
- "external"
- ],
- "type": "string"
- },
- "cloud_service_product_name": {
- "type": "string"
- },
- "competent_supervisory_authority": {
- "type": "string"
- },
- "customer_description": {
- "type": "string"
- },
- "data_exporter_address_city": {
- "type": "string"
- },
- "data_exporter_address_country": {
- "type": "string"
- },
- "data_exporter_address_state": {
- "type": "string"
- },
- "data_exporter_address_street_address": {
- "type": "string"
- },
- "data_exporter_address_zipcode": {
- "type": "string"
- },
- "data_exporter_contact_details": {
- "type": "string"
- },
- "data_exporter_contact_name": {
- "type": "string"
- },
- "data_exporter_contact_position": {
- "type": "string"
- },
- "data_exporter_role": {
- "description": "Role of the data exporter. Overwritten to `Controller` when the agreement is created from a template.",
- "enum": [
- "Controller",
- "Processor"
- ],
- "type": "string"
- },
- "data_importer_address": {
- "type": "string"
- },
- "data_importer_address_city": {
- "type": "string"
- },
- "data_importer_address_country": {
- "type": "string"
- },
- "data_importer_address_state": {
- "type": "string"
- },
- "data_importer_address_street_address": {
- "type": "string"
- },
- "data_importer_address_zipcode": {
- "type": "string"
- },
- "data_importer_contact_details": {
- "type": "string"
- },
- "data_importer_contact_name": {
- "type": "string"
- },
- "data_importer_contact_position": {
- "type": "string"
- },
- "duration_of_processing": {
- "type": "string"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_covered_claim": {
- "type": "boolean"
- },
- "include_covered_claim_external_val": {
- "type": "string"
- },
- "include_covered_claim_internal_val": {
- "type": "string"
- },
- "include_covered_claim_type": {
- "description": "Which covered-claim text applies: `internal` uses `include_covered_claim_internal_val`, `external` uses `include_covered_claim_external_val`. Required when `include_covered_claim` is true.",
- "enum": [
- "internal",
- "external"
- ],
- "type": "string"
- },
- "include_data_subjects_custom": {
- "type": "boolean"
- },
- "include_data_subjects_custom_val": {
- "type": "string"
- },
- "include_data_subjects_employees": {
- "type": "boolean"
- },
- "include_data_subjects_end_users": {
- "type": "boolean"
- },
- "include_external_subprocessor_location": {
- "type": "string"
- },
- "include_frequency_of_transfer_continuous": {
- "type": "boolean"
- },
- "include_frequency_of_transfer_custom": {
- "type": "boolean"
- },
- "include_frequency_of_transfer_custom_val": {
- "type": "string"
- },
- "include_governing_country_eu": {
- "type": "boolean"
- },
- "include_governing_country_eu_val": {
- "type": "string"
- },
- "include_governing_country_uk": {
- "type": "boolean"
- },
- "include_governing_country_uk_val": {
- "type": "string"
- },
- "include_governing_law": {
- "type": "boolean"
- },
- "include_governing_law_country": {
- "type": "string"
- },
- "include_governing_law_state": {
- "type": "string"
- },
- "include_increased_claim_amount": {
- "description": "Legacy field. Stored but not shown on the DPA; use the `include_liability_cap*` fields instead.",
- "type": "boolean"
- },
- "include_increased_claim_amount_currency": {
- "description": "Legacy field. Stored but not shown on the DPA; use the `include_liability_cap*` fields instead."
- },
- "include_increased_claim_amount_qty": {
- "description": "Legacy field. Stored but not shown on the DPA; use the `include_liability_cap*` fields instead."
- },
- "include_increased_claim_amount_type": {
- "description": "Legacy field. Stored but not shown on the DPA; use the `include_liability_cap*` fields instead.",
- "type": "string"
- },
- "include_liability_cap": {
- "type": "boolean"
- },
- "include_liability_cap_amount_constant_external": {
- "type": "string"
- },
- "include_liability_cap_amount_constant_internal": {
- "type": "string"
- },
- "include_liability_cap_amount_currency_external": {
- "description": "Currency amount. Numbers and numeric strings (commas allowed) are both accepted."
- },
- "include_liability_cap_amount_currency_internal": {
- "description": "Currency amount. Numbers and numeric strings (commas allowed) are both accepted."
- },
- "include_liability_cap_csa_type": {
- "description": "Which liability cap values apply: the `_internal` or `_external` amount fields. Required when `include_liability_cap` is true.",
- "enum": [
- "internal",
- "external"
- ],
- "type": "string"
- },
- "include_personal_data_biographic_info": {
- "type": "boolean"
- },
- "include_personal_data_contact_info": {
- "type": "boolean"
- },
- "include_personal_data_custom": {
- "type": "boolean"
- },
- "include_personal_data_custom_val": {
- "type": "string"
- },
- "include_personal_data_employment_info": {
- "type": "boolean"
- },
- "include_personal_data_financial_info": {
- "type": "boolean"
- },
- "include_personal_data_location": {
- "type": "boolean"
- },
- "include_personal_data_name": {
- "type": "boolean"
- },
- "include_personal_data_transactional_info": {
- "type": "boolean"
- },
- "include_personal_data_user_activity_info": {
- "type": "boolean"
- },
- "include_processing_purpose_custom": {
- "type": "boolean"
- },
- "include_processing_purpose_custom_val": {
- "type": "string"
- },
- "include_processing_purpose_erasing": {
- "type": "boolean"
- },
- "include_processing_purpose_holding": {
- "type": "boolean"
- },
- "include_processing_purpose_protecting": {
- "type": "boolean"
- },
- "include_processing_purpose_receiving": {
- "type": "boolean"
- },
- "include_processing_purpose_returning": {
- "type": "boolean"
- },
- "include_processing_purpose_sharing": {
- "type": "boolean"
- },
- "include_processing_purpose_updating": {
- "type": "boolean"
- },
- "include_processing_purpose_using": {
- "type": "boolean"
- },
- "include_provider_security_contact_address": {
- "type": "boolean"
- },
- "include_provider_security_contact_address_city": {
- "type": "string"
- },
- "include_provider_security_contact_address_country": {
- "type": "string"
- },
- "include_provider_security_contact_address_state": {
- "type": "string"
- },
- "include_provider_security_contact_address_street_address": {
- "type": "string"
- },
- "include_provider_security_contact_address_zipcode": {
- "type": "string"
- },
- "include_provider_security_contact_email": {
- "type": "boolean"
- },
- "include_provider_security_contact_email_val": {
- "format": "email",
- "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
- "type": "string"
- },
- "include_security_measures_accountability": {
- "type": "boolean"
- },
- "include_security_measures_accountability_val": {
- "type": "string"
- },
- "include_security_measures_certification_or_assurance": {
- "type": "boolean"
- },
- "include_security_measures_certification_or_assurance_val": {
- "type": "string"
- },
- "include_security_measures_confidentiality_integrity": {
- "type": "boolean"
- },
- "include_security_measures_confidentiality_integrity_val": {
- "type": "string"
- },
- "include_security_measures_data_at_rest": {
- "type": "boolean"
- },
- "include_security_measures_data_at_rest_val": {
- "type": "string"
- },
- "include_security_measures_data_minimization": {
- "type": "boolean"
- },
- "include_security_measures_data_minimization_val": {
- "type": "string"
- },
- "include_security_measures_data_quality": {
- "type": "boolean"
- },
- "include_security_measures_data_quality_val": {
- "type": "string"
- },
- "include_security_measures_data_retention": {
- "type": "boolean"
- },
- "include_security_measures_data_retention_val": {
- "type": "string"
- },
- "include_security_measures_data_transmission": {
- "type": "boolean"
- },
- "include_security_measures_data_transmission_val": {
- "type": "string"
- },
- "include_security_measures_event_logging": {
- "type": "boolean"
- },
- "include_security_measures_event_logging_val": {
- "type": "string"
- },
- "include_security_measures_identity_auth": {
- "type": "boolean"
- },
- "include_security_measures_identity_auth_val": {
- "type": "string"
- },
- "include_security_measures_it_security_governance": {
- "type": "boolean"
- },
- "include_security_measures_it_security_governance_val": {
- "type": "string"
- },
- "include_security_measures_physical_security": {
- "type": "boolean"
- },
- "include_security_measures_physical_security_val": {
- "type": "string"
- },
- "include_security_measures_portability_and_erasure": {
- "type": "boolean"
- },
- "include_security_measures_portability_and_erasure_val": {
- "type": "string"
- },
- "include_security_measures_pseudonym_encryption": {
- "type": "boolean"
- },
- "include_security_measures_pseudonym_encryption_val": {
- "type": "string"
- },
- "include_security_measures_restore_data_access": {
- "type": "boolean"
- },
- "include_security_measures_restore_data_access_val": {
- "type": "string"
- },
- "include_security_measures_security_policy": {
- "type": "boolean"
- },
- "include_security_measures_system_configuration": {
- "type": "boolean"
- },
- "include_security_measures_system_configuration_val": {
- "type": "string"
- },
- "include_security_measures_testing_assessment": {
- "type": "boolean"
- },
- "include_security_measures_testing_assessment_val": {
- "type": "string"
- },
- "include_security_policy": {
- "type": "boolean"
- },
- "include_security_policy_fedramp_auth": {
- "type": "boolean"
- },
- "include_security_policy_hipaa": {
- "type": "boolean"
- },
- "include_security_policy_hitrust": {
- "type": "boolean"
- },
- "include_security_policy_include_other": {
- "type": "boolean"
- },
- "include_security_policy_iso27001": {
- "type": "boolean"
- },
- "include_security_policy_other": {
- "type": "string"
- },
- "include_security_policy_pci1": {
- "type": "boolean"
- },
- "include_security_policy_pci2": {
- "type": "boolean"
- },
- "include_security_policy_penetration_testing": {
- "type": "boolean"
- },
- "include_security_policy_soc2": {
- "type": "boolean"
- },
- "include_security_policy_soc2_type2": {
- "type": "boolean"
- },
- "include_sensitive_data_restrictions_custom": {
- "type": "boolean"
- },
- "include_sensitive_data_restrictions_custom_val": {
- "type": "string"
- },
- "include_sensitive_data_restrictions_security_policy": {
- "type": "boolean"
- },
- "include_service_provider_relationship": {
- "type": "boolean"
- },
- "include_special_category_data": {
- "type": "boolean"
- },
- "provider": {
- "type": "string"
- },
- "security_policy_available_at": {
- "type": "string"
- },
- "security_policy_type": {
- "description": "Where the Security Policy is defined. For `external`, set `security_policy_available_at`.",
- "enum": [
- "defined in agreement",
- "provider service",
- "external"
- ],
- "type": "string"
- },
- "subprocessors_attributes": {
- "additionalProperties": {
- "additionalProperties": false,
- "properties": {
- "_destroy": {
- "description": "Set to true with `id` to remove that subprocessor.",
- "type": "boolean"
- },
- "country": {
- "type": "string"
- },
- "id": {
- "description": "ID of an existing subprocessor to update or remove. Omit to add a new subprocessor.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "name": {
- "type": "string"
- },
- "processing_task": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "description": "Subprocessors, keyed by string index such as \"0\", \"1\". On create these are added to the template's subprocessors. On a draft update, an entry without `id` adds a new subprocessor; pass `id` to change one and `id` with `_destroy: true` to remove one.",
- "propertyNames": {
- "type": "string"
- },
- "type": "object"
- },
- "underlying_agreement_id": {
- "description": "ID of the CSA this DPA supplements when `underlying_agreement_type` is `internal`.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "underlying_agreement_type": {
- "description": "`internal` links a CSA in Common Paper (`underlying_agreement_id`); `external` describes another agreement in `underlying_agreement_val` (required). Omit for none.",
- "enum": [
- "internal",
- "external"
- ],
- "type": "string"
- },
- "underlying_agreement_val": {
- "description": "Description of the agreement this DPA supplements. Required when `underlying_agreement_type` is `external`.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "framework_terms_description": {
- "description": "Custom framework terms description. Only used when framework_terms_type is \"description\".",
- "type": "string"
- },
- "framework_terms_type": {
- "description": "How framework terms are specified. Use \"new\" for standard terms or \"description\" to provide a custom framework_terms_description.",
- "enum": [
- "new",
- "description"
- ],
- "type": "string"
- },
- "governing_law_country": {
- "description": "The country whose laws govern the agreement.",
- "type": "string"
- },
- "governing_law_region": {
- "description": "The state or region whose laws govern the agreement.",
- "type": "string"
- },
- "include_automated_payment_reminders": {
- "description": "When true, automatically sends payment reminder emails.",
- "type": "boolean"
- },
- "include_billing_info": {
- "description": "When true, billing contact information (billing_name, billing_email) is included.",
- "type": "boolean"
- },
- "include_billing_workflow": {
- "description": "When true, enables a billing workflow after signing.",
- "type": "boolean"
- },
- "include_expiration_date": {
- "description": "Expiration date in YYYY-MM-DD format. Use when include_expiration_type is \"date\".",
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "include_expiration_days": {
- "description": "Number of days until the agreement expires. Use when include_expiration_type is \"days\".",
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_expiration_type": {
- "description": "How to set expiration: \"none\" (default), \"days\" (use include_expiration_days), or \"date\" (use include_expiration_date).",
- "enum": [
- "none",
- "days",
- "date"
- ],
- "type": "string"
- },
- "include_terms": {
- "description": "When true, the standard terms are included with the agreement.",
- "type": "boolean"
- },
- "loi_attributes": {
- "additionalProperties": false,
- "description": "Override loi terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "confidentiality_custom": {
- "type": "string"
- },
- "confidentiality_mutual_include_loi": {
- "type": "boolean"
- },
- "confidentiality_nda_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "confidentiality_nda_description": {
- "type": "string"
- },
- "confidentiality_nda_include_loi": {
- "type": "boolean"
- },
- "confidentiality_nda_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "confidentiality_type": {
- "enum": [
- "mutual",
- "nda",
- "provider",
- "custom"
- ],
- "type": "string"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_custom_details": {
- "type": "boolean"
- },
- "include_custom_details_val": {
- "type": "string"
- },
- "include_fees": {
- "type": "boolean"
- },
- "include_fees_amount": {
- "type": "number"
- },
- "include_fees_amount_duration": {
- "enum": [
- "month",
- "year",
- "quarter"
- ],
- "type": "string"
- },
- "include_fees_include_amount": {
- "type": "boolean"
- },
- "include_fees_include_other": {
- "type": "boolean"
- },
- "include_fees_other": {
- "type": "string"
- },
- "include_functionality": {
- "type": "boolean"
- },
- "include_functionality_val": {
- "type": "string"
- },
- "include_launch_date": {
- "type": "boolean"
- },
- "include_launch_date_custom": {
- "type": "string"
- },
- "include_launch_date_date": {
- "format": "date-time",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$",
- "type": "string"
- },
- "include_launch_date_type": {
- "enum": [
- "date",
- "custom"
- ],
- "type": "string"
- },
- "product_name": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "manual_send": {
- "description": "When true, the agreement is marked as manually sent outside the platform.",
- "type": "boolean"
- },
- "message": {
- "type": "string"
- },
- "negotiations_allowed": {
- "description": "When true, the recipient can propose changes to the legal terms. For agreement types without separate business terms, that covers every term. CSA order forms, PSA statements of work, partnership business terms and software license order forms have their own `negotiations_allowed` flag.",
- "type": "boolean"
- },
- "partnership_attributes": {
- "additionalProperties": false,
- "description": "Override partnership terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "effective_date": {
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "effective_date_type": {
- "enum": [
- "signature",
- "date"
- ],
- "type": "string"
- },
- "general_cap_amount_currency_val": {
- "type": "number"
- },
- "general_cap_amount_either_currency": {
- "type": "number"
- },
- "general_cap_amount_either_multiple": {
- "type": "number"
- },
- "general_cap_amount_multiple_val": {
- "type": "number"
- },
- "general_cap_amount_type": {
- "enum": [
- "multiple",
- "currency",
- "either",
- "base"
- ],
- "type": "string"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_additional_warranties": {
- "type": "boolean"
- },
- "include_additional_warranties_include_company": {
- "type": "boolean"
- },
- "include_additional_warranties_include_company_val": {
- "type": "string"
- },
- "include_additional_warranties_include_partner": {
- "type": "boolean"
- },
- "include_additional_warranties_include_partner_val": {
- "type": "string"
- },
- "include_brand_guidelines": {
- "type": "boolean"
- },
- "include_brand_guidelines_include_company": {
- "type": "boolean"
- },
- "include_brand_guidelines_include_company_val": {
- "type": "string"
- },
- "include_brand_guidelines_include_partner": {
- "type": "boolean"
- },
- "include_brand_guidelines_include_partner_val": {
- "type": "string"
- },
- "include_covered_claims": {
- "type": "boolean"
- },
- "include_covered_claims_company_claims": {
- "type": "string"
- },
- "include_covered_claims_include_company_claims": {
- "type": "boolean"
- },
- "include_covered_claims_include_partner_claims": {
- "type": "boolean"
- },
- "include_covered_claims_partner_claims": {
- "type": "string"
- },
- "include_dpa": {
- "type": "boolean"
- },
- "include_dpa_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_dpa_location": {
- "type": "string"
- },
- "include_dpa_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_increased_cap_amount": {
- "type": "boolean"
- },
- "include_increased_cap_amount_currency": {
- "type": "number"
- },
- "include_increased_cap_amount_either_currency": {
- "type": "number"
- },
- "include_increased_cap_amount_either_multiple": {
- "type": "string"
- },
- "include_increased_cap_amount_multiple": {
- "type": "string"
- },
- "include_increased_cap_amount_type": {
- "enum": [
- "multiple",
- "currency",
- "either"
- ],
- "type": "string"
- },
- "include_increased_claims": {
- "type": "boolean"
- },
- "include_increased_claims_include_confidentiality": {
- "type": "boolean"
- },
- "include_increased_claims_include_confidentiality_misconduct": {
- "type": "boolean"
- },
- "include_increased_claims_include_covered_claims": {
- "type": "boolean"
- },
- "include_increased_claims_include_misconduct": {
- "type": "boolean"
- },
- "include_increased_claims_include_other": {
- "type": "boolean"
- },
- "include_increased_claims_include_other_val": {
- "type": "string"
- },
- "include_unlimited_claims": {
- "type": "boolean"
- },
- "include_unlimited_claims_confidentiality": {
- "type": "boolean"
- },
- "include_unlimited_claims_confidentiality_misconduct": {
- "type": "boolean"
- },
- "include_unlimited_claims_covered_claims": {
- "type": "boolean"
- },
- "include_unlimited_claims_misconduct": {
- "type": "boolean"
- },
- "include_unlimited_claims_other": {
- "type": "boolean"
- },
- "include_unlimited_claims_other_val": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "partnership_business_terms_attributes": {
- "additionalProperties": false,
- "description": "Override partnership business terms terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "end_date_after_effective_date_amount": {
- "type": "number"
- },
- "end_date_after_effective_date_unit": {
- "enum": [
- "month(s)",
- "quarter(s)",
- "year(s)"
- ],
- "type": "string"
- },
- "end_date_date": {
- "type": "string"
- },
- "end_date_type": {
- "enum": [
- "date",
- "effective date"
- ],
- "type": "string"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_obligations_company_brand": {
- "type": "boolean"
- },
- "include_obligations_company_promotion": {
- "type": "boolean"
- },
- "include_obligations_company_promotion_include_activities": {
- "type": "boolean"
- },
- "include_obligations_company_promotion_include_activities_val": {
- "type": "string"
- },
- "include_obligations_company_promotion_include_materials": {
- "type": "boolean"
- },
- "include_obligations_company_promotion_include_materials_val": {
- "type": "string"
- },
- "include_obligations_company_referral": {
- "type": "boolean"
- },
- "include_obligations_company_referral_include_criteria": {
- "type": "boolean"
- },
- "include_obligations_company_referral_include_criteria_val": {
- "type": "string"
- },
- "include_obligations_company_referral_include_pay_sch": {
- "type": "boolean"
- },
- "include_obligations_company_referral_include_pay_sch_amount": {
- "type": "number"
- },
- "include_obligations_company_referral_include_pay_sch_custom": {
- "type": "string"
- },
- "include_obligations_company_referral_include_pay_sch_unit": {
- "enum": [
- "U.S. Dollars",
- "percent"
- ],
- "type": "string"
- },
- "include_obligations_company_sponsorship": {
- "type": "boolean"
- },
- "include_obligations_company_sponsorship_include_benefits": {
- "type": "boolean"
- },
- "include_obligations_company_sponsorship_include_benefits_val": {
- "type": "string"
- },
- "include_obligations_company_sponsorship_include_payments": {
- "type": "boolean"
- },
- "include_obligations_company_sponsorship_include_payments_amount": {
- "type": "number"
- },
- "include_obligations_company_sponsorship_include_payments_unit": {
- "enum": [
- "U.S. Dollars",
- "percent"
- ],
- "type": "string"
- },
- "include_obligations_partner_brand": {
- "type": "boolean"
- },
- "include_obligations_partner_promotion": {
- "type": "boolean"
- },
- "include_obligations_partner_promotion_include_activities": {
- "type": "boolean"
- },
- "include_obligations_partner_promotion_include_activities_val": {
- "type": "string"
- },
- "include_obligations_partner_promotion_include_materials": {
- "type": "boolean"
- },
- "include_obligations_partner_promotion_include_materials_val": {
- "type": "string"
- },
- "include_obligations_partner_referral": {
- "type": "boolean"
- },
- "include_obligations_partner_referral_include_criteria": {
- "type": "boolean"
- },
- "include_obligations_partner_referral_include_criteria_val": {
- "type": "string"
- },
- "include_obligations_partner_referral_include_pay_sch": {
- "type": "boolean"
- },
- "include_obligations_partner_referral_include_pay_sch_amount": {
- "type": "number"
- },
- "include_obligations_partner_referral_include_pay_sch_custom": {
- "type": "string"
- },
- "include_obligations_partner_referral_include_pay_sch_unit": {
- "enum": [
- "U.S. Dollars",
- "percent"
- ],
- "type": "string"
- },
- "include_obligations_partner_sponsorship": {
- "type": "boolean"
- },
- "include_obligations_partner_sponsorship_include_benefits": {
- "type": "boolean"
- },
- "include_obligations_partner_sponsorship_include_benefits_val": {
- "type": "string"
- },
- "include_obligations_partner_sponsorship_include_payments": {
- "type": "boolean"
- },
- "include_obligations_partner_sponsorship_include_payments_amount": {
- "type": "number"
- },
- "include_obligations_partner_sponsorship_include_payments_unit": {
- "enum": [
- "U.S. Dollars",
- "percent"
- ],
- "type": "string"
- },
- "include_payment_process": {
- "type": "boolean"
- },
- "include_payment_process_company": {
- "type": "boolean"
- },
- "include_payment_process_company_include_address": {
- "type": "boolean"
- },
- "include_payment_process_company_include_address_city": {
- "type": "string"
- },
- "include_payment_process_company_include_address_country": {
- "type": "string"
- },
- "include_payment_process_company_include_address_state": {
- "type": "string"
- },
- "include_payment_process_company_include_address_street_address": {
- "type": "string"
- },
- "include_payment_process_company_include_address_zipcode": {
- "type": "string"
- },
- "include_payment_process_company_include_email": {
- "type": "boolean"
- },
- "include_payment_process_company_include_email_val": {
- "type": "string"
- },
- "include_payment_process_partner": {
- "type": "boolean"
- },
- "include_payment_process_partner_include_address": {
- "type": "boolean"
- },
- "include_payment_process_partner_include_address_city": {
- "type": "string"
- },
- "include_payment_process_partner_include_address_country": {
- "type": "string"
- },
- "include_payment_process_partner_include_address_state": {
- "type": "string"
- },
- "include_payment_process_partner_include_address_street_address": {
- "type": "string"
- },
- "include_payment_process_partner_include_address_zipcode": {
- "type": "string"
- },
- "include_payment_process_partner_include_email": {
- "type": "boolean"
- },
- "include_payment_process_partner_include_email_val": {
- "type": "string"
- },
- "include_payment_schedule": {
- "type": "boolean"
- },
- "include_payment_schedule_custom": {
- "type": "string"
- },
- "include_payment_schedule_specified_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_payment_schedule_specified_timeframe": {
- "enum": [
- "receipt",
- "date"
- ],
- "type": "string"
- },
- "include_payment_schedule_specified_unit": {
- "enum": [
- "day(s)",
- "week(s)",
- "month(s)",
- "quarter(s)",
- "year(s)"
- ],
- "type": "string"
- },
- "include_payment_schedule_type": {
- "enum": [
- "specified",
- "custom"
- ],
- "type": "string"
- },
- "negotiations_allowed": {
- "description": "When true, the recipient can propose changes to the business terms, even when the agreement-level `negotiations_allowed` is false. This only covers the business terms.",
- "type": "boolean"
- },
- "territory_type": {
- "enum": [
- "worldwide",
- "custom"
- ],
- "type": "string"
- },
- "territory_type_val": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "payment_link_url": {
- "description": "A payment URL shown to the recipient after signing. Requires include_billing_workflow to be true and billing_workflow_type to be \"link\".",
- "type": "string"
- },
- "pilot_attributes": {
- "additionalProperties": false,
- "description": "Override pilot terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "fees_type": {
- "enum": [
- "free",
- "pilot_period_fees"
- ],
- "type": "string"
- },
- "general_cap_amount": {
- "type": "number"
- },
- "general_cap_amount_type": {
- "enum": [
- "preceding",
- "base",
- "period"
- ],
- "type": "string"
- },
- "general_cap_period_currency": {
- "type": "number"
- },
- "general_cap_period_qty": {
- "type": "number"
- },
- "general_cap_preceding_amount": {
- "type": "number"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_dpa": {
- "type": "boolean"
- },
- "include_dpa_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_dpa_location": {
- "type": "string"
- },
- "include_dpa_type": {
- "enum": [
- "description",
- "attachment",
- "standard"
- ],
- "type": "string"
- },
- "include_payment_process": {
- "type": "boolean"
- },
- "include_technical_support": {
- "type": "boolean"
- },
- "payment_process_automatic_frequency": {
- "enum": [
- "monthly",
- "quarterly",
- "annually",
- "once_per_period"
- ],
- "type": "string"
- },
- "payment_process_invoice_days": {
- "type": "number"
- },
- "payment_process_invoice_from": {
- "enum": [
- "receipt",
- "date"
- ],
- "type": "string"
- },
- "payment_process_invoice_timeframe": {
- "enum": [
- "days",
- "weeks",
- "months",
- "quarters",
- "years"
- ],
- "type": "string"
- },
- "payment_process_type": {
- "enum": [
- "automatic",
- "invoice"
- ],
- "type": "string"
- },
- "pilot_period_description": {
- "type": "string"
- },
- "pilot_period_fees_description": {
- "type": "string"
- },
- "product_description": {
- "type": "string"
- },
- "technical_support_description": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "psa_attributes": {
- "additionalProperties": false,
- "description": "Override psa terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "additional_changes": {
- "type": "string"
- },
- "customer_description": {
- "type": "string"
- },
- "effective_date": {
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "effective_date_type": {
- "enum": [
- "signature",
- "date"
- ],
- "type": "string"
- },
- "general_cap_amount": {
- "type": "number"
- },
- "general_cap_amount_type": {
- "enum": [
- "preceding",
- "base",
- "period"
- ],
- "type": "string"
- },
- "general_cap_period_currency": {
- "type": "number"
- },
- "general_cap_period_qty": {
- "type": "number"
- },
- "general_cap_preceding_amount": {
- "type": "number"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_additional_changes": {
- "type": "boolean"
- },
- "include_additional_warranties": {
- "type": "boolean"
- },
- "include_additional_warranties_by_customer": {
- "type": "string"
- },
- "include_additional_warranties_by_provider": {
- "type": "string"
- },
- "include_additional_warranties_include_by_customer": {
- "type": "boolean"
- },
- "include_additional_warranties_include_by_provider": {
- "type": "boolean"
- },
- "include_covered_claims": {
- "type": "boolean"
- },
- "include_covered_claims_customer_claims": {
- "type": "string"
- },
- "include_covered_claims_include_customer_claims": {
- "type": "boolean"
- },
- "include_covered_claims_include_provider_claims": {
- "type": "boolean"
- },
- "include_covered_claims_provider_claims": {
- "type": "string"
- },
- "include_customer_insurance_min": {
- "type": "boolean"
- },
- "include_customer_insurance_min_add_provider_com_gen_liability": {
- "type": "boolean"
- },
- "include_customer_insurance_min_add_provider_cyber_liability": {
- "type": "boolean"
- },
- "include_customer_insurance_min_add_provider_errors_omissions": {
- "type": "boolean"
- },
- "include_customer_insurance_min_auto_liability_aggregate": {
- "type": "number"
- },
- "include_customer_insurance_min_auto_liability_minimum": {
- "type": "number"
- },
- "include_customer_insurance_min_cyber_liability_aggregate": {
- "type": "number"
- },
- "include_customer_insurance_min_cyber_liability_minimum": {
- "type": "number"
- },
- "include_customer_insurance_min_employer_liability_aggregate": {
- "type": "number"
- },
- "include_customer_insurance_min_employer_liability_minimum": {
- "type": "number"
- },
- "include_customer_insurance_min_general_liability_aggregate": {
- "type": "number"
- },
- "include_customer_insurance_min_general_liability_minimum": {
- "type": "number"
- },
- "include_customer_insurance_min_include_add_provider": {
- "type": "boolean"
- },
- "include_customer_insurance_min_include_auto_liability": {
- "type": "boolean"
- },
- "include_customer_insurance_min_include_cyber_liability": {
- "type": "boolean"
- },
- "include_customer_insurance_min_include_employer_liability": {
- "type": "boolean"
- },
- "include_customer_insurance_min_include_general_liability": {
- "type": "boolean"
- },
- "include_customer_insurance_min_include_workers_comp": {
- "type": "boolean"
- },
- "include_customer_policies": {
- "type": "boolean"
- },
- "include_customer_policies_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_customer_policies_location": {
- "type": "string"
- },
- "include_customer_policies_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_dpa": {
- "type": "boolean"
- },
- "include_dpa_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_dpa_location": {
- "type": "string"
- },
- "include_dpa_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_increased_cap_amount": {
- "type": "boolean"
- },
- "include_increased_claims": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_confidentiality": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_confidentiality_negligence": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_privsec": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_privsec_negligence": {
- "type": "boolean"
- },
- "include_increased_claims_include_other": {
- "type": "boolean"
- },
- "include_increased_claims_indemnification_obligation": {
- "type": "boolean"
- },
- "include_increased_claims_negligence": {
- "type": "boolean"
- },
- "include_increased_claims_other": {
- "type": "string"
- },
- "include_provider_insurance_min": {
- "type": "boolean"
- },
- "include_provider_insurance_min_add_customer_com_gen_liability": {
- "type": "boolean"
- },
- "include_provider_insurance_min_add_customer_cyber_liability": {
- "type": "boolean"
- },
- "include_provider_insurance_min_add_customer_errors_omissions": {
- "type": "boolean"
- },
- "include_provider_insurance_min_auto_liability_aggregate": {
- "type": "number"
- },
- "include_provider_insurance_min_auto_liability_minimum": {
- "type": "number"
- },
- "include_provider_insurance_min_cyber_liability_aggregate": {
- "type": "number"
- },
- "include_provider_insurance_min_cyber_liability_minimum": {
- "type": "number"
- },
- "include_provider_insurance_min_employer_liability_aggregate": {
- "type": "number"
- },
- "include_provider_insurance_min_employer_liability_minimum": {
- "type": "number"
- },
- "include_provider_insurance_min_general_liability_aggregate": {
- "type": "number"
- },
- "include_provider_insurance_min_general_liability_minimum": {
- "type": "number"
- },
- "include_provider_insurance_min_include_add_customer": {
- "type": "boolean"
- },
- "include_provider_insurance_min_include_auto_liability": {
- "type": "boolean"
- },
- "include_provider_insurance_min_include_cyber_liability": {
- "type": "boolean"
- },
- "include_provider_insurance_min_include_employer_liability": {
- "type": "boolean"
- },
- "include_provider_insurance_min_include_general_liability": {
- "type": "boolean"
- },
- "include_provider_insurance_min_include_workers_comp": {
- "type": "boolean"
- },
- "include_publicity_rights": {
- "type": "boolean"
- },
- "include_publicity_rights_type": {
- "enum": [
- "public",
- "non-public"
- ],
- "type": "string"
- },
- "include_security_policy": {
- "type": "boolean"
- },
- "include_security_policy_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_security_policy_fedramp_auth": {
- "type": "boolean"
- },
- "include_security_policy_hitrust": {
- "type": "boolean"
- },
- "include_security_policy_include_annual_maintenance": {
- "type": "boolean"
- },
- "include_security_policy_include_other": {
- "type": "boolean"
- },
- "include_security_policy_include_other_val": {
- "type": "string"
- },
- "include_security_policy_iso27001": {
- "type": "boolean"
- },
- "include_security_policy_location": {
- "type": "string"
- },
- "include_security_policy_pci1": {
- "type": "boolean"
- },
- "include_security_policy_pci2": {
- "type": "boolean"
- },
- "include_security_policy_penetration_testing": {
- "type": "boolean"
- },
- "include_security_policy_soc2_type1": {
- "type": "boolean"
- },
- "include_security_policy_soc2_type2": {
- "type": "boolean"
- },
- "include_security_policy_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_unlimited_claims": {
- "type": "boolean"
- },
- "include_unlimited_claims_breach_of_confidentiality": {
- "type": "boolean"
- },
- "include_unlimited_claims_breach_of_confidentiality_negligence": {
- "type": "boolean"
- },
- "include_unlimited_claims_breach_of_privsec": {
- "type": "boolean"
- },
- "include_unlimited_claims_breach_of_privsec_negligence": {
- "type": "boolean"
- },
- "include_unlimited_claims_include_other": {
- "type": "boolean"
- },
- "include_unlimited_claims_indemnification_obligation": {
- "type": "boolean"
- },
- "include_unlimited_claims_negligence": {
- "type": "boolean"
- },
- "include_unlimited_claims_other": {
- "type": "string"
- },
- "increased_cap_amount_currency": {
- "type": "number"
- },
- "increased_cap_amount_period_currency": {
- "type": "number"
- },
- "increased_cap_amount_period_qty": {
- "type": "number"
- },
- "increased_cap_amount_qty": {
- "type": "number"
- },
- "increased_cap_amount_type": {
- "enum": [
- "qty",
- "currency",
- "period"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- "psa_statement_of_work_attributes": {
- "additionalProperties": false,
- "description": "Override psa statement of work terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "additional_changes": {
- "type": "string"
- },
- "cost": {
- "type": "number"
- },
- "description": {
- "type": "string"
- },
- "fee_type": {
- "type": "string"
- },
- "fees_attributes": {
- "additionalProperties": {
- "anyOf": [
- {
- "additionalProperties": false,
- "description": "Fees::Flat (fee_type \"flat\"). A fixed recurring fee, e.g. a platform subscription. Set type to \"Fees::Flat\" or fee_type to \"flat\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "Fixed amount in the order form's fees_currency, charged per fee_period. A plain amount, not cents: 20 means 20.00.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"flat\". Alternative to type.",
- "enum": [
- "flat"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Flat\". Optional when fee_type is set.",
- "enum": [
- "Fees::Flat"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Discount (fee_type \"discount\"). A discount, as a fixed amount or a percentage, applied forever, once, or for a number of months. Set type to \"Fees::Discount\" or fee_type to \"discount\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "Discount size: an amount in fees_currency when discount_type is fixed_amount (a plain amount, not cents: 20 means 20.00), or a percentage (e.g. 10 for 10%) when it is percentage.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "discount_duration_amount": {
- "description": "Number of months the discount applies. Required when discount_duration_type is multiple_months.",
- "type": "number"
- },
- "discount_duration_type": {
- "description": "How long the discount applies. multiple_months also needs discount_duration_amount.",
- "enum": [
- "forever",
- "once",
- "multiple_months"
- ],
- "type": "string"
- },
- "discount_type": {
- "description": "Whether cost is a currency amount or a percentage.",
- "enum": [
- "fixed_amount",
- "percentage"
- ],
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"discount\". Alternative to type.",
- "enum": [
- "discount"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Discount\". Optional when fee_type is set.",
- "enum": [
- "Fees::Discount"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Cost (fee_type \"cost\"). A per-unit fee: price per unit times quantity, e.g. seats. Set type to \"Fees::Cost\" or fee_type to \"cost\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "Price per unit in fees_currency. The row total is quantity x cost. A plain amount, not cents: 20 means 20.00.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"cost\". Alternative to type.",
- "enum": [
- "cost"
- ],
- "type": "string"
- },
- "quantity": {
- "description": "Number of units.",
- "type": "number"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Cost\". Optional when fee_type is set.",
- "enum": [
- "Fees::Cost"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Attachment (fee_type \"attachment\"). A fee described in an uploaded attachment instead of in the table. Set type to \"Fees::Attachment\" or fee_type to \"attachment\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "attachment_id": {
- "description": "ID of an attachment uploaded with upload-attachment.",
- "type": "string"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"attachment\". Alternative to type.",
- "enum": [
- "attachment"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Attachment\". Optional when fee_type is set.",
- "enum": [
- "Fees::Attachment"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Graduated (fee_type \"graduated\"). Tiered pricing, with the price set per tier in graduated_fee_tiers_attributes. Set type to \"Fees::Graduated\" or fee_type to \"graduated\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"graduated\". Alternative to type.",
- "enum": [
- "graduated"
- ],
- "type": "string"
- },
- "graduated_fee_tiers_attributes": {
- "additionalProperties": {
- "additionalProperties": false,
- "properties": {
- "flat_price": {
- "type": "number"
- },
- "price_per_unit": {
- "type": "string"
- },
- "upper_limit": {
- "type": "number"
- }
- },
- "type": "object"
- },
- "description": "Graduated fee tiers. Use string keys such as \"0\", \"1\".",
- "propertyNames": {
- "type": "string"
- },
- "type": "object"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Graduated\". Optional when fee_type is set.",
- "enum": [
- "Fees::Graduated"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Included (fee_type \"included\"). An item included at no charge. Set type to \"Fees::Included\" or fee_type to \"included\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"included\". Alternative to type.",
- "enum": [
- "included"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Included\". Optional when fee_type is set.",
- "enum": [
- "Fees::Included"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Metered (fee_type \"metered\"). Usage-based pricing, billed per unit used. Set type to \"Fees::Metered\" or fee_type to \"metered\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "Price per unit of usage in fees_currency. A plain amount, not cents: 20 means 20.00.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"metered\". Alternative to type.",
- "enum": [
- "metered"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Metered\". Optional when fee_type is set.",
- "enum": [
- "Fees::Metered"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::OneTime (fee_type \"one_time\"). A one-time charge, such as a setup fee. Set type to \"Fees::OneTime\" or fee_type to \"one_time\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "One-time amount in fees_currency, charged once rather than per fee_period. A plain amount, not cents: 20 means 20.00.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"one_time\". Alternative to type.",
- "enum": [
- "one_time"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::OneTime\". Optional when fee_type is set.",
- "enum": [
- "Fees::OneTime"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Text (fee_type \"text\"). A fee term described in free text. Set type to \"Fees::Text\" or fee_type to \"text\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"text\". Alternative to type.",
- "enum": [
- "text"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Text\". Optional when fee_type is set.",
- "enum": [
- "Fees::Text"
- ],
- "type": "string"
- }
- },
- "type": "object"
- }
- ]
- },
- "description": "Fee line items. Use string keys such as \"0\", \"1\". Replaces template fees when provided.",
- "propertyNames": {
- "type": "string"
- },
- "type": "object"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_additional_changes": {
- "type": "boolean"
- },
- "include_customer_obligation": {
- "type": "boolean"
- },
- "include_customer_obligation_val": {
- "type": "string"
- },
- "include_deliverables": {
- "type": "boolean"
- },
- "include_deliverables_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_deliverables_description": {
- "type": "string"
- },
- "include_deliverables_include_acceptance": {
- "type": "boolean"
- },
- "include_deliverables_include_attachment": {
- "type": "boolean"
- },
- "include_deliverables_include_draft_deliverables": {
- "type": "boolean"
- },
- "include_deliverables_rejection_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_deliverables_rejection_unit": {
- "enum": [
- "hours",
- "days",
- "weeks",
- "months"
- ],
- "type": "string"
- },
- "include_deliverables_resubmission_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_deliverables_resubmission_unit": {
- "enum": [
- "hours",
- "days",
- "weeks",
- "months"
- ],
- "type": "string"
- },
- "include_fees_other": {
- "type": "boolean"
- },
- "include_fees_other_val": {
- "type": "string"
- },
- "include_fees_table": {
- "type": "boolean"
- },
- "include_fees_table_total": {
- "type": "boolean"
- },
- "include_fees_travel": {
- "type": "boolean"
- },
- "include_fees_travel_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_fees_travel_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_fees_travel_val": {
- "type": "string"
- },
- "include_third_party_customer": {
- "type": "boolean"
- },
- "include_third_party_include_description": {
- "type": "boolean"
- },
- "include_third_party_include_description_val": {
- "type": "string"
- },
- "include_third_party_materials": {
- "type": "boolean"
- },
- "include_third_party_provider": {
- "type": "boolean"
- },
- "include_time_of_assignment": {
- "type": "boolean"
- },
- "include_time_of_assignment_type": {
- "enum": [
- "created",
- "paid"
- ],
- "type": "string"
- },
- "invoice_period_description": {
- "type": "string"
- },
- "negotiations_allowed": {
- "description": "When true, the recipient can propose changes to the statement of work, even when the agreement-level `negotiations_allowed` is false. This only covers the statement of work.",
- "type": "boolean"
- },
- "payment_period": {
- "type": "number"
- },
- "payment_period_other": {
- "type": "string"
- },
- "payment_period_timeframe": {
- "enum": [
- "receipt",
- "invoice",
- "Customer's receipt of invoice",
- "date of invoice"
- ],
- "type": "string"
- },
- "payment_period_type": {
- "enum": [
- "standard",
- "other"
- ],
- "type": "string"
- },
- "payment_period_unit": {
- "enum": [
- "day(s)",
- "week(s)",
- "month(s)",
- "quarter(s)",
- "year(s)"
- ],
- "type": "string"
- },
- "quantity": {
- "type": "number"
- },
- "services_description": {
- "type": "string"
- },
- "sow_date": {
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "sow_date_type": {
- "enum": [
- "signature",
- "date"
- ],
- "type": "string"
- },
- "sow_term_amount": {
- "type": "number"
- },
- "sow_term_date": {
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "sow_term_type": {
- "enum": [
- "deliverables",
- "period",
- "date"
- ],
- "type": "string"
- },
- "sow_term_unit": {
- "enum": [
- "month(s)",
- "quarter(s)",
- "year(s)"
- ],
- "type": "string"
- },
- "type": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "recipient_email": {
- "format": "email",
- "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
- "type": "string"
- },
- "recipient_name": {
- "type": "string"
- },
- "recipient_notice_email_address": {
- "description": "Email address for legal notices to the recipient.",
- "format": "email",
- "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
- "type": "string"
- },
- "recipient_organization": {
- "type": "string"
- },
- "recipient_role": {
- "description": "PSA only. The recipient's role: `Customer` (the default) or `Provider`. Send it with `sender_role`; the two must be one `Provider` and one `Customer`. Other standard agreement types ignore it.",
- "type": "string"
- },
- "sender_last_to_sign": {
- "description": "When true, your signer signs after the recipient.",
- "type": "boolean"
- },
- "sender_notice_email_address": {
- "description": "Email address for legal notices to the sender.",
- "format": "email",
- "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
- "type": "string"
- },
- "sender_role": {
- "description": "PSA only. Your company's role: `Provider` (the default) or `Customer` when you hire the recipient to provide the services. Send it with `recipient_role`; the two must be one `Provider` and one `Customer`. When reading a PSA, an empty `sender_role` means `Provider`. Other standard agreement types ignore it.",
- "type": "string"
- },
- "software_license_attributes": {
- "additionalProperties": false,
- "description": "Override software license terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "effective_date": {
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "effective_date_type": {
- "enum": [
- "signature",
- "date"
- ],
- "type": "string"
- },
- "general_cap_amount": {
- "type": "number"
- },
- "general_cap_amount_type": {
- "enum": [
- "preceding",
- "base",
- "period"
- ],
- "type": "string"
- },
- "general_cap_period_currency": {
- "type": "number"
- },
- "general_cap_period_qty": {
- "type": "number"
- },
- "general_cap_preceding_amount": {
- "type": "number"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_additional_warranties": {
- "type": "boolean"
- },
- "include_additional_warranties_by_customer": {
- "type": "string"
- },
- "include_additional_warranties_by_provider": {
- "type": "string"
- },
- "include_additional_warranties_include_by_customer": {
- "type": "boolean"
- },
- "include_additional_warranties_include_by_provider": {
- "type": "boolean"
- },
- "include_ai_addendum": {
- "type": "boolean"
- },
- "include_ai_addendum_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_covered_claims": {
- "type": "boolean"
- },
- "include_covered_claims_customer_claims": {
- "type": "string"
- },
- "include_covered_claims_include_customer_claims": {
- "type": "boolean"
- },
- "include_covered_claims_include_provider_claims": {
- "type": "boolean"
- },
- "include_covered_claims_provider_claims": {
- "type": "string"
- },
- "include_dpa": {
- "type": "boolean"
- },
- "include_dpa_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_dpa_location": {
- "type": "string"
- },
- "include_dpa_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_increased_cap_amount": {
- "type": "boolean"
- },
- "include_increased_claims": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_confidentiality": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_confidentiality_negligence": {
- "type": "boolean"
- },
- "include_increased_claims_include_other": {
- "type": "boolean"
- },
- "include_increased_claims_indemnification_obligation": {
- "type": "boolean"
- },
- "include_increased_claims_negligence": {
- "type": "boolean"
- },
- "include_increased_claims_other": {
- "type": "string"
- },
- "include_increased_claims_restrictions": {
- "type": "boolean"
- },
- "include_unlimited_claims": {
- "type": "boolean"
- },
- "include_unlimited_claims_breach_of_confidentiality": {
- "type": "boolean"
- },
- "include_unlimited_claims_breach_of_confidentiality_negligence": {
- "type": "boolean"
- },
- "include_unlimited_claims_include_other": {
- "type": "boolean"
- },
- "include_unlimited_claims_indemnification_obligation": {
- "type": "boolean"
- },
- "include_unlimited_claims_license_or_restrictions": {
- "type": "boolean"
- },
- "include_unlimited_claims_negligence": {
- "type": "boolean"
- },
- "include_unlimited_claims_other": {
- "type": "string"
- },
- "increased_cap_amount_currency": {
- "type": "number"
- },
- "increased_cap_amount_period_currency": {
- "type": "number"
- },
- "increased_cap_amount_period_qty": {
- "type": "number"
- },
- "increased_cap_amount_qty": {
- "type": "number"
- },
- "increased_cap_amount_type": {
- "enum": [
- "qty",
- "currency",
- "period"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- "software_license_order_form_attributes": {
- "additionalProperties": false,
- "description": "Override software license order form terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "additional_changes": {
- "type": "string"
- },
- "deletion_procedure_include_custom": {
- "type": "boolean"
- },
- "deletion_procedure_include_custom_description": {
- "type": "string"
- },
- "deletion_procedure_include_customer_disable": {
- "type": "boolean"
- },
- "deletion_procedure_include_customer_proof": {
- "type": "boolean"
- },
- "deletion_procedure_include_provider_disable": {
- "type": "boolean"
- },
- "fee_custom_unit": {
- "type": "string"
- },
- "fee_period": {
- "enum": [
- "Subscription Period",
- "month",
- "year",
- "Custom unit"
- ],
- "type": "string"
- },
- "fees_attributes": {
- "additionalProperties": {
- "anyOf": [
- {
- "additionalProperties": false,
- "description": "Fees::Flat (fee_type \"flat\"). A fixed recurring fee, e.g. a platform subscription. Set type to \"Fees::Flat\" or fee_type to \"flat\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "Fixed amount in the order form's fees_currency, charged per fee_period. A plain amount, not cents: 20 means 20.00.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"flat\". Alternative to type.",
- "enum": [
- "flat"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Flat\". Optional when fee_type is set.",
- "enum": [
- "Fees::Flat"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Discount (fee_type \"discount\"). A discount, as a fixed amount or a percentage, applied forever, once, or for a number of months. Set type to \"Fees::Discount\" or fee_type to \"discount\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "Discount size: an amount in fees_currency when discount_type is fixed_amount (a plain amount, not cents: 20 means 20.00), or a percentage (e.g. 10 for 10%) when it is percentage.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "discount_duration_amount": {
- "description": "Number of months the discount applies. Required when discount_duration_type is multiple_months.",
- "type": "number"
- },
- "discount_duration_type": {
- "description": "How long the discount applies. multiple_months also needs discount_duration_amount.",
- "enum": [
- "forever",
- "once",
- "multiple_months"
- ],
- "type": "string"
- },
- "discount_type": {
- "description": "Whether cost is a currency amount or a percentage.",
- "enum": [
- "fixed_amount",
- "percentage"
- ],
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"discount\". Alternative to type.",
- "enum": [
- "discount"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Discount\". Optional when fee_type is set.",
- "enum": [
- "Fees::Discount"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Cost (fee_type \"cost\"). A per-unit fee: price per unit times quantity, e.g. seats. Set type to \"Fees::Cost\" or fee_type to \"cost\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "Price per unit in fees_currency. The row total is quantity x cost. A plain amount, not cents: 20 means 20.00.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"cost\". Alternative to type.",
- "enum": [
- "cost"
- ],
- "type": "string"
- },
- "quantity": {
- "description": "Number of units.",
- "type": "number"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Cost\". Optional when fee_type is set.",
- "enum": [
- "Fees::Cost"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Attachment (fee_type \"attachment\"). A fee described in an uploaded attachment instead of in the table. Set type to \"Fees::Attachment\" or fee_type to \"attachment\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "attachment_id": {
- "description": "ID of an attachment uploaded with upload-attachment.",
- "type": "string"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"attachment\". Alternative to type.",
- "enum": [
- "attachment"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Attachment\". Optional when fee_type is set.",
- "enum": [
- "Fees::Attachment"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Graduated (fee_type \"graduated\"). Tiered pricing, with the price set per tier in graduated_fee_tiers_attributes. Set type to \"Fees::Graduated\" or fee_type to \"graduated\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"graduated\". Alternative to type.",
- "enum": [
- "graduated"
- ],
- "type": "string"
- },
- "graduated_fee_tiers_attributes": {
- "additionalProperties": {
- "additionalProperties": false,
- "properties": {
- "flat_price": {
- "type": "number"
- },
- "price_per_unit": {
- "type": "string"
- },
- "upper_limit": {
- "type": "number"
- }
- },
- "type": "object"
- },
- "description": "Graduated fee tiers. Use string keys such as \"0\", \"1\".",
- "propertyNames": {
- "type": "string"
- },
- "type": "object"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Graduated\". Optional when fee_type is set.",
- "enum": [
- "Fees::Graduated"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Included (fee_type \"included\"). An item included at no charge. Set type to \"Fees::Included\" or fee_type to \"included\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"included\". Alternative to type.",
- "enum": [
- "included"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Included\". Optional when fee_type is set.",
- "enum": [
- "Fees::Included"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Metered (fee_type \"metered\"). Usage-based pricing, billed per unit used. Set type to \"Fees::Metered\" or fee_type to \"metered\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "Price per unit of usage in fees_currency. A plain amount, not cents: 20 means 20.00.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"metered\". Alternative to type.",
- "enum": [
- "metered"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Metered\". Optional when fee_type is set.",
- "enum": [
- "Fees::Metered"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::OneTime (fee_type \"one_time\"). A one-time charge, such as a setup fee. Set type to \"Fees::OneTime\" or fee_type to \"one_time\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "One-time amount in fees_currency, charged once rather than per fee_period. A plain amount, not cents: 20 means 20.00.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"one_time\". Alternative to type.",
- "enum": [
- "one_time"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::OneTime\". Optional when fee_type is set.",
- "enum": [
- "Fees::OneTime"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Text (fee_type \"text\"). A fee term described in free text. Set type to \"Fees::Text\" or fee_type to \"text\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"text\". Alternative to type.",
- "enum": [
- "text"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Text\". Optional when fee_type is set.",
- "enum": [
- "Fees::Text"
- ],
- "type": "string"
- }
- },
- "type": "object"
- }
- ]
- },
- "description": "Fee line items. Use string keys such as \"0\", \"1\". Replaces template fees when provided.",
- "propertyNames": {
- "type": "string"
- },
- "type": "object"
- },
- "fees_currency": {
- "enum": [
- "USD",
- "EUR",
- "GBP",
- "CAD",
- "AUD",
- "SGD",
- "ILS",
- "JPY",
- "CHF",
- "HKD"
- ],
- "type": "string"
- },
- "fees_include_fee_increase_upon_renewal": {
- "type": "boolean"
- },
- "fees_include_fee_increase_upon_renewal_fee": {
- "type": "number"
- },
- "fees_include_fee_increase_upon_renewal_type": {
- "enum": [
- "will",
- "may"
- ],
- "type": "string"
- },
- "fees_inclusive_of_taxes": {
- "type": "boolean"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_additional_changes": {
- "type": "boolean"
- },
- "include_license_compliance_verification": {
- "type": "boolean"
- },
- "include_license_compliance_verification_description": {
- "type": "string"
- },
- "include_license_limits": {
- "type": "boolean"
- },
- "include_license_limits_description": {
- "type": "string"
- },
- "include_payment_process_include_billing_email": {
- "type": "boolean"
- },
- "include_pilot_period": {
- "type": "boolean"
- },
- "include_pilot_period_duration_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_pilot_period_duration_type": {
- "enum": [
- "day",
- "week",
- "month"
- ],
- "type": "string"
- },
- "include_pilot_period_include_fees": {
- "type": "boolean"
- },
- "include_pilot_period_include_fees_amount": {
- "type": "number"
- },
- "include_pilot_period_include_modifications": {
- "type": "boolean"
- },
- "include_pilot_period_include_modifications_description": {
- "type": "string"
- },
- "include_services": {
- "type": "boolean"
- },
- "include_services_description": {
- "type": "string"
- },
- "negotiations_allowed": {
- "description": "When true, the recipient can propose changes to the order form, even when the agreement-level `negotiations_allowed` is false. This only covers the order form.",
- "type": "boolean"
- },
- "order_date_date": {
- "type": "string"
- },
- "order_date_type": {
- "enum": [
- "signature",
- "date",
- "other"
- ],
- "type": "string"
- },
- "payment_process_automatic_frequency": {
- "enum": [
- "monthly",
- "quarterly",
- "semiannually",
- "annually"
- ],
- "type": "string"
- },
- "payment_process_type": {
- "enum": [
- "automatic",
- "invoice",
- "custom"
- ],
- "type": "string"
- },
- "payment_process_type_custom_val": {
- "type": "string"
- },
- "payment_process_type_invoice_amount": {
- "type": "number"
- },
- "payment_process_type_invoice_custom_unit": {
- "type": "string"
- },
- "payment_process_type_invoice_duration": {
- "enum": [
- "day",
- "week",
- "month",
- "year",
- "day(s)",
- "week(s)",
- "month(s)",
- "year(s)"
- ],
- "type": "string"
- },
- "payment_process_type_invoice_duration_start": {
- "enum": [
- "Customer's receipt of invoice",
- "date of invoice"
- ],
- "type": "string"
- },
- "payment_process_type_invoice_type": {
- "enum": [
- "monthly",
- "quarterly",
- "semiannually",
- "annually",
- "Custom unit"
- ],
- "type": "string"
- },
- "permitted_uses_include_custom": {
- "type": "boolean"
- },
- "permitted_uses_include_custom_description": {
- "type": "string"
- },
- "permitted_uses_include_customers_affiliates": {
- "type": "boolean"
- },
- "permitted_uses_include_internal_business": {
- "type": "boolean"
- },
- "pilot_period_stripe_product_id": {
- "type": "string"
- },
- "software_description": {
- "type": "string"
- },
- "subscription_auto_renew": {
- "enum": [
- "days",
- "subscription_end"
- ],
- "type": "string"
- },
- "subscription_period": {
- "type": "number"
- },
- "subscription_period_unit": {
- "type": "string"
- },
- "subscription_renewal_notice_days": {
- "type": "number"
- },
- "warranty_period_description_amount": {
- "type": "number"
- },
- "warranty_period_description_duration": {
- "enum": [
- "day",
- "week",
- "month",
- "year"
- ],
- "type": "string"
- },
- "warranty_period_description_duration_start": {
- "enum": [
- "initial delivery of the Software",
- "delivery of the Software and each subsequent Update",
- "the Order Date"
- ],
- "type": "string"
- },
- "warranty_period_type": {
- "enum": [
- "description",
- "none"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- "test_agreement": {
- "description": "When true, marks the agreement as a test. Test agreements do not count against your monthly limit.",
- "type": "boolean"
- }
- },
- "required": [
- "recipient_name",
- "recipient_email"
- ],
- "type": "object"
- },
- "cc_users": {
- "items": {
- "format": "email",
- "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
- "type": "string"
- },
- "type": "array"
- },
- "draft": {
- "description": "When true, the agreement is saved as a draft and not sent to the recipient. Use POST /v1/agreements/{id}/send to send a draft agreement later.",
- "type": "boolean"
- },
- "owner_id": {
- "description": "User id of the agreement owner (sender).",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "signer_id": {
- "description": "User id of the signer from the owner's organization.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "template_id": {
- "description": "UUID of a template from `GET /v1/templates`. Accepts both Common Paper standard templates and uploaded PDF templates (`type` `uploaded_template`).",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- }
- },
- "required": [
- "template_id",
- "owner_id",
- "signer_id",
- "agreement"
- ],
- "type": "object"
- }
-]New value: +[
+ {
+ "additionalProperties": false,
+ "properties": {
+ "agreement": {
+ "additionalProperties": {},
+ "properties": {
+ "amendment_attributes": {
+ "additionalProperties": false,
+ "description": "Override amendment terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "amended_terms_attributes": {
+ "additionalProperties": {
+ "additionalProperties": false,
+ "properties": {
+ "description": {
+ "type": "string"
+ },
+ "term": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "description": "Amended terms. Use string keys such as \"0\", \"1\".",
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+ },
+ "amendment_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "amendment_date_type": {
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "type": "string"
+ },
+ "framework_terms_type": {
+ "type": "string"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "parent_agreement_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "underlying_agreement_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "underlying_agreement_type": {
+ "type": "string"
+ },
+ "underlying_agreement_val": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "baa_attributes": {
+ "additionalProperties": false,
+ "description": "Override baa terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "aggregation_limitations_permitted": {
+ "type": "boolean"
+ },
+ "aggregation_limitations_permitted_val": {
+ "type": "string"
+ },
+ "breach_notification_unit": {
+ "enum": [
+ "hours",
+ "business days",
+ "calendar days"
+ ],
+ "type": "string"
+ },
+ "breach_notification_val": {
+ "type": "number"
+ },
+ "business_associate_relationship_type": {
+ "enum": [
+ "provider",
+ "company"
+ ],
+ "type": "string"
+ },
+ "deidentification_limitations_include_purpose": {
+ "type": "boolean"
+ },
+ "deidentification_limitations_include_requirements": {
+ "type": "boolean"
+ },
+ "deidentification_limitations_permitted": {
+ "type": "boolean"
+ },
+ "deidentification_limitations_purpose_val": {
+ "type": "string"
+ },
+ "deidentification_limitations_requirements_val": {
+ "type": "string"
+ },
+ "designated_record_set_provider_maintains": {
+ "type": "boolean"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_aggregation_limitations": {
+ "type": "boolean"
+ },
+ "include_deidentification_limitations": {
+ "type": "boolean"
+ },
+ "include_limitations": {
+ "type": "boolean"
+ },
+ "include_offshore_limitations": {
+ "type": "boolean"
+ },
+ "include_subcontract_limitations": {
+ "type": "boolean"
+ },
+ "offshore_limitations_permitted": {
+ "type": "boolean"
+ },
+ "offshore_limitations_permitted_val": {
+ "type": "string"
+ },
+ "subcontract_limitations_include_notice": {
+ "type": "boolean"
+ },
+ "subcontract_limitations_include_permission": {
+ "type": "boolean"
+ },
+ "subcontract_limitations_notice_val": {
+ "type": "string"
+ },
+ "subcontract_limitations_permission_val": {
+ "type": "string"
+ },
+ "subcontract_limitations_permitted": {
+ "type": "boolean"
+ },
+ "underlying_agreement_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "underlying_agreement_type": {
+ "enum": [
+ "internal",
+ "external",
+ "none"
+ ],
+ "type": "string"
+ },
+ "underlying_agreement_val": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "billing_email": {
+ "description": "Email of the billing contact. Used when include_billing_info is true.",
+ "format": "email",
+ "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "billing_name": {
+ "description": "Name of the billing contact. Used when include_billing_info is true.",
+ "type": "string"
+ },
+ "billing_workflow_type": {
+ "description": "The type of billing workflow. Use \"link\" to provide a payment_link_url, or \"stripe\" for Stripe-managed billing.",
+ "enum": [
+ "link",
+ "stripe"
+ ],
+ "type": "string"
+ },
+ "chosen_courts_country": {
+ "description": "The country in which disputes will be resolved.",
+ "type": "string"
+ },
+ "chosen_courts_region": {
+ "description": "The state or region in which disputes will be resolved.",
+ "type": "string"
+ },
+ "csa_attributes": {
+ "additionalProperties": false,
+ "description": "Override csa terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "customer_description": {
+ "type": "string"
+ },
+ "effective_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "effective_date_marketplace": {
+ "enum": [
+ "AWS",
+ "GCP",
+ "Azure"
+ ],
+ "type": "string"
+ },
+ "effective_date_type": {
+ "enum": [
+ "signature",
+ "date",
+ "marketplace_acceptance"
+ ],
+ "type": "string"
+ },
+ "general_cap_amount": {
+ "type": "number"
+ },
+ "general_cap_amount_type": {
+ "enum": [
+ "preceding",
+ "base",
+ "period"
+ ],
+ "type": "string"
+ },
+ "general_cap_period_currency": {
+ "type": "number"
+ },
+ "general_cap_period_qty": {
+ "type": "number"
+ },
+ "general_cap_preceding_amount": {
+ "type": "number"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_acceptable_use_policy": {
+ "type": "boolean"
+ },
+ "include_acceptable_use_policy_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_acceptable_use_policy_location": {
+ "type": "string"
+ },
+ "include_acceptable_use_policy_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_additional_warranties": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_by_customer": {
+ "type": "string"
+ },
+ "include_additional_warranties_by_provider": {
+ "type": "string"
+ },
+ "include_additional_warranties_include_by_customer": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_include_by_provider": {
+ "type": "boolean"
+ },
+ "include_ai_addendum": {
+ "type": "boolean"
+ },
+ "include_ai_addendum_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_covered_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_customer_claims": {
+ "type": "string"
+ },
+ "include_covered_claims_include_customer_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_include_provider_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_provider_claims": {
+ "type": "string"
+ },
+ "include_dpa": {
+ "type": "boolean"
+ },
+ "include_dpa_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_dpa_location": {
+ "type": "string"
+ },
+ "include_dpa_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_increased_cap_amount": {
+ "type": "boolean"
+ },
+ "include_increased_claims": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_confidentiality": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_confidentiality_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_privsec": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_privsec_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_other": {
+ "type": "boolean"
+ },
+ "include_increased_claims_indemnification_obligation": {
+ "type": "boolean"
+ },
+ "include_increased_claims_other": {
+ "type": "string"
+ },
+ "include_insurance_minimums": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_add_customer": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_add_customer_com_gen_liability": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_add_customer_cyber_liability": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_add_customer_errors_omissions": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_additional_information": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_additional_information_text": {
+ "type": "string"
+ },
+ "include_insurance_minimums_cyber_liability_aggregate": {
+ "type": "number"
+ },
+ "include_insurance_minimums_cyber_liability_minimum": {
+ "type": "number"
+ },
+ "include_insurance_minimums_employer_liability_aggregate": {
+ "type": "number"
+ },
+ "include_insurance_minimums_employer_liability_minimum": {
+ "type": "number"
+ },
+ "include_insurance_minimums_general_liability_aggregate": {
+ "type": "number"
+ },
+ "include_insurance_minimums_general_liability_minimum": {
+ "type": "number"
+ },
+ "include_insurance_minimums_include_cyber_liability": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_include_employer_liability": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_include_general_liability": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_include_workers_compensation": {
+ "type": "boolean"
+ },
+ "include_publicity_rights": {
+ "type": "boolean"
+ },
+ "include_publicity_rights_type": {
+ "enum": [
+ "public",
+ "non-public"
+ ],
+ "type": "string"
+ },
+ "include_security_policy": {
+ "type": "boolean"
+ },
+ "include_security_policy_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_security_policy_fedramp_auth": {
+ "type": "boolean"
+ },
+ "include_security_policy_hipaa": {
+ "type": "boolean"
+ },
+ "include_security_policy_hitrust": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_annual_maintenance": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_location": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_other": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_reasonable_efforts": {
+ "type": "boolean"
+ },
+ "include_security_policy_iso27001": {
+ "type": "boolean"
+ },
+ "include_security_policy_location": {
+ "type": "string"
+ },
+ "include_security_policy_other": {
+ "type": "string"
+ },
+ "include_security_policy_pci1": {
+ "type": "boolean"
+ },
+ "include_security_policy_pci2": {
+ "type": "boolean"
+ },
+ "include_security_policy_penetration_testing": {
+ "type": "boolean"
+ },
+ "include_security_policy_soc2": {
+ "type": "boolean"
+ },
+ "include_security_policy_soc2_type2": {
+ "type": "boolean"
+ },
+ "include_security_policy_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_supercap": {
+ "description": "CSA 3.0 renamed `include_increased_cap_amount` to `include_supercap`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_increased_cap_amount`. Sending the other spelling returns a 422.",
+ "type": "boolean"
+ },
+ "include_uncapped_claims": {
+ "description": "CSA 3.0 renamed `include_unlimited_claims` to `include_uncapped_claims`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims`. Sending the other spelling returns a 422.",
+ "type": "boolean"
+ },
+ "include_uncapped_claims_breach_of_confidentiality": {
+ "description": "CSA 3.0 renamed `include_unlimited_claims_breach_of_confidentiality` to `include_uncapped_claims_breach_of_confidentiality`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_breach_of_confidentiality`. Sending the other spelling returns a 422.",
+ "type": "boolean"
+ },
+ "include_uncapped_claims_breach_of_confidentiality_negligence": {
+ "description": "CSA 3.0 renamed `include_unlimited_claims_breach_of_confidentiality_negligence` to `include_uncapped_claims_breach_of_confidentiality_negligence`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_breach_of_confidentiality_negligence`. Sending the other spelling returns a 422.",
+ "type": "boolean"
+ },
+ "include_uncapped_claims_breach_of_privsec": {
+ "description": "CSA 3.0 renamed `include_unlimited_claims_breach_of_privsec` to `include_uncapped_claims_breach_of_privsec`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_breach_of_privsec`. Sending the other spelling returns a 422.",
+ "type": "boolean"
+ },
+ "include_uncapped_claims_breach_of_privsec_negligence": {
+ "description": "CSA 3.0 renamed `include_unlimited_claims_breach_of_privsec_negligence` to `include_uncapped_claims_breach_of_privsec_negligence`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_breach_of_privsec_negligence`. Sending the other spelling returns a 422.",
+ "type": "boolean"
+ },
+ "include_uncapped_claims_include_other": {
+ "description": "CSA 3.0 renamed `include_unlimited_claims_include_other` to `include_uncapped_claims_include_other`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_include_other`. Sending the other spelling returns a 422.",
+ "type": "boolean"
+ },
+ "include_uncapped_claims_indemnification_obligation": {
+ "description": "CSA 3.0 renamed `include_unlimited_claims_indemnification_obligation` to `include_uncapped_claims_indemnification_obligation`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_indemnification_obligation`. Sending the other spelling returns a 422.",
+ "type": "boolean"
+ },
+ "include_uncapped_claims_other": {
+ "description": "CSA 3.0 renamed `include_unlimited_claims_other` to `include_uncapped_claims_other`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_other`. Sending the other spelling returns a 422.",
+ "type": "boolean"
+ },
+ "include_unlimited_claims": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_confidentiality": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_confidentiality_negligence": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_privsec": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_privsec_negligence": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_include_other": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_indemnification_obligation": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_other": {
+ "type": "string"
+ },
+ "increased_cap_amount_currency": {
+ "type": "number"
+ },
+ "increased_cap_amount_period_currency": {
+ "type": "number"
+ },
+ "increased_cap_amount_period_qty": {
+ "type": "number"
+ },
+ "increased_cap_amount_qty": {
+ "type": "number"
+ },
+ "increased_cap_amount_type": {
+ "enum": [
+ "qty",
+ "currency",
+ "period"
+ ],
+ "type": "string"
+ },
+ "provider": {
+ "type": "string"
+ },
+ "supercap_currency": {
+ "description": "CSA 3.0 renamed `increased_cap_amount_currency` to `supercap_currency`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `increased_cap_amount_currency`. Sending the other spelling returns a 422.",
+ "type": "number"
+ },
+ "supercap_period_currency": {
+ "description": "CSA 3.0 renamed `increased_cap_amount_period_currency` to `supercap_period_currency`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `increased_cap_amount_period_currency`. Sending the other spelling returns a 422.",
+ "type": "number"
+ },
+ "supercap_period_qty": {
+ "description": "CSA 3.0 renamed `increased_cap_amount_period_qty` to `supercap_period_qty`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `increased_cap_amount_period_qty`. Sending the other spelling returns a 422.",
+ "type": "number"
+ },
+ "supercap_qty": {
+ "description": "CSA 3.0 renamed `increased_cap_amount_qty` to `supercap_qty`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `increased_cap_amount_qty`. Sending the other spelling returns a 422.",
+ "type": "number"
+ },
+ "supercap_type": {
+ "description": "CSA 3.0 renamed `increased_cap_amount_type` to `supercap_type`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `increased_cap_amount_type`. Sending the other spelling returns a 422.",
+ "type": "number"
+ }
+ },
+ "type": "object"
+ },
+ "csa_order_form_attributes": {
+ "additionalProperties": false,
+ "description": "Override csa order form terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "additional_changes": {
+ "type": "string"
+ },
+ "additional_parameters_or_limitations": {
+ "type": "string"
+ },
+ "affiliates_as_users": {
+ "type": "boolean"
+ },
+ "cloud_service_description": {
+ "type": "string"
+ },
+ "consumption_units": {
+ "type": "string"
+ },
+ "fee_amount": {
+ "type": "number"
+ },
+ "fee_custom_unit": {
+ "type": "string"
+ },
+ "fee_period": {
+ "enum": [
+ "Subscription Period",
+ "month",
+ "year",
+ "User",
+ "Custom unit"
+ ],
+ "type": "string"
+ },
+ "fees_attributes": {
+ "additionalProperties": {
+ "anyOf": [
+ {
+ "additionalProperties": false,
+ "description": "Fees::Flat (fee_type \"flat\"). A fixed recurring fee, e.g. a platform subscription. Set type to \"Fees::Flat\" or fee_type to \"flat\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Fixed amount in the order form's fees_currency, charged per fee_period. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"flat\". Alternative to type.",
+ "enum": [
+ "flat"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Flat\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Flat"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Discount (fee_type \"discount\"). A discount, as a fixed amount or a percentage, applied forever, once, or for a number of months. Set type to \"Fees::Discount\" or fee_type to \"discount\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Discount size: an amount in fees_currency when discount_type is fixed_amount (a plain amount, not cents: 20 means 20.00), or a percentage (e.g. 10 for 10%) when it is percentage.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "discount_duration_amount": {
+ "description": "Number of months the discount applies. Required when discount_duration_type is multiple_months.",
+ "type": "number"
+ },
+ "discount_duration_type": {
+ "description": "How long the discount applies. multiple_months also needs discount_duration_amount.",
+ "enum": [
+ "forever",
+ "once",
+ "multiple_months"
+ ],
+ "type": "string"
+ },
+ "discount_type": {
+ "description": "Whether cost is a currency amount or a percentage.",
+ "enum": [
+ "fixed_amount",
+ "percentage"
+ ],
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"discount\". Alternative to type.",
+ "enum": [
+ "discount"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Discount\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Discount"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Cost (fee_type \"cost\"). A per-unit fee: price per unit times quantity, e.g. seats. Set type to \"Fees::Cost\" or fee_type to \"cost\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Price per unit in fees_currency. The row total is quantity x cost. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"cost\". Alternative to type.",
+ "enum": [
+ "cost"
+ ],
+ "type": "string"
+ },
+ "quantity": {
+ "description": "Number of units.",
+ "type": "number"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Cost\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Cost"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Attachment (fee_type \"attachment\"). A fee described in an uploaded attachment instead of in the table. Set type to \"Fees::Attachment\" or fee_type to \"attachment\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "attachment_id": {
+ "description": "ID of an attachment uploaded with upload-attachment.",
+ "type": "string"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"attachment\". Alternative to type.",
+ "enum": [
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Attachment\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Attachment"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Graduated (fee_type \"graduated\"). Tiered pricing, with the price set per tier in graduated_fee_tiers_attributes. Set type to \"Fees::Graduated\" or fee_type to \"graduated\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"graduated\". Alternative to type.",
+ "enum": [
+ "graduated"
+ ],
+ "type": "string"
+ },
+ "graduated_fee_tiers_attributes": {
+ "additionalProperties": {
+ "additionalProperties": false,
+ "properties": {
+ "flat_price": {
+ "type": "number"
+ },
+ "price_per_unit": {
+ "type": "string"
+ },
+ "upper_limit": {
+ "type": "number"
+ }
+ },
+ "type": "object"
+ },
+ "description": "Graduated fee tiers. Use string keys such as \"0\", \"1\".",
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Graduated\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Graduated"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Included (fee_type \"included\"). An item included at no charge. Set type to \"Fees::Included\" or fee_type to \"included\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"included\". Alternative to type.",
+ "enum": [
+ "included"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Included\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Included"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Metered (fee_type \"metered\"). Usage-based pricing, billed per unit used. Set type to \"Fees::Metered\" or fee_type to \"metered\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Price per unit of usage in fees_currency. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"metered\". Alternative to type.",
+ "enum": [
+ "metered"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Metered\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Metered"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::OneTime (fee_type \"one_time\"). A one-time charge, such as a setup fee. Set type to \"Fees::OneTime\" or fee_type to \"one_time\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "One-time amount in fees_currency, charged once rather than per fee_period. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"one_time\". Alternative to type.",
+ "enum": [
+ "one_time"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::OneTime\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::OneTime"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Text (fee_type \"text\"). A fee term described in free text. Set type to \"Fees::Text\" or fee_type to \"text\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"text\". Alternative to type.",
+ "enum": [
+ "text"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Text\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Text"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ }
+ ]
+ },
+ "description": "Fee table rows, keyed by string index (\"0\", \"1\", ...). Replaces the template's fees when provided. Each row sets type or fee_type to pick the fee class. Amounts are in the order form's fees_currency and, for recurring fees, are charged per fee_period.",
+ "examples": [
+ {
+ "0": {
+ "cost": 2000,
+ "description": "Platform subscription",
+ "type": "Fees::Flat"
+ }
+ },
+ {
+ "0": {
+ "cost": 50,
+ "description": "Seats",
+ "fee_type": "cost",
+ "quantity": 10
+ },
+ "1": {
+ "cost": 10,
+ "description": "Launch discount",
+ "discount_duration_amount": 3,
+ "discount_duration_type": "multiple_months",
+ "discount_type": "percentage",
+ "fee_type": "discount"
+ }
+ }
+ ],
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+ },
+ "fees_currency": {
+ "enum": [
+ "USD",
+ "EUR",
+ "GBP",
+ "CAD",
+ "AUD",
+ "SGD",
+ "ILS",
+ "JPY",
+ "CHF",
+ "HKD"
+ ],
+ "type": "string"
+ },
+ "fees_include_fee_increase_upon_renewal": {
+ "type": "boolean"
+ },
+ "fees_include_fee_increase_upon_renewal_fee": {
+ "type": "number"
+ },
+ "fees_include_fee_increase_upon_renewal_type": {
+ "enum": [
+ "will",
+ "may"
+ ],
+ "type": "string"
+ },
+ "fees_inclusive_of_taxes": {
+ "type": "boolean"
+ },
+ "framework_terms_type": {
+ "enum": [
+ "new",
+ "existing",
+ "description"
+ ],
+ "type": "string"
+ },
+ "free_trial_days": {
+ "type": "number"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_additional_changes": {
+ "type": "boolean"
+ },
+ "include_additional_parameters_or_limitations": {
+ "type": "boolean"
+ },
+ "include_consumption": {
+ "type": "boolean"
+ },
+ "include_fees": {
+ "type": "boolean"
+ },
+ "include_fees_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_fees_include_attachment": {
+ "type": "boolean"
+ },
+ "include_fees_other": {
+ "type": "boolean"
+ },
+ "include_fees_other_val": {
+ "type": "string"
+ },
+ "include_fees_table": {
+ "type": "boolean"
+ },
+ "include_fees_table_period": {
+ "enum": [
+ "Subscription Period",
+ "month",
+ "year",
+ "User"
+ ],
+ "type": "string"
+ },
+ "include_free_trial": {
+ "type": "boolean"
+ },
+ "include_max_users": {
+ "type": "boolean"
+ },
+ "include_pilot_period": {
+ "type": "boolean"
+ },
+ "include_pilot_period_duration_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_pilot_period_duration_type": {
+ "enum": [
+ "day",
+ "week",
+ "month"
+ ],
+ "type": "string"
+ },
+ "include_pilot_period_include_fees": {
+ "type": "boolean"
+ },
+ "include_pilot_period_include_fees_amount": {
+ "type": "number"
+ },
+ "include_pilot_period_include_modifications": {
+ "type": "boolean"
+ },
+ "include_pilot_period_include_modifications_description": {
+ "type": "string"
+ },
+ "include_product_support": {
+ "type": "boolean"
+ },
+ "include_product_support_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_product_support_description": {
+ "type": "string"
+ },
+ "include_product_support_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_professional_services": {
+ "type": "boolean"
+ },
+ "include_professional_services_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_professional_services_custom_name": {
+ "type": "string"
+ },
+ "include_professional_services_description": {
+ "type": "string"
+ },
+ "include_professional_services_end_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "include_professional_services_fees_description": {
+ "type": "string"
+ },
+ "include_professional_services_include_end_date": {
+ "type": "boolean"
+ },
+ "include_professional_services_include_fees_description": {
+ "type": "boolean"
+ },
+ "include_professional_services_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_sla": {
+ "type": "boolean"
+ },
+ "include_sla_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_sla_description": {
+ "type": "string"
+ },
+ "include_sla_include_response_time": {
+ "type": "boolean"
+ },
+ "include_sla_include_response_time_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_sla_include_response_time_credit": {
+ "type": "number"
+ },
+ "include_sla_include_response_time_duration": {
+ "enum": [
+ "hour",
+ "day",
+ "week",
+ "month",
+ "hours"
+ ],
+ "type": "string"
+ },
+ "include_sla_include_response_time_support_channel": {
+ "type": "string"
+ },
+ "include_sla_include_target_uptime": {
+ "type": "boolean"
+ },
+ "include_sla_maintenance_notice": {
+ "type": "boolean"
+ },
+ "include_sla_maintenance_window": {
+ "type": "boolean"
+ },
+ "include_sla_maintenance_window_type": {
+ "enum": [
+ "standard",
+ "none"
+ ],
+ "type": "string"
+ },
+ "include_sla_standard_maintenance_notice_qty": {
+ "type": "number"
+ },
+ "include_sla_standard_maintenance_notice_unit": {
+ "enum": [
+ "hour",
+ "day",
+ "week",
+ "month"
+ ],
+ "type": "string"
+ },
+ "include_sla_standard_maintenance_window_end_time": {
+ "type": "string"
+ },
+ "include_sla_standard_maintenance_window_friday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_monday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_saturday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_start_time": {
+ "type": "string"
+ },
+ "include_sla_standard_maintenance_window_sunday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_thursday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_time_zone": {
+ "type": "string"
+ },
+ "include_sla_standard_maintenance_window_tuesday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_wednesday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_target_uptime": {
+ "type": "number"
+ },
+ "include_sla_type": {
+ "enum": [
+ "description",
+ "standard",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_subscription_start_date": {
+ "type": "boolean"
+ },
+ "include_subscription_start_date_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "include_usage_review": {
+ "type": "boolean"
+ },
+ "include_usage_review_val": {
+ "type": "string"
+ },
+ "include_use_limitations": {
+ "type": "boolean"
+ },
+ "include_use_limitations_val": {
+ "type": "string"
+ },
+ "invoice_period": {
+ "enum": [
+ "monthly",
+ "quarterly",
+ "semiannually",
+ "annually",
+ "Custom unit",
+ "Monthly",
+ "Quarterly",
+ "Semiannually",
+ "Annually"
+ ],
+ "type": "string"
+ },
+ "invoice_period_custom_unit": {
+ "type": "string"
+ },
+ "max_consumption": {
+ "type": "number"
+ },
+ "max_users": {
+ "type": "number"
+ },
+ "negotiations_allowed": {
+ "description": "When true, the recipient can propose changes to the order form, even when the agreement-level `negotiations_allowed` is false. This only covers the order form.",
+ "type": "boolean"
+ },
+ "order_date_date": {
+ "type": "string"
+ },
+ "order_date_other": {
+ "type": "string"
+ },
+ "order_date_type": {
+ "enum": [
+ "signature",
+ "date",
+ "other"
+ ],
+ "type": "string"
+ },
+ "payment_period": {
+ "type": "number"
+ },
+ "payment_period_timeframe": {
+ "enum": [
+ "Customer's receipt of invoice",
+ "date of invoice"
+ ],
+ "type": "string"
+ },
+ "payment_period_unit": {
+ "enum": [
+ "day(s)",
+ "week(s)",
+ "month(s)",
+ "marketplace_acceptance"
+ ],
+ "type": "string"
+ },
+ "payment_process_automatic_frequency": {
+ "enum": [
+ "monthly",
+ "quarterly",
+ "semiannually",
+ "annually"
+ ],
+ "type": "string"
+ },
+ "payment_process_type": {
+ "enum": [
+ "automatic",
+ "invoice",
+ "custom",
+ "marketplace_acceptance"
+ ],
+ "type": "string"
+ },
+ "payment_process_type_custom_val": {
+ "type": "string"
+ },
+ "payment_process_type_invoice_amount": {
+ "type": "number"
+ },
+ "payment_process_type_invoice_custom_unit": {
+ "type": "string"
+ },
+ "payment_process_type_invoice_duration": {
+ "enum": [
+ "day",
+ "week",
+ "month",
+ "year",
+ "day(s)",
+ "week(s)",
+ "month(s)",
+ "year(s)"
+ ],
+ "type": "string"
+ },
+ "payment_process_type_invoice_duration_start": {
+ "enum": [
+ "Customer's receipt of invoice",
+ "date of invoice"
+ ],
+ "type": "string"
+ },
+ "payment_process_type_invoice_type": {
+ "enum": [
+ "monthly",
+ "quarterly",
+ "semiannually",
+ "annually",
+ "Custom unit"
+ ],
+ "type": "string"
+ },
+ "pilot_period_stripe_product_id": {
+ "type": "string"
+ },
+ "service_credits_attributes": {
+ "additionalProperties": {
+ "additionalProperties": false,
+ "properties": {
+ "credit": {
+ "type": "number"
+ },
+ "max": {
+ "type": "number"
+ },
+ "min": {
+ "type": "number"
+ }
+ },
+ "type": "object"
+ },
+ "description": "Service credits. Use string keys such as \"0\", \"1\".",
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+ },
+ "subscription_auto_renew": {
+ "enum": [
+ "days",
+ "subscription_end"
+ ],
+ "type": "string"
+ },
+ "subscription_period": {
+ "type": "number"
+ },
+ "subscription_period_unit": {
+ "type": "string"
+ },
+ "subscription_renewal_notice_days": {
+ "type": "number"
+ },
+ "subscription_start_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "subscription_start_date_type": {
+ "enum": [
+ "effective_date",
+ "date"
+ ],
+ "type": "string"
+ },
+ "underlying_agreement_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "use_limitations_attributes": {
+ "additionalProperties": {
+ "additionalProperties": false,
+ "properties": {
+ "amount": {
+ "type": "number"
+ },
+ "limitation_type": {
+ "type": "string"
+ },
+ "unit": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "description": "Use limitations. Use string keys such as \"0\", \"1\".",
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+ }
+ },
+ "type": "object"
+ },
+ "custom_field_values": {
+ "description": "Values for a custom template's fields, keyed by the field keys defined in the template's YAML definition. Only used when template_id is a custom template. Template defaults fill any fields you omit; a required field with no default and no submitted value returns a 400 naming the field. Values are validated against the field's input type: select and radio values must be one of the field's options, multiselect values are an array of selections each of which must be one of the field's options, number and currency values must be numeric, date values must be YYYY-MM-DD, and email values must be valid addresses. An invalid value returns a 400 naming the field."
+ },
+ "design_partner_attributes": {
+ "additionalProperties": false,
+ "description": "Override design partner terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "customer_description": {
+ "type": "string"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_fees": {
+ "type": "boolean"
+ },
+ "include_fees_amount": {
+ "type": "number"
+ },
+ "include_fees_description": {
+ "type": "string"
+ },
+ "include_fees_pay_by_amount": {
+ "type": "string"
+ },
+ "include_fees_type": {
+ "enum": [
+ "default_language",
+ "description"
+ ],
+ "type": "string"
+ },
+ "include_fees_unit": {
+ "enum": [
+ "month",
+ "quarter",
+ "year",
+ "Term"
+ ],
+ "type": "string"
+ },
+ "include_program_appear_as_customer_private": {
+ "type": "boolean"
+ },
+ "include_program_appear_as_customer_public": {
+ "type": "boolean"
+ },
+ "include_program_case_study": {
+ "type": "boolean"
+ },
+ "include_program_develop_functionality": {
+ "type": "boolean"
+ },
+ "include_program_develop_functionality_val": {
+ "type": "string"
+ },
+ "include_program_discount": {
+ "type": "boolean"
+ },
+ "include_program_discount_amount": {
+ "type": "number"
+ },
+ "include_program_discount_unit": {
+ "enum": [
+ "U.S. Dollars",
+ "percent"
+ ],
+ "type": "string"
+ },
+ "include_program_participation_feedback": {
+ "type": "boolean"
+ },
+ "include_program_participation_feedback_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_program_participation_feedback_unit": {
+ "enum": [
+ "month",
+ "quarter",
+ "year",
+ "Term"
+ ],
+ "type": "string"
+ },
+ "include_program_partner_other": {
+ "type": "boolean"
+ },
+ "include_program_partner_other_val": {
+ "type": "string"
+ },
+ "include_program_provider_other": {
+ "type": "boolean"
+ },
+ "include_program_provider_other_val": {
+ "type": "string"
+ },
+ "include_program_reference": {
+ "type": "boolean"
+ },
+ "product_description": {
+ "type": "string"
+ },
+ "term_amount": {
+ "type": "number"
+ },
+ "term_unit": {
+ "enum": [
+ "day(s)",
+ "week(s)",
+ "month(s)",
+ "quarter(s)",
+ "year(s)"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "district_or_county": {
+ "description": "The district or county for dispute resolution.",
+ "type": "string"
+ },
+ "dpa_attributes": {
+ "additionalProperties": false,
+ "description": "Override dpa terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "approved_subprocessor_type": {
+ "description": "`internal` lists approved subprocessors in the agreement (`subprocessors_attributes`); `external` points to a list published elsewhere.",
+ "enum": [
+ "internal",
+ "external"
+ ],
+ "type": "string"
+ },
+ "cloud_service_product_name": {
+ "type": "string"
+ },
+ "competent_supervisory_authority": {
+ "type": "string"
+ },
+ "customer_description": {
+ "type": "string"
+ },
+ "data_exporter_address_city": {
+ "type": "string"
+ },
+ "data_exporter_address_country": {
+ "type": "string"
+ },
+ "data_exporter_address_state": {
+ "type": "string"
+ },
+ "data_exporter_address_street_address": {
+ "type": "string"
+ },
+ "data_exporter_address_zipcode": {
+ "type": "string"
+ },
+ "data_exporter_contact_details": {
+ "type": "string"
+ },
+ "data_exporter_contact_name": {
+ "type": "string"
+ },
+ "data_exporter_contact_position": {
+ "type": "string"
+ },
+ "data_exporter_role": {
+ "description": "Role of the data exporter. Overwritten to `Controller` when the agreement is created from a template.",
+ "enum": [
+ "Controller",
+ "Processor"
+ ],
+ "type": "string"
+ },
+ "data_importer_address": {
+ "type": "string"
+ },
+ "data_importer_address_city": {
+ "type": "string"
+ },
+ "data_importer_address_country": {
+ "type": "string"
+ },
+ "data_importer_address_state": {
+ "type": "string"
+ },
+ "data_importer_address_street_address": {
+ "type": "string"
+ },
+ "data_importer_address_zipcode": {
+ "type": "string"
+ },
+ "data_importer_contact_details": {
+ "type": "string"
+ },
+ "data_importer_contact_name": {
+ "type": "string"
+ },
+ "data_importer_contact_position": {
+ "type": "string"
+ },
+ "duration_of_processing": {
+ "type": "string"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_covered_claim": {
+ "type": "boolean"
+ },
+ "include_covered_claim_external_val": {
+ "type": "string"
+ },
+ "include_covered_claim_internal_val": {
+ "type": "string"
+ },
+ "include_covered_claim_type": {
+ "description": "Which covered-claim text applies: `internal` uses `include_covered_claim_internal_val`, `external` uses `include_covered_claim_external_val`. Required when `include_covered_claim` is true.",
+ "enum": [
+ "internal",
+ "external"
+ ],
+ "type": "string"
+ },
+ "include_data_subjects_custom": {
+ "type": "boolean"
+ },
+ "include_data_subjects_custom_val": {
+ "type": "string"
+ },
+ "include_data_subjects_employees": {
+ "type": "boolean"
+ },
+ "include_data_subjects_end_users": {
+ "type": "boolean"
+ },
+ "include_external_subprocessor_location": {
+ "type": "string"
+ },
+ "include_frequency_of_transfer_continuous": {
+ "type": "boolean"
+ },
+ "include_frequency_of_transfer_custom": {
+ "type": "boolean"
+ },
+ "include_frequency_of_transfer_custom_val": {
+ "type": "string"
+ },
+ "include_governing_country_eu": {
+ "type": "boolean"
+ },
+ "include_governing_country_eu_val": {
+ "type": "string"
+ },
+ "include_governing_country_uk": {
+ "type": "boolean"
+ },
+ "include_governing_country_uk_val": {
+ "type": "string"
+ },
+ "include_governing_law": {
+ "type": "boolean"
+ },
+ "include_governing_law_country": {
+ "type": "string"
+ },
+ "include_governing_law_state": {
+ "type": "string"
+ },
+ "include_increased_claim_amount": {
+ "description": "Legacy field. Stored but not shown on the DPA; use the `include_liability_cap*` fields instead.",
+ "type": "boolean"
+ },
+ "include_increased_claim_amount_currency": {
+ "description": "Legacy field. Stored but not shown on the DPA; use the `include_liability_cap*` fields instead."
+ },
+ "include_increased_claim_amount_qty": {
+ "description": "Legacy field. Stored but not shown on the DPA; use the `include_liability_cap*` fields instead."
+ },
+ "include_increased_claim_amount_type": {
+ "description": "Legacy field. Stored but not shown on the DPA; use the `include_liability_cap*` fields instead.",
+ "type": "string"
+ },
+ "include_liability_cap": {
+ "type": "boolean"
+ },
+ "include_liability_cap_amount_constant_external": {
+ "type": "string"
+ },
+ "include_liability_cap_amount_constant_internal": {
+ "type": "string"
+ },
+ "include_liability_cap_amount_currency_external": {
+ "description": "Currency amount. Numbers and numeric strings (commas allowed) are both accepted."
+ },
+ "include_liability_cap_amount_currency_internal": {
+ "description": "Currency amount. Numbers and numeric strings (commas allowed) are both accepted."
+ },
+ "include_liability_cap_csa_type": {
+ "description": "Which liability cap values apply: the `_internal` or `_external` amount fields. Required when `include_liability_cap` is true.",
+ "enum": [
+ "internal",
+ "external"
+ ],
+ "type": "string"
+ },
+ "include_personal_data_biographic_info": {
+ "type": "boolean"
+ },
+ "include_personal_data_contact_info": {
+ "type": "boolean"
+ },
+ "include_personal_data_custom": {
+ "type": "boolean"
+ },
+ "include_personal_data_custom_val": {
+ "type": "string"
+ },
+ "include_personal_data_employment_info": {
+ "type": "boolean"
+ },
+ "include_personal_data_financial_info": {
+ "type": "boolean"
+ },
+ "include_personal_data_location": {
+ "type": "boolean"
+ },
+ "include_personal_data_name": {
+ "type": "boolean"
+ },
+ "include_personal_data_transactional_info": {
+ "type": "boolean"
+ },
+ "include_personal_data_user_activity_info": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_custom": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_custom_val": {
+ "type": "string"
+ },
+ "include_processing_purpose_erasing": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_holding": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_protecting": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_receiving": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_returning": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_sharing": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_updating": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_using": {
+ "type": "boolean"
+ },
+ "include_provider_security_contact_address": {
+ "type": "boolean"
+ },
+ "include_provider_security_contact_address_city": {
+ "type": "string"
+ },
+ "include_provider_security_contact_address_country": {
+ "type": "string"
+ },
+ "include_provider_security_contact_address_state": {
+ "type": "string"
+ },
+ "include_provider_security_contact_address_street_address": {
+ "type": "string"
+ },
+ "include_provider_security_contact_address_zipcode": {
+ "type": "string"
+ },
+ "include_provider_security_contact_email": {
+ "type": "boolean"
+ },
+ "include_provider_security_contact_email_val": {
+ "format": "email",
+ "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "include_security_measures_accountability": {
+ "type": "boolean"
+ },
+ "include_security_measures_accountability_val": {
+ "type": "string"
+ },
+ "include_security_measures_certification_or_assurance": {
+ "type": "boolean"
+ },
+ "include_security_measures_certification_or_assurance_val": {
+ "type": "string"
+ },
+ "include_security_measures_confidentiality_integrity": {
+ "type": "boolean"
+ },
+ "include_security_measures_confidentiality_integrity_val": {
+ "type": "string"
+ },
+ "include_security_measures_data_at_rest": {
+ "type": "boolean"
+ },
+ "include_security_measures_data_at_rest_val": {
+ "type": "string"
+ },
+ "include_security_measures_data_minimization": {
+ "type": "boolean"
+ },
+ "include_security_measures_data_minimization_val": {
+ "type": "string"
+ },
+ "include_security_measures_data_quality": {
+ "type": "boolean"
+ },
+ "include_security_measures_data_quality_val": {
+ "type": "string"
+ },
+ "include_security_measures_data_retention": {
+ "type": "boolean"
+ },
+ "include_security_measures_data_retention_val": {
+ "type": "string"
+ },
+ "include_security_measures_data_transmission": {
+ "type": "boolean"
+ },
+ "include_security_measures_data_transmission_val": {
+ "type": "string"
+ },
+ "include_security_measures_event_logging": {
+ "type": "boolean"
+ },
+ "include_security_measures_event_logging_val": {
+ "type": "string"
+ },
+ "include_security_measures_identity_auth": {
+ "type": "boolean"
+ },
+ "include_security_measures_identity_auth_val": {
+ "type": "string"
+ },
+ "include_security_measures_it_security_governance": {
+ "type": "boolean"
+ },
+ "include_security_measures_it_security_governance_val": {
+ "type": "string"
+ },
+ "include_security_measures_physical_security": {
+ "type": "boolean"
+ },
+ "include_security_measures_physical_security_val": {
+ "type": "string"
+ },
+ "include_security_measures_portability_and_erasure": {
+ "type": "boolean"
+ },
+ "include_security_measures_portability_and_erasure_val": {
+ "type": "string"
+ },
+ "include_security_measures_pseudonym_encryption": {
+ "type": "boolean"
+ },
+ "include_security_measures_pseudonym_encryption_val": {
+ "type": "string"
+ },
+ "include_security_measures_restore_data_access": {
+ "type": "boolean"
+ },
+ "include_security_measures_restore_data_access_val": {
+ "type": "string"
+ },
+ "include_security_measures_security_policy": {
+ "type": "boolean"
+ },
+ "include_security_measures_system_configuration": {
+ "type": "boolean"
+ },
+ "include_security_measures_system_configuration_val": {
+ "type": "string"
+ },
+ "include_security_measures_testing_assessment": {
+ "type": "boolean"
+ },
+ "include_security_measures_testing_assessment_val": {
+ "type": "string"
+ },
+ "include_security_policy": {
+ "type": "boolean"
+ },
+ "include_security_policy_fedramp_auth": {
+ "type": "boolean"
+ },
+ "include_security_policy_hipaa": {
+ "type": "boolean"
+ },
+ "include_security_policy_hitrust": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_other": {
+ "type": "boolean"
+ },
+ "include_security_policy_iso27001": {
+ "type": "boolean"
+ },
+ "include_security_policy_other": {
+ "type": "string"
+ },
+ "include_security_policy_pci1": {
+ "type": "boolean"
+ },
+ "include_security_policy_pci2": {
+ "type": "boolean"
+ },
+ "include_security_policy_penetration_testing": {
+ "type": "boolean"
+ },
+ "include_security_policy_soc2": {
+ "type": "boolean"
+ },
+ "include_security_policy_soc2_type2": {
+ "type": "boolean"
+ },
+ "include_sensitive_data_restrictions_custom": {
+ "type": "boolean"
+ },
+ "include_sensitive_data_restrictions_custom_val": {
+ "type": "string"
+ },
+ "include_sensitive_data_restrictions_security_policy": {
+ "type": "boolean"
+ },
+ "include_service_provider_relationship": {
+ "type": "boolean"
+ },
+ "include_special_category_data": {
+ "type": "boolean"
+ },
+ "provider": {
+ "type": "string"
+ },
+ "security_policy_available_at": {
+ "type": "string"
+ },
+ "security_policy_type": {
+ "description": "Where the Security Policy is defined. For `external`, set `security_policy_available_at`.",
+ "enum": [
+ "defined in agreement",
+ "provider service",
+ "external"
+ ],
+ "type": "string"
+ },
+ "subprocessors_attributes": {
+ "additionalProperties": {
+ "additionalProperties": false,
+ "properties": {
+ "_destroy": {
+ "description": "Set to true with `id` to remove that subprocessor.",
+ "type": "boolean"
+ },
+ "country": {
+ "type": "string"
+ },
+ "id": {
+ "description": "ID of an existing subprocessor to update or remove. Omit to add a new subprocessor.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "processing_task": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "description": "Subprocessors, keyed by string index such as \"0\", \"1\". On create these are added to the template's subprocessors. On a draft update, an entry without `id` adds a new subprocessor; pass `id` to change one and `id` with `_destroy: true` to remove one.",
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+ },
+ "underlying_agreement_id": {
+ "description": "ID of the CSA this DPA supplements when `underlying_agreement_type` is `internal`.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "underlying_agreement_type": {
+ "description": "`internal` links a CSA in Common Paper (`underlying_agreement_id`, required); `external` describes another agreement in `underlying_agreement_val` (required). Defaults to `internal` when omitted on create.",
+ "enum": [
+ "internal",
+ "external"
+ ],
+ "type": "string"
+ },
+ "underlying_agreement_val": {
+ "description": "Description of the agreement this DPA supplements. Required when `underlying_agreement_type` is `external`.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "framework_terms_description": {
+ "description": "Custom framework terms description. Only used when framework_terms_type is \"description\".",
+ "type": "string"
+ },
+ "framework_terms_type": {
+ "description": "How framework terms are specified. Use \"new\" for standard terms or \"description\" to provide a custom framework_terms_description.",
+ "enum": [
+ "new",
+ "description"
+ ],
+ "type": "string"
+ },
+ "governing_law_country": {
+ "description": "The country whose laws govern the agreement.",
+ "type": "string"
+ },
+ "governing_law_region": {
+ "description": "The state or region whose laws govern the agreement.",
+ "type": "string"
+ },
+ "include_automated_payment_reminders": {
+ "description": "When true, automatically sends payment reminder emails.",
+ "type": "boolean"
+ },
+ "include_billing_info": {
+ "description": "When true, billing contact information (billing_name, billing_email) is included.",
+ "type": "boolean"
+ },
+ "include_billing_workflow": {
+ "description": "When true, enables a billing workflow after signing.",
+ "type": "boolean"
+ },
+ "include_expiration_date": {
+ "description": "Expiration date in YYYY-MM-DD format. Use when include_expiration_type is \"date\".",
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "include_expiration_days": {
+ "description": "Number of days until the agreement expires. Use when include_expiration_type is \"days\".",
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_expiration_type": {
+ "description": "How to set expiration: \"none\" (default), \"days\" (use include_expiration_days), or \"date\" (use include_expiration_date).",
+ "enum": [
+ "none",
+ "days",
+ "date"
+ ],
+ "type": "string"
+ },
+ "include_terms": {
+ "description": "When true, the standard terms are included with the agreement.",
+ "type": "boolean"
+ },
+ "loi_attributes": {
+ "additionalProperties": false,
+ "description": "Override loi terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "confidentiality_custom": {
+ "type": "string"
+ },
+ "confidentiality_mutual_include_loi": {
+ "type": "boolean"
+ },
+ "confidentiality_nda_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "confidentiality_nda_description": {
+ "type": "string"
+ },
+ "confidentiality_nda_include_loi": {
+ "type": "boolean"
+ },
+ "confidentiality_nda_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "confidentiality_type": {
+ "enum": [
+ "mutual",
+ "nda",
+ "provider",
+ "custom"
+ ],
+ "type": "string"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_custom_details": {
+ "type": "boolean"
+ },
+ "include_custom_details_val": {
+ "type": "string"
+ },
+ "include_fees": {
+ "type": "boolean"
+ },
+ "include_fees_amount": {
+ "type": "number"
+ },
+ "include_fees_amount_duration": {
+ "enum": [
+ "month",
+ "year",
+ "quarter"
+ ],
+ "type": "string"
+ },
+ "include_fees_include_amount": {
+ "type": "boolean"
+ },
+ "include_fees_include_other": {
+ "type": "boolean"
+ },
+ "include_fees_other": {
+ "type": "string"
+ },
+ "include_functionality": {
+ "type": "boolean"
+ },
+ "include_functionality_val": {
+ "type": "string"
+ },
+ "include_launch_date": {
+ "type": "boolean"
+ },
+ "include_launch_date_custom": {
+ "type": "string"
+ },
+ "include_launch_date_date": {
+ "format": "date-time",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$",
+ "type": "string"
+ },
+ "include_launch_date_type": {
+ "enum": [
+ "date",
+ "custom"
+ ],
+ "type": "string"
+ },
+ "product_name": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "manual_send": {
+ "description": "When true, the agreement is marked as manually sent outside the platform.",
+ "type": "boolean"
+ },
+ "message": {
+ "type": "string"
+ },
+ "negotiations_allowed": {
+ "description": "When true, the recipient can propose changes to the legal terms. For agreement types without separate business terms, that covers every term. CSA order forms, PSA statements of work, partnership business terms and software license order forms have their own `negotiations_allowed` flag.",
+ "type": "boolean"
+ },
+ "partnership_attributes": {
+ "additionalProperties": false,
+ "description": "Override partnership terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "effective_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "effective_date_type": {
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "type": "string"
+ },
+ "general_cap_amount_currency_val": {
+ "type": "number"
+ },
+ "general_cap_amount_either_currency": {
+ "type": "number"
+ },
+ "general_cap_amount_either_multiple": {
+ "type": "number"
+ },
+ "general_cap_amount_multiple_val": {
+ "type": "number"
+ },
+ "general_cap_amount_type": {
+ "enum": [
+ "multiple",
+ "currency",
+ "either",
+ "base"
+ ],
+ "type": "string"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_additional_warranties": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_include_company": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_include_company_val": {
+ "type": "string"
+ },
+ "include_additional_warranties_include_partner": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_include_partner_val": {
+ "type": "string"
+ },
+ "include_brand_guidelines": {
+ "type": "boolean"
+ },
+ "include_brand_guidelines_include_company": {
+ "type": "boolean"
+ },
+ "include_brand_guidelines_include_company_val": {
+ "type": "string"
+ },
+ "include_brand_guidelines_include_partner": {
+ "type": "boolean"
+ },
+ "include_brand_guidelines_include_partner_val": {
+ "type": "string"
+ },
+ "include_covered_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_company_claims": {
+ "type": "string"
+ },
+ "include_covered_claims_include_company_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_include_partner_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_partner_claims": {
+ "type": "string"
+ },
+ "include_dpa": {
+ "type": "boolean"
+ },
+ "include_dpa_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_dpa_location": {
+ "type": "string"
+ },
+ "include_dpa_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_increased_cap_amount": {
+ "type": "boolean"
+ },
+ "include_increased_cap_amount_currency": {
+ "type": "number"
+ },
+ "include_increased_cap_amount_either_currency": {
+ "type": "number"
+ },
+ "include_increased_cap_amount_either_multiple": {
+ "type": "string"
+ },
+ "include_increased_cap_amount_multiple": {
+ "type": "string"
+ },
+ "include_increased_cap_amount_type": {
+ "enum": [
+ "multiple",
+ "currency",
+ "either"
+ ],
+ "type": "string"
+ },
+ "include_increased_claims": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_confidentiality": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_confidentiality_misconduct": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_covered_claims": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_misconduct": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_other": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_other_val": {
+ "type": "string"
+ },
+ "include_unlimited_claims": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_confidentiality": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_confidentiality_misconduct": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_covered_claims": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_misconduct": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_other": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_other_val": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "partnership_business_terms_attributes": {
+ "additionalProperties": false,
+ "description": "Override partnership business terms terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "end_date_after_effective_date_amount": {
+ "type": "number"
+ },
+ "end_date_after_effective_date_unit": {
+ "enum": [
+ "month(s)",
+ "quarter(s)",
+ "year(s)"
+ ],
+ "type": "string"
+ },
+ "end_date_date": {
+ "type": "string"
+ },
+ "end_date_type": {
+ "enum": [
+ "date",
+ "effective date"
+ ],
+ "type": "string"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_obligations_company_brand": {
+ "type": "boolean"
+ },
+ "include_obligations_company_promotion": {
+ "type": "boolean"
+ },
+ "include_obligations_company_promotion_include_activities": {
+ "type": "boolean"
+ },
+ "include_obligations_company_promotion_include_activities_val": {
+ "type": "string"
+ },
+ "include_obligations_company_promotion_include_materials": {
+ "type": "boolean"
+ },
+ "include_obligations_company_promotion_include_materials_val": {
+ "type": "string"
+ },
+ "include_obligations_company_referral": {
+ "type": "boolean"
+ },
+ "include_obligations_company_referral_include_criteria": {
+ "type": "boolean"
+ },
+ "include_obligations_company_referral_include_criteria_val": {
+ "type": "string"
+ },
+ "include_obligations_company_referral_include_pay_sch": {
+ "type": "boolean"
+ },
+ "include_obligations_company_referral_include_pay_sch_amount": {
+ "type": "number"
+ },
+ "include_obligations_company_referral_include_pay_sch_custom": {
+ "type": "string"
+ },
+ "include_obligations_company_referral_include_pay_sch_unit": {
+ "enum": [
+ "U.S. Dollars",
+ "percent"
+ ],
+ "type": "string"
+ },
+ "include_obligations_company_sponsorship": {
+ "type": "boolean"
+ },
+ "include_obligations_company_sponsorship_include_benefits": {
+ "type": "boolean"
+ },
+ "include_obligations_company_sponsorship_include_benefits_val": {
+ "type": "string"
+ },
+ "include_obligations_company_sponsorship_include_payments": {
+ "type": "boolean"
+ },
+ "include_obligations_company_sponsorship_include_payments_amount": {
+ "type": "number"
+ },
+ "include_obligations_company_sponsorship_include_payments_unit": {
+ "enum": [
+ "U.S. Dollars",
+ "percent"
+ ],
+ "type": "string"
+ },
+ "include_obligations_partner_brand": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_promotion": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_promotion_include_activities": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_promotion_include_activities_val": {
+ "type": "string"
+ },
+ "include_obligations_partner_promotion_include_materials": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_promotion_include_materials_val": {
+ "type": "string"
+ },
+ "include_obligations_partner_referral": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_referral_include_criteria": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_referral_include_criteria_val": {
+ "type": "string"
+ },
+ "include_obligations_partner_referral_include_pay_sch": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_referral_include_pay_sch_amount": {
+ "type": "number"
+ },
+ "include_obligations_partner_referral_include_pay_sch_custom": {
+ "type": "string"
+ },
+ "include_obligations_partner_referral_include_pay_sch_unit": {
+ "enum": [
+ "U.S. Dollars",
+ "percent"
+ ],
+ "type": "string"
+ },
+ "include_obligations_partner_sponsorship": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_sponsorship_include_benefits": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_sponsorship_include_benefits_val": {
+ "type": "string"
+ },
+ "include_obligations_partner_sponsorship_include_payments": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_sponsorship_include_payments_amount": {
+ "type": "number"
+ },
+ "include_obligations_partner_sponsorship_include_payments_unit": {
+ "enum": [
+ "U.S. Dollars",
+ "percent"
+ ],
+ "type": "string"
+ },
+ "include_payment_process": {
+ "type": "boolean"
+ },
+ "include_payment_process_company": {
+ "type": "boolean"
+ },
+ "include_payment_process_company_include_address": {
+ "type": "boolean"
+ },
+ "include_payment_process_company_include_address_city": {
+ "type": "string"
+ },
+ "include_payment_process_company_include_address_country": {
+ "type": "string"
+ },
+ "include_payment_process_company_include_address_state": {
+ "type": "string"
+ },
+ "include_payment_process_company_include_address_street_address": {
+ "type": "string"
+ },
+ "include_payment_process_company_include_address_zipcode": {
+ "type": "string"
+ },
+ "include_payment_process_company_include_email": {
+ "type": "boolean"
+ },
+ "include_payment_process_company_include_email_val": {
+ "type": "string"
+ },
+ "include_payment_process_partner": {
+ "type": "boolean"
+ },
+ "include_payment_process_partner_include_address": {
+ "type": "boolean"
+ },
+ "include_payment_process_partner_include_address_city": {
+ "type": "string"
+ },
+ "include_payment_process_partner_include_address_country": {
+ "type": "string"
+ },
+ "include_payment_process_partner_include_address_state": {
+ "type": "string"
+ },
+ "include_payment_process_partner_include_address_street_address": {
+ "type": "string"
+ },
+ "include_payment_process_partner_include_address_zipcode": {
+ "type": "string"
+ },
+ "include_payment_process_partner_include_email": {
+ "type": "boolean"
+ },
+ "include_payment_process_partner_include_email_val": {
+ "type": "string"
+ },
+ "include_payment_schedule": {
+ "type": "boolean"
+ },
+ "include_payment_schedule_custom": {
+ "type": "string"
+ },
+ "include_payment_schedule_specified_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_payment_schedule_specified_timeframe": {
+ "enum": [
+ "receipt",
+ "date"
+ ],
+ "type": "string"
+ },
+ "include_payment_schedule_specified_unit": {
+ "enum": [
+ "day(s)",
+ "week(s)",
+ "month(s)",
+ "quarter(s)",
+ "year(s)"
+ ],
+ "type": "string"
+ },
+ "include_payment_schedule_type": {
+ "enum": [
+ "specified",
+ "custom"
+ ],
+ "type": "string"
+ },
+ "negotiations_allowed": {
+ "description": "When true, the recipient can propose changes to the business terms, even when the agreement-level `negotiations_allowed` is false. This only covers the business terms.",
+ "type": "boolean"
+ },
+ "territory_type": {
+ "enum": [
+ "worldwide",
+ "custom"
+ ],
+ "type": "string"
+ },
+ "territory_type_val": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "payment_link_url": {
+ "description": "A payment URL shown to the recipient after signing. Requires include_billing_workflow to be true and billing_workflow_type to be \"link\".",
+ "type": "string"
+ },
+ "pilot_attributes": {
+ "additionalProperties": false,
+ "description": "Override pilot terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "fees_type": {
+ "enum": [
+ "free",
+ "pilot_period_fees"
+ ],
+ "type": "string"
+ },
+ "general_cap_amount": {
+ "type": "number"
+ },
+ "general_cap_amount_type": {
+ "enum": [
+ "preceding",
+ "base",
+ "period"
+ ],
+ "type": "string"
+ },
+ "general_cap_period_currency": {
+ "type": "number"
+ },
+ "general_cap_period_qty": {
+ "type": "number"
+ },
+ "general_cap_preceding_amount": {
+ "type": "number"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_dpa": {
+ "type": "boolean"
+ },
+ "include_dpa_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_dpa_location": {
+ "type": "string"
+ },
+ "include_dpa_type": {
+ "enum": [
+ "description",
+ "attachment",
+ "standard"
+ ],
+ "type": "string"
+ },
+ "include_payment_process": {
+ "type": "boolean"
+ },
+ "include_technical_support": {
+ "type": "boolean"
+ },
+ "payment_process_automatic_frequency": {
+ "enum": [
+ "monthly",
+ "quarterly",
+ "annually",
+ "once_per_period"
+ ],
+ "type": "string"
+ },
+ "payment_process_invoice_days": {
+ "type": "number"
+ },
+ "payment_process_invoice_from": {
+ "enum": [
+ "receipt",
+ "date"
+ ],
+ "type": "string"
+ },
+ "payment_process_invoice_timeframe": {
+ "enum": [
+ "days",
+ "weeks",
+ "months",
+ "quarters",
+ "years"
+ ],
+ "type": "string"
+ },
+ "payment_process_type": {
+ "enum": [
+ "automatic",
+ "invoice"
+ ],
+ "type": "string"
+ },
+ "pilot_period_description": {
+ "type": "string"
+ },
+ "pilot_period_fees_description": {
+ "type": "string"
+ },
+ "product_description": {
+ "type": "string"
+ },
+ "technical_support_description": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "psa_attributes": {
+ "additionalProperties": false,
+ "description": "Override psa terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "additional_changes": {
+ "type": "string"
+ },
+ "customer_description": {
+ "type": "string"
+ },
+ "effective_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "effective_date_type": {
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "type": "string"
+ },
+ "general_cap_amount": {
+ "type": "number"
+ },
+ "general_cap_amount_type": {
+ "enum": [
+ "preceding",
+ "base",
+ "period"
+ ],
+ "type": "string"
+ },
+ "general_cap_period_currency": {
+ "type": "number"
+ },
+ "general_cap_period_qty": {
+ "type": "number"
+ },
+ "general_cap_preceding_amount": {
+ "type": "number"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_additional_changes": {
+ "type": "boolean"
+ },
+ "include_additional_warranties": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_by_customer": {
+ "type": "string"
+ },
+ "include_additional_warranties_by_provider": {
+ "type": "string"
+ },
+ "include_additional_warranties_include_by_customer": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_include_by_provider": {
+ "type": "boolean"
+ },
+ "include_covered_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_customer_claims": {
+ "type": "string"
+ },
+ "include_covered_claims_include_customer_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_include_provider_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_provider_claims": {
+ "type": "string"
+ },
+ "include_customer_insurance_min": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_add_provider_com_gen_liability": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_add_provider_cyber_liability": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_add_provider_errors_omissions": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_auto_liability_aggregate": {
+ "type": "number"
+ },
+ "include_customer_insurance_min_auto_liability_minimum": {
+ "type": "number"
+ },
+ "include_customer_insurance_min_cyber_liability_aggregate": {
+ "type": "number"
+ },
+ "include_customer_insurance_min_cyber_liability_minimum": {
+ "type": "number"
+ },
+ "include_customer_insurance_min_employer_liability_aggregate": {
+ "type": "number"
+ },
+ "include_customer_insurance_min_employer_liability_minimum": {
+ "type": "number"
+ },
+ "include_customer_insurance_min_general_liability_aggregate": {
+ "type": "number"
+ },
+ "include_customer_insurance_min_general_liability_minimum": {
+ "type": "number"
+ },
+ "include_customer_insurance_min_include_add_provider": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_include_auto_liability": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_include_cyber_liability": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_include_employer_liability": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_include_general_liability": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_include_workers_comp": {
+ "type": "boolean"
+ },
+ "include_customer_policies": {
+ "type": "boolean"
+ },
+ "include_customer_policies_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_customer_policies_location": {
+ "type": "string"
+ },
+ "include_customer_policies_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_dpa": {
+ "type": "boolean"
+ },
+ "include_dpa_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_dpa_location": {
+ "type": "string"
+ },
+ "include_dpa_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_increased_cap_amount": {
+ "type": "boolean"
+ },
+ "include_increased_claims": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_confidentiality": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_confidentiality_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_privsec": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_privsec_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_other": {
+ "type": "boolean"
+ },
+ "include_increased_claims_indemnification_obligation": {
+ "type": "boolean"
+ },
+ "include_increased_claims_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_other": {
+ "type": "string"
+ },
+ "include_provider_insurance_min": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_add_customer_com_gen_liability": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_add_customer_cyber_liability": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_add_customer_errors_omissions": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_auto_liability_aggregate": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_auto_liability_minimum": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_cyber_liability_aggregate": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_cyber_liability_minimum": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_employer_liability_aggregate": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_employer_liability_minimum": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_general_liability_aggregate": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_general_liability_minimum": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_include_add_customer": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_include_auto_liability": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_include_cyber_liability": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_include_employer_liability": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_include_general_liability": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_include_workers_comp": {
+ "type": "boolean"
+ },
+ "include_publicity_rights": {
+ "type": "boolean"
+ },
+ "include_publicity_rights_type": {
+ "enum": [
+ "public",
+ "non-public"
+ ],
+ "type": "string"
+ },
+ "include_security_policy": {
+ "type": "boolean"
+ },
+ "include_security_policy_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_security_policy_fedramp_auth": {
+ "type": "boolean"
+ },
+ "include_security_policy_hitrust": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_annual_maintenance": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_other": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_other_val": {
+ "type": "string"
+ },
+ "include_security_policy_iso27001": {
+ "type": "boolean"
+ },
+ "include_security_policy_location": {
+ "type": "string"
+ },
+ "include_security_policy_pci1": {
+ "type": "boolean"
+ },
+ "include_security_policy_pci2": {
+ "type": "boolean"
+ },
+ "include_security_policy_penetration_testing": {
+ "type": "boolean"
+ },
+ "include_security_policy_soc2_type1": {
+ "type": "boolean"
+ },
+ "include_security_policy_soc2_type2": {
+ "type": "boolean"
+ },
+ "include_security_policy_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_unlimited_claims": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_confidentiality": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_confidentiality_negligence": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_privsec": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_privsec_negligence": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_include_other": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_indemnification_obligation": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_negligence": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_other": {
+ "type": "string"
+ },
+ "increased_cap_amount_currency": {
+ "type": "number"
+ },
+ "increased_cap_amount_period_currency": {
+ "type": "number"
+ },
+ "increased_cap_amount_period_qty": {
+ "type": "number"
+ },
+ "increased_cap_amount_qty": {
+ "type": "number"
+ },
+ "increased_cap_amount_type": {
+ "enum": [
+ "qty",
+ "currency",
+ "period"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "psa_statement_of_work_attributes": {
+ "additionalProperties": false,
+ "description": "Override psa statement of work terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "additional_changes": {
+ "type": "string"
+ },
+ "cost": {
+ "type": "number"
+ },
+ "description": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "fees_attributes": {
+ "additionalProperties": {
+ "anyOf": [
+ {
+ "additionalProperties": false,
+ "description": "Fees::Flat (fee_type \"flat\"). A fixed recurring fee, e.g. a platform subscription. Set type to \"Fees::Flat\" or fee_type to \"flat\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Fixed amount in the order form's fees_currency, charged per fee_period. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"flat\". Alternative to type.",
+ "enum": [
+ "flat"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Flat\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Flat"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Discount (fee_type \"discount\"). A discount, as a fixed amount or a percentage, applied forever, once, or for a number of months. Set type to \"Fees::Discount\" or fee_type to \"discount\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Discount size: an amount in fees_currency when discount_type is fixed_amount (a plain amount, not cents: 20 means 20.00), or a percentage (e.g. 10 for 10%) when it is percentage.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "discount_duration_amount": {
+ "description": "Number of months the discount applies. Required when discount_duration_type is multiple_months.",
+ "type": "number"
+ },
+ "discount_duration_type": {
+ "description": "How long the discount applies. multiple_months also needs discount_duration_amount.",
+ "enum": [
+ "forever",
+ "once",
+ "multiple_months"
+ ],
+ "type": "string"
+ },
+ "discount_type": {
+ "description": "Whether cost is a currency amount or a percentage.",
+ "enum": [
+ "fixed_amount",
+ "percentage"
+ ],
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"discount\". Alternative to type.",
+ "enum": [
+ "discount"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Discount\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Discount"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Cost (fee_type \"cost\"). A per-unit fee: price per unit times quantity, e.g. seats. Set type to \"Fees::Cost\" or fee_type to \"cost\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Price per unit in fees_currency. The row total is quantity x cost. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"cost\". Alternative to type.",
+ "enum": [
+ "cost"
+ ],
+ "type": "string"
+ },
+ "quantity": {
+ "description": "Number of units.",
+ "type": "number"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Cost\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Cost"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Attachment (fee_type \"attachment\"). A fee described in an uploaded attachment instead of in the table. Set type to \"Fees::Attachment\" or fee_type to \"attachment\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "attachment_id": {
+ "description": "ID of an attachment uploaded with upload-attachment.",
+ "type": "string"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"attachment\". Alternative to type.",
+ "enum": [
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Attachment\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Attachment"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Graduated (fee_type \"graduated\"). Tiered pricing, with the price set per tier in graduated_fee_tiers_attributes. Set type to \"Fees::Graduated\" or fee_type to \"graduated\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"graduated\". Alternative to type.",
+ "enum": [
+ "graduated"
+ ],
+ "type": "string"
+ },
+ "graduated_fee_tiers_attributes": {
+ "additionalProperties": {
+ "additionalProperties": false,
+ "properties": {
+ "flat_price": {
+ "type": "number"
+ },
+ "price_per_unit": {
+ "type": "string"
+ },
+ "upper_limit": {
+ "type": "number"
+ }
+ },
+ "type": "object"
+ },
+ "description": "Graduated fee tiers. Use string keys such as \"0\", \"1\".",
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Graduated\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Graduated"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Included (fee_type \"included\"). An item included at no charge. Set type to \"Fees::Included\" or fee_type to \"included\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"included\". Alternative to type.",
+ "enum": [
+ "included"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Included\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Included"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Metered (fee_type \"metered\"). Usage-based pricing, billed per unit used. Set type to \"Fees::Metered\" or fee_type to \"metered\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Price per unit of usage in fees_currency. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"metered\". Alternative to type.",
+ "enum": [
+ "metered"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Metered\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Metered"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::OneTime (fee_type \"one_time\"). A one-time charge, such as a setup fee. Set type to \"Fees::OneTime\" or fee_type to \"one_time\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "One-time amount in fees_currency, charged once rather than per fee_period. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"one_time\". Alternative to type.",
+ "enum": [
+ "one_time"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::OneTime\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::OneTime"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Text (fee_type \"text\"). A fee term described in free text. Set type to \"Fees::Text\" or fee_type to \"text\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"text\". Alternative to type.",
+ "enum": [
+ "text"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Text\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Text"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ }
+ ]
+ },
+ "description": "Fee line items. Use string keys such as \"0\", \"1\". Replaces template fees when provided.",
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_additional_changes": {
+ "type": "boolean"
+ },
+ "include_customer_obligation": {
+ "type": "boolean"
+ },
+ "include_customer_obligation_val": {
+ "type": "string"
+ },
+ "include_deliverables": {
+ "type": "boolean"
+ },
+ "include_deliverables_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_deliverables_description": {
+ "type": "string"
+ },
+ "include_deliverables_include_acceptance": {
+ "type": "boolean"
+ },
+ "include_deliverables_include_attachment": {
+ "type": "boolean"
+ },
+ "include_deliverables_include_draft_deliverables": {
+ "type": "boolean"
+ },
+ "include_deliverables_rejection_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_deliverables_rejection_unit": {
+ "enum": [
+ "hours",
+ "days",
+ "weeks",
+ "months"
+ ],
+ "type": "string"
+ },
+ "include_deliverables_resubmission_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_deliverables_resubmission_unit": {
+ "enum": [
+ "hours",
+ "days",
+ "weeks",
+ "months"
+ ],
+ "type": "string"
+ },
+ "include_fees_other": {
+ "type": "boolean"
+ },
+ "include_fees_other_val": {
+ "type": "string"
+ },
+ "include_fees_table": {
+ "type": "boolean"
+ },
+ "include_fees_table_total": {
+ "type": "boolean"
+ },
+ "include_fees_travel": {
+ "type": "boolean"
+ },
+ "include_fees_travel_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_fees_travel_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_fees_travel_val": {
+ "type": "string"
+ },
+ "include_third_party_customer": {
+ "type": "boolean"
+ },
+ "include_third_party_include_description": {
+ "type": "boolean"
+ },
+ "include_third_party_include_description_val": {
+ "type": "string"
+ },
+ "include_third_party_materials": {
+ "type": "boolean"
+ },
+ "include_third_party_provider": {
+ "type": "boolean"
+ },
+ "include_time_of_assignment": {
+ "type": "boolean"
+ },
+ "include_time_of_assignment_type": {
+ "enum": [
+ "created",
+ "paid"
+ ],
+ "type": "string"
+ },
+ "invoice_period_description": {
+ "type": "string"
+ },
+ "negotiations_allowed": {
+ "description": "When true, the recipient can propose changes to the statement of work, even when the agreement-level `negotiations_allowed` is false. This only covers the statement of work.",
+ "type": "boolean"
+ },
+ "payment_period": {
+ "type": "number"
+ },
+ "payment_period_other": {
+ "type": "string"
+ },
+ "payment_period_timeframe": {
+ "enum": [
+ "receipt",
+ "invoice",
+ "Customer's receipt of invoice",
+ "date of invoice"
+ ],
+ "type": "string"
+ },
+ "payment_period_type": {
+ "enum": [
+ "standard",
+ "other"
+ ],
+ "type": "string"
+ },
+ "payment_period_unit": {
+ "enum": [
+ "day(s)",
+ "week(s)",
+ "month(s)",
+ "quarter(s)",
+ "year(s)"
+ ],
+ "type": "string"
+ },
+ "quantity": {
+ "type": "number"
+ },
+ "services_description": {
+ "type": "string"
+ },
+ "sow_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "sow_date_type": {
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "type": "string"
+ },
+ "sow_term_amount": {
+ "type": "number"
+ },
+ "sow_term_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "sow_term_type": {
+ "enum": [
+ "deliverables",
+ "period",
+ "date"
+ ],
+ "type": "string"
+ },
+ "sow_term_unit": {
+ "enum": [
+ "month(s)",
+ "quarter(s)",
+ "year(s)"
+ ],
+ "type": "string"
+ },
+ "type": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "recipient_email": {
+ "format": "email",
+ "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "recipient_name": {
+ "type": "string"
+ },
+ "recipient_notice_email_address": {
+ "description": "Email address for legal notices to the recipient.",
+ "format": "email",
+ "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "recipient_organization": {
+ "type": "string"
+ },
+ "recipient_role": {
+ "description": "PSA only. The recipient's role: `Customer` (the default) or `Provider`. Send it with `sender_role`; the two must be one `Provider` and one `Customer`. Other standard agreement types ignore it.",
+ "type": "string"
+ },
+ "sender_last_to_sign": {
+ "description": "When true, your signer signs after the recipient.",
+ "type": "boolean"
+ },
+ "sender_notice_email_address": {
+ "description": "Email address for legal notices to the sender.",
+ "format": "email",
+ "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "sender_role": {
+ "description": "PSA only. Your company's role: `Provider` (the default) or `Customer` when you hire the recipient to provide the services. Send it with `recipient_role`; the two must be one `Provider` and one `Customer`. When reading a PSA, an empty `sender_role` means `Provider`. Other standard agreement types ignore it.",
+ "type": "string"
+ },
+ "software_license_attributes": {
+ "additionalProperties": false,
+ "description": "Override software license terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "effective_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "effective_date_type": {
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "type": "string"
+ },
+ "general_cap_amount": {
+ "type": "number"
+ },
+ "general_cap_amount_type": {
+ "enum": [
+ "preceding",
+ "base",
+ "period"
+ ],
+ "type": "string"
+ },
+ "general_cap_period_currency": {
+ "type": "number"
+ },
+ "general_cap_period_qty": {
+ "type": "number"
+ },
+ "general_cap_preceding_amount": {
+ "type": "number"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_additional_warranties": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_by_customer": {
+ "type": "string"
+ },
+ "include_additional_warranties_by_provider": {
+ "type": "string"
+ },
+ "include_additional_warranties_include_by_customer": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_include_by_provider": {
+ "type": "boolean"
+ },
+ "include_ai_addendum": {
+ "type": "boolean"
+ },
+ "include_ai_addendum_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_covered_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_customer_claims": {
+ "type": "string"
+ },
+ "include_covered_claims_include_customer_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_include_provider_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_provider_claims": {
+ "type": "string"
+ },
+ "include_dpa": {
+ "type": "boolean"
+ },
+ "include_dpa_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_dpa_location": {
+ "type": "string"
+ },
+ "include_dpa_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_increased_cap_amount": {
+ "type": "boolean"
+ },
+ "include_increased_claims": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_confidentiality": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_confidentiality_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_other": {
+ "type": "boolean"
+ },
+ "include_increased_claims_indemnification_obligation": {
+ "type": "boolean"
+ },
+ "include_increased_claims_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_other": {
+ "type": "string"
+ },
+ "include_increased_claims_restrictions": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_confidentiality": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_confidentiality_negligence": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_include_other": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_indemnification_obligation": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_license_or_restrictions": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_negligence": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_other": {
+ "type": "string"
+ },
+ "increased_cap_amount_currency": {
+ "type": "number"
+ },
+ "increased_cap_amount_period_currency": {
+ "type": "number"
+ },
+ "increased_cap_amount_period_qty": {
+ "type": "number"
+ },
+ "increased_cap_amount_qty": {
+ "type": "number"
+ },
+ "increased_cap_amount_type": {
+ "enum": [
+ "qty",
+ "currency",
+ "period"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "software_license_order_form_attributes": {
+ "additionalProperties": false,
+ "description": "Override software license order form terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "additional_changes": {
+ "type": "string"
+ },
+ "deletion_procedure_include_custom": {
+ "type": "boolean"
+ },
+ "deletion_procedure_include_custom_description": {
+ "type": "string"
+ },
+ "deletion_procedure_include_customer_disable": {
+ "type": "boolean"
+ },
+ "deletion_procedure_include_customer_proof": {
+ "type": "boolean"
+ },
+ "deletion_procedure_include_provider_disable": {
+ "type": "boolean"
+ },
+ "fee_custom_unit": {
+ "type": "string"
+ },
+ "fee_period": {
+ "enum": [
+ "Subscription Period",
+ "month",
+ "year",
+ "Custom unit"
+ ],
+ "type": "string"
+ },
+ "fees_attributes": {
+ "additionalProperties": {
+ "anyOf": [
+ {
+ "additionalProperties": false,
+ "description": "Fees::Flat (fee_type \"flat\"). A fixed recurring fee, e.g. a platform subscription. Set type to \"Fees::Flat\" or fee_type to \"flat\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Fixed amount in the order form's fees_currency, charged per fee_period. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"flat\". Alternative to type.",
+ "enum": [
+ "flat"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Flat\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Flat"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Discount (fee_type \"discount\"). A discount, as a fixed amount or a percentage, applied forever, once, or for a number of months. Set type to \"Fees::Discount\" or fee_type to \"discount\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Discount size: an amount in fees_currency when discount_type is fixed_amount (a plain amount, not cents: 20 means 20.00), or a percentage (e.g. 10 for 10%) when it is percentage.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "discount_duration_amount": {
+ "description": "Number of months the discount applies. Required when discount_duration_type is multiple_months.",
+ "type": "number"
+ },
+ "discount_duration_type": {
+ "description": "How long the discount applies. multiple_months also needs discount_duration_amount.",
+ "enum": [
+ "forever",
+ "once",
+ "multiple_months"
+ ],
+ "type": "string"
+ },
+ "discount_type": {
+ "description": "Whether cost is a currency amount or a percentage.",
+ "enum": [
+ "fixed_amount",
+ "percentage"
+ ],
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"discount\". Alternative to type.",
+ "enum": [
+ "discount"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Discount\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Discount"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Cost (fee_type \"cost\"). A per-unit fee: price per unit times quantity, e.g. seats. Set type to \"Fees::Cost\" or fee_type to \"cost\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Price per unit in fees_currency. The row total is quantity x cost. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"cost\". Alternative to type.",
+ "enum": [
+ "cost"
+ ],
+ "type": "string"
+ },
+ "quantity": {
+ "description": "Number of units.",
+ "type": "number"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Cost\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Cost"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Attachment (fee_type \"attachment\"). A fee described in an uploaded attachment instead of in the table. Set type to \"Fees::Attachment\" or fee_type to \"attachment\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "attachment_id": {
+ "description": "ID of an attachment uploaded with upload-attachment.",
+ "type": "string"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"attachment\". Alternative to type.",
+ "enum": [
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Attachment\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Attachment"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Graduated (fee_type \"graduated\"). Tiered pricing, with the price set per tier in graduated_fee_tiers_attributes. Set type to \"Fees::Graduated\" or fee_type to \"graduated\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"graduated\". Alternative to type.",
+ "enum": [
+ "graduated"
+ ],
+ "type": "string"
+ },
+ "graduated_fee_tiers_attributes": {
+ "additionalProperties": {
+ "additionalProperties": false,
+ "properties": {
+ "flat_price": {
+ "type": "number"
+ },
+ "price_per_unit": {
+ "type": "string"
+ },
+ "upper_limit": {
+ "type": "number"
+ }
+ },
+ "type": "object"
+ },
+ "description": "Graduated fee tiers. Use string keys such as \"0\", \"1\".",
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Graduated\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Graduated"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Included (fee_type \"included\"). An item included at no charge. Set type to \"Fees::Included\" or fee_type to \"included\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"included\". Alternative to type.",
+ "enum": [
+ "included"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Included\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Included"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Metered (fee_type \"metered\"). Usage-based pricing, billed per unit used. Set type to \"Fees::Metered\" or fee_type to \"metered\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Price per unit of usage in fees_currency. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"metered\". Alternative to type.",
+ "enum": [
+ "metered"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Metered\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Metered"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::OneTime (fee_type \"one_time\"). A one-time charge, such as a setup fee. Set type to \"Fees::OneTime\" or fee_type to \"one_time\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "One-time amount in fees_currency, charged once rather than per fee_period. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"one_time\". Alternative to type.",
+ "enum": [
+ "one_time"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::OneTime\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::OneTime"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Text (fee_type \"text\"). A fee term described in free text. Set type to \"Fees::Text\" or fee_type to \"text\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"text\". Alternative to type.",
+ "enum": [
+ "text"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Text\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Text"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ }
+ ]
+ },
+ "description": "Fee line items. Use string keys such as \"0\", \"1\". Replaces template fees when provided.",
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+ },
+ "fees_currency": {
+ "enum": [
+ "USD",
+ "EUR",
+ "GBP",
+ "CAD",
+ "AUD",
+ "SGD",
+ "ILS",
+ "JPY",
+ "CHF",
+ "HKD"
+ ],
+ "type": "string"
+ },
+ "fees_include_fee_increase_upon_renewal": {
+ "type": "boolean"
+ },
+ "fees_include_fee_increase_upon_renewal_fee": {
+ "type": "number"
+ },
+ "fees_include_fee_increase_upon_renewal_type": {
+ "enum": [
+ "will",
+ "may"
+ ],
+ "type": "string"
+ },
+ "fees_inclusive_of_taxes": {
+ "type": "boolean"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_additional_changes": {
+ "type": "boolean"
+ },
+ "include_license_compliance_verification": {
+ "type": "boolean"
+ },
+ "include_license_compliance_verification_description": {
+ "type": "string"
+ },
+ "include_license_limits": {
+ "type": "boolean"
+ },
+ "include_license_limits_description": {
+ "type": "string"
+ },
+ "include_payment_process_include_billing_email": {
+ "type": "boolean"
+ },
+ "include_pilot_period": {
+ "type": "boolean"
+ },
+ "include_pilot_period_duration_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_pilot_period_duration_type": {
+ "enum": [
+ "day",
+ "week",
+ "month"
+ ],
+ "type": "string"
+ },
+ "include_pilot_period_include_fees": {
+ "type": "boolean"
+ },
+ "include_pilot_period_include_fees_amount": {
+ "type": "number"
+ },
+ "include_pilot_period_include_modifications": {
+ "type": "boolean"
+ },
+ "include_pilot_period_include_modifications_description": {
+ "type": "string"
+ },
+ "include_services": {
+ "type": "boolean"
+ },
+ "include_services_description": {
+ "type": "string"
+ },
+ "negotiations_allowed": {
+ "description": "When true, the recipient can propose changes to the order form, even when the agreement-level `negotiations_allowed` is false. This only covers the order form.",
+ "type": "boolean"
+ },
+ "order_date_date": {
+ "type": "string"
+ },
+ "order_date_type": {
+ "enum": [
+ "signature",
+ "date",
+ "other"
+ ],
+ "type": "string"
+ },
+ "payment_process_automatic_frequency": {
+ "enum": [
+ "monthly",
+ "quarterly",
+ "semiannually",
+ "annually"
+ ],
+ "type": "string"
+ },
+ "payment_process_type": {
+ "enum": [
+ "automatic",
+ "invoice",
+ "custom"
+ ],
+ "type": "string"
+ },
+ "payment_process_type_custom_val": {
+ "type": "string"
+ },
+ "payment_process_type_invoice_amount": {
+ "type": "number"
+ },
+ "payment_process_type_invoice_custom_unit": {
+ "type": "string"
+ },
+ "payment_process_type_invoice_duration": {
+ "enum": [
+ "day",
+ "week",
+ "month",
+ "year",
+ "day(s)",
+ "week(s)",
+ "month(s)",
+ "year(s)"
+ ],
+ "type": "string"
+ },
+ "payment_process_type_invoice_duration_start": {
+ "enum": [
+ "Customer's receipt of invoice",
+ "date of invoice"
+ ],
+ "type": "string"
+ },
+ "payment_process_type_invoice_type": {
+ "enum": [
+ "monthly",
+ "quarterly",
+ "semiannually",
+ "annually",
+ "Custom unit"
+ ],
+ "type": "string"
+ },
+ "permitted_uses_include_custom": {
+ "type": "boolean"
+ },
+ "permitted_uses_include_custom_description": {
+ "type": "string"
+ },
+ "permitted_uses_include_customers_affiliates": {
+ "type": "boolean"
+ },
+ "permitted_uses_include_internal_business": {
+ "type": "boolean"
+ },
+ "pilot_period_stripe_product_id": {
+ "type": "string"
+ },
+ "software_description": {
+ "type": "string"
+ },
+ "subscription_auto_renew": {
+ "enum": [
+ "days",
+ "subscription_end"
+ ],
+ "type": "string"
+ },
+ "subscription_period": {
+ "type": "number"
+ },
+ "subscription_period_unit": {
+ "type": "string"
+ },
+ "subscription_renewal_notice_days": {
+ "type": "number"
+ },
+ "warranty_period_description_amount": {
+ "type": "number"
+ },
+ "warranty_period_description_duration": {
+ "enum": [
+ "day",
+ "week",
+ "month",
+ "year"
+ ],
+ "type": "string"
+ },
+ "warranty_period_description_duration_start": {
+ "enum": [
+ "initial delivery of the Software",
+ "delivery of the Software and each subsequent Update",
+ "the Order Date"
+ ],
+ "type": "string"
+ },
+ "warranty_period_type": {
+ "enum": [
+ "description",
+ "none"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "test_agreement": {
+ "description": "When true, marks the agreement as a test. Test agreements do not count against your monthly limit.",
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "recipient_name",
+ "recipient_email"
+ ],
+ "type": "object"
+ },
+ "cc_users": {
+ "items": {
+ "format": "email",
+ "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "draft": {
+ "description": "When true, the agreement is saved as a draft and not sent to the recipient. Use POST /v1/agreements/{id}/send to send a draft agreement later.",
+ "type": "boolean"
+ },
+ "owner_email": {
+ "description": "Email address of the agreement owner (sender).",
+ "type": "string"
+ },
+ "signer_email": {
+ "description": "Email address of the signer from the owner's organization.",
+ "format": "email",
+ "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "template_id": {
+ "description": "UUID of a template from `GET /v1/templates`. Accepts both Common Paper standard templates and uploaded PDF templates (`type` `uploaded_template`).",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ }
+ },
+ "required": [
+ "template_id",
+ "owner_email",
+ "signer_email",
+ "agreement"
+ ],
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "agreement": {
+ "additionalProperties": {},
+ "properties": {
+ "amendment_attributes": {
+ "additionalProperties": false,
+ "description": "Override amendment terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "amended_terms_attributes": {
+ "additionalProperties": {
+ "additionalProperties": false,
+ "properties": {
+ "description": {
+ "type": "string"
+ },
+ "term": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "description": "Amended terms. Use string keys such as \"0\", \"1\".",
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+ },
+ "amendment_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "amendment_date_type": {
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "type": "string"
+ },
+ "framework_terms_type": {
+ "type": "string"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "parent_agreement_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "underlying_agreement_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "underlying_agreement_type": {
+ "type": "string"
+ },
+ "underlying_agreement_val": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "baa_attributes": {
+ "additionalProperties": false,
+ "description": "Override baa terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "aggregation_limitations_permitted": {
+ "type": "boolean"
+ },
+ "aggregation_limitations_permitted_val": {
+ "type": "string"
+ },
+ "breach_notification_unit": {
+ "enum": [
+ "hours",
+ "business days",
+ "calendar days"
+ ],
+ "type": "string"
+ },
+ "breach_notification_val": {
+ "type": "number"
+ },
+ "business_associate_relationship_type": {
+ "enum": [
+ "provider",
+ "company"
+ ],
+ "type": "string"
+ },
+ "deidentification_limitations_include_purpose": {
+ "type": "boolean"
+ },
+ "deidentification_limitations_include_requirements": {
+ "type": "boolean"
+ },
+ "deidentification_limitations_permitted": {
+ "type": "boolean"
+ },
+ "deidentification_limitations_purpose_val": {
+ "type": "string"
+ },
+ "deidentification_limitations_requirements_val": {
+ "type": "string"
+ },
+ "designated_record_set_provider_maintains": {
+ "type": "boolean"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_aggregation_limitations": {
+ "type": "boolean"
+ },
+ "include_deidentification_limitations": {
+ "type": "boolean"
+ },
+ "include_limitations": {
+ "type": "boolean"
+ },
+ "include_offshore_limitations": {
+ "type": "boolean"
+ },
+ "include_subcontract_limitations": {
+ "type": "boolean"
+ },
+ "offshore_limitations_permitted": {
+ "type": "boolean"
+ },
+ "offshore_limitations_permitted_val": {
+ "type": "string"
+ },
+ "subcontract_limitations_include_notice": {
+ "type": "boolean"
+ },
+ "subcontract_limitations_include_permission": {
+ "type": "boolean"
+ },
+ "subcontract_limitations_notice_val": {
+ "type": "string"
+ },
+ "subcontract_limitations_permission_val": {
+ "type": "string"
+ },
+ "subcontract_limitations_permitted": {
+ "type": "boolean"
+ },
+ "underlying_agreement_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "underlying_agreement_type": {
+ "enum": [
+ "internal",
+ "external",
+ "none"
+ ],
+ "type": "string"
+ },
+ "underlying_agreement_val": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "billing_email": {
+ "description": "Email of the billing contact. Used when include_billing_info is true.",
+ "format": "email",
+ "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "billing_name": {
+ "description": "Name of the billing contact. Used when include_billing_info is true.",
+ "type": "string"
+ },
+ "billing_workflow_type": {
+ "description": "The type of billing workflow. Use \"link\" to provide a payment_link_url, or \"stripe\" for Stripe-managed billing.",
+ "enum": [
+ "link",
+ "stripe"
+ ],
+ "type": "string"
+ },
+ "chosen_courts_country": {
+ "description": "The country in which disputes will be resolved.",
+ "type": "string"
+ },
+ "chosen_courts_region": {
+ "description": "The state or region in which disputes will be resolved.",
+ "type": "string"
+ },
+ "csa_attributes": {
+ "additionalProperties": false,
+ "description": "Override csa terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "customer_description": {
+ "type": "string"
+ },
+ "effective_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "effective_date_marketplace": {
+ "enum": [
+ "AWS",
+ "GCP",
+ "Azure"
+ ],
+ "type": "string"
+ },
+ "effective_date_type": {
+ "enum": [
+ "signature",
+ "date",
+ "marketplace_acceptance"
+ ],
+ "type": "string"
+ },
+ "general_cap_amount": {
+ "type": "number"
+ },
+ "general_cap_amount_type": {
+ "enum": [
+ "preceding",
+ "base",
+ "period"
+ ],
+ "type": "string"
+ },
+ "general_cap_period_currency": {
+ "type": "number"
+ },
+ "general_cap_period_qty": {
+ "type": "number"
+ },
+ "general_cap_preceding_amount": {
+ "type": "number"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_acceptable_use_policy": {
+ "type": "boolean"
+ },
+ "include_acceptable_use_policy_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_acceptable_use_policy_location": {
+ "type": "string"
+ },
+ "include_acceptable_use_policy_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_additional_warranties": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_by_customer": {
+ "type": "string"
+ },
+ "include_additional_warranties_by_provider": {
+ "type": "string"
+ },
+ "include_additional_warranties_include_by_customer": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_include_by_provider": {
+ "type": "boolean"
+ },
+ "include_ai_addendum": {
+ "type": "boolean"
+ },
+ "include_ai_addendum_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_covered_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_customer_claims": {
+ "type": "string"
+ },
+ "include_covered_claims_include_customer_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_include_provider_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_provider_claims": {
+ "type": "string"
+ },
+ "include_dpa": {
+ "type": "boolean"
+ },
+ "include_dpa_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_dpa_location": {
+ "type": "string"
+ },
+ "include_dpa_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_increased_cap_amount": {
+ "type": "boolean"
+ },
+ "include_increased_claims": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_confidentiality": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_confidentiality_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_privsec": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_privsec_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_other": {
+ "type": "boolean"
+ },
+ "include_increased_claims_indemnification_obligation": {
+ "type": "boolean"
+ },
+ "include_increased_claims_other": {
+ "type": "string"
+ },
+ "include_insurance_minimums": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_add_customer": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_add_customer_com_gen_liability": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_add_customer_cyber_liability": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_add_customer_errors_omissions": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_additional_information": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_additional_information_text": {
+ "type": "string"
+ },
+ "include_insurance_minimums_cyber_liability_aggregate": {
+ "type": "number"
+ },
+ "include_insurance_minimums_cyber_liability_minimum": {
+ "type": "number"
+ },
+ "include_insurance_minimums_employer_liability_aggregate": {
+ "type": "number"
+ },
+ "include_insurance_minimums_employer_liability_minimum": {
+ "type": "number"
+ },
+ "include_insurance_minimums_general_liability_aggregate": {
+ "type": "number"
+ },
+ "include_insurance_minimums_general_liability_minimum": {
+ "type": "number"
+ },
+ "include_insurance_minimums_include_cyber_liability": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_include_employer_liability": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_include_general_liability": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_include_workers_compensation": {
+ "type": "boolean"
+ },
+ "include_publicity_rights": {
+ "type": "boolean"
+ },
+ "include_publicity_rights_type": {
+ "enum": [
+ "public",
+ "non-public"
+ ],
+ "type": "string"
+ },
+ "include_security_policy": {
+ "type": "boolean"
+ },
+ "include_security_policy_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_security_policy_fedramp_auth": {
+ "type": "boolean"
+ },
+ "include_security_policy_hipaa": {
+ "type": "boolean"
+ },
+ "include_security_policy_hitrust": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_annual_maintenance": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_location": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_other": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_reasonable_efforts": {
+ "type": "boolean"
+ },
+ "include_security_policy_iso27001": {
+ "type": "boolean"
+ },
+ "include_security_policy_location": {
+ "type": "string"
+ },
+ "include_security_policy_other": {
+ "type": "string"
+ },
+ "include_security_policy_pci1": {
+ "type": "boolean"
+ },
+ "include_security_policy_pci2": {
+ "type": "boolean"
+ },
+ "include_security_policy_penetration_testing": {
+ "type": "boolean"
+ },
+ "include_security_policy_soc2": {
+ "type": "boolean"
+ },
+ "include_security_policy_soc2_type2": {
+ "type": "boolean"
+ },
+ "include_security_policy_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_supercap": {
+ "description": "CSA 3.0 renamed `include_increased_cap_amount` to `include_supercap`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_increased_cap_amount`. Sending the other spelling returns a 422.",
+ "type": "boolean"
+ },
+ "include_uncapped_claims": {
+ "description": "CSA 3.0 renamed `include_unlimited_claims` to `include_uncapped_claims`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims`. Sending the other spelling returns a 422.",
+ "type": "boolean"
+ },
+ "include_uncapped_claims_breach_of_confidentiality": {
+ "description": "CSA 3.0 renamed `include_unlimited_claims_breach_of_confidentiality` to `include_uncapped_claims_breach_of_confidentiality`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_breach_of_confidentiality`. Sending the other spelling returns a 422.",
+ "type": "boolean"
+ },
+ "include_uncapped_claims_breach_of_confidentiality_negligence": {
+ "description": "CSA 3.0 renamed `include_unlimited_claims_breach_of_confidentiality_negligence` to `include_uncapped_claims_breach_of_confidentiality_negligence`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_breach_of_confidentiality_negligence`. Sending the other spelling returns a 422.",
+ "type": "boolean"
+ },
+ "include_uncapped_claims_breach_of_privsec": {
+ "description": "CSA 3.0 renamed `include_unlimited_claims_breach_of_privsec` to `include_uncapped_claims_breach_of_privsec`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_breach_of_privsec`. Sending the other spelling returns a 422.",
+ "type": "boolean"
+ },
+ "include_uncapped_claims_breach_of_privsec_negligence": {
+ "description": "CSA 3.0 renamed `include_unlimited_claims_breach_of_privsec_negligence` to `include_uncapped_claims_breach_of_privsec_negligence`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_breach_of_privsec_negligence`. Sending the other spelling returns a 422.",
+ "type": "boolean"
+ },
+ "include_uncapped_claims_include_other": {
+ "description": "CSA 3.0 renamed `include_unlimited_claims_include_other` to `include_uncapped_claims_include_other`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_include_other`. Sending the other spelling returns a 422.",
+ "type": "boolean"
+ },
+ "include_uncapped_claims_indemnification_obligation": {
+ "description": "CSA 3.0 renamed `include_unlimited_claims_indemnification_obligation` to `include_uncapped_claims_indemnification_obligation`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_indemnification_obligation`. Sending the other spelling returns a 422.",
+ "type": "boolean"
+ },
+ "include_uncapped_claims_other": {
+ "description": "CSA 3.0 renamed `include_unlimited_claims_other` to `include_uncapped_claims_other`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_other`. Sending the other spelling returns a 422.",
+ "type": "boolean"
+ },
+ "include_unlimited_claims": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_confidentiality": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_confidentiality_negligence": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_privsec": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_privsec_negligence": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_include_other": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_indemnification_obligation": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_other": {
+ "type": "string"
+ },
+ "increased_cap_amount_currency": {
+ "type": "number"
+ },
+ "increased_cap_amount_period_currency": {
+ "type": "number"
+ },
+ "increased_cap_amount_period_qty": {
+ "type": "number"
+ },
+ "increased_cap_amount_qty": {
+ "type": "number"
+ },
+ "increased_cap_amount_type": {
+ "enum": [
+ "qty",
+ "currency",
+ "period"
+ ],
+ "type": "string"
+ },
+ "provider": {
+ "type": "string"
+ },
+ "supercap_currency": {
+ "description": "CSA 3.0 renamed `increased_cap_amount_currency` to `supercap_currency`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `increased_cap_amount_currency`. Sending the other spelling returns a 422.",
+ "type": "number"
+ },
+ "supercap_period_currency": {
+ "description": "CSA 3.0 renamed `increased_cap_amount_period_currency` to `supercap_period_currency`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `increased_cap_amount_period_currency`. Sending the other spelling returns a 422.",
+ "type": "number"
+ },
+ "supercap_period_qty": {
+ "description": "CSA 3.0 renamed `increased_cap_amount_period_qty` to `supercap_period_qty`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `increased_cap_amount_period_qty`. Sending the other spelling returns a 422.",
+ "type": "number"
+ },
+ "supercap_qty": {
+ "description": "CSA 3.0 renamed `increased_cap_amount_qty` to `supercap_qty`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `increased_cap_amount_qty`. Sending the other spelling returns a 422.",
+ "type": "number"
+ },
+ "supercap_type": {
+ "description": "CSA 3.0 renamed `increased_cap_amount_type` to `supercap_type`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `increased_cap_amount_type`. Sending the other spelling returns a 422.",
+ "type": "number"
+ }
+ },
+ "type": "object"
+ },
+ "csa_order_form_attributes": {
+ "additionalProperties": false,
+ "description": "Override csa order form terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "additional_changes": {
+ "type": "string"
+ },
+ "additional_parameters_or_limitations": {
+ "type": "string"
+ },
+ "affiliates_as_users": {
+ "type": "boolean"
+ },
+ "cloud_service_description": {
+ "type": "string"
+ },
+ "consumption_units": {
+ "type": "string"
+ },
+ "fee_amount": {
+ "type": "number"
+ },
+ "fee_custom_unit": {
+ "type": "string"
+ },
+ "fee_period": {
+ "enum": [
+ "Subscription Period",
+ "month",
+ "year",
+ "User",
+ "Custom unit"
+ ],
+ "type": "string"
+ },
+ "fees_attributes": {
+ "additionalProperties": {
+ "anyOf": [
+ {
+ "additionalProperties": false,
+ "description": "Fees::Flat (fee_type \"flat\"). A fixed recurring fee, e.g. a platform subscription. Set type to \"Fees::Flat\" or fee_type to \"flat\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Fixed amount in the order form's fees_currency, charged per fee_period. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"flat\". Alternative to type.",
+ "enum": [
+ "flat"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Flat\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Flat"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Discount (fee_type \"discount\"). A discount, as a fixed amount or a percentage, applied forever, once, or for a number of months. Set type to \"Fees::Discount\" or fee_type to \"discount\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Discount size: an amount in fees_currency when discount_type is fixed_amount (a plain amount, not cents: 20 means 20.00), or a percentage (e.g. 10 for 10%) when it is percentage.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "discount_duration_amount": {
+ "description": "Number of months the discount applies. Required when discount_duration_type is multiple_months.",
+ "type": "number"
+ },
+ "discount_duration_type": {
+ "description": "How long the discount applies. multiple_months also needs discount_duration_amount.",
+ "enum": [
+ "forever",
+ "once",
+ "multiple_months"
+ ],
+ "type": "string"
+ },
+ "discount_type": {
+ "description": "Whether cost is a currency amount or a percentage.",
+ "enum": [
+ "fixed_amount",
+ "percentage"
+ ],
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"discount\". Alternative to type.",
+ "enum": [
+ "discount"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Discount\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Discount"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Cost (fee_type \"cost\"). A per-unit fee: price per unit times quantity, e.g. seats. Set type to \"Fees::Cost\" or fee_type to \"cost\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Price per unit in fees_currency. The row total is quantity x cost. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"cost\". Alternative to type.",
+ "enum": [
+ "cost"
+ ],
+ "type": "string"
+ },
+ "quantity": {
+ "description": "Number of units.",
+ "type": "number"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Cost\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Cost"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Attachment (fee_type \"attachment\"). A fee described in an uploaded attachment instead of in the table. Set type to \"Fees::Attachment\" or fee_type to \"attachment\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "attachment_id": {
+ "description": "ID of an attachment uploaded with upload-attachment.",
+ "type": "string"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"attachment\". Alternative to type.",
+ "enum": [
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Attachment\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Attachment"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Graduated (fee_type \"graduated\"). Tiered pricing, with the price set per tier in graduated_fee_tiers_attributes. Set type to \"Fees::Graduated\" or fee_type to \"graduated\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"graduated\". Alternative to type.",
+ "enum": [
+ "graduated"
+ ],
+ "type": "string"
+ },
+ "graduated_fee_tiers_attributes": {
+ "additionalProperties": {
+ "additionalProperties": false,
+ "properties": {
+ "flat_price": {
+ "type": "number"
+ },
+ "price_per_unit": {
+ "type": "string"
+ },
+ "upper_limit": {
+ "type": "number"
+ }
+ },
+ "type": "object"
+ },
+ "description": "Graduated fee tiers. Use string keys such as \"0\", \"1\".",
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Graduated\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Graduated"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Included (fee_type \"included\"). An item included at no charge. Set type to \"Fees::Included\" or fee_type to \"included\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"included\". Alternative to type.",
+ "enum": [
+ "included"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Included\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Included"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Metered (fee_type \"metered\"). Usage-based pricing, billed per unit used. Set type to \"Fees::Metered\" or fee_type to \"metered\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Price per unit of usage in fees_currency. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"metered\". Alternative to type.",
+ "enum": [
+ "metered"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Metered\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Metered"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::OneTime (fee_type \"one_time\"). A one-time charge, such as a setup fee. Set type to \"Fees::OneTime\" or fee_type to \"one_time\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "One-time amount in fees_currency, charged once rather than per fee_period. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"one_time\". Alternative to type.",
+ "enum": [
+ "one_time"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::OneTime\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::OneTime"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Text (fee_type \"text\"). A fee term described in free text. Set type to \"Fees::Text\" or fee_type to \"text\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"text\". Alternative to type.",
+ "enum": [
+ "text"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Text\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Text"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ }
+ ]
+ },
+ "description": "Fee table rows, keyed by string index (\"0\", \"1\", ...). Replaces the template's fees when provided. Each row sets type or fee_type to pick the fee class. Amounts are in the order form's fees_currency and, for recurring fees, are charged per fee_period.",
+ "examples": [
+ {
+ "0": {
+ "cost": 2000,
+ "description": "Platform subscription",
+ "type": "Fees::Flat"
+ }
+ },
+ {
+ "0": {
+ "cost": 50,
+ "description": "Seats",
+ "fee_type": "cost",
+ "quantity": 10
+ },
+ "1": {
+ "cost": 10,
+ "description": "Launch discount",
+ "discount_duration_amount": 3,
+ "discount_duration_type": "multiple_months",
+ "discount_type": "percentage",
+ "fee_type": "discount"
+ }
+ }
+ ],
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+ },
+ "fees_currency": {
+ "enum": [
+ "USD",
+ "EUR",
+ "GBP",
+ "CAD",
+ "AUD",
+ "SGD",
+ "ILS",
+ "JPY",
+ "CHF",
+ "HKD"
+ ],
+ "type": "string"
+ },
+ "fees_include_fee_increase_upon_renewal": {
+ "type": "boolean"
+ },
+ "fees_include_fee_increase_upon_renewal_fee": {
+ "type": "number"
+ },
+ "fees_include_fee_increase_upon_renewal_type": {
+ "enum": [
+ "will",
+ "may"
+ ],
+ "type": "string"
+ },
+ "fees_inclusive_of_taxes": {
+ "type": "boolean"
+ },
+ "framework_terms_type": {
+ "enum": [
+ "new",
+ "existing",
+ "description"
+ ],
+ "type": "string"
+ },
+ "free_trial_days": {
+ "type": "number"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_additional_changes": {
+ "type": "boolean"
+ },
+ "include_additional_parameters_or_limitations": {
+ "type": "boolean"
+ },
+ "include_consumption": {
+ "type": "boolean"
+ },
+ "include_fees": {
+ "type": "boolean"
+ },
+ "include_fees_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_fees_include_attachment": {
+ "type": "boolean"
+ },
+ "include_fees_other": {
+ "type": "boolean"
+ },
+ "include_fees_other_val": {
+ "type": "string"
+ },
+ "include_fees_table": {
+ "type": "boolean"
+ },
+ "include_fees_table_period": {
+ "enum": [
+ "Subscription Period",
+ "month",
+ "year",
+ "User"
+ ],
+ "type": "string"
+ },
+ "include_free_trial": {
+ "type": "boolean"
+ },
+ "include_max_users": {
+ "type": "boolean"
+ },
+ "include_pilot_period": {
+ "type": "boolean"
+ },
+ "include_pilot_period_duration_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_pilot_period_duration_type": {
+ "enum": [
+ "day",
+ "week",
+ "month"
+ ],
+ "type": "string"
+ },
+ "include_pilot_period_include_fees": {
+ "type": "boolean"
+ },
+ "include_pilot_period_include_fees_amount": {
+ "type": "number"
+ },
+ "include_pilot_period_include_modifications": {
+ "type": "boolean"
+ },
+ "include_pilot_period_include_modifications_description": {
+ "type": "string"
+ },
+ "include_product_support": {
+ "type": "boolean"
+ },
+ "include_product_support_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_product_support_description": {
+ "type": "string"
+ },
+ "include_product_support_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_professional_services": {
+ "type": "boolean"
+ },
+ "include_professional_services_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_professional_services_custom_name": {
+ "type": "string"
+ },
+ "include_professional_services_description": {
+ "type": "string"
+ },
+ "include_professional_services_end_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "include_professional_services_fees_description": {
+ "type": "string"
+ },
+ "include_professional_services_include_end_date": {
+ "type": "boolean"
+ },
+ "include_professional_services_include_fees_description": {
+ "type": "boolean"
+ },
+ "include_professional_services_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_sla": {
+ "type": "boolean"
+ },
+ "include_sla_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_sla_description": {
+ "type": "string"
+ },
+ "include_sla_include_response_time": {
+ "type": "boolean"
+ },
+ "include_sla_include_response_time_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_sla_include_response_time_credit": {
+ "type": "number"
+ },
+ "include_sla_include_response_time_duration": {
+ "enum": [
+ "hour",
+ "day",
+ "week",
+ "month",
+ "hours"
+ ],
+ "type": "string"
+ },
+ "include_sla_include_response_time_support_channel": {
+ "type": "string"
+ },
+ "include_sla_include_target_uptime": {
+ "type": "boolean"
+ },
+ "include_sla_maintenance_notice": {
+ "type": "boolean"
+ },
+ "include_sla_maintenance_window": {
+ "type": "boolean"
+ },
+ "include_sla_maintenance_window_type": {
+ "enum": [
+ "standard",
+ "none"
+ ],
+ "type": "string"
+ },
+ "include_sla_standard_maintenance_notice_qty": {
+ "type": "number"
+ },
+ "include_sla_standard_maintenance_notice_unit": {
+ "enum": [
+ "hour",
+ "day",
+ "week",
+ "month"
+ ],
+ "type": "string"
+ },
+ "include_sla_standard_maintenance_window_end_time": {
+ "type": "string"
+ },
+ "include_sla_standard_maintenance_window_friday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_monday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_saturday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_start_time": {
+ "type": "string"
+ },
+ "include_sla_standard_maintenance_window_sunday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_thursday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_time_zone": {
+ "type": "string"
+ },
+ "include_sla_standard_maintenance_window_tuesday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_wednesday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_target_uptime": {
+ "type": "number"
+ },
+ "include_sla_type": {
+ "enum": [
+ "description",
+ "standard",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_subscription_start_date": {
+ "type": "boolean"
+ },
+ "include_subscription_start_date_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "include_usage_review": {
+ "type": "boolean"
+ },
+ "include_usage_review_val": {
+ "type": "string"
+ },
+ "include_use_limitations": {
+ "type": "boolean"
+ },
+ "include_use_limitations_val": {
+ "type": "string"
+ },
+ "invoice_period": {
+ "enum": [
+ "monthly",
+ "quarterly",
+ "semiannually",
+ "annually",
+ "Custom unit",
+ "Monthly",
+ "Quarterly",
+ "Semiannually",
+ "Annually"
+ ],
+ "type": "string"
+ },
+ "invoice_period_custom_unit": {
+ "type": "string"
+ },
+ "max_consumption": {
+ "type": "number"
+ },
+ "max_users": {
+ "type": "number"
+ },
+ "negotiations_allowed": {
+ "description": "When true, the recipient can propose changes to the order form, even when the agreement-level `negotiations_allowed` is false. This only covers the order form.",
+ "type": "boolean"
+ },
+ "order_date_date": {
+ "type": "string"
+ },
+ "order_date_other": {
+ "type": "string"
+ },
+ "order_date_type": {
+ "enum": [
+ "signature",
+ "date",
+ "other"
+ ],
+ "type": "string"
+ },
+ "payment_period": {
+ "type": "number"
+ },
+ "payment_period_timeframe": {
+ "enum": [
+ "Customer's receipt of invoice",
+ "date of invoice"
+ ],
+ "type": "string"
+ },
+ "payment_period_unit": {
+ "enum": [
+ "day(s)",
+ "week(s)",
+ "month(s)",
+ "marketplace_acceptance"
+ ],
+ "type": "string"
+ },
+ "payment_process_automatic_frequency": {
+ "enum": [
+ "monthly",
+ "quarterly",
+ "semiannually",
+ "annually"
+ ],
+ "type": "string"
+ },
+ "payment_process_type": {
+ "enum": [
+ "automatic",
+ "invoice",
+ "custom",
+ "marketplace_acceptance"
+ ],
+ "type": "string"
+ },
+ "payment_process_type_custom_val": {
+ "type": "string"
+ },
+ "payment_process_type_invoice_amount": {
+ "type": "number"
+ },
+ "payment_process_type_invoice_custom_unit": {
+ "type": "string"
+ },
+ "payment_process_type_invoice_duration": {
+ "enum": [
+ "day",
+ "week",
+ "month",
+ "year",
+ "day(s)",
+ "week(s)",
+ "month(s)",
+ "year(s)"
+ ],
+ "type": "string"
+ },
+ "payment_process_type_invoice_duration_start": {
+ "enum": [
+ "Customer's receipt of invoice",
+ "date of invoice"
+ ],
+ "type": "string"
+ },
+ "payment_process_type_invoice_type": {
+ "enum": [
+ "monthly",
+ "quarterly",
+ "semiannually",
+ "annually",
+ "Custom unit"
+ ],
+ "type": "string"
+ },
+ "pilot_period_stripe_product_id": {
+ "type": "string"
+ },
+ "service_credits_attributes": {
+ "additionalProperties": {
+ "additionalProperties": false,
+ "properties": {
+ "credit": {
+ "type": "number"
+ },
+ "max": {
+ "type": "number"
+ },
+ "min": {
+ "type": "number"
+ }
+ },
+ "type": "object"
+ },
+ "description": "Service credits. Use string keys such as \"0\", \"1\".",
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+ },
+ "subscription_auto_renew": {
+ "enum": [
+ "days",
+ "subscription_end"
+ ],
+ "type": "string"
+ },
+ "subscription_period": {
+ "type": "number"
+ },
+ "subscription_period_unit": {
+ "type": "string"
+ },
+ "subscription_renewal_notice_days": {
+ "type": "number"
+ },
+ "subscription_start_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "subscription_start_date_type": {
+ "enum": [
+ "effective_date",
+ "date"
+ ],
+ "type": "string"
+ },
+ "underlying_agreement_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "use_limitations_attributes": {
+ "additionalProperties": {
+ "additionalProperties": false,
+ "properties": {
+ "amount": {
+ "type": "number"
+ },
+ "limitation_type": {
+ "type": "string"
+ },
+ "unit": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "description": "Use limitations. Use string keys such as \"0\", \"1\".",
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+ }
+ },
+ "type": "object"
+ },
+ "custom_field_values": {
+ "description": "Values for a custom template's fields, keyed by the field keys defined in the template's YAML definition. Only used when template_id is a custom template. Template defaults fill any fields you omit; a required field with no default and no submitted value returns a 400 naming the field. Values are validated against the field's input type: select and radio values must be one of the field's options, multiselect values are an array of selections each of which must be one of the field's options, number and currency values must be numeric, date values must be YYYY-MM-DD, and email values must be valid addresses. An invalid value returns a 400 naming the field."
+ },
+ "design_partner_attributes": {
+ "additionalProperties": false,
+ "description": "Override design partner terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "customer_description": {
+ "type": "string"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_fees": {
+ "type": "boolean"
+ },
+ "include_fees_amount": {
+ "type": "number"
+ },
+ "include_fees_description": {
+ "type": "string"
+ },
+ "include_fees_pay_by_amount": {
+ "type": "string"
+ },
+ "include_fees_type": {
+ "enum": [
+ "default_language",
+ "description"
+ ],
+ "type": "string"
+ },
+ "include_fees_unit": {
+ "enum": [
+ "month",
+ "quarter",
+ "year",
+ "Term"
+ ],
+ "type": "string"
+ },
+ "include_program_appear_as_customer_private": {
+ "type": "boolean"
+ },
+ "include_program_appear_as_customer_public": {
+ "type": "boolean"
+ },
+ "include_program_case_study": {
+ "type": "boolean"
+ },
+ "include_program_develop_functionality": {
+ "type": "boolean"
+ },
+ "include_program_develop_functionality_val": {
+ "type": "string"
+ },
+ "include_program_discount": {
+ "type": "boolean"
+ },
+ "include_program_discount_amount": {
+ "type": "number"
+ },
+ "include_program_discount_unit": {
+ "enum": [
+ "U.S. Dollars",
+ "percent"
+ ],
+ "type": "string"
+ },
+ "include_program_participation_feedback": {
+ "type": "boolean"
+ },
+ "include_program_participation_feedback_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_program_participation_feedback_unit": {
+ "enum": [
+ "month",
+ "quarter",
+ "year",
+ "Term"
+ ],
+ "type": "string"
+ },
+ "include_program_partner_other": {
+ "type": "boolean"
+ },
+ "include_program_partner_other_val": {
+ "type": "string"
+ },
+ "include_program_provider_other": {
+ "type": "boolean"
+ },
+ "include_program_provider_other_val": {
+ "type": "string"
+ },
+ "include_program_reference": {
+ "type": "boolean"
+ },
+ "product_description": {
+ "type": "string"
+ },
+ "term_amount": {
+ "type": "number"
+ },
+ "term_unit": {
+ "enum": [
+ "day(s)",
+ "week(s)",
+ "month(s)",
+ "quarter(s)",
+ "year(s)"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "district_or_county": {
+ "description": "The district or county for dispute resolution.",
+ "type": "string"
+ },
+ "dpa_attributes": {
+ "additionalProperties": false,
+ "description": "Override dpa terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "approved_subprocessor_type": {
+ "description": "`internal` lists approved subprocessors in the agreement (`subprocessors_attributes`); `external` points to a list published elsewhere.",
+ "enum": [
+ "internal",
+ "external"
+ ],
+ "type": "string"
+ },
+ "cloud_service_product_name": {
+ "type": "string"
+ },
+ "competent_supervisory_authority": {
+ "type": "string"
+ },
+ "customer_description": {
+ "type": "string"
+ },
+ "data_exporter_address_city": {
+ "type": "string"
+ },
+ "data_exporter_address_country": {
+ "type": "string"
+ },
+ "data_exporter_address_state": {
+ "type": "string"
+ },
+ "data_exporter_address_street_address": {
+ "type": "string"
+ },
+ "data_exporter_address_zipcode": {
+ "type": "string"
+ },
+ "data_exporter_contact_details": {
+ "type": "string"
+ },
+ "data_exporter_contact_name": {
+ "type": "string"
+ },
+ "data_exporter_contact_position": {
+ "type": "string"
+ },
+ "data_exporter_role": {
+ "description": "Role of the data exporter. Overwritten to `Controller` when the agreement is created from a template.",
+ "enum": [
+ "Controller",
+ "Processor"
+ ],
+ "type": "string"
+ },
+ "data_importer_address": {
+ "type": "string"
+ },
+ "data_importer_address_city": {
+ "type": "string"
+ },
+ "data_importer_address_country": {
+ "type": "string"
+ },
+ "data_importer_address_state": {
+ "type": "string"
+ },
+ "data_importer_address_street_address": {
+ "type": "string"
+ },
+ "data_importer_address_zipcode": {
+ "type": "string"
+ },
+ "data_importer_contact_details": {
+ "type": "string"
+ },
+ "data_importer_contact_name": {
+ "type": "string"
+ },
+ "data_importer_contact_position": {
+ "type": "string"
+ },
+ "duration_of_processing": {
+ "type": "string"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_covered_claim": {
+ "type": "boolean"
+ },
+ "include_covered_claim_external_val": {
+ "type": "string"
+ },
+ "include_covered_claim_internal_val": {
+ "type": "string"
+ },
+ "include_covered_claim_type": {
+ "description": "Which covered-claim text applies: `internal` uses `include_covered_claim_internal_val`, `external` uses `include_covered_claim_external_val`. Required when `include_covered_claim` is true.",
+ "enum": [
+ "internal",
+ "external"
+ ],
+ "type": "string"
+ },
+ "include_data_subjects_custom": {
+ "type": "boolean"
+ },
+ "include_data_subjects_custom_val": {
+ "type": "string"
+ },
+ "include_data_subjects_employees": {
+ "type": "boolean"
+ },
+ "include_data_subjects_end_users": {
+ "type": "boolean"
+ },
+ "include_external_subprocessor_location": {
+ "type": "string"
+ },
+ "include_frequency_of_transfer_continuous": {
+ "type": "boolean"
+ },
+ "include_frequency_of_transfer_custom": {
+ "type": "boolean"
+ },
+ "include_frequency_of_transfer_custom_val": {
+ "type": "string"
+ },
+ "include_governing_country_eu": {
+ "type": "boolean"
+ },
+ "include_governing_country_eu_val": {
+ "type": "string"
+ },
+ "include_governing_country_uk": {
+ "type": "boolean"
+ },
+ "include_governing_country_uk_val": {
+ "type": "string"
+ },
+ "include_governing_law": {
+ "type": "boolean"
+ },
+ "include_governing_law_country": {
+ "type": "string"
+ },
+ "include_governing_law_state": {
+ "type": "string"
+ },
+ "include_increased_claim_amount": {
+ "description": "Legacy field. Stored but not shown on the DPA; use the `include_liability_cap*` fields instead.",
+ "type": "boolean"
+ },
+ "include_increased_claim_amount_currency": {
+ "description": "Legacy field. Stored but not shown on the DPA; use the `include_liability_cap*` fields instead."
+ },
+ "include_increased_claim_amount_qty": {
+ "description": "Legacy field. Stored but not shown on the DPA; use the `include_liability_cap*` fields instead."
+ },
+ "include_increased_claim_amount_type": {
+ "description": "Legacy field. Stored but not shown on the DPA; use the `include_liability_cap*` fields instead.",
+ "type": "string"
+ },
+ "include_liability_cap": {
+ "type": "boolean"
+ },
+ "include_liability_cap_amount_constant_external": {
+ "type": "string"
+ },
+ "include_liability_cap_amount_constant_internal": {
+ "type": "string"
+ },
+ "include_liability_cap_amount_currency_external": {
+ "description": "Currency amount. Numbers and numeric strings (commas allowed) are both accepted."
+ },
+ "include_liability_cap_amount_currency_internal": {
+ "description": "Currency amount. Numbers and numeric strings (commas allowed) are both accepted."
+ },
+ "include_liability_cap_csa_type": {
+ "description": "Which liability cap values apply: the `_internal` or `_external` amount fields. Required when `include_liability_cap` is true.",
+ "enum": [
+ "internal",
+ "external"
+ ],
+ "type": "string"
+ },
+ "include_personal_data_biographic_info": {
+ "type": "boolean"
+ },
+ "include_personal_data_contact_info": {
+ "type": "boolean"
+ },
+ "include_personal_data_custom": {
+ "type": "boolean"
+ },
+ "include_personal_data_custom_val": {
+ "type": "string"
+ },
+ "include_personal_data_employment_info": {
+ "type": "boolean"
+ },
+ "include_personal_data_financial_info": {
+ "type": "boolean"
+ },
+ "include_personal_data_location": {
+ "type": "boolean"
+ },
+ "include_personal_data_name": {
+ "type": "boolean"
+ },
+ "include_personal_data_transactional_info": {
+ "type": "boolean"
+ },
+ "include_personal_data_user_activity_info": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_custom": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_custom_val": {
+ "type": "string"
+ },
+ "include_processing_purpose_erasing": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_holding": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_protecting": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_receiving": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_returning": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_sharing": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_updating": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_using": {
+ "type": "boolean"
+ },
+ "include_provider_security_contact_address": {
+ "type": "boolean"
+ },
+ "include_provider_security_contact_address_city": {
+ "type": "string"
+ },
+ "include_provider_security_contact_address_country": {
+ "type": "string"
+ },
+ "include_provider_security_contact_address_state": {
+ "type": "string"
+ },
+ "include_provider_security_contact_address_street_address": {
+ "type": "string"
+ },
+ "include_provider_security_contact_address_zipcode": {
+ "type": "string"
+ },
+ "include_provider_security_contact_email": {
+ "type": "boolean"
+ },
+ "include_provider_security_contact_email_val": {
+ "format": "email",
+ "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "include_security_measures_accountability": {
+ "type": "boolean"
+ },
+ "include_security_measures_accountability_val": {
+ "type": "string"
+ },
+ "include_security_measures_certification_or_assurance": {
+ "type": "boolean"
+ },
+ "include_security_measures_certification_or_assurance_val": {
+ "type": "string"
+ },
+ "include_security_measures_confidentiality_integrity": {
+ "type": "boolean"
+ },
+ "include_security_measures_confidentiality_integrity_val": {
+ "type": "string"
+ },
+ "include_security_measures_data_at_rest": {
+ "type": "boolean"
+ },
+ "include_security_measures_data_at_rest_val": {
+ "type": "string"
+ },
+ "include_security_measures_data_minimization": {
+ "type": "boolean"
+ },
+ "include_security_measures_data_minimization_val": {
+ "type": "string"
+ },
+ "include_security_measures_data_quality": {
+ "type": "boolean"
+ },
+ "include_security_measures_data_quality_val": {
+ "type": "string"
+ },
+ "include_security_measures_data_retention": {
+ "type": "boolean"
+ },
+ "include_security_measures_data_retention_val": {
+ "type": "string"
+ },
+ "include_security_measures_data_transmission": {
+ "type": "boolean"
+ },
+ "include_security_measures_data_transmission_val": {
+ "type": "string"
+ },
+ "include_security_measures_event_logging": {
+ "type": "boolean"
+ },
+ "include_security_measures_event_logging_val": {
+ "type": "string"
+ },
+ "include_security_measures_identity_auth": {
+ "type": "boolean"
+ },
+ "include_security_measures_identity_auth_val": {
+ "type": "string"
+ },
+ "include_security_measures_it_security_governance": {
+ "type": "boolean"
+ },
+ "include_security_measures_it_security_governance_val": {
+ "type": "string"
+ },
+ "include_security_measures_physical_security": {
+ "type": "boolean"
+ },
+ "include_security_measures_physical_security_val": {
+ "type": "string"
+ },
+ "include_security_measures_portability_and_erasure": {
+ "type": "boolean"
+ },
+ "include_security_measures_portability_and_erasure_val": {
+ "type": "string"
+ },
+ "include_security_measures_pseudonym_encryption": {
+ "type": "boolean"
+ },
+ "include_security_measures_pseudonym_encryption_val": {
+ "type": "string"
+ },
+ "include_security_measures_restore_data_access": {
+ "type": "boolean"
+ },
+ "include_security_measures_restore_data_access_val": {
+ "type": "string"
+ },
+ "include_security_measures_security_policy": {
+ "type": "boolean"
+ },
+ "include_security_measures_system_configuration": {
+ "type": "boolean"
+ },
+ "include_security_measures_system_configuration_val": {
+ "type": "string"
+ },
+ "include_security_measures_testing_assessment": {
+ "type": "boolean"
+ },
+ "include_security_measures_testing_assessment_val": {
+ "type": "string"
+ },
+ "include_security_policy": {
+ "type": "boolean"
+ },
+ "include_security_policy_fedramp_auth": {
+ "type": "boolean"
+ },
+ "include_security_policy_hipaa": {
+ "type": "boolean"
+ },
+ "include_security_policy_hitrust": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_other": {
+ "type": "boolean"
+ },
+ "include_security_policy_iso27001": {
+ "type": "boolean"
+ },
+ "include_security_policy_other": {
+ "type": "string"
+ },
+ "include_security_policy_pci1": {
+ "type": "boolean"
+ },
+ "include_security_policy_pci2": {
+ "type": "boolean"
+ },
+ "include_security_policy_penetration_testing": {
+ "type": "boolean"
+ },
+ "include_security_policy_soc2": {
+ "type": "boolean"
+ },
+ "include_security_policy_soc2_type2": {
+ "type": "boolean"
+ },
+ "include_sensitive_data_restrictions_custom": {
+ "type": "boolean"
+ },
+ "include_sensitive_data_restrictions_custom_val": {
+ "type": "string"
+ },
+ "include_sensitive_data_restrictions_security_policy": {
+ "type": "boolean"
+ },
+ "include_service_provider_relationship": {
+ "type": "boolean"
+ },
+ "include_special_category_data": {
+ "type": "boolean"
+ },
+ "provider": {
+ "type": "string"
+ },
+ "security_policy_available_at": {
+ "type": "string"
+ },
+ "security_policy_type": {
+ "description": "Where the Security Policy is defined. For `external`, set `security_policy_available_at`.",
+ "enum": [
+ "defined in agreement",
+ "provider service",
+ "external"
+ ],
+ "type": "string"
+ },
+ "subprocessors_attributes": {
+ "additionalProperties": {
+ "additionalProperties": false,
+ "properties": {
+ "_destroy": {
+ "description": "Set to true with `id` to remove that subprocessor.",
+ "type": "boolean"
+ },
+ "country": {
+ "type": "string"
+ },
+ "id": {
+ "description": "ID of an existing subprocessor to update or remove. Omit to add a new subprocessor.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "processing_task": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "description": "Subprocessors, keyed by string index such as \"0\", \"1\". On create these are added to the template's subprocessors. On a draft update, an entry without `id` adds a new subprocessor; pass `id` to change one and `id` with `_destroy: true` to remove one.",
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+ },
+ "underlying_agreement_id": {
+ "description": "ID of the CSA this DPA supplements when `underlying_agreement_type` is `internal`.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "underlying_agreement_type": {
+ "description": "`internal` links a CSA in Common Paper (`underlying_agreement_id`, required); `external` describes another agreement in `underlying_agreement_val` (required). Defaults to `internal` when omitted on create.",
+ "enum": [
+ "internal",
+ "external"
+ ],
+ "type": "string"
+ },
+ "underlying_agreement_val": {
+ "description": "Description of the agreement this DPA supplements. Required when `underlying_agreement_type` is `external`.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "framework_terms_description": {
+ "description": "Custom framework terms description. Only used when framework_terms_type is \"description\".",
+ "type": "string"
+ },
+ "framework_terms_type": {
+ "description": "How framework terms are specified. Use \"new\" for standard terms or \"description\" to provide a custom framework_terms_description.",
+ "enum": [
+ "new",
+ "description"
+ ],
+ "type": "string"
+ },
+ "governing_law_country": {
+ "description": "The country whose laws govern the agreement.",
+ "type": "string"
+ },
+ "governing_law_region": {
+ "description": "The state or region whose laws govern the agreement.",
+ "type": "string"
+ },
+ "include_automated_payment_reminders": {
+ "description": "When true, automatically sends payment reminder emails.",
+ "type": "boolean"
+ },
+ "include_billing_info": {
+ "description": "When true, billing contact information (billing_name, billing_email) is included.",
+ "type": "boolean"
+ },
+ "include_billing_workflow": {
+ "description": "When true, enables a billing workflow after signing.",
+ "type": "boolean"
+ },
+ "include_expiration_date": {
+ "description": "Expiration date in YYYY-MM-DD format. Use when include_expiration_type is \"date\".",
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "include_expiration_days": {
+ "description": "Number of days until the agreement expires. Use when include_expiration_type is \"days\".",
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_expiration_type": {
+ "description": "How to set expiration: \"none\" (default), \"days\" (use include_expiration_days), or \"date\" (use include_expiration_date).",
+ "enum": [
+ "none",
+ "days",
+ "date"
+ ],
+ "type": "string"
+ },
+ "include_terms": {
+ "description": "When true, the standard terms are included with the agreement.",
+ "type": "boolean"
+ },
+ "loi_attributes": {
+ "additionalProperties": false,
+ "description": "Override loi terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "confidentiality_custom": {
+ "type": "string"
+ },
+ "confidentiality_mutual_include_loi": {
+ "type": "boolean"
+ },
+ "confidentiality_nda_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "confidentiality_nda_description": {
+ "type": "string"
+ },
+ "confidentiality_nda_include_loi": {
+ "type": "boolean"
+ },
+ "confidentiality_nda_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "confidentiality_type": {
+ "enum": [
+ "mutual",
+ "nda",
+ "provider",
+ "custom"
+ ],
+ "type": "string"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_custom_details": {
+ "type": "boolean"
+ },
+ "include_custom_details_val": {
+ "type": "string"
+ },
+ "include_fees": {
+ "type": "boolean"
+ },
+ "include_fees_amount": {
+ "type": "number"
+ },
+ "include_fees_amount_duration": {
+ "enum": [
+ "month",
+ "year",
+ "quarter"
+ ],
+ "type": "string"
+ },
+ "include_fees_include_amount": {
+ "type": "boolean"
+ },
+ "include_fees_include_other": {
+ "type": "boolean"
+ },
+ "include_fees_other": {
+ "type": "string"
+ },
+ "include_functionality": {
+ "type": "boolean"
+ },
+ "include_functionality_val": {
+ "type": "string"
+ },
+ "include_launch_date": {
+ "type": "boolean"
+ },
+ "include_launch_date_custom": {
+ "type": "string"
+ },
+ "include_launch_date_date": {
+ "format": "date-time",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$",
+ "type": "string"
+ },
+ "include_launch_date_type": {
+ "enum": [
+ "date",
+ "custom"
+ ],
+ "type": "string"
+ },
+ "product_name": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "manual_send": {
+ "description": "When true, the agreement is marked as manually sent outside the platform.",
+ "type": "boolean"
+ },
+ "message": {
+ "type": "string"
+ },
+ "negotiations_allowed": {
+ "description": "When true, the recipient can propose changes to the legal terms. For agreement types without separate business terms, that covers every term. CSA order forms, PSA statements of work, partnership business terms and software license order forms have their own `negotiations_allowed` flag.",
+ "type": "boolean"
+ },
+ "partnership_attributes": {
+ "additionalProperties": false,
+ "description": "Override partnership terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "effective_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "effective_date_type": {
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "type": "string"
+ },
+ "general_cap_amount_currency_val": {
+ "type": "number"
+ },
+ "general_cap_amount_either_currency": {
+ "type": "number"
+ },
+ "general_cap_amount_either_multiple": {
+ "type": "number"
+ },
+ "general_cap_amount_multiple_val": {
+ "type": "number"
+ },
+ "general_cap_amount_type": {
+ "enum": [
+ "multiple",
+ "currency",
+ "either",
+ "base"
+ ],
+ "type": "string"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_additional_warranties": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_include_company": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_include_company_val": {
+ "type": "string"
+ },
+ "include_additional_warranties_include_partner": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_include_partner_val": {
+ "type": "string"
+ },
+ "include_brand_guidelines": {
+ "type": "boolean"
+ },
+ "include_brand_guidelines_include_company": {
+ "type": "boolean"
+ },
+ "include_brand_guidelines_include_company_val": {
+ "type": "string"
+ },
+ "include_brand_guidelines_include_partner": {
+ "type": "boolean"
+ },
+ "include_brand_guidelines_include_partner_val": {
+ "type": "string"
+ },
+ "include_covered_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_company_claims": {
+ "type": "string"
+ },
+ "include_covered_claims_include_company_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_include_partner_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_partner_claims": {
+ "type": "string"
+ },
+ "include_dpa": {
+ "type": "boolean"
+ },
+ "include_dpa_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_dpa_location": {
+ "type": "string"
+ },
+ "include_dpa_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_increased_cap_amount": {
+ "type": "boolean"
+ },
+ "include_increased_cap_amount_currency": {
+ "type": "number"
+ },
+ "include_increased_cap_amount_either_currency": {
+ "type": "number"
+ },
+ "include_increased_cap_amount_either_multiple": {
+ "type": "string"
+ },
+ "include_increased_cap_amount_multiple": {
+ "type": "string"
+ },
+ "include_increased_cap_amount_type": {
+ "enum": [
+ "multiple",
+ "currency",
+ "either"
+ ],
+ "type": "string"
+ },
+ "include_increased_claims": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_confidentiality": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_confidentiality_misconduct": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_covered_claims": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_misconduct": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_other": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_other_val": {
+ "type": "string"
+ },
+ "include_unlimited_claims": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_confidentiality": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_confidentiality_misconduct": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_covered_claims": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_misconduct": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_other": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_other_val": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "partnership_business_terms_attributes": {
+ "additionalProperties": false,
+ "description": "Override partnership business terms terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "end_date_after_effective_date_amount": {
+ "type": "number"
+ },
+ "end_date_after_effective_date_unit": {
+ "enum": [
+ "month(s)",
+ "quarter(s)",
+ "year(s)"
+ ],
+ "type": "string"
+ },
+ "end_date_date": {
+ "type": "string"
+ },
+ "end_date_type": {
+ "enum": [
+ "date",
+ "effective date"
+ ],
+ "type": "string"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_obligations_company_brand": {
+ "type": "boolean"
+ },
+ "include_obligations_company_promotion": {
+ "type": "boolean"
+ },
+ "include_obligations_company_promotion_include_activities": {
+ "type": "boolean"
+ },
+ "include_obligations_company_promotion_include_activities_val": {
+ "type": "string"
+ },
+ "include_obligations_company_promotion_include_materials": {
+ "type": "boolean"
+ },
+ "include_obligations_company_promotion_include_materials_val": {
+ "type": "string"
+ },
+ "include_obligations_company_referral": {
+ "type": "boolean"
+ },
+ "include_obligations_company_referral_include_criteria": {
+ "type": "boolean"
+ },
+ "include_obligations_company_referral_include_criteria_val": {
+ "type": "string"
+ },
+ "include_obligations_company_referral_include_pay_sch": {
+ "type": "boolean"
+ },
+ "include_obligations_company_referral_include_pay_sch_amount": {
+ "type": "number"
+ },
+ "include_obligations_company_referral_include_pay_sch_custom": {
+ "type": "string"
+ },
+ "include_obligations_company_referral_include_pay_sch_unit": {
+ "enum": [
+ "U.S. Dollars",
+ "percent"
+ ],
+ "type": "string"
+ },
+ "include_obligations_company_sponsorship": {
+ "type": "boolean"
+ },
+ "include_obligations_company_sponsorship_include_benefits": {
+ "type": "boolean"
+ },
+ "include_obligations_company_sponsorship_include_benefits_val": {
+ "type": "string"
+ },
+ "include_obligations_company_sponsorship_include_payments": {
+ "type": "boolean"
+ },
+ "include_obligations_company_sponsorship_include_payments_amount": {
+ "type": "number"
+ },
+ "include_obligations_company_sponsorship_include_payments_unit": {
+ "enum": [
+ "U.S. Dollars",
+ "percent"
+ ],
+ "type": "string"
+ },
+ "include_obligations_partner_brand": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_promotion": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_promotion_include_activities": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_promotion_include_activities_val": {
+ "type": "string"
+ },
+ "include_obligations_partner_promotion_include_materials": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_promotion_include_materials_val": {
+ "type": "string"
+ },
+ "include_obligations_partner_referral": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_referral_include_criteria": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_referral_include_criteria_val": {
+ "type": "string"
+ },
+ "include_obligations_partner_referral_include_pay_sch": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_referral_include_pay_sch_amount": {
+ "type": "number"
+ },
+ "include_obligations_partner_referral_include_pay_sch_custom": {
+ "type": "string"
+ },
+ "include_obligations_partner_referral_include_pay_sch_unit": {
+ "enum": [
+ "U.S. Dollars",
+ "percent"
+ ],
+ "type": "string"
+ },
+ "include_obligations_partner_sponsorship": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_sponsorship_include_benefits": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_sponsorship_include_benefits_val": {
+ "type": "string"
+ },
+ "include_obligations_partner_sponsorship_include_payments": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_sponsorship_include_payments_amount": {
+ "type": "number"
+ },
+ "include_obligations_partner_sponsorship_include_payments_unit": {
+ "enum": [
+ "U.S. Dollars",
+ "percent"
+ ],
+ "type": "string"
+ },
+ "include_payment_process": {
+ "type": "boolean"
+ },
+ "include_payment_process_company": {
+ "type": "boolean"
+ },
+ "include_payment_process_company_include_address": {
+ "type": "boolean"
+ },
+ "include_payment_process_company_include_address_city": {
+ "type": "string"
+ },
+ "include_payment_process_company_include_address_country": {
+ "type": "string"
+ },
+ "include_payment_process_company_include_address_state": {
+ "type": "string"
+ },
+ "include_payment_process_company_include_address_street_address": {
+ "type": "string"
+ },
+ "include_payment_process_company_include_address_zipcode": {
+ "type": "string"
+ },
+ "include_payment_process_company_include_email": {
+ "type": "boolean"
+ },
+ "include_payment_process_company_include_email_val": {
+ "type": "string"
+ },
+ "include_payment_process_partner": {
+ "type": "boolean"
+ },
+ "include_payment_process_partner_include_address": {
+ "type": "boolean"
+ },
+ "include_payment_process_partner_include_address_city": {
+ "type": "string"
+ },
+ "include_payment_process_partner_include_address_country": {
+ "type": "string"
+ },
+ "include_payment_process_partner_include_address_state": {
+ "type": "string"
+ },
+ "include_payment_process_partner_include_address_street_address": {
+ "type": "string"
+ },
+ "include_payment_process_partner_include_address_zipcode": {
+ "type": "string"
+ },
+ "include_payment_process_partner_include_email": {
+ "type": "boolean"
+ },
+ "include_payment_process_partner_include_email_val": {
+ "type": "string"
+ },
+ "include_payment_schedule": {
+ "type": "boolean"
+ },
+ "include_payment_schedule_custom": {
+ "type": "string"
+ },
+ "include_payment_schedule_specified_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_payment_schedule_specified_timeframe": {
+ "enum": [
+ "receipt",
+ "date"
+ ],
+ "type": "string"
+ },
+ "include_payment_schedule_specified_unit": {
+ "enum": [
+ "day(s)",
+ "week(s)",
+ "month(s)",
+ "quarter(s)",
+ "year(s)"
+ ],
+ "type": "string"
+ },
+ "include_payment_schedule_type": {
+ "enum": [
+ "specified",
+ "custom"
+ ],
+ "type": "string"
+ },
+ "negotiations_allowed": {
+ "description": "When true, the recipient can propose changes to the business terms, even when the agreement-level `negotiations_allowed` is false. This only covers the business terms.",
+ "type": "boolean"
+ },
+ "territory_type": {
+ "enum": [
+ "worldwide",
+ "custom"
+ ],
+ "type": "string"
+ },
+ "territory_type_val": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "payment_link_url": {
+ "description": "A payment URL shown to the recipient after signing. Requires include_billing_workflow to be true and billing_workflow_type to be \"link\".",
+ "type": "string"
+ },
+ "pilot_attributes": {
+ "additionalProperties": false,
+ "description": "Override pilot terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "fees_type": {
+ "enum": [
+ "free",
+ "pilot_period_fees"
+ ],
+ "type": "string"
+ },
+ "general_cap_amount": {
+ "type": "number"
+ },
+ "general_cap_amount_type": {
+ "enum": [
+ "preceding",
+ "base",
+ "period"
+ ],
+ "type": "string"
+ },
+ "general_cap_period_currency": {
+ "type": "number"
+ },
+ "general_cap_period_qty": {
+ "type": "number"
+ },
+ "general_cap_preceding_amount": {
+ "type": "number"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_dpa": {
+ "type": "boolean"
+ },
+ "include_dpa_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_dpa_location": {
+ "type": "string"
+ },
+ "include_dpa_type": {
+ "enum": [
+ "description",
+ "attachment",
+ "standard"
+ ],
+ "type": "string"
+ },
+ "include_payment_process": {
+ "type": "boolean"
+ },
+ "include_technical_support": {
+ "type": "boolean"
+ },
+ "payment_process_automatic_frequency": {
+ "enum": [
+ "monthly",
+ "quarterly",
+ "annually",
+ "once_per_period"
+ ],
+ "type": "string"
+ },
+ "payment_process_invoice_days": {
+ "type": "number"
+ },
+ "payment_process_invoice_from": {
+ "enum": [
+ "receipt",
+ "date"
+ ],
+ "type": "string"
+ },
+ "payment_process_invoice_timeframe": {
+ "enum": [
+ "days",
+ "weeks",
+ "months",
+ "quarters",
+ "years"
+ ],
+ "type": "string"
+ },
+ "payment_process_type": {
+ "enum": [
+ "automatic",
+ "invoice"
+ ],
+ "type": "string"
+ },
+ "pilot_period_description": {
+ "type": "string"
+ },
+ "pilot_period_fees_description": {
+ "type": "string"
+ },
+ "product_description": {
+ "type": "string"
+ },
+ "technical_support_description": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "psa_attributes": {
+ "additionalProperties": false,
+ "description": "Override psa terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "additional_changes": {
+ "type": "string"
+ },
+ "customer_description": {
+ "type": "string"
+ },
+ "effective_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "effective_date_type": {
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "type": "string"
+ },
+ "general_cap_amount": {
+ "type": "number"
+ },
+ "general_cap_amount_type": {
+ "enum": [
+ "preceding",
+ "base",
+ "period"
+ ],
+ "type": "string"
+ },
+ "general_cap_period_currency": {
+ "type": "number"
+ },
+ "general_cap_period_qty": {
+ "type": "number"
+ },
+ "general_cap_preceding_amount": {
+ "type": "number"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_additional_changes": {
+ "type": "boolean"
+ },
+ "include_additional_warranties": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_by_customer": {
+ "type": "string"
+ },
+ "include_additional_warranties_by_provider": {
+ "type": "string"
+ },
+ "include_additional_warranties_include_by_customer": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_include_by_provider": {
+ "type": "boolean"
+ },
+ "include_covered_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_customer_claims": {
+ "type": "string"
+ },
+ "include_covered_claims_include_customer_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_include_provider_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_provider_claims": {
+ "type": "string"
+ },
+ "include_customer_insurance_min": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_add_provider_com_gen_liability": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_add_provider_cyber_liability": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_add_provider_errors_omissions": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_auto_liability_aggregate": {
+ "type": "number"
+ },
+ "include_customer_insurance_min_auto_liability_minimum": {
+ "type": "number"
+ },
+ "include_customer_insurance_min_cyber_liability_aggregate": {
+ "type": "number"
+ },
+ "include_customer_insurance_min_cyber_liability_minimum": {
+ "type": "number"
+ },
+ "include_customer_insurance_min_employer_liability_aggregate": {
+ "type": "number"
+ },
+ "include_customer_insurance_min_employer_liability_minimum": {
+ "type": "number"
+ },
+ "include_customer_insurance_min_general_liability_aggregate": {
+ "type": "number"
+ },
+ "include_customer_insurance_min_general_liability_minimum": {
+ "type": "number"
+ },
+ "include_customer_insurance_min_include_add_provider": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_include_auto_liability": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_include_cyber_liability": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_include_employer_liability": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_include_general_liability": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_include_workers_comp": {
+ "type": "boolean"
+ },
+ "include_customer_policies": {
+ "type": "boolean"
+ },
+ "include_customer_policies_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_customer_policies_location": {
+ "type": "string"
+ },
+ "include_customer_policies_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_dpa": {
+ "type": "boolean"
+ },
+ "include_dpa_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_dpa_location": {
+ "type": "string"
+ },
+ "include_dpa_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_increased_cap_amount": {
+ "type": "boolean"
+ },
+ "include_increased_claims": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_confidentiality": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_confidentiality_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_privsec": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_privsec_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_other": {
+ "type": "boolean"
+ },
+ "include_increased_claims_indemnification_obligation": {
+ "type": "boolean"
+ },
+ "include_increased_claims_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_other": {
+ "type": "string"
+ },
+ "include_provider_insurance_min": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_add_customer_com_gen_liability": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_add_customer_cyber_liability": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_add_customer_errors_omissions": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_auto_liability_aggregate": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_auto_liability_minimum": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_cyber_liability_aggregate": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_cyber_liability_minimum": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_employer_liability_aggregate": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_employer_liability_minimum": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_general_liability_aggregate": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_general_liability_minimum": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_include_add_customer": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_include_auto_liability": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_include_cyber_liability": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_include_employer_liability": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_include_general_liability": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_include_workers_comp": {
+ "type": "boolean"
+ },
+ "include_publicity_rights": {
+ "type": "boolean"
+ },
+ "include_publicity_rights_type": {
+ "enum": [
+ "public",
+ "non-public"
+ ],
+ "type": "string"
+ },
+ "include_security_policy": {
+ "type": "boolean"
+ },
+ "include_security_policy_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_security_policy_fedramp_auth": {
+ "type": "boolean"
+ },
+ "include_security_policy_hitrust": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_annual_maintenance": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_other": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_other_val": {
+ "type": "string"
+ },
+ "include_security_policy_iso27001": {
+ "type": "boolean"
+ },
+ "include_security_policy_location": {
+ "type": "string"
+ },
+ "include_security_policy_pci1": {
+ "type": "boolean"
+ },
+ "include_security_policy_pci2": {
+ "type": "boolean"
+ },
+ "include_security_policy_penetration_testing": {
+ "type": "boolean"
+ },
+ "include_security_policy_soc2_type1": {
+ "type": "boolean"
+ },
+ "include_security_policy_soc2_type2": {
+ "type": "boolean"
+ },
+ "include_security_policy_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_unlimited_claims": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_confidentiality": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_confidentiality_negligence": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_privsec": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_privsec_negligence": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_include_other": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_indemnification_obligation": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_negligence": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_other": {
+ "type": "string"
+ },
+ "increased_cap_amount_currency": {
+ "type": "number"
+ },
+ "increased_cap_amount_period_currency": {
+ "type": "number"
+ },
+ "increased_cap_amount_period_qty": {
+ "type": "number"
+ },
+ "increased_cap_amount_qty": {
+ "type": "number"
+ },
+ "increased_cap_amount_type": {
+ "enum": [
+ "qty",
+ "currency",
+ "period"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "psa_statement_of_work_attributes": {
+ "additionalProperties": false,
+ "description": "Override psa statement of work terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "additional_changes": {
+ "type": "string"
+ },
+ "cost": {
+ "type": "number"
+ },
+ "description": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "fees_attributes": {
+ "additionalProperties": {
+ "anyOf": [
+ {
+ "additionalProperties": false,
+ "description": "Fees::Flat (fee_type \"flat\"). A fixed recurring fee, e.g. a platform subscription. Set type to \"Fees::Flat\" or fee_type to \"flat\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Fixed amount in the order form's fees_currency, charged per fee_period. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"flat\". Alternative to type.",
+ "enum": [
+ "flat"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Flat\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Flat"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Discount (fee_type \"discount\"). A discount, as a fixed amount or a percentage, applied forever, once, or for a number of months. Set type to \"Fees::Discount\" or fee_type to \"discount\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Discount size: an amount in fees_currency when discount_type is fixed_amount (a plain amount, not cents: 20 means 20.00), or a percentage (e.g. 10 for 10%) when it is percentage.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "discount_duration_amount": {
+ "description": "Number of months the discount applies. Required when discount_duration_type is multiple_months.",
+ "type": "number"
+ },
+ "discount_duration_type": {
+ "description": "How long the discount applies. multiple_months also needs discount_duration_amount.",
+ "enum": [
+ "forever",
+ "once",
+ "multiple_months"
+ ],
+ "type": "string"
+ },
+ "discount_type": {
+ "description": "Whether cost is a currency amount or a percentage.",
+ "enum": [
+ "fixed_amount",
+ "percentage"
+ ],
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"discount\". Alternative to type.",
+ "enum": [
+ "discount"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Discount\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Discount"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Cost (fee_type \"cost\"). A per-unit fee: price per unit times quantity, e.g. seats. Set type to \"Fees::Cost\" or fee_type to \"cost\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Price per unit in fees_currency. The row total is quantity x cost. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"cost\". Alternative to type.",
+ "enum": [
+ "cost"
+ ],
+ "type": "string"
+ },
+ "quantity": {
+ "description": "Number of units.",
+ "type": "number"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Cost\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Cost"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Attachment (fee_type \"attachment\"). A fee described in an uploaded attachment instead of in the table. Set type to \"Fees::Attachment\" or fee_type to \"attachment\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "attachment_id": {
+ "description": "ID of an attachment uploaded with upload-attachment.",
+ "type": "string"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"attachment\". Alternative to type.",
+ "enum": [
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Attachment\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Attachment"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Graduated (fee_type \"graduated\"). Tiered pricing, with the price set per tier in graduated_fee_tiers_attributes. Set type to \"Fees::Graduated\" or fee_type to \"graduated\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"graduated\". Alternative to type.",
+ "enum": [
+ "graduated"
+ ],
+ "type": "string"
+ },
+ "graduated_fee_tiers_attributes": {
+ "additionalProperties": {
+ "additionalProperties": false,
+ "properties": {
+ "flat_price": {
+ "type": "number"
+ },
+ "price_per_unit": {
+ "type": "string"
+ },
+ "upper_limit": {
+ "type": "number"
+ }
+ },
+ "type": "object"
+ },
+ "description": "Graduated fee tiers. Use string keys such as \"0\", \"1\".",
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Graduated\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Graduated"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Included (fee_type \"included\"). An item included at no charge. Set type to \"Fees::Included\" or fee_type to \"included\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"included\". Alternative to type.",
+ "enum": [
+ "included"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Included\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Included"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Metered (fee_type \"metered\"). Usage-based pricing, billed per unit used. Set type to \"Fees::Metered\" or fee_type to \"metered\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Price per unit of usage in fees_currency. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"metered\". Alternative to type.",
+ "enum": [
+ "metered"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Metered\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Metered"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::OneTime (fee_type \"one_time\"). A one-time charge, such as a setup fee. Set type to \"Fees::OneTime\" or fee_type to \"one_time\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "One-time amount in fees_currency, charged once rather than per fee_period. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"one_time\". Alternative to type.",
+ "enum": [
+ "one_time"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::OneTime\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::OneTime"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Text (fee_type \"text\"). A fee term described in free text. Set type to \"Fees::Text\" or fee_type to \"text\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"text\". Alternative to type.",
+ "enum": [
+ "text"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Text\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Text"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ }
+ ]
+ },
+ "description": "Fee line items. Use string keys such as \"0\", \"1\". Replaces template fees when provided.",
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_additional_changes": {
+ "type": "boolean"
+ },
+ "include_customer_obligation": {
+ "type": "boolean"
+ },
+ "include_customer_obligation_val": {
+ "type": "string"
+ },
+ "include_deliverables": {
+ "type": "boolean"
+ },
+ "include_deliverables_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_deliverables_description": {
+ "type": "string"
+ },
+ "include_deliverables_include_acceptance": {
+ "type": "boolean"
+ },
+ "include_deliverables_include_attachment": {
+ "type": "boolean"
+ },
+ "include_deliverables_include_draft_deliverables": {
+ "type": "boolean"
+ },
+ "include_deliverables_rejection_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_deliverables_rejection_unit": {
+ "enum": [
+ "hours",
+ "days",
+ "weeks",
+ "months"
+ ],
+ "type": "string"
+ },
+ "include_deliverables_resubmission_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_deliverables_resubmission_unit": {
+ "enum": [
+ "hours",
+ "days",
+ "weeks",
+ "months"
+ ],
+ "type": "string"
+ },
+ "include_fees_other": {
+ "type": "boolean"
+ },
+ "include_fees_other_val": {
+ "type": "string"
+ },
+ "include_fees_table": {
+ "type": "boolean"
+ },
+ "include_fees_table_total": {
+ "type": "boolean"
+ },
+ "include_fees_travel": {
+ "type": "boolean"
+ },
+ "include_fees_travel_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_fees_travel_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_fees_travel_val": {
+ "type": "string"
+ },
+ "include_third_party_customer": {
+ "type": "boolean"
+ },
+ "include_third_party_include_description": {
+ "type": "boolean"
+ },
+ "include_third_party_include_description_val": {
+ "type": "string"
+ },
+ "include_third_party_materials": {
+ "type": "boolean"
+ },
+ "include_third_party_provider": {
+ "type": "boolean"
+ },
+ "include_time_of_assignment": {
+ "type": "boolean"
+ },
+ "include_time_of_assignment_type": {
+ "enum": [
+ "created",
+ "paid"
+ ],
+ "type": "string"
+ },
+ "invoice_period_description": {
+ "type": "string"
+ },
+ "negotiations_allowed": {
+ "description": "When true, the recipient can propose changes to the statement of work, even when the agreement-level `negotiations_allowed` is false. This only covers the statement of work.",
+ "type": "boolean"
+ },
+ "payment_period": {
+ "type": "number"
+ },
+ "payment_period_other": {
+ "type": "string"
+ },
+ "payment_period_timeframe": {
+ "enum": [
+ "receipt",
+ "invoice",
+ "Customer's receipt of invoice",
+ "date of invoice"
+ ],
+ "type": "string"
+ },
+ "payment_period_type": {
+ "enum": [
+ "standard",
+ "other"
+ ],
+ "type": "string"
+ },
+ "payment_period_unit": {
+ "enum": [
+ "day(s)",
+ "week(s)",
+ "month(s)",
+ "quarter(s)",
+ "year(s)"
+ ],
+ "type": "string"
+ },
+ "quantity": {
+ "type": "number"
+ },
+ "services_description": {
+ "type": "string"
+ },
+ "sow_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "sow_date_type": {
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "type": "string"
+ },
+ "sow_term_amount": {
+ "type": "number"
+ },
+ "sow_term_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "sow_term_type": {
+ "enum": [
+ "deliverables",
+ "period",
+ "date"
+ ],
+ "type": "string"
+ },
+ "sow_term_unit": {
+ "enum": [
+ "month(s)",
+ "quarter(s)",
+ "year(s)"
+ ],
+ "type": "string"
+ },
+ "type": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "recipient_email": {
+ "format": "email",
+ "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "recipient_name": {
+ "type": "string"
+ },
+ "recipient_notice_email_address": {
+ "description": "Email address for legal notices to the recipient.",
+ "format": "email",
+ "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "recipient_organization": {
+ "type": "string"
+ },
+ "recipient_role": {
+ "description": "PSA only. The recipient's role: `Customer` (the default) or `Provider`. Send it with `sender_role`; the two must be one `Provider` and one `Customer`. Other standard agreement types ignore it.",
+ "type": "string"
+ },
+ "sender_last_to_sign": {
+ "description": "When true, your signer signs after the recipient.",
+ "type": "boolean"
+ },
+ "sender_notice_email_address": {
+ "description": "Email address for legal notices to the sender.",
+ "format": "email",
+ "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "sender_role": {
+ "description": "PSA only. Your company's role: `Provider` (the default) or `Customer` when you hire the recipient to provide the services. Send it with `recipient_role`; the two must be one `Provider` and one `Customer`. When reading a PSA, an empty `sender_role` means `Provider`. Other standard agreement types ignore it.",
+ "type": "string"
+ },
+ "software_license_attributes": {
+ "additionalProperties": false,
+ "description": "Override software license terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "effective_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "effective_date_type": {
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "type": "string"
+ },
+ "general_cap_amount": {
+ "type": "number"
+ },
+ "general_cap_amount_type": {
+ "enum": [
+ "preceding",
+ "base",
+ "period"
+ ],
+ "type": "string"
+ },
+ "general_cap_period_currency": {
+ "type": "number"
+ },
+ "general_cap_period_qty": {
+ "type": "number"
+ },
+ "general_cap_preceding_amount": {
+ "type": "number"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_additional_warranties": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_by_customer": {
+ "type": "string"
+ },
+ "include_additional_warranties_by_provider": {
+ "type": "string"
+ },
+ "include_additional_warranties_include_by_customer": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_include_by_provider": {
+ "type": "boolean"
+ },
+ "include_ai_addendum": {
+ "type": "boolean"
+ },
+ "include_ai_addendum_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_covered_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_customer_claims": {
+ "type": "string"
+ },
+ "include_covered_claims_include_customer_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_include_provider_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_provider_claims": {
+ "type": "string"
+ },
+ "include_dpa": {
+ "type": "boolean"
+ },
+ "include_dpa_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_dpa_location": {
+ "type": "string"
+ },
+ "include_dpa_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_increased_cap_amount": {
+ "type": "boolean"
+ },
+ "include_increased_claims": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_confidentiality": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_confidentiality_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_other": {
+ "type": "boolean"
+ },
+ "include_increased_claims_indemnification_obligation": {
+ "type": "boolean"
+ },
+ "include_increased_claims_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_other": {
+ "type": "string"
+ },
+ "include_increased_claims_restrictions": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_confidentiality": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_confidentiality_negligence": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_include_other": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_indemnification_obligation": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_license_or_restrictions": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_negligence": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_other": {
+ "type": "string"
+ },
+ "increased_cap_amount_currency": {
+ "type": "number"
+ },
+ "increased_cap_amount_period_currency": {
+ "type": "number"
+ },
+ "increased_cap_amount_period_qty": {
+ "type": "number"
+ },
+ "increased_cap_amount_qty": {
+ "type": "number"
+ },
+ "increased_cap_amount_type": {
+ "enum": [
+ "qty",
+ "currency",
+ "period"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "software_license_order_form_attributes": {
+ "additionalProperties": false,
+ "description": "Override software license order form terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "additional_changes": {
+ "type": "string"
+ },
+ "deletion_procedure_include_custom": {
+ "type": "boolean"
+ },
+ "deletion_procedure_include_custom_description": {
+ "type": "string"
+ },
+ "deletion_procedure_include_customer_disable": {
+ "type": "boolean"
+ },
+ "deletion_procedure_include_customer_proof": {
+ "type": "boolean"
+ },
+ "deletion_procedure_include_provider_disable": {
+ "type": "boolean"
+ },
+ "fee_custom_unit": {
+ "type": "string"
+ },
+ "fee_period": {
+ "enum": [
+ "Subscription Period",
+ "month",
+ "year",
+ "Custom unit"
+ ],
+ "type": "string"
+ },
+ "fees_attributes": {
+ "additionalProperties": {
+ "anyOf": [
+ {
+ "additionalProperties": false,
+ "description": "Fees::Flat (fee_type \"flat\"). A fixed recurring fee, e.g. a platform subscription. Set type to \"Fees::Flat\" or fee_type to \"flat\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Fixed amount in the order form's fees_currency, charged per fee_period. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"flat\". Alternative to type.",
+ "enum": [
+ "flat"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Flat\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Flat"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Discount (fee_type \"discount\"). A discount, as a fixed amount or a percentage, applied forever, once, or for a number of months. Set type to \"Fees::Discount\" or fee_type to \"discount\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Discount size: an amount in fees_currency when discount_type is fixed_amount (a plain amount, not cents: 20 means 20.00), or a percentage (e.g. 10 for 10%) when it is percentage.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "discount_duration_amount": {
+ "description": "Number of months the discount applies. Required when discount_duration_type is multiple_months.",
+ "type": "number"
+ },
+ "discount_duration_type": {
+ "description": "How long the discount applies. multiple_months also needs discount_duration_amount.",
+ "enum": [
+ "forever",
+ "once",
+ "multiple_months"
+ ],
+ "type": "string"
+ },
+ "discount_type": {
+ "description": "Whether cost is a currency amount or a percentage.",
+ "enum": [
+ "fixed_amount",
+ "percentage"
+ ],
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"discount\". Alternative to type.",
+ "enum": [
+ "discount"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Discount\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Discount"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Cost (fee_type \"cost\"). A per-unit fee: price per unit times quantity, e.g. seats. Set type to \"Fees::Cost\" or fee_type to \"cost\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Price per unit in fees_currency. The row total is quantity x cost. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"cost\". Alternative to type.",
+ "enum": [
+ "cost"
+ ],
+ "type": "string"
+ },
+ "quantity": {
+ "description": "Number of units.",
+ "type": "number"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Cost\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Cost"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Attachment (fee_type \"attachment\"). A fee described in an uploaded attachment instead of in the table. Set type to \"Fees::Attachment\" or fee_type to \"attachment\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "attachment_id": {
+ "description": "ID of an attachment uploaded with upload-attachment.",
+ "type": "string"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"attachment\". Alternative to type.",
+ "enum": [
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Attachment\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Attachment"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Graduated (fee_type \"graduated\"). Tiered pricing, with the price set per tier in graduated_fee_tiers_attributes. Set type to \"Fees::Graduated\" or fee_type to \"graduated\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"graduated\". Alternative to type.",
+ "enum": [
+ "graduated"
+ ],
+ "type": "string"
+ },
+ "graduated_fee_tiers_attributes": {
+ "additionalProperties": {
+ "additionalProperties": false,
+ "properties": {
+ "flat_price": {
+ "type": "number"
+ },
+ "price_per_unit": {
+ "type": "string"
+ },
+ "upper_limit": {
+ "type": "number"
+ }
+ },
+ "type": "object"
+ },
+ "description": "Graduated fee tiers. Use string keys such as \"0\", \"1\".",
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Graduated\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Graduated"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Included (fee_type \"included\"). An item included at no charge. Set type to \"Fees::Included\" or fee_type to \"included\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"included\". Alternative to type.",
+ "enum": [
+ "included"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Included\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Included"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Metered (fee_type \"metered\"). Usage-based pricing, billed per unit used. Set type to \"Fees::Metered\" or fee_type to \"metered\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Price per unit of usage in fees_currency. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"metered\". Alternative to type.",
+ "enum": [
+ "metered"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Metered\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Metered"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::OneTime (fee_type \"one_time\"). A one-time charge, such as a setup fee. Set type to \"Fees::OneTime\" or fee_type to \"one_time\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "One-time amount in fees_currency, charged once rather than per fee_period. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"one_time\". Alternative to type.",
+ "enum": [
+ "one_time"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::OneTime\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::OneTime"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Text (fee_type \"text\"). A fee term described in free text. Set type to \"Fees::Text\" or fee_type to \"text\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"text\". Alternative to type.",
+ "enum": [
+ "text"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Text\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Text"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ }
+ ]
+ },
+ "description": "Fee line items. Use string keys such as \"0\", \"1\". Replaces template fees when provided.",
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+ },
+ "fees_currency": {
+ "enum": [
+ "USD",
+ "EUR",
+ "GBP",
+ "CAD",
+ "AUD",
+ "SGD",
+ "ILS",
+ "JPY",
+ "CHF",
+ "HKD"
+ ],
+ "type": "string"
+ },
+ "fees_include_fee_increase_upon_renewal": {
+ "type": "boolean"
+ },
+ "fees_include_fee_increase_upon_renewal_fee": {
+ "type": "number"
+ },
+ "fees_include_fee_increase_upon_renewal_type": {
+ "enum": [
+ "will",
+ "may"
+ ],
+ "type": "string"
+ },
+ "fees_inclusive_of_taxes": {
+ "type": "boolean"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_additional_changes": {
+ "type": "boolean"
+ },
+ "include_license_compliance_verification": {
+ "type": "boolean"
+ },
+ "include_license_compliance_verification_description": {
+ "type": "string"
+ },
+ "include_license_limits": {
+ "type": "boolean"
+ },
+ "include_license_limits_description": {
+ "type": "string"
+ },
+ "include_payment_process_include_billing_email": {
+ "type": "boolean"
+ },
+ "include_pilot_period": {
+ "type": "boolean"
+ },
+ "include_pilot_period_duration_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_pilot_period_duration_type": {
+ "enum": [
+ "day",
+ "week",
+ "month"
+ ],
+ "type": "string"
+ },
+ "include_pilot_period_include_fees": {
+ "type": "boolean"
+ },
+ "include_pilot_period_include_fees_amount": {
+ "type": "number"
+ },
+ "include_pilot_period_include_modifications": {
+ "type": "boolean"
+ },
+ "include_pilot_period_include_modifications_description": {
+ "type": "string"
+ },
+ "include_services": {
+ "type": "boolean"
+ },
+ "include_services_description": {
+ "type": "string"
+ },
+ "negotiations_allowed": {
+ "description": "When true, the recipient can propose changes to the order form, even when the agreement-level `negotiations_allowed` is false. This only covers the order form.",
+ "type": "boolean"
+ },
+ "order_date_date": {
+ "type": "string"
+ },
+ "order_date_type": {
+ "enum": [
+ "signature",
+ "date",
+ "other"
+ ],
+ "type": "string"
+ },
+ "payment_process_automatic_frequency": {
+ "enum": [
+ "monthly",
+ "quarterly",
+ "semiannually",
+ "annually"
+ ],
+ "type": "string"
+ },
+ "payment_process_type": {
+ "enum": [
+ "automatic",
+ "invoice",
+ "custom"
+ ],
+ "type": "string"
+ },
+ "payment_process_type_custom_val": {
+ "type": "string"
+ },
+ "payment_process_type_invoice_amount": {
+ "type": "number"
+ },
+ "payment_process_type_invoice_custom_unit": {
+ "type": "string"
+ },
+ "payment_process_type_invoice_duration": {
+ "enum": [
+ "day",
+ "week",
+ "month",
+ "year",
+ "day(s)",
+ "week(s)",
+ "month(s)",
+ "year(s)"
+ ],
+ "type": "string"
+ },
+ "payment_process_type_invoice_duration_start": {
+ "enum": [
+ "Customer's receipt of invoice",
+ "date of invoice"
+ ],
+ "type": "string"
+ },
+ "payment_process_type_invoice_type": {
+ "enum": [
+ "monthly",
+ "quarterly",
+ "semiannually",
+ "annually",
+ "Custom unit"
+ ],
+ "type": "string"
+ },
+ "permitted_uses_include_custom": {
+ "type": "boolean"
+ },
+ "permitted_uses_include_custom_description": {
+ "type": "string"
+ },
+ "permitted_uses_include_customers_affiliates": {
+ "type": "boolean"
+ },
+ "permitted_uses_include_internal_business": {
+ "type": "boolean"
+ },
+ "pilot_period_stripe_product_id": {
+ "type": "string"
+ },
+ "software_description": {
+ "type": "string"
+ },
+ "subscription_auto_renew": {
+ "enum": [
+ "days",
+ "subscription_end"
+ ],
+ "type": "string"
+ },
+ "subscription_period": {
+ "type": "number"
+ },
+ "subscription_period_unit": {
+ "type": "string"
+ },
+ "subscription_renewal_notice_days": {
+ "type": "number"
+ },
+ "warranty_period_description_amount": {
+ "type": "number"
+ },
+ "warranty_period_description_duration": {
+ "enum": [
+ "day",
+ "week",
+ "month",
+ "year"
+ ],
+ "type": "string"
+ },
+ "warranty_period_description_duration_start": {
+ "enum": [
+ "initial delivery of the Software",
+ "delivery of the Software and each subsequent Update",
+ "the Order Date"
+ ],
+ "type": "string"
+ },
+ "warranty_period_type": {
+ "enum": [
+ "description",
+ "none"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "test_agreement": {
+ "description": "When true, marks the agreement as a test. Test agreements do not count against your monthly limit.",
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "recipient_name",
+ "recipient_email"
+ ],
+ "type": "object"
+ },
+ "cc_users": {
+ "items": {
+ "format": "email",
+ "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "draft": {
+ "description": "When true, the agreement is saved as a draft and not sent to the recipient. Use POST /v1/agreements/{id}/send to send a draft agreement later.",
+ "type": "boolean"
+ },
+ "owner_email": {
+ "description": "Email address of the agreement owner (sender).",
+ "type": "string"
+ },
+ "signer_id": {
+ "description": "User id of the signer from the owner's organization.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "template_id": {
+ "description": "UUID of a template from `GET /v1/templates`. Accepts both Common Paper standard templates and uploaded PDF templates (`type` `uploaded_template`).",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ }
+ },
+ "required": [
+ "template_id",
+ "owner_email",
+ "signer_id",
+ "agreement"
+ ],
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "agreement": {
+ "additionalProperties": {},
+ "properties": {
+ "amendment_attributes": {
+ "additionalProperties": false,
+ "description": "Override amendment terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "amended_terms_attributes": {
+ "additionalProperties": {
+ "additionalProperties": false,
+ "properties": {
+ "description": {
+ "type": "string"
+ },
+ "term": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "description": "Amended terms. Use string keys such as \"0\", \"1\".",
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+ },
+ "amendment_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "amendment_date_type": {
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "type": "string"
+ },
+ "framework_terms_type": {
+ "type": "string"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "parent_agreement_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "underlying_agreement_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "underlying_agreement_type": {
+ "type": "string"
+ },
+ "underlying_agreement_val": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "baa_attributes": {
+ "additionalProperties": false,
+ "description": "Override baa terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "aggregation_limitations_permitted": {
+ "type": "boolean"
+ },
+ "aggregation_limitations_permitted_val": {
+ "type": "string"
+ },
+ "breach_notification_unit": {
+ "enum": [
+ "hours",
+ "business days",
+ "calendar days"
+ ],
+ "type": "string"
+ },
+ "breach_notification_val": {
+ "type": "number"
+ },
+ "business_associate_relationship_type": {
+ "enum": [
+ "provider",
+ "company"
+ ],
+ "type": "string"
+ },
+ "deidentification_limitations_include_purpose": {
+ "type": "boolean"
+ },
+ "deidentification_limitations_include_requirements": {
+ "type": "boolean"
+ },
+ "deidentification_limitations_permitted": {
+ "type": "boolean"
+ },
+ "deidentification_limitations_purpose_val": {
+ "type": "string"
+ },
+ "deidentification_limitations_requirements_val": {
+ "type": "string"
+ },
+ "designated_record_set_provider_maintains": {
+ "type": "boolean"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_aggregation_limitations": {
+ "type": "boolean"
+ },
+ "include_deidentification_limitations": {
+ "type": "boolean"
+ },
+ "include_limitations": {
+ "type": "boolean"
+ },
+ "include_offshore_limitations": {
+ "type": "boolean"
+ },
+ "include_subcontract_limitations": {
+ "type": "boolean"
+ },
+ "offshore_limitations_permitted": {
+ "type": "boolean"
+ },
+ "offshore_limitations_permitted_val": {
+ "type": "string"
+ },
+ "subcontract_limitations_include_notice": {
+ "type": "boolean"
+ },
+ "subcontract_limitations_include_permission": {
+ "type": "boolean"
+ },
+ "subcontract_limitations_notice_val": {
+ "type": "string"
+ },
+ "subcontract_limitations_permission_val": {
+ "type": "string"
+ },
+ "subcontract_limitations_permitted": {
+ "type": "boolean"
+ },
+ "underlying_agreement_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "underlying_agreement_type": {
+ "enum": [
+ "internal",
+ "external",
+ "none"
+ ],
+ "type": "string"
+ },
+ "underlying_agreement_val": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "billing_email": {
+ "description": "Email of the billing contact. Used when include_billing_info is true.",
+ "format": "email",
+ "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "billing_name": {
+ "description": "Name of the billing contact. Used when include_billing_info is true.",
+ "type": "string"
+ },
+ "billing_workflow_type": {
+ "description": "The type of billing workflow. Use \"link\" to provide a payment_link_url, or \"stripe\" for Stripe-managed billing.",
+ "enum": [
+ "link",
+ "stripe"
+ ],
+ "type": "string"
+ },
+ "chosen_courts_country": {
+ "description": "The country in which disputes will be resolved.",
+ "type": "string"
+ },
+ "chosen_courts_region": {
+ "description": "The state or region in which disputes will be resolved.",
+ "type": "string"
+ },
+ "csa_attributes": {
+ "additionalProperties": false,
+ "description": "Override csa terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "customer_description": {
+ "type": "string"
+ },
+ "effective_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "effective_date_marketplace": {
+ "enum": [
+ "AWS",
+ "GCP",
+ "Azure"
+ ],
+ "type": "string"
+ },
+ "effective_date_type": {
+ "enum": [
+ "signature",
+ "date",
+ "marketplace_acceptance"
+ ],
+ "type": "string"
+ },
+ "general_cap_amount": {
+ "type": "number"
+ },
+ "general_cap_amount_type": {
+ "enum": [
+ "preceding",
+ "base",
+ "period"
+ ],
+ "type": "string"
+ },
+ "general_cap_period_currency": {
+ "type": "number"
+ },
+ "general_cap_period_qty": {
+ "type": "number"
+ },
+ "general_cap_preceding_amount": {
+ "type": "number"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_acceptable_use_policy": {
+ "type": "boolean"
+ },
+ "include_acceptable_use_policy_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_acceptable_use_policy_location": {
+ "type": "string"
+ },
+ "include_acceptable_use_policy_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_additional_warranties": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_by_customer": {
+ "type": "string"
+ },
+ "include_additional_warranties_by_provider": {
+ "type": "string"
+ },
+ "include_additional_warranties_include_by_customer": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_include_by_provider": {
+ "type": "boolean"
+ },
+ "include_ai_addendum": {
+ "type": "boolean"
+ },
+ "include_ai_addendum_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_covered_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_customer_claims": {
+ "type": "string"
+ },
+ "include_covered_claims_include_customer_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_include_provider_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_provider_claims": {
+ "type": "string"
+ },
+ "include_dpa": {
+ "type": "boolean"
+ },
+ "include_dpa_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_dpa_location": {
+ "type": "string"
+ },
+ "include_dpa_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_increased_cap_amount": {
+ "type": "boolean"
+ },
+ "include_increased_claims": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_confidentiality": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_confidentiality_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_privsec": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_privsec_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_other": {
+ "type": "boolean"
+ },
+ "include_increased_claims_indemnification_obligation": {
+ "type": "boolean"
+ },
+ "include_increased_claims_other": {
+ "type": "string"
+ },
+ "include_insurance_minimums": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_add_customer": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_add_customer_com_gen_liability": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_add_customer_cyber_liability": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_add_customer_errors_omissions": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_additional_information": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_additional_information_text": {
+ "type": "string"
+ },
+ "include_insurance_minimums_cyber_liability_aggregate": {
+ "type": "number"
+ },
+ "include_insurance_minimums_cyber_liability_minimum": {
+ "type": "number"
+ },
+ "include_insurance_minimums_employer_liability_aggregate": {
+ "type": "number"
+ },
+ "include_insurance_minimums_employer_liability_minimum": {
+ "type": "number"
+ },
+ "include_insurance_minimums_general_liability_aggregate": {
+ "type": "number"
+ },
+ "include_insurance_minimums_general_liability_minimum": {
+ "type": "number"
+ },
+ "include_insurance_minimums_include_cyber_liability": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_include_employer_liability": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_include_general_liability": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_include_workers_compensation": {
+ "type": "boolean"
+ },
+ "include_publicity_rights": {
+ "type": "boolean"
+ },
+ "include_publicity_rights_type": {
+ "enum": [
+ "public",
+ "non-public"
+ ],
+ "type": "string"
+ },
+ "include_security_policy": {
+ "type": "boolean"
+ },
+ "include_security_policy_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_security_policy_fedramp_auth": {
+ "type": "boolean"
+ },
+ "include_security_policy_hipaa": {
+ "type": "boolean"
+ },
+ "include_security_policy_hitrust": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_annual_maintenance": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_location": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_other": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_reasonable_efforts": {
+ "type": "boolean"
+ },
+ "include_security_policy_iso27001": {
+ "type": "boolean"
+ },
+ "include_security_policy_location": {
+ "type": "string"
+ },
+ "include_security_policy_other": {
+ "type": "string"
+ },
+ "include_security_policy_pci1": {
+ "type": "boolean"
+ },
+ "include_security_policy_pci2": {
+ "type": "boolean"
+ },
+ "include_security_policy_penetration_testing": {
+ "type": "boolean"
+ },
+ "include_security_policy_soc2": {
+ "type": "boolean"
+ },
+ "include_security_policy_soc2_type2": {
+ "type": "boolean"
+ },
+ "include_security_policy_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_supercap": {
+ "description": "CSA 3.0 renamed `include_increased_cap_amount` to `include_supercap`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_increased_cap_amount`. Sending the other spelling returns a 422.",
+ "type": "boolean"
+ },
+ "include_uncapped_claims": {
+ "description": "CSA 3.0 renamed `include_unlimited_claims` to `include_uncapped_claims`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims`. Sending the other spelling returns a 422.",
+ "type": "boolean"
+ },
+ "include_uncapped_claims_breach_of_confidentiality": {
+ "description": "CSA 3.0 renamed `include_unlimited_claims_breach_of_confidentiality` to `include_uncapped_claims_breach_of_confidentiality`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_breach_of_confidentiality`. Sending the other spelling returns a 422.",
+ "type": "boolean"
+ },
+ "include_uncapped_claims_breach_of_confidentiality_negligence": {
+ "description": "CSA 3.0 renamed `include_unlimited_claims_breach_of_confidentiality_negligence` to `include_uncapped_claims_breach_of_confidentiality_negligence`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_breach_of_confidentiality_negligence`. Sending the other spelling returns a 422.",
+ "type": "boolean"
+ },
+ "include_uncapped_claims_breach_of_privsec": {
+ "description": "CSA 3.0 renamed `include_unlimited_claims_breach_of_privsec` to `include_uncapped_claims_breach_of_privsec`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_breach_of_privsec`. Sending the other spelling returns a 422.",
+ "type": "boolean"
+ },
+ "include_uncapped_claims_breach_of_privsec_negligence": {
+ "description": "CSA 3.0 renamed `include_unlimited_claims_breach_of_privsec_negligence` to `include_uncapped_claims_breach_of_privsec_negligence`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_breach_of_privsec_negligence`. Sending the other spelling returns a 422.",
+ "type": "boolean"
+ },
+ "include_uncapped_claims_include_other": {
+ "description": "CSA 3.0 renamed `include_unlimited_claims_include_other` to `include_uncapped_claims_include_other`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_include_other`. Sending the other spelling returns a 422.",
+ "type": "boolean"
+ },
+ "include_uncapped_claims_indemnification_obligation": {
+ "description": "CSA 3.0 renamed `include_unlimited_claims_indemnification_obligation` to `include_uncapped_claims_indemnification_obligation`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_indemnification_obligation`. Sending the other spelling returns a 422.",
+ "type": "boolean"
+ },
+ "include_uncapped_claims_other": {
+ "description": "CSA 3.0 renamed `include_unlimited_claims_other` to `include_uncapped_claims_other`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_other`. Sending the other spelling returns a 422.",
+ "type": "boolean"
+ },
+ "include_unlimited_claims": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_confidentiality": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_confidentiality_negligence": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_privsec": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_privsec_negligence": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_include_other": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_indemnification_obligation": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_other": {
+ "type": "string"
+ },
+ "increased_cap_amount_currency": {
+ "type": "number"
+ },
+ "increased_cap_amount_period_currency": {
+ "type": "number"
+ },
+ "increased_cap_amount_period_qty": {
+ "type": "number"
+ },
+ "increased_cap_amount_qty": {
+ "type": "number"
+ },
+ "increased_cap_amount_type": {
+ "enum": [
+ "qty",
+ "currency",
+ "period"
+ ],
+ "type": "string"
+ },
+ "provider": {
+ "type": "string"
+ },
+ "supercap_currency": {
+ "description": "CSA 3.0 renamed `increased_cap_amount_currency` to `supercap_currency`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `increased_cap_amount_currency`. Sending the other spelling returns a 422.",
+ "type": "number"
+ },
+ "supercap_period_currency": {
+ "description": "CSA 3.0 renamed `increased_cap_amount_period_currency` to `supercap_period_currency`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `increased_cap_amount_period_currency`. Sending the other spelling returns a 422.",
+ "type": "number"
+ },
+ "supercap_period_qty": {
+ "description": "CSA 3.0 renamed `increased_cap_amount_period_qty` to `supercap_period_qty`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `increased_cap_amount_period_qty`. Sending the other spelling returns a 422.",
+ "type": "number"
+ },
+ "supercap_qty": {
+ "description": "CSA 3.0 renamed `increased_cap_amount_qty` to `supercap_qty`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `increased_cap_amount_qty`. Sending the other spelling returns a 422.",
+ "type": "number"
+ },
+ "supercap_type": {
+ "description": "CSA 3.0 renamed `increased_cap_amount_type` to `supercap_type`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `increased_cap_amount_type`. Sending the other spelling returns a 422.",
+ "type": "number"
+ }
+ },
+ "type": "object"
+ },
+ "csa_order_form_attributes": {
+ "additionalProperties": false,
+ "description": "Override csa order form terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "additional_changes": {
+ "type": "string"
+ },
+ "additional_parameters_or_limitations": {
+ "type": "string"
+ },
+ "affiliates_as_users": {
+ "type": "boolean"
+ },
+ "cloud_service_description": {
+ "type": "string"
+ },
+ "consumption_units": {
+ "type": "string"
+ },
+ "fee_amount": {
+ "type": "number"
+ },
+ "fee_custom_unit": {
+ "type": "string"
+ },
+ "fee_period": {
+ "enum": [
+ "Subscription Period",
+ "month",
+ "year",
+ "User",
+ "Custom unit"
+ ],
+ "type": "string"
+ },
+ "fees_attributes": {
+ "additionalProperties": {
+ "anyOf": [
+ {
+ "additionalProperties": false,
+ "description": "Fees::Flat (fee_type \"flat\"). A fixed recurring fee, e.g. a platform subscription. Set type to \"Fees::Flat\" or fee_type to \"flat\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Fixed amount in the order form's fees_currency, charged per fee_period. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"flat\". Alternative to type.",
+ "enum": [
+ "flat"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Flat\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Flat"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Discount (fee_type \"discount\"). A discount, as a fixed amount or a percentage, applied forever, once, or for a number of months. Set type to \"Fees::Discount\" or fee_type to \"discount\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Discount size: an amount in fees_currency when discount_type is fixed_amount (a plain amount, not cents: 20 means 20.00), or a percentage (e.g. 10 for 10%) when it is percentage.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "discount_duration_amount": {
+ "description": "Number of months the discount applies. Required when discount_duration_type is multiple_months.",
+ "type": "number"
+ },
+ "discount_duration_type": {
+ "description": "How long the discount applies. multiple_months also needs discount_duration_amount.",
+ "enum": [
+ "forever",
+ "once",
+ "multiple_months"
+ ],
+ "type": "string"
+ },
+ "discount_type": {
+ "description": "Whether cost is a currency amount or a percentage.",
+ "enum": [
+ "fixed_amount",
+ "percentage"
+ ],
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"discount\". Alternative to type.",
+ "enum": [
+ "discount"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Discount\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Discount"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Cost (fee_type \"cost\"). A per-unit fee: price per unit times quantity, e.g. seats. Set type to \"Fees::Cost\" or fee_type to \"cost\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Price per unit in fees_currency. The row total is quantity x cost. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"cost\". Alternative to type.",
+ "enum": [
+ "cost"
+ ],
+ "type": "string"
+ },
+ "quantity": {
+ "description": "Number of units.",
+ "type": "number"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Cost\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Cost"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Attachment (fee_type \"attachment\"). A fee described in an uploaded attachment instead of in the table. Set type to \"Fees::Attachment\" or fee_type to \"attachment\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "attachment_id": {
+ "description": "ID of an attachment uploaded with upload-attachment.",
+ "type": "string"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"attachment\". Alternative to type.",
+ "enum": [
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Attachment\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Attachment"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Graduated (fee_type \"graduated\"). Tiered pricing, with the price set per tier in graduated_fee_tiers_attributes. Set type to \"Fees::Graduated\" or fee_type to \"graduated\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"graduated\". Alternative to type.",
+ "enum": [
+ "graduated"
+ ],
+ "type": "string"
+ },
+ "graduated_fee_tiers_attributes": {
+ "additionalProperties": {
+ "additionalProperties": false,
+ "properties": {
+ "flat_price": {
+ "type": "number"
+ },
+ "price_per_unit": {
+ "type": "string"
+ },
+ "upper_limit": {
+ "type": "number"
+ }
+ },
+ "type": "object"
+ },
+ "description": "Graduated fee tiers. Use string keys such as \"0\", \"1\".",
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Graduated\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Graduated"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Included (fee_type \"included\"). An item included at no charge. Set type to \"Fees::Included\" or fee_type to \"included\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"included\". Alternative to type.",
+ "enum": [
+ "included"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Included\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Included"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Metered (fee_type \"metered\"). Usage-based pricing, billed per unit used. Set type to \"Fees::Metered\" or fee_type to \"metered\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Price per unit of usage in fees_currency. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"metered\". Alternative to type.",
+ "enum": [
+ "metered"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Metered\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Metered"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::OneTime (fee_type \"one_time\"). A one-time charge, such as a setup fee. Set type to \"Fees::OneTime\" or fee_type to \"one_time\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "One-time amount in fees_currency, charged once rather than per fee_period. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"one_time\". Alternative to type.",
+ "enum": [
+ "one_time"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::OneTime\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::OneTime"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Text (fee_type \"text\"). A fee term described in free text. Set type to \"Fees::Text\" or fee_type to \"text\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"text\". Alternative to type.",
+ "enum": [
+ "text"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Text\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Text"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ }
+ ]
+ },
+ "description": "Fee table rows, keyed by string index (\"0\", \"1\", ...). Replaces the template's fees when provided. Each row sets type or fee_type to pick the fee class. Amounts are in the order form's fees_currency and, for recurring fees, are charged per fee_period.",
+ "examples": [
+ {
+ "0": {
+ "cost": 2000,
+ "description": "Platform subscription",
+ "type": "Fees::Flat"
+ }
+ },
+ {
+ "0": {
+ "cost": 50,
+ "description": "Seats",
+ "fee_type": "cost",
+ "quantity": 10
+ },
+ "1": {
+ "cost": 10,
+ "description": "Launch discount",
+ "discount_duration_amount": 3,
+ "discount_duration_type": "multiple_months",
+ "discount_type": "percentage",
+ "fee_type": "discount"
+ }
+ }
+ ],
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+ },
+ "fees_currency": {
+ "enum": [
+ "USD",
+ "EUR",
+ "GBP",
+ "CAD",
+ "AUD",
+ "SGD",
+ "ILS",
+ "JPY",
+ "CHF",
+ "HKD"
+ ],
+ "type": "string"
+ },
+ "fees_include_fee_increase_upon_renewal": {
+ "type": "boolean"
+ },
+ "fees_include_fee_increase_upon_renewal_fee": {
+ "type": "number"
+ },
+ "fees_include_fee_increase_upon_renewal_type": {
+ "enum": [
+ "will",
+ "may"
+ ],
+ "type": "string"
+ },
+ "fees_inclusive_of_taxes": {
+ "type": "boolean"
+ },
+ "framework_terms_type": {
+ "enum": [
+ "new",
+ "existing",
+ "description"
+ ],
+ "type": "string"
+ },
+ "free_trial_days": {
+ "type": "number"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_additional_changes": {
+ "type": "boolean"
+ },
+ "include_additional_parameters_or_limitations": {
+ "type": "boolean"
+ },
+ "include_consumption": {
+ "type": "boolean"
+ },
+ "include_fees": {
+ "type": "boolean"
+ },
+ "include_fees_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_fees_include_attachment": {
+ "type": "boolean"
+ },
+ "include_fees_other": {
+ "type": "boolean"
+ },
+ "include_fees_other_val": {
+ "type": "string"
+ },
+ "include_fees_table": {
+ "type": "boolean"
+ },
+ "include_fees_table_period": {
+ "enum": [
+ "Subscription Period",
+ "month",
+ "year",
+ "User"
+ ],
+ "type": "string"
+ },
+ "include_free_trial": {
+ "type": "boolean"
+ },
+ "include_max_users": {
+ "type": "boolean"
+ },
+ "include_pilot_period": {
+ "type": "boolean"
+ },
+ "include_pilot_period_duration_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_pilot_period_duration_type": {
+ "enum": [
+ "day",
+ "week",
+ "month"
+ ],
+ "type": "string"
+ },
+ "include_pilot_period_include_fees": {
+ "type": "boolean"
+ },
+ "include_pilot_period_include_fees_amount": {
+ "type": "number"
+ },
+ "include_pilot_period_include_modifications": {
+ "type": "boolean"
+ },
+ "include_pilot_period_include_modifications_description": {
+ "type": "string"
+ },
+ "include_product_support": {
+ "type": "boolean"
+ },
+ "include_product_support_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_product_support_description": {
+ "type": "string"
+ },
+ "include_product_support_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_professional_services": {
+ "type": "boolean"
+ },
+ "include_professional_services_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_professional_services_custom_name": {
+ "type": "string"
+ },
+ "include_professional_services_description": {
+ "type": "string"
+ },
+ "include_professional_services_end_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "include_professional_services_fees_description": {
+ "type": "string"
+ },
+ "include_professional_services_include_end_date": {
+ "type": "boolean"
+ },
+ "include_professional_services_include_fees_description": {
+ "type": "boolean"
+ },
+ "include_professional_services_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_sla": {
+ "type": "boolean"
+ },
+ "include_sla_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_sla_description": {
+ "type": "string"
+ },
+ "include_sla_include_response_time": {
+ "type": "boolean"
+ },
+ "include_sla_include_response_time_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_sla_include_response_time_credit": {
+ "type": "number"
+ },
+ "include_sla_include_response_time_duration": {
+ "enum": [
+ "hour",
+ "day",
+ "week",
+ "month",
+ "hours"
+ ],
+ "type": "string"
+ },
+ "include_sla_include_response_time_support_channel": {
+ "type": "string"
+ },
+ "include_sla_include_target_uptime": {
+ "type": "boolean"
+ },
+ "include_sla_maintenance_notice": {
+ "type": "boolean"
+ },
+ "include_sla_maintenance_window": {
+ "type": "boolean"
+ },
+ "include_sla_maintenance_window_type": {
+ "enum": [
+ "standard",
+ "none"
+ ],
+ "type": "string"
+ },
+ "include_sla_standard_maintenance_notice_qty": {
+ "type": "number"
+ },
+ "include_sla_standard_maintenance_notice_unit": {
+ "enum": [
+ "hour",
+ "day",
+ "week",
+ "month"
+ ],
+ "type": "string"
+ },
+ "include_sla_standard_maintenance_window_end_time": {
+ "type": "string"
+ },
+ "include_sla_standard_maintenance_window_friday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_monday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_saturday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_start_time": {
+ "type": "string"
+ },
+ "include_sla_standard_maintenance_window_sunday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_thursday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_time_zone": {
+ "type": "string"
+ },
+ "include_sla_standard_maintenance_window_tuesday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_wednesday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_target_uptime": {
+ "type": "number"
+ },
+ "include_sla_type": {
+ "enum": [
+ "description",
+ "standard",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_subscription_start_date": {
+ "type": "boolean"
+ },
+ "include_subscription_start_date_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "include_usage_review": {
+ "type": "boolean"
+ },
+ "include_usage_review_val": {
+ "type": "string"
+ },
+ "include_use_limitations": {
+ "type": "boolean"
+ },
+ "include_use_limitations_val": {
+ "type": "string"
+ },
+ "invoice_period": {
+ "enum": [
+ "monthly",
+ "quarterly",
+ "semiannually",
+ "annually",
+ "Custom unit",
+ "Monthly",
+ "Quarterly",
+ "Semiannually",
+ "Annually"
+ ],
+ "type": "string"
+ },
+ "invoice_period_custom_unit": {
+ "type": "string"
+ },
+ "max_consumption": {
+ "type": "number"
+ },
+ "max_users": {
+ "type": "number"
+ },
+ "negotiations_allowed": {
+ "description": "When true, the recipient can propose changes to the order form, even when the agreement-level `negotiations_allowed` is false. This only covers the order form.",
+ "type": "boolean"
+ },
+ "order_date_date": {
+ "type": "string"
+ },
+ "order_date_other": {
+ "type": "string"
+ },
+ "order_date_type": {
+ "enum": [
+ "signature",
+ "date",
+ "other"
+ ],
+ "type": "string"
+ },
+ "payment_period": {
+ "type": "number"
+ },
+ "payment_period_timeframe": {
+ "enum": [
+ "Customer's receipt of invoice",
+ "date of invoice"
+ ],
+ "type": "string"
+ },
+ "payment_period_unit": {
+ "enum": [
+ "day(s)",
+ "week(s)",
+ "month(s)",
+ "marketplace_acceptance"
+ ],
+ "type": "string"
+ },
+ "payment_process_automatic_frequency": {
+ "enum": [
+ "monthly",
+ "quarterly",
+ "semiannually",
+ "annually"
+ ],
+ "type": "string"
+ },
+ "payment_process_type": {
+ "enum": [
+ "automatic",
+ "invoice",
+ "custom",
+ "marketplace_acceptance"
+ ],
+ "type": "string"
+ },
+ "payment_process_type_custom_val": {
+ "type": "string"
+ },
+ "payment_process_type_invoice_amount": {
+ "type": "number"
+ },
+ "payment_process_type_invoice_custom_unit": {
+ "type": "string"
+ },
+ "payment_process_type_invoice_duration": {
+ "enum": [
+ "day",
+ "week",
+ "month",
+ "year",
+ "day(s)",
+ "week(s)",
+ "month(s)",
+ "year(s)"
+ ],
+ "type": "string"
+ },
+ "payment_process_type_invoice_duration_start": {
+ "enum": [
+ "Customer's receipt of invoice",
+ "date of invoice"
+ ],
+ "type": "string"
+ },
+ "payment_process_type_invoice_type": {
+ "enum": [
+ "monthly",
+ "quarterly",
+ "semiannually",
+ "annually",
+ "Custom unit"
+ ],
+ "type": "string"
+ },
+ "pilot_period_stripe_product_id": {
+ "type": "string"
+ },
+ "service_credits_attributes": {
+ "additionalProperties": {
+ "additionalProperties": false,
+ "properties": {
+ "credit": {
+ "type": "number"
+ },
+ "max": {
+ "type": "number"
+ },
+ "min": {
+ "type": "number"
+ }
+ },
+ "type": "object"
+ },
+ "description": "Service credits. Use string keys such as \"0\", \"1\".",
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+ },
+ "subscription_auto_renew": {
+ "enum": [
+ "days",
+ "subscription_end"
+ ],
+ "type": "string"
+ },
+ "subscription_period": {
+ "type": "number"
+ },
+ "subscription_period_unit": {
+ "type": "string"
+ },
+ "subscription_renewal_notice_days": {
+ "type": "number"
+ },
+ "subscription_start_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "subscription_start_date_type": {
+ "enum": [
+ "effective_date",
+ "date"
+ ],
+ "type": "string"
+ },
+ "underlying_agreement_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "use_limitations_attributes": {
+ "additionalProperties": {
+ "additionalProperties": false,
+ "properties": {
+ "amount": {
+ "type": "number"
+ },
+ "limitation_type": {
+ "type": "string"
+ },
+ "unit": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "description": "Use limitations. Use string keys such as \"0\", \"1\".",
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+ }
+ },
+ "type": "object"
+ },
+ "custom_field_values": {
+ "description": "Values for a custom template's fields, keyed by the field keys defined in the template's YAML definition. Only used when template_id is a custom template. Template defaults fill any fields you omit; a required field with no default and no submitted value returns a 400 naming the field. Values are validated against the field's input type: select and radio values must be one of the field's options, multiselect values are an array of selections each of which must be one of the field's options, number and currency values must be numeric, date values must be YYYY-MM-DD, and email values must be valid addresses. An invalid value returns a 400 naming the field."
+ },
+ "design_partner_attributes": {
+ "additionalProperties": false,
+ "description": "Override design partner terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "customer_description": {
+ "type": "string"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_fees": {
+ "type": "boolean"
+ },
+ "include_fees_amount": {
+ "type": "number"
+ },
+ "include_fees_description": {
+ "type": "string"
+ },
+ "include_fees_pay_by_amount": {
+ "type": "string"
+ },
+ "include_fees_type": {
+ "enum": [
+ "default_language",
+ "description"
+ ],
+ "type": "string"
+ },
+ "include_fees_unit": {
+ "enum": [
+ "month",
+ "quarter",
+ "year",
+ "Term"
+ ],
+ "type": "string"
+ },
+ "include_program_appear_as_customer_private": {
+ "type": "boolean"
+ },
+ "include_program_appear_as_customer_public": {
+ "type": "boolean"
+ },
+ "include_program_case_study": {
+ "type": "boolean"
+ },
+ "include_program_develop_functionality": {
+ "type": "boolean"
+ },
+ "include_program_develop_functionality_val": {
+ "type": "string"
+ },
+ "include_program_discount": {
+ "type": "boolean"
+ },
+ "include_program_discount_amount": {
+ "type": "number"
+ },
+ "include_program_discount_unit": {
+ "enum": [
+ "U.S. Dollars",
+ "percent"
+ ],
+ "type": "string"
+ },
+ "include_program_participation_feedback": {
+ "type": "boolean"
+ },
+ "include_program_participation_feedback_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_program_participation_feedback_unit": {
+ "enum": [
+ "month",
+ "quarter",
+ "year",
+ "Term"
+ ],
+ "type": "string"
+ },
+ "include_program_partner_other": {
+ "type": "boolean"
+ },
+ "include_program_partner_other_val": {
+ "type": "string"
+ },
+ "include_program_provider_other": {
+ "type": "boolean"
+ },
+ "include_program_provider_other_val": {
+ "type": "string"
+ },
+ "include_program_reference": {
+ "type": "boolean"
+ },
+ "product_description": {
+ "type": "string"
+ },
+ "term_amount": {
+ "type": "number"
+ },
+ "term_unit": {
+ "enum": [
+ "day(s)",
+ "week(s)",
+ "month(s)",
+ "quarter(s)",
+ "year(s)"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "district_or_county": {
+ "description": "The district or county for dispute resolution.",
+ "type": "string"
+ },
+ "dpa_attributes": {
+ "additionalProperties": false,
+ "description": "Override dpa terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "approved_subprocessor_type": {
+ "description": "`internal` lists approved subprocessors in the agreement (`subprocessors_attributes`); `external` points to a list published elsewhere.",
+ "enum": [
+ "internal",
+ "external"
+ ],
+ "type": "string"
+ },
+ "cloud_service_product_name": {
+ "type": "string"
+ },
+ "competent_supervisory_authority": {
+ "type": "string"
+ },
+ "customer_description": {
+ "type": "string"
+ },
+ "data_exporter_address_city": {
+ "type": "string"
+ },
+ "data_exporter_address_country": {
+ "type": "string"
+ },
+ "data_exporter_address_state": {
+ "type": "string"
+ },
+ "data_exporter_address_street_address": {
+ "type": "string"
+ },
+ "data_exporter_address_zipcode": {
+ "type": "string"
+ },
+ "data_exporter_contact_details": {
+ "type": "string"
+ },
+ "data_exporter_contact_name": {
+ "type": "string"
+ },
+ "data_exporter_contact_position": {
+ "type": "string"
+ },
+ "data_exporter_role": {
+ "description": "Role of the data exporter. Overwritten to `Controller` when the agreement is created from a template.",
+ "enum": [
+ "Controller",
+ "Processor"
+ ],
+ "type": "string"
+ },
+ "data_importer_address": {
+ "type": "string"
+ },
+ "data_importer_address_city": {
+ "type": "string"
+ },
+ "data_importer_address_country": {
+ "type": "string"
+ },
+ "data_importer_address_state": {
+ "type": "string"
+ },
+ "data_importer_address_street_address": {
+ "type": "string"
+ },
+ "data_importer_address_zipcode": {
+ "type": "string"
+ },
+ "data_importer_contact_details": {
+ "type": "string"
+ },
+ "data_importer_contact_name": {
+ "type": "string"
+ },
+ "data_importer_contact_position": {
+ "type": "string"
+ },
+ "duration_of_processing": {
+ "type": "string"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_covered_claim": {
+ "type": "boolean"
+ },
+ "include_covered_claim_external_val": {
+ "type": "string"
+ },
+ "include_covered_claim_internal_val": {
+ "type": "string"
+ },
+ "include_covered_claim_type": {
+ "description": "Which covered-claim text applies: `internal` uses `include_covered_claim_internal_val`, `external` uses `include_covered_claim_external_val`. Required when `include_covered_claim` is true.",
+ "enum": [
+ "internal",
+ "external"
+ ],
+ "type": "string"
+ },
+ "include_data_subjects_custom": {
+ "type": "boolean"
+ },
+ "include_data_subjects_custom_val": {
+ "type": "string"
+ },
+ "include_data_subjects_employees": {
+ "type": "boolean"
+ },
+ "include_data_subjects_end_users": {
+ "type": "boolean"
+ },
+ "include_external_subprocessor_location": {
+ "type": "string"
+ },
+ "include_frequency_of_transfer_continuous": {
+ "type": "boolean"
+ },
+ "include_frequency_of_transfer_custom": {
+ "type": "boolean"
+ },
+ "include_frequency_of_transfer_custom_val": {
+ "type": "string"
+ },
+ "include_governing_country_eu": {
+ "type": "boolean"
+ },
+ "include_governing_country_eu_val": {
+ "type": "string"
+ },
+ "include_governing_country_uk": {
+ "type": "boolean"
+ },
+ "include_governing_country_uk_val": {
+ "type": "string"
+ },
+ "include_governing_law": {
+ "type": "boolean"
+ },
+ "include_governing_law_country": {
+ "type": "string"
+ },
+ "include_governing_law_state": {
+ "type": "string"
+ },
+ "include_increased_claim_amount": {
+ "description": "Legacy field. Stored but not shown on the DPA; use the `include_liability_cap*` fields instead.",
+ "type": "boolean"
+ },
+ "include_increased_claim_amount_currency": {
+ "description": "Legacy field. Stored but not shown on the DPA; use the `include_liability_cap*` fields instead."
+ },
+ "include_increased_claim_amount_qty": {
+ "description": "Legacy field. Stored but not shown on the DPA; use the `include_liability_cap*` fields instead."
+ },
+ "include_increased_claim_amount_type": {
+ "description": "Legacy field. Stored but not shown on the DPA; use the `include_liability_cap*` fields instead.",
+ "type": "string"
+ },
+ "include_liability_cap": {
+ "type": "boolean"
+ },
+ "include_liability_cap_amount_constant_external": {
+ "type": "string"
+ },
+ "include_liability_cap_amount_constant_internal": {
+ "type": "string"
+ },
+ "include_liability_cap_amount_currency_external": {
+ "description": "Currency amount. Numbers and numeric strings (commas allowed) are both accepted."
+ },
+ "include_liability_cap_amount_currency_internal": {
+ "description": "Currency amount. Numbers and numeric strings (commas allowed) are both accepted."
+ },
+ "include_liability_cap_csa_type": {
+ "description": "Which liability cap values apply: the `_internal` or `_external` amount fields. Required when `include_liability_cap` is true.",
+ "enum": [
+ "internal",
+ "external"
+ ],
+ "type": "string"
+ },
+ "include_personal_data_biographic_info": {
+ "type": "boolean"
+ },
+ "include_personal_data_contact_info": {
+ "type": "boolean"
+ },
+ "include_personal_data_custom": {
+ "type": "boolean"
+ },
+ "include_personal_data_custom_val": {
+ "type": "string"
+ },
+ "include_personal_data_employment_info": {
+ "type": "boolean"
+ },
+ "include_personal_data_financial_info": {
+ "type": "boolean"
+ },
+ "include_personal_data_location": {
+ "type": "boolean"
+ },
+ "include_personal_data_name": {
+ "type": "boolean"
+ },
+ "include_personal_data_transactional_info": {
+ "type": "boolean"
+ },
+ "include_personal_data_user_activity_info": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_custom": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_custom_val": {
+ "type": "string"
+ },
+ "include_processing_purpose_erasing": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_holding": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_protecting": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_receiving": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_returning": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_sharing": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_updating": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_using": {
+ "type": "boolean"
+ },
+ "include_provider_security_contact_address": {
+ "type": "boolean"
+ },
+ "include_provider_security_contact_address_city": {
+ "type": "string"
+ },
+ "include_provider_security_contact_address_country": {
+ "type": "string"
+ },
+ "include_provider_security_contact_address_state": {
+ "type": "string"
+ },
+ "include_provider_security_contact_address_street_address": {
+ "type": "string"
+ },
+ "include_provider_security_contact_address_zipcode": {
+ "type": "string"
+ },
+ "include_provider_security_contact_email": {
+ "type": "boolean"
+ },
+ "include_provider_security_contact_email_val": {
+ "format": "email",
+ "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "include_security_measures_accountability": {
+ "type": "boolean"
+ },
+ "include_security_measures_accountability_val": {
+ "type": "string"
+ },
+ "include_security_measures_certification_or_assurance": {
+ "type": "boolean"
+ },
+ "include_security_measures_certification_or_assurance_val": {
+ "type": "string"
+ },
+ "include_security_measures_confidentiality_integrity": {
+ "type": "boolean"
+ },
+ "include_security_measures_confidentiality_integrity_val": {
+ "type": "string"
+ },
+ "include_security_measures_data_at_rest": {
+ "type": "boolean"
+ },
+ "include_security_measures_data_at_rest_val": {
+ "type": "string"
+ },
+ "include_security_measures_data_minimization": {
+ "type": "boolean"
+ },
+ "include_security_measures_data_minimization_val": {
+ "type": "string"
+ },
+ "include_security_measures_data_quality": {
+ "type": "boolean"
+ },
+ "include_security_measures_data_quality_val": {
+ "type": "string"
+ },
+ "include_security_measures_data_retention": {
+ "type": "boolean"
+ },
+ "include_security_measures_data_retention_val": {
+ "type": "string"
+ },
+ "include_security_measures_data_transmission": {
+ "type": "boolean"
+ },
+ "include_security_measures_data_transmission_val": {
+ "type": "string"
+ },
+ "include_security_measures_event_logging": {
+ "type": "boolean"
+ },
+ "include_security_measures_event_logging_val": {
+ "type": "string"
+ },
+ "include_security_measures_identity_auth": {
+ "type": "boolean"
+ },
+ "include_security_measures_identity_auth_val": {
+ "type": "string"
+ },
+ "include_security_measures_it_security_governance": {
+ "type": "boolean"
+ },
+ "include_security_measures_it_security_governance_val": {
+ "type": "string"
+ },
+ "include_security_measures_physical_security": {
+ "type": "boolean"
+ },
+ "include_security_measures_physical_security_val": {
+ "type": "string"
+ },
+ "include_security_measures_portability_and_erasure": {
+ "type": "boolean"
+ },
+ "include_security_measures_portability_and_erasure_val": {
+ "type": "string"
+ },
+ "include_security_measures_pseudonym_encryption": {
+ "type": "boolean"
+ },
+ "include_security_measures_pseudonym_encryption_val": {
+ "type": "string"
+ },
+ "include_security_measures_restore_data_access": {
+ "type": "boolean"
+ },
+ "include_security_measures_restore_data_access_val": {
+ "type": "string"
+ },
+ "include_security_measures_security_policy": {
+ "type": "boolean"
+ },
+ "include_security_measures_system_configuration": {
+ "type": "boolean"
+ },
+ "include_security_measures_system_configuration_val": {
+ "type": "string"
+ },
+ "include_security_measures_testing_assessment": {
+ "type": "boolean"
+ },
+ "include_security_measures_testing_assessment_val": {
+ "type": "string"
+ },
+ "include_security_policy": {
+ "type": "boolean"
+ },
+ "include_security_policy_fedramp_auth": {
+ "type": "boolean"
+ },
+ "include_security_policy_hipaa": {
+ "type": "boolean"
+ },
+ "include_security_policy_hitrust": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_other": {
+ "type": "boolean"
+ },
+ "include_security_policy_iso27001": {
+ "type": "boolean"
+ },
+ "include_security_policy_other": {
+ "type": "string"
+ },
+ "include_security_policy_pci1": {
+ "type": "boolean"
+ },
+ "include_security_policy_pci2": {
+ "type": "boolean"
+ },
+ "include_security_policy_penetration_testing": {
+ "type": "boolean"
+ },
+ "include_security_policy_soc2": {
+ "type": "boolean"
+ },
+ "include_security_policy_soc2_type2": {
+ "type": "boolean"
+ },
+ "include_sensitive_data_restrictions_custom": {
+ "type": "boolean"
+ },
+ "include_sensitive_data_restrictions_custom_val": {
+ "type": "string"
+ },
+ "include_sensitive_data_restrictions_security_policy": {
+ "type": "boolean"
+ },
+ "include_service_provider_relationship": {
+ "type": "boolean"
+ },
+ "include_special_category_data": {
+ "type": "boolean"
+ },
+ "provider": {
+ "type": "string"
+ },
+ "security_policy_available_at": {
+ "type": "string"
+ },
+ "security_policy_type": {
+ "description": "Where the Security Policy is defined. For `external`, set `security_policy_available_at`.",
+ "enum": [
+ "defined in agreement",
+ "provider service",
+ "external"
+ ],
+ "type": "string"
+ },
+ "subprocessors_attributes": {
+ "additionalProperties": {
+ "additionalProperties": false,
+ "properties": {
+ "_destroy": {
+ "description": "Set to true with `id` to remove that subprocessor.",
+ "type": "boolean"
+ },
+ "country": {
+ "type": "string"
+ },
+ "id": {
+ "description": "ID of an existing subprocessor to update or remove. Omit to add a new subprocessor.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "processing_task": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "description": "Subprocessors, keyed by string index such as \"0\", \"1\". On create these are added to the template's subprocessors. On a draft update, an entry without `id` adds a new subprocessor; pass `id` to change one and `id` with `_destroy: true` to remove one.",
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+ },
+ "underlying_agreement_id": {
+ "description": "ID of the CSA this DPA supplements when `underlying_agreement_type` is `internal`.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "underlying_agreement_type": {
+ "description": "`internal` links a CSA in Common Paper (`underlying_agreement_id`, required); `external` describes another agreement in `underlying_agreement_val` (required). Defaults to `internal` when omitted on create.",
+ "enum": [
+ "internal",
+ "external"
+ ],
+ "type": "string"
+ },
+ "underlying_agreement_val": {
+ "description": "Description of the agreement this DPA supplements. Required when `underlying_agreement_type` is `external`.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "framework_terms_description": {
+ "description": "Custom framework terms description. Only used when framework_terms_type is \"description\".",
+ "type": "string"
+ },
+ "framework_terms_type": {
+ "description": "How framework terms are specified. Use \"new\" for standard terms or \"description\" to provide a custom framework_terms_description.",
+ "enum": [
+ "new",
+ "description"
+ ],
+ "type": "string"
+ },
+ "governing_law_country": {
+ "description": "The country whose laws govern the agreement.",
+ "type": "string"
+ },
+ "governing_law_region": {
+ "description": "The state or region whose laws govern the agreement.",
+ "type": "string"
+ },
+ "include_automated_payment_reminders": {
+ "description": "When true, automatically sends payment reminder emails.",
+ "type": "boolean"
+ },
+ "include_billing_info": {
+ "description": "When true, billing contact information (billing_name, billing_email) is included.",
+ "type": "boolean"
+ },
+ "include_billing_workflow": {
+ "description": "When true, enables a billing workflow after signing.",
+ "type": "boolean"
+ },
+ "include_expiration_date": {
+ "description": "Expiration date in YYYY-MM-DD format. Use when include_expiration_type is \"date\".",
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "include_expiration_days": {
+ "description": "Number of days until the agreement expires. Use when include_expiration_type is \"days\".",
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_expiration_type": {
+ "description": "How to set expiration: \"none\" (default), \"days\" (use include_expiration_days), or \"date\" (use include_expiration_date).",
+ "enum": [
+ "none",
+ "days",
+ "date"
+ ],
+ "type": "string"
+ },
+ "include_terms": {
+ "description": "When true, the standard terms are included with the agreement.",
+ "type": "boolean"
+ },
+ "loi_attributes": {
+ "additionalProperties": false,
+ "description": "Override loi terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "confidentiality_custom": {
+ "type": "string"
+ },
+ "confidentiality_mutual_include_loi": {
+ "type": "boolean"
+ },
+ "confidentiality_nda_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "confidentiality_nda_description": {
+ "type": "string"
+ },
+ "confidentiality_nda_include_loi": {
+ "type": "boolean"
+ },
+ "confidentiality_nda_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "confidentiality_type": {
+ "enum": [
+ "mutual",
+ "nda",
+ "provider",
+ "custom"
+ ],
+ "type": "string"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_custom_details": {
+ "type": "boolean"
+ },
+ "include_custom_details_val": {
+ "type": "string"
+ },
+ "include_fees": {
+ "type": "boolean"
+ },
+ "include_fees_amount": {
+ "type": "number"
+ },
+ "include_fees_amount_duration": {
+ "enum": [
+ "month",
+ "year",
+ "quarter"
+ ],
+ "type": "string"
+ },
+ "include_fees_include_amount": {
+ "type": "boolean"
+ },
+ "include_fees_include_other": {
+ "type": "boolean"
+ },
+ "include_fees_other": {
+ "type": "string"
+ },
+ "include_functionality": {
+ "type": "boolean"
+ },
+ "include_functionality_val": {
+ "type": "string"
+ },
+ "include_launch_date": {
+ "type": "boolean"
+ },
+ "include_launch_date_custom": {
+ "type": "string"
+ },
+ "include_launch_date_date": {
+ "format": "date-time",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$",
+ "type": "string"
+ },
+ "include_launch_date_type": {
+ "enum": [
+ "date",
+ "custom"
+ ],
+ "type": "string"
+ },
+ "product_name": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "manual_send": {
+ "description": "When true, the agreement is marked as manually sent outside the platform.",
+ "type": "boolean"
+ },
+ "message": {
+ "type": "string"
+ },
+ "negotiations_allowed": {
+ "description": "When true, the recipient can propose changes to the legal terms. For agreement types without separate business terms, that covers every term. CSA order forms, PSA statements of work, partnership business terms and software license order forms have their own `negotiations_allowed` flag.",
+ "type": "boolean"
+ },
+ "partnership_attributes": {
+ "additionalProperties": false,
+ "description": "Override partnership terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "effective_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "effective_date_type": {
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "type": "string"
+ },
+ "general_cap_amount_currency_val": {
+ "type": "number"
+ },
+ "general_cap_amount_either_currency": {
+ "type": "number"
+ },
+ "general_cap_amount_either_multiple": {
+ "type": "number"
+ },
+ "general_cap_amount_multiple_val": {
+ "type": "number"
+ },
+ "general_cap_amount_type": {
+ "enum": [
+ "multiple",
+ "currency",
+ "either",
+ "base"
+ ],
+ "type": "string"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_additional_warranties": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_include_company": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_include_company_val": {
+ "type": "string"
+ },
+ "include_additional_warranties_include_partner": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_include_partner_val": {
+ "type": "string"
+ },
+ "include_brand_guidelines": {
+ "type": "boolean"
+ },
+ "include_brand_guidelines_include_company": {
+ "type": "boolean"
+ },
+ "include_brand_guidelines_include_company_val": {
+ "type": "string"
+ },
+ "include_brand_guidelines_include_partner": {
+ "type": "boolean"
+ },
+ "include_brand_guidelines_include_partner_val": {
+ "type": "string"
+ },
+ "include_covered_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_company_claims": {
+ "type": "string"
+ },
+ "include_covered_claims_include_company_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_include_partner_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_partner_claims": {
+ "type": "string"
+ },
+ "include_dpa": {
+ "type": "boolean"
+ },
+ "include_dpa_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_dpa_location": {
+ "type": "string"
+ },
+ "include_dpa_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_increased_cap_amount": {
+ "type": "boolean"
+ },
+ "include_increased_cap_amount_currency": {
+ "type": "number"
+ },
+ "include_increased_cap_amount_either_currency": {
+ "type": "number"
+ },
+ "include_increased_cap_amount_either_multiple": {
+ "type": "string"
+ },
+ "include_increased_cap_amount_multiple": {
+ "type": "string"
+ },
+ "include_increased_cap_amount_type": {
+ "enum": [
+ "multiple",
+ "currency",
+ "either"
+ ],
+ "type": "string"
+ },
+ "include_increased_claims": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_confidentiality": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_confidentiality_misconduct": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_covered_claims": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_misconduct": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_other": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_other_val": {
+ "type": "string"
+ },
+ "include_unlimited_claims": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_confidentiality": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_confidentiality_misconduct": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_covered_claims": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_misconduct": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_other": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_other_val": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "partnership_business_terms_attributes": {
+ "additionalProperties": false,
+ "description": "Override partnership business terms terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "end_date_after_effective_date_amount": {
+ "type": "number"
+ },
+ "end_date_after_effective_date_unit": {
+ "enum": [
+ "month(s)",
+ "quarter(s)",
+ "year(s)"
+ ],
+ "type": "string"
+ },
+ "end_date_date": {
+ "type": "string"
+ },
+ "end_date_type": {
+ "enum": [
+ "date",
+ "effective date"
+ ],
+ "type": "string"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_obligations_company_brand": {
+ "type": "boolean"
+ },
+ "include_obligations_company_promotion": {
+ "type": "boolean"
+ },
+ "include_obligations_company_promotion_include_activities": {
+ "type": "boolean"
+ },
+ "include_obligations_company_promotion_include_activities_val": {
+ "type": "string"
+ },
+ "include_obligations_company_promotion_include_materials": {
+ "type": "boolean"
+ },
+ "include_obligations_company_promotion_include_materials_val": {
+ "type": "string"
+ },
+ "include_obligations_company_referral": {
+ "type": "boolean"
+ },
+ "include_obligations_company_referral_include_criteria": {
+ "type": "boolean"
+ },
+ "include_obligations_company_referral_include_criteria_val": {
+ "type": "string"
+ },
+ "include_obligations_company_referral_include_pay_sch": {
+ "type": "boolean"
+ },
+ "include_obligations_company_referral_include_pay_sch_amount": {
+ "type": "number"
+ },
+ "include_obligations_company_referral_include_pay_sch_custom": {
+ "type": "string"
+ },
+ "include_obligations_company_referral_include_pay_sch_unit": {
+ "enum": [
+ "U.S. Dollars",
+ "percent"
+ ],
+ "type": "string"
+ },
+ "include_obligations_company_sponsorship": {
+ "type": "boolean"
+ },
+ "include_obligations_company_sponsorship_include_benefits": {
+ "type": "boolean"
+ },
+ "include_obligations_company_sponsorship_include_benefits_val": {
+ "type": "string"
+ },
+ "include_obligations_company_sponsorship_include_payments": {
+ "type": "boolean"
+ },
+ "include_obligations_company_sponsorship_include_payments_amount": {
+ "type": "number"
+ },
+ "include_obligations_company_sponsorship_include_payments_unit": {
+ "enum": [
+ "U.S. Dollars",
+ "percent"
+ ],
+ "type": "string"
+ },
+ "include_obligations_partner_brand": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_promotion": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_promotion_include_activities": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_promotion_include_activities_val": {
+ "type": "string"
+ },
+ "include_obligations_partner_promotion_include_materials": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_promotion_include_materials_val": {
+ "type": "string"
+ },
+ "include_obligations_partner_referral": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_referral_include_criteria": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_referral_include_criteria_val": {
+ "type": "string"
+ },
+ "include_obligations_partner_referral_include_pay_sch": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_referral_include_pay_sch_amount": {
+ "type": "number"
+ },
+ "include_obligations_partner_referral_include_pay_sch_custom": {
+ "type": "string"
+ },
+ "include_obligations_partner_referral_include_pay_sch_unit": {
+ "enum": [
+ "U.S. Dollars",
+ "percent"
+ ],
+ "type": "string"
+ },
+ "include_obligations_partner_sponsorship": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_sponsorship_include_benefits": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_sponsorship_include_benefits_val": {
+ "type": "string"
+ },
+ "include_obligations_partner_sponsorship_include_payments": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_sponsorship_include_payments_amount": {
+ "type": "number"
+ },
+ "include_obligations_partner_sponsorship_include_payments_unit": {
+ "enum": [
+ "U.S. Dollars",
+ "percent"
+ ],
+ "type": "string"
+ },
+ "include_payment_process": {
+ "type": "boolean"
+ },
+ "include_payment_process_company": {
+ "type": "boolean"
+ },
+ "include_payment_process_company_include_address": {
+ "type": "boolean"
+ },
+ "include_payment_process_company_include_address_city": {
+ "type": "string"
+ },
+ "include_payment_process_company_include_address_country": {
+ "type": "string"
+ },
+ "include_payment_process_company_include_address_state": {
+ "type": "string"
+ },
+ "include_payment_process_company_include_address_street_address": {
+ "type": "string"
+ },
+ "include_payment_process_company_include_address_zipcode": {
+ "type": "string"
+ },
+ "include_payment_process_company_include_email": {
+ "type": "boolean"
+ },
+ "include_payment_process_company_include_email_val": {
+ "type": "string"
+ },
+ "include_payment_process_partner": {
+ "type": "boolean"
+ },
+ "include_payment_process_partner_include_address": {
+ "type": "boolean"
+ },
+ "include_payment_process_partner_include_address_city": {
+ "type": "string"
+ },
+ "include_payment_process_partner_include_address_country": {
+ "type": "string"
+ },
+ "include_payment_process_partner_include_address_state": {
+ "type": "string"
+ },
+ "include_payment_process_partner_include_address_street_address": {
+ "type": "string"
+ },
+ "include_payment_process_partner_include_address_zipcode": {
+ "type": "string"
+ },
+ "include_payment_process_partner_include_email": {
+ "type": "boolean"
+ },
+ "include_payment_process_partner_include_email_val": {
+ "type": "string"
+ },
+ "include_payment_schedule": {
+ "type": "boolean"
+ },
+ "include_payment_schedule_custom": {
+ "type": "string"
+ },
+ "include_payment_schedule_specified_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_payment_schedule_specified_timeframe": {
+ "enum": [
+ "receipt",
+ "date"
+ ],
+ "type": "string"
+ },
+ "include_payment_schedule_specified_unit": {
+ "enum": [
+ "day(s)",
+ "week(s)",
+ "month(s)",
+ "quarter(s)",
+ "year(s)"
+ ],
+ "type": "string"
+ },
+ "include_payment_schedule_type": {
+ "enum": [
+ "specified",
+ "custom"
+ ],
+ "type": "string"
+ },
+ "negotiations_allowed": {
+ "description": "When true, the recipient can propose changes to the business terms, even when the agreement-level `negotiations_allowed` is false. This only covers the business terms.",
+ "type": "boolean"
+ },
+ "territory_type": {
+ "enum": [
+ "worldwide",
+ "custom"
+ ],
+ "type": "string"
+ },
+ "territory_type_val": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "payment_link_url": {
+ "description": "A payment URL shown to the recipient after signing. Requires include_billing_workflow to be true and billing_workflow_type to be \"link\".",
+ "type": "string"
+ },
+ "pilot_attributes": {
+ "additionalProperties": false,
+ "description": "Override pilot terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "fees_type": {
+ "enum": [
+ "free",
+ "pilot_period_fees"
+ ],
+ "type": "string"
+ },
+ "general_cap_amount": {
+ "type": "number"
+ },
+ "general_cap_amount_type": {
+ "enum": [
+ "preceding",
+ "base",
+ "period"
+ ],
+ "type": "string"
+ },
+ "general_cap_period_currency": {
+ "type": "number"
+ },
+ "general_cap_period_qty": {
+ "type": "number"
+ },
+ "general_cap_preceding_amount": {
+ "type": "number"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_dpa": {
+ "type": "boolean"
+ },
+ "include_dpa_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_dpa_location": {
+ "type": "string"
+ },
+ "include_dpa_type": {
+ "enum": [
+ "description",
+ "attachment",
+ "standard"
+ ],
+ "type": "string"
+ },
+ "include_payment_process": {
+ "type": "boolean"
+ },
+ "include_technical_support": {
+ "type": "boolean"
+ },
+ "payment_process_automatic_frequency": {
+ "enum": [
+ "monthly",
+ "quarterly",
+ "annually",
+ "once_per_period"
+ ],
+ "type": "string"
+ },
+ "payment_process_invoice_days": {
+ "type": "number"
+ },
+ "payment_process_invoice_from": {
+ "enum": [
+ "receipt",
+ "date"
+ ],
+ "type": "string"
+ },
+ "payment_process_invoice_timeframe": {
+ "enum": [
+ "days",
+ "weeks",
+ "months",
+ "quarters",
+ "years"
+ ],
+ "type": "string"
+ },
+ "payment_process_type": {
+ "enum": [
+ "automatic",
+ "invoice"
+ ],
+ "type": "string"
+ },
+ "pilot_period_description": {
+ "type": "string"
+ },
+ "pilot_period_fees_description": {
+ "type": "string"
+ },
+ "product_description": {
+ "type": "string"
+ },
+ "technical_support_description": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "psa_attributes": {
+ "additionalProperties": false,
+ "description": "Override psa terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "additional_changes": {
+ "type": "string"
+ },
+ "customer_description": {
+ "type": "string"
+ },
+ "effective_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "effective_date_type": {
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "type": "string"
+ },
+ "general_cap_amount": {
+ "type": "number"
+ },
+ "general_cap_amount_type": {
+ "enum": [
+ "preceding",
+ "base",
+ "period"
+ ],
+ "type": "string"
+ },
+ "general_cap_period_currency": {
+ "type": "number"
+ },
+ "general_cap_period_qty": {
+ "type": "number"
+ },
+ "general_cap_preceding_amount": {
+ "type": "number"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_additional_changes": {
+ "type": "boolean"
+ },
+ "include_additional_warranties": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_by_customer": {
+ "type": "string"
+ },
+ "include_additional_warranties_by_provider": {
+ "type": "string"
+ },
+ "include_additional_warranties_include_by_customer": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_include_by_provider": {
+ "type": "boolean"
+ },
+ "include_covered_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_customer_claims": {
+ "type": "string"
+ },
+ "include_covered_claims_include_customer_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_include_provider_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_provider_claims": {
+ "type": "string"
+ },
+ "include_customer_insurance_min": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_add_provider_com_gen_liability": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_add_provider_cyber_liability": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_add_provider_errors_omissions": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_auto_liability_aggregate": {
+ "type": "number"
+ },
+ "include_customer_insurance_min_auto_liability_minimum": {
+ "type": "number"
+ },
+ "include_customer_insurance_min_cyber_liability_aggregate": {
+ "type": "number"
+ },
+ "include_customer_insurance_min_cyber_liability_minimum": {
+ "type": "number"
+ },
+ "include_customer_insurance_min_employer_liability_aggregate": {
+ "type": "number"
+ },
+ "include_customer_insurance_min_employer_liability_minimum": {
+ "type": "number"
+ },
+ "include_customer_insurance_min_general_liability_aggregate": {
+ "type": "number"
+ },
+ "include_customer_insurance_min_general_liability_minimum": {
+ "type": "number"
+ },
+ "include_customer_insurance_min_include_add_provider": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_include_auto_liability": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_include_cyber_liability": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_include_employer_liability": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_include_general_liability": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_include_workers_comp": {
+ "type": "boolean"
+ },
+ "include_customer_policies": {
+ "type": "boolean"
+ },
+ "include_customer_policies_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_customer_policies_location": {
+ "type": "string"
+ },
+ "include_customer_policies_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_dpa": {
+ "type": "boolean"
+ },
+ "include_dpa_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_dpa_location": {
+ "type": "string"
+ },
+ "include_dpa_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_increased_cap_amount": {
+ "type": "boolean"
+ },
+ "include_increased_claims": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_confidentiality": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_confidentiality_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_privsec": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_privsec_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_other": {
+ "type": "boolean"
+ },
+ "include_increased_claims_indemnification_obligation": {
+ "type": "boolean"
+ },
+ "include_increased_claims_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_other": {
+ "type": "string"
+ },
+ "include_provider_insurance_min": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_add_customer_com_gen_liability": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_add_customer_cyber_liability": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_add_customer_errors_omissions": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_auto_liability_aggregate": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_auto_liability_minimum": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_cyber_liability_aggregate": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_cyber_liability_minimum": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_employer_liability_aggregate": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_employer_liability_minimum": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_general_liability_aggregate": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_general_liability_minimum": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_include_add_customer": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_include_auto_liability": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_include_cyber_liability": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_include_employer_liability": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_include_general_liability": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_include_workers_comp": {
+ "type": "boolean"
+ },
+ "include_publicity_rights": {
+ "type": "boolean"
+ },
+ "include_publicity_rights_type": {
+ "enum": [
+ "public",
+ "non-public"
+ ],
+ "type": "string"
+ },
+ "include_security_policy": {
+ "type": "boolean"
+ },
+ "include_security_policy_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_security_policy_fedramp_auth": {
+ "type": "boolean"
+ },
+ "include_security_policy_hitrust": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_annual_maintenance": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_other": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_other_val": {
+ "type": "string"
+ },
+ "include_security_policy_iso27001": {
+ "type": "boolean"
+ },
+ "include_security_policy_location": {
+ "type": "string"
+ },
+ "include_security_policy_pci1": {
+ "type": "boolean"
+ },
+ "include_security_policy_pci2": {
+ "type": "boolean"
+ },
+ "include_security_policy_penetration_testing": {
+ "type": "boolean"
+ },
+ "include_security_policy_soc2_type1": {
+ "type": "boolean"
+ },
+ "include_security_policy_soc2_type2": {
+ "type": "boolean"
+ },
+ "include_security_policy_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_unlimited_claims": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_confidentiality": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_confidentiality_negligence": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_privsec": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_privsec_negligence": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_include_other": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_indemnification_obligation": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_negligence": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_other": {
+ "type": "string"
+ },
+ "increased_cap_amount_currency": {
+ "type": "number"
+ },
+ "increased_cap_amount_period_currency": {
+ "type": "number"
+ },
+ "increased_cap_amount_period_qty": {
+ "type": "number"
+ },
+ "increased_cap_amount_qty": {
+ "type": "number"
+ },
+ "increased_cap_amount_type": {
+ "enum": [
+ "qty",
+ "currency",
+ "period"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "psa_statement_of_work_attributes": {
+ "additionalProperties": false,
+ "description": "Override psa statement of work terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "additional_changes": {
+ "type": "string"
+ },
+ "cost": {
+ "type": "number"
+ },
+ "description": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "fees_attributes": {
+ "additionalProperties": {
+ "anyOf": [
+ {
+ "additionalProperties": false,
+ "description": "Fees::Flat (fee_type \"flat\"). A fixed recurring fee, e.g. a platform subscription. Set type to \"Fees::Flat\" or fee_type to \"flat\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Fixed amount in the order form's fees_currency, charged per fee_period. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"flat\". Alternative to type.",
+ "enum": [
+ "flat"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Flat\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Flat"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Discount (fee_type \"discount\"). A discount, as a fixed amount or a percentage, applied forever, once, or for a number of months. Set type to \"Fees::Discount\" or fee_type to \"discount\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Discount size: an amount in fees_currency when discount_type is fixed_amount (a plain amount, not cents: 20 means 20.00), or a percentage (e.g. 10 for 10%) when it is percentage.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "discount_duration_amount": {
+ "description": "Number of months the discount applies. Required when discount_duration_type is multiple_months.",
+ "type": "number"
+ },
+ "discount_duration_type": {
+ "description": "How long the discount applies. multiple_months also needs discount_duration_amount.",
+ "enum": [
+ "forever",
+ "once",
+ "multiple_months"
+ ],
+ "type": "string"
+ },
+ "discount_type": {
+ "description": "Whether cost is a currency amount or a percentage.",
+ "enum": [
+ "fixed_amount",
+ "percentage"
+ ],
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"discount\". Alternative to type.",
+ "enum": [
+ "discount"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Discount\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Discount"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Cost (fee_type \"cost\"). A per-unit fee: price per unit times quantity, e.g. seats. Set type to \"Fees::Cost\" or fee_type to \"cost\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Price per unit in fees_currency. The row total is quantity x cost. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"cost\". Alternative to type.",
+ "enum": [
+ "cost"
+ ],
+ "type": "string"
+ },
+ "quantity": {
+ "description": "Number of units.",
+ "type": "number"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Cost\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Cost"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Attachment (fee_type \"attachment\"). A fee described in an uploaded attachment instead of in the table. Set type to \"Fees::Attachment\" or fee_type to \"attachment\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "attachment_id": {
+ "description": "ID of an attachment uploaded with upload-attachment.",
+ "type": "string"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"attachment\". Alternative to type.",
+ "enum": [
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Attachment\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Attachment"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Graduated (fee_type \"graduated\"). Tiered pricing, with the price set per tier in graduated_fee_tiers_attributes. Set type to \"Fees::Graduated\" or fee_type to \"graduated\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"graduated\". Alternative to type.",
+ "enum": [
+ "graduated"
+ ],
+ "type": "string"
+ },
+ "graduated_fee_tiers_attributes": {
+ "additionalProperties": {
+ "additionalProperties": false,
+ "properties": {
+ "flat_price": {
+ "type": "number"
+ },
+ "price_per_unit": {
+ "type": "string"
+ },
+ "upper_limit": {
+ "type": "number"
+ }
+ },
+ "type": "object"
+ },
+ "description": "Graduated fee tiers. Use string keys such as \"0\", \"1\".",
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Graduated\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Graduated"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Included (fee_type \"included\"). An item included at no charge. Set type to \"Fees::Included\" or fee_type to \"included\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"included\". Alternative to type.",
+ "enum": [
+ "included"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Included\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Included"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Metered (fee_type \"metered\"). Usage-based pricing, billed per unit used. Set type to \"Fees::Metered\" or fee_type to \"metered\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Price per unit of usage in fees_currency. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"metered\". Alternative to type.",
+ "enum": [
+ "metered"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Metered\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Metered"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::OneTime (fee_type \"one_time\"). A one-time charge, such as a setup fee. Set type to \"Fees::OneTime\" or fee_type to \"one_time\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "One-time amount in fees_currency, charged once rather than per fee_period. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"one_time\". Alternative to type.",
+ "enum": [
+ "one_time"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::OneTime\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::OneTime"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Text (fee_type \"text\"). A fee term described in free text. Set type to \"Fees::Text\" or fee_type to \"text\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"text\". Alternative to type.",
+ "enum": [
+ "text"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Text\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Text"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ }
+ ]
+ },
+ "description": "Fee line items. Use string keys such as \"0\", \"1\". Replaces template fees when provided.",
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_additional_changes": {
+ "type": "boolean"
+ },
+ "include_customer_obligation": {
+ "type": "boolean"
+ },
+ "include_customer_obligation_val": {
+ "type": "string"
+ },
+ "include_deliverables": {
+ "type": "boolean"
+ },
+ "include_deliverables_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_deliverables_description": {
+ "type": "string"
+ },
+ "include_deliverables_include_acceptance": {
+ "type": "boolean"
+ },
+ "include_deliverables_include_attachment": {
+ "type": "boolean"
+ },
+ "include_deliverables_include_draft_deliverables": {
+ "type": "boolean"
+ },
+ "include_deliverables_rejection_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_deliverables_rejection_unit": {
+ "enum": [
+ "hours",
+ "days",
+ "weeks",
+ "months"
+ ],
+ "type": "string"
+ },
+ "include_deliverables_resubmission_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_deliverables_resubmission_unit": {
+ "enum": [
+ "hours",
+ "days",
+ "weeks",
+ "months"
+ ],
+ "type": "string"
+ },
+ "include_fees_other": {
+ "type": "boolean"
+ },
+ "include_fees_other_val": {
+ "type": "string"
+ },
+ "include_fees_table": {
+ "type": "boolean"
+ },
+ "include_fees_table_total": {
+ "type": "boolean"
+ },
+ "include_fees_travel": {
+ "type": "boolean"
+ },
+ "include_fees_travel_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_fees_travel_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_fees_travel_val": {
+ "type": "string"
+ },
+ "include_third_party_customer": {
+ "type": "boolean"
+ },
+ "include_third_party_include_description": {
+ "type": "boolean"
+ },
+ "include_third_party_include_description_val": {
+ "type": "string"
+ },
+ "include_third_party_materials": {
+ "type": "boolean"
+ },
+ "include_third_party_provider": {
+ "type": "boolean"
+ },
+ "include_time_of_assignment": {
+ "type": "boolean"
+ },
+ "include_time_of_assignment_type": {
+ "enum": [
+ "created",
+ "paid"
+ ],
+ "type": "string"
+ },
+ "invoice_period_description": {
+ "type": "string"
+ },
+ "negotiations_allowed": {
+ "description": "When true, the recipient can propose changes to the statement of work, even when the agreement-level `negotiations_allowed` is false. This only covers the statement of work.",
+ "type": "boolean"
+ },
+ "payment_period": {
+ "type": "number"
+ },
+ "payment_period_other": {
+ "type": "string"
+ },
+ "payment_period_timeframe": {
+ "enum": [
+ "receipt",
+ "invoice",
+ "Customer's receipt of invoice",
+ "date of invoice"
+ ],
+ "type": "string"
+ },
+ "payment_period_type": {
+ "enum": [
+ "standard",
+ "other"
+ ],
+ "type": "string"
+ },
+ "payment_period_unit": {
+ "enum": [
+ "day(s)",
+ "week(s)",
+ "month(s)",
+ "quarter(s)",
+ "year(s)"
+ ],
+ "type": "string"
+ },
+ "quantity": {
+ "type": "number"
+ },
+ "services_description": {
+ "type": "string"
+ },
+ "sow_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "sow_date_type": {
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "type": "string"
+ },
+ "sow_term_amount": {
+ "type": "number"
+ },
+ "sow_term_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "sow_term_type": {
+ "enum": [
+ "deliverables",
+ "period",
+ "date"
+ ],
+ "type": "string"
+ },
+ "sow_term_unit": {
+ "enum": [
+ "month(s)",
+ "quarter(s)",
+ "year(s)"
+ ],
+ "type": "string"
+ },
+ "type": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "recipient_email": {
+ "format": "email",
+ "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "recipient_name": {
+ "type": "string"
+ },
+ "recipient_notice_email_address": {
+ "description": "Email address for legal notices to the recipient.",
+ "format": "email",
+ "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "recipient_organization": {
+ "type": "string"
+ },
+ "recipient_role": {
+ "description": "PSA only. The recipient's role: `Customer` (the default) or `Provider`. Send it with `sender_role`; the two must be one `Provider` and one `Customer`. Other standard agreement types ignore it.",
+ "type": "string"
+ },
+ "sender_last_to_sign": {
+ "description": "When true, your signer signs after the recipient.",
+ "type": "boolean"
+ },
+ "sender_notice_email_address": {
+ "description": "Email address for legal notices to the sender.",
+ "format": "email",
+ "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "sender_role": {
+ "description": "PSA only. Your company's role: `Provider` (the default) or `Customer` when you hire the recipient to provide the services. Send it with `recipient_role`; the two must be one `Provider` and one `Customer`. When reading a PSA, an empty `sender_role` means `Provider`. Other standard agreement types ignore it.",
+ "type": "string"
+ },
+ "software_license_attributes": {
+ "additionalProperties": false,
+ "description": "Override software license terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "effective_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "effective_date_type": {
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "type": "string"
+ },
+ "general_cap_amount": {
+ "type": "number"
+ },
+ "general_cap_amount_type": {
+ "enum": [
+ "preceding",
+ "base",
+ "period"
+ ],
+ "type": "string"
+ },
+ "general_cap_period_currency": {
+ "type": "number"
+ },
+ "general_cap_period_qty": {
+ "type": "number"
+ },
+ "general_cap_preceding_amount": {
+ "type": "number"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_additional_warranties": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_by_customer": {
+ "type": "string"
+ },
+ "include_additional_warranties_by_provider": {
+ "type": "string"
+ },
+ "include_additional_warranties_include_by_customer": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_include_by_provider": {
+ "type": "boolean"
+ },
+ "include_ai_addendum": {
+ "type": "boolean"
+ },
+ "include_ai_addendum_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_covered_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_customer_claims": {
+ "type": "string"
+ },
+ "include_covered_claims_include_customer_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_include_provider_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_provider_claims": {
+ "type": "string"
+ },
+ "include_dpa": {
+ "type": "boolean"
+ },
+ "include_dpa_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_dpa_location": {
+ "type": "string"
+ },
+ "include_dpa_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_increased_cap_amount": {
+ "type": "boolean"
+ },
+ "include_increased_claims": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_confidentiality": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_confidentiality_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_other": {
+ "type": "boolean"
+ },
+ "include_increased_claims_indemnification_obligation": {
+ "type": "boolean"
+ },
+ "include_increased_claims_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_other": {
+ "type": "string"
+ },
+ "include_increased_claims_restrictions": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_confidentiality": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_confidentiality_negligence": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_include_other": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_indemnification_obligation": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_license_or_restrictions": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_negligence": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_other": {
+ "type": "string"
+ },
+ "increased_cap_amount_currency": {
+ "type": "number"
+ },
+ "increased_cap_amount_period_currency": {
+ "type": "number"
+ },
+ "increased_cap_amount_period_qty": {
+ "type": "number"
+ },
+ "increased_cap_amount_qty": {
+ "type": "number"
+ },
+ "increased_cap_amount_type": {
+ "enum": [
+ "qty",
+ "currency",
+ "period"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "software_license_order_form_attributes": {
+ "additionalProperties": false,
+ "description": "Override software license order form terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "additional_changes": {
+ "type": "string"
+ },
+ "deletion_procedure_include_custom": {
+ "type": "boolean"
+ },
+ "deletion_procedure_include_custom_description": {
+ "type": "string"
+ },
+ "deletion_procedure_include_customer_disable": {
+ "type": "boolean"
+ },
+ "deletion_procedure_include_customer_proof": {
+ "type": "boolean"
+ },
+ "deletion_procedure_include_provider_disable": {
+ "type": "boolean"
+ },
+ "fee_custom_unit": {
+ "type": "string"
+ },
+ "fee_period": {
+ "enum": [
+ "Subscription Period",
+ "month",
+ "year",
+ "Custom unit"
+ ],
+ "type": "string"
+ },
+ "fees_attributes": {
+ "additionalProperties": {
+ "anyOf": [
+ {
+ "additionalProperties": false,
+ "description": "Fees::Flat (fee_type \"flat\"). A fixed recurring fee, e.g. a platform subscription. Set type to \"Fees::Flat\" or fee_type to \"flat\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Fixed amount in the order form's fees_currency, charged per fee_period. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"flat\". Alternative to type.",
+ "enum": [
+ "flat"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Flat\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Flat"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Discount (fee_type \"discount\"). A discount, as a fixed amount or a percentage, applied forever, once, or for a number of months. Set type to \"Fees::Discount\" or fee_type to \"discount\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Discount size: an amount in fees_currency when discount_type is fixed_amount (a plain amount, not cents: 20 means 20.00), or a percentage (e.g. 10 for 10%) when it is percentage.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "discount_duration_amount": {
+ "description": "Number of months the discount applies. Required when discount_duration_type is multiple_months.",
+ "type": "number"
+ },
+ "discount_duration_type": {
+ "description": "How long the discount applies. multiple_months also needs discount_duration_amount.",
+ "enum": [
+ "forever",
+ "once",
+ "multiple_months"
+ ],
+ "type": "string"
+ },
+ "discount_type": {
+ "description": "Whether cost is a currency amount or a percentage.",
+ "enum": [
+ "fixed_amount",
+ "percentage"
+ ],
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"discount\". Alternative to type.",
+ "enum": [
+ "discount"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Discount\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Discount"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Cost (fee_type \"cost\"). A per-unit fee: price per unit times quantity, e.g. seats. Set type to \"Fees::Cost\" or fee_type to \"cost\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Price per unit in fees_currency. The row total is quantity x cost. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"cost\". Alternative to type.",
+ "enum": [
+ "cost"
+ ],
+ "type": "string"
+ },
+ "quantity": {
+ "description": "Number of units.",
+ "type": "number"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Cost\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Cost"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Attachment (fee_type \"attachment\"). A fee described in an uploaded attachment instead of in the table. Set type to \"Fees::Attachment\" or fee_type to \"attachment\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "attachment_id": {
+ "description": "ID of an attachment uploaded with upload-attachment.",
+ "type": "string"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"attachment\". Alternative to type.",
+ "enum": [
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Attachment\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Attachment"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Graduated (fee_type \"graduated\"). Tiered pricing, with the price set per tier in graduated_fee_tiers_attributes. Set type to \"Fees::Graduated\" or fee_type to \"graduated\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"graduated\". Alternative to type.",
+ "enum": [
+ "graduated"
+ ],
+ "type": "string"
+ },
+ "graduated_fee_tiers_attributes": {
+ "additionalProperties": {
+ "additionalProperties": false,
+ "properties": {
+ "flat_price": {
+ "type": "number"
+ },
+ "price_per_unit": {
+ "type": "string"
+ },
+ "upper_limit": {
+ "type": "number"
+ }
+ },
+ "type": "object"
+ },
+ "description": "Graduated fee tiers. Use string keys such as \"0\", \"1\".",
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Graduated\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Graduated"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Included (fee_type \"included\"). An item included at no charge. Set type to \"Fees::Included\" or fee_type to \"included\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"included\". Alternative to type.",
+ "enum": [
+ "included"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Included\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Included"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Metered (fee_type \"metered\"). Usage-based pricing, billed per unit used. Set type to \"Fees::Metered\" or fee_type to \"metered\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Price per unit of usage in fees_currency. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"metered\". Alternative to type.",
+ "enum": [
+ "metered"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Metered\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Metered"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::OneTime (fee_type \"one_time\"). A one-time charge, such as a setup fee. Set type to \"Fees::OneTime\" or fee_type to \"one_time\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "One-time amount in fees_currency, charged once rather than per fee_period. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"one_time\". Alternative to type.",
+ "enum": [
+ "one_time"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::OneTime\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::OneTime"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Text (fee_type \"text\"). A fee term described in free text. Set type to \"Fees::Text\" or fee_type to \"text\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"text\". Alternative to type.",
+ "enum": [
+ "text"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Text\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Text"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ }
+ ]
+ },
+ "description": "Fee line items. Use string keys such as \"0\", \"1\". Replaces template fees when provided.",
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+ },
+ "fees_currency": {
+ "enum": [
+ "USD",
+ "EUR",
+ "GBP",
+ "CAD",
+ "AUD",
+ "SGD",
+ "ILS",
+ "JPY",
+ "CHF",
+ "HKD"
+ ],
+ "type": "string"
+ },
+ "fees_include_fee_increase_upon_renewal": {
+ "type": "boolean"
+ },
+ "fees_include_fee_increase_upon_renewal_fee": {
+ "type": "number"
+ },
+ "fees_include_fee_increase_upon_renewal_type": {
+ "enum": [
+ "will",
+ "may"
+ ],
+ "type": "string"
+ },
+ "fees_inclusive_of_taxes": {
+ "type": "boolean"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_additional_changes": {
+ "type": "boolean"
+ },
+ "include_license_compliance_verification": {
+ "type": "boolean"
+ },
+ "include_license_compliance_verification_description": {
+ "type": "string"
+ },
+ "include_license_limits": {
+ "type": "boolean"
+ },
+ "include_license_limits_description": {
+ "type": "string"
+ },
+ "include_payment_process_include_billing_email": {
+ "type": "boolean"
+ },
+ "include_pilot_period": {
+ "type": "boolean"
+ },
+ "include_pilot_period_duration_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_pilot_period_duration_type": {
+ "enum": [
+ "day",
+ "week",
+ "month"
+ ],
+ "type": "string"
+ },
+ "include_pilot_period_include_fees": {
+ "type": "boolean"
+ },
+ "include_pilot_period_include_fees_amount": {
+ "type": "number"
+ },
+ "include_pilot_period_include_modifications": {
+ "type": "boolean"
+ },
+ "include_pilot_period_include_modifications_description": {
+ "type": "string"
+ },
+ "include_services": {
+ "type": "boolean"
+ },
+ "include_services_description": {
+ "type": "string"
+ },
+ "negotiations_allowed": {
+ "description": "When true, the recipient can propose changes to the order form, even when the agreement-level `negotiations_allowed` is false. This only covers the order form.",
+ "type": "boolean"
+ },
+ "order_date_date": {
+ "type": "string"
+ },
+ "order_date_type": {
+ "enum": [
+ "signature",
+ "date",
+ "other"
+ ],
+ "type": "string"
+ },
+ "payment_process_automatic_frequency": {
+ "enum": [
+ "monthly",
+ "quarterly",
+ "semiannually",
+ "annually"
+ ],
+ "type": "string"
+ },
+ "payment_process_type": {
+ "enum": [
+ "automatic",
+ "invoice",
+ "custom"
+ ],
+ "type": "string"
+ },
+ "payment_process_type_custom_val": {
+ "type": "string"
+ },
+ "payment_process_type_invoice_amount": {
+ "type": "number"
+ },
+ "payment_process_type_invoice_custom_unit": {
+ "type": "string"
+ },
+ "payment_process_type_invoice_duration": {
+ "enum": [
+ "day",
+ "week",
+ "month",
+ "year",
+ "day(s)",
+ "week(s)",
+ "month(s)",
+ "year(s)"
+ ],
+ "type": "string"
+ },
+ "payment_process_type_invoice_duration_start": {
+ "enum": [
+ "Customer's receipt of invoice",
+ "date of invoice"
+ ],
+ "type": "string"
+ },
+ "payment_process_type_invoice_type": {
+ "enum": [
+ "monthly",
+ "quarterly",
+ "semiannually",
+ "annually",
+ "Custom unit"
+ ],
+ "type": "string"
+ },
+ "permitted_uses_include_custom": {
+ "type": "boolean"
+ },
+ "permitted_uses_include_custom_description": {
+ "type": "string"
+ },
+ "permitted_uses_include_customers_affiliates": {
+ "type": "boolean"
+ },
+ "permitted_uses_include_internal_business": {
+ "type": "boolean"
+ },
+ "pilot_period_stripe_product_id": {
+ "type": "string"
+ },
+ "software_description": {
+ "type": "string"
+ },
+ "subscription_auto_renew": {
+ "enum": [
+ "days",
+ "subscription_end"
+ ],
+ "type": "string"
+ },
+ "subscription_period": {
+ "type": "number"
+ },
+ "subscription_period_unit": {
+ "type": "string"
+ },
+ "subscription_renewal_notice_days": {
+ "type": "number"
+ },
+ "warranty_period_description_amount": {
+ "type": "number"
+ },
+ "warranty_period_description_duration": {
+ "enum": [
+ "day",
+ "week",
+ "month",
+ "year"
+ ],
+ "type": "string"
+ },
+ "warranty_period_description_duration_start": {
+ "enum": [
+ "initial delivery of the Software",
+ "delivery of the Software and each subsequent Update",
+ "the Order Date"
+ ],
+ "type": "string"
+ },
+ "warranty_period_type": {
+ "enum": [
+ "description",
+ "none"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "test_agreement": {
+ "description": "When true, marks the agreement as a test. Test agreements do not count against your monthly limit.",
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "recipient_name",
+ "recipient_email"
+ ],
+ "type": "object"
+ },
+ "cc_users": {
+ "items": {
+ "format": "email",
+ "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "draft": {
+ "description": "When true, the agreement is saved as a draft and not sent to the recipient. Use POST /v1/agreements/{id}/send to send a draft agreement later.",
+ "type": "boolean"
+ },
+ "owner_id": {
+ "description": "User id of the agreement owner (sender).",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "signer_email": {
+ "description": "Email address of the signer from the owner's organization.",
+ "format": "email",
+ "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "template_id": {
+ "description": "UUID of a template from `GET /v1/templates`. Accepts both Common Paper standard templates and uploaded PDF templates (`type` `uploaded_template`).",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ }
+ },
+ "required": [
+ "template_id",
+ "owner_id",
+ "signer_email",
+ "agreement"
+ ],
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "agreement": {
+ "additionalProperties": {},
+ "properties": {
+ "amendment_attributes": {
+ "additionalProperties": false,
+ "description": "Override amendment terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "amended_terms_attributes": {
+ "additionalProperties": {
+ "additionalProperties": false,
+ "properties": {
+ "description": {
+ "type": "string"
+ },
+ "term": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "description": "Amended terms. Use string keys such as \"0\", \"1\".",
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+ },
+ "amendment_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "amendment_date_type": {
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "type": "string"
+ },
+ "framework_terms_type": {
+ "type": "string"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "parent_agreement_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "underlying_agreement_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "underlying_agreement_type": {
+ "type": "string"
+ },
+ "underlying_agreement_val": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "baa_attributes": {
+ "additionalProperties": false,
+ "description": "Override baa terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "aggregation_limitations_permitted": {
+ "type": "boolean"
+ },
+ "aggregation_limitations_permitted_val": {
+ "type": "string"
+ },
+ "breach_notification_unit": {
+ "enum": [
+ "hours",
+ "business days",
+ "calendar days"
+ ],
+ "type": "string"
+ },
+ "breach_notification_val": {
+ "type": "number"
+ },
+ "business_associate_relationship_type": {
+ "enum": [
+ "provider",
+ "company"
+ ],
+ "type": "string"
+ },
+ "deidentification_limitations_include_purpose": {
+ "type": "boolean"
+ },
+ "deidentification_limitations_include_requirements": {
+ "type": "boolean"
+ },
+ "deidentification_limitations_permitted": {
+ "type": "boolean"
+ },
+ "deidentification_limitations_purpose_val": {
+ "type": "string"
+ },
+ "deidentification_limitations_requirements_val": {
+ "type": "string"
+ },
+ "designated_record_set_provider_maintains": {
+ "type": "boolean"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_aggregation_limitations": {
+ "type": "boolean"
+ },
+ "include_deidentification_limitations": {
+ "type": "boolean"
+ },
+ "include_limitations": {
+ "type": "boolean"
+ },
+ "include_offshore_limitations": {
+ "type": "boolean"
+ },
+ "include_subcontract_limitations": {
+ "type": "boolean"
+ },
+ "offshore_limitations_permitted": {
+ "type": "boolean"
+ },
+ "offshore_limitations_permitted_val": {
+ "type": "string"
+ },
+ "subcontract_limitations_include_notice": {
+ "type": "boolean"
+ },
+ "subcontract_limitations_include_permission": {
+ "type": "boolean"
+ },
+ "subcontract_limitations_notice_val": {
+ "type": "string"
+ },
+ "subcontract_limitations_permission_val": {
+ "type": "string"
+ },
+ "subcontract_limitations_permitted": {
+ "type": "boolean"
+ },
+ "underlying_agreement_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "underlying_agreement_type": {
+ "enum": [
+ "internal",
+ "external",
+ "none"
+ ],
+ "type": "string"
+ },
+ "underlying_agreement_val": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "billing_email": {
+ "description": "Email of the billing contact. Used when include_billing_info is true.",
+ "format": "email",
+ "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "billing_name": {
+ "description": "Name of the billing contact. Used when include_billing_info is true.",
+ "type": "string"
+ },
+ "billing_workflow_type": {
+ "description": "The type of billing workflow. Use \"link\" to provide a payment_link_url, or \"stripe\" for Stripe-managed billing.",
+ "enum": [
+ "link",
+ "stripe"
+ ],
+ "type": "string"
+ },
+ "chosen_courts_country": {
+ "description": "The country in which disputes will be resolved.",
+ "type": "string"
+ },
+ "chosen_courts_region": {
+ "description": "The state or region in which disputes will be resolved.",
+ "type": "string"
+ },
+ "csa_attributes": {
+ "additionalProperties": false,
+ "description": "Override csa terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "customer_description": {
+ "type": "string"
+ },
+ "effective_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "effective_date_marketplace": {
+ "enum": [
+ "AWS",
+ "GCP",
+ "Azure"
+ ],
+ "type": "string"
+ },
+ "effective_date_type": {
+ "enum": [
+ "signature",
+ "date",
+ "marketplace_acceptance"
+ ],
+ "type": "string"
+ },
+ "general_cap_amount": {
+ "type": "number"
+ },
+ "general_cap_amount_type": {
+ "enum": [
+ "preceding",
+ "base",
+ "period"
+ ],
+ "type": "string"
+ },
+ "general_cap_period_currency": {
+ "type": "number"
+ },
+ "general_cap_period_qty": {
+ "type": "number"
+ },
+ "general_cap_preceding_amount": {
+ "type": "number"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_acceptable_use_policy": {
+ "type": "boolean"
+ },
+ "include_acceptable_use_policy_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_acceptable_use_policy_location": {
+ "type": "string"
+ },
+ "include_acceptable_use_policy_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_additional_warranties": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_by_customer": {
+ "type": "string"
+ },
+ "include_additional_warranties_by_provider": {
+ "type": "string"
+ },
+ "include_additional_warranties_include_by_customer": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_include_by_provider": {
+ "type": "boolean"
+ },
+ "include_ai_addendum": {
+ "type": "boolean"
+ },
+ "include_ai_addendum_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_covered_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_customer_claims": {
+ "type": "string"
+ },
+ "include_covered_claims_include_customer_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_include_provider_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_provider_claims": {
+ "type": "string"
+ },
+ "include_dpa": {
+ "type": "boolean"
+ },
+ "include_dpa_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_dpa_location": {
+ "type": "string"
+ },
+ "include_dpa_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_increased_cap_amount": {
+ "type": "boolean"
+ },
+ "include_increased_claims": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_confidentiality": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_confidentiality_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_privsec": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_privsec_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_other": {
+ "type": "boolean"
+ },
+ "include_increased_claims_indemnification_obligation": {
+ "type": "boolean"
+ },
+ "include_increased_claims_other": {
+ "type": "string"
+ },
+ "include_insurance_minimums": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_add_customer": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_add_customer_com_gen_liability": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_add_customer_cyber_liability": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_add_customer_errors_omissions": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_additional_information": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_additional_information_text": {
+ "type": "string"
+ },
+ "include_insurance_minimums_cyber_liability_aggregate": {
+ "type": "number"
+ },
+ "include_insurance_minimums_cyber_liability_minimum": {
+ "type": "number"
+ },
+ "include_insurance_minimums_employer_liability_aggregate": {
+ "type": "number"
+ },
+ "include_insurance_minimums_employer_liability_minimum": {
+ "type": "number"
+ },
+ "include_insurance_minimums_general_liability_aggregate": {
+ "type": "number"
+ },
+ "include_insurance_minimums_general_liability_minimum": {
+ "type": "number"
+ },
+ "include_insurance_minimums_include_cyber_liability": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_include_employer_liability": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_include_general_liability": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_include_workers_compensation": {
+ "type": "boolean"
+ },
+ "include_publicity_rights": {
+ "type": "boolean"
+ },
+ "include_publicity_rights_type": {
+ "enum": [
+ "public",
+ "non-public"
+ ],
+ "type": "string"
+ },
+ "include_security_policy": {
+ "type": "boolean"
+ },
+ "include_security_policy_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_security_policy_fedramp_auth": {
+ "type": "boolean"
+ },
+ "include_security_policy_hipaa": {
+ "type": "boolean"
+ },
+ "include_security_policy_hitrust": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_annual_maintenance": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_location": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_other": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_reasonable_efforts": {
+ "type": "boolean"
+ },
+ "include_security_policy_iso27001": {
+ "type": "boolean"
+ },
+ "include_security_policy_location": {
+ "type": "string"
+ },
+ "include_security_policy_other": {
+ "type": "string"
+ },
+ "include_security_policy_pci1": {
+ "type": "boolean"
+ },
+ "include_security_policy_pci2": {
+ "type": "boolean"
+ },
+ "include_security_policy_penetration_testing": {
+ "type": "boolean"
+ },
+ "include_security_policy_soc2": {
+ "type": "boolean"
+ },
+ "include_security_policy_soc2_type2": {
+ "type": "boolean"
+ },
+ "include_security_policy_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_supercap": {
+ "description": "CSA 3.0 renamed `include_increased_cap_amount` to `include_supercap`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_increased_cap_amount`. Sending the other spelling returns a 422.",
+ "type": "boolean"
+ },
+ "include_uncapped_claims": {
+ "description": "CSA 3.0 renamed `include_unlimited_claims` to `include_uncapped_claims`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims`. Sending the other spelling returns a 422.",
+ "type": "boolean"
+ },
+ "include_uncapped_claims_breach_of_confidentiality": {
+ "description": "CSA 3.0 renamed `include_unlimited_claims_breach_of_confidentiality` to `include_uncapped_claims_breach_of_confidentiality`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_breach_of_confidentiality`. Sending the other spelling returns a 422.",
+ "type": "boolean"
+ },
+ "include_uncapped_claims_breach_of_confidentiality_negligence": {
+ "description": "CSA 3.0 renamed `include_unlimited_claims_breach_of_confidentiality_negligence` to `include_uncapped_claims_breach_of_confidentiality_negligence`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_breach_of_confidentiality_negligence`. Sending the other spelling returns a 422.",
+ "type": "boolean"
+ },
+ "include_uncapped_claims_breach_of_privsec": {
+ "description": "CSA 3.0 renamed `include_unlimited_claims_breach_of_privsec` to `include_uncapped_claims_breach_of_privsec`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_breach_of_privsec`. Sending the other spelling returns a 422.",
+ "type": "boolean"
+ },
+ "include_uncapped_claims_breach_of_privsec_negligence": {
+ "description": "CSA 3.0 renamed `include_unlimited_claims_breach_of_privsec_negligence` to `include_uncapped_claims_breach_of_privsec_negligence`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_breach_of_privsec_negligence`. Sending the other spelling returns a 422.",
+ "type": "boolean"
+ },
+ "include_uncapped_claims_include_other": {
+ "description": "CSA 3.0 renamed `include_unlimited_claims_include_other` to `include_uncapped_claims_include_other`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_include_other`. Sending the other spelling returns a 422.",
+ "type": "boolean"
+ },
+ "include_uncapped_claims_indemnification_obligation": {
+ "description": "CSA 3.0 renamed `include_unlimited_claims_indemnification_obligation` to `include_uncapped_claims_indemnification_obligation`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_indemnification_obligation`. Sending the other spelling returns a 422.",
+ "type": "boolean"
+ },
+ "include_uncapped_claims_other": {
+ "description": "CSA 3.0 renamed `include_unlimited_claims_other` to `include_uncapped_claims_other`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_other`. Sending the other spelling returns a 422.",
+ "type": "boolean"
+ },
+ "include_unlimited_claims": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_confidentiality": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_confidentiality_negligence": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_privsec": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_privsec_negligence": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_include_other": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_indemnification_obligation": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_other": {
+ "type": "string"
+ },
+ "increased_cap_amount_currency": {
+ "type": "number"
+ },
+ "increased_cap_amount_period_currency": {
+ "type": "number"
+ },
+ "increased_cap_amount_period_qty": {
+ "type": "number"
+ },
+ "increased_cap_amount_qty": {
+ "type": "number"
+ },
+ "increased_cap_amount_type": {
+ "enum": [
+ "qty",
+ "currency",
+ "period"
+ ],
+ "type": "string"
+ },
+ "provider": {
+ "type": "string"
+ },
+ "supercap_currency": {
+ "description": "CSA 3.0 renamed `increased_cap_amount_currency` to `supercap_currency`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `increased_cap_amount_currency`. Sending the other spelling returns a 422.",
+ "type": "number"
+ },
+ "supercap_period_currency": {
+ "description": "CSA 3.0 renamed `increased_cap_amount_period_currency` to `supercap_period_currency`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `increased_cap_amount_period_currency`. Sending the other spelling returns a 422.",
+ "type": "number"
+ },
+ "supercap_period_qty": {
+ "description": "CSA 3.0 renamed `increased_cap_amount_period_qty` to `supercap_period_qty`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `increased_cap_amount_period_qty`. Sending the other spelling returns a 422.",
+ "type": "number"
+ },
+ "supercap_qty": {
+ "description": "CSA 3.0 renamed `increased_cap_amount_qty` to `supercap_qty`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `increased_cap_amount_qty`. Sending the other spelling returns a 422.",
+ "type": "number"
+ },
+ "supercap_type": {
+ "description": "CSA 3.0 renamed `increased_cap_amount_type` to `supercap_type`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `increased_cap_amount_type`. Sending the other spelling returns a 422.",
+ "type": "number"
+ }
+ },
+ "type": "object"
+ },
+ "csa_order_form_attributes": {
+ "additionalProperties": false,
+ "description": "Override csa order form terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "additional_changes": {
+ "type": "string"
+ },
+ "additional_parameters_or_limitations": {
+ "type": "string"
+ },
+ "affiliates_as_users": {
+ "type": "boolean"
+ },
+ "cloud_service_description": {
+ "type": "string"
+ },
+ "consumption_units": {
+ "type": "string"
+ },
+ "fee_amount": {
+ "type": "number"
+ },
+ "fee_custom_unit": {
+ "type": "string"
+ },
+ "fee_period": {
+ "enum": [
+ "Subscription Period",
+ "month",
+ "year",
+ "User",
+ "Custom unit"
+ ],
+ "type": "string"
+ },
+ "fees_attributes": {
+ "additionalProperties": {
+ "anyOf": [
+ {
+ "additionalProperties": false,
+ "description": "Fees::Flat (fee_type \"flat\"). A fixed recurring fee, e.g. a platform subscription. Set type to \"Fees::Flat\" or fee_type to \"flat\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Fixed amount in the order form's fees_currency, charged per fee_period. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"flat\". Alternative to type.",
+ "enum": [
+ "flat"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Flat\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Flat"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Discount (fee_type \"discount\"). A discount, as a fixed amount or a percentage, applied forever, once, or for a number of months. Set type to \"Fees::Discount\" or fee_type to \"discount\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Discount size: an amount in fees_currency when discount_type is fixed_amount (a plain amount, not cents: 20 means 20.00), or a percentage (e.g. 10 for 10%) when it is percentage.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "discount_duration_amount": {
+ "description": "Number of months the discount applies. Required when discount_duration_type is multiple_months.",
+ "type": "number"
+ },
+ "discount_duration_type": {
+ "description": "How long the discount applies. multiple_months also needs discount_duration_amount.",
+ "enum": [
+ "forever",
+ "once",
+ "multiple_months"
+ ],
+ "type": "string"
+ },
+ "discount_type": {
+ "description": "Whether cost is a currency amount or a percentage.",
+ "enum": [
+ "fixed_amount",
+ "percentage"
+ ],
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"discount\". Alternative to type.",
+ "enum": [
+ "discount"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Discount\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Discount"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Cost (fee_type \"cost\"). A per-unit fee: price per unit times quantity, e.g. seats. Set type to \"Fees::Cost\" or fee_type to \"cost\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Price per unit in fees_currency. The row total is quantity x cost. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"cost\". Alternative to type.",
+ "enum": [
+ "cost"
+ ],
+ "type": "string"
+ },
+ "quantity": {
+ "description": "Number of units.",
+ "type": "number"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Cost\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Cost"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Attachment (fee_type \"attachment\"). A fee described in an uploaded attachment instead of in the table. Set type to \"Fees::Attachment\" or fee_type to \"attachment\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "attachment_id": {
+ "description": "ID of an attachment uploaded with upload-attachment.",
+ "type": "string"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"attachment\". Alternative to type.",
+ "enum": [
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Attachment\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Attachment"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Graduated (fee_type \"graduated\"). Tiered pricing, with the price set per tier in graduated_fee_tiers_attributes. Set type to \"Fees::Graduated\" or fee_type to \"graduated\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"graduated\". Alternative to type.",
+ "enum": [
+ "graduated"
+ ],
+ "type": "string"
+ },
+ "graduated_fee_tiers_attributes": {
+ "additionalProperties": {
+ "additionalProperties": false,
+ "properties": {
+ "flat_price": {
+ "type": "number"
+ },
+ "price_per_unit": {
+ "type": "string"
+ },
+ "upper_limit": {
+ "type": "number"
+ }
+ },
+ "type": "object"
+ },
+ "description": "Graduated fee tiers. Use string keys such as \"0\", \"1\".",
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Graduated\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Graduated"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Included (fee_type \"included\"). An item included at no charge. Set type to \"Fees::Included\" or fee_type to \"included\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"included\". Alternative to type.",
+ "enum": [
+ "included"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Included\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Included"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Metered (fee_type \"metered\"). Usage-based pricing, billed per unit used. Set type to \"Fees::Metered\" or fee_type to \"metered\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Price per unit of usage in fees_currency. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"metered\". Alternative to type.",
+ "enum": [
+ "metered"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Metered\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Metered"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::OneTime (fee_type \"one_time\"). A one-time charge, such as a setup fee. Set type to \"Fees::OneTime\" or fee_type to \"one_time\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "One-time amount in fees_currency, charged once rather than per fee_period. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"one_time\". Alternative to type.",
+ "enum": [
+ "one_time"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::OneTime\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::OneTime"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Text (fee_type \"text\"). A fee term described in free text. Set type to \"Fees::Text\" or fee_type to \"text\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"text\". Alternative to type.",
+ "enum": [
+ "text"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Text\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Text"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ }
+ ]
+ },
+ "description": "Fee table rows, keyed by string index (\"0\", \"1\", ...). Replaces the template's fees when provided. Each row sets type or fee_type to pick the fee class. Amounts are in the order form's fees_currency and, for recurring fees, are charged per fee_period.",
+ "examples": [
+ {
+ "0": {
+ "cost": 2000,
+ "description": "Platform subscription",
+ "type": "Fees::Flat"
+ }
+ },
+ {
+ "0": {
+ "cost": 50,
+ "description": "Seats",
+ "fee_type": "cost",
+ "quantity": 10
+ },
+ "1": {
+ "cost": 10,
+ "description": "Launch discount",
+ "discount_duration_amount": 3,
+ "discount_duration_type": "multiple_months",
+ "discount_type": "percentage",
+ "fee_type": "discount"
+ }
+ }
+ ],
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+ },
+ "fees_currency": {
+ "enum": [
+ "USD",
+ "EUR",
+ "GBP",
+ "CAD",
+ "AUD",
+ "SGD",
+ "ILS",
+ "JPY",
+ "CHF",
+ "HKD"
+ ],
+ "type": "string"
+ },
+ "fees_include_fee_increase_upon_renewal": {
+ "type": "boolean"
+ },
+ "fees_include_fee_increase_upon_renewal_fee": {
+ "type": "number"
+ },
+ "fees_include_fee_increase_upon_renewal_type": {
+ "enum": [
+ "will",
+ "may"
+ ],
+ "type": "string"
+ },
+ "fees_inclusive_of_taxes": {
+ "type": "boolean"
+ },
+ "framework_terms_type": {
+ "enum": [
+ "new",
+ "existing",
+ "description"
+ ],
+ "type": "string"
+ },
+ "free_trial_days": {
+ "type": "number"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_additional_changes": {
+ "type": "boolean"
+ },
+ "include_additional_parameters_or_limitations": {
+ "type": "boolean"
+ },
+ "include_consumption": {
+ "type": "boolean"
+ },
+ "include_fees": {
+ "type": "boolean"
+ },
+ "include_fees_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_fees_include_attachment": {
+ "type": "boolean"
+ },
+ "include_fees_other": {
+ "type": "boolean"
+ },
+ "include_fees_other_val": {
+ "type": "string"
+ },
+ "include_fees_table": {
+ "type": "boolean"
+ },
+ "include_fees_table_period": {
+ "enum": [
+ "Subscription Period",
+ "month",
+ "year",
+ "User"
+ ],
+ "type": "string"
+ },
+ "include_free_trial": {
+ "type": "boolean"
+ },
+ "include_max_users": {
+ "type": "boolean"
+ },
+ "include_pilot_period": {
+ "type": "boolean"
+ },
+ "include_pilot_period_duration_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_pilot_period_duration_type": {
+ "enum": [
+ "day",
+ "week",
+ "month"
+ ],
+ "type": "string"
+ },
+ "include_pilot_period_include_fees": {
+ "type": "boolean"
+ },
+ "include_pilot_period_include_fees_amount": {
+ "type": "number"
+ },
+ "include_pilot_period_include_modifications": {
+ "type": "boolean"
+ },
+ "include_pilot_period_include_modifications_description": {
+ "type": "string"
+ },
+ "include_product_support": {
+ "type": "boolean"
+ },
+ "include_product_support_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_product_support_description": {
+ "type": "string"
+ },
+ "include_product_support_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_professional_services": {
+ "type": "boolean"
+ },
+ "include_professional_services_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_professional_services_custom_name": {
+ "type": "string"
+ },
+ "include_professional_services_description": {
+ "type": "string"
+ },
+ "include_professional_services_end_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "include_professional_services_fees_description": {
+ "type": "string"
+ },
+ "include_professional_services_include_end_date": {
+ "type": "boolean"
+ },
+ "include_professional_services_include_fees_description": {
+ "type": "boolean"
+ },
+ "include_professional_services_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_sla": {
+ "type": "boolean"
+ },
+ "include_sla_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_sla_description": {
+ "type": "string"
+ },
+ "include_sla_include_response_time": {
+ "type": "boolean"
+ },
+ "include_sla_include_response_time_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_sla_include_response_time_credit": {
+ "type": "number"
+ },
+ "include_sla_include_response_time_duration": {
+ "enum": [
+ "hour",
+ "day",
+ "week",
+ "month",
+ "hours"
+ ],
+ "type": "string"
+ },
+ "include_sla_include_response_time_support_channel": {
+ "type": "string"
+ },
+ "include_sla_include_target_uptime": {
+ "type": "boolean"
+ },
+ "include_sla_maintenance_notice": {
+ "type": "boolean"
+ },
+ "include_sla_maintenance_window": {
+ "type": "boolean"
+ },
+ "include_sla_maintenance_window_type": {
+ "enum": [
+ "standard",
+ "none"
+ ],
+ "type": "string"
+ },
+ "include_sla_standard_maintenance_notice_qty": {
+ "type": "number"
+ },
+ "include_sla_standard_maintenance_notice_unit": {
+ "enum": [
+ "hour",
+ "day",
+ "week",
+ "month"
+ ],
+ "type": "string"
+ },
+ "include_sla_standard_maintenance_window_end_time": {
+ "type": "string"
+ },
+ "include_sla_standard_maintenance_window_friday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_monday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_saturday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_start_time": {
+ "type": "string"
+ },
+ "include_sla_standard_maintenance_window_sunday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_thursday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_time_zone": {
+ "type": "string"
+ },
+ "include_sla_standard_maintenance_window_tuesday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_wednesday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_target_uptime": {
+ "type": "number"
+ },
+ "include_sla_type": {
+ "enum": [
+ "description",
+ "standard",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_subscription_start_date": {
+ "type": "boolean"
+ },
+ "include_subscription_start_date_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "include_usage_review": {
+ "type": "boolean"
+ },
+ "include_usage_review_val": {
+ "type": "string"
+ },
+ "include_use_limitations": {
+ "type": "boolean"
+ },
+ "include_use_limitations_val": {
+ "type": "string"
+ },
+ "invoice_period": {
+ "enum": [
+ "monthly",
+ "quarterly",
+ "semiannually",
+ "annually",
+ "Custom unit",
+ "Monthly",
+ "Quarterly",
+ "Semiannually",
+ "Annually"
+ ],
+ "type": "string"
+ },
+ "invoice_period_custom_unit": {
+ "type": "string"
+ },
+ "max_consumption": {
+ "type": "number"
+ },
+ "max_users": {
+ "type": "number"
+ },
+ "negotiations_allowed": {
+ "description": "When true, the recipient can propose changes to the order form, even when the agreement-level `negotiations_allowed` is false. This only covers the order form.",
+ "type": "boolean"
+ },
+ "order_date_date": {
+ "type": "string"
+ },
+ "order_date_other": {
+ "type": "string"
+ },
+ "order_date_type": {
+ "enum": [
+ "signature",
+ "date",
+ "other"
+ ],
+ "type": "string"
+ },
+ "payment_period": {
+ "type": "number"
+ },
+ "payment_period_timeframe": {
+ "enum": [
+ "Customer's receipt of invoice",
+ "date of invoice"
+ ],
+ "type": "string"
+ },
+ "payment_period_unit": {
+ "enum": [
+ "day(s)",
+ "week(s)",
+ "month(s)",
+ "marketplace_acceptance"
+ ],
+ "type": "string"
+ },
+ "payment_process_automatic_frequency": {
+ "enum": [
+ "monthly",
+ "quarterly",
+ "semiannually",
+ "annually"
+ ],
+ "type": "string"
+ },
+ "payment_process_type": {
+ "enum": [
+ "automatic",
+ "invoice",
+ "custom",
+ "marketplace_acceptance"
+ ],
+ "type": "string"
+ },
+ "payment_process_type_custom_val": {
+ "type": "string"
+ },
+ "payment_process_type_invoice_amount": {
+ "type": "number"
+ },
+ "payment_process_type_invoice_custom_unit": {
+ "type": "string"
+ },
+ "payment_process_type_invoice_duration": {
+ "enum": [
+ "day",
+ "week",
+ "month",
+ "year",
+ "day(s)",
+ "week(s)",
+ "month(s)",
+ "year(s)"
+ ],
+ "type": "string"
+ },
+ "payment_process_type_invoice_duration_start": {
+ "enum": [
+ "Customer's receipt of invoice",
+ "date of invoice"
+ ],
+ "type": "string"
+ },
+ "payment_process_type_invoice_type": {
+ "enum": [
+ "monthly",
+ "quarterly",
+ "semiannually",
+ "annually",
+ "Custom unit"
+ ],
+ "type": "string"
+ },
+ "pilot_period_stripe_product_id": {
+ "type": "string"
+ },
+ "service_credits_attributes": {
+ "additionalProperties": {
+ "additionalProperties": false,
+ "properties": {
+ "credit": {
+ "type": "number"
+ },
+ "max": {
+ "type": "number"
+ },
+ "min": {
+ "type": "number"
+ }
+ },
+ "type": "object"
+ },
+ "description": "Service credits. Use string keys such as \"0\", \"1\".",
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+ },
+ "subscription_auto_renew": {
+ "enum": [
+ "days",
+ "subscription_end"
+ ],
+ "type": "string"
+ },
+ "subscription_period": {
+ "type": "number"
+ },
+ "subscription_period_unit": {
+ "type": "string"
+ },
+ "subscription_renewal_notice_days": {
+ "type": "number"
+ },
+ "subscription_start_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "subscription_start_date_type": {
+ "enum": [
+ "effective_date",
+ "date"
+ ],
+ "type": "string"
+ },
+ "underlying_agreement_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "use_limitations_attributes": {
+ "additionalProperties": {
+ "additionalProperties": false,
+ "properties": {
+ "amount": {
+ "type": "number"
+ },
+ "limitation_type": {
+ "type": "string"
+ },
+ "unit": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "description": "Use limitations. Use string keys such as \"0\", \"1\".",
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+ }
+ },
+ "type": "object"
+ },
+ "custom_field_values": {
+ "description": "Values for a custom template's fields, keyed by the field keys defined in the template's YAML definition. Only used when template_id is a custom template. Template defaults fill any fields you omit; a required field with no default and no submitted value returns a 400 naming the field. Values are validated against the field's input type: select and radio values must be one of the field's options, multiselect values are an array of selections each of which must be one of the field's options, number and currency values must be numeric, date values must be YYYY-MM-DD, and email values must be valid addresses. An invalid value returns a 400 naming the field."
+ },
+ "design_partner_attributes": {
+ "additionalProperties": false,
+ "description": "Override design partner terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "customer_description": {
+ "type": "string"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_fees": {
+ "type": "boolean"
+ },
+ "include_fees_amount": {
+ "type": "number"
+ },
+ "include_fees_description": {
+ "type": "string"
+ },
+ "include_fees_pay_by_amount": {
+ "type": "string"
+ },
+ "include_fees_type": {
+ "enum": [
+ "default_language",
+ "description"
+ ],
+ "type": "string"
+ },
+ "include_fees_unit": {
+ "enum": [
+ "month",
+ "quarter",
+ "year",
+ "Term"
+ ],
+ "type": "string"
+ },
+ "include_program_appear_as_customer_private": {
+ "type": "boolean"
+ },
+ "include_program_appear_as_customer_public": {
+ "type": "boolean"
+ },
+ "include_program_case_study": {
+ "type": "boolean"
+ },
+ "include_program_develop_functionality": {
+ "type": "boolean"
+ },
+ "include_program_develop_functionality_val": {
+ "type": "string"
+ },
+ "include_program_discount": {
+ "type": "boolean"
+ },
+ "include_program_discount_amount": {
+ "type": "number"
+ },
+ "include_program_discount_unit": {
+ "enum": [
+ "U.S. Dollars",
+ "percent"
+ ],
+ "type": "string"
+ },
+ "include_program_participation_feedback": {
+ "type": "boolean"
+ },
+ "include_program_participation_feedback_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_program_participation_feedback_unit": {
+ "enum": [
+ "month",
+ "quarter",
+ "year",
+ "Term"
+ ],
+ "type": "string"
+ },
+ "include_program_partner_other": {
+ "type": "boolean"
+ },
+ "include_program_partner_other_val": {
+ "type": "string"
+ },
+ "include_program_provider_other": {
+ "type": "boolean"
+ },
+ "include_program_provider_other_val": {
+ "type": "string"
+ },
+ "include_program_reference": {
+ "type": "boolean"
+ },
+ "product_description": {
+ "type": "string"
+ },
+ "term_amount": {
+ "type": "number"
+ },
+ "term_unit": {
+ "enum": [
+ "day(s)",
+ "week(s)",
+ "month(s)",
+ "quarter(s)",
+ "year(s)"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "district_or_county": {
+ "description": "The district or county for dispute resolution.",
+ "type": "string"
+ },
+ "dpa_attributes": {
+ "additionalProperties": false,
+ "description": "Override dpa terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "approved_subprocessor_type": {
+ "description": "`internal` lists approved subprocessors in the agreement (`subprocessors_attributes`); `external` points to a list published elsewhere.",
+ "enum": [
+ "internal",
+ "external"
+ ],
+ "type": "string"
+ },
+ "cloud_service_product_name": {
+ "type": "string"
+ },
+ "competent_supervisory_authority": {
+ "type": "string"
+ },
+ "customer_description": {
+ "type": "string"
+ },
+ "data_exporter_address_city": {
+ "type": "string"
+ },
+ "data_exporter_address_country": {
+ "type": "string"
+ },
+ "data_exporter_address_state": {
+ "type": "string"
+ },
+ "data_exporter_address_street_address": {
+ "type": "string"
+ },
+ "data_exporter_address_zipcode": {
+ "type": "string"
+ },
+ "data_exporter_contact_details": {
+ "type": "string"
+ },
+ "data_exporter_contact_name": {
+ "type": "string"
+ },
+ "data_exporter_contact_position": {
+ "type": "string"
+ },
+ "data_exporter_role": {
+ "description": "Role of the data exporter. Overwritten to `Controller` when the agreement is created from a template.",
+ "enum": [
+ "Controller",
+ "Processor"
+ ],
+ "type": "string"
+ },
+ "data_importer_address": {
+ "type": "string"
+ },
+ "data_importer_address_city": {
+ "type": "string"
+ },
+ "data_importer_address_country": {
+ "type": "string"
+ },
+ "data_importer_address_state": {
+ "type": "string"
+ },
+ "data_importer_address_street_address": {
+ "type": "string"
+ },
+ "data_importer_address_zipcode": {
+ "type": "string"
+ },
+ "data_importer_contact_details": {
+ "type": "string"
+ },
+ "data_importer_contact_name": {
+ "type": "string"
+ },
+ "data_importer_contact_position": {
+ "type": "string"
+ },
+ "duration_of_processing": {
+ "type": "string"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_covered_claim": {
+ "type": "boolean"
+ },
+ "include_covered_claim_external_val": {
+ "type": "string"
+ },
+ "include_covered_claim_internal_val": {
+ "type": "string"
+ },
+ "include_covered_claim_type": {
+ "description": "Which covered-claim text applies: `internal` uses `include_covered_claim_internal_val`, `external` uses `include_covered_claim_external_val`. Required when `include_covered_claim` is true.",
+ "enum": [
+ "internal",
+ "external"
+ ],
+ "type": "string"
+ },
+ "include_data_subjects_custom": {
+ "type": "boolean"
+ },
+ "include_data_subjects_custom_val": {
+ "type": "string"
+ },
+ "include_data_subjects_employees": {
+ "type": "boolean"
+ },
+ "include_data_subjects_end_users": {
+ "type": "boolean"
+ },
+ "include_external_subprocessor_location": {
+ "type": "string"
+ },
+ "include_frequency_of_transfer_continuous": {
+ "type": "boolean"
+ },
+ "include_frequency_of_transfer_custom": {
+ "type": "boolean"
+ },
+ "include_frequency_of_transfer_custom_val": {
+ "type": "string"
+ },
+ "include_governing_country_eu": {
+ "type": "boolean"
+ },
+ "include_governing_country_eu_val": {
+ "type": "string"
+ },
+ "include_governing_country_uk": {
+ "type": "boolean"
+ },
+ "include_governing_country_uk_val": {
+ "type": "string"
+ },
+ "include_governing_law": {
+ "type": "boolean"
+ },
+ "include_governing_law_country": {
+ "type": "string"
+ },
+ "include_governing_law_state": {
+ "type": "string"
+ },
+ "include_increased_claim_amount": {
+ "description": "Legacy field. Stored but not shown on the DPA; use the `include_liability_cap*` fields instead.",
+ "type": "boolean"
+ },
+ "include_increased_claim_amount_currency": {
+ "description": "Legacy field. Stored but not shown on the DPA; use the `include_liability_cap*` fields instead."
+ },
+ "include_increased_claim_amount_qty": {
+ "description": "Legacy field. Stored but not shown on the DPA; use the `include_liability_cap*` fields instead."
+ },
+ "include_increased_claim_amount_type": {
+ "description": "Legacy field. Stored but not shown on the DPA; use the `include_liability_cap*` fields instead.",
+ "type": "string"
+ },
+ "include_liability_cap": {
+ "type": "boolean"
+ },
+ "include_liability_cap_amount_constant_external": {
+ "type": "string"
+ },
+ "include_liability_cap_amount_constant_internal": {
+ "type": "string"
+ },
+ "include_liability_cap_amount_currency_external": {
+ "description": "Currency amount. Numbers and numeric strings (commas allowed) are both accepted."
+ },
+ "include_liability_cap_amount_currency_internal": {
+ "description": "Currency amount. Numbers and numeric strings (commas allowed) are both accepted."
+ },
+ "include_liability_cap_csa_type": {
+ "description": "Which liability cap values apply: the `_internal` or `_external` amount fields. Required when `include_liability_cap` is true.",
+ "enum": [
+ "internal",
+ "external"
+ ],
+ "type": "string"
+ },
+ "include_personal_data_biographic_info": {
+ "type": "boolean"
+ },
+ "include_personal_data_contact_info": {
+ "type": "boolean"
+ },
+ "include_personal_data_custom": {
+ "type": "boolean"
+ },
+ "include_personal_data_custom_val": {
+ "type": "string"
+ },
+ "include_personal_data_employment_info": {
+ "type": "boolean"
+ },
+ "include_personal_data_financial_info": {
+ "type": "boolean"
+ },
+ "include_personal_data_location": {
+ "type": "boolean"
+ },
+ "include_personal_data_name": {
+ "type": "boolean"
+ },
+ "include_personal_data_transactional_info": {
+ "type": "boolean"
+ },
+ "include_personal_data_user_activity_info": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_custom": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_custom_val": {
+ "type": "string"
+ },
+ "include_processing_purpose_erasing": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_holding": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_protecting": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_receiving": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_returning": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_sharing": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_updating": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_using": {
+ "type": "boolean"
+ },
+ "include_provider_security_contact_address": {
+ "type": "boolean"
+ },
+ "include_provider_security_contact_address_city": {
+ "type": "string"
+ },
+ "include_provider_security_contact_address_country": {
+ "type": "string"
+ },
+ "include_provider_security_contact_address_state": {
+ "type": "string"
+ },
+ "include_provider_security_contact_address_street_address": {
+ "type": "string"
+ },
+ "include_provider_security_contact_address_zipcode": {
+ "type": "string"
+ },
+ "include_provider_security_contact_email": {
+ "type": "boolean"
+ },
+ "include_provider_security_contact_email_val": {
+ "format": "email",
+ "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "include_security_measures_accountability": {
+ "type": "boolean"
+ },
+ "include_security_measures_accountability_val": {
+ "type": "string"
+ },
+ "include_security_measures_certification_or_assurance": {
+ "type": "boolean"
+ },
+ "include_security_measures_certification_or_assurance_val": {
+ "type": "string"
+ },
+ "include_security_measures_confidentiality_integrity": {
+ "type": "boolean"
+ },
+ "include_security_measures_confidentiality_integrity_val": {
+ "type": "string"
+ },
+ "include_security_measures_data_at_rest": {
+ "type": "boolean"
+ },
+ "include_security_measures_data_at_rest_val": {
+ "type": "string"
+ },
+ "include_security_measures_data_minimization": {
+ "type": "boolean"
+ },
+ "include_security_measures_data_minimization_val": {
+ "type": "string"
+ },
+ "include_security_measures_data_quality": {
+ "type": "boolean"
+ },
+ "include_security_measures_data_quality_val": {
+ "type": "string"
+ },
+ "include_security_measures_data_retention": {
+ "type": "boolean"
+ },
+ "include_security_measures_data_retention_val": {
+ "type": "string"
+ },
+ "include_security_measures_data_transmission": {
+ "type": "boolean"
+ },
+ "include_security_measures_data_transmission_val": {
+ "type": "string"
+ },
+ "include_security_measures_event_logging": {
+ "type": "boolean"
+ },
+ "include_security_measures_event_logging_val": {
+ "type": "string"
+ },
+ "include_security_measures_identity_auth": {
+ "type": "boolean"
+ },
+ "include_security_measures_identity_auth_val": {
+ "type": "string"
+ },
+ "include_security_measures_it_security_governance": {
+ "type": "boolean"
+ },
+ "include_security_measures_it_security_governance_val": {
+ "type": "string"
+ },
+ "include_security_measures_physical_security": {
+ "type": "boolean"
+ },
+ "include_security_measures_physical_security_val": {
+ "type": "string"
+ },
+ "include_security_measures_portability_and_erasure": {
+ "type": "boolean"
+ },
+ "include_security_measures_portability_and_erasure_val": {
+ "type": "string"
+ },
+ "include_security_measures_pseudonym_encryption": {
+ "type": "boolean"
+ },
+ "include_security_measures_pseudonym_encryption_val": {
+ "type": "string"
+ },
+ "include_security_measures_restore_data_access": {
+ "type": "boolean"
+ },
+ "include_security_measures_restore_data_access_val": {
+ "type": "string"
+ },
+ "include_security_measures_security_policy": {
+ "type": "boolean"
+ },
+ "include_security_measures_system_configuration": {
+ "type": "boolean"
+ },
+ "include_security_measures_system_configuration_val": {
+ "type": "string"
+ },
+ "include_security_measures_testing_assessment": {
+ "type": "boolean"
+ },
+ "include_security_measures_testing_assessment_val": {
+ "type": "string"
+ },
+ "include_security_policy": {
+ "type": "boolean"
+ },
+ "include_security_policy_fedramp_auth": {
+ "type": "boolean"
+ },
+ "include_security_policy_hipaa": {
+ "type": "boolean"
+ },
+ "include_security_policy_hitrust": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_other": {
+ "type": "boolean"
+ },
+ "include_security_policy_iso27001": {
+ "type": "boolean"
+ },
+ "include_security_policy_other": {
+ "type": "string"
+ },
+ "include_security_policy_pci1": {
+ "type": "boolean"
+ },
+ "include_security_policy_pci2": {
+ "type": "boolean"
+ },
+ "include_security_policy_penetration_testing": {
+ "type": "boolean"
+ },
+ "include_security_policy_soc2": {
+ "type": "boolean"
+ },
+ "include_security_policy_soc2_type2": {
+ "type": "boolean"
+ },
+ "include_sensitive_data_restrictions_custom": {
+ "type": "boolean"
+ },
+ "include_sensitive_data_restrictions_custom_val": {
+ "type": "string"
+ },
+ "include_sensitive_data_restrictions_security_policy": {
+ "type": "boolean"
+ },
+ "include_service_provider_relationship": {
+ "type": "boolean"
+ },
+ "include_special_category_data": {
+ "type": "boolean"
+ },
+ "provider": {
+ "type": "string"
+ },
+ "security_policy_available_at": {
+ "type": "string"
+ },
+ "security_policy_type": {
+ "description": "Where the Security Policy is defined. For `external`, set `security_policy_available_at`.",
+ "enum": [
+ "defined in agreement",
+ "provider service",
+ "external"
+ ],
+ "type": "string"
+ },
+ "subprocessors_attributes": {
+ "additionalProperties": {
+ "additionalProperties": false,
+ "properties": {
+ "_destroy": {
+ "description": "Set to true with `id` to remove that subprocessor.",
+ "type": "boolean"
+ },
+ "country": {
+ "type": "string"
+ },
+ "id": {
+ "description": "ID of an existing subprocessor to update or remove. Omit to add a new subprocessor.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "processing_task": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "description": "Subprocessors, keyed by string index such as \"0\", \"1\". On create these are added to the template's subprocessors. On a draft update, an entry without `id` adds a new subprocessor; pass `id` to change one and `id` with `_destroy: true` to remove one.",
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+ },
+ "underlying_agreement_id": {
+ "description": "ID of the CSA this DPA supplements when `underlying_agreement_type` is `internal`.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "underlying_agreement_type": {
+ "description": "`internal` links a CSA in Common Paper (`underlying_agreement_id`, required); `external` describes another agreement in `underlying_agreement_val` (required). Defaults to `internal` when omitted on create.",
+ "enum": [
+ "internal",
+ "external"
+ ],
+ "type": "string"
+ },
+ "underlying_agreement_val": {
+ "description": "Description of the agreement this DPA supplements. Required when `underlying_agreement_type` is `external`.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "framework_terms_description": {
+ "description": "Custom framework terms description. Only used when framework_terms_type is \"description\".",
+ "type": "string"
+ },
+ "framework_terms_type": {
+ "description": "How framework terms are specified. Use \"new\" for standard terms or \"description\" to provide a custom framework_terms_description.",
+ "enum": [
+ "new",
+ "description"
+ ],
+ "type": "string"
+ },
+ "governing_law_country": {
+ "description": "The country whose laws govern the agreement.",
+ "type": "string"
+ },
+ "governing_law_region": {
+ "description": "The state or region whose laws govern the agreement.",
+ "type": "string"
+ },
+ "include_automated_payment_reminders": {
+ "description": "When true, automatically sends payment reminder emails.",
+ "type": "boolean"
+ },
+ "include_billing_info": {
+ "description": "When true, billing contact information (billing_name, billing_email) is included.",
+ "type": "boolean"
+ },
+ "include_billing_workflow": {
+ "description": "When true, enables a billing workflow after signing.",
+ "type": "boolean"
+ },
+ "include_expiration_date": {
+ "description": "Expiration date in YYYY-MM-DD format. Use when include_expiration_type is \"date\".",
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "include_expiration_days": {
+ "description": "Number of days until the agreement expires. Use when include_expiration_type is \"days\".",
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_expiration_type": {
+ "description": "How to set expiration: \"none\" (default), \"days\" (use include_expiration_days), or \"date\" (use include_expiration_date).",
+ "enum": [
+ "none",
+ "days",
+ "date"
+ ],
+ "type": "string"
+ },
+ "include_terms": {
+ "description": "When true, the standard terms are included with the agreement.",
+ "type": "boolean"
+ },
+ "loi_attributes": {
+ "additionalProperties": false,
+ "description": "Override loi terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "confidentiality_custom": {
+ "type": "string"
+ },
+ "confidentiality_mutual_include_loi": {
+ "type": "boolean"
+ },
+ "confidentiality_nda_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "confidentiality_nda_description": {
+ "type": "string"
+ },
+ "confidentiality_nda_include_loi": {
+ "type": "boolean"
+ },
+ "confidentiality_nda_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "confidentiality_type": {
+ "enum": [
+ "mutual",
+ "nda",
+ "provider",
+ "custom"
+ ],
+ "type": "string"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_custom_details": {
+ "type": "boolean"
+ },
+ "include_custom_details_val": {
+ "type": "string"
+ },
+ "include_fees": {
+ "type": "boolean"
+ },
+ "include_fees_amount": {
+ "type": "number"
+ },
+ "include_fees_amount_duration": {
+ "enum": [
+ "month",
+ "year",
+ "quarter"
+ ],
+ "type": "string"
+ },
+ "include_fees_include_amount": {
+ "type": "boolean"
+ },
+ "include_fees_include_other": {
+ "type": "boolean"
+ },
+ "include_fees_other": {
+ "type": "string"
+ },
+ "include_functionality": {
+ "type": "boolean"
+ },
+ "include_functionality_val": {
+ "type": "string"
+ },
+ "include_launch_date": {
+ "type": "boolean"
+ },
+ "include_launch_date_custom": {
+ "type": "string"
+ },
+ "include_launch_date_date": {
+ "format": "date-time",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$",
+ "type": "string"
+ },
+ "include_launch_date_type": {
+ "enum": [
+ "date",
+ "custom"
+ ],
+ "type": "string"
+ },
+ "product_name": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "manual_send": {
+ "description": "When true, the agreement is marked as manually sent outside the platform.",
+ "type": "boolean"
+ },
+ "message": {
+ "type": "string"
+ },
+ "negotiations_allowed": {
+ "description": "When true, the recipient can propose changes to the legal terms. For agreement types without separate business terms, that covers every term. CSA order forms, PSA statements of work, partnership business terms and software license order forms have their own `negotiations_allowed` flag.",
+ "type": "boolean"
+ },
+ "partnership_attributes": {
+ "additionalProperties": false,
+ "description": "Override partnership terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "effective_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "effective_date_type": {
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "type": "string"
+ },
+ "general_cap_amount_currency_val": {
+ "type": "number"
+ },
+ "general_cap_amount_either_currency": {
+ "type": "number"
+ },
+ "general_cap_amount_either_multiple": {
+ "type": "number"
+ },
+ "general_cap_amount_multiple_val": {
+ "type": "number"
+ },
+ "general_cap_amount_type": {
+ "enum": [
+ "multiple",
+ "currency",
+ "either",
+ "base"
+ ],
+ "type": "string"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_additional_warranties": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_include_company": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_include_company_val": {
+ "type": "string"
+ },
+ "include_additional_warranties_include_partner": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_include_partner_val": {
+ "type": "string"
+ },
+ "include_brand_guidelines": {
+ "type": "boolean"
+ },
+ "include_brand_guidelines_include_company": {
+ "type": "boolean"
+ },
+ "include_brand_guidelines_include_company_val": {
+ "type": "string"
+ },
+ "include_brand_guidelines_include_partner": {
+ "type": "boolean"
+ },
+ "include_brand_guidelines_include_partner_val": {
+ "type": "string"
+ },
+ "include_covered_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_company_claims": {
+ "type": "string"
+ },
+ "include_covered_claims_include_company_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_include_partner_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_partner_claims": {
+ "type": "string"
+ },
+ "include_dpa": {
+ "type": "boolean"
+ },
+ "include_dpa_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_dpa_location": {
+ "type": "string"
+ },
+ "include_dpa_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_increased_cap_amount": {
+ "type": "boolean"
+ },
+ "include_increased_cap_amount_currency": {
+ "type": "number"
+ },
+ "include_increased_cap_amount_either_currency": {
+ "type": "number"
+ },
+ "include_increased_cap_amount_either_multiple": {
+ "type": "string"
+ },
+ "include_increased_cap_amount_multiple": {
+ "type": "string"
+ },
+ "include_increased_cap_amount_type": {
+ "enum": [
+ "multiple",
+ "currency",
+ "either"
+ ],
+ "type": "string"
+ },
+ "include_increased_claims": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_confidentiality": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_confidentiality_misconduct": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_covered_claims": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_misconduct": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_other": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_other_val": {
+ "type": "string"
+ },
+ "include_unlimited_claims": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_confidentiality": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_confidentiality_misconduct": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_covered_claims": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_misconduct": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_other": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_other_val": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "partnership_business_terms_attributes": {
+ "additionalProperties": false,
+ "description": "Override partnership business terms terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "end_date_after_effective_date_amount": {
+ "type": "number"
+ },
+ "end_date_after_effective_date_unit": {
+ "enum": [
+ "month(s)",
+ "quarter(s)",
+ "year(s)"
+ ],
+ "type": "string"
+ },
+ "end_date_date": {
+ "type": "string"
+ },
+ "end_date_type": {
+ "enum": [
+ "date",
+ "effective date"
+ ],
+ "type": "string"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_obligations_company_brand": {
+ "type": "boolean"
+ },
+ "include_obligations_company_promotion": {
+ "type": "boolean"
+ },
+ "include_obligations_company_promotion_include_activities": {
+ "type": "boolean"
+ },
+ "include_obligations_company_promotion_include_activities_val": {
+ "type": "string"
+ },
+ "include_obligations_company_promotion_include_materials": {
+ "type": "boolean"
+ },
+ "include_obligations_company_promotion_include_materials_val": {
+ "type": "string"
+ },
+ "include_obligations_company_referral": {
+ "type": "boolean"
+ },
+ "include_obligations_company_referral_include_criteria": {
+ "type": "boolean"
+ },
+ "include_obligations_company_referral_include_criteria_val": {
+ "type": "string"
+ },
+ "include_obligations_company_referral_include_pay_sch": {
+ "type": "boolean"
+ },
+ "include_obligations_company_referral_include_pay_sch_amount": {
+ "type": "number"
+ },
+ "include_obligations_company_referral_include_pay_sch_custom": {
+ "type": "string"
+ },
+ "include_obligations_company_referral_include_pay_sch_unit": {
+ "enum": [
+ "U.S. Dollars",
+ "percent"
+ ],
+ "type": "string"
+ },
+ "include_obligations_company_sponsorship": {
+ "type": "boolean"
+ },
+ "include_obligations_company_sponsorship_include_benefits": {
+ "type": "boolean"
+ },
+ "include_obligations_company_sponsorship_include_benefits_val": {
+ "type": "string"
+ },
+ "include_obligations_company_sponsorship_include_payments": {
+ "type": "boolean"
+ },
+ "include_obligations_company_sponsorship_include_payments_amount": {
+ "type": "number"
+ },
+ "include_obligations_company_sponsorship_include_payments_unit": {
+ "enum": [
+ "U.S. Dollars",
+ "percent"
+ ],
+ "type": "string"
+ },
+ "include_obligations_partner_brand": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_promotion": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_promotion_include_activities": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_promotion_include_activities_val": {
+ "type": "string"
+ },
+ "include_obligations_partner_promotion_include_materials": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_promotion_include_materials_val": {
+ "type": "string"
+ },
+ "include_obligations_partner_referral": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_referral_include_criteria": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_referral_include_criteria_val": {
+ "type": "string"
+ },
+ "include_obligations_partner_referral_include_pay_sch": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_referral_include_pay_sch_amount": {
+ "type": "number"
+ },
+ "include_obligations_partner_referral_include_pay_sch_custom": {
+ "type": "string"
+ },
+ "include_obligations_partner_referral_include_pay_sch_unit": {
+ "enum": [
+ "U.S. Dollars",
+ "percent"
+ ],
+ "type": "string"
+ },
+ "include_obligations_partner_sponsorship": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_sponsorship_include_benefits": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_sponsorship_include_benefits_val": {
+ "type": "string"
+ },
+ "include_obligations_partner_sponsorship_include_payments": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_sponsorship_include_payments_amount": {
+ "type": "number"
+ },
+ "include_obligations_partner_sponsorship_include_payments_unit": {
+ "enum": [
+ "U.S. Dollars",
+ "percent"
+ ],
+ "type": "string"
+ },
+ "include_payment_process": {
+ "type": "boolean"
+ },
+ "include_payment_process_company": {
+ "type": "boolean"
+ },
+ "include_payment_process_company_include_address": {
+ "type": "boolean"
+ },
+ "include_payment_process_company_include_address_city": {
+ "type": "string"
+ },
+ "include_payment_process_company_include_address_country": {
+ "type": "string"
+ },
+ "include_payment_process_company_include_address_state": {
+ "type": "string"
+ },
+ "include_payment_process_company_include_address_street_address": {
+ "type": "string"
+ },
+ "include_payment_process_company_include_address_zipcode": {
+ "type": "string"
+ },
+ "include_payment_process_company_include_email": {
+ "type": "boolean"
+ },
+ "include_payment_process_company_include_email_val": {
+ "type": "string"
+ },
+ "include_payment_process_partner": {
+ "type": "boolean"
+ },
+ "include_payment_process_partner_include_address": {
+ "type": "boolean"
+ },
+ "include_payment_process_partner_include_address_city": {
+ "type": "string"
+ },
+ "include_payment_process_partner_include_address_country": {
+ "type": "string"
+ },
+ "include_payment_process_partner_include_address_state": {
+ "type": "string"
+ },
+ "include_payment_process_partner_include_address_street_address": {
+ "type": "string"
+ },
+ "include_payment_process_partner_include_address_zipcode": {
+ "type": "string"
+ },
+ "include_payment_process_partner_include_email": {
+ "type": "boolean"
+ },
+ "include_payment_process_partner_include_email_val": {
+ "type": "string"
+ },
+ "include_payment_schedule": {
+ "type": "boolean"
+ },
+ "include_payment_schedule_custom": {
+ "type": "string"
+ },
+ "include_payment_schedule_specified_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_payment_schedule_specified_timeframe": {
+ "enum": [
+ "receipt",
+ "date"
+ ],
+ "type": "string"
+ },
+ "include_payment_schedule_specified_unit": {
+ "enum": [
+ "day(s)",
+ "week(s)",
+ "month(s)",
+ "quarter(s)",
+ "year(s)"
+ ],
+ "type": "string"
+ },
+ "include_payment_schedule_type": {
+ "enum": [
+ "specified",
+ "custom"
+ ],
+ "type": "string"
+ },
+ "negotiations_allowed": {
+ "description": "When true, the recipient can propose changes to the business terms, even when the agreement-level `negotiations_allowed` is false. This only covers the business terms.",
+ "type": "boolean"
+ },
+ "territory_type": {
+ "enum": [
+ "worldwide",
+ "custom"
+ ],
+ "type": "string"
+ },
+ "territory_type_val": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "payment_link_url": {
+ "description": "A payment URL shown to the recipient after signing. Requires include_billing_workflow to be true and billing_workflow_type to be \"link\".",
+ "type": "string"
+ },
+ "pilot_attributes": {
+ "additionalProperties": false,
+ "description": "Override pilot terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "fees_type": {
+ "enum": [
+ "free",
+ "pilot_period_fees"
+ ],
+ "type": "string"
+ },
+ "general_cap_amount": {
+ "type": "number"
+ },
+ "general_cap_amount_type": {
+ "enum": [
+ "preceding",
+ "base",
+ "period"
+ ],
+ "type": "string"
+ },
+ "general_cap_period_currency": {
+ "type": "number"
+ },
+ "general_cap_period_qty": {
+ "type": "number"
+ },
+ "general_cap_preceding_amount": {
+ "type": "number"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_dpa": {
+ "type": "boolean"
+ },
+ "include_dpa_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_dpa_location": {
+ "type": "string"
+ },
+ "include_dpa_type": {
+ "enum": [
+ "description",
+ "attachment",
+ "standard"
+ ],
+ "type": "string"
+ },
+ "include_payment_process": {
+ "type": "boolean"
+ },
+ "include_technical_support": {
+ "type": "boolean"
+ },
+ "payment_process_automatic_frequency": {
+ "enum": [
+ "monthly",
+ "quarterly",
+ "annually",
+ "once_per_period"
+ ],
+ "type": "string"
+ },
+ "payment_process_invoice_days": {
+ "type": "number"
+ },
+ "payment_process_invoice_from": {
+ "enum": [
+ "receipt",
+ "date"
+ ],
+ "type": "string"
+ },
+ "payment_process_invoice_timeframe": {
+ "enum": [
+ "days",
+ "weeks",
+ "months",
+ "quarters",
+ "years"
+ ],
+ "type": "string"
+ },
+ "payment_process_type": {
+ "enum": [
+ "automatic",
+ "invoice"
+ ],
+ "type": "string"
+ },
+ "pilot_period_description": {
+ "type": "string"
+ },
+ "pilot_period_fees_description": {
+ "type": "string"
+ },
+ "product_description": {
+ "type": "string"
+ },
+ "technical_support_description": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "psa_attributes": {
+ "additionalProperties": false,
+ "description": "Override psa terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "additional_changes": {
+ "type": "string"
+ },
+ "customer_description": {
+ "type": "string"
+ },
+ "effective_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "effective_date_type": {
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "type": "string"
+ },
+ "general_cap_amount": {
+ "type": "number"
+ },
+ "general_cap_amount_type": {
+ "enum": [
+ "preceding",
+ "base",
+ "period"
+ ],
+ "type": "string"
+ },
+ "general_cap_period_currency": {
+ "type": "number"
+ },
+ "general_cap_period_qty": {
+ "type": "number"
+ },
+ "general_cap_preceding_amount": {
+ "type": "number"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_additional_changes": {
+ "type": "boolean"
+ },
+ "include_additional_warranties": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_by_customer": {
+ "type": "string"
+ },
+ "include_additional_warranties_by_provider": {
+ "type": "string"
+ },
+ "include_additional_warranties_include_by_customer": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_include_by_provider": {
+ "type": "boolean"
+ },
+ "include_covered_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_customer_claims": {
+ "type": "string"
+ },
+ "include_covered_claims_include_customer_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_include_provider_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_provider_claims": {
+ "type": "string"
+ },
+ "include_customer_insurance_min": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_add_provider_com_gen_liability": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_add_provider_cyber_liability": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_add_provider_errors_omissions": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_auto_liability_aggregate": {
+ "type": "number"
+ },
+ "include_customer_insurance_min_auto_liability_minimum": {
+ "type": "number"
+ },
+ "include_customer_insurance_min_cyber_liability_aggregate": {
+ "type": "number"
+ },
+ "include_customer_insurance_min_cyber_liability_minimum": {
+ "type": "number"
+ },
+ "include_customer_insurance_min_employer_liability_aggregate": {
+ "type": "number"
+ },
+ "include_customer_insurance_min_employer_liability_minimum": {
+ "type": "number"
+ },
+ "include_customer_insurance_min_general_liability_aggregate": {
+ "type": "number"
+ },
+ "include_customer_insurance_min_general_liability_minimum": {
+ "type": "number"
+ },
+ "include_customer_insurance_min_include_add_provider": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_include_auto_liability": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_include_cyber_liability": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_include_employer_liability": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_include_general_liability": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_include_workers_comp": {
+ "type": "boolean"
+ },
+ "include_customer_policies": {
+ "type": "boolean"
+ },
+ "include_customer_policies_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_customer_policies_location": {
+ "type": "string"
+ },
+ "include_customer_policies_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_dpa": {
+ "type": "boolean"
+ },
+ "include_dpa_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_dpa_location": {
+ "type": "string"
+ },
+ "include_dpa_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_increased_cap_amount": {
+ "type": "boolean"
+ },
+ "include_increased_claims": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_confidentiality": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_confidentiality_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_privsec": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_privsec_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_other": {
+ "type": "boolean"
+ },
+ "include_increased_claims_indemnification_obligation": {
+ "type": "boolean"
+ },
+ "include_increased_claims_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_other": {
+ "type": "string"
+ },
+ "include_provider_insurance_min": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_add_customer_com_gen_liability": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_add_customer_cyber_liability": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_add_customer_errors_omissions": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_auto_liability_aggregate": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_auto_liability_minimum": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_cyber_liability_aggregate": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_cyber_liability_minimum": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_employer_liability_aggregate": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_employer_liability_minimum": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_general_liability_aggregate": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_general_liability_minimum": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_include_add_customer": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_include_auto_liability": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_include_cyber_liability": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_include_employer_liability": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_include_general_liability": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_include_workers_comp": {
+ "type": "boolean"
+ },
+ "include_publicity_rights": {
+ "type": "boolean"
+ },
+ "include_publicity_rights_type": {
+ "enum": [
+ "public",
+ "non-public"
+ ],
+ "type": "string"
+ },
+ "include_security_policy": {
+ "type": "boolean"
+ },
+ "include_security_policy_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_security_policy_fedramp_auth": {
+ "type": "boolean"
+ },
+ "include_security_policy_hitrust": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_annual_maintenance": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_other": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_other_val": {
+ "type": "string"
+ },
+ "include_security_policy_iso27001": {
+ "type": "boolean"
+ },
+ "include_security_policy_location": {
+ "type": "string"
+ },
+ "include_security_policy_pci1": {
+ "type": "boolean"
+ },
+ "include_security_policy_pci2": {
+ "type": "boolean"
+ },
+ "include_security_policy_penetration_testing": {
+ "type": "boolean"
+ },
+ "include_security_policy_soc2_type1": {
+ "type": "boolean"
+ },
+ "include_security_policy_soc2_type2": {
+ "type": "boolean"
+ },
+ "include_security_policy_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_unlimited_claims": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_confidentiality": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_confidentiality_negligence": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_privsec": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_privsec_negligence": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_include_other": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_indemnification_obligation": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_negligence": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_other": {
+ "type": "string"
+ },
+ "increased_cap_amount_currency": {
+ "type": "number"
+ },
+ "increased_cap_amount_period_currency": {
+ "type": "number"
+ },
+ "increased_cap_amount_period_qty": {
+ "type": "number"
+ },
+ "increased_cap_amount_qty": {
+ "type": "number"
+ },
+ "increased_cap_amount_type": {
+ "enum": [
+ "qty",
+ "currency",
+ "period"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "psa_statement_of_work_attributes": {
+ "additionalProperties": false,
+ "description": "Override psa statement of work terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "additional_changes": {
+ "type": "string"
+ },
+ "cost": {
+ "type": "number"
+ },
+ "description": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "fees_attributes": {
+ "additionalProperties": {
+ "anyOf": [
+ {
+ "additionalProperties": false,
+ "description": "Fees::Flat (fee_type \"flat\"). A fixed recurring fee, e.g. a platform subscription. Set type to \"Fees::Flat\" or fee_type to \"flat\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Fixed amount in the order form's fees_currency, charged per fee_period. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"flat\". Alternative to type.",
+ "enum": [
+ "flat"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Flat\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Flat"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Discount (fee_type \"discount\"). A discount, as a fixed amount or a percentage, applied forever, once, or for a number of months. Set type to \"Fees::Discount\" or fee_type to \"discount\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Discount size: an amount in fees_currency when discount_type is fixed_amount (a plain amount, not cents: 20 means 20.00), or a percentage (e.g. 10 for 10%) when it is percentage.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "discount_duration_amount": {
+ "description": "Number of months the discount applies. Required when discount_duration_type is multiple_months.",
+ "type": "number"
+ },
+ "discount_duration_type": {
+ "description": "How long the discount applies. multiple_months also needs discount_duration_amount.",
+ "enum": [
+ "forever",
+ "once",
+ "multiple_months"
+ ],
+ "type": "string"
+ },
+ "discount_type": {
+ "description": "Whether cost is a currency amount or a percentage.",
+ "enum": [
+ "fixed_amount",
+ "percentage"
+ ],
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"discount\". Alternative to type.",
+ "enum": [
+ "discount"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Discount\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Discount"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Cost (fee_type \"cost\"). A per-unit fee: price per unit times quantity, e.g. seats. Set type to \"Fees::Cost\" or fee_type to \"cost\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Price per unit in fees_currency. The row total is quantity x cost. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"cost\". Alternative to type.",
+ "enum": [
+ "cost"
+ ],
+ "type": "string"
+ },
+ "quantity": {
+ "description": "Number of units.",
+ "type": "number"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Cost\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Cost"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Attachment (fee_type \"attachment\"). A fee described in an uploaded attachment instead of in the table. Set type to \"Fees::Attachment\" or fee_type to \"attachment\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "attachment_id": {
+ "description": "ID of an attachment uploaded with upload-attachment.",
+ "type": "string"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"attachment\". Alternative to type.",
+ "enum": [
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Attachment\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Attachment"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Graduated (fee_type \"graduated\"). Tiered pricing, with the price set per tier in graduated_fee_tiers_attributes. Set type to \"Fees::Graduated\" or fee_type to \"graduated\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"graduated\". Alternative to type.",
+ "enum": [
+ "graduated"
+ ],
+ "type": "string"
+ },
+ "graduated_fee_tiers_attributes": {
+ "additionalProperties": {
+ "additionalProperties": false,
+ "properties": {
+ "flat_price": {
+ "type": "number"
+ },
+ "price_per_unit": {
+ "type": "string"
+ },
+ "upper_limit": {
+ "type": "number"
+ }
+ },
+ "type": "object"
+ },
+ "description": "Graduated fee tiers. Use string keys such as \"0\", \"1\".",
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Graduated\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Graduated"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Included (fee_type \"included\"). An item included at no charge. Set type to \"Fees::Included\" or fee_type to \"included\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"included\". Alternative to type.",
+ "enum": [
+ "included"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Included\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Included"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Metered (fee_type \"metered\"). Usage-based pricing, billed per unit used. Set type to \"Fees::Metered\" or fee_type to \"metered\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Price per unit of usage in fees_currency. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"metered\". Alternative to type.",
+ "enum": [
+ "metered"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Metered\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Metered"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::OneTime (fee_type \"one_time\"). A one-time charge, such as a setup fee. Set type to \"Fees::OneTime\" or fee_type to \"one_time\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "One-time amount in fees_currency, charged once rather than per fee_period. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"one_time\". Alternative to type.",
+ "enum": [
+ "one_time"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::OneTime\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::OneTime"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Text (fee_type \"text\"). A fee term described in free text. Set type to \"Fees::Text\" or fee_type to \"text\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"text\". Alternative to type.",
+ "enum": [
+ "text"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Text\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Text"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ }
+ ]
+ },
+ "description": "Fee line items. Use string keys such as \"0\", \"1\". Replaces template fees when provided.",
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_additional_changes": {
+ "type": "boolean"
+ },
+ "include_customer_obligation": {
+ "type": "boolean"
+ },
+ "include_customer_obligation_val": {
+ "type": "string"
+ },
+ "include_deliverables": {
+ "type": "boolean"
+ },
+ "include_deliverables_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_deliverables_description": {
+ "type": "string"
+ },
+ "include_deliverables_include_acceptance": {
+ "type": "boolean"
+ },
+ "include_deliverables_include_attachment": {
+ "type": "boolean"
+ },
+ "include_deliverables_include_draft_deliverables": {
+ "type": "boolean"
+ },
+ "include_deliverables_rejection_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_deliverables_rejection_unit": {
+ "enum": [
+ "hours",
+ "days",
+ "weeks",
+ "months"
+ ],
+ "type": "string"
+ },
+ "include_deliverables_resubmission_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_deliverables_resubmission_unit": {
+ "enum": [
+ "hours",
+ "days",
+ "weeks",
+ "months"
+ ],
+ "type": "string"
+ },
+ "include_fees_other": {
+ "type": "boolean"
+ },
+ "include_fees_other_val": {
+ "type": "string"
+ },
+ "include_fees_table": {
+ "type": "boolean"
+ },
+ "include_fees_table_total": {
+ "type": "boolean"
+ },
+ "include_fees_travel": {
+ "type": "boolean"
+ },
+ "include_fees_travel_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_fees_travel_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_fees_travel_val": {
+ "type": "string"
+ },
+ "include_third_party_customer": {
+ "type": "boolean"
+ },
+ "include_third_party_include_description": {
+ "type": "boolean"
+ },
+ "include_third_party_include_description_val": {
+ "type": "string"
+ },
+ "include_third_party_materials": {
+ "type": "boolean"
+ },
+ "include_third_party_provider": {
+ "type": "boolean"
+ },
+ "include_time_of_assignment": {
+ "type": "boolean"
+ },
+ "include_time_of_assignment_type": {
+ "enum": [
+ "created",
+ "paid"
+ ],
+ "type": "string"
+ },
+ "invoice_period_description": {
+ "type": "string"
+ },
+ "negotiations_allowed": {
+ "description": "When true, the recipient can propose changes to the statement of work, even when the agreement-level `negotiations_allowed` is false. This only covers the statement of work.",
+ "type": "boolean"
+ },
+ "payment_period": {
+ "type": "number"
+ },
+ "payment_period_other": {
+ "type": "string"
+ },
+ "payment_period_timeframe": {
+ "enum": [
+ "receipt",
+ "invoice",
+ "Customer's receipt of invoice",
+ "date of invoice"
+ ],
+ "type": "string"
+ },
+ "payment_period_type": {
+ "enum": [
+ "standard",
+ "other"
+ ],
+ "type": "string"
+ },
+ "payment_period_unit": {
+ "enum": [
+ "day(s)",
+ "week(s)",
+ "month(s)",
+ "quarter(s)",
+ "year(s)"
+ ],
+ "type": "string"
+ },
+ "quantity": {
+ "type": "number"
+ },
+ "services_description": {
+ "type": "string"
+ },
+ "sow_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "sow_date_type": {
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "type": "string"
+ },
+ "sow_term_amount": {
+ "type": "number"
+ },
+ "sow_term_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "sow_term_type": {
+ "enum": [
+ "deliverables",
+ "period",
+ "date"
+ ],
+ "type": "string"
+ },
+ "sow_term_unit": {
+ "enum": [
+ "month(s)",
+ "quarter(s)",
+ "year(s)"
+ ],
+ "type": "string"
+ },
+ "type": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "recipient_email": {
+ "format": "email",
+ "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "recipient_name": {
+ "type": "string"
+ },
+ "recipient_notice_email_address": {
+ "description": "Email address for legal notices to the recipient.",
+ "format": "email",
+ "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "recipient_organization": {
+ "type": "string"
+ },
+ "recipient_role": {
+ "description": "PSA only. The recipient's role: `Customer` (the default) or `Provider`. Send it with `sender_role`; the two must be one `Provider` and one `Customer`. Other standard agreement types ignore it.",
+ "type": "string"
+ },
+ "sender_last_to_sign": {
+ "description": "When true, your signer signs after the recipient.",
+ "type": "boolean"
+ },
+ "sender_notice_email_address": {
+ "description": "Email address for legal notices to the sender.",
+ "format": "email",
+ "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "sender_role": {
+ "description": "PSA only. Your company's role: `Provider` (the default) or `Customer` when you hire the recipient to provide the services. Send it with `recipient_role`; the two must be one `Provider` and one `Customer`. When reading a PSA, an empty `sender_role` means `Provider`. Other standard agreement types ignore it.",
+ "type": "string"
+ },
+ "software_license_attributes": {
+ "additionalProperties": false,
+ "description": "Override software license terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "effective_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "effective_date_type": {
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "type": "string"
+ },
+ "general_cap_amount": {
+ "type": "number"
+ },
+ "general_cap_amount_type": {
+ "enum": [
+ "preceding",
+ "base",
+ "period"
+ ],
+ "type": "string"
+ },
+ "general_cap_period_currency": {
+ "type": "number"
+ },
+ "general_cap_period_qty": {
+ "type": "number"
+ },
+ "general_cap_preceding_amount": {
+ "type": "number"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_additional_warranties": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_by_customer": {
+ "type": "string"
+ },
+ "include_additional_warranties_by_provider": {
+ "type": "string"
+ },
+ "include_additional_warranties_include_by_customer": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_include_by_provider": {
+ "type": "boolean"
+ },
+ "include_ai_addendum": {
+ "type": "boolean"
+ },
+ "include_ai_addendum_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_covered_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_customer_claims": {
+ "type": "string"
+ },
+ "include_covered_claims_include_customer_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_include_provider_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_provider_claims": {
+ "type": "string"
+ },
+ "include_dpa": {
+ "type": "boolean"
+ },
+ "include_dpa_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_dpa_location": {
+ "type": "string"
+ },
+ "include_dpa_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_increased_cap_amount": {
+ "type": "boolean"
+ },
+ "include_increased_claims": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_confidentiality": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_confidentiality_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_other": {
+ "type": "boolean"
+ },
+ "include_increased_claims_indemnification_obligation": {
+ "type": "boolean"
+ },
+ "include_increased_claims_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_other": {
+ "type": "string"
+ },
+ "include_increased_claims_restrictions": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_confidentiality": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_confidentiality_negligence": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_include_other": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_indemnification_obligation": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_license_or_restrictions": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_negligence": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_other": {
+ "type": "string"
+ },
+ "increased_cap_amount_currency": {
+ "type": "number"
+ },
+ "increased_cap_amount_period_currency": {
+ "type": "number"
+ },
+ "increased_cap_amount_period_qty": {
+ "type": "number"
+ },
+ "increased_cap_amount_qty": {
+ "type": "number"
+ },
+ "increased_cap_amount_type": {
+ "enum": [
+ "qty",
+ "currency",
+ "period"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "software_license_order_form_attributes": {
+ "additionalProperties": false,
+ "description": "Override software license order form terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "additional_changes": {
+ "type": "string"
+ },
+ "deletion_procedure_include_custom": {
+ "type": "boolean"
+ },
+ "deletion_procedure_include_custom_description": {
+ "type": "string"
+ },
+ "deletion_procedure_include_customer_disable": {
+ "type": "boolean"
+ },
+ "deletion_procedure_include_customer_proof": {
+ "type": "boolean"
+ },
+ "deletion_procedure_include_provider_disable": {
+ "type": "boolean"
+ },
+ "fee_custom_unit": {
+ "type": "string"
+ },
+ "fee_period": {
+ "enum": [
+ "Subscription Period",
+ "month",
+ "year",
+ "Custom unit"
+ ],
+ "type": "string"
+ },
+ "fees_attributes": {
+ "additionalProperties": {
+ "anyOf": [
+ {
+ "additionalProperties": false,
+ "description": "Fees::Flat (fee_type \"flat\"). A fixed recurring fee, e.g. a platform subscription. Set type to \"Fees::Flat\" or fee_type to \"flat\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Fixed amount in the order form's fees_currency, charged per fee_period. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"flat\". Alternative to type.",
+ "enum": [
+ "flat"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Flat\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Flat"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Discount (fee_type \"discount\"). A discount, as a fixed amount or a percentage, applied forever, once, or for a number of months. Set type to \"Fees::Discount\" or fee_type to \"discount\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Discount size: an amount in fees_currency when discount_type is fixed_amount (a plain amount, not cents: 20 means 20.00), or a percentage (e.g. 10 for 10%) when it is percentage.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "discount_duration_amount": {
+ "description": "Number of months the discount applies. Required when discount_duration_type is multiple_months.",
+ "type": "number"
+ },
+ "discount_duration_type": {
+ "description": "How long the discount applies. multiple_months also needs discount_duration_amount.",
+ "enum": [
+ "forever",
+ "once",
+ "multiple_months"
+ ],
+ "type": "string"
+ },
+ "discount_type": {
+ "description": "Whether cost is a currency amount or a percentage.",
+ "enum": [
+ "fixed_amount",
+ "percentage"
+ ],
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"discount\". Alternative to type.",
+ "enum": [
+ "discount"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Discount\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Discount"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Cost (fee_type \"cost\"). A per-unit fee: price per unit times quantity, e.g. seats. Set type to \"Fees::Cost\" or fee_type to \"cost\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Price per unit in fees_currency. The row total is quantity x cost. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"cost\". Alternative to type.",
+ "enum": [
+ "cost"
+ ],
+ "type": "string"
+ },
+ "quantity": {
+ "description": "Number of units.",
+ "type": "number"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Cost\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Cost"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Attachment (fee_type \"attachment\"). A fee described in an uploaded attachment instead of in the table. Set type to \"Fees::Attachment\" or fee_type to \"attachment\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "attachment_id": {
+ "description": "ID of an attachment uploaded with upload-attachment.",
+ "type": "string"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"attachment\". Alternative to type.",
+ "enum": [
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Attachment\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Attachment"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Graduated (fee_type \"graduated\"). Tiered pricing, with the price set per tier in graduated_fee_tiers_attributes. Set type to \"Fees::Graduated\" or fee_type to \"graduated\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"graduated\". Alternative to type.",
+ "enum": [
+ "graduated"
+ ],
+ "type": "string"
+ },
+ "graduated_fee_tiers_attributes": {
+ "additionalProperties": {
+ "additionalProperties": false,
+ "properties": {
+ "flat_price": {
+ "type": "number"
+ },
+ "price_per_unit": {
+ "type": "string"
+ },
+ "upper_limit": {
+ "type": "number"
+ }
+ },
+ "type": "object"
+ },
+ "description": "Graduated fee tiers. Use string keys such as \"0\", \"1\".",
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Graduated\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Graduated"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Included (fee_type \"included\"). An item included at no charge. Set type to \"Fees::Included\" or fee_type to \"included\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"included\". Alternative to type.",
+ "enum": [
+ "included"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Included\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Included"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Metered (fee_type \"metered\"). Usage-based pricing, billed per unit used. Set type to \"Fees::Metered\" or fee_type to \"metered\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Price per unit of usage in fees_currency. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"metered\". Alternative to type.",
+ "enum": [
+ "metered"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Metered\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Metered"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::OneTime (fee_type \"one_time\"). A one-time charge, such as a setup fee. Set type to \"Fees::OneTime\" or fee_type to \"one_time\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "One-time amount in fees_currency, charged once rather than per fee_period. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"one_time\". Alternative to type.",
+ "enum": [
+ "one_time"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::OneTime\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::OneTime"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Text (fee_type \"text\"). A fee term described in free text. Set type to \"Fees::Text\" or fee_type to \"text\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"text\". Alternative to type.",
+ "enum": [
+ "text"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Text\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Text"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ }
+ ]
+ },
+ "description": "Fee line items. Use string keys such as \"0\", \"1\". Replaces template fees when provided.",
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+ },
+ "fees_currency": {
+ "enum": [
+ "USD",
+ "EUR",
+ "GBP",
+ "CAD",
+ "AUD",
+ "SGD",
+ "ILS",
+ "JPY",
+ "CHF",
+ "HKD"
+ ],
+ "type": "string"
+ },
+ "fees_include_fee_increase_upon_renewal": {
+ "type": "boolean"
+ },
+ "fees_include_fee_increase_upon_renewal_fee": {
+ "type": "number"
+ },
+ "fees_include_fee_increase_upon_renewal_type": {
+ "enum": [
+ "will",
+ "may"
+ ],
+ "type": "string"
+ },
+ "fees_inclusive_of_taxes": {
+ "type": "boolean"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_additional_changes": {
+ "type": "boolean"
+ },
+ "include_license_compliance_verification": {
+ "type": "boolean"
+ },
+ "include_license_compliance_verification_description": {
+ "type": "string"
+ },
+ "include_license_limits": {
+ "type": "boolean"
+ },
+ "include_license_limits_description": {
+ "type": "string"
+ },
+ "include_payment_process_include_billing_email": {
+ "type": "boolean"
+ },
+ "include_pilot_period": {
+ "type": "boolean"
+ },
+ "include_pilot_period_duration_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_pilot_period_duration_type": {
+ "enum": [
+ "day",
+ "week",
+ "month"
+ ],
+ "type": "string"
+ },
+ "include_pilot_period_include_fees": {
+ "type": "boolean"
+ },
+ "include_pilot_period_include_fees_amount": {
+ "type": "number"
+ },
+ "include_pilot_period_include_modifications": {
+ "type": "boolean"
+ },
+ "include_pilot_period_include_modifications_description": {
+ "type": "string"
+ },
+ "include_services": {
+ "type": "boolean"
+ },
+ "include_services_description": {
+ "type": "string"
+ },
+ "negotiations_allowed": {
+ "description": "When true, the recipient can propose changes to the order form, even when the agreement-level `negotiations_allowed` is false. This only covers the order form.",
+ "type": "boolean"
+ },
+ "order_date_date": {
+ "type": "string"
+ },
+ "order_date_type": {
+ "enum": [
+ "signature",
+ "date",
+ "other"
+ ],
+ "type": "string"
+ },
+ "payment_process_automatic_frequency": {
+ "enum": [
+ "monthly",
+ "quarterly",
+ "semiannually",
+ "annually"
+ ],
+ "type": "string"
+ },
+ "payment_process_type": {
+ "enum": [
+ "automatic",
+ "invoice",
+ "custom"
+ ],
+ "type": "string"
+ },
+ "payment_process_type_custom_val": {
+ "type": "string"
+ },
+ "payment_process_type_invoice_amount": {
+ "type": "number"
+ },
+ "payment_process_type_invoice_custom_unit": {
+ "type": "string"
+ },
+ "payment_process_type_invoice_duration": {
+ "enum": [
+ "day",
+ "week",
+ "month",
+ "year",
+ "day(s)",
+ "week(s)",
+ "month(s)",
+ "year(s)"
+ ],
+ "type": "string"
+ },
+ "payment_process_type_invoice_duration_start": {
+ "enum": [
+ "Customer's receipt of invoice",
+ "date of invoice"
+ ],
+ "type": "string"
+ },
+ "payment_process_type_invoice_type": {
+ "enum": [
+ "monthly",
+ "quarterly",
+ "semiannually",
+ "annually",
+ "Custom unit"
+ ],
+ "type": "string"
+ },
+ "permitted_uses_include_custom": {
+ "type": "boolean"
+ },
+ "permitted_uses_include_custom_description": {
+ "type": "string"
+ },
+ "permitted_uses_include_customers_affiliates": {
+ "type": "boolean"
+ },
+ "permitted_uses_include_internal_business": {
+ "type": "boolean"
+ },
+ "pilot_period_stripe_product_id": {
+ "type": "string"
+ },
+ "software_description": {
+ "type": "string"
+ },
+ "subscription_auto_renew": {
+ "enum": [
+ "days",
+ "subscription_end"
+ ],
+ "type": "string"
+ },
+ "subscription_period": {
+ "type": "number"
+ },
+ "subscription_period_unit": {
+ "type": "string"
+ },
+ "subscription_renewal_notice_days": {
+ "type": "number"
+ },
+ "warranty_period_description_amount": {
+ "type": "number"
+ },
+ "warranty_period_description_duration": {
+ "enum": [
+ "day",
+ "week",
+ "month",
+ "year"
+ ],
+ "type": "string"
+ },
+ "warranty_period_description_duration_start": {
+ "enum": [
+ "initial delivery of the Software",
+ "delivery of the Software and each subsequent Update",
+ "the Order Date"
+ ],
+ "type": "string"
+ },
+ "warranty_period_type": {
+ "enum": [
+ "description",
+ "none"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "test_agreement": {
+ "description": "When true, marks the agreement as a test. Test agreements do not count against your monthly limit.",
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "recipient_name",
+ "recipient_email"
+ ],
+ "type": "object"
+ },
+ "cc_users": {
+ "items": {
+ "format": "email",
+ "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "draft": {
+ "description": "When true, the agreement is saved as a draft and not sent to the recipient. Use POST /v1/agreements/{id}/send to send a draft agreement later.",
+ "type": "boolean"
+ },
+ "owner_id": {
+ "description": "User id of the agreement owner (sender).",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "signer_id": {
+ "description": "User id of the signer from the owner's organization.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "template_id": {
+ "description": "UUID of a template from `GET /v1/templates`. Accepts both Common Paper standard templates and uploaded PDF templates (`type` `uploaded_template`).",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ }
+ },
+ "required": [
+ "template_id",
+ "owner_id",
+ "signer_id",
+ "agreement"
+ ],
+ "type": "object"
+ }
+]
