Create, send, negotiate, sign, and track contracts with Common Paper.
Scored across 46 tools
The server ships functionally identical pairs distinguished only by transport wrapper: create-custom-term_application_json vs create-custom-term_multipart_form_data, create-custom-term-version_* pair, and upload-attachment_* pair share word-for-word descriptions. An agent has no reliable basis to choose between them, and the same duplication clouds the term vs term-version tools.
Core tools follow a clean kebab-case verb_noun pattern (create-agreement, archive-template, list-custom-terms), but the _application_json/_multipart_form_data suffixes are an appended naming hack that breaks the convention and mixes hyphen and underscore styles within a single name.
46 tools is heavy for this domain, and 6 of them are redundant JSON/multipart variants of only 3 operations, so the count is inflated by transport duplication rather than genuinely distinct capabilities.
Coverage is broad and solid: agreements (create/get/list/update/send/void/reassign/resend/history/shareable-link/pdf), templates and custom templates with versioning, custom terms, invitations, users, orgs, and attachments all have lifecycle operations. Missing pieces are minor, e.g. no delete for users/agreements beyond void/archive.
Archive a file attachment. Removed from active list; restorable in the UI.
| Name | Required | Description | Default |
|---|---|---|---|
| pathParams | Yes |
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare destructiveHint=true and readOnlyHint=false, and the description adds context the annotations do not: the file is removed from the active list and remains restorable via the UI. That reversibility detail materially changes how an agent should treat the operation. It does not state auth requirements or idempotency, so it is not a 5.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Two brief sentences with the action front-loaded and the behavioral note second; no filler. It is close to minimal but the second clause is the most valuable part of the definition.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a single-parameter mutation with annotations covering the safety profile, the essentials are present, but there is no output/response description, no mention of whether a corresponding unarchive path exists (which the sibling list lacks), and no permission context.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Only one parameter exists and the schema itself documents it as "The UUID of the attachment to archive" with a UUID pattern, so the schema carries most of the meaning. The description adds nothing about the identifier, leaving the low reported schema coverage uncompensated, but there is little room to add value for a single well-typed field.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
"Archive a file attachment" gives a specific verb plus resource, and the resource (attachment) is distinguishable from the sibling archive-template and archive-custom-template tools. It stops short of explicitly telling the agent how it differs from those siblings, but the noun is unambiguous.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
There is no guidance on when to archive versus doing something else, no mention of prerequisites, and no reference to any alternative tool. The agent must infer the trigger condition entirely, which is a clear gap for a mutation tool.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
Archive a custom template. It can no longer be used to create agreements; existing agreements are unaffected.
| Name | Required | Description | Default |
|---|---|---|---|
| pathParams | Yes |
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare destructiveHint=true and readOnlyHint=false, so the safety profile is covered. The description adds non-obvious behavioral context: the template can no longer be used to create agreements, while existing agreements are unaffected — exactly the impact scoping an agent needs before destructive action.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Two short sentences with zero filler; the action and its consequences are front-loaded in a single tight paragraph. Every clause earns its place by qualifying the blast radius.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a destructive single-parameter tool with annotations carrying the safety hints and no output schema, the description supplies the essential effect scope (creation blocked, existing agreements untouched). It could note whether archiving is reversible, but nothing critical is missing.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Only one parameter (a UUID id) and the schema itself names and describes it, so the description need not elaborate. The description adds no additional parameter meaning, but there is little to add given the single, name-obvious identifier.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
States a specific verb (archive) and specific resource (custom template), making it distinguishable from archive-attachment and archive-template by the resource noun. It stops short of explicitly contrasting itself with the sibling archive-template, so it is clear but not maximally differentiating.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Usage is implied by the resource scoping (custom templates only), but there is no explicit statement of when to pick this over archive-template, nor any prerequisites or warnings about the operation being irreversible. Adequate but leaves routing to inference.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
Archive an agreement template. Removed from active list; restorable in the UI.
| Name | Required | Description | Default |
|---|---|---|---|
| pathParams | Yes |
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare destructiveHint=true and readOnlyHint=false, but the description adds genuinely useful context beyond them: the template is only removed from the active list and is restorable (in the UI). This tells the agent it is a soft-delete rather than permanent data loss. It still omits auth/permission requirements and whether already-issued agreements are affected.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Two short sentences, front-loaded with the action and followed immediately by the effect and reversibility. No filler.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
No output schema exists, and the description adequately covers the outcome (removed from active list, restorable in UI) for a single-parameter mutation. Missing only edge behavior such as idempotency when archiving an already-archived template and whether the restore path exists outside the UI.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The description adds nothing about the single 'id' parameter. Reported top-level schema coverage is 0%, but the nested id field is self-documenting ('The UUID of the template to archive'), so the omission is not costly. Baseline 3 is appropriate given the schema carries the meaning.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
States a specific verb and resource: 'Archive an agreement template.' An agent can identify the operation, though the description never distinguishes it from the close sibling 'archive-custom-template', which is the main ambiguity in this toolset.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
No when-to-use guidance, no prerequisites, and no mention of alternatives such as archive-custom-template or the archive vs. delete distinction. Usage must be inferred entirely from the name and sibling list.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
Create an agreement from a standard, uploaded PDF, or custom template. Owner and signer: id or email each, never both. Recipient is counterparty. draft=true saves without sending; use send-agreement to send. Override template defaults via type attributes (e.g. csa_attributes); for custom templates pass agreement.custom_field_values keyed by the template's field keys.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes |
| Name | Required | Description |
|---|---|---|
No output parameters | ||
Create a custom template from a YAML definition of its title, sections, and fields. The definition becomes the first version. Requires user_email or user_id to record the creator. Optionally pass custom_term_id to attach custom terms from the organization.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Provide user_email or user_id to record the creator; one of the two is required. |
| Name | Required | Description |
|---|---|---|
No output parameters | ||
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare the safety profile (readOnlyHint=false, destructiveHint=false, openWorldHint=false). The description adds meaningful context beyond that: the definition is persisted as the template's first version, a creator must be recorded, and custom terms can be attached. It doesn't cover failure modes or name-uniqueness behavior, keeping it below 5.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Three sentences, front-loaded with the core action, then versioning behavior, then parameter requirements. No filler; every sentence carries distinct information.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
With an output schema present, return values need not be described, and the description covers the required creator and optional term attachment. It leaves minor gaps such as org-scoping and validation/failure conditions, but is sufficient for correct invocation.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 100%, so the schema already documents every field. The description reinforces the creator requirement and the custom_term_id attachment behavior but adds little syntax or format detail beyond the schema, so the baseline 3 applies.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
States a specific verb ("Create") plus resource ("custom template") and the input method ("from a YAML definition of its title, sections, and fields"). The purpose is unambiguous, but it never distinguishes itself from the sibling create-template or create-custom-template-version tools.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
It names the required creator fields (user_email/user_id) and the optional custom_term_id, which implies prerequisites, but offers no when-to-use vs alternative guidance or exclusions relative to create-template or create-custom-template-version.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
Publish a new YAML version of a custom template. It immediately becomes the version new agreements use; existing agreements keep their pinned version. Publishing an identical definition with the same linked terms is a no-op that returns the current version. Requires user_email or user_id to record the publisher.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Provide user_email or user_id to record the creator; one of the two is required. | |
| pathParams | Yes |
| Name | Required | Description |
|---|---|---|
No output parameters | ||
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Beyond the annotations (which only declare it is not read-only and not destructive), the description discloses significant behavioral traits: the new version immediately becomes the default for new agreements while existing agreements keep their pinned version, and republishing an identical definition is a no-op returning the current version. This is exactly the kind of non-obvious semantics an agent needs to avoid redundant calls.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Four tight sentences with the core action and its effect front-loaded, then the no-op edge case, then the publisher requirement. No redundant or filler content, and each sentence contributes distinct information.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given the tool has an output schema (so return values need not be explained), the description covers everything an agent requires: what it does, the versioning consequence, the idempotent no-op case, and the identity requirement. Nothing material is missing for correct invocation.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 50% and the schema already documents the id, definition, user_email and user_id parameters in detail. The description's 'Requires user_email or user_id to record the publisher' repeats what the schema already states, adding no new semantic value. Baseline 3 is appropriate when the schema carries the parameter documentation.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
States a precise verb+resource combination ('Publish a new YAML version of a custom template'), which is clearly distinct from sibling tools like update-custom-template and create-custom-template. An agent can immediately tell this creates a new version rather than editing or creating the template itself.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description implies usage through its versioning semantics but never explicitly states when to reach for this versus update-custom-template or create-custom-template. There are no exclusions or alternative-routing guidance, leaving the agent to infer the trigger condition from the name alone.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
Create text custom terms. The markdown body becomes released version 1. Requires user_email or user_id to record the creator. Text only; file terms are managed in the app. File uploads are not supported over MCP; create file terms through the REST endpoint with multipart/form-data.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Provide user_email or user_id to record the creator; one of the two is required. |
| Name | Required | Description |
|---|---|---|
No output parameters | ||
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint=false, destructiveHint=false and openWorldHint=false, so the safety profile is covered. The description adds genuinely non-obvious behavior: the markdown body is immediately published as released version 1 (an auto-release side effect), and a creator must be recorded via user_email or user_id. That is meaningful context an agent cannot get from the annotations alone.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Front-loaded with purpose and the key publish/creator facts, no filler preamble. The final two sentences about file terms and multipart/form-data partially restate each other, and one of them points away from an existing sibling tool, so the tail is slightly wasteful.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
An output schema exists, so return values need not be explained, and the description covers the creation semantics, the creator attribution requirement, and the text-only constraint. The one gap is the absence of any reference to the multipart sibling or the version-creation tools, which is the most likely source of a wrong tool choice here.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, including per-property descriptions for name, body, user_email, user_id and term_type, so the schema carries the parameter burden and the baseline is 3. The description reinforces the creator requirement and the 'released version 1' semantics of body but adds no syntax or format detail beyond what the schema already states.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
States a specific verb and resource ('Create text custom terms') and immediately draws the text-vs-file boundary that separates it from the file-oriented tools. It stops short of naming the actual sibling create-custom-term_multipart_form_data, so the agent must infer the routing from the 'text only' qualifier rather than a direct pointer.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
It gives a when-not ('Text only; file terms are managed in the app... create file terms through the REST endpoint with multipart/form-data'), which is real guidance. However, a sibling MCP tool named create-custom-term_multipart_form_data exists in the tool set, so steering the agent to a REST endpoint instead of that sibling is at best confusing and at worst misdirecting. The 'when to use this one vs the version-creation siblings' question is not addressed at all.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
Create text custom terms. The markdown body becomes released version 1. Requires user_email or user_id to record the creator. Text only; file terms are managed in the app. File uploads are not supported over MCP; create file terms through the REST endpoint with multipart/form-data.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes |
| Name | Required | Description |
|---|---|---|
No output parameters | ||
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint=false, destructiveHint=false, openWorldHint=false, so the write/safety profile is covered. The description adds valuable behavior — the markdown body becomes 'released version 1' and file uploads are unsupported over MCP — but it also asserts 'Requires user_email or user_id to record the creator,' which is not reflected in the schema and muddies the picture.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Front-loaded with the core action, and each sentence adds something. The 'Text only; file terms are managed in the app' and the final REST-endpoint sentence partially overlap, costing a little efficiency.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
An output schema exists, so return values need not be described. Coverage of the text-only constraint and versioning behavior is good, but the dangling user_email/user_id requirement is a real gap — it implies required inputs the schema does not expose, leaving the agent unsure how to satisfy the creator requirement.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 0% and the single 'body' property is an opaque anyOf, so the description must compensate: it explains the markdown body becomes version 1, which adds real meaning. But it references user_email/user_id as if required even though they are absent from the schema (additionalProperties=false), creating misleading parameter guidance.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
States a specific verb and resource ('Create text custom terms') and clarifies scope by contrasting text terms with file terms. However, it does not distinguish itself from the sibling create-custom-term_application_json, so an agent cannot easily tell the two apart beyond the name suffix.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Gives clear use/when-not guidance: use this for text terms, and file terms are not supported over MCP — instead create them via the REST endpoint with multipart/form-data. It stops short of naming the application/json sibling as the alternative for non-multipart contexts.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
Publish a new markdown version of text custom terms. It immediately becomes the released version new agreements use; existing versions stay immutable. Requires user_email or user_id to record the publisher. File uploads are not supported over MCP; publish file term versions through the REST endpoint with multipart/form-data.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Provide user_email or user_id to record the creator; one of the two is required. | |
| pathParams | Yes |
| Name | Required | Description |
|---|---|---|
No output parameters | ||
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare non-read-only, non-destructive, closed-world behavior, so the bar is lower. The description adds genuinely useful traits beyond that: the new version immediately becomes the released version used by new agreements, existing versions stay immutable, and a publisher must be recorded. It does not cover failure modes (e.g. invalid publisher) but the immutability/release semantics are the key non-obvious behavior.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Three sentences, all earning their place: what it does, the immutability/release consequence, and the limitation with its workaround. The primary action is front-loaded and nothing is redundant.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
With an output schema present, return values need not be described. The description covers the mutation semantics, the required publisher identity, and the transport limitation, which is everything an agent needs to call this correctly in a crowded sibling set.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is only 50% (the wrapper body/pathParams objects carry no field descriptions), so the description must compensate. It does by naming the markdown format of the body and reinforcing the user_email-or-user_id requirement for the publisher record, though it does not explain the pathParams id itself.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
States a specific verb+resource+scope: publishing a new markdown version of text custom terms. It also clarifies the domain distinction (text vs. file) that separates it from the multipart sibling, so an agent can route correctly without opening either schema.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Explicitly gives a when-not condition: file uploads are not supported over MCP and must go through the REST multipart endpoint. It also states the publisher-identity prerequisite. It does not name the sibling tool create-custom-term-version_multipart_form_data directly, leaving the agent to infer the MCP alternative.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
Publish a new markdown version of text custom terms. It immediately becomes the released version new agreements use; existing versions stay immutable. Requires user_email or user_id to record the publisher. File uploads are not supported over MCP; publish file term versions through the REST endpoint with multipart/form-data.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | ||
| pathParams | Yes |
| Name | Required | Description |
|---|---|---|
No output parameters | ||
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint=false and destructiveHint=false; the description adds genuinely new behavioral context — the new version is immediately released and used by new agreements, existing versions stay immutable, publisher identity must be recorded, and file uploads are unsupported over MCP. These are non-obvious traits beyond the annotation set.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Three front-loaded sentences with no filler: the publishing action and its versioning semantics come first, then the publisher requirement, then the MCP file-upload limitation. Each sentence earns its place.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a mutation tool with an output schema and annotations covering the safety profile, the description supplies the essential missing context: immutability of prior versions, immediate release, publisher identity, and the file-upload restriction. Only the exact body field list is left unexplained.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 0% and the body parameter is an opaque anyOf of empty schemas, so the description must carry the load. It does add meaning by identifying the publisher fields (user_email/user_id) and implying markdown content, but it does not enumerate the actual body fields, leaving half the input surface undocumented.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
States a specific verb+resource ('Publish a new markdown version of text custom terms') and immediately scopes it to text terms, explicitly excluding file terms, which are handled via REST. An agent can distinguish this from create-custom-term-version_application_json and the term-creation siblings without opening a schema.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Gives clear context: use this for markdown/text term versions, and route file uploads to the REST multipart endpoint since MCP does not support them. It also names the publisher requirement (user_email or user_id). It stops short of naming the exact sibling for the JSON variant, so it is clear but not exhaustive.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
Invite a user by email. Requires invitation.email and invitation.inviter_email (existing member). access defaults to standard. Returns 422 if email missing, inviter invalid, or already a member. Docs at https://api.commonpaper.com/docs/api/invitations#create-invitation
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes |
| Name | Required | Description |
|---|---|---|
No output parameters | ||
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare destructiveHint=true and openWorldHint=true, so the safety profile is covered. The description adds the existing-member precondition, the default access level, and the 422 failure conditions, which is meaningful context beyond the annotations. It does not state that an invite email is dispatched as a side effect, which would be the remaining useful disclosure.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Four short sentences, front-loaded with the action, then requirements, defaults, failure modes, and a docs link. No filler or redundancy.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
An output schema exists, so return-value description is unnecessary, and the description covers inputs, defaults, and error conditions. The only modest gap is not flagging the email-send side effect, which matters for a destructive/open-world mutation.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
With reported schema description coverage at 0% and a nested body/invitation wrapper, the description compensates by naming the two required sub-fields and noting access defaults to standard. It does not clarify the nested body wrapper shape or the admin/standard enum trade-offs, but it covers the decision-relevant parameters.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
States a specific verb and resource ('Invite a user by email') and names the mechanism (email) and the key identity fields. No sibling tool creates invitations, so differentiation is unambiguous against list-invitations/get-invitation.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Gives clear preconditions: invitation.email and invitation.inviter_email are required, and inviter_email must be an existing member. Adds error semantics (422 when email is missing, inviter invalid, or the address is already a member), which tells the agent when a call will fail. No explicit when-not-to-use or alternative tool, so it stops short of a 5.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
Create an agreement template. Use the schema variant for your template type (defaults to NDA). All fields optional; they pre-fill agreements created from the template.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes |
| Name | Required | Description |
|---|---|---|
No output parameters | ||
Download an agreement PDF by UUID. This tool does not return file bytes. It returns JSON with a curl_command string. Run that curl command exactly as returned to save the PDF locally. The download URL inside the command is single-use and expires in 5 minutes. Do not call any other file-download tool.
| Name | Required | Description | Default |
|---|---|---|---|
| pathParams | Yes |
| Name | Required | Description |
|---|---|---|
| curl_command | Yes | A ready-to-run curl command that downloads the PDF. The -o filename is shell-escaped by the server. Execute it exactly as returned; do not re-quote or modify arguments. |
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Discloses highly non-obvious behavior beyond the annotations: the tool does NOT return file bytes, it returns JSON containing a curl_command, the URL is single-use and expires in 5 minutes. Annotations only cover the read-only safety profile; the description carries the critical two-step workflow semantics.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Purpose is front-loaded in the first sentence, followed by tight, high-value sentences on return shape, execution steps, and expiration. Every sentence earns its place with no redundancy.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Despite an output schema existing, the description usefully explains the non-standard return (curl_command) and the execution requirement plus URL expiry. Combined with readOnly annotations, an agent has everything needed to invoke it correctly.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
With one parameter and reported schema coverage of 0%, the description compensates minimally by naming it a UUID, matching the schema's uuid format. It adds little meaning beyond the identifier type, so baseline is appropriate.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
States a specific verb+resource ('Download an agreement PDF') and the identifier ('by UUID'), immediately orienting the agent. It further differentiates itself by warning against other file-download tools, so it is distinguishable from siblings.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Gives clear operational guidance: use this to download a PDF by UUID and do not call any other file-download tool. It stops short of explicitly contrasting with non-download siblings like get-agreement, so it's clear context without full exclusions.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
Generate a Common Paper API key for the current OAuth user. Pass optional api_key.description. Returns attributes.key once — treat it as a secret; do not echo it to the user unless they ask. Persist the key in client/session storage and reuse it for future HTTP calls; only call this tool again if a request fails with 401/403 or the stored key is missing. Use the key as Authorization: Bearer for direct HTTP calls (e.g. uploading attachments to POST /v1/attachments).
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes |
| Name | Required | Description |
|---|---|---|
No output parameters | ||
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations declare it is a non-read-only, destructive (credential-creating) operation, and the description adds materially beyond that: the key is returned exactly once, must be treated as a secret, should not be echoed to the user unprompted, and must be persisted in client/session storage for reuse. That is exactly the behavioral context an agent needs before invoking.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Front-loaded with purpose, then the optional parameter, then the secret-handling and reuse protocol. Every sentence carries a distinct instruction, though the four-sentence density is near the upper bound for a single-parameter tool.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
An output schema exists, yet the description still flags the one non-obvious return fact (attributes.key is single-use output). Combined with lifecycle guidance (store, reuse, re-call on 401/403) and consumption instructions, nothing an agent needs to call this correctly is missing.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Top-level schema coverage is 0% (the single 'body' param carries no description), so the description must compensate, and it does: it names api_key.description as the optional field and clarifies that user_id is unnecessary under OAuth, matching the nested schema's note. It stops short of covering the full nested structure, so it compensates well but not exhaustively.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
States a specific verb and resource ('Generate a Common Paper API key for the current OAuth user'), plus the optional label it accepts. No sibling tool generates credentials, so an agent can place it uniquely in the toolset without opening the schema.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Explicitly states when to call it and, more importantly, when NOT to call it again: only re-invoke if a request fails with 401/403 or the stored key is missing. It also names the consumption pattern (Authorization: Bearer for direct HTTP calls such as POST /v1/attachments), leaving no ambiguity about sequencing.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
Get agreement details by UUID: parties, terms, and status. For CSA fees, check standard_version first - see the server instructions for which fee fields apply.
| Name | Required | Description | Default |
|---|---|---|---|
| pathParams | Yes |
| Name | Required | Description |
|---|---|---|
No output parameters | ||
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint=true, destructiveHint=false, and openWorldHint=false, so the safety profile is covered structurally. The description adds a genuine domain caveat about CSA fee fields depending on `standard_version`, but says nothing about not-found/error behavior or auth requirements, keeping it at a moderate level.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Two tight sentences, front-loaded with the core operation and followed by a targeted caveat. No filler, and the pointer to server instructions is bounded rather than vague.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
An output schema exists, so return-value detail is not required, and the description still names the main content areas. The CSA fee caveat defers to external server instructions, which is a small gap in self-containedness, but the definition is otherwise sufficient for a single-parameter read.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is reported at 0% (the `id` description is minimal), and the nested pathParams structure is not explained. The description corroborates that the key is a UUID, adding marginal clarity but no format or edge-case detail beyond the schema's pattern.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
States a specific verb and resource ('Get agreement details by UUID') and enumerates what is returned (parties, terms, status), which cleanly separates it from siblings like list-agreements, get-agreement-history, and download-agreement-pdf. An agent can identify the tool's scope without opening the schema.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Implied usage is clear from the verb (fetch one agreement by id), and it adds a domain hint about checking `standard_version` for CSA fees, but it never states when to prefer this over get-agreement-history or download-agreement-pdf, nor any preconditions such as the agreement existing or permissions needed.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
Get event history for an agreement: who changed what and when.
| Name | Required | Description | Default |
|---|---|---|---|
| pathParams | Yes |
| Name | Required | Description |
|---|---|---|
No output parameters | ||
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint=true, destructiveHint=false and openWorldHint=false, so the safety profile is fully covered. The description adds the substance of the return ('who changed what and when'), but says nothing about ordering, pagination, or retention limits on the history.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
A single tight sentence, front-loaded with the verb and the payoff of the call. Nothing wasted and nothing buried.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
An output schema exists, so return structure need not be described, and annotations cover safety. What is missing is the routing information an agent needs in a 40-tool namespace: why this history call and not list-agreement-history, and whether results are paged.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
One parameter at 0% schema description coverage in the metric sense, though the schema does label the UUID as the resource id. The description implies the agreement to look up but adds no format, scope, or versioning detail beyond that. Since the meaning is largely evident from the tool name, a baseline 3 is fair.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
States a specific verb (get) and resource (agreement history), plus what the payload contains ('who changed what and when'). However, it does not distinguish itself from the sibling list-agreement-history, which an agent could easily pick instead.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
No guidance on when to use this versus list-agreement-history or get-agreement, and no prerequisites (e.g. that it requires an existing agreement id). The agent must infer selection from the name alone.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
Get a custom template by UUID, including the YAML of its current version.
| Name | Required | Description | Default |
|---|---|---|---|
| pathParams | Yes |
| Name | Required | Description |
|---|---|---|
No output parameters | ||
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint=true, destructiveHint=false and openWorldHint=false, so the safety profile is covered. The description adds one non-obvious behavioral fact — that the response includes the current version's YAML rather than metadata only — but says nothing about auth requirements or behavior for a missing/stale UUID.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
A single front-loaded sentence with the resource, the lookup key, and the payload, and zero filler. Every clause earns its place.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
An output schema exists, so return structure needn't be explained, and annotations cover safety. The description still usefully discloses that the YAML of the current version is included, which is the one thing an agent might otherwise guess wrong; only error/missing-UUID behavior is omitted.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
There is a single path parameter whose meaning is largely conveyed by the schema's format/pattern, and the description's 'by UUID' adds only the identifier type. With one parameter and schema coverage reported at 0%, a baseline 3 is appropriate; nothing beyond 'UUID' is clarified.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
Specific verb ('Get') plus specific resource ('custom template'), with the lookup key ('by UUID') and the returned payload ('YAML of its current version') stated. This distinguishes it in practice from get-template and list-custom-templates, though the description never names those siblings explicitly.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The phrase 'by UUID' implicitly signals that a UUID must already be known (e.g., obtained from list-custom-templates), which is a weak usage cue. There is no explicit when-to-use versus get-template or when-not-to-use guidance.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
Get custom terms by UUID, including the full terms text of the released version.
| Name | Required | Description | Default |
|---|---|---|---|
| pathParams | Yes |
| Name | Required | Description |
|---|---|---|
No output parameters | ||
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint=true, destructiveHint=false and openWorldHint=false, so the safe-read profile is covered. The description contributes that the response includes the full terms text of the released version, but says nothing about permissions, error behavior for unknown UUIDs, or versioning semantics.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
One short sentence, front-loaded with the action and resource, with the return-content detail appended rather than buried. No wasted words.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
With an output schema present, the description need not explain return structure, and it still flags the notable payload (released-version terms text). For a single-parameter read tool with full annotations, this is nearly complete; only usage routing to siblings is absent.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
There is a single path parameter (id) whose format and meaning are already specified in the schema ('The UUID of the custom terms'). The description's 'by UUID' phrase reinforces but does not extend that, so it adds marginal value over the structured field.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description gives a specific verb+resource ('Get custom terms') and scopes it to retrieval by UUID, which cleanly separates it from the sibling list-custom-terms. It adds that the released version's full terms text is returned, though it does not explicitly name the list/update alternatives.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Usage is only implied: 'by UUID' signals a single-record lookup versus the list-custom-terms sibling, but there is no explicit when-to-use or when-not-to-use guidance and no mention of alternatives such as list-custom-terms or update-custom-term.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
Get a single invitation by id. Returns 404 if it belongs to another organization.
| Name | Required | Description | Default |
|---|---|---|---|
| pathParams | Yes |
| Name | Required | Description |
|---|---|---|
No output parameters | ||
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint=true, openWorldHint=false and destructiveHint=false, so the safety profile is covered. The description adds genuine behavioral context not present in the annotations: the org-scoped 404 outcome when the invitation belongs to another organization, which tells the agent how to interpret a failure.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Two short sentences, the core action front-loaded and the failure condition immediately after. No filler or repetition of the name/title.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
With an output schema present, return-shape explanation is not required, and the description still covers the important error case. For a one-parameter read tool this is nearly complete; only the pagination/bulk alternative context is absent.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
There is a single required parameter whose schema already carries a description ('The UUID of the invitation'). The description only restates 'by id' and adds no format, sourcing, or lookup semantics beyond the schema, so baseline 3 applies.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
States a specific verb and resource ('Get a single invitation by id'), which clearly separates it from mutation siblings like create-invitation and resend-agreement-email. It does not explicitly name the closest sibling (list-invitations) as the alternative for bulk retrieval, so it stops short of a 5.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The phrase 'a single invitation by id' implies the lookup use case versus list-invitations, but there is no explicit when-to-use/when-not-to-use statement or named alternative. Usage is inferable rather than stated.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
Get the currently authenticated user's profile. Only available when authenticating via OAuth.
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
| Name | Required | Description |
|---|---|---|
No output parameters | ||
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint=true, destructiveHint=false and openWorldHint=false, so the safety profile is covered. The description adds a genuine behavioral constraint beyond those annotations: the OAuth-only availability, which is auth/permission context the agent cannot infer from the schema. It stops short of describing failure behavior when unauthenticated.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Two short sentences with zero waste; the purpose is front-loaded and the availability caveat follows. Nothing could be cut without losing information.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a zero-parameter read-only getter with an output schema already defining the return shape, the description covers everything needed: what it returns and the auth condition under which it works.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The tool takes zero parameters and schema coverage is 100%, so there is nothing for the description to document. Baseline 4 applies for a parameterless tool.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
States a specific verb (Get) and a precisely scoped resource (the currently authenticated user's profile), which cleanly separates it from the sibling get-user that presumably targets an arbitrary user. An agent can tell the two apart without opening either schema.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Explicitly states the precondition 'Only available when authenticating via OAuth,' which tells the agent when this call will succeed. It does not, however, contrast itself against the sibling get-user or say what to do when the caller is not OAuth-authenticated, so a 4 rather than a 5.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
Get organization details by UUID.
| Name | Required | Description | Default |
|---|---|---|---|
| pathParams | Yes |
| Name | Required | Description |
|---|---|---|
No output parameters | ||
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint=true, destructiveHint=false, and openWorldHint=false, so the safety profile is covered. The description adds no behavioral context beyond that — no mention of authorization scope, error behavior for unknown UUIDs, or whether the caller can only fetch its own organization.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
A single, front-loaded sentence with no waste. It is appropriately sized for the tool's simplicity, though it is so terse that it borders on under-specification.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
With an output schema present, return values need not be explained, and annotations cover the safety profile. For a simple read tool the entry is minimally viable, but it omits how to source the UUID and any scoping/authorization context.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Only one parameter, and the schema provides a (generic) description for it. The phrase 'by UUID' marginally reinforces the required identifier format, but adds no real semantics beyond what the schema already encodes.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
States a specific verb (get) and resource (organization details) plus the lookup key (UUID). The distinction from list-organizations and update-organization is inferable from the verb, but the description never explicitly differentiates itself from those siblings.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
There is no when-to-use or when-not-to-use guidance. It implies a UUID is required but doesn't tell the agent where to obtain one (e.g., list-organizations) or how this differs from other get-* tools.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
Get template details by UUID (standard or uploaded PDF template).
| Name | Required | Description | Default |
|---|---|---|---|
| pathParams | Yes |
| Name | Required | Description |
|---|---|---|
| data | No | A standard template (type template_nda, template_csa, etc.) or an uploaded PDF template (type uploaded_template). Uploaded templates have no standard_version. |
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint=true, destructiveHint=false and openWorldHint=false, so the safety profile is fully covered. The description adds the template-type distinction (standard vs uploaded PDF), which is mild extra context, and the output schema covers return values, so no further disclosure is required.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
A single front-loaded sentence with zero filler; the lookup key and the covered resource variants come first with nothing wasted.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
With an output schema present, return-value explanation is unnecessary, and annotations cover safety, so the core need is met. The remaining gap is sibling disambiguation from get-custom-template and get-custom-term, which the description only gestures at.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Only one parameter, and schema description coverage is reported as 0% even though the id field carries a generic label. The description's 'by UUID' adds a small amount of meaning over the schema's 'The UUID of the resource', but nothing about nesting or format beyond what the schema's uuid format already enforces.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
States a specific verb (Get) and resource (template) scoped to lookup by UUID, and clarifies it covers 'standard or uploaded PDF template'. It hints at a sibling distinction (custom templates handled elsewhere) but never names get-custom-template, so an agent must infer the boundary.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The parenthetical implies two template varieties exist but gives no explicit when-to-use guidance or naming of the alternative tool (get-custom-template) for custom templates. The agent is left to infer routing from the name alone.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
Get user profile by UUID: name, email, and role.
| Name | Required | Description | Default |
|---|---|---|---|
| pathParams | Yes |
| Name | Required | Description |
|---|---|---|
No output parameters | ||
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint=true, openWorldHint=false and destructiveHint=false, so the safety profile is covered structurally. The description adds the returned field set (name, email, role), but says nothing about auth requirements, permission scoping, or behavior on unknown UUIDs.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
A single front-loaded sentence with no filler; the action, key, and payload are all stated in one pass.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a simple read-by-id tool with an output schema present, the description covers the essentials — resource, key, and returned fields — so return-value explanation is unnecessary. Only the sibling disambiguation is missing.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is reported at 0% despite the nested 'id' carrying a short description, and the description adds only that the identifier is a UUID — which the schema already enforces via format and pattern. It does not clarify the nested pathParams wrapper.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
States a specific verb and resource ('Get user profile') and enumerates the returned fields, so the agent knows exactly what this returns. It does not, however, distinguish itself from the closely related sibling 'get-me' or from 'list-users', which a reader must infer from the name alone.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
No guidance on when to use this versus 'get-me' (current user) or 'list-users' (enumeration). The only implicit signal is the 'by UUID' phrase, which hints at lookup semantics but never states an exclusion or condition.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
List agreement history events across your organization.
| Name | Required | Description | Default |
|---|---|---|---|
| queryParams | Yes |
| Name | Required | Description |
|---|---|---|
No output parameters | ||
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint=true, destructiveHint=false, and openWorldHint=false, so the safety profile is covered. The description adds only the organizational breadth of the read, with no word on result ordering, pagination behavior, or how much history is returned.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
A single front-loaded sentence with no filler. It is terse to the point of under-specification, but nothing in it is wasted.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
An output schema exists, so return-value documentation is not required, and annotations carry the safety profile. What is missing is routing guidance against the many list-* and get-* siblings, which the description never addresses.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Reported schema description coverage is 0% at the top level, and the description explains nothing about the queryParams payload. The nested properties (page[size], page[number], agreement_id, date range filters) are self-documented in the schema, so the description neither helps nor harms, landing at the baseline.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description gives a specific verb (list) and resource (agreement history events) plus a scope qualifier ('across your organization'). That scope wording implicitly separates it from the singular get-agreement-history sibling, though it never names the alternative.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
There is no statement of when to use this tool versus get-agreement-history, list-agreements, or any other sibling, and no mention of prerequisites or pagination expectations. The agent must infer the org-wide vs single-agreement distinction from the scope phrase alone.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
List agreements. Filter and sort by created_at, status, agreement_type, etc.
| Name | Required | Description | Default |
|---|---|---|---|
| queryParams | Yes |
| Name | Required | Description |
|---|---|---|
No output parameters | ||
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare this is a read-only, non-destructive, closed-world operation, so the bar is lower. The description adds no behavioral context beyond 'List agreements' and misleadingly promises sorting ('sort by created_at, status, agreement_type, etc.') that the schema does not support.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is two short sentences and front-loads the core action. The trailing 'etc.' is lazy, and the false 'sort' phrase is a wasted and incorrect clause, but overall it is compact.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
An output schema exists and the nested schema richly documents each filter, so the description need not explain return values. However, for a filtered-list tool with pagination behavior and a 'full' flag, the one-line description is minimally adequate and includes an unsupported sorting claim.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage for the top-level queryParams parameter is 0%, so the description must compensate for parameter meaning. It does not: it only loosely names a few filter fields and claims an unsupported sort capability, while the actual nested schema already documents each filter in far more precise detail.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description states a clear verb and resource ('List agreements') and names several filterable fields, so an agent can tell it retrieves agreements. It does not distinguish this list tool from siblings like get-agreement or list-agreement-history, and the 'sort by' claim is not backed by any sort parameter.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description offers no guidance on when to use this tool versus alternatives such as get-agreement, list-agreement-history, or list-agreement-types. It also does not mention pagination or the 'full' flag context, leaving usage conditions implicit at best.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
List all possible agreement status values.
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
| Name | Required | Description |
|---|---|---|
No output parameters | ||
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint=true, destructiveHint=false, and openWorldHint=false, so the safety profile is fully covered. The description adds only the 'all possible' completeness claim; it reveals nothing about caching, ordering, or stability of the enumeration.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
A single tight sentence with zero filler and the key qualifier ('all possible') front-loaded where the agent will read it.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
An output schema exists, so the description need not enumerate return values. For a zero-parameter enumeration tool this is nearly complete; only a hint about how the values should be used would add value.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The tool takes zero parameters, so per the baseline this scores 4. The schema is empty and fully covered, and there is nothing extra the description could usefully say about inputs.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
States a specific verb (List) and resource (agreement status values) with an explicit completeness claim ('all possible'). It is understandable without opening the schema, though it does not explicitly distinguish itself from the nearby list-agreement-types sibling.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Usage is only implied: an agent can infer this is a reference/lookup call to discover valid status values, but the description never states when to call it or what to do with the result. No alternatives or exclusions are named.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
List agreement types, including custom types for your organization.
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
| Name | Required | Description |
|---|---|---|
No output parameters | ||
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint=true, destructiveHint=false, and openWorldHint=false, so the safety profile is covered. The description only adds that org-custom types are included, which is modest extra value but not rich behavioral context.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
A single tight sentence with the resource stated first and the scoping detail second. Every word earns its place with no redundancy.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
An output schema exists, so return values need no explanation, and the annotations carry the safety profile. The description is complete for a zero-parameter read-only list tool, though it could note what the types are usable for.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The tool takes zero parameters, so the 4 baseline applies. There is nothing to document and no schema gap for the description to compensate for.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
States a specific verb (List) and resource (agreement types), and the clause 'including custom types for your organization' scopes what is returned. This helps distinguish it from sibling list tools like list-agreement-statuses and list-custom-terms, though it doesn't explicitly name those alternatives.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
There is no explicit when-to-use or when-not-to-use guidance. The agent must infer from the name that this is for enumerating agreement types (e.g., before creating an agreement); nothing routes it away from sibling list tools or states prerequisites.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
List file attachments in your organization.
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint=true, destructiveHint=false and openWorldHint=false, so the safety profile is covered by structured data. The description's only added behavioral fact is the organizational scope of the listing; it says nothing about pagination, ordering, or result size, which for a list endpoint would be the useful additions.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
A single front-loaded sentence with no padding or redundancy. It is efficiently sized, though its brevity reflects limited content rather than exceptional editorial discipline.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a zero-parameter, read-only listing with a fully covered schema and clear annotations, the description is the minimum viable. With no output schema, it still leaves an agent guessing at what a returned attachment looks like, whether results are paged, or whether the list is filtered by caller permissions.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The tool takes zero parameters and the schema is trivially complete, so the schema-carried baseline of 4 applies. There is no parameter syntax the description could usefully add.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
States a specific verb (List) and resource (file attachments) with an org-level scope, which an agent can distinguish from upload-attachment or archive-attachment by resource alone. It doesn't explicitly contrast itself with adjacent list-* siblings, but the named resource is unambiguous.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
No when-to-use guidance, no prerequisites, and no pointer to alternatives such as get-agreement for a specific agreement's attachments. Usage is only weakly implied by the verb+resource.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
List custom templates (YAML-defined templates). current_definition is the YAML new agreements are created from.
| Name | Required | Description | Default |
|---|---|---|---|
| queryParams | Yes |
| Name | Required | Description |
|---|---|---|
No output parameters | ||
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint=true, destructiveHint=false and openWorldHint=false, so the safety profile is covered. The description adds only a snippet of domain semantics ('current_definition is the YAML new agreements are created from'), with no mention of pagination behavior or result scope.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Two short, front-loaded sentences with no filler; the resource is named first and the field gloss follows. Efficient, though the second sentence is marginal value for a caller who just wants to list.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
An output schema exists, so return-value documentation is not required, and read-only annotations cover the safety profile. The description adequately identifies the resource; its only shortfall is failing to position custom templates against the plain templates and custom terms handled by siblings.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is reported as 0% at the tool level and the description says nothing about the pagination parameters (page[size], page[number]). Although the nested schema fields do carry their own descriptions, the description itself contributes no parameter meaning, so it fails to compensate for the coverage gap.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description states a specific verb+resource ('List custom templates') and qualifies it as 'YAML-defined templates', which implicitly separates it from the sibling list-templates. It stops short of explicitly naming or contrasting the sibling, so it lands just below the top mark.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
There is no guidance on when to use this versus list-templates, list-custom-terms, or get-custom-template, and no stated prerequisites or filtering conditions. The second sentence is domain context about a field, not usage direction.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
List custom terms (ids and metadata only; the terms text is omitted). Use get-custom-term for the full body.
| Name | Required | Description | Default |
|---|---|---|---|
| queryParams | Yes |
| Name | Required | Description |
|---|---|---|
No output parameters | ||
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare a read-only, non-destructive, closed-world read, so the safety profile is covered. The description adds a useful payload constraint (terms text omitted, metadata only), which goes beyond the annotations. However it says nothing about pagination behavior or result volume, which the nested query params imply.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Two tight sentences with zero waste; the payload-scope constraint is front-loaded ahead of the alternative-tool pointer. Every clause earns its place.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
With an output schema present, return values needn't be explained, and the description correctly focuses on scope plus the routing hint. For a simple filtered-list tool it is nearly complete, though pagination expectations are left entirely to the schema.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
There is a single queryParams object with 0% top-level schema coverage, and the description adds no parameter meaning. The nested page[size] and page[number] fields do carry their own descriptions and defaults in the schema, so the gap is partially mitigated. Baseline 3 is appropriate given the schema documents the effective inputs.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
States a specific verb (List) and resource (custom terms) and immediately scopes the payload (ids and metadata only; the terms text is omitted). It explicitly distinguishes itself from the sibling get-custom-term, so an agent can tell the two apart without opening a schema.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Names the alternative explicitly ('Use get-custom-term for the full body'), giving the condition that selects it. It doesn't cover list-vs-search-style cases or pagination expectations, but the core when-to-use routing is clear.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
List invitations for your organization. Filter with filter[status_eq] query param (e.g. pending).
| Name | Required | Description | Default |
|---|---|---|---|
| queryParams | Yes |
| Name | Required | Description |
|---|---|---|
No output parameters | ||
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint=true and destructiveHint=false, so the agent knows this is a safe read. The description adds little beyond that — no mention of pagination behavior or result scope — but it does not contradict the annotations.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Two tight sentences, front-loading the core purpose and then the filtering hint. No filler.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
An output schema exists and annotations carry the safety profile, so the description need not explain returns. For a list tool it is nearly complete, lacking only scope/pagination notes.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The description calls out only filter[status_eq] with a concrete example ('pending'), while the nested schema actually documents all five params including paging and access/email filters. The description adds a useful usage example but omits the other filters, so it is not adding substantially beyond the schema.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
States a specific verb and resource ('List invitations') and scopes it to the organization. It does not explicitly differentiate itself from the sibling get-invitation (singular fetch), though 'List' vs 'Get' makes the distinction reasonably inferable.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Implies usage by naming the filter pattern, but offers no when-to-use guidance, no exclusions, and no routing to alternatives like get-invitation. Structured filter params are the only selection hint.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
List organizations accessible to the authenticated user.
| Name | Required | Description | Default |
|---|---|---|---|
| queryParams | Yes |
| Name | Required | Description |
|---|---|---|
No output parameters | ||
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint=true, destructiveHint=false, and openWorldHint=false, so the safety profile is covered. The description adds only the scope constraint (accessible orgs); it says nothing about pagination behavior or result ordering, so it adds modest value beyond the structured fields.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
A single tight sentence with the resource and scope front-loaded and no filler. Nothing is wasted.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
An output schema exists, so return values need not be explained, and annotations cover safety. However, for a paginated list endpoint the description never mentions paging defaults or limits, leaving an agent to discover them from the schema alone.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The single parameter is a nested queryParams object whose page[size] and page[number] fields are documented in the schema, but the description adds nothing about pagination, page-size limits, or how to pass the wrapper. With no compensatory detail, the description leaves parameter usage entirely to the schema.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
States a specific verb and resource ('List organizations') plus a scope qualifier ('accessible to the authenticated user'), which distinguishes it from the singular get-organization. It does not explicitly name the sibling it replaces, but the intent is unambiguous.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
There is no when-to-use guidance, no mention of when to prefer get-organization for a single org, and no prerequisites or exclusions. The scope phrase 'accessible to the authenticated user' hints at context but is not routing guidance.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
List agreement templates (including uploaded PDF templates) and their attributes.
| Name | Required | Description | Default |
|---|---|---|---|
| queryParams | Yes |
| Name | Required | Description |
|---|---|---|
No output parameters | ||
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint=true, destructiveHint=false and openWorldHint=false, so the safety profile is fully covered without the description. The description adds the useful fact that uploaded PDF templates are included in results, but says nothing about pagination behavior or result size beyond what the schema provides.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
A single front-loaded sentence with no filler, and the parenthetical scope note is placed where it is most useful. It is efficient, though it leaves room for a sentence that would earn its place by distinguishing siblings.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
An output schema exists, so return values need not be explained, and annotations carry the safety profile. However, for a list tool sitting among several list-* and template tools, the description omits the routing information an agent needs to pick correctly, leaving a real completeness gap.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The top-level queryParams object carries no description (0% coverage), but its nested properties (full, page[size], page[number]) are well documented in the schema with defaults and meanings. The phrase 'and their attributes' loosely gestures at the `full` parameter's type-specific attributes but adds no real syntax or behavior detail, so the baseline 3 holds.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description names a specific verb (List) and resource (agreement templates) and adds a scope note that uploaded PDF templates are included, which is genuinely useful. It does not, however, distinguish this tool from the sibling list-custom-templates, so an agent must infer the boundary.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
There is no statement of when to use this tool versus alternatives such as list-custom-templates or get-template, and no prerequisites or exclusions are given. The agent gets the what but none of the routing guidance that this crowded sibling set demands.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
List all users in your organization.
| Name | Required | Description | Default |
|---|---|---|---|
| queryParams | Yes |
| Name | Required | Description |
|---|---|---|
No output parameters | ||
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint=true, destructiveHint=false, and openWorldHint=false, so the safety profile is covered. The description adds the organizational scoping constraint but says nothing about pagination, result size, or ordering behavior that a listing tool typically exhibits.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
A single short, front-loaded sentence with no filler or redundancy. It is efficient, though arguably efficient to the point of under-specification rather than genuinely informative.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
An output schema exists, so return values need not be explained. However, for a nested-parameter, org-scoped list tool, the description omits the filter capability and any pagination or scope caveats, leaving the agent to discover these from the schema alone.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 0% for the top-level queryParams object, and the description makes no mention of the available email filters (email_eq, email_cont). With low coverage the description was expected to compensate for the undocumented parameters, and it does not.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
States a clear verb+resource+scope: listing all users within the caller's organization. An agent can understand the operation at a glance, but the description does not distinguish it from the sibling get-user (single-user retrieval), which is the closest alternative an agent might confuse it with.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
There is no when-to-use guidance, no mention of get-user as the single-user alternative, and no indication of when filtering is appropriate. The agent must infer everything from the name and the sibling list.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
Reassign an agreement to a different recipient with new name and email. Docs at https://api.commonpaper.com/docs/api/agreements#reassign-agreement
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | ||
| pathParams | Yes |
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already disclose readOnlyHint=false, destructiveHint=true and openWorldHint=true, so the safety profile is known. The description adds little beyond that: it does not say whether the previous recipient loses access, whether an email is dispatched, whether a comment is sent, or what state the agreement must be in. The 'reassign' wording is the only behavioral signal, and it is largely redundant with the tool name.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
A single compact sentence with a docs link, front-loaded with the action. Nothing is wasted, though the sentence carries almost no operational detail given the tool's complexity.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
This is a destructive, open-world mutation on a UUID-scoped resource with a nested body object and no output schema. The description omits the id requirement, the state preconditions, the fate of the prior recipient, and the side effects of add_recipient_as_cc, leaving the agent materially under-informed.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is reported at 0% for the top-level envelope, and the description only hints at recipient_name and recipient_email. It says nothing about the required path id, the optional comments field, or add_recipient_as_cc, which alters behavior (previous recipient becomes a CC). With low schema coverage the description should compensate but does not.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description gives a specific verb and resource ('Reassign an agreement') plus the scope of the change ('to a different recipient with new name and email'), which distinguishes it from resend-agreement-email and send-agreement. It stops short of explicitly naming or contrasting those siblings, so it falls just below a 5.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
There is no when-to-use guidance, no prerequisites (e.g. agreement must be in a draft/sent state), and no mention of alternatives such as resend-agreement-email or send-agreement. The only pointer is an external docs URL, which the agent cannot rely on at selection time.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
Resend the last notification email to the agreement recipient.
| Name | Required | Description | Default |
|---|---|---|---|
| pathParams | Yes |
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint=false, destructiveHint=true and openWorldHint=true, so the safety profile is covered. The description adds genuinely useful context beyond them: it resends the LAST notification (not a fresh send) and targets the agreement recipient. It does not mention rate limits, required agreement state, or what happens if no prior email exists.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
One tight sentence with no filler, and the key qualifier ('last notification email', 'agreement recipient') is front-loaded.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Annotations cover the mutation/open-world profile and there is no output schema to explain, so the bar is lower. Still, for a destructiveHint=true action that sends mail to a third party, the definition omits preconditions (agreement state, prior email existence) and any duplicate-send or rate-limit caveat.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 0% for the single nested pathParams.id, whose only schema text is the generic 'The UUID of the resource.' The description implies the id identifies the agreement whose recipient is emailed, which adds a little meaning, but it never states that the UUID is the agreement id or whether other identifiers are accepted.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
States a specific verb (resend) and resource (the last notification email to the agreement recipient), which is clearer than the bare name. It implicitly distinguishes itself from send-agreement by saying it resends an existing notification, but never names that sibling or any other alternative explicitly.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
There is no when-to-use or when-not-to-use guidance and no alternative tool named, despite the obvious sibling send-agreement. The agent must infer that this is for re-delivering an email the recipient missed.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
Send a draft agreement to the recipient (draft → sent_waiting_for_initial_review). Agreement must be in draft status.
| Name | Required | Description | Default |
|---|---|---|---|
| pathParams | Yes |
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint=false, destructiveHint=true and openWorldHint=true, so the mutation and external-side-effect profile is covered. The description adds genuinely useful context beyond that: the exact state transition (draft → sent_waiting_for_initial_review) and the required starting state. It stops short of describing notification/email behavior or reversibility.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Two compact sentences with the state transition front-loaded and the precondition second; every clause earns its place and nothing is padded.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a single-parameter send action with no output schema, the description supplies the two things an agent needs: the required source state and the resulting state. There is no meaningful gap left unstated that would cause a wrong invocation.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
There is a single parameter whose meaning ('UUID of the draft agreement to send') is already documented inside the nested pathParams.id schema. The description adds no extra syntax or format guidance, so it neither compensates for nor improves on the schema; a baseline 3 is appropriate for a one-param tool with a self-describing field.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description states a specific verb (Send), resource (draft agreement), and target (the recipient), plus the resulting state transition. It is clearly distinguishable from siblings such as resend-agreement-email or create-agreement without opening their schemas.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
It gives an explicit precondition — 'Agreement must be in draft status' — which tells the agent when the call is valid. It does not, however, name the alternative to use once the agreement is already sent (e.g. resend-agreement-email), so the when-not guidance is only partial.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
Rename a custom template or change its linked custom terms. Pass custom_term_id to link terms, or an empty string to unlink; a terms change publishes a new template version, and user_id records who made it. YAML changes go through create-custom-template-version instead.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Provide name to rename the template, custom_term_id to change its linked terms, or both. | |
| pathParams | Yes |
| Name | Required | Description |
|---|---|---|
No output parameters | ||
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare destructiveHint=true and readOnlyHint=false, but the description adds genuine behavioral context: an empty custom_term_id unlinks terms, a terms change publishes a new template version, and user_id records the publisher. The side effect of version publishing is the key disclosure here.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Three dense sentences, front-loaded with the core action and the sibling redirect. No filler; each clause carries operational information.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
With an output schema present, return values need no explanation, and the annotations cover the safety profile. The description covers rename, terms linking/unlinking, version publishing, and sibling routing, leaving little an agent needs beyond what's given.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is only 50%, but the nested body properties carry rich inline descriptions (name, user_id format/422 note, custom_term_id link/unlink semantics) that already cover the substance. The description largely restates this ('Pass custom_term_id to link terms, or an empty string to unlink'), adding only marginal meaning over the schema.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
States a specific verb + resource ('Rename a custom template') and a second distinct operation ('change its linked custom terms'), then explicitly routes YAML edits to the sibling create-custom-template-version. An agent can distinguish it from the create/version siblings without opening a schema.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Explicitly names an alternative (YAML changes go through create-custom-template-version), giving clear when-not guidance for that case. It doesn't enumerate every alternative among the many update-* siblings, but the routing for the ambiguous case is stated plainly.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
Rename custom terms. Versions are immutable; content changes go through create-custom-term-version instead.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | ||
| pathParams | Yes |
| Name | Required | Description |
|---|---|---|
No output parameters | ||
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare destructiveHint=true and readOnlyHint=false, so the mutation profile is covered. The description adds genuinely useful behavior beyond that: versions are immutable and only the name is mutable, with content changes handled by a different tool. It does not explain permissions, response, or why a rename is flagged destructive, but the added context is real.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Two short sentences, zero waste, scope constraint front-loaded before the alternative. Nothing could be removed without losing routing information.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
An output schema exists, so return values need no explanation, and the description covers scope plus the sibling alternative for a 2-param mutation tool. Remaining gaps (id/path details, permission expectations) are minor rather than blocking.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Reported schema description coverage is 0%, so the description is expected to compensate for the two parameters. It implies only the name changes, which partially clarifies the body parameter, but says nothing about the id pathParam or value formats. Baseline 3.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
States a specific verb and resource ("Rename custom terms") and immediately contrasts the scope with the sibling create-custom-term-version. An agent can tell it apart from the other update-* and create-*-version tools without opening a schema.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Explicitly names the alternative for content edits ("content changes go through create-custom-term-version instead"), which gives a clear routing condition. It stops short of stating general when-to-use prerequisites (e.g., what state the terms must be in), so it is strong but not exhaustive.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
Edit a draft agreement in place; only agreements in draft status can be edited. Only the fields you send change. Send the term object the agreement type owns (csa_attributes and csa_order_form_attributes for a CSA, design_partner_attributes for a Design, and so on) and include that term's existing id from get-agreement, otherwise the request is rejected. Use send-agreement when the draft is ready.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | ||
| pathParams | Yes |
| Name | Required | Description |
|---|---|---|
No output parameters | ||
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations declare destructiveHint=true and readOnlyHint=false, so the safety profile is covered, but the description still adds real substance: partial-update semantics ('Only the fields you send change'), the status gate, and the term-object requirement that causes rejection. It stops short of describing auth needs or what 'destructive' means here (e.g. cc removal side effects noted in the schema).
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Four tight sentences, each carrying a distinct constraint (status gate, partial update, term object requirement, handoff to send-agreement), with the routing note last. No filler.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a complex, high-risk mutation with a heavy anyOf body and an output schema, the description covers the critical behavioral gotchas (status, partial update, term id). Return values need not be explained since an output schema exists. Minor gap: it does not warn about schema-level side effects like clearing cc users or replacing attachment lists.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Top-level params (body, pathParams) have no descriptions, so coverage reads 0%, but the description compensates for the most important semantic gap: it tells the agent to send the agreement-type-specific term object (csa_attributes, design_partner_attributes, ...) with that term's existing id from get-agreement. This mapping is not obvious from the schema's anyOf branches. It does not enumerate the term object names exhaustively ('and so on').
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
States a specific verb and resource ('Edit a draft agreement in place') and immediately constrains scope to draft-status agreements. An agent can distinguish it from send-agreement and update-custom-template without opening any schema.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Gives the precondition (only draft status), the routing rule ('Use send-agreement when the draft is ready'), and the rejection condition (missing term id). Explicit when/when-not with a named alternative.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
Update organization settings. URL id must match your API key organization (else 404). Only fields in organization object that you provide are changed.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | ||
| pathParams | Yes |
| Name | Required | Description |
|---|---|---|
No output parameters | ||
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare destructiveHint=true and readOnlyHint=false, so the safety profile is covered. The description adds real behavioral context: the update is a partial merge ("Only fields you provide are changed") and there is an auth/ownership constraint on the id. It does not detail irreversibility or required permissions beyond the ownership match.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Three tight sentences, front-loaded with the core action, then the two constraints that matter most. No filler or redundancy.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
With an output schema present, the return value need not be described, and annotations carry the destructive profile. The description covers the essentials (partial update, ownership constraint) for a nested-object mutation, though it could note side effects such as what being destructive entails.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Although top-level schema coverage reads 0%, the nested body fields carry their own descriptions and the body object documents the merge behavior. The description reinforces this semantic ("Only fields you provide are changed") and explains the id path param's ownership requirement, adding meaning beyond the raw schema.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
States a specific verb (update) and resource (organization settings), so an agent immediately knows this is a mutation on the organization entity. It does not explicitly differentiate itself from siblings like get-organization or list-organizations, but the verb is unambiguous.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Provides a concrete prerequisite: the URL id must match the API key's organization or a 404 results. This is actionable context an agent needs before calling. It stops short of naming alternatives (e.g. get-organization) or stating when-not to use it, keeping it below 5.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
Update an existing template. Match request schema to the template's agreement type (from get-template). Only provided fields change; template type cannot be changed.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | ||
| pathParams | Yes |
| Name | Required | Description |
|---|---|---|
No output parameters | ||
Upload a PDF attachment without sending file bytes through this tool. Required: attachment.filename (local PDF path; no control characters). Optional: attachment.name only if the Common Paper attachment name should differ from the file basename; attachment.description. Do not send uploaded_by — the OAuth-authenticated MCP user is recorded as the uploader. Returns JSON with curl_command where the path is already shell-escaped — run that command exactly as returned. Do not base64-encode the PDF into this tool and do not use generate-api-key for uploads.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes |
| Name | Required | Description |
|---|---|---|
| curl_command | Yes | Ready-to-run curl that POSTs the local PDF to the signed upload URL. The @path is shell-escaped by the server. Execute the string exactly as returned; do not re-quote or modify arguments. |
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations only cover the safety profile (readOnly=false, destructive=false, openWorld=false); the description adds decisive behavior beyond that: the tool returns a curl_command already shell-escaped, the OAuth user is auto-recorded as uploader, and the command must be run exactly as returned without re-quoting.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Dense but front-loaded, leading with the mechanism and then required/optional/forbidden fields before the return-value warning. Every clause carries information, though the density makes it slightly heavy for a single-param tool.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Covers the non-obvious contract end to end: metadata-only submission, identity handling, the curl_command return, and the run-as-is constraint. With an output schema present, return details are legitimately handled there, so nothing an agent needs is missing.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Despite 0% top-level schema coverage, the description fully specifies semantics: filename is a local path with no control characters, name is optional and only when it should differ from the basename, description is optional, and uploaded_by must be omitted. This is more than the schema conveys on its own.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
States a specific verb and resource ('Upload a PDF attachment') and clarifies the unusual mechanism ('without sending file bytes through this tool'). It distinguishes itself from generate-api-key explicitly, though it never names its true sibling upload-attachment_multipart_form_data, leaving that distinction to inference.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Gives explicit when-to-use and when-not-to-use: required vs optional fields, 'Do not send uploaded_by', 'Do not base64-encode the PDF into this tool', and 'do not use generate-api-key for uploads'. The agent has unambiguous routing rules.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
Upload a PDF attachment without sending file bytes through this tool. Required: attachment.filename (local PDF path; no control characters). Optional: attachment.name only if the Common Paper attachment name should differ from the file basename; attachment.description. Do not send uploaded_by — the OAuth-authenticated MCP user is recorded as the uploader. Returns JSON with curl_command where the path is already shell-escaped — run that command exactly as returned. Do not base64-encode the PDF into this tool and do not use generate-api-key for uploads.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes |
| Name | Required | Description |
|---|---|---|
| curl_command | Yes | Ready-to-run curl that POSTs the local PDF to the signed upload URL. The @path is shell-escaped by the server. Execute the string exactly as returned; do not re-quote or modify arguments. |
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations only declare write semantics (readOnlyHint=false, destructiveHint=false, openWorldHint=false). The description adds crucial non-obvious behavior: the call returns JSON containing a curl_command that is already shell-escaped and must be executed verbatim, and the uploader identity is derived from the OAuth user rather than a submitted field. That is high-value disclosure the annotations cannot convey.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The critical fact (no file bytes through this tool) is front-loaded in the first clause, and the remaining sentences each carry a distinct constraint. It is somewhat dense with stacked prohibitions, but nothing is padding.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
An output schema exists, so return-value explanation is not required, and the description still notes the curl_command payload. For a write tool with a three-branch anyOf schema, the description coherently steers the agent to the correct branch and covers the required invocation step, though it leaves the application_json variant's contract for the agent to infer.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Reported schema description coverage is 0% for the top-level param, so the description must compensate, and it does: it marks filename as required (local PDF path, no control characters), name as optional and only when it should differ from the basename, description as optional, and explicitly forbids sending uploaded_by. It does not describe the base64/pdf variant fields, which the schema still contains.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
States a specific verb and resource ('Upload a PDF attachment') and immediately resolves the confusing tool name by clarifying that file bytes are NOT sent through this tool. It implicitly separates itself from the sibling upload-attachment_application_json by forbidding base64 encoding, so an agent can distinguish the two without opening either schema.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Gives clear situational context (MCP client sends metadata only; the returned curl_command performs the actual byte upload) plus explicit exclusions ('Do not base64-encode', 'do not use generate-api-key for uploads'). It does not name the application_json sibling as the alternative for API-key clients, so the when-to-use-the-other-variant guidance is left implicit.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
Void an agreement so it is no longer valid or executable.
| Name | Required | Description | Default |
|---|---|---|---|
| pathParams | Yes |
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare destructiveHint=true, readOnlyHint=false and openWorldHint=true, so the safety profile is carried by structured data. The description adds useful effect context ("no longer valid or executable"), but says nothing about irreversibility, required permissions, valid source states, or whether existing signatures remain accessible.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
A single short sentence that front-loads the verb and effect with zero filler. Nothing could be removed without losing meaning.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
This is a destructive, likely irreversible state transition with no output schema to explain the result and no annotations covering prerequisites. The description omits valid starting states, permission requirements, downstream effects on signatures/attachments, and error behavior, leaving the agent under-informed for a one-way operation.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
There is a single required path parameter (id), and the schema itself supplies the UUID format, pattern and a short description of the field. With schema description coverage reported at 0%, the description contributes nothing about which agreement identifier is expected or how to obtain it, so it neither compensates nor harms.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description pairs a specific verb ("Void") with a specific resource ("an agreement") and clarifies the resulting state ("no longer valid or executable"). It is clearly distinguishable in meaning from create/send/update siblings, but it never explicitly names or contrasts a sibling such as archive-template or update-draft-agreement.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
There is no when-to-use guidance, no prerequisites (e.g. only draft or sent agreements can be voided), and no mention of alternatives such as update-draft-agreement or send-agreement for cases where voiding is not appropriate. The agent must infer usage entirely from the name.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
Recent tool additions, removals, and schema changes observed during successful MCP inspections.
create-agreement1 field changedInput schema / properties / body / anyOfPrevious 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": {
- "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": "number"
- },
- "aggregation_limitations_permitted_val": {
- "type": "number"
- },
- "breach_notification_unit": {
- "type": "string"
- },
- "breach_notification_val": {
- "type": "number"
- },
- "business_associate_relationship_type": {
- "type": "string"
- },
- "deidentification_limitations_include_purpose": {
- "type": "number"
- },
- "deidentification_limitations_include_requirements": {
- "type": "number"
- },
- "deidentification_limitations_permitted": {
- "type": "number"
- },
- "deidentification_limitations_purpose_val": {
- "type": "number"
- },
- "deidentification_limitations_requirements_val": {
- "type": "number"
- },
- "designated_record_set_provider_maintains": {
- "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_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": "number"
- },
- "offshore_limitations_permitted_val": {
- "type": "number"
- },
- "subcontract_limitations_include_notice": {
- "type": "number"
- },
- "subcontract_limitations_include_permission": {
- "type": "number"
- },
- "subcontract_limitations_notice_val": {
- "type": "number"
- },
- "subcontract_limitations_permission_val": {
- "type": "number"
- },
- "subcontract_limitations_permitted": {
- "type": "number"
- },
- "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"
- },
- "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-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"
- },
- "default_signer_email": {
- "format": "email",
- "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
- "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": {
- "type": "string"
- },
- "effective_date_type": {
- "type": "string"
- },
- "general_cap_amount": {
- "type": "number"
- },
- "general_cap_amount_type": {
- "type": "number"
- },
- "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": "boolean"
- },
- "include_acceptable_use_policy_type": {
- "type": "boolean"
- },
- "include_additional_warranties": {
- "type": "boolean"
- },
- "include_additional_warranties_by_customer": {
- "type": "boolean"
- },
- "include_additional_warranties_by_provider": {
- "type": "boolean"
- },
- "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": "boolean"
- },
- "include_covered_claims_include_customer_claims": {
- "type": "boolean"
- },
- "include_covered_claims_include_provider_claims": {
- "type": "boolean"
- },
- "include_covered_claims_provider_claims": {
- "type": "boolean"
- },
- "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": "boolean"
- },
- "include_dpa_type": {
- "type": "boolean"
- },
- "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": "boolean"
- },
- "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": "boolean"
- },
- "include_insurance_minimums_cyber_liability_aggregate": {
- "type": "boolean"
- },
- "include_insurance_minimums_cyber_liability_minimum": {
- "type": "boolean"
- },
- "include_insurance_minimums_employer_liability_aggregate": {
- "type": "boolean"
- },
- "include_insurance_minimums_employer_liability_minimum": {
- "type": "boolean"
- },
- "include_insurance_minimums_general_liability_aggregate": {
- "type": "boolean"
- },
- "include_insurance_minimums_general_liability_minimum": {
- "type": "boolean"
- },
- "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": {
- "type": "boolean"
- },
- "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": "boolean"
- },
- "include_security_policy_other": {
- "type": "boolean"
- },
- "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": {
- "type": "boolean"
- },
- "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_terms": {
- "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": "boolean"
- },
- "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": {
- "type": "number"
- },
- "negotiations_allowed": {
- "type": "string"
- },
- "provider": {
- "type": "string"
- },
- "sender_last_to_sign": {
- "type": "boolean"
- },
- "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": "number"
- },
- "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": {
- "type": "number"
- },
- "fees_attributes": {
- "additionalProperties": {
- "anyOf": [
- {
- "additionalProperties": false,
- "properties": {
- "cost": {
- "type": "number"
- },
- "description": {
- "type": "string"
- },
- "fee_type": {
- "type": "string"
- },
- "stripe_product_id": {
- "type": "string"
- },
- "type": {
- "description": "Fee class discriminator.",
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "cost": {
- "type": "number"
- },
- "description": {
- "type": "string"
- },
- "discount_duration_amount": {
- "type": "number"
- },
- "discount_duration_type": {
- "type": "string"
- },
- "discount_type": {
- "type": "string"
- },
- "fee_type": {
- "type": "string"
- },
- "stripe_product_id": {
- "type": "string"
- },
- "type": {
- "description": "Fee class discriminator.",
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "cost": {
- "type": "number"
- },
- "description": {
- "type": "string"
- },
- "fee_type": {
- "type": "string"
- },
- "quantity": {
- "type": "number"
- },
- "stripe_product_id": {
- "type": "string"
- },
- "type": {
- "description": "Fee class discriminator.",
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "attachment_id": {
- "type": "string"
- },
- "description": {
- "type": "string"
- },
- "fee_type": {
- "type": "string"
- },
- "stripe_product_id": {
- "type": "string"
- },
- "type": {
- "description": "Fee class discriminator.",
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "description": {
- "type": "string"
- },
- "fee_type": {
- "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": {
- "type": "string"
- },
- "type": {
- "description": "Fee class discriminator.",
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "description": {
- "type": "string"
- },
- "fee_type": {
- "type": "string"
- },
- "stripe_product_id": {
- "type": "string"
- },
- "type": {
- "description": "Fee class discriminator.",
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "cost": {
- "type": "number"
- },
- "description": {
- "type": "string"
- },
- "fee_type": {
- "type": "string"
- },
- "stripe_product_id": {
- "type": "string"
- },
- "type": {
- "description": "Fee class discriminator.",
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "cost": {
- "type": "number"
- },
- "description": {
- "type": "string"
- },
- "fee_type": {
- "type": "string"
- },
- "stripe_product_id": {
- "type": "string"
- },
- "type": {
- "description": "Fee class discriminator.",
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "description": {
- "type": "string"
- },
- "fee_type": {
- "type": "string"
- },
- "stripe_product_id": {
- "type": "string"
- },
- "type": {
- "description": "Fee class discriminator.",
- "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": {
- "type": "string"
- },
- "fees_include_fee_increase_upon_renewal": {
- "type": "number"
- },
- "fees_include_fee_increase_upon_renewal_fee": {
- "type": "number"
- },
- "fees_include_fee_increase_upon_renewal_type": {
- "type": "number"
- },
- "fees_inclusive_of_taxes": {
- "type": "boolean"
- },
- "framework_terms_type": {
- "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": "boolean"
- },
- "include_fees_table": {
- "type": "boolean"
- },
- "include_fees_table_period": {
- "type": "boolean"
- },
- "include_free_trial": {
- "type": "boolean"
- },
- "include_max_users": {
- "type": "boolean"
- },
- "include_pilot_period": {
- "type": "boolean"
- },
- "include_pilot_period_duration_amount": {
- "type": "boolean"
- },
- "include_pilot_period_duration_type": {
- "type": "boolean"
- },
- "include_pilot_period_include_fees": {
- "type": "boolean"
- },
- "include_pilot_period_include_fees_amount": {
- "type": "boolean"
- },
- "include_pilot_period_include_modifications": {
- "type": "boolean"
- },
- "include_pilot_period_include_modifications_description": {
- "type": "boolean"
- },
- "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": "boolean"
- },
- "include_product_support_type": {
- "type": "boolean"
- },
- "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": "boolean"
- },
- "include_professional_services_description": {
- "type": "boolean"
- },
- "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": "boolean"
- },
- "include_professional_services_include_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_include_fees_description": {
- "type": "boolean"
- },
- "include_professional_services_type": {
- "type": "boolean"
- },
- "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": "boolean"
- },
- "include_sla_include_response_time": {
- "type": "boolean"
- },
- "include_sla_include_response_time_amount": {
- "type": "boolean"
- },
- "include_sla_include_response_time_credit": {
- "type": "boolean"
- },
- "include_sla_include_response_time_duration": {
- "type": "boolean"
- },
- "include_sla_include_response_time_support_channel": {
- "type": "boolean"
- },
- "include_sla_include_target_uptime": {
- "type": "boolean"
- },
- "include_sla_maintenance_notice": {
- "type": "boolean"
- },
- "include_sla_maintenance_window": {
- "type": "boolean"
- },
- "include_sla_maintenance_window_type": {
- "type": "boolean"
- },
- "include_sla_standard_maintenance_notice_qty": {
- "type": "boolean"
- },
- "include_sla_standard_maintenance_notice_unit": {
- "type": "boolean"
- },
- "include_sla_standard_maintenance_window_end_time": {
- "type": "boolean"
- },
- "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": "boolean"
- },
- "include_sla_standard_maintenance_window_sunday": {
- "type": "boolean"
- },
- "include_sla_standard_maintenance_window_thursday": {
- "type": "boolean"
- },
- "include_sla_standard_maintenance_window_time_zone": {
- "type": "boolean"
- },
- "include_sla_standard_maintenance_window_tuesday": {
- "type": "boolean"
- },
- "include_sla_standard_maintenance_window_wednesday": {
- "type": "boolean"
- },
- "include_sla_standard_target_uptime": {
- "type": "boolean"
- },
- "include_sla_type": {
- "type": "boolean"
- },
- "include_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"
- },
- "include_subscription_start_date_date": {
- "type": "boolean"
- },
- "include_usage_review": {
- "type": "boolean"
- },
- "include_usage_review_val": {
- "type": "boolean"
- },
- "include_use_limitations": {
- "type": "boolean"
- },
- "include_use_limitations_val": {
- "type": "boolean"
- },
- "invoice_period": {
- "type": "number"
- },
- "invoice_period_custom_unit": {
- "type": "number"
- },
- "max_consumption": {
- "type": "number"
- },
- "max_users": {
- "type": "number"
- },
- "negotiations_allowed": {
- "type": "string"
- },
- "order_date_date": {
- "type": "string"
- },
- "order_date_other": {
- "type": "string"
- },
- "order_date_type": {
- "type": "string"
- },
- "payment_period": {
- "type": "number"
- },
- "payment_period_timeframe": {
- "type": "number"
- },
- "payment_period_unit": {
- "type": "number"
- },
- "payment_process_automatic_frequency": {
- "type": "string"
- },
- "payment_process_type": {
- "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": {
- "type": "string"
- },
- "payment_process_type_invoice_duration_start": {
- "type": "string"
- },
- "payment_process_type_invoice_type": {
- "type": "string"
- },
- "pilot_period_stripe_product_id": {
- "type": "number"
- },
- "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": {
- "type": "string"
- },
- "subscription_period": {
- "type": "number"
- },
- "subscription_period_unit": {
- "type": "number"
- },
- "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": {
- "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": "boolean"
- },
- "include_fees_description": {
- "type": "boolean"
- },
- "include_fees_pay_by_amount": {
- "type": "boolean"
- },
- "include_fees_type": {
- "type": "boolean"
- },
- "include_fees_unit": {
- "type": "boolean"
- },
- "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": "boolean"
- },
- "include_program_discount": {
- "type": "boolean"
- },
- "include_program_discount_amount": {
- "type": "boolean"
- },
- "include_program_discount_unit": {
- "type": "boolean"
- },
- "include_program_participation_feedback": {
- "type": "boolean"
- },
- "include_program_participation_feedback_amount": {
- "type": "boolean"
- },
- "include_program_participation_feedback_unit": {
- "type": "boolean"
- },
- "include_program_partner_other": {
- "type": "boolean"
- },
- "include_program_partner_other_val": {
- "type": "boolean"
- },
- "include_program_provider_other": {
- "type": "boolean"
- },
- "include_program_provider_other_val": {
- "type": "boolean"
- },
- "include_program_reference": {
- "type": "boolean"
- },
- "product_description": {
- "type": "string"
- },
- "term_amount": {
- "type": "number"
- },
- "term_unit": {
- "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": {
- "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": "number"
- },
- "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": {
- "type": "string"
- },
- "data_importer_address": {
- "type": "string"
- },
- "data_importer_address_city": {
- "type": "string"
- },
- "data_importer_address_country": {
- "type": "number"
- },
- "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": "boolean"
- },
- "include_covered_claim_internal_val": {
- "type": "boolean"
- },
- "include_covered_claim_type": {
- "type": "boolean"
- },
- "include_data_subjects_custom": {
- "type": "boolean"
- },
- "include_data_subjects_custom_val": {
- "type": "boolean"
- },
- "include_data_subjects_employees": {
- "type": "boolean"
- },
- "include_data_subjects_end_users": {
- "type": "boolean"
- },
- "include_external_subprocessor_location": {
- "type": "boolean"
- },
- "include_frequency_of_transfer_continuous": {
- "type": "boolean"
- },
- "include_frequency_of_transfer_custom": {
- "type": "boolean"
- },
- "include_frequency_of_transfer_custom_val": {
- "type": "boolean"
- },
- "include_governing_country_eu": {
- "type": "boolean"
- },
- "include_governing_country_eu_val": {
- "type": "boolean"
- },
- "include_governing_country_uk": {
- "type": "boolean"
- },
- "include_governing_country_uk_val": {
- "type": "boolean"
- },
- "include_governing_law": {
- "type": "boolean"
- },
- "include_governing_law_country": {
- "type": "boolean"
- },
- "include_governing_law_state": {
- "type": "boolean"
- },
- "include_increased_claim_amount": {
- "type": "boolean"
- },
- "include_increased_claim_amount_currency": {
- "type": "boolean"
- },
- "include_increased_claim_amount_qty": {
- "type": "boolean"
- },
- "include_increased_claim_amount_type": {
- "type": "boolean"
- },
- "include_liability_cap": {
- "type": "boolean"
- },
- "include_liability_cap_amount_constant_external": {
- "type": "boolean"
- },
- "include_liability_cap_amount_constant_internal": {
- "type": "boolean"
- },
- "include_liability_cap_amount_currency_external": {
- "type": "boolean"
- },
- "include_liability_cap_amount_currency_internal": {
- "type": "boolean"
- },
- "include_liability_cap_csa_type": {
- "type": "boolean"
- },
- "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": "boolean"
- },
- "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": "boolean"
- },
- "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": "boolean"
- },
- "include_provider_security_contact_address_country": {
- "type": "boolean"
- },
- "include_provider_security_contact_address_state": {
- "type": "boolean"
- },
- "include_provider_security_contact_address_street_address": {
- "type": "boolean"
- },
- "include_provider_security_contact_address_zipcode": {
- "type": "boolean"
- },
- "include_provider_security_contact_email": {
- "format": "email",
- "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
- "type": "string"
- },
- "include_provider_security_contact_email_val": {
- "type": "boolean"
- },
- "include_security_measures_accountability": {
- "type": "boolean"
- },
- "include_security_measures_accountability_val": {
- "type": "boolean"
- },
- "include_security_measures_certification_or_assurance": {
- "type": "boolean"
- },
- "include_security_measures_certification_or_assurance_val": {
- "type": "boolean"
- },
- "include_security_measures_confidentiality_integrity": {
- "type": "boolean"
- },
- "include_security_measures_confidentiality_integrity_val": {
- "type": "boolean"
- },
- "include_security_measures_data_at_rest": {
- "type": "boolean"
- },
- "include_security_measures_data_at_rest_val": {
- "type": "boolean"
- },
- "include_security_measures_data_minimization": {
- "type": "boolean"
- },
- "include_security_measures_data_minimization_val": {
- "type": "boolean"
- },
- "include_security_measures_data_quality": {
- "type": "boolean"
- },
- "include_security_measures_data_quality_val": {
- "type": "boolean"
- },
- "include_security_measures_data_retention": {
- "type": "boolean"
- },
- "include_security_measures_data_retention_val": {
- "type": "boolean"
- },
- "include_security_measures_data_transmission": {
- "type": "boolean"
- },
- "include_security_measures_data_transmission_val": {
- "type": "boolean"
- },
- "include_security_measures_event_logging": {
- "type": "boolean"
- },
- "include_security_measures_event_logging_val": {
- "type": "boolean"
- },
- "include_security_measures_identity_auth": {
- "type": "boolean"
- },
- "include_security_measures_identity_auth_val": {
- "type": "boolean"
- },
- "include_security_measures_it_security_governance": {
- "type": "boolean"
- },
- "include_security_measures_it_security_governance_val": {
- "type": "boolean"
- },
- "include_security_measures_physical_security": {
- "type": "boolean"
- },
- "include_security_measures_physical_security_val": {
- "type": "boolean"
- },
- "include_security_measures_portability_and_erasure": {
- "type": "boolean"
- },
- "include_security_measures_portability_and_erasure_val": {
- "type": "boolean"
- },
- "include_security_measures_pseudonym_encryption": {
- "type": "boolean"
- },
- "include_security_measures_pseudonym_encryption_val": {
- "type": "boolean"
- },
- "include_security_measures_restore_data_access": {
- "type": "boolean"
- },
- "include_security_measures_restore_data_access_val": {
- "type": "boolean"
- },
- "include_security_measures_security_policy": {
- "type": "boolean"
- },
- "include_security_measures_system_configuration": {
- "type": "boolean"
- },
- "include_security_measures_system_configuration_val": {
- "type": "boolean"
- },
- "include_security_measures_testing_assessment": {
- "type": "boolean"
- },
- "include_security_measures_testing_assessment_val": {
- "type": "boolean"
- },
- "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": "boolean"
- },
- "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": "boolean"
- },
- "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": {
- "type": "string"
- },
- "subprocessors_attributes": {
- "additionalProperties": {
- "additionalProperties": false,
- "properties": {
- "country": {
- "type": "string"
- },
- "name": {
- "type": "string"
- },
- "processing_task": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "description": "Subprocessors. Use string keys such as \"0\", \"1\".",
- "propertyNames": {
- "type": "string"
- },
- "type": "object"
- },
- "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"
- },
- "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"
- },
- "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": "string"
- },
- "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": "string"
- },
- "confidentiality_nda_type": {
- "type": "string"
- },
- "confidentiality_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"
- },
- "include_custom_details": {
- "type": "boolean"
- },
- "include_custom_details_val": {
- "type": "boolean"
- },
- "include_fees": {
- "type": "boolean"
- },
- "include_fees_amount": {
- "type": "boolean"
- },
- "include_fees_amount_duration": {
- "type": "boolean"
- },
- "include_fees_include_amount": {
- "type": "boolean"
- },
- "include_fees_include_other": {
- "type": "boolean"
- },
- "include_fees_other": {
- "type": "boolean"
- },
- "include_functionality": {
- "type": "boolean"
- },
- "include_functionality_val": {
- "type": "boolean"
- },
- "include_launch_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_launch_date_custom": {
- "type": "boolean"
- },
- "include_launch_date_date": {
- "type": "boolean"
- },
- "include_launch_date_type": {
- "type": "boolean"
- },
- "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"
- },
- "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": {
- "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": {
- "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_include_company": {
- "type": "boolean"
- },
- "include_additional_warranties_include_company_val": {
- "type": "boolean"
- },
- "include_additional_warranties_include_partner": {
- "type": "boolean"
- },
- "include_additional_warranties_include_partner_val": {
- "type": "boolean"
- },
- "include_brand_guidelines": {
- "type": "boolean"
- },
- "include_brand_guidelines_include_company": {
- "type": "boolean"
- },
- "include_brand_guidelines_include_company_val": {
- "type": "boolean"
- },
- "include_brand_guidelines_include_partner": {
- "type": "boolean"
- },
- "include_brand_guidelines_include_partner_val": {
- "type": "boolean"
- },
- "include_covered_claims": {
- "type": "boolean"
- },
- "include_covered_claims_company_claims": {
- "type": "boolean"
- },
- "include_covered_claims_include_company_claims": {
- "type": "boolean"
- },
- "include_covered_claims_include_partner_claims": {
- "type": "boolean"
- },
- "include_covered_claims_partner_claims": {
- "type": "boolean"
- },
- "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": "boolean"
- },
- "include_dpa_type": {
- "type": "boolean"
- },
- "include_increased_cap_amount": {
- "type": "boolean"
- },
- "include_increased_cap_amount_currency": {
- "type": "boolean"
- },
- "include_increased_cap_amount_either_currency": {
- "type": "boolean"
- },
- "include_increased_cap_amount_either_multiple": {
- "type": "boolean"
- },
- "include_increased_cap_amount_multiple": {
- "type": "boolean"
- },
- "include_increased_cap_amount_type": {
- "type": "boolean"
- },
- "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": "boolean"
- },
- "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": "boolean"
- },
- "negotiations_allowed": {
- "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": {
- "type": "string"
- },
- "end_date_date": {
- "type": "string"
- },
- "end_date_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"
- },
- "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": "boolean"
- },
- "include_obligations_company_promotion_include_materials": {
- "type": "boolean"
- },
- "include_obligations_company_promotion_include_materials_val": {
- "type": "boolean"
- },
- "include_obligations_company_referral": {
- "type": "boolean"
- },
- "include_obligations_company_referral_include_criteria": {
- "type": "boolean"
- },
- "include_obligations_company_referral_include_criteria_val": {
- "type": "boolean"
- },
- "include_obligations_company_referral_include_pay_sch": {
- "type": "boolean"
- },
- "include_obligations_company_referral_include_pay_sch_amount": {
- "type": "boolean"
- },
- "include_obligations_company_referral_include_pay_sch_custom": {
- "type": "boolean"
- },
- "include_obligations_company_referral_include_pay_sch_unit": {
- "type": "boolean"
- },
- "include_obligations_company_sponsorship": {
- "type": "boolean"
- },
- "include_obligations_company_sponsorship_include_benefits": {
- "type": "boolean"
- },
- "include_obligations_company_sponsorship_include_benefits_val": {
- "type": "boolean"
- },
- "include_obligations_company_sponsorship_include_payments": {
- "type": "boolean"
- },
- "include_obligations_company_sponsorship_include_payments_amount": {
- "type": "boolean"
- },
- "include_obligations_company_sponsorship_include_payments_unit": {
- "type": "boolean"
- },
- "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": "boolean"
- },
- "include_obligations_partner_promotion_include_materials": {
- "type": "boolean"
- },
- "include_obligations_partner_promotion_include_materials_val": {
- "type": "boolean"
- },
- "include_obligations_partner_referral": {
- "type": "boolean"
- },
- "include_obligations_partner_referral_include_criteria": {
- "type": "boolean"
- },
- "include_obligations_partner_referral_include_criteria_val": {
- "type": "boolean"
- },
- "include_obligations_partner_referral_include_pay_sch": {
- "type": "boolean"
- },
- "include_obligations_partner_referral_include_pay_sch_amount": {
- "type": "boolean"
- },
- "include_obligations_partner_referral_include_pay_sch_custom": {
- "type": "boolean"
- },
- "include_obligations_partner_referral_include_pay_sch_unit": {
- "type": "boolean"
- },
- "include_obligations_partner_sponsorship": {
- "type": "boolean"
- },
- "include_obligations_partner_sponsorship_include_benefits": {
- "type": "boolean"
- },
- "include_obligations_partner_sponsorship_include_benefits_val": {
- "type": "boolean"
- },
- "include_obligations_partner_sponsorship_include_payments": {
- "type": "boolean"
- },
- "include_obligations_partner_sponsorship_include_payments_amount": {
- "type": "boolean"
- },
- "include_obligations_partner_sponsorship_include_payments_unit": {
- "type": "boolean"
- },
- "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": "boolean"
- },
- "include_payment_process_company_include_address_country": {
- "type": "boolean"
- },
- "include_payment_process_company_include_address_state": {
- "type": "boolean"
- },
- "include_payment_process_company_include_address_street_address": {
- "type": "boolean"
- },
- "include_payment_process_company_include_address_zipcode": {
- "type": "boolean"
- },
- "include_payment_process_company_include_email": {
- "format": "email",
- "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
- "type": "string"
- },
- "include_payment_process_company_include_email_val": {
- "type": "boolean"
- },
- "include_payment_process_partner": {
- "type": "boolean"
- },
- "include_payment_process_partner_include_address": {
- "type": "boolean"
- },
- "include_payment_process_partner_include_address_city": {
- "type": "boolean"
- },
- "include_payment_process_partner_include_address_country": {
- "type": "boolean"
- },
- "include_payment_process_partner_include_address_state": {
- "type": "boolean"
- },
- "include_payment_process_partner_include_address_street_address": {
- "type": "boolean"
- },
- "include_payment_process_partner_include_address_zipcode": {
- "type": "boolean"
- },
- "include_payment_process_partner_include_email": {
- "format": "email",
- "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
- "type": "string"
- },
- "include_payment_process_partner_include_email_val": {
- "type": "boolean"
- },
- "include_payment_schedule": {
- "type": "boolean"
- },
- "include_payment_schedule_custom": {
- "type": "boolean"
- },
- "include_payment_schedule_specified_amount": {
- "type": "boolean"
- },
- "include_payment_schedule_specified_timeframe": {
- "type": "boolean"
- },
- "include_payment_schedule_specified_unit": {
- "type": "boolean"
- },
- "include_payment_schedule_type": {
- "type": "boolean"
- },
- "negotiations_allowed": {
- "type": "string"
- },
- "territory_type": {
- "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": {
- "type": "string"
- },
- "general_cap_amount": {
- "type": "number"
- },
- "general_cap_amount_type": {
- "type": "number"
- },
- "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": "boolean"
- },
- "include_dpa_type": {
- "type": "boolean"
- },
- "include_payment_process": {
- "type": "boolean"
- },
- "include_technical_support": {
- "type": "boolean"
- },
- "negotiations_allowed": {
- "type": "string"
- },
- "payment_process_automatic_frequency": {
- "type": "string"
- },
- "payment_process_invoice_days": {
- "type": "number"
- },
- "payment_process_invoice_from": {
- "type": "string"
- },
- "payment_process_invoice_timeframe": {
- "type": "string"
- },
- "payment_process_type": {
- "type": "string"
- },
- "pilot_period_description": {
- "type": "number"
- },
- "pilot_period_fees_description": {
- "type": "number"
- },
- "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"
- },
- "default_signer_email": {
- "format": "email",
- "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
- "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": {
- "type": "string"
- },
- "general_cap_amount": {
- "type": "number"
- },
- "general_cap_amount_type": {
- "type": "number"
- },
- "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": "boolean"
- },
- "include_additional_warranties_by_provider": {
- "type": "boolean"
- },
- "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": "boolean"
- },
- "include_covered_claims_include_customer_claims": {
- "type": "boolean"
- },
- "include_covered_claims_include_provider_claims": {
- "type": "boolean"
- },
- "include_covered_claims_provider_claims": {
- "type": "boolean"
- },
- "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": "boolean"
- },
- "include_customer_insurance_min_auto_liability_minimum": {
- "type": "boolean"
- },
- "include_customer_insurance_min_cyber_liability_aggregate": {
- "type": "boolean"
- },
- "include_customer_insurance_min_cyber_liability_minimum": {
- "type": "boolean"
- },
- "include_customer_insurance_min_employer_liability_aggregate": {
- "type": "boolean"
- },
- "include_customer_insurance_min_employer_liability_minimum": {
- "type": "boolean"
- },
- "include_customer_insurance_min_general_liability_aggregate": {
- "type": "boolean"
- },
- "include_customer_insurance_min_general_liability_minimum": {
- "type": "boolean"
- },
- "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": "boolean"
- },
- "include_customer_policies_type": {
- "type": "boolean"
- },
- "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": "boolean"
- },
- "include_dpa_type": {
- "type": "boolean"
- },
- "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": "boolean"
- },
- "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": "boolean"
- },
- "include_provider_insurance_min_auto_liability_minimum": {
- "type": "boolean"
- },
- "include_provider_insurance_min_cyber_liability_aggregate": {
- "type": "boolean"
- },
- "include_provider_insurance_min_cyber_liability_minimum": {
- "type": "boolean"
- },
- "include_provider_insurance_min_employer_liability_aggregate": {
- "type": "boolean"
- },
- "include_provider_insurance_min_employer_liability_minimum": {
- "type": "boolean"
- },
- "include_provider_insurance_min_general_liability_aggregate": {
- "type": "boolean"
- },
- "include_provider_insurance_min_general_liability_minimum": {
- "type": "boolean"
- },
- "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": {
- "type": "boolean"
- },
- "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": "boolean"
- },
- "include_security_policy_iso27001": {
- "type": "boolean"
- },
- "include_security_policy_location": {
- "type": "boolean"
- },
- "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": {
- "type": "boolean"
- },
- "include_terms": {
- "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_negligence": {
- "type": "boolean"
- },
- "include_unlimited_claims_other": {
- "type": "boolean"
- },
- "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": {
- "type": "number"
- },
- "negotiations_allowed": {
- "type": "string"
- },
- "sender_last_to_sign": {
- "type": "boolean"
- }
- },
- "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,
- "properties": {
- "cost": {
- "type": "number"
- },
- "description": {
- "type": "string"
- },
- "fee_type": {
- "type": "string"
- },
- "stripe_product_id": {
- "type": "string"
- },
- "type": {
- "description": "Fee class discriminator.",
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "cost": {
- "type": "number"
- },
- "description": {
- "type": "string"
- },
- "discount_duration_amount": {
- "type": "number"
- },
- "discount_duration_type": {
- "type": "string"
- },
- "discount_type": {
- "type": "string"
- },
- "fee_type": {
- "type": "string"
- },
- "stripe_product_id": {
- "type": "string"
- },
- "type": {
- "description": "Fee class discriminator.",
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "cost": {
- "type": "number"
- },
- "description": {
- "type": "string"
- },
- "fee_type": {
- "type": "string"
- },
- "quantity": {
- "type": "number"
- },
- "stripe_product_id": {
- "type": "string"
- },
- "type": {
- "description": "Fee class discriminator.",
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "attachment_id": {
- "type": "string"
- },
- "description": {
- "type": "string"
- },
- "fee_type": {
- "type": "string"
- },
- "stripe_product_id": {
- "type": "string"
- },
- "type": {
- "description": "Fee class discriminator.",
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "description": {
- "type": "string"
- },
- "fee_type": {
- "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": {
- "type": "string"
- },
- "type": {
- "description": "Fee class discriminator.",
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "description": {
- "type": "string"
- },
- "fee_type": {
- "type": "string"
- },
- "stripe_product_id": {
- "type": "string"
- },
- "type": {
- "description": "Fee class discriminator.",
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "cost": {
- "type": "number"
- },
- "description": {
- "type": "string"
- },
- "fee_type": {
- "type": "string"
- },
- "stripe_product_id": {
- "type": "string"
- },
- "type": {
- "description": "Fee class discriminator.",
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "cost": {
- "type": "number"
- },
- "description": {
- "type": "string"
- },
- "fee_type": {
- "type": "string"
- },
- "stripe_product_id": {
- "type": "string"
- },
- "type": {
- "description": "Fee class discriminator.",
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "description": {
- "type": "string"
- },
- "fee_type": {
- "type": "string"
- },
- "stripe_product_id": {
- "type": "string"
- },
- "type": {
- "description": "Fee class discriminator.",
- "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": "boolean"
- },
- "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": "boolean"
- },
- "include_deliverables_include_acceptance": {
- "type": "boolean"
- },
- "include_deliverables_include_attachment": {
- "type": "boolean"
- },
- "include_deliverables_include_draft_deliverables": {
- "type": "boolean"
- },
- "include_deliverables_rejection_amount": {
- "type": "boolean"
- },
- "include_deliverables_rejection_unit": {
- "type": "boolean"
- },
- "include_deliverables_resubmission_amount": {
- "type": "boolean"
- },
- "include_deliverables_resubmission_unit": {
- "type": "boolean"
- },
- "include_fees_other": {
- "type": "boolean"
- },
- "include_fees_other_val": {
- "type": "boolean"
- },
- "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": {
- "type": "boolean"
- },
- "include_fees_travel_val": {
- "type": "boolean"
- },
- "include_third_party_customer": {
- "type": "boolean"
- },
- "include_third_party_include_description": {
- "type": "boolean"
- },
- "include_third_party_include_description_val": {
- "type": "boolean"
- },
- "include_third_party_materials": {
- "type": "boolean"
- },
- "include_third_party_provider": {
- "type": "boolean"
- },
- "include_time_of_assignment": {
- "type": "boolean"
- },
- "include_time_of_assignment_type": {
- "type": "boolean"
- },
- "invoice_period_description": {
- "type": "number"
- },
- "negotiations_allowed": {
- "type": "string"
- },
- "payment_period": {
- "type": "number"
- },
- "payment_period_other": {
- "type": "number"
- },
- "payment_period_timeframe": {
- "type": "number"
- },
- "payment_period_type": {
- "type": "number"
- },
- "payment_period_unit": {
- "type": "number"
- },
- "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": {
- "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": {
- "type": "string"
- },
- "sow_term_unit": {
- "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-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-z]{2,}$",
- "type": "string"
- },
- "recipient_organization": {
- "type": "string"
- },
- "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-z]{2,}$",
- "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": {
- "type": "string"
- },
- "general_cap_amount": {
- "type": "number"
- },
- "general_cap_amount_type": {
- "type": "number"
- },
- "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": "boolean"
- },
- "include_additional_warranties_by_provider": {
- "type": "boolean"
- },
- "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": "boolean"
- },
- "include_covered_claims_include_customer_claims": {
- "type": "boolean"
- },
- "include_covered_claims_include_provider_claims": {
- "type": "boolean"
- },
- "include_covered_claims_provider_claims": {
- "type": "boolean"
- },
- "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": "boolean"
- },
- "include_dpa_type": {
- "type": "boolean"
- },
- "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": "boolean"
- },
- "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": "boolean"
- },
- "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": {
- "type": "number"
- }
- },
- "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": "string"
- },
- "deletion_procedure_include_custom_description": {
- "type": "string"
- },
- "deletion_procedure_include_customer_disable": {
- "type": "string"
- },
- "deletion_procedure_include_customer_proof": {
- "type": "string"
- },
- "deletion_procedure_include_provider_disable": {
- "type": "string"
- },
- "fee_custom_unit": {
- "type": "string"
- },
- "fee_period": {
- "type": "number"
- },
- "fees_attributes": {
- "additionalProperties": {
- "anyOf": [
- {
- "additionalProperties": false,
- "properties": {
- "cost": {
- "type": "number"
- },
- "description": {
- "type": "string"
- },
- "fee_type": {
- "type": "string"
- },
- "stripe_product_id": {
- "type": "string"
- },
- "type": {
- "description": "Fee class discriminator.",
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "cost": {
- "type": "number"
- },
- "description": {
- "type": "string"
- },
- "discount_duration_amount": {
- "type": "number"
- },
- "discount_duration_type": {
- "type": "string"
- },
- "discount_type": {
- "type": "string"
- },
- "fee_type": {
- "type": "string"
- },
- "stripe_product_id": {
- "type": "string"
- },
- "type": {
- "description": "Fee class discriminator.",
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "cost": {
- "type": "number"
- },
- "description": {
- "type": "string"
- },
- "fee_type": {
- "type": "string"
- },
- "quantity": {
- "type": "number"
- },
- "stripe_product_id": {
- "type": "string"
- },
- "type": {
- "description": "Fee class discriminator.",
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "attachment_id": {
- "type": "string"
- },
- "description": {
- "type": "string"
- },
- "fee_type": {
- "type": "string"
- },
- "stripe_product_id": {
- "type": "string"
- },
- "type": {
- "description": "Fee class discriminator.",
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "description": {
- "type": "string"
- },
- "fee_type": {
- "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": {
- "type": "string"
- },
- "type": {
- "description": "Fee class discriminator.",
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "description": {
- "type": "string"
- },
- "fee_type": {
- "type": "string"
- },
- "stripe_product_id": {
- "type": "string"
- },
- "type": {
- "description": "Fee class discriminator.",
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "cost": {
- "type": "number"
- },
- "description": {
- "type": "string"
- },
- "fee_type": {
- "type": "string"
- },
- "stripe_product_id": {
- "type": "string"
- },
- "type": {
- "description": "Fee class discriminator.",
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "cost": {
- "type": "number"
- },
- "description": {
- "type": "string"
- },
- "fee_type": {
- "type": "string"
- },
- "stripe_product_id": {
- "type": "string"
- },
- "type": {
- "description": "Fee class discriminator.",
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "description": {
- "type": "string"
- },
- "fee_type": {
- "type": "string"
- },
- "stripe_product_id": {
- "type": "string"
- },
- "type": {
- "description": "Fee class discriminator.",
- "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": {
- "type": "string"
- },
- "fees_include_fee_increase_upon_renewal": {
- "type": "number"
- },
- "fees_include_fee_increase_upon_renewal_fee": {
- "type": "number"
- },
- "fees_include_fee_increase_upon_renewal_type": {
- "type": "number"
- },
- "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": "boolean"
- },
- "include_license_limits": {
- "type": "boolean"
- },
- "include_license_limits_description": {
- "type": "boolean"
- },
- "include_payment_process_include_billing_email": {
- "format": "email",
- "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
- "type": "string"
- },
- "include_pilot_period": {
- "type": "boolean"
- },
- "include_pilot_period_duration_amount": {
- "type": "boolean"
- },
- "include_pilot_period_duration_type": {
- "type": "boolean"
- },
- "include_pilot_period_include_fees": {
- "type": "boolean"
- },
- "include_pilot_period_include_fees_amount": {
- "type": "boolean"
- },
- "include_pilot_period_include_modifications": {
- "type": "boolean"
- },
- "include_pilot_period_include_modifications_description": {
- "type": "boolean"
- },
- "include_services": {
- "type": "boolean"
- },
- "include_services_description": {
- "type": "boolean"
- },
- "negotiations_allowed": {
- "type": "string"
- },
- "order_date_date": {
- "type": "string"
- },
- "order_date_type": {
- "type": "string"
- },
- "payment_process_automatic_frequency": {
- "type": "string"
- },
- "payment_process_type": {
- "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": {
- "type": "string"
- },
- "payment_process_type_invoice_duration_start": {
- "type": "string"
- },
- "payment_process_type_invoice_type": {
- "type": "string"
- },
- "permitted_uses_include_custom": {
- "type": "string"
- },
- "permitted_uses_include_custom_description": {
- "type": "string"
- },
- "permitted_uses_include_customers_affiliates": {
- "type": "string"
- },
- "permitted_uses_include_internal_business": {
- "type": "string"
- },
- "pilot_period_stripe_product_id": {
- "type": "number"
- },
- "software_description": {
- "type": "string"
- },
- "subscription_auto_renew": {
- "type": "string"
- },
- "subscription_period": {
- "type": "number"
- },
- "subscription_period_unit": {
- "type": "number"
- },
- "subscription_renewal_notice_days": {
- "type": "number"
- },
- "warranty_period_description_amount": {
- "type": "number"
- },
- "warranty_period_description_duration": {
- "type": "number"
- },
- "warranty_period_description_duration_start": {
- "type": "number"
- },
- "warranty_period_type": {
- "type": "number"
- }
- },
- "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-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-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": {
- "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": "number"
- },
- "aggregation_limitations_permitted_val": {
- "type": "number"
- },
- "breach_notification_unit": {
- "type": "string"
- },
- "breach_notification_val": {
- "type": "number"
- },
- "business_associate_relationship_type": {
- "type": "string"
- },
- "deidentification_limitations_include_purpose": {
- "type": "number"
- },
- "deidentification_limitations_include_requirements": {
- "type": "number"
- },
- "deidentification_limitations_permitted": {
- "type": "number"
- },
- "deidentification_limitations_purpose_val": {
- "type": "number"
- },
- "deidentification_limitations_requirements_val": {
- "type": "number"
- },
- "designated_record_set_provider_maintains": {
- "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_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": "number"
- },
- "offshore_limitations_permitted_val": {
- "type": "number"
- },
- "subcontract_limitations_include_notice": {
- "type": "number"
- },
- "subcontract_limitations_include_permission": {
- "type": "number"
- },
- "subcontract_limitations_notice_val": {
- "type": "number"
- },
- "subcontract_limitations_permission_val": {
- "type": "number"
- },
- "subcontract_limitations_permitted": {
- "type": "number"
- },
- "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"
- },
- "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-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"
- },
- "default_signer_email": {
- "format": "email",
- "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
- "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": {
- "type": "string"
- },
- "effective_date_type": {
- "type": "string"
- },
- "general_cap_amount": {
- "type": "number"
- },
- "general_cap_amount_type": {
- "type": "number"
- },
- "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": "boolean"
- },
- "include_acceptable_use_policy_type": {
- "type": "boolean"
- },
- "include_additional_warranties": {
- "type": "boolean"
- },
- "include_additional_warranties_by_customer": {
- "type": "boolean"
- },
- "include_additional_warranties_by_provider": {
- "type": "boolean"
- },
- "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": "boolean"
- },
- "include_covered_claims_include_customer_claims": {
- "type": "boolean"
- },
- "include_covered_claims_include_provider_claims": {
- "type": "boolean"
- },
- "include_covered_claims_provider_claims": {
- "type": "boolean"
- },
- "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": "boolean"
- },
- "include_dpa_type": {
- "type": "boolean"
- },
- "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": "boolean"
- },
- "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": "boolean"
- },
- "include_insurance_minimums_cyber_liability_aggregate": {
- "type": "boolean"
- },
- "include_insurance_minimums_cyber_liability_minimum": {
- "type": "boolean"
- },
- "include_insurance_minimums_employer_liability_aggregate": {
- "type": "boolean"
- },
- "include_insurance_minimums_employer_liability_minimum": {
- "type": "boolean"
- },
- "include_insurance_minimums_general_liability_aggregate": {
- "type": "boolean"
- },
- "include_insurance_minimums_general_liability_minimum": {
- "type": "boolean"
- },
- "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": {
- "type": "boolean"
- },
- "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": "boolean"
- },
- "include_security_policy_other": {
- "type": "boolean"
- },
- "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": {
- "type": "boolean"
- },
- "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_terms": {
- "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": "boolean"
- },
- "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": {
- "type": "number"
- },
- "negotiations_allowed": {
- "type": "string"
- },
- "provider": {
- "type": "string"
- },
- "sender_last_to_sign": {
- "type": "boolean"
- },
- "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": "number"
- },
- "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": {
- "type": "number"
- },
- "fees_attributes": {
- "additionalProperties": {
- "anyOf": [
- {
- "additionalProperties": false,
- "properties": {
- "cost": {
- "type": "number"
- },
- "description": {
- "type": "string"
- },
- "fee_type": {
- "type": "string"
- },
- "stripe_product_id": {
- "type": "string"
- },
- "type": {
- "description": "Fee class discriminator.",
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "cost": {
- "type": "number"
- },
- "description": {
- "type": "string"
- },
- "discount_duration_amount": {
- "type": "number"
- },
- "discount_duration_type": {
- "type": "string"
- },
- "discount_type": {
- "type": "string"
- },
- "fee_type": {
- "type": "string"
- },
- "stripe_product_id": {
- "type": "string"
- },
- "type": {
- "description": "Fee class discriminator.",
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "cost": {
- "type": "number"
- },
- "description": {
- "type": "string"
- },
- "fee_type": {
- "type": "string"
- },
- "quantity": {
- "type": "number"
- },
- "stripe_product_id": {
- "type": "string"
- },
- "type": {
- "description": "Fee class discriminator.",
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "attachment_id": {
- "type": "string"
- },
- "description": {
- "type": "string"
- },
- "fee_type": {
- "type": "string"
- },
- "stripe_product_id": {
- "type": "string"
- },
- "type": {
- "description": "Fee class discriminator.",
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "description": {
- "type": "string"
- },
- "fee_type": {
- "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": {
- "type": "string"
- },
- "type": {
- "description": "Fee class discriminator.",
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "description": {
- "type": "string"
- },
- "fee_type": {
- "type": "string"
- },
- "stripe_product_id": {
- "type": "string"
- },
- "type": {
- "description": "Fee class discriminator.",
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "cost": {
- "type": "number"
- },
- "description": {
- "type": "string"
- },
- "fee_type": {
- "type": "string"
- },
- "stripe_product_id": {
- "type": "string"
- },
- "type": {
- "description": "Fee class discriminator.",
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "cost": {
- "type": "number"
- },
- "description": {
- "type": "string"
- },
- "fee_type": {
- "type": "string"
- },
- "stripe_product_id": {
- "type": "string"
- },
- "type": {
- "description": "Fee class discriminator.",
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "description": {
- "type": "string"
- },
- "fee_type": {
- "type": "string"
- },
- "stripe_product_id": {
- "type": "string"
- },
- "type": {
- "description": "Fee class discriminator.",
- "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": {
- "type": "string"
- },
- "fees_include_fee_increase_upon_renewal": {
- "type": "number"
- },
- "fees_include_fee_increase_upon_renewal_fee": {
- "type": "number"
- },
- "fees_include_fee_increase_upon_renewal_type": {
- "type": "number"
- },
- "fees_inclusive_of_taxes": {
- "type": "boolean"
- },
- "framework_terms_type": {
- "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": "boolean"
- },
- "include_fees_table": {
- "type": "boolean"
- },
- "include_fees_table_period": {
- "type": "boolean"
- },
- "include_free_trial": {
- "type": "boolean"
- },
- "include_max_users": {
- "type": "boolean"
- },
- "include_pilot_period": {
- "type": "boolean"
- },
- "include_pilot_period_duration_amount": {
- "type": "boolean"
- },
- "include_pilot_period_duration_type": {
- "type": "boolean"
- },
- "include_pilot_period_include_fees": {
- "type": "boolean"
- },
- "include_pilot_period_include_fees_amount": {
- "type": "boolean"
- },
- "include_pilot_period_include_modifications": {
- "type": "boolean"
- },
- "include_pilot_period_include_modifications_description": {
- "type": "boolean"
- },
- "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": "boolean"
- },
- "include_product_support_type": {
- "type": "boolean"
- },
- "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": "boolean"
- },
- "include_professional_services_description": {
- "type": "boolean"
- },
- "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": "boolean"
- },
- "include_professional_services_include_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_include_fees_description": {
- "type": "boolean"
- },
- "include_professional_services_type": {
- "type": "boolean"
- },
- "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": "boolean"
- },
- "include_sla_include_response_time": {
- "type": "boolean"
- },
- "include_sla_include_response_time_amount": {
- "type": "boolean"
- },
- "include_sla_include_response_time_credit": {
- "type": "boolean"
- },
- "include_sla_include_response_time_duration": {
- "type": "boolean"
- },
- "include_sla_include_response_time_support_channel": {
- "type": "boolean"
- },
- "include_sla_include_target_uptime": {
- "type": "boolean"
- },
- "include_sla_maintenance_notice": {
- "type": "boolean"
- },
- "include_sla_maintenance_window": {
- "type": "boolean"
- },
- "include_sla_maintenance_window_type": {
- "type": "boolean"
- },
- "include_sla_standard_maintenance_notice_qty": {
- "type": "boolean"
- },
- "include_sla_standard_maintenance_notice_unit": {
- "type": "boolean"
- },
- "include_sla_standard_maintenance_window_end_time": {
- "type": "boolean"
- },
- "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": "boolean"
- },
- "include_sla_standard_maintenance_window_sunday": {
- "type": "boolean"
- },
- "include_sla_standard_maintenance_window_thursday": {
- "type": "boolean"
- },
- "include_sla_standard_maintenance_window_time_zone": {
- "type": "boolean"
- },
- "include_sla_standard_maintenance_window_tuesday": {
- "type": "boolean"
- },
- "include_sla_standard_maintenance_window_wednesday": {
- "type": "boolean"
- },
- "include_sla_standard_target_uptime": {
- "type": "boolean"
- },
- "include_sla_type": {
- "type": "boolean"
- },
- "include_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"
- },
- "include_subscription_start_date_date": {
- "type": "boolean"
- },
- "include_usage_review": {
- "type": "boolean"
- },
- "include_usage_review_val": {
- "type": "boolean"
- },
- "include_use_limitations": {
- "type": "boolean"
- },
- "include_use_limitations_val": {
- "type": "boolean"
- },
- "invoice_period": {
- "type": "number"
- },
- "invoice_period_custom_unit": {
- "type": "number"
- },
- "max_consumption": {
- "type": "number"
- },
- "max_users": {
- "type": "number"
- },
- "negotiations_allowed": {
- "type": "string"
- },
- "order_date_date": {
- "type": "string"
- },
- "order_date_other": {
- "type": "string"
- },
- "order_date_type": {
- "type": "string"
- },
- "payment_period": {
- "type": "number"
- },
- "payment_period_timeframe": {
- "type": "number"
- },
- "payment_period_unit": {
- "type": "number"
- },
- "payment_process_automatic_frequency": {
- "type": "string"
- },
- "payment_process_type": {
- "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": {
- "type": "string"
- },
- "payment_process_type_invoice_duration_start": {
- "type": "string"
- },
- "payment_process_type_invoice_type": {
- "type": "string"
- },
- "pilot_period_stripe_product_id": {
- "type": "number"
- },
- "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": {
- "type": "string"
- },
- "subscription_period": {
- "type": "number"
- },
- "subscription_period_unit": {
- "type": "number"
- },
- "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": {
- "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": "boolean"
- },
- "include_fees_description": {
- "type": "boolean"
- },
- "include_fees_pay_by_amount": {
- "type": "boolean"
- },
- "include_fees_type": {
- "type": "boolean"
- },
- "include_fees_unit": {
- "type": "boolean"
- },
- "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": "boolean"
- },
- "include_program_discount": {
- "type": "boolean"
- },
- "include_program_discount_amount": {
- "type": "boolean"
- },
- "include_program_discount_unit": {
- "type": "boolean"
- },
- "include_program_participation_feedback": {
- "type": "boolean"
- },
- "include_program_participation_feedback_amount": {
- "type": "boolean"
- },
- "include_program_participation_feedback_unit": {
- "type": "boolean"
- },
- "include_program_partner_other": {
- "type": "boolean"
- },
- "include_program_partner_other_val": {
- "type": "boolean"
- },
- "include_program_provider_other": {
- "type": "boolean"
- },
- "include_program_provider_other_val": {
- "type": "boolean"
- },
- "include_program_reference": {
- "type": "boolean"
- },
- "product_description": {
- "type": "string"
- },
- "term_amount": {
- "type": "number"
- },
- "term_unit": {
- "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": {
- "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": "number"
- },
- "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": {
- "type": "string"
- },
- "data_importer_address": {
- "type": "string"
- },
- "data_importer_address_city": {
- "type": "string"
- },
- "data_importer_address_country": {
- "type": "number"
- },
- "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": "boolean"
- },
- "include_covered_claim_internal_val": {
- "type": "boolean"
- },
- "include_covered_claim_type": {
- "type": "boolean"
- },
- "include_data_subjects_custom": {
- "type": "boolean"
- },
- "include_data_subjects_custom_val": {
- "type": "boolean"
- },
- "include_data_subjects_employees": {
- "type": "boolean"
- },
- "include_data_subjects_end_users": {
- "type": "boolean"
- },
- "include_external_subprocessor_location": {
- "type": "boolean"
- },
- "include_frequency_of_transfer_continuous": {
- "type": "boolean"
- },
- "include_frequency_of_transfer_custom": {
- "type": "boolean"
- },
- "include_frequency_of_transfer_custom_val": {
- "type": "boolean"
- },
- "include_governing_country_eu": {
- "type": "boolean"
- },
- "include_governing_country_eu_val": {
- "type": "boolean"
- },
- "include_governing_country_uk": {
- "type": "boolean"
- },
- "include_governing_country_uk_val": {
- "type": "boolean"
- },
- "include_governing_law": {
- "type": "boolean"
- },
- "include_governing_law_country": {
- "type": "boolean"
- },
- "include_governing_law_state": {
- "type": "boolean"
- },
- "include_increased_claim_amount": {
- "type": "boolean"
- },
- "include_increased_claim_amount_currency": {
- "type": "boolean"
- },
- "include_increased_claim_amount_qty": {
- "type": "boolean"
- },
- "include_increased_claim_amount_type": {
- "type": "boolean"
- },
- "include_liability_cap": {
- "type": "boolean"
- },
- "include_liability_cap_amount_constant_external": {
- "type": "boolean"
- },
- "include_liability_cap_amount_constant_internal": {
- "type": "boolean"
- },
- "include_liability_cap_amount_currency_external": {
- "type": "boolean"
- },
- "include_liability_cap_amount_currency_internal": {
- "type": "boolean"
- },
- "include_liability_cap_csa_type": {
- "type": "boolean"
- },
- "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": "boolean"
- },
- "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": "boolean"
- },
- "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": "boolean"
- },
- "include_provider_security_contact_address_country": {
- "type": "boolean"
- },
- "include_provider_security_contact_address_state": {
- "type": "boolean"
- },
- "include_provider_security_contact_address_street_address": {
- "type": "boolean"
- },
- "include_provider_security_contact_address_zipcode": {
- "type": "boolean"
- },
- "include_provider_security_contact_email": {
- "format": "email",
- "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
- "type": "string"
- },
- "include_provider_security_contact_email_val": {
- "type": "boolean"
- },
- "include_security_measures_accountability": {
- "type": "boolean"
- },
- "include_security_measures_accountability_val": {
- "type": "boolean"
- },
- "include_security_measures_certification_or_assurance": {
- "type": "boolean"
- },
- "include_security_measures_certification_or_assurance_val": {
- "type": "boolean"
- },
- "include_security_measures_confidentiality_integrity": {
- "type": "boolean"
- },
- "include_security_measures_confidentiality_integrity_val": {
- "type": "boolean"
- },
- "include_security_measures_data_at_rest": {
- "type": "boolean"
- },
- "include_security_measures_data_at_rest_val": {
- "type": "boolean"
- },
- "include_security_measures_data_minimization": {
- "type": "boolean"
- },
- "include_security_measures_data_minimization_val": {
- "type": "boolean"
- },
- "include_security_measures_data_quality": {
- "type": "boolean"
- },
- "include_security_measures_data_quality_val": {
- "type": "boolean"
- },
- "include_security_measures_data_retention": {
- "type": "boolean"
- },
- "include_security_measures_data_retention_val": {
- "type": "boolean"
- },
- "include_security_measures_data_transmission": {
- "type": "boolean"
- },
- "include_security_measures_data_transmission_val": {
- "type": "boolean"
- },
- "include_security_measures_event_logging": {
- "type": "boolean"
- },
- "include_security_measures_event_logging_val": {
- "type": "boolean"
- },
- "include_security_measures_identity_auth": {
- "type": "boolean"
- },
- "include_security_measures_identity_auth_val": {
- "type": "boolean"
- },
- "include_security_measures_it_security_governance": {
- "type": "boolean"
- },
- "include_security_measures_it_security_governance_val": {
- "type": "boolean"
- },
- "include_security_measures_physical_security": {
- "type": "boolean"
- },
- "include_security_measures_physical_security_val": {
- "type": "boolean"
- },
- "include_security_measures_portability_and_erasure": {
- "type": "boolean"
- },
- "include_security_measures_portability_and_erasure_val": {
- "type": "boolean"
- },
- "include_security_measures_pseudonym_encryption": {
- "type": "boolean"
- },
- "include_security_measures_pseudonym_encryption_val": {
- "type": "boolean"
- },
- "include_security_measures_restore_data_access": {
- "type": "boolean"
- },
- "include_security_measures_restore_data_access_val": {
- "type": "boolean"
- },
- "include_security_measures_security_policy": {
- "type": "boolean"
- },
- "include_security_measures_system_configuration": {
- "type": "boolean"
- },
- "include_security_measures_system_configuration_val": {
- "type": "boolean"
- },
- "include_security_measures_testing_assessment": {
- "type": "boolean"
- },
- "include_security_measures_testing_assessment_val": {
- "type": "boolean"
- },
- "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": "boolean"
- },
- "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": "boolean"
- },
- "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": {
- "type": "string"
- },
- "subprocessors_attributes": {
- "additionalProperties": {
- "additionalProperties": false,
- "properties": {
- "country": {
- "type": "string"
- },
- "name": {
- "type": "string"
- },
- "processing_task": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "description": "Subprocessors. Use string keys such as \"0\", \"1\".",
- "propertyNames": {
- "type": "string"
- },
- "type": "object"
- },
- "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"
- },
- "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"
- },
- "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": "string"
- },
- "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": "string"
- },
- "confidentiality_nda_type": {
- "type": "string"
- },
- "confidentiality_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"
- },
- "include_custom_details": {
- "type": "boolean"
- },
- "include_custom_details_val": {
- "type": "boolean"
- },
- "include_fees": {
- "type": "boolean"
- },
- "include_fees_amount": {
- "type": "boolean"
- },
- "include_fees_amount_duration": {
- "type": "boolean"
- },
- "include_fees_include_amount": {
- "type": "boolean"
- },
- "include_fees_include_other": {
- "type": "boolean"
- },
- "include_fees_other": {
- "type": "boolean"
- },
- "include_functionality": {
- "type": "boolean"
- },
- "include_functionality_val": {
- "type": "boolean"
- },
- "include_launch_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_launch_date_custom": {
- "type": "boolean"
- },
- "include_launch_date_date": {
- "type": "boolean"
- },
- "include_launch_date_type": {
- "type": "boolean"
- },
- "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"
- },
- "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": {
- "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": {
- "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_include_company": {
- "type": "boolean"
- },
- "include_additional_warranties_include_company_val": {
- "type": "boolean"
- },
- "include_additional_warranties_include_partner": {
- "type": "boolean"
- },
- "include_additional_warranties_include_partner_val": {
- "type": "boolean"
- },
- "include_brand_guidelines": {
- "type": "boolean"
- },
- "include_brand_guidelines_include_company": {
- "type": "boolean"
- },
- "include_brand_guidelines_include_company_val": {
- "type": "boolean"
- },
- "include_brand_guidelines_include_partner": {
- "type": "boolean"
- },
- "include_brand_guidelines_include_partner_val": {
- "type": "boolean"
- },
- "include_covered_claims": {
- "type": "boolean"
- },
- "include_covered_claims_company_claims": {
- "type": "boolean"
- },
- "include_covered_claims_include_company_claims": {
- "type": "boolean"
- },
- "include_covered_claims_include_partner_claims": {
- "type": "boolean"
- },
- "include_covered_claims_partner_claims": {
- "type": "boolean"
- },
- "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": "boolean"
- },
- "include_dpa_type": {
- "type": "boolean"
- },
- "include_increased_cap_amount": {
- "type": "boolean"
- },
- "include_increased_cap_amount_currency": {
- "type": "boolean"
- },
- "include_increased_cap_amount_either_currency": {
- "type": "boolean"
- },
- "include_increased_cap_amount_either_multiple": {
- "type": "boolean"
- },
- "include_increased_cap_amount_multiple": {
- "type": "boolean"
- },
- "include_increased_cap_amount_type": {
- "type": "boolean"
- },
- "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": "boolean"
- },
- "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": "boolean"
- },
- "negotiations_allowed": {
- "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": {
- "type": "string"
- },
- "end_date_date": {
- "type": "string"
- },
- "end_date_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"
- },
- "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": "boolean"
- },
- "include_obligations_company_promotion_include_materials": {
- "type": "boolean"
- },
- "include_obligations_company_promotion_include_materials_val": {
- "type": "boolean"
- },
- "include_obligations_company_referral": {
- "type": "boolean"
- },
- "include_obligations_company_referral_include_criteria": {
- "type": "boolean"
- },
- "include_obligations_company_referral_include_criteria_val": {
- "type": "boolean"
- },
- "include_obligations_company_referral_include_pay_sch": {
- "type": "boolean"
- },
- "include_obligations_company_referral_include_pay_sch_amount": {
- "type": "boolean"
- },
- "include_obligations_company_referral_include_pay_sch_custom": {
- "type": "boolean"
- },
- "include_obligations_company_referral_include_pay_sch_unit": {
- "type": "boolean"
- },
- "include_obligations_company_sponsorship": {
- "type": "boolean"
- },
- "include_obligations_company_sponsorship_include_benefits": {
- "type": "boolean"
- },
- "include_obligations_company_sponsorship_include_benefits_val": {
- "type": "boolean"
- },
- "include_obligations_company_sponsorship_include_payments": {
- "type": "boolean"
- },
- "include_obligations_company_sponsorship_include_payments_amount": {
- "type": "boolean"
- },
- "include_obligations_company_sponsorship_include_payments_unit": {
- "type": "boolean"
- },
- "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": "boolean"
- },
- "include_obligations_partner_promotion_include_materials": {
- "type": "boolean"
- },
- "include_obligations_partner_promotion_include_materials_val": {
- "type": "boolean"
- },
- "include_obligations_partner_referral": {
- "type": "boolean"
- },
- "include_obligations_partner_referral_include_criteria": {
- "type": "boolean"
- },
- "include_obligations_partner_referral_include_criteria_val": {
- "type": "boolean"
- },
- "include_obligations_partner_referral_include_pay_sch": {
- "type": "boolean"
- },
- "include_obligations_partner_referral_include_pay_sch_amount": {
- "type": "boolean"
- },
- "include_obligations_partner_referral_include_pay_sch_custom": {
- "type": "boolean"
- },
- "include_obligations_partner_referral_include_pay_sch_unit": {
- "type": "boolean"
- },
- "include_obligations_partner_sponsorship": {
- "type": "boolean"
- },
- "include_obligations_partner_sponsorship_include_benefits": {
- "type": "boolean"
- },
- "include_obligations_partner_sponsorship_include_benefits_val": {
- "type": "boolean"
- },
- "include_obligations_partner_sponsorship_include_payments": {
- "type": "boolean"
- },
- "include_obligations_partner_sponsorship_include_payments_amount": {
- "type": "boolean"
- },
- "include_obligations_partner_sponsorship_include_payments_unit": {
- "type": "boolean"
- },
- "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": "boolean"
- },
- "include_payment_process_company_include_address_country": {
- "type": "boolean"
- },
- "include_payment_process_company_include_address_state": {
- "type": "boolean"
- },
- "include_payment_process_company_include_address_street_address": {
- "type": "boolean"
- },
- "include_payment_process_company_include_address_zipcode": {
- "type": "boolean"
- },
- "include_payment_process_company_include_email": {
- "format": "email",
- "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
- "type": "string"
- },
- "include_payment_process_company_include_email_val": {
- "type": "boolean"
- },
- "include_payment_process_partner": {
- "type": "boolean"
- },
- "include_payment_process_partner_include_address": {
- "type": "boolean"
- },
- "include_payment_process_partner_include_address_city": {
- "type": "boolean"
- },
- "include_payment_process_partner_include_address_country": {
- "type": "boolean"
- },
- "include_payment_process_partner_include_address_state": {
- "type": "boolean"
- },
- "include_payment_process_partner_include_address_street_address": {
- "type": "boolean"
- },
- "include_payment_process_partner_include_address_zipcode": {
- "type": "boolean"
- },
- "include_payment_process_partner_include_email": {
- "format": "email",
- "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
- "type": "string"
- },
- "include_payment_process_partner_include_email_val": {
- "type": "boolean"
- },
- "include_payment_schedule": {
- "type": "boolean"
- },
- "include_payment_schedule_custom": {
- "type": "boolean"
- },
- "include_payment_schedule_specified_amount": {
- "type": "boolean"
- },
- "include_payment_schedule_specified_timeframe": {
- "type": "boolean"
- },
- "include_payment_schedule_specified_unit": {
- "type": "boolean"
- },
- "include_payment_schedule_type": {
- "type": "boolean"
- },
- "negotiations_allowed": {
- "type": "string"
- },
- "territory_type": {
- "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": {
- "type": "string"
- },
- "general_cap_amount": {
- "type": "number"
- },
- "general_cap_amount_type": {
- "type": "number"
- },
- "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": "boolean"
- },
- "include_dpa_type": {
- "type": "boolean"
- },
- "include_payment_process": {
- "type": "boolean"
- },
- "include_technical_support": {
- "type": "boolean"
- },
- "negotiations_allowed": {
- "type": "string"
- },
- "payment_process_automatic_frequency": {
- "type": "string"
- },
- "payment_process_invoice_days": {
- "type": "number"
- },
- "payment_process_invoice_from": {
- "type": "string"
- },
- "payment_process_invoice_timeframe": {
- "type": "string"
- },
- "payment_process_type": {
- "type": "string"
- },
- "pilot_period_description": {
- "type": "number"
- },
- "pilot_period_fees_description": {
- "type": "number"
- },
- "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"
- },
- "default_signer_email": {
- "format": "email",
- "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
- "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": {
- "type": "string"
- },
- "general_cap_amount": {
- "type": "number"
- },
- "general_cap_amount_type": {
- "type": "number"
- },
- "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": "boolean"
- },
- "include_additional_warranties_by_provider": {
- "type": "boolean"
- },
- "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": "boolean"
- },
- "include_covered_claims_include_customer_claims": {
- "type": "boolean"
- },
- "include_covered_claims_include_provider_claims": {
- "type": "boolean"
- },
- "include_covered_claims_provider_claims": {
- "type": "boolean"
- },
- "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": "boolean"
- },
- "include_customer_insurance_min_auto_liability_minimum": {
- "type": "boolean"
- },
- "include_customer_insurance_min_cyber_liability_aggregate": {
- "type": "boolean"
- },
- "include_customer_insurance_min_cyber_liability_minimum": {
- "type": "boolean"
- },
- "include_customer_insurance_min_employer_liability_aggregate": {
- "type": "boolean"
- },
- "include_customer_insurance_min_employer_liability_minimum": {
- "type": "boolean"
- },
- "include_customer_insurance_min_general_liability_aggregate": {
- "type": "boolean"
- },
- "include_customer_insurance_min_general_liability_minimum": {
- "type": "boolean"
- },
- "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": "boolean"
- },
- "include_customer_policies_type": {
- "type": "boolean"
- },
- "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": "boolean"
- },
- "include_dpa_type": {
- "type": "boolean"
- },
- "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": "boolean"
- },
- "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": "boolean"
- },
- "include_provider_insurance_min_auto_liability_minimum": {
- "type": "boolean"
- },
- "include_provider_insurance_min_cyber_liability_aggregate": {
- "type": "boolean"
- },
- "include_provider_insurance_min_cyber_liability_minimum": {
- "type": "boolean"
- },
- "include_provider_insurance_min_employer_liability_aggregate": {
- "type": "boolean"
- },
- "include_provider_insurance_min_employer_liability_minimum": {
- "type": "boolean"
- },
- "include_provider_insurance_min_general_liability_aggregate": {
- "type": "boolean"
- },
- "include_provider_insurance_min_general_liability_minimum": {
- "type": "boolean"
- },
- "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": {
- "type": "boolean"
- },
- "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": "boolean"
- },
- "include_security_policy_iso27001": {
- "type": "boolean"
- },
- "include_security_policy_location": {
- "type": "boolean"
- },
- "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": {
- "type": "boolean"
- },
- "include_terms": {
- "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_negligence": {
- "type": "boolean"
- },
- "include_unlimited_claims_other": {
- "type": "boolean"
- },
- "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": {
- "type": "number"
- },
- "negotiations_allowed": {
- "type": "string"
- },
- "sender_last_to_sign": {
- "type": "boolean"
- }
- },
- "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,
- "properties": {
- "cost": {
- "type": "number"
- },
- "description": {
- "type": "string"
- },
- "fee_type": {
- "type": "string"
- },
- "stripe_product_id": {
- "type": "string"
- },
- "type": {
- "description": "Fee class discriminator.",
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "cost": {
- "type": "number"
- },
- "description": {
- "type": "string"
- },
- "discount_duration_amount": {
- "type": "number"
- },
- "discount_duration_type": {
- "type": "string"
- },
- "discount_type": {
- "type": "string"
- },
- "fee_type": {
- "type": "string"
- },
- "stripe_product_id": {
- "type": "string"
- },
- "type": {
- "description": "Fee class discriminator.",
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "cost": {
- "type": "number"
- },
- "description": {
- "type": "string"
- },
- "fee_type": {
- "type": "string"
- },
- "quantity": {
- "type": "number"
- },
- "stripe_product_id": {
- "type": "string"
- },
- "type": {
- "description": "Fee class discriminator.",
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "attachment_id": {
- "type": "string"
- },
- "description": {
- "type": "string"
- },
- "fee_type": {
- "type": "string"
- },
- "stripe_product_id": {
- "type": "string"
- },
- "type": {
- "description": "Fee class discriminator.",
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "description": {
- "type": "string"
- },
- "fee_type": {
- "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": {
- "type": "string"
- },
- "type": {
- "description": "Fee class discriminator.",
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "description": {
- "type": "string"
- },
- "fee_type": {
- "type": "string"
- },
- "stripe_product_id": {
- "type": "string"
- },
- "type": {
- "description": "Fee class discriminator.",
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "cost": {
- "type": "number"
- },
- "description": {
- "type": "string"
- },
- "fee_type": {
- "type": "string"
- },
- "stripe_product_id": {
- "type": "string"
- },
- "type": {
- "description": "Fee class discriminator.",
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "cost": {
- "type": "number"
- },
- "description": {
- "type": "string"
- },
- "fee_type": {
- "type": "string"
- },
- "stripe_product_id": {
- "type": "string"
- },
- "type": {
- "description": "Fee class discriminator.",
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "description": {
- "type": "string"
- },
- "fee_type": {
- "type": "string"
- },
- "stripe_product_id": {
- "type": "string"
- },
- "type": {
- "description": "Fee class discriminator.",
- "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": "boolean"
- },
- "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": "boolean"
- },
- "include_deliverables_include_acceptance": {
- "type": "boolean"
- },
- "include_deliverables_include_attachment": {
- "type": "boolean"
- },
- "include_deliverables_include_draft_deliverables": {
- "type": "boolean"
- },
- "include_deliverables_rejection_amount": {
- "type": "boolean"
- },
- "include_deliverables_rejection_unit": {
- "type": "boolean"
- },
- "include_deliverables_resubmission_amount": {
- "type": "boolean"
- },
- "include_deliverables_resubmission_unit": {
- "type": "boolean"
- },
- "include_fees_other": {
- "type": "boolean"
- },
- "include_fees_other_val": {
- "type": "boolean"
- },
- "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": {
- "type": "boolean"
- },
- "include_fees_travel_val": {
- "type": "boolean"
- },
- "include_third_party_customer": {
- "type": "boolean"
- },
- "include_third_party_include_description": {
- "type": "boolean"
- },
- "include_third_party_include_description_val": {
- "type": "boolean"
- },
- "include_third_party_materials": {
- "type": "boolean"
- },
- "include_third_party_provider": {
- "type": "boolean"
- },
- "include_time_of_assignment": {
- "type": "boolean"
- },
- "include_time_of_assignment_type": {
- "type": "boolean"
- },
- "invoice_period_description": {
- "type": "number"
- },
- "negotiations_allowed": {
- "type": "string"
- },
- "payment_period": {
- "type": "number"
- },
- "payment_period_other": {
- "type": "number"
- },
- "payment_period_timeframe": {
- "type": "number"
- },
- "payment_period_type": {
- "type": "number"
- },
- "payment_period_unit": {
- "type": "number"
- },
- "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": {
- "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": {
- "type": "string"
- },
- "sow_term_unit": {
- "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-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-z]{2,}$",
- "type": "string"
- },
- "recipient_organization": {
- "type": "string"
- },
- "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-z]{2,}$",
- "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": {
- "type": "string"
- },
- "general_cap_amount": {
- "type": "number"
- },
- "general_cap_amount_type": {
- "type": "number"
- },
- "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": "boolean"
- },
- "include_additional_warranties_by_provider": {
- "type": "boolean"
- },
- "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": "boolean"
- },
- "include_covered_claims_include_customer_claims": {
- "type": "boolean"
- },
- "include_covered_claims_include_provider_claims": {
- "type": "boolean"
- },
- "include_covered_claims_provider_claims": {
- "type": "boolean"
- },
- "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": "boolean"
- },
- "include_dpa_type": {
- "type": "boolean"
- },
- "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": "boolean"
- },
- "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": "boolean"
- },
- "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": {
- "type": "number"
- }
- },
- "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": "string"
- },
- "deletion_procedure_include_custom_description": {
- "type": "string"
- },
- "deletion_procedure_include_customer_disable": {
- "type": "string"
- },
- "deletion_procedure_include_customer_proof": {
- "type": "string"
- },
- "deletion_procedure_include_provider_disable": {
- "type": "string"
- },
- "fee_custom_unit": {
- "type": "string"
- },
- "fee_period": {
- "type": "number"
- },
- "fees_attributes": {
- "additionalProperties": {
- "anyOf": [
- {
- "additionalProperties": false,
- "properties": {
- "cost": {
- "type": "number"
- },
- "description": {
- "type": "string"
- },
- "fee_type": {
- "type": "string"
- },
- "stripe_product_id": {
- "type": "string"
- },
- "type": {
- "description": "Fee class discriminator.",
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "cost": {
- "type": "number"
- },
- "description": {
- "type": "string"
- },
- "discount_duration_amount": {
- "type": "number"
- },
- "discount_duration_type": {
- "type": "string"
- },
- "discount_type": {
- "type": "string"
- },
- "fee_type": {
- "type": "string"
- },
- "stripe_product_id": {
- "type": "string"
- },
- "type": {
- "description": "Fee class discriminator.",
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "cost": {
- "type": "number"
- },
- "description": {
- "type": "string"
- },
- "fee_type": {
- "type": "string"
- },
- "quantity": {
- "type": "number"
- },
- "stripe_product_id": {
- "type": "string"
- },
- "type": {
- "description": "Fee class discriminator.",
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "attachment_id": {
- "type": "string"
- },
- "description": {
- "type": "string"
- },
- "fee_type": {
- "type": "string"
- },
- "stripe_product_id": {
- "type": "string"
- },
- "type": {
- "description": "Fee class discriminator.",
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "description": {
- "type": "string"
- },
- "fee_type": {
- "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": {
- "type": "string"
- },
- "type": {
- "description": "Fee class discriminator.",
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "description": {
- "type": "string"
- },
- "fee_type": {
- "type": "string"
- },
- "stripe_product_id": {
- "type": "string"
- },
- "type": {
- "description": "Fee class discriminator.",
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "cost": {
- "type": "number"
- },
- "description": {
- "type": "string"
- },
- "fee_type": {
- "type": "string"
- },
- "stripe_product_id": {
- "type": "string"
- },
- "type": {
- "description": "Fee class discriminator.",
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "cost": {
- "type": "number"
- },
- "description": {
- "type": "string"
- },
- "fee_type": {
- "type": "string"
- },
- "stripe_product_id": {
- "type": "string"
- },
- "type": {
- "description": "Fee class discriminator.",
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "description": {
- "type": "string"
- },
- "fee_type": {
- "type": "string"
- },
- "stripe_product_id": {
- "type": "string"
- },
- "type": {
- "description": "Fee class discriminator.",
- "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": {
- "type": "string"
- },
- "fees_include_fee_increase_upon_renewal": {
- "type": "number"
- },
- "fees_include_fee_increase_upon_renewal_fee": {
- "type": "number"
- },
- "fees_include_fee_increase_upon_renewal_type": {
- "type": "number"
- },
- "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": "boolean"
- },
- "include_license_limits": {
- "type": "boolean"
- },
- "include_license_limits_description": {
- "type": "boolean"
- },
- "include_payment_process_include_billing_email": {
- "format": "email",
- "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
- "type": "string"
- },
- "include_pilot_period": {
- "type": "boolean"
- },
- "include_pilot_period_duration_amount": {
- "type": "boolean"
- },
- "include_pilot_period_duration_type": {
- "type": "boolean"
- },
- "include_pilot_period_include_fees": {
- "type": "boolean"
- },
- "include_pilot_period_include_fees_amount": {
- "type": "boolean"
- },
- "include_pilot_period_include_modifications": {
- "type": "boolean"
- },
- "include_pilot_period_include_modifications_description": {
- "type": "boolean"
- },
- "include_services": {
- "type": "boolean"
- },
- "include_services_description": {
- "type": "boolean"
- },
- "negotiations_allowed": {
- "type": "string"
- },
- "order_date_date": {
- "type": "string"
- },
- "order_date_type": {
- "type": "string"
- },
- "payment_process_automatic_frequency": {
- "type": "string"
- },
- "payment_process_type": {
- "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": {
- "type": "string"
- },
- "payment_process_type_invoice_duration_start": {
- "type": "string"
- },
- "payment_process_type_invoice_type": {
- "type": "string"
- },
- "permitted_uses_include_custom": {
- "type": "string"
- },
- "permitted_uses_include_custom_description": {
- "type": "string"
- },
- "permitted_uses_include_customers_affiliates": {
- "type": "string"
- },
- "permitted_uses_include_internal_business": {
- "type": "string"
- },
- "pilot_period_stripe_product_id": {
- "type": "number"
- },
- "software_description": {
- "type": "string"
- },
- "subscription_auto_renew": {
- "type": "string"
- },
- "subscription_period": {
- "type": "number"
- },
- "subscription_period_unit": {
- "type": "number"
- },
- "subscription_renewal_notice_days": {
- "type": "number"
- },
- "warranty_period_description_amount": {
- "type": "number"
- },
- "warranty_period_description_duration": {
- "type": "number"
- },
- "warranty_period_description_duration_start": {
- "type": "number"
- },
- "warranty_period_type": {
- "type": "number"
- }
- },
- "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-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": {
- "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": "number"
- },
- "aggregation_limitations_permitted_val": {
- "type": "number"
- },
- "breach_notification_unit": {
- "type": "string"
- },
- "breach_notification_val": {
- "type": "number"
- },
- "business_associate_relationship_type": {
- "type": "string"
- },
- "deidentification_limitations_include_purpose": {
- "type": "number"
- },
- "deidentification_limitations_include_requirements": {
- "type": "number"
- },
- "deidentification_limitations_permitted": {
- "type": "number"
- },
- "deidentification_limitations_purpose_val": {
- "type": "number"
- },
- "deidentification_limitations_requirements_val": {
- "type": "number"
- },
- "designated_record_set_provider_maintains": {
- "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_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": "number"
- },
- "offshore_limitations_permitted_val": {
- "type": "number"
- },
- "subcontract_limitations_include_notice": {
- "type": "number"
- },
- "subcontract_limitations_include_permission": {
- "type": "number"
- },
- "subcontract_limitations_notice_val": {
- "type": "number"
- },
- "subcontract_limitations_permission_val": {
- "type": "number"
- },
- "subcontract_limitations_permitted": {
- "type": "number"
- },
- "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"
- },
- "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-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"
- },
- "default_signer_email": {
- "format": "email",
- "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
- "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": {
- "type": "string"
- },
- "effective_date_type": {
- "type": "string"
- },
- "general_cap_amount": {
- "type": "number"
- },
- "general_cap_amount_type": {
- "type": "number"
- },
- "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": "boolean"
- },
- "include_acceptable_use_policy_type": {
- "type": "boolean"
- },
- "include_additional_warranties": {
- "type": "boolean"
- },
- "include_additional_warranties_by_customer": {
- "type": "boolean"
- },
- "include_additional_warranties_by_provider": {
- "type": "boolean"
- },
- "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": "boolean"
- },
- "include_covered_claims_include_customer_claims": {
- "type": "boolean"
- },
- "include_covered_claims_include_provider_claims": {
- "type": "boolean"
- },
- "include_covered_claims_provider_claims": {
- "type": "boolean"
- },
- "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": "boolean"
- },
- "include_dpa_type": {
- "type": "boolean"
- },
- "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": "boolean"
- },
- "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": "boolean"
- },
- "include_insurance_minimums_cyber_liability_aggregate": {
- "type": "boolean"
- },
- "include_insurance_minimums_cyber_liability_minimum": {
- "type": "boolean"
- },
- "include_insurance_minimums_employer_liability_aggregate": {
- "type": "boolean"
- },
- "include_insurance_minimums_employer_liability_minimum": {
- "type": "boolean"
- },
- "include_insurance_minimums_general_liability_aggregate": {
- "type": "boolean"
- },
- "include_insurance_minimums_general_liability_minimum": {
- "type": "boolean"
- },
- "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": {
- "type": "boolean"
- },
- "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": "boolean"
- },
- "include_security_policy_other": {
- "type": "boolean"
- },
- "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": {
- "type": "boolean"
- },
- "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_terms": {
- "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": "boolean"
- },
- "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": {
- "type": "number"
- },
- "negotiations_allowed": {
- "type": "string"
- },
- "provider": {
- "type": "string"
- },
- "sender_last_to_sign": {
- "type": "boolean"
- },
- "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": "number"
- },
- "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": {
- "type": "number"
- },
- "fees_attributes": {
- "additionalProperties": {
- "anyOf": [
- {
- "additionalProperties": false,
- "properties": {
- "cost": {
- "type": "number"
- },
- "description": {
- "type": "string"
- },
- "fee_type": {
- "type": "string"
- },
- "stripe_product_id": {
- "type": "string"
- },
- "type": {
- "description": "Fee class discriminator.",
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "cost": {
- "type": "number"
- },
- "description": {
- "type": "string"
- },
- "discount_duration_amount": {
- "type": "number"
- },
- "discount_duration_type": {
- "type": "string"
- },
- "discount_type": {
- "type": "string"
- },
- "fee_type": {
- "type": "string"
- },
- "stripe_product_id": {
- "type": "string"
- },
- "type": {
- "description": "Fee class discriminator.",
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "cost": {
- "type": "number"
- },
- "description": {
- "type": "string"
- },
- "fee_type": {
- "type": "string"
- },
- "quantity": {
- "type": "number"
- },
- "stripe_product_id": {
- "type": "string"
- },
- "type": {
- "description": "Fee class discriminator.",
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "attachment_id": {
- "type": "string"
- },
- "description": {
- "type": "string"
- },
- "fee_type": {
- "type": "string"
- },
- "stripe_product_id": {
- "type": "string"
- },
- "type": {
- "description": "Fee class discriminator.",
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "description": {
- "type": "string"
- },
- "fee_type": {
- "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": {
- "type": "string"
- },
- "type": {
- "description": "Fee class discriminator.",
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "description": {
- "type": "string"
- },
- "fee_type": {
- "type": "string"
- },
- "stripe_product_id": {
- "type": "string"
- },
- "type": {
- "description": "Fee class discriminator.",
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "cost": {
- "type": "number"
- },
- "description": {
- "type": "string"
- },
- "fee_type": {
- "type": "string"
- },
- "stripe_product_id": {
- "type": "string"
- },
- "type": {
- "description": "Fee class discriminator.",
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "cost": {
- "type": "number"
- },
- "description": {
- "type": "string"
- },
- "fee_type": {
- "type": "string"
- },
- "stripe_product_id": {
- "type": "string"
- },
- "type": {
- "description": "Fee class discriminator.",
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "description": {
- "type": "string"
- },
- "fee_type": {
- "type": "string"
- },
- "stripe_product_id": {
- "type": "string"
- },
- "type": {
- "description": "Fee class discriminator.",
- "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": {
- "type": "string"
- },
- "fees_include_fee_increase_upon_renewal": {
- "type": "number"
- },
- "fees_include_fee_increase_upon_renewal_fee": {
- "type": "number"
- },
- "fees_include_fee_increase_upon_renewal_type": {
- "type": "number"
- },
- "fees_inclusive_of_taxes": {
- "type": "boolean"
- },
- "framework_terms_type": {
- "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": "boolean"
- },
- "include_fees_table": {
- "type": "boolean"
- },
- "include_fees_table_period": {
- "type": "boolean"
- },
- "include_free_trial": {
- "type": "boolean"
- },
- "include_max_users": {
- "type": "boolean"
- },
- "include_pilot_period": {
- "type": "boolean"
- },
- "include_pilot_period_duration_amount": {
- "type": "boolean"
- },
- "include_pilot_period_duration_type": {
- "type": "boolean"
- },
- "include_pilot_period_include_fees": {
- "type": "boolean"
- },
- "include_pilot_period_include_fees_amount": {
- "type": "boolean"
- },
- "include_pilot_period_include_modifications": {
- "type": "boolean"
- },
- "include_pilot_period_include_modifications_description": {
- "type": "boolean"
- },
- "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": "boolean"
- },
- "include_product_support_type": {
- "type": "boolean"
- },
- "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": "boolean"
- },
- "include_professional_services_description": {
- "type": "boolean"
- },
- "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": "boolean"
- },
- "include_professional_services_include_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_include_fees_description": {
- "type": "boolean"
- },
- "include_professional_services_type": {
- "type": "boolean"
- },
- "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": "boolean"
- },
- "include_sla_include_response_time": {
- "type": "boolean"
- },
- "include_sla_include_response_time_amount": {
- "type": "boolean"
- },
- "include_sla_include_response_time_credit": {
- "type": "boolean"
- },
- "include_sla_include_response_time_duration": {
- "type": "boolean"
- },
- "include_sla_include_response_time_support_channel": {
- "type": "boolean"
- },
- "include_sla_include_target_uptime": {
- "type": "boolean"
- },
- "include_sla_maintenance_notice": {
- "type": "boolean"
- },
- "include_sla_maintenance_window": {
- "type": "boolean"
- },
- "include_sla_maintenance_window_type": {
- "type": "boolean"
- },
- "include_sla_standard_maintenance_notice_qty": {
- "type": "boolean"
- },
- "include_sla_standard_maintenance_notice_unit": {
- "type": "boolean"
- },
- "include_sla_standard_maintenance_window_end_time": {
- "type": "boolean"
- },
- "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": "boolean"
- },
- "include_sla_standard_maintenance_window_sunday": {
- "type": "boolean"
- },
- "include_sla_standard_maintenance_window_thursday": {
- "type": "boolean"
- },
- "include_sla_standard_maintenance_window_time_zone": {
- "type": "boolean"
- },
- "include_sla_standard_maintenance_window_tuesday": {
- "type": "boolean"
- },
- "include_sla_standard_maintenance_window_wednesday": {
- "type": "boolean"
- },
- "include_sla_standard_target_uptime": {
- "type": "boolean"
- },
- "include_sla_type": {
- "type": "boolean"
- },
- "include_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"
- },
- "include_subscription_start_date_date": {
- "type": "boolean"
- },
- "include_usage_review": {
- "type": "boolean"
- },
- "include_usage_review_val": {
- "type": "boolean"
- },
- "include_use_limitations": {
- "type": "boolean"
- },
- "include_use_limitations_val": {
- "type": "boolean"
- },
- "invoice_period": {
- "type": "number"
- },
- "invoice_period_custom_unit": {
- "type": "number"
- },
- "max_consumption": {
- "type": "number"
- },
- "max_users": {
- "type": "number"
- },
- "negotiations_allowed": {
- "type": "string"
- },
- "order_date_date": {
- "type": "string"
- },
- "order_date_other": {
- "type": "string"
- },
- "order_date_type": {
- "type": "string"
- },
- "payment_period": {
- "type": "number"
- },
- "payment_period_timeframe": {
- "type": "number"
- },
- "payment_period_unit": {
- "type": "number"
- },
- "payment_process_automatic_frequency": {
- "type": "string"
- },
- "payment_process_type": {
- "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": {
- "type": "string"
- },
- "payment_process_type_invoice_duration_start": {
- "type": "string"
- },
- "payment_process_type_invoice_type": {
- "type": "string"
- },
- "pilot_period_stripe_product_id": {
- "type": "number"
- },
- "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": {
- "type": "string"
- },
- "subscription_period": {
- "type": "number"
- },
- "subscription_period_unit": {
- "type": "number"
- },
- "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": {
- "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": "boolean"
- },
- "include_fees_description": {
- "type": "boolean"
- },
- "include_fees_pay_by_amount": {
- "type": "boolean"
- },
- "include_fees_type": {
- "type": "boolean"
- },
- "include_fees_unit": {
- "type": "boolean"
- },
- "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": "boolean"
- },
- "include_program_discount": {
- "type": "boolean"
- },
- "include_program_discount_amount": {
- "type": "boolean"
- },
- "include_program_discount_unit": {
- "type": "boolean"
- },
- "include_program_participation_feedback": {
- "type": "boolean"
- },
- "include_program_participation_feedback_amount": {
- "type": "boolean"
- },
- "include_program_participation_feedback_unit": {
- "type": "boolean"
- },
- "include_program_partner_other": {
- "type": "boolean"
- },
- "include_program_partner_other_val": {
- "type": "boolean"
- },
- "include_program_provider_other": {
- "type": "boolean"
- },
- "include_program_provider_other_val": {
- "type": "boolean"
- },
- "include_program_reference": {
- "type": "boolean"
- },
- "product_description": {
- "type": "string"
- },
- "term_amount": {
- "type": "number"
- },
- "term_unit": {
- "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": {
- "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": "number"
- },
- "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": {
- "type": "string"
- },
- "data_importer_address": {
- "type": "string"
- },
- "data_importer_address_city": {
- "type": "string"
- },
- "data_importer_address_country": {
- "type": "number"
- },
- "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": "boolean"
- },
- "include_covered_claim_internal_val": {
- "type": "boolean"
- },
- "include_covered_claim_type": {
- "type": "boolean"
- },
- "include_data_subjects_custom": {
- "type": "boolean"
- },
- "include_data_subjects_custom_val": {
- "type": "boolean"
- },
- "include_data_subjects_employees": {
- "type": "boolean"
- },
- "include_data_subjects_end_users": {
- "type": "boolean"
- },
- "include_external_subprocessor_location": {
- "type": "boolean"
- },
- "include_frequency_of_transfer_continuous": {
- "type": "boolean"
- },
- "include_frequency_of_transfer_custom": {
- "type": "boolean"
- },
- "include_frequency_of_transfer_custom_val": {
- "type": "boolean"
- },
- "include_governing_country_eu": {
- "type": "boolean"
- },
- "include_governing_country_eu_val": {
- "type": "boolean"
- },
- "include_governing_country_uk": {
- "type": "boolean"
- },
- "include_governing_country_uk_val": {
- "type": "boolean"
- },
- "include_governing_law": {
- "type": "boolean"
- },
- "include_governing_law_country": {
- "type": "boolean"
- },
- "include_governing_law_state": {
- "type": "boolean"
- },
- "include_increased_claim_amount": {
- "type": "boolean"
- },
- "include_increased_claim_amount_currency": {
- "type": "boolean"
- },
- "include_increased_claim_amount_qty": {
- "type": "boolean"
- },
- "include_increased_claim_amount_type": {
- "type": "boolean"
- },
- "include_liability_cap": {
- "type": "boolean"
- },
- "include_liability_cap_amount_constant_external": {
- "type": "boolean"
- },
- "include_liability_cap_amount_constant_internal": {
- "type": "boolean"
- },
- "include_liability_cap_amount_currency_external": {
- "type": "boolean"
- },
- "include_liability_cap_amount_currency_internal": {
- "type": "boolean"
- },
- "include_liability_cap_csa_type": {
- "type": "boolean"
- },
- "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": "boolean"
- },
- "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": "boolean"
- },
- "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": "boolean"
- },
- "include_provider_security_contact_address_country": {
- "type": "boolean"
- },
- "include_provider_security_contact_address_state": {
- "type": "boolean"
- },
- "include_provider_security_contact_address_street_address": {
- "type": "boolean"
- },
- "include_provider_security_contact_address_zipcode": {
- "type": "boolean"
- },
- "include_provider_security_contact_email": {
- "format": "email",
- "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
- "type": "string"
- },
- "include_provider_security_contact_email_val": {
- "type": "boolean"
- },
- "include_security_measures_accountability": {
- "type": "boolean"
- },
- "include_security_measures_accountability_val": {
- "type": "boolean"
- },
- "include_security_measures_certification_or_assurance": {
- "type": "boolean"
- },
- "include_security_measures_certification_or_assurance_val": {
- "type": "boolean"
- },
- "include_security_measures_confidentiality_integrity": {
- "type": "boolean"
- },
- "include_security_measures_confidentiality_integrity_val": {
- "type": "boolean"
- },
- "include_security_measures_data_at_rest": {
- "type": "boolean"
- },
- "include_security_measures_data_at_rest_val": {
- "type": "boolean"
- },
- "include_security_measures_data_minimization": {
- "type": "boolean"
- },
- "include_security_measures_data_minimization_val": {
- "type": "boolean"
- },
- "include_security_measures_data_quality": {
- "type": "boolean"
- },
- "include_security_measures_data_quality_val": {
- "type": "boolean"
- },
- "include_security_measures_data_retention": {
- "type": "boolean"
- },
- "include_security_measures_data_retention_val": {
- "type": "boolean"
- },
- "include_security_measures_data_transmission": {
- "type": "boolean"
- },
- "include_security_measures_data_transmission_val": {
- "type": "boolean"
- },
- "include_security_measures_event_logging": {
- "type": "boolean"
- },
- "include_security_measures_event_logging_val": {
- "type": "boolean"
- },
- "include_security_measures_identity_auth": {
- "type": "boolean"
- },
- "include_security_measures_identity_auth_val": {
- "type": "boolean"
- },
- "include_security_measures_it_security_governance": {
- "type": "boolean"
- },
- "include_security_measures_it_security_governance_val": {
- "type": "boolean"
- },
- "include_security_measures_physical_security": {
- "type": "boolean"
- },
- "include_security_measures_physical_security_val": {
- "type": "boolean"
- },
- "include_security_measures_portability_and_erasure": {
- "type": "boolean"
- },
- "include_security_measures_portability_and_erasure_val": {
- "type": "boolean"
- },
- "include_security_measures_pseudonym_encryption": {
- "type": "boolean"
- },
- "include_security_measures_pseudonym_encryption_val": {
- "type": "boolean"
- },
- "include_security_measures_restore_data_access": {
- "type": "boolean"
- },
- "include_security_measures_restore_data_access_val": {
- "type": "boolean"
- },
- "include_security_measures_security_policy": {
- "type": "boolean"
- },
- "include_security_measures_system_configuration": {
- "type": "boolean"
- },
- "include_security_measures_system_configuration_val": {
- "type": "boolean"
- },
- "include_security_measures_testing_assessment": {
- "type": "boolean"
- },
- "include_security_measures_testing_assessment_val": {
- "type": "boolean"
- },
- "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": "boolean"
- },
- "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": "boolean"
- },
- "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": {
- "type": "string"
- },
- "subprocessors_attributes": {
- "additionalProperties": {
- "additionalProperties": false,
- "properties": {
- "country": {
- "type": "string"
- },
- "name": {
- "type": "string"
- },
- "processing_task": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "description": "Subprocessors. Use string keys such as \"0\", \"1\".",
- "propertyNames": {
- "type": "string"
- },
- "type": "object"
- },
- "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"
- },
- "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"
- },
- "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": "string"
- },
- "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": "string"
- },
- "confidentiality_nda_type": {
- "type": "string"
- },
- "confidentiality_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"
- },
- "include_custom_details": {
- "type": "boolean"
- },
- "include_custom_details_val": {
- "type": "boolean"
- },
- "include_fees": {
- "type": "boolean"
- },
- "include_fees_amount": {
- "type": "boolean"
- },
- "include_fees_amount_duration": {
- "type": "boolean"
- },
- "include_fees_include_amount": {
- "type": "boolean"
- },
- "include_fees_include_other": {
- "type": "boolean"
- },
- "include_fees_other": {
- "type": "boolean"
- },
- "include_functionality": {
- "type": "boolean"
- },
- "include_functionality_val": {
- "type": "boolean"
- },
- "include_launch_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_launch_date_custom": {
- "type": "boolean"
- },
- "include_launch_date_date": {
- "type": "boolean"
- },
- "include_launch_date_type": {
- "type": "boolean"
- },
- "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"
- },
- "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": {
- "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": {
- "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_include_company": {
- "type": "boolean"
- },
- "include_additional_warranties_include_company_val": {
- "type": "boolean"
- },
- "include_additional_warranties_include_partner": {
- "type": "boolean"
- },
- "include_additional_warranties_include_partner_val": {
- "type": "boolean"
- },
- "include_brand_guidelines": {
- "type": "boolean"
- },
- "include_brand_guidelines_include_company": {
- "type": "boolean"
- },
- "include_brand_guidelines_include_company_val": {
- "type": "boolean"
- },
- "include_brand_guidelines_include_partner": {
- "type": "boolean"
- },
- "include_brand_guidelines_include_partner_val": {
- "type": "boolean"
- },
- "include_covered_claims": {
- "type": "boolean"
- },
- "include_covered_claims_company_claims": {
- "type": "boolean"
- },
- "include_covered_claims_include_company_claims": {
- "type": "boolean"
- },
- "include_covered_claims_include_partner_claims": {
- "type": "boolean"
- },
- "include_covered_claims_partner_claims": {
- "type": "boolean"
- },
- "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": "boolean"
- },
- "include_dpa_type": {
- "type": "boolean"
- },
- "include_increased_cap_amount": {
- "type": "boolean"
- },
- "include_increased_cap_amount_currency": {
- "type": "boolean"
- },
- "include_increased_cap_amount_either_currency": {
- "type": "boolean"
- },
- "include_increased_cap_amount_either_multiple": {
- "type": "boolean"
- },
- "include_increased_cap_amount_multiple": {
- "type": "boolean"
- },
- "include_increased_cap_amount_type": {
- "type": "boolean"
- },
- "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": "boolean"
- },
- "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": "boolean"
- },
- "negotiations_allowed": {
- "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": {
- "type": "string"
- },
- "end_date_date": {
- "type": "string"
- },
- "end_date_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"
- },
- "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": "boolean"
- },
- "include_obligations_company_promotion_include_materials": {
- "type": "boolean"
- },
- "include_obligations_company_promotion_include_materials_val": {
- "type": "boolean"
- },
- "include_obligations_company_referral": {
- "type": "boolean"
- },
- "include_obligations_company_referral_include_criteria": {
- "type": "boolean"
- },
- "include_obligations_company_referral_include_criteria_val": {
- "type": "boolean"
- },
- "include_obligations_company_referral_include_pay_sch": {
- "type": "boolean"
- },
- "include_obligations_company_referral_include_pay_sch_amount": {
- "type": "boolean"
- },
- "include_obligations_company_referral_include_pay_sch_custom": {
- "type": "boolean"
- },
- "include_obligations_company_referral_include_pay_sch_unit": {
- "type": "boolean"
- },
- "include_obligations_company_sponsorship": {
- "type": "boolean"
- },
- "include_obligations_company_sponsorship_include_benefits": {
- "type": "boolean"
- },
- "include_obligations_company_sponsorship_include_benefits_val": {
- "type": "boolean"
- },
- "include_obligations_company_sponsorship_include_payments": {
- "type": "boolean"
- },
- "include_obligations_company_sponsorship_include_payments_amount": {
- "type": "boolean"
- },
- "include_obligations_company_sponsorship_include_payments_unit": {
- "type": "boolean"
- },
- "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": "boolean"
- },
- "include_obligations_partner_promotion_include_materials": {
- "type": "boolean"
- },
- "include_obligations_partner_promotion_include_materials_val": {
- "type": "boolean"
- },
- "include_obligations_partner_referral": {
- "type": "boolean"
- },
- "include_obligations_partner_referral_include_criteria": {
- "type": "boolean"
- },
- "include_obligations_partner_referral_include_criteria_val": {
- "type": "boolean"
- },
- "include_obligations_partner_referral_include_pay_sch": {
- "type": "boolean"
- },
- "include_obligations_partner_referral_include_pay_sch_amount": {
- "type": "boolean"
- },
- "include_obligations_partner_referral_include_pay_sch_custom": {
- "type": "boolean"
- },
- "include_obligations_partner_referral_include_pay_sch_unit": {
- "type": "boolean"
- },
- "include_obligations_partner_sponsorship": {
- "type": "boolean"
- },
- "include_obligations_partner_sponsorship_include_benefits": {
- "type": "boolean"
- },
- "include_obligations_partner_sponsorship_include_benefits_val": {
- "type": "boolean"
- },
- "include_obligations_partner_sponsorship_include_payments": {
- "type": "boolean"
- },
- "include_obligations_partner_sponsorship_include_payments_amount": {
- "type": "boolean"
- },
- "include_obligations_partner_sponsorship_include_payments_unit": {
- "type": "boolean"
- },
- "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": "boolean"
- },
- "include_payment_process_company_include_address_country": {
- "type": "boolean"
- },
- "include_payment_process_company_include_address_state": {
- "type": "boolean"
- },
- "include_payment_process_company_include_address_street_address": {
- "type": "boolean"
- },
- "include_payment_process_company_include_address_zipcode": {
- "type": "boolean"
- },
- "include_payment_process_company_include_email": {
- "format": "email",
- "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
- "type": "string"
- },
- "include_payment_process_company_include_email_val": {
- "type": "boolean"
- },
- "include_payment_process_partner": {
- "type": "boolean"
- },
- "include_payment_process_partner_include_address": {
- "type": "boolean"
- },
- "include_payment_process_partner_include_address_city": {
- "type": "boolean"
- },
- "include_payment_process_partner_include_address_country": {
- "type": "boolean"
- },
- "include_payment_process_partner_include_address_state": {
- "type": "boolean"
- },
- "include_payment_process_partner_include_address_street_address": {
- "type": "boolean"
- },
- "include_payment_process_partner_include_address_zipcode": {
- "type": "boolean"
- },
- "include_payment_process_partner_include_email": {
- "format": "email",
- "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
- "type": "string"
- },
- "include_payment_process_partner_include_email_val": {
- "type": "boolean"
- },
- "include_payment_schedule": {
- "type": "boolean"
- },
- "include_payment_schedule_custom": {
- "type": "boolean"
- },
- "include_payment_schedule_specified_amount": {
- "type": "boolean"
- },
- "include_payment_schedule_specified_timeframe": {
- "type": "boolean"
- },
- "include_payment_schedule_specified_unit": {
- "type": "boolean"
- },
- "include_payment_schedule_type": {
- "type": "boolean"
- },
- "negotiations_allowed": {
- "type": "string"
- },
- "territory_type": {
- "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": {
- "type": "string"
- },
- "general_cap_amount": {
- "type": "number"
- },
- "general_cap_amount_type": {
- "type": "number"
- },
- "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": "boolean"
- },
- "include_dpa_type": {
- "type": "boolean"
- },
- "include_payment_process": {
- "type": "boolean"
- },
- "include_technical_support": {
- "type": "boolean"
- },
- "negotiations_allowed": {
- "type": "string"
- },
- "payment_process_automatic_frequency": {
- "type": "string"
- },
- "payment_process_invoice_days": {
- "type": "number"
- },
- "payment_process_invoice_from": {
- "type": "string"
- },
- "payment_process_invoice_timeframe": {
- "type": "string"
- },
- "payment_process_type": {
- "type": "string"
- },
- "pilot_period_description": {
- "type": "number"
- },
- "pilot_period_fees_description": {
- "type": "number"
- },
- "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"
- },
- "default_signer_email": {
- "format": "email",
- "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
- "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": {
- "type": "string"
- },
- "general_cap_amount": {
- "type": "number"
- },
- "general_cap_amount_type": {
- "type": "number"
- },
- "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": "boolean"
- },
- "include_additional_warranties_by_provider": {
- "type": "boolean"
- },
- "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": "boolean"
- },
- "include_covered_claims_include_customer_claims": {
- "type": "boolean"
- },
- "include_covered_claims_include_provider_claims": {
- "type": "boolean"
- },
- "include_covered_claims_provider_claims": {
- "type": "boolean"
- },
- "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": "boolean"
- },
- "include_customer_insurance_min_auto_liability_minimum": {
- "type": "boolean"
- },
- "include_customer_insurance_min_cyber_liability_aggregate": {
- "type": "boolean"
- },
- "include_customer_insurance_min_cyber_liability_minimum": {
- "type": "boolean"
- },
- "include_customer_insurance_min_employer_liability_aggregate": {
- "type": "boolean"
- },
- "include_customer_insurance_min_employer_liability_minimum": {
- "type": "boolean"
- },
- "include_customer_insurance_min_general_liability_aggregate": {
- "type": "boolean"
- },
- "include_customer_insurance_min_general_liability_minimum": {
- "type": "boolean"
- },
- "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": "boolean"
- },
- "include_customer_policies_type": {
- "type": "boolean"
- },
- "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": "boolean"
- },
- "include_dpa_type": {
- "type": "boolean"
- },
- "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": "boolean"
- },
- "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": "boolean"
- },
- "include_provider_insurance_min_auto_liability_minimum": {
- "type": "boolean"
- },
- "include_provider_insurance_min_cyber_liability_aggregate": {
- "type": "boolean"
- },
- "include_provider_insurance_min_cyber_liability_minimum": {
- "type": "boolean"
- },
- "include_provider_insurance_min_employer_liability_aggregate": {
- "type": "boolean"
- },
- "include_provider_insurance_min_employer_liability_minimum": {
- "type": "boolean"
- },
- "include_provider_insurance_min_general_liability_aggregate": {
- "type": "boolean"
- },
- "include_provider_insurance_min_general_liability_minimum": {
- "type": "boolean"
- },
- "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": {
- "type": "boolean"
- },
- "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": "boolean"
- },
- "include_security_policy_iso27001": {
- "type": "boolean"
- },
- "include_security_policy_location": {
- "type": "boolean"
- },
- "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": {
- "type": "boolean"
- },
- "include_terms": {
- "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_negligence": {
- "type": "boolean"
- },
- "include_unlimited_claims_other": {
- "type": "boolean"
- },
- "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": {
- "type": "number"
- },
- "negotiations_allowed": {
- "type": "string"
- },
- "sender_last_to_sign": {
- "type": "boolean"
- }
- },
- "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,
- "properties": {
- "cost": {
- "type": "number"
- },
- "description": {
- "type": "string"
- },
- "fee_type": {
- "type": "string"
- },
- "stripe_product_id": {
- "type": "string"
- },
- "type": {
- "description": "Fee class discriminator.",
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "cost": {
- "type": "number"
- },
- "description": {
- "type": "string"
- },
- "discount_duration_amount": {
- "type": "number"
- },
- "discount_duration_type": {
- "type": "string"
- },
- "discount_type": {
- "type": "string"
- },
- "fee_type": {
- "type": "string"
- },
- "stripe_product_id": {
- "type": "string"
- },
- "type": {
- "description": "Fee class discriminator.",
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "cost": {
- "type": "number"
- },
- "description": {
- "type": "string"
- },
- "fee_type": {
- "type": "string"
- },
- "quantity": {
- "type": "number"
- },
- "stripe_product_id": {
- "type": "string"
- },
- "type": {
- "description": "Fee class discriminator.",
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "attachment_id": {
- "type": "string"
- },
- "description": {
- "type": "string"
- },
- "fee_type": {
- "type": "string"
- },
- "stripe_product_id": {
- "type": "string"
- },
- "type": {
- "description": "Fee class discriminator.",
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "description": {
- "type": "string"
- },
- "fee_type": {
- "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": {
- "type": "string"
- },
- "type": {
- "description": "Fee class discriminator.",
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "description": {
- "type": "string"
- },
- "fee_type": {
- "type": "string"
- },
- "stripe_product_id": {
- "type": "string"
- },
- "type": {
- "description": "Fee class discriminator.",
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "cost": {
- "type": "number"
- },
- "description": {
- "type": "string"
- },
- "fee_type": {
- "type": "string"
- },
- "stripe_product_id": {
- "type": "string"
- },
- "type": {
- "description": "Fee class discriminator.",
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "cost": {
- "type": "number"
- },
- "description": {
- "type": "string"
- },
- "fee_type": {
- "type": "string"
- },
- "stripe_product_id": {
- "type": "string"
- },
- "type": {
- "description": "Fee class discriminator.",
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "description": {
- "type": "string"
- },
- "fee_type": {
- "type": "string"
- },
- "stripe_product_id": {
- "type": "string"
- },
- "type": {
- "description": "Fee class discriminator.",
- "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": "boolean"
- },
- "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": "boolean"
- },
- "include_deliverables_include_acceptance": {
- "type": "boolean"
- },
- "include_deliverables_include_attachment": {
- "type": "boolean"
- },
- "include_deliverables_include_draft_deliverables": {
- "type": "boolean"
- },
- "include_deliverables_rejection_amount": {
- "type": "boolean"
- },
- "include_deliverables_rejection_unit": {
- "type": "boolean"
- },
- "include_deliverables_resubmission_amount": {
- "type": "boolean"
- },
- "include_deliverables_resubmission_unit": {
- "type": "boolean"
- },
- "include_fees_other": {
- "type": "boolean"
- },
- "include_fees_other_val": {
- "type": "boolean"
- },
- "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": {
- "type": "boolean"
- },
- "include_fees_travel_val": {
- "type": "boolean"
- },
- "include_third_party_customer": {
- "type": "boolean"
- },
- "include_third_party_include_description": {
- "type": "boolean"
- },
- "include_third_party_include_description_val": {
- "type": "boolean"
- },
- "include_third_party_materials": {
- "type": "boolean"
- },
- "include_third_party_provider": {
- "type": "boolean"
- },
- "include_time_of_assignment": {
- "type": "boolean"
- },
- "include_time_of_assignment_type": {
- "type": "boolean"
- },
- "invoice_period_description": {
- "type": "number"
- },
- "negotiations_allowed": {
- "type": "string"
- },
- "payment_period": {
- "type": "number"
- },
- "payment_period_other": {
- "type": "number"
- },
- "payment_period_timeframe": {
- "type": "number"
- },
- "payment_period_type": {
- "type": "number"
- },
- "payment_period_unit": {
- "type": "number"
- },
- "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": {
- "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": {
- "type": "string"
- },
- "sow_term_unit": {
- "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-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-z]{2,}$",
- "type": "string"
- },
- "recipient_organization": {
- "type": "string"
- },
- "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-z]{2,}$",
- "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": {
- "type": "string"
- },
- "general_cap_amount": {
- "type": "number"
- },
- "general_cap_amount_type": {
- "type": "number"
- },
- "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": "boolean"
- },
- "include_additional_warranties_by_provider": {
- "type": "boolean"
- },
- "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": "boolean"
- },
- "include_covered_claims_include_customer_claims": {
- "type": "boolean"
- },
- "include_covered_claims_include_provider_claims": {
- "type": "boolean"
- },
- "include_covered_claims_provider_claims": {
- "type": "boolean"
- },
- "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": "boolean"
- },
- "include_dpa_type": {
- "type": "boolean"
- },
- "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": "boolean"
- },
- "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": "boolean"
- },
- "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": {
- "type": "number"
- }
- },
- "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": "string"
- },
- "deletion_procedure_include_custom_description": {
- "type": "string"
- },
- "deletion_procedure_include_customer_disable": {
- "type": "string"
- },
- "deletion_procedure_include_customer_proof": {
- "type": "string"
- },
- "deletion_procedure_include_provider_disable": {
- "type": "string"
- },
- "fee_custom_unit": {
- "type": "string"
- },
- "fee_period": {
- "type": "number"
- },
- "fees_attributes": {
- "additionalProperties": {
- "anyOf": [
- {
- "additionalProperties": false,
- "properties": {
- "cost": {
- "type": "number"
- },
- "description": {
- "type": "string"
- },
- "fee_type": {
- "type": "string"
- },
- "stripe_product_id": {
- "type": "string"
- },
- "type": {
- "description": "Fee class discriminator.",
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "cost": {
- "type": "number"
- },
- "description": {
- "type": "string"
- },
- "discount_duration_amount": {
- "type": "number"
- },
- "discount_duration_type": {
- "type": "string"
- },
- "discount_type": {
- "type": "string"
- },
- "fee_type": {
- "type": "string"
- },
- "stripe_product_id": {
- "type": "string"
- },
- "type": {
- "description": "Fee class discriminator.",
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "cost": {
- "type": "number"
- },
- "description": {
- "type": "string"
- },
- "fee_type": {
- "type": "string"
- },
- "quantity": {
- "type": "number"
- },
- "stripe_product_id": {
- "type": "string"
- },
- "type": {
- "description": "Fee class discriminator.",
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "attachment_id": {
- "type": "string"
- },
- "description": {
- "type": "string"
- },
- "fee_type": {
- "type": "string"
- },
- "stripe_product_id": {
- "type": "string"
- },
- "type": {
- "description": "Fee class discriminator.",
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "description": {
- "type": "string"
- },
- "fee_type": {
- "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": {
- "type": "string"
- },
- "type": {
- "description": "Fee class discriminator.",
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "description": {
- "type": "string"
- },
- "fee_type": {
- "type": "string"
- },
- "stripe_product_id": {
- "type": "string"
- },
- "type": {
- "description": "Fee class discriminator.",
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "cost": {
- "type": "number"
- },
- "description": {
- "type": "string"
- },
- "fee_type": {
- "type": "string"
- },
- "stripe_product_id": {
- "type": "string"
- },
- "type": {
- "description": "Fee class discriminator.",
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "cost": {
- "type": "number"
- },
- "description": {
- "type": "string"
- },
- "fee_type": {
- "type": "string"
- },
- "stripe_product_id": {
- "type": "string"
- },
- "type": {
- "description": "Fee class discriminator.",
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "description": {
- "type": "string"
- },
- "fee_type": {
- "type": "string"
- },
- "stripe_product_id": {
- "type": "string"
- },
- "type": {
- "description": "Fee class discriminator.",
- "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": {
- "type": "string"
- },
- "fees_include_fee_increase_upon_renewal": {
- "type": "number"
- },
- "fees_include_fee_increase_upon_renewal_fee": {
- "type": "number"
- },
- "fees_include_fee_increase_upon_renewal_type": {
- "type": "number"
- },
- "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": "boolean"
- },
- "include_license_limits": {
- "type": "boolean"
- },
- "include_license_limits_description": {
- "type": "boolean"
- },
- "include_payment_process_include_billing_email": {
- "format": "email",
- "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
- "type": "string"
- },
- "include_pilot_period": {
- "type": "boolean"
- },
- "include_pilot_period_duration_amount": {
- "type": "boolean"
- },
- "include_pilot_period_duration_type": {
- "type": "boolean"
- },
- "include_pilot_period_include_fees": {
- "type": "boolean"
- },
- "include_pilot_period_include_fees_amount": {
- "type": "boolean"
- },
- "include_pilot_period_include_modifications": {
- "type": "boolean"
- },
- "include_pilot_period_include_modifications_description": {
- "type": "boolean"
- },
- "include_services": {
- "type": "boolean"
- },
- "include_services_description": {
- "type": "boolean"
- },
- "negotiations_allowed": {
- "type": "string"
- },
- "order_date_date": {
- "type": "string"
- },
- "order_date_type": {
- "type": "string"
- },
- "payment_process_automatic_frequency": {
- "type": "string"
- },
- "payment_process_type": {
- "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": {
- "type": "string"
- },
- "payment_process_type_invoice_duration_start": {
- "type": "string"
- },
- "payment_process_type_invoice_type": {
- "type": "string"
- },
- "permitted_uses_include_custom": {
- "type": "string"
- },
- "permitted_uses_include_custom_description": {
- "type": "string"
- },
- "permitted_uses_include_customers_affiliates": {
- "type": "string"
- },
- "permitted_uses_include_internal_business": {
- "type": "string"
- },
- "pilot_period_stripe_product_id": {
- "type": "number"
- },
- "software_description": {
- "type": "string"
- },
- "subscription_auto_renew": {
- "type": "string"
- },
- "subscription_period": {
- "type": "number"
- },
- "subscription_period_unit": {
- "type": "number"
- },
- "subscription_renewal_notice_days": {
- "type": "number"
- },
- "warranty_period_description_amount": {
- "type": "number"
- },
- "warranty_period_description_duration": {
- "type": "number"
- },
- "warranty_period_description_duration_start": {
- "type": "number"
- },
- "warranty_period_type": {
- "type": "number"
- }
- },
- "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-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-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": {
- "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": "number"
- },
- "aggregation_limitations_permitted_val": {
- "type": "number"
- },
- "breach_notification_unit": {
- "type": "string"
- },
- "breach_notification_val": {
- "type": "number"
- },
- "business_associate_relationship_type": {
- "type": "string"
- },
- "deidentification_limitations_include_purpose": {
- "type": "number"
- },
- "deidentification_limitations_include_requirements": {
- "type": "number"
- },
- "deidentification_limitations_permitted": {
- "type": "number"
- },
- "deidentification_limitations_purpose_val": {
- "type": "number"
- },
- "deidentification_limitations_requirements_val": {
- "type": "number"
- },
- "designated_record_set_provider_maintains": {
- "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_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": "number"
- },
- "offshore_limitations_permitted_val": {
- "type": "number"
- },
- "subcontract_limitations_include_notice": {
- "type": "number"
- },
- "subcontract_limitations_include_permission": {
- "type": "number"
- },
- "subcontract_limitations_notice_val": {
- "type": "number"
- },
- "subcontract_limitations_permission_val": {
- "type": "number"
- },
- "subcontract_limitations_permitted": {
- "type": "number"
- },
- "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"
- },
- "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-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"
- },
- "default_signer_email": {
- "format": "email",
- "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
- "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": {
- "type": "string"
- },
- "effective_date_type": {
- "type": "string"
- },
- "general_cap_amount": {
- "type": "number"
- },
- "general_cap_amount_type": {
- "type": "number"
- },
- "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": "boolean"
- },
- "include_acceptable_use_policy_type": {
- "type": "boolean"
- },
- "include_additional_warranties": {
- "type": "boolean"
- },
- "include_additional_warranties_by_customer": {
- "type": "boolean"
- },
- "include_additional_warranties_by_provider": {
- "type": "boolean"
- },
- "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": "boolean"
- },
- "include_covered_claims_include_customer_claims": {
- "type": "boolean"
- },
- "include_covered_claims_include_provider_claims": {
- "type": "boolean"
- },
- "include_covered_claims_provider_claims": {
- "type": "boolean"
- },
- "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": "boolean"
- },
- "include_dpa_type": {
- "type": "boolean"
- },
- "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": "boolean"
- },
- "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": "boolean"
- },
- "include_insurance_minimums_cyber_liability_aggregate": {
- "type": "boolean"
- },
- "include_insurance_minimums_cyber_liability_minimum": {
- "type": "boolean"
- },
- "include_insurance_minimums_employer_liability_aggregate": {
- "type": "boolean"
- },
- "include_insurance_minimums_employer_liability_minimum": {
- "type": "boolean"
- },
- "include_insurance_minimums_general_liability_aggregate": {
- "type": "boolean"
- },
- "include_insurance_minimums_general_liability_minimum": {
- "type": "boolean"
- },
- "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": {
- "type": "boolean"
- },
- "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": "boolean"
- },
- "include_security_policy_other": {
- "type": "boolean"
- },
- "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": {
- "type": "boolean"
- },
- "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_terms": {
- "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": "boolean"
- },
- "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": {
- "type": "number"
- },
- "negotiations_allowed": {
- "type": "string"
- },
- "provider": {
- "type": "string"
- },
- "sender_last_to_sign": {
- "type": "boolean"
- },
- "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": "number"
- },
- "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": {
- "type": "number"
- },
- "fees_attributes": {
- "additionalProperties": {
- "anyOf": [
- {
- "additionalProperties": false,
- "properties": {
- "cost": {
- "type": "number"
- },
- "description": {
- "type": "string"
- },
- "fee_type": {
- "type": "string"
- },
- "stripe_product_id": {
- "type": "string"
- },
- "type": {
- "description": "Fee class discriminator.",
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "cost": {
- "type": "number"
- },
- "description": {
- "type": "string"
- },
- "discount_duration_amount": {
- "type": "number"
- },
- "discount_duration_type": {
- "type": "string"
- },
- "discount_type": {
- "type": "string"
- },
- "fee_type": {
- "type": "string"
- },
- "stripe_product_id": {
- "type": "string"
- },
- "type": {
- "description": "Fee class discriminator.",
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "cost": {
- "type": "number"
- },
- "description": {
- "type": "string"
- },
- "fee_type": {
- "type": "string"
- },
- "quantity": {
- "type": "number"
- },
- "stripe_product_id": {
- "type": "string"
- },
- "type": {
- "description": "Fee class discriminator.",
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "attachment_id": {
- "type": "string"
- },
- "description": {
- "type": "string"
- },
- "fee_type": {
- "type": "string"
- },
- "stripe_product_id": {
- "type": "string"
- },
- "type": {
- "description": "Fee class discriminator.",
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "description": {
- "type": "string"
- },
- "fee_type": {
- "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": {
- "type": "string"
- },
- "type": {
- "description": "Fee class discriminator.",
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "description": {
- "type": "string"
- },
- "fee_type": {
- "type": "string"
- },
- "stripe_product_id": {
- "type": "string"
- },
- "type": {
- "description": "Fee class discriminator.",
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "cost": {
- "type": "number"
- },
- "description": {
- "type": "string"
- },
- "fee_type": {
- "type": "string"
- },
- "stripe_product_id": {
- "type": "string"
- },
- "type": {
- "description": "Fee class discriminator.",
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "cost": {
- "type": "number"
- },
- "description": {
- "type": "string"
- },
- "fee_type": {
- "type": "string"
- },
- "stripe_product_id": {
- "type": "string"
- },
- "type": {
- "description": "Fee class discriminator.",
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "description": {
- "type": "string"
- },
- "fee_type": {
- "type": "string"
- },
- "stripe_product_id": {
- "type": "string"
- },
- "type": {
- "description": "Fee class discriminator.",
- "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": {
- "type": "string"
- },
- "fees_include_fee_increase_upon_renewal": {
- "type": "number"
- },
- "fees_include_fee_increase_upon_renewal_fee": {
- "type": "number"
- },
- "fees_include_fee_increase_upon_renewal_type": {
- "type": "number"
- },
- "fees_inclusive_of_taxes": {
- "type": "boolean"
- },
- "framework_terms_type": {
- "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": "boolean"
- },
- "include_fees_table": {
- "type": "boolean"
- },
- "include_fees_table_period": {
- "type": "boolean"
- },
- "include_free_trial": {
- "type": "boolean"
- },
- "include_max_users": {
- "type": "boolean"
- },
- "include_pilot_period": {
- "type": "boolean"
- },
- "include_pilot_period_duration_amount": {
- "type": "boolean"
- },
- "include_pilot_period_duration_type": {
- "type": "boolean"
- },
- "include_pilot_period_include_fees": {
- "type": "boolean"
- },
- "include_pilot_period_include_fees_amount": {
- "type": "boolean"
- },
- "include_pilot_period_include_modifications": {
- "type": "boolean"
- },
- "include_pilot_period_include_modifications_description": {
- "type": "boolean"
- },
- "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": "boolean"
- },
- "include_product_support_type": {
- "type": "boolean"
- },
- "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": "boolean"
- },
- "include_professional_services_description": {
- "type": "boolean"
- },
- "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": "boolean"
- },
- "include_professional_services_include_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_include_fees_description": {
- "type": "boolean"
- },
- "include_professional_services_type": {
- "type": "boolean"
- },
- "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": "boolean"
- },
- "include_sla_include_response_time": {
- "type": "boolean"
- },
- "include_sla_include_response_time_amount": {
- "type": "boolean"
- },
- "include_sla_include_response_time_credit": {
- "type": "boolean"
- },
- "include_sla_include_response_time_duration": {
- "type": "boolean"
- },
- "include_sla_include_response_time_support_channel": {
- "type": "boolean"
- },
- "include_sla_include_target_uptime": {
- "type": "boolean"
- },
- "include_sla_maintenance_notice": {
- "type": "boolean"
- },
- "include_sla_maintenance_window": {
- "type": "boolean"
- },
- "include_sla_maintenance_window_type": {
- "type": "boolean"
- },
- "include_sla_standard_maintenance_notice_qty": {
- "type": "boolean"
- },
- "include_sla_standard_maintenance_notice_unit": {
- "type": "boolean"
- },
- "include_sla_standard_maintenance_window_end_time": {
- "type": "boolean"
- },
- "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": "boolean"
- },
- "include_sla_standard_maintenance_window_sunday": {
- "type": "boolean"
- },
- "include_sla_standard_maintenance_window_thursday": {
- "type": "boolean"
- },
- "include_sla_standard_maintenance_window_time_zone": {
- "type": "boolean"
- },
- "include_sla_standard_maintenance_window_tuesday": {
- "type": "boolean"
- },
- "include_sla_standard_maintenance_window_wednesday": {
- "type": "boolean"
- },
- "include_sla_standard_target_uptime": {
- "type": "boolean"
- },
- "include_sla_type": {
- "type": "boolean"
- },
- "include_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"
- },
- "include_subscription_start_date_date": {
- "type": "boolean"
- },
- "include_usage_review": {
- "type": "boolean"
- },
- "include_usage_review_val": {
- "type": "boolean"
- },
- "include_use_limitations": {
- "type": "boolean"
- },
- "include_use_limitations_val": {
- "type": "boolean"
- },
- "invoice_period": {
- "type": "number"
- },
- "invoice_period_custom_unit": {
- "type": "number"
- },
- "max_consumption": {
- "type": "number"
- },
- "max_users": {
- "type": "number"
- },
- "negotiations_allowed": {
- "type": "string"
- },
- "order_date_date": {
- "type": "string"
- },
- "order_date_other": {
- "type": "string"
- },
- "order_date_type": {
- "type": "string"
- },
- "payment_period": {
- "type": "number"
- },
- "payment_period_timeframe": {
- "type": "number"
- },
- "payment_period_unit": {
- "type": "number"
- },
- "payment_process_automatic_frequency": {
- "type": "string"
- },
- "payment_process_type": {
- "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": {
- "type": "string"
- },
- "payment_process_type_invoice_duration_start": {
- "type": "string"
- },
- "payment_process_type_invoice_type": {
- "type": "string"
- },
- "pilot_period_stripe_product_id": {
- "type": "number"
- },
- "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": {
- "type": "string"
- },
- "subscription_period": {
- "type": "number"
- },
- "subscription_period_unit": {
- "type": "number"
- },
- "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": {
- "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": "boolean"
- },
- "include_fees_description": {
- "type": "boolean"
- },
- "include_fees_pay_by_amount": {
- "type": "boolean"
- },
- "include_fees_type": {
- "type": "boolean"
- },
- "include_fees_unit": {
- "type": "boolean"
- },
- "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": "boolean"
- },
- "include_program_discount": {
- "type": "boolean"
- },
- "include_program_discount_amount": {
- "type": "boolean"
- },
- "include_program_discount_unit": {
- "type": "boolean"
- },
- "include_program_participation_feedback": {
- "type": "boolean"
- },
- "include_program_participation_feedback_amount": {
- "type": "boolean"
- },
- "include_program_participation_feedback_unit": {
- "type": "boolean"
- },
- "include_program_partner_other": {
- "type": "boolean"
- },
- "include_program_partner_other_val": {
- "type": "boolean"
- },
- "include_program_provider_other": {
- "type": "boolean"
- },
- "include_program_provider_other_val": {
- "type": "boolean"
- },
- "include_program_reference": {
- "type": "boolean"
- },
- "product_description": {
- "type": "string"
- },
- "term_amount": {
- "type": "number"
- },
- "term_unit": {
- "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": {
- "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": "number"
- },
- "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": {
- "type": "string"
- },
- "data_importer_address": {
- "type": "string"
- },
- "data_importer_address_city": {
- "type": "string"
- },
- "data_importer_address_country": {
- "type": "number"
- },
- "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": "boolean"
- },
- "include_covered_claim_internal_val": {
- "type": "boolean"
- },
- "include_covered_claim_type": {
- "type": "boolean"
- },
- "include_data_subjects_custom": {
- "type": "boolean"
- },
- "include_data_subjects_custom_val": {
- "type": "boolean"
- },
- "include_data_subjects_employees": {
- "type": "boolean"
- },
- "include_data_subjects_end_users": {
- "type": "boolean"
- },
- "include_external_subprocessor_location": {
- "type": "boolean"
- },
- "include_frequency_of_transfer_continuous": {
- "type": "boolean"
- },
- "include_frequency_of_transfer_custom": {
- "type": "boolean"
- },
- "include_frequency_of_transfer_custom_val": {
- "type": "boolean"
- },
- "include_governing_country_eu": {
- "type": "boolean"
- },
- "include_governing_country_eu_val": {
- "type": "boolean"
- },
- "include_governing_country_uk": {
- "type": "boolean"
- },
- "include_governing_country_uk_val": {
- "type": "boolean"
- },
- "include_governing_law": {
- "type": "boolean"
- },
- "include_governing_law_country": {
- "type": "boolean"
- },
- "include_governing_law_state": {
- "type": "boolean"
- },
- "include_increased_claim_amount": {
- "type": "boolean"
- },
- "include_increased_claim_amount_currency": {
- "type": "boolean"
- },
- "include_increased_claim_amount_qty": {
- "type": "boolean"
- },
- "include_increased_claim_amount_type": {
- "type": "boolean"
- },
- "include_liability_cap": {
- "type": "boolean"
- },
- "include_liability_cap_amount_constant_external": {
- "type": "boolean"
- },
- "include_liability_cap_amount_constant_internal": {
- "type": "boolean"
- },
- "include_liability_cap_amount_currency_external": {
- "type": "boolean"
- },
- "include_liability_cap_amount_currency_internal": {
- "type": "boolean"
- },
- "include_liability_cap_csa_type": {
- "type": "boolean"
- },
- "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": "boolean"
- },
- "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": "boolean"
- },
- "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": "boolean"
- },
- "include_provider_security_contact_address_country": {
- "type": "boolean"
- },
- "include_provider_security_contact_address_state": {
- "type": "boolean"
- },
- "include_provider_security_contact_address_street_address": {
- "type": "boolean"
- },
- "include_provider_security_contact_address_zipcode": {
- "type": "boolean"
- },
- "include_provider_security_contact_email": {
- "format": "email",
- "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
- "type": "string"
- },
- "include_provider_security_contact_email_val": {
- "type": "boolean"
- },
- "include_security_measures_accountability": {
- "type": "boolean"
- },
- "include_security_measures_accountability_val": {
- "type": "boolean"
- },
- "include_security_measures_certification_or_assurance": {
- "type": "boolean"
- },
- "include_security_measures_certification_or_assurance_val": {
- "type": "boolean"
- },
- "include_security_measures_confidentiality_integrity": {
- "type": "boolean"
- },
- "include_security_measures_confidentiality_integrity_val": {
- "type": "boolean"
- },
- "include_security_measures_data_at_rest": {
- "type": "boolean"
- },
- "include_security_measures_data_at_rest_val": {
- "type": "boolean"
- },
- "include_security_measures_data_minimization": {
- "type": "boolean"
- },
- "include_security_measures_data_minimization_val": {
- "type": "boolean"
- },
- "include_security_measures_data_quality": {
- "type": "boolean"
- },
- "include_security_measures_data_quality_val": {
- "type": "boolean"
- },
- "include_security_measures_data_retention": {
- "type": "boolean"
- },
- "include_security_measures_data_retention_val": {
- "type": "boolean"
- },
- "include_security_measures_data_transmission": {
- "type": "boolean"
- },
- "include_security_measures_data_transmission_val": {
- "type": "boolean"
- },
- "include_security_measures_event_logging": {
- "type": "boolean"
- },
- "include_security_measures_event_logging_val": {
- "type": "boolean"
- },
- "include_security_measures_identity_auth": {
- "type": "boolean"
- },
- "include_security_measures_identity_auth_val": {
- "type": "boolean"
- },
- "include_security_measures_it_security_governance": {
- "type": "boolean"
- },
- "include_security_measures_it_security_governance_val": {
- "type": "boolean"
- },
- "include_security_measures_physical_security": {
- "type": "boolean"
- },
- "include_security_measures_physical_security_val": {
- "type": "boolean"
- },
- "include_security_measures_portability_and_erasure": {
- "type": "boolean"
- },
- "include_security_measures_portability_and_erasure_val": {
- "type": "boolean"
- },
- "include_security_measures_pseudonym_encryption": {
- "type": "boolean"
- },
- "include_security_measures_pseudonym_encryption_val": {
- "type": "boolean"
- },
- "include_security_measures_restore_data_access": {
- "type": "boolean"
- },
- "include_security_measures_restore_data_access_val": {
- "type": "boolean"
- },
- "include_security_measures_security_policy": {
- "type": "boolean"
- },
- "include_security_measures_system_configuration": {
- "type": "boolean"
- },
- "include_security_measures_system_configuration_val": {
- "type": "boolean"
- },
- "include_security_measures_testing_assessment": {
- "type": "boolean"
- },
- "include_security_measures_testing_assessment_val": {
- "type": "boolean"
- },
- "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": "boolean"
- },
- "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": "boolean"
- },
- "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": {
- "type": "string"
- },
- "subprocessors_attributes": {
- "additionalProperties": {
- "additionalProperties": false,
- "properties": {
- "country": {
- "type": "string"
- },
- "name": {
- "type": "string"
- },
- "processing_task": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "description": "Subprocessors. Use string keys such as \"0\", \"1\".",
- "propertyNames": {
- "type": "string"
- },
- "type": "object"
- },
- "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"
- },
- "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"
- },
- "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": "string"
- },
- "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": "string"
- },
- "confidentiality_nda_type": {
- "type": "string"
- },
- "confidentiality_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"
- },
- "include_custom_details": {
- "type": "boolean"
- },
- "include_custom_details_val": {
- "type": "boolean"
- },
- "include_fees": {
- "type": "boolean"
- },
- "include_fees_amount": {
- "type": "boolean"
- },
- "include_fees_amount_duration": {
- "type": "boolean"
- },
- "include_fees_include_amount": {
- "type": "boolean"
- },
- "include_fees_include_other": {
- "type": "boolean"
- },
- "include_fees_other": {
- "type": "boolean"
- },
- "include_functionality": {
- "type": "boolean"
- },
- "include_functionality_val": {
- "type": "boolean"
- },
- "include_launch_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_launch_date_custom": {
- "type": "boolean"
- },
- "include_launch_date_date": {
- "type": "boolean"
- },
- "include_launch_date_type": {
- "type": "boolean"
- },
- "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"
- },
- "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": {
- "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": {
- "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_include_company": {
- "type": "boolean"
- },
- "include_additional_warranties_include_company_val": {
- "type": "boolean"
- },
- "include_additional_warranties_include_partner": {
- "type": "boolean"
- },
- "include_additional_warranties_include_partner_val": {
- "type": "boolean"
- },
- "include_brand_guidelines": {
- "type": "boolean"
- },
- "include_brand_guidelines_include_company": {
- "type": "boolean"
- },
- "include_brand_guidelines_include_company_val": {
- "type": "boolean"
- },
- "include_brand_guidelines_include_partner": {
- "type": "boolean"
- },
- "include_brand_guidelines_include_partner_val": {
- "type": "boolean"
- },
- "include_covered_claims": {
- "type": "boolean"
- },
- "include_covered_claims_company_claims": {
- "type": "boolean"
- },
- "include_covered_claims_include_company_claims": {
- "type": "boolean"
- },
- "include_covered_claims_include_partner_claims": {
- "type": "boolean"
- },
- "include_covered_claims_partner_claims": {
- "type": "boolean"
- },
- "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": "boolean"
- },
- "include_dpa_type": {
- "type": "boolean"
- },
- "include_increased_cap_amount": {
- "type": "boolean"
- },
- "include_increased_cap_amount_currency": {
- "type": "boolean"
- },
- "include_increased_cap_amount_either_currency": {
- "type": "boolean"
- },
- "include_increased_cap_amount_either_multiple": {
- "type": "boolean"
- },
- "include_increased_cap_amount_multiple": {
- "type": "boolean"
- },
- "include_increased_cap_amount_type": {
- "type": "boolean"
- },
- "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": "boolean"
- },
- "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": "boolean"
- },
- "negotiations_allowed": {
- "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": {
- "type": "string"
- },
- "end_date_date": {
- "type": "string"
- },
- "end_date_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"
- },
- "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": "boolean"
- },
- "include_obligations_company_promotion_include_materials": {
- "type": "boolean"
- },
- "include_obligations_company_promotion_include_materials_val": {
- "type": "boolean"
- },
- "include_obligations_company_referral": {
- "type": "boolean"
- },
- "include_obligations_company_referral_include_criteria": {
- "type": "boolean"
- },
- "include_obligations_company_referral_include_criteria_val": {
- "type": "boolean"
- },
- "include_obligations_company_referral_include_pay_sch": {
- "type": "boolean"
- },
- "include_obligations_company_referral_include_pay_sch_amount": {
- "type": "boolean"
- },
- "include_obligations_company_referral_include_pay_sch_custom": {
- "type": "boolean"
- },
- "include_obligations_company_referral_include_pay_sch_unit": {
- "type": "boolean"
- },
- "include_obligations_company_sponsorship": {
- "type": "boolean"
- },
- "include_obligations_company_sponsorship_include_benefits": {
- "type": "boolean"
- },
- "include_obligations_company_sponsorship_include_benefits_val": {
- "type": "boolean"
- },
- "include_obligations_company_sponsorship_include_payments": {
- "type": "boolean"
- },
- "include_obligations_company_sponsorship_include_payments_amount": {
- "type": "boolean"
- },
- "include_obligations_company_sponsorship_include_payments_unit": {
- "type": "boolean"
- },
- "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": "boolean"
- },
- "include_obligations_partner_promotion_include_materials": {
- "type": "boolean"
- },
- "include_obligations_partner_promotion_include_materials_val": {
- "type": "boolean"
- },
- "include_obligations_partner_referral": {
- "type": "boolean"
- },
- "include_obligations_partner_referral_include_criteria": {
- "type": "boolean"
- },
- "include_obligations_partner_referral_include_criteria_val": {
- "type": "boolean"
- },
- "include_obligations_partner_referral_include_pay_sch": {
- "type": "boolean"
- },
- "include_obligations_partner_referral_include_pay_sch_amount": {
- "type": "boolean"
- },
- "include_obligations_partner_referral_include_pay_sch_custom": {
- "type": "boolean"
- },
- "include_obligations_partner_referral_include_pay_sch_unit": {
- "type": "boolean"
- },
- "include_obligations_partner_sponsorship": {
- "type": "boolean"
- },
- "include_obligations_partner_sponsorship_include_benefits": {
- "type": "boolean"
- },
- "include_obligations_partner_sponsorship_include_benefits_val": {
- "type": "boolean"
- },
- "include_obligations_partner_sponsorship_include_payments": {
- "type": "boolean"
- },
- "include_obligations_partner_sponsorship_include_payments_amount": {
- "type": "boolean"
- },
- "include_obligations_partner_sponsorship_include_payments_unit": {
- "type": "boolean"
- },
- "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": "boolean"
- },
- "include_payment_process_company_include_address_country": {
- "type": "boolean"
- },
- "include_payment_process_company_include_address_state": {
- "type": "boolean"
- },
- "include_payment_process_company_include_address_street_address": {
- "type": "boolean"
- },
- "include_payment_process_company_include_address_zipcode": {
- "type": "boolean"
- },
- "include_payment_process_company_include_email": {
- "format": "email",
- "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
- "type": "string"
- },
- "include_payment_process_company_include_email_val": {
- "type": "boolean"
- },
- "include_payment_process_partner": {
- "type": "boolean"
- },
- "include_payment_process_partner_include_address": {
- "type": "boolean"
- },
- "include_payment_process_partner_include_address_city": {
- "type": "boolean"
- },
- "include_payment_process_partner_include_address_country": {
- "type": "boolean"
- },
- "include_payment_process_partner_include_address_state": {
- "type": "boolean"
- },
- "include_payment_process_partner_include_address_street_address": {
- "type": "boolean"
- },
- "include_payment_process_partner_include_address_zipcode": {
- "type": "boolean"
- },
- "include_payment_process_partner_include_email": {
- "format": "email",
- "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
- "type": "string"
- },
- "include_payment_process_partner_include_email_val": {
- "type": "boolean"
- },
- "include_payment_schedule": {
- "type": "boolean"
- },
- "include_payment_schedule_custom": {
- "type": "boolean"
- },
- "include_payment_schedule_specified_amount": {
- "type": "boolean"
- },
- "include_payment_schedule_specified_timeframe": {
- "type": "boolean"
- },
- "include_payment_schedule_specified_unit": {
- "type": "boolean"
- },
- "include_payment_schedule_type": {
- "type": "boolean"
- },
- "negotiations_allowed": {
- "type": "string"
- },
- "territory_type": {
- "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": {
- "type": "string"
- },
- "general_cap_amount": {
- "type": "number"
- },
- "general_cap_amount_type": {
- "type": "number"
- },
- "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": "boolean"
- },
- "include_dpa_type": {
- "type": "boolean"
- },
- "include_payment_process": {
- "type": "boolean"
- },
- "include_technical_support": {
- "type": "boolean"
- },
- "negotiations_allowed": {
- "type": "string"
- },
- "payment_process_automatic_frequency": {
- "type": "string"
- },
- "payment_process_invoice_days": {
- "type": "number"
- },
- "payment_process_invoice_from": {
- "type": "string"
- },
- "payment_process_invoice_timeframe": {
- "type": "string"
- },
- "payment_process_type": {
- "type": "string"
- },
- "pilot_period_description": {
- "type": "number"
- },
- "pilot_period_fees_description": {
- "type": "number"
- },
- "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"
- },
- "default_signer_email": {
- "format": "email",
- "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
- "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": {
- "type": "string"
- },
- "general_cap_amount": {
- "type": "number"
- },
- "general_cap_amount_type": {
- "type": "number"
- },
- "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": "boolean"
- },
- "include_additional_warranties_by_provider": {
- "type": "boolean"
- },
- "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": "boolean"
- },
- "include_covered_claims_include_customer_claims": {
- "type": "boolean"
- },
- "include_covered_claims_include_provider_claims": {
- "type": "boolean"
- },
- "include_covered_claims_provider_claims": {
- "type": "boolean"
- },
- "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": "boolean"
- },
- "include_customer_insurance_min_auto_liability_minimum": {
- "type": "boolean"
- },
- "include_customer_insurance_min_cyber_liability_aggregate": {
- "type": "boolean"
- },
- "include_customer_insurance_min_cyber_liability_minimum": {
- "type": "boolean"
- },
- "include_customer_insurance_min_employer_liability_aggregate": {
- "type": "boolean"
- },
- "include_customer_insurance_min_employer_liability_minimum": {
- "type": "boolean"
- },
- "include_customer_insurance_min_general_liability_aggregate": {
- "type": "boolean"
- },
- "include_customer_insurance_min_general_liability_minimum": {
- "type": "boolean"
- },
- "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": "boolean"
- },
- "include_customer_policies_type": {
- "type": "boolean"
- },
- "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": "boolean"
- },
- "include_dpa_type": {
- "type": "boolean"
- },
- "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": "boolean"
- },
- "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": "boolean"
- },
- "include_provider_insurance_min_auto_liability_minimum": {
- "type": "boolean"
- },
- "include_provider_insurance_min_cyber_liability_aggregate": {
- "type": "boolean"
- },
- "include_provider_insurance_min_cyber_liability_minimum": {
- "type": "boolean"
- },
- "include_provider_insurance_min_employer_liability_aggregate": {
- "type": "boolean"
- },
- "include_provider_insurance_min_employer_liability_minimum": {
- "type": "boolean"
- },
- "include_provider_insurance_min_general_liability_aggregate": {
- "type": "boolean"
- },
- "include_provider_insurance_min_general_liability_minimum": {
- "type": "boolean"
- },
- "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": {
- "type": "boolean"
- },
- "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": "boolean"
- },
- "include_security_policy_iso27001": {
- "type": "boolean"
- },
- "include_security_policy_location": {
- "type": "boolean"
- },
- "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": {
- "type": "boolean"
- },
- "include_terms": {
- "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_negligence": {
- "type": "boolean"
- },
- "include_unlimited_claims_other": {
- "type": "boolean"
- },
- "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": {
- "type": "number"
- },
- "negotiations_allowed": {
- "type": "string"
- },
- "sender_last_to_sign": {
- "type": "boolean"
- }
- },
- "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,
- "properties": {
- "cost": {
- "type": "number"
- },
- "description": {
- "type": "string"
- },
- "fee_type": {
- "type": "string"
- },
- "stripe_product_id": {
- "type": "string"
- },
- "type": {
- "description": "Fee class discriminator.",
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "cost": {
- "type": "number"
- },
- "description": {
- "type": "string"
- },
- "discount_duration_amount": {
- "type": "number"
- },
- "discount_duration_type": {
- "type": "string"
- },
- "discount_type": {
- "type": "string"
- },
- "fee_type": {
- "type": "string"
- },
- "stripe_product_id": {
- "type": "string"
- },
- "type": {
- "description": "Fee class discriminator.",
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "cost": {
- "type": "number"
- },
- "description": {
- "type": "string"
- },
- "fee_type": {
- "type": "string"
- },
- "quantity": {
- "type": "number"
- },
- "stripe_product_id": {
- "type": "string"
- },
- "type": {
- "description": "Fee class discriminator.",
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "attachment_id": {
- "type": "string"
- },
- "description": {
- "type": "string"
- },
- "fee_type": {
- "type": "string"
- },
- "stripe_product_id": {
- "type": "string"
- },
- "type": {
- "description": "Fee class discriminator.",
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "description": {
- "type": "string"
- },
- "fee_type": {
- "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": {
- "type": "string"
- },
- "type": {
- "description": "Fee class discriminator.",
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "description": {
- "type": "string"
- },
- "fee_type": {
- "type": "string"
- },
- "stripe_product_id": {
- "type": "string"
- },
- "type": {
- "description": "Fee class discriminator.",
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "cost": {
- "type": "number"
- },
- "description": {
- "type": "string"
- },
- "fee_type": {
- "type": "string"
- },
- "stripe_product_id": {
- "type": "string"
- },
- "type": {
- "description": "Fee class discriminator.",
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "cost": {
- "type": "number"
- },
- "description": {
- "type": "string"
- },
- "fee_type": {
- "type": "string"
- },
- "stripe_product_id": {
- "type": "string"
- },
- "type": {
- "description": "Fee class discriminator.",
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "description": {
- "type": "string"
- },
- "fee_type": {
- "type": "string"
- },
- "stripe_product_id": {
- "type": "string"
- },
- "type": {
- "description": "Fee class discriminator.",
- "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": "boolean"
- },
- "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": "boolean"
- },
- "include_deliverables_include_acceptance": {
- "type": "boolean"
- },
- "include_deliverables_include_attachment": {
- "type": "boolean"
- },
- "include_deliverables_include_draft_deliverables": {
- "type": "boolean"
- },
- "include_deliverables_rejection_amount": {
- "type": "boolean"
- },
- "include_deliverables_rejection_unit": {
- "type": "boolean"
- },
- "include_deliverables_resubmission_amount": {
- "type": "boolean"
- },
- "include_deliverables_resubmission_unit": {
- "type": "boolean"
- },
- "include_fees_other": {
- "type": "boolean"
- },
- "include_fees_other_val": {
- "type": "boolean"
- },
- "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": {
- "type": "boolean"
- },
- "include_fees_travel_val": {
- "type": "boolean"
- },
- "include_third_party_customer": {
- "type": "boolean"
- },
- "include_third_party_include_description": {
- "type": "boolean"
- },
- "include_third_party_include_description_val": {
- "type": "boolean"
- },
- "include_third_party_materials": {
- "type": "boolean"
- },
- "include_third_party_provider": {
- "type": "boolean"
- },
- "include_time_of_assignment": {
- "type": "boolean"
- },
- "include_time_of_assignment_type": {
- "type": "boolean"
- },
- "invoice_period_description": {
- "type": "number"
- },
- "negotiations_allowed": {
- "type": "string"
- },
- "payment_period": {
- "type": "number"
- },
- "payment_period_other": {
- "type": "number"
- },
- "payment_period_timeframe": {
- "type": "number"
- },
- "payment_period_type": {
- "type": "number"
- },
- "payment_period_unit": {
- "type": "number"
- },
- "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": {
- "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": {
- "type": "string"
- },
- "sow_term_unit": {
- "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-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-z]{2,}$",
- "type": "string"
- },
- "recipient_organization": {
- "type": "string"
- },
- "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-z]{2,}$",
- "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": {
- "type": "string"
- },
- "general_cap_amount": {
- "type": "number"
- },
- "general_cap_amount_type": {
- "type": "number"
- },
- "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": "boolean"
- },
- "include_additional_warranties_by_provider": {
- "type": "boolean"
- },
- "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": "boolean"
- },
- "include_covered_claims_include_customer_claims": {
- "type": "boolean"
- },
- "include_covered_claims_include_provider_claims": {
- "type": "boolean"
- },
- "include_covered_claims_provider_claims": {
- "type": "boolean"
- },
- "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": "boolean"
- },
- "include_dpa_type": {
- "type": "boolean"
- },
- "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": "boolean"
- },
- "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": "boolean"
- },
- "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": {
- "type": "number"
- }
- },
- "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": "string"
- },
- "deletion_procedure_include_custom_description": {
- "type": "string"
- },
- "deletion_procedure_include_customer_disable": {
- "type": "string"
- },
- "deletion_procedure_include_customer_proof": {
- "type": "string"
- },
- "deletion_procedure_include_provider_disable": {
- "type": "string"
- },
- "fee_custom_unit": {
- "type": "string"
- },
- "fee_period": {
- "type": "number"
- },
- "fees_attributes": {
- "additionalProperties": {
- "anyOf": [
- {
- "additionalProperties": false,
- "properties": {
- "cost": {
- "type": "number"
- },
- "description": {
- "type": "string"
- },
- "fee_type": {
- "type": "string"
- },
- "stripe_product_id": {
- "type": "string"
- },
- "type": {
- "description": "Fee class discriminator.",
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "cost": {
- "type": "number"
- },
- "description": {
- "type": "string"
- },
- "discount_duration_amount": {
- "type": "number"
- },
- "discount_duration_type": {
- "type": "string"
- },
- "discount_type": {
- "type": "string"
- },
- "fee_type": {
- "type": "string"
- },
- "stripe_product_id": {
- "type": "string"
- },
- "type": {
- "description": "Fee class discriminator.",
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "cost": {
- "type": "number"
- },
- "description": {
- "type": "string"
- },
- "fee_type": {
- "type": "string"
- },
- "quantity": {
- "type": "number"
- },
- "stripe_product_id": {
- "type": "string"
- },
- "type": {
- "description": "Fee class discriminator.",
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "attachment_id": {
- "type": "string"
- },
- "description": {
- "type": "string"
- },
- "fee_type": {
- "type": "string"
- },
- "stripe_product_id": {
- "type": "string"
- },
- "type": {
- "description": "Fee class discriminator.",
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "description": {
- "type": "string"
- },
- "fee_type": {
- "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": {
- "type": "string"
- },
- "type": {
- "description": "Fee class discriminator.",
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "description": {
- "type": "string"
- },
- "fee_type": {
- "type": "string"
- },
- "stripe_product_id": {
- "type": "string"
- },
- "type": {
- "description": "Fee class discriminator.",
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "cost": {
- "type": "number"
- },
- "description": {
- "type": "string"
- },
- "fee_type": {
- "type": "string"
- },
- "stripe_product_id": {
- "type": "string"
- },
- "type": {
- "description": "Fee class discriminator.",
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "cost": {
- "type": "number"
- },
- "description": {
- "type": "string"
- },
- "fee_type": {
- "type": "string"
- },
- "stripe_product_id": {
- "type": "string"
- },
- "type": {
- "description": "Fee class discriminator.",
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "description": {
- "type": "string"
- },
- "fee_type": {
- "type": "string"
- },
- "stripe_product_id": {
- "type": "string"
- },
- "type": {
- "description": "Fee class discriminator.",
- "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": {
- "type": "string"
- },
- "fees_include_fee_increase_upon_renewal": {
- "type": "number"
- },
- "fees_include_fee_increase_upon_renewal_fee": {
- "type": "number"
- },
- "fees_include_fee_increase_upon_renewal_type": {
- "type": "number"
- },
- "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": "boolean"
- },
- "include_license_limits": {
- "type": "boolean"
- },
- "include_license_limits_description": {
- "type": "boolean"
- },
- "include_payment_process_include_billing_email": {
- "format": "email",
- "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
- "type": "string"
- },
- "include_pilot_period": {
- "type": "boolean"
- },
- "include_pilot_period_duration_amount": {
- "type": "boolean"
- },
- "include_pilot_period_duration_type": {
- "type": "boolean"
- },
- "include_pilot_period_include_fees": {
- "type": "boolean"
- },
- "include_pilot_period_include_fees_amount": {
- "type": "boolean"
- },
- "include_pilot_period_include_modifications": {
- "type": "boolean"
- },
- "include_pilot_period_include_modifications_description": {
- "type": "boolean"
- },
- "include_services": {
- "type": "boolean"
- },
- "include_services_description": {
- "type": "boolean"
- },
- "negotiations_allowed": {
- "type": "string"
- },
- "order_date_date": {
- "type": "string"
- },
- "order_date_type": {
- "type": "string"
- },
- "payment_process_automatic_frequency": {
- "type": "string"
- },
- "payment_process_type": {
- "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": {
- "type": "string"
- },
- "payment_process_type_invoice_duration_start": {
- "type": "string"
- },
- "payment_process_type_invoice_type": {
- "type": "string"
- },
- "permitted_uses_include_custom": {
- "type": "string"
- },
- "permitted_uses_include_custom_description": {
- "type": "string"
- },
- "permitted_uses_include_customers_affiliates": {
- "type": "string"
- },
- "permitted_uses_include_internal_business": {
- "type": "string"
- },
- "pilot_period_stripe_product_id": {
- "type": "number"
- },
- "software_description": {
- "type": "string"
- },
- "subscription_auto_renew": {
- "type": "string"
- },
- "subscription_period": {
- "type": "number"
- },
- "subscription_period_unit": {
- "type": "number"
- },
- "subscription_renewal_notice_days": {
- "type": "number"
- },
- "warranty_period_description_amount": {
- "type": "number"
- },
- "warranty_period_description_duration": {
- "type": "number"
- },
- "warranty_period_description_duration_start": {
- "type": "number"
- },
- "warranty_period_type": {
- "type": "number"
- }
- },
- "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-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": {
+ "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": "number"
+ },
+ "aggregation_limitations_permitted_val": {
+ "type": "number"
+ },
+ "breach_notification_unit": {
+ "type": "string"
+ },
+ "breach_notification_val": {
+ "type": "number"
+ },
+ "business_associate_relationship_type": {
+ "type": "string"
+ },
+ "deidentification_limitations_include_purpose": {
+ "type": "number"
+ },
+ "deidentification_limitations_include_requirements": {
+ "type": "number"
+ },
+ "deidentification_limitations_permitted": {
+ "type": "number"
+ },
+ "deidentification_limitations_purpose_val": {
+ "type": "number"
+ },
+ "deidentification_limitations_requirements_val": {
+ "type": "number"
+ },
+ "designated_record_set_provider_maintains": {
+ "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_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": "number"
+ },
+ "offshore_limitations_permitted_val": {
+ "type": "number"
+ },
+ "subcontract_limitations_include_notice": {
+ "type": "number"
+ },
+ "subcontract_limitations_include_permission": {
+ "type": "number"
+ },
+ "subcontract_limitations_notice_val": {
+ "type": "number"
+ },
+ "subcontract_limitations_permission_val": {
+ "type": "number"
+ },
+ "subcontract_limitations_permitted": {
+ "type": "number"
+ },
+ "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"
+ },
+ "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-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"
+ },
+ "default_signer_email": {
+ "format": "email",
+ "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "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": {
+ "type": "string"
+ },
+ "effective_date_type": {
+ "type": "string"
+ },
+ "general_cap_amount": {
+ "type": "number"
+ },
+ "general_cap_amount_type": {
+ "type": "number"
+ },
+ "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": "boolean"
+ },
+ "include_acceptable_use_policy_type": {
+ "type": "boolean"
+ },
+ "include_additional_warranties": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_by_customer": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_by_provider": {
+ "type": "boolean"
+ },
+ "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": "boolean"
+ },
+ "include_covered_claims_include_customer_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_include_provider_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_provider_claims": {
+ "type": "boolean"
+ },
+ "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": "boolean"
+ },
+ "include_dpa_type": {
+ "type": "boolean"
+ },
+ "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": "boolean"
+ },
+ "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": "boolean"
+ },
+ "include_insurance_minimums_cyber_liability_aggregate": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_cyber_liability_minimum": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_employer_liability_aggregate": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_employer_liability_minimum": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_general_liability_aggregate": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_general_liability_minimum": {
+ "type": "boolean"
+ },
+ "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": {
+ "type": "boolean"
+ },
+ "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": "boolean"
+ },
+ "include_security_policy_other": {
+ "type": "boolean"
+ },
+ "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": {
+ "type": "boolean"
+ },
+ "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_terms": {
+ "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": "boolean"
+ },
+ "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": {
+ "type": "number"
+ },
+ "negotiations_allowed": {
+ "type": "string"
+ },
+ "provider": {
+ "type": "string"
+ },
+ "sender_last_to_sign": {
+ "type": "boolean"
+ },
+ "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": "number"
+ },
+ "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": {
+ "type": "number"
+ },
+ "fees_attributes": {
+ "additionalProperties": {
+ "anyOf": [
+ {
+ "additionalProperties": false,
+ "properties": {
+ "cost": {
+ "type": "number"
+ },
+ "description": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class discriminator.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "cost": {
+ "type": "number"
+ },
+ "description": {
+ "type": "string"
+ },
+ "discount_duration_amount": {
+ "type": "number"
+ },
+ "discount_duration_type": {
+ "type": "string"
+ },
+ "discount_type": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class discriminator.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "cost": {
+ "type": "number"
+ },
+ "description": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "quantity": {
+ "type": "number"
+ },
+ "stripe_product_id": {
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class discriminator.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "attachment_id": {
+ "type": "string"
+ },
+ "description": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class discriminator.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "description": {
+ "type": "string"
+ },
+ "fee_type": {
+ "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": {
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class discriminator.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "description": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class discriminator.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "cost": {
+ "type": "number"
+ },
+ "description": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class discriminator.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "cost": {
+ "type": "number"
+ },
+ "description": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class discriminator.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "description": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class discriminator.",
+ "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": {
+ "type": "string"
+ },
+ "fees_include_fee_increase_upon_renewal": {
+ "type": "number"
+ },
+ "fees_include_fee_increase_upon_renewal_fee": {
+ "type": "number"
+ },
+ "fees_include_fee_increase_upon_renewal_type": {
+ "type": "number"
+ },
+ "fees_inclusive_of_taxes": {
+ "type": "boolean"
+ },
+ "framework_terms_type": {
+ "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": "boolean"
+ },
+ "include_fees_table": {
+ "type": "boolean"
+ },
+ "include_fees_table_period": {
+ "type": "boolean"
+ },
+ "include_free_trial": {
+ "type": "boolean"
+ },
+ "include_max_users": {
+ "type": "boolean"
+ },
+ "include_pilot_period": {
+ "type": "boolean"
+ },
+ "include_pilot_period_duration_amount": {
+ "type": "boolean"
+ },
+ "include_pilot_period_duration_type": {
+ "type": "boolean"
+ },
+ "include_pilot_period_include_fees": {
+ "type": "boolean"
+ },
+ "include_pilot_period_include_fees_amount": {
+ "type": "boolean"
+ },
+ "include_pilot_period_include_modifications": {
+ "type": "boolean"
+ },
+ "include_pilot_period_include_modifications_description": {
+ "type": "boolean"
+ },
+ "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": "boolean"
+ },
+ "include_product_support_type": {
+ "type": "boolean"
+ },
+ "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": "boolean"
+ },
+ "include_professional_services_description": {
+ "type": "boolean"
+ },
+ "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": "boolean"
+ },
+ "include_professional_services_include_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_include_fees_description": {
+ "type": "boolean"
+ },
+ "include_professional_services_type": {
+ "type": "boolean"
+ },
+ "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": "boolean"
+ },
+ "include_sla_include_response_time": {
+ "type": "boolean"
+ },
+ "include_sla_include_response_time_amount": {
+ "type": "boolean"
+ },
+ "include_sla_include_response_time_credit": {
+ "type": "boolean"
+ },
+ "include_sla_include_response_time_duration": {
+ "type": "boolean"
+ },
+ "include_sla_include_response_time_support_channel": {
+ "type": "boolean"
+ },
+ "include_sla_include_target_uptime": {
+ "type": "boolean"
+ },
+ "include_sla_maintenance_notice": {
+ "type": "boolean"
+ },
+ "include_sla_maintenance_window": {
+ "type": "boolean"
+ },
+ "include_sla_maintenance_window_type": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_notice_qty": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_notice_unit": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_end_time": {
+ "type": "boolean"
+ },
+ "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": "boolean"
+ },
+ "include_sla_standard_maintenance_window_sunday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_thursday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_time_zone": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_tuesday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_wednesday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_target_uptime": {
+ "type": "boolean"
+ },
+ "include_sla_type": {
+ "type": "boolean"
+ },
+ "include_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"
+ },
+ "include_subscription_start_date_date": {
+ "type": "boolean"
+ },
+ "include_usage_review": {
+ "type": "boolean"
+ },
+ "include_usage_review_val": {
+ "type": "boolean"
+ },
+ "include_use_limitations": {
+ "type": "boolean"
+ },
+ "include_use_limitations_val": {
+ "type": "boolean"
+ },
+ "invoice_period": {
+ "type": "number"
+ },
+ "invoice_period_custom_unit": {
+ "type": "number"
+ },
+ "max_consumption": {
+ "type": "number"
+ },
+ "max_users": {
+ "type": "number"
+ },
+ "negotiations_allowed": {
+ "type": "string"
+ },
+ "order_date_date": {
+ "type": "string"
+ },
+ "order_date_other": {
+ "type": "string"
+ },
+ "order_date_type": {
+ "type": "string"
+ },
+ "payment_period": {
+ "type": "number"
+ },
+ "payment_period_timeframe": {
+ "type": "number"
+ },
+ "payment_period_unit": {
+ "type": "number"
+ },
+ "payment_process_automatic_frequency": {
+ "type": "string"
+ },
+ "payment_process_type": {
+ "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": {
+ "type": "string"
+ },
+ "payment_process_type_invoice_duration_start": {
+ "type": "string"
+ },
+ "payment_process_type_invoice_type": {
+ "type": "string"
+ },
+ "pilot_period_stripe_product_id": {
+ "type": "number"
+ },
+ "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": {
+ "type": "string"
+ },
+ "subscription_period": {
+ "type": "number"
+ },
+ "subscription_period_unit": {
+ "type": "number"
+ },
+ "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": {
+ "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": "boolean"
+ },
+ "include_fees_description": {
+ "type": "boolean"
+ },
+ "include_fees_pay_by_amount": {
+ "type": "boolean"
+ },
+ "include_fees_type": {
+ "type": "boolean"
+ },
+ "include_fees_unit": {
+ "type": "boolean"
+ },
+ "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": "boolean"
+ },
+ "include_program_discount": {
+ "type": "boolean"
+ },
+ "include_program_discount_amount": {
+ "type": "boolean"
+ },
+ "include_program_discount_unit": {
+ "type": "boolean"
+ },
+ "include_program_participation_feedback": {
+ "type": "boolean"
+ },
+ "include_program_participation_feedback_amount": {
+ "type": "boolean"
+ },
+ "include_program_participation_feedback_unit": {
+ "type": "boolean"
+ },
+ "include_program_partner_other": {
+ "type": "boolean"
+ },
+ "include_program_partner_other_val": {
+ "type": "boolean"
+ },
+ "include_program_provider_other": {
+ "type": "boolean"
+ },
+ "include_program_provider_other_val": {
+ "type": "boolean"
+ },
+ "include_program_reference": {
+ "type": "boolean"
+ },
+ "product_description": {
+ "type": "string"
+ },
+ "term_amount": {
+ "type": "number"
+ },
+ "term_unit": {
+ "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.",
+ "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-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"
+ },
+ "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": "string"
+ },
+ "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": "string"
+ },
+ "confidentiality_nda_type": {
+ "type": "string"
+ },
+ "confidentiality_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"
+ },
+ "include_custom_details": {
+ "type": "boolean"
+ },
+ "include_custom_details_val": {
+ "type": "boolean"
+ },
+ "include_fees": {
+ "type": "boolean"
+ },
+ "include_fees_amount": {
+ "type": "boolean"
+ },
+ "include_fees_amount_duration": {
+ "type": "boolean"
+ },
+ "include_fees_include_amount": {
+ "type": "boolean"
+ },
+ "include_fees_include_other": {
+ "type": "boolean"
+ },
+ "include_fees_other": {
+ "type": "boolean"
+ },
+ "include_functionality": {
+ "type": "boolean"
+ },
+ "include_functionality_val": {
+ "type": "boolean"
+ },
+ "include_launch_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_launch_date_custom": {
+ "type": "boolean"
+ },
+ "include_launch_date_date": {
+ "type": "boolean"
+ },
+ "include_launch_date_type": {
+ "type": "boolean"
+ },
+ "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"
+ },
+ "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": {
+ "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": {
+ "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_include_company": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_include_company_val": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_include_partner": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_include_partner_val": {
+ "type": "boolean"
+ },
+ "include_brand_guidelines": {
+ "type": "boolean"
+ },
+ "include_brand_guidelines_include_company": {
+ "type": "boolean"
+ },
+ "include_brand_guidelines_include_company_val": {
+ "type": "boolean"
+ },
+ "include_brand_guidelines_include_partner": {
+ "type": "boolean"
+ },
+ "include_brand_guidelines_include_partner_val": {
+ "type": "boolean"
+ },
+ "include_covered_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_company_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_include_company_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_include_partner_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_partner_claims": {
+ "type": "boolean"
+ },
+ "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": "boolean"
+ },
+ "include_dpa_type": {
+ "type": "boolean"
+ },
+ "include_increased_cap_amount": {
+ "type": "boolean"
+ },
+ "include_increased_cap_amount_currency": {
+ "type": "boolean"
+ },
+ "include_increased_cap_amount_either_currency": {
+ "type": "boolean"
+ },
+ "include_increased_cap_amount_either_multiple": {
+ "type": "boolean"
+ },
+ "include_increased_cap_amount_multiple": {
+ "type": "boolean"
+ },
+ "include_increased_cap_amount_type": {
+ "type": "boolean"
+ },
+ "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": "boolean"
+ },
+ "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": "boolean"
+ },
+ "negotiations_allowed": {
+ "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": {
+ "type": "string"
+ },
+ "end_date_date": {
+ "type": "string"
+ },
+ "end_date_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"
+ },
+ "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": "boolean"
+ },
+ "include_obligations_company_promotion_include_materials": {
+ "type": "boolean"
+ },
+ "include_obligations_company_promotion_include_materials_val": {
+ "type": "boolean"
+ },
+ "include_obligations_company_referral": {
+ "type": "boolean"
+ },
+ "include_obligations_company_referral_include_criteria": {
+ "type": "boolean"
+ },
+ "include_obligations_company_referral_include_criteria_val": {
+ "type": "boolean"
+ },
+ "include_obligations_company_referral_include_pay_sch": {
+ "type": "boolean"
+ },
+ "include_obligations_company_referral_include_pay_sch_amount": {
+ "type": "boolean"
+ },
+ "include_obligations_company_referral_include_pay_sch_custom": {
+ "type": "boolean"
+ },
+ "include_obligations_company_referral_include_pay_sch_unit": {
+ "type": "boolean"
+ },
+ "include_obligations_company_sponsorship": {
+ "type": "boolean"
+ },
+ "include_obligations_company_sponsorship_include_benefits": {
+ "type": "boolean"
+ },
+ "include_obligations_company_sponsorship_include_benefits_val": {
+ "type": "boolean"
+ },
+ "include_obligations_company_sponsorship_include_payments": {
+ "type": "boolean"
+ },
+ "include_obligations_company_sponsorship_include_payments_amount": {
+ "type": "boolean"
+ },
+ "include_obligations_company_sponsorship_include_payments_unit": {
+ "type": "boolean"
+ },
+ "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": "boolean"
+ },
+ "include_obligations_partner_promotion_include_materials": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_promotion_include_materials_val": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_referral": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_referral_include_criteria": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_referral_include_criteria_val": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_referral_include_pay_sch": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_referral_include_pay_sch_amount": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_referral_include_pay_sch_custom": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_referral_include_pay_sch_unit": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_sponsorship": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_sponsorship_include_benefits": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_sponsorship_include_benefits_val": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_sponsorship_include_payments": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_sponsorship_include_payments_amount": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_sponsorship_include_payments_unit": {
+ "type": "boolean"
+ },
+ "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": "boolean"
+ },
+ "include_payment_process_company_include_address_country": {
+ "type": "boolean"
+ },
+ "include_payment_process_company_include_address_state": {
+ "type": "boolean"
+ },
+ "include_payment_process_company_include_address_street_address": {
+ "type": "boolean"
+ },
+ "include_payment_process_company_include_address_zipcode": {
+ "type": "boolean"
+ },
+ "include_payment_process_company_include_email": {
+ "format": "email",
+ "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "include_payment_process_company_include_email_val": {
+ "type": "boolean"
+ },
+ "include_payment_process_partner": {
+ "type": "boolean"
+ },
+ "include_payment_process_partner_include_address": {
+ "type": "boolean"
+ },
+ "include_payment_process_partner_include_address_city": {
+ "type": "boolean"
+ },
+ "include_payment_process_partner_include_address_country": {
+ "type": "boolean"
+ },
+ "include_payment_process_partner_include_address_state": {
+ "type": "boolean"
+ },
+ "include_payment_process_partner_include_address_street_address": {
+ "type": "boolean"
+ },
+ "include_payment_process_partner_include_address_zipcode": {
+ "type": "boolean"
+ },
+ "include_payment_process_partner_include_email": {
+ "format": "email",
+ "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "include_payment_process_partner_include_email_val": {
+ "type": "boolean"
+ },
+ "include_payment_schedule": {
+ "type": "boolean"
+ },
+ "include_payment_schedule_custom": {
+ "type": "boolean"
+ },
+ "include_payment_schedule_specified_amount": {
+ "type": "boolean"
+ },
+ "include_payment_schedule_specified_timeframe": {
+ "type": "boolean"
+ },
+ "include_payment_schedule_specified_unit": {
+ "type": "boolean"
+ },
+ "include_payment_schedule_type": {
+ "type": "boolean"
+ },
+ "negotiations_allowed": {
+ "type": "string"
+ },
+ "territory_type": {
+ "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": {
+ "type": "string"
+ },
+ "general_cap_amount": {
+ "type": "number"
+ },
+ "general_cap_amount_type": {
+ "type": "number"
+ },
+ "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": "boolean"
+ },
+ "include_dpa_type": {
+ "type": "boolean"
+ },
+ "include_payment_process": {
+ "type": "boolean"
+ },
+ "include_technical_support": {
+ "type": "boolean"
+ },
+ "negotiations_allowed": {
+ "type": "string"
+ },
+ "payment_process_automatic_frequency": {
+ "type": "string"
+ },
+ "payment_process_invoice_days": {
+ "type": "number"
+ },
+ "payment_process_invoice_from": {
+ "type": "string"
+ },
+ "payment_process_invoice_timeframe": {
+ "type": "string"
+ },
+ "payment_process_type": {
+ "type": "string"
+ },
+ "pilot_period_description": {
+ "type": "number"
+ },
+ "pilot_period_fees_description": {
+ "type": "number"
+ },
+ "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"
+ },
+ "default_signer_email": {
+ "format": "email",
+ "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "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": {
+ "type": "string"
+ },
+ "general_cap_amount": {
+ "type": "number"
+ },
+ "general_cap_amount_type": {
+ "type": "number"
+ },
+ "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": "boolean"
+ },
+ "include_additional_warranties_by_provider": {
+ "type": "boolean"
+ },
+ "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": "boolean"
+ },
+ "include_covered_claims_include_customer_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_include_provider_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_provider_claims": {
+ "type": "boolean"
+ },
+ "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": "boolean"
+ },
+ "include_customer_insurance_min_auto_liability_minimum": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_cyber_liability_aggregate": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_cyber_liability_minimum": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_employer_liability_aggregate": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_employer_liability_minimum": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_general_liability_aggregate": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_general_liability_minimum": {
+ "type": "boolean"
+ },
+ "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": "boolean"
+ },
+ "include_customer_policies_type": {
+ "type": "boolean"
+ },
+ "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": "boolean"
+ },
+ "include_dpa_type": {
+ "type": "boolean"
+ },
+ "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": "boolean"
+ },
+ "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": "boolean"
+ },
+ "include_provider_insurance_min_auto_liability_minimum": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_cyber_liability_aggregate": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_cyber_liability_minimum": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_employer_liability_aggregate": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_employer_liability_minimum": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_general_liability_aggregate": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_general_liability_minimum": {
+ "type": "boolean"
+ },
+ "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": {
+ "type": "boolean"
+ },
+ "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": "boolean"
+ },
+ "include_security_policy_iso27001": {
+ "type": "boolean"
+ },
+ "include_security_policy_location": {
+ "type": "boolean"
+ },
+ "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": {
+ "type": "boolean"
+ },
+ "include_terms": {
+ "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_negligence": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_other": {
+ "type": "boolean"
+ },
+ "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": {
+ "type": "number"
+ },
+ "negotiations_allowed": {
+ "type": "string"
+ },
+ "sender_last_to_sign": {
+ "type": "boolean"
+ }
+ },
+ "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,
+ "properties": {
+ "cost": {
+ "type": "number"
+ },
+ "description": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class discriminator.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "cost": {
+ "type": "number"
+ },
+ "description": {
+ "type": "string"
+ },
+ "discount_duration_amount": {
+ "type": "number"
+ },
+ "discount_duration_type": {
+ "type": "string"
+ },
+ "discount_type": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class discriminator.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "cost": {
+ "type": "number"
+ },
+ "description": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "quantity": {
+ "type": "number"
+ },
+ "stripe_product_id": {
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class discriminator.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "attachment_id": {
+ "type": "string"
+ },
+ "description": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class discriminator.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "description": {
+ "type": "string"
+ },
+ "fee_type": {
+ "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": {
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class discriminator.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "description": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class discriminator.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "cost": {
+ "type": "number"
+ },
+ "description": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class discriminator.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "cost": {
+ "type": "number"
+ },
+ "description": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class discriminator.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "description": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class discriminator.",
+ "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": "boolean"
+ },
+ "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": "boolean"
+ },
+ "include_deliverables_include_acceptance": {
+ "type": "boolean"
+ },
+ "include_deliverables_include_attachment": {
+ "type": "boolean"
+ },
+ "include_deliverables_include_draft_deliverables": {
+ "type": "boolean"
+ },
+ "include_deliverables_rejection_amount": {
+ "type": "boolean"
+ },
+ "include_deliverables_rejection_unit": {
+ "type": "boolean"
+ },
+ "include_deliverables_resubmission_amount": {
+ "type": "boolean"
+ },
+ "include_deliverables_resubmission_unit": {
+ "type": "boolean"
+ },
+ "include_fees_other": {
+ "type": "boolean"
+ },
+ "include_fees_other_val": {
+ "type": "boolean"
+ },
+ "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": {
+ "type": "boolean"
+ },
+ "include_fees_travel_val": {
+ "type": "boolean"
+ },
+ "include_third_party_customer": {
+ "type": "boolean"
+ },
+ "include_third_party_include_description": {
+ "type": "boolean"
+ },
+ "include_third_party_include_description_val": {
+ "type": "boolean"
+ },
+ "include_third_party_materials": {
+ "type": "boolean"
+ },
+ "include_third_party_provider": {
+ "type": "boolean"
+ },
+ "include_time_of_assignment": {
+ "type": "boolean"
+ },
+ "include_time_of_assignment_type": {
+ "type": "boolean"
+ },
+ "invoice_period_description": {
+ "type": "number"
+ },
+ "negotiations_allowed": {
+ "type": "string"
+ },
+ "payment_period": {
+ "type": "number"
+ },
+ "payment_period_other": {
+ "type": "number"
+ },
+ "payment_period_timeframe": {
+ "type": "number"
+ },
+ "payment_period_type": {
+ "type": "number"
+ },
+ "payment_period_unit": {
+ "type": "number"
+ },
+ "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": {
+ "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": {
+ "type": "string"
+ },
+ "sow_term_unit": {
+ "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-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-z]{2,}$",
+ "type": "string"
+ },
+ "recipient_organization": {
+ "type": "string"
+ },
+ "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-z]{2,}$",
+ "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": {
+ "type": "string"
+ },
+ "general_cap_amount": {
+ "type": "number"
+ },
+ "general_cap_amount_type": {
+ "type": "number"
+ },
+ "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": "boolean"
+ },
+ "include_additional_warranties_by_provider": {
+ "type": "boolean"
+ },
+ "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": "boolean"
+ },
+ "include_covered_claims_include_customer_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_include_provider_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_provider_claims": {
+ "type": "boolean"
+ },
+ "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": "boolean"
+ },
+ "include_dpa_type": {
+ "type": "boolean"
+ },
+ "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": "boolean"
+ },
+ "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": "boolean"
+ },
+ "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": {
+ "type": "number"
+ }
+ },
+ "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": "string"
+ },
+ "deletion_procedure_include_custom_description": {
+ "type": "string"
+ },
+ "deletion_procedure_include_customer_disable": {
+ "type": "string"
+ },
+ "deletion_procedure_include_customer_proof": {
+ "type": "string"
+ },
+ "deletion_procedure_include_provider_disable": {
+ "type": "string"
+ },
+ "fee_custom_unit": {
+ "type": "string"
+ },
+ "fee_period": {
+ "type": "number"
+ },
+ "fees_attributes": {
+ "additionalProperties": {
+ "anyOf": [
+ {
+ "additionalProperties": false,
+ "properties": {
+ "cost": {
+ "type": "number"
+ },
+ "description": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class discriminator.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "cost": {
+ "type": "number"
+ },
+ "description": {
+ "type": "string"
+ },
+ "discount_duration_amount": {
+ "type": "number"
+ },
+ "discount_duration_type": {
+ "type": "string"
+ },
+ "discount_type": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class discriminator.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "cost": {
+ "type": "number"
+ },
+ "description": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "quantity": {
+ "type": "number"
+ },
+ "stripe_product_id": {
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class discriminator.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "attachment_id": {
+ "type": "string"
+ },
+ "description": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class discriminator.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "description": {
+ "type": "string"
+ },
+ "fee_type": {
+ "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": {
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class discriminator.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "description": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class discriminator.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "cost": {
+ "type": "number"
+ },
+ "description": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class discriminator.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "cost": {
+ "type": "number"
+ },
+ "description": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class discriminator.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "description": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class discriminator.",
+ "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": {
+ "type": "string"
+ },
+ "fees_include_fee_increase_upon_renewal": {
+ "type": "number"
+ },
+ "fees_include_fee_increase_upon_renewal_fee": {
+ "type": "number"
+ },
+ "fees_include_fee_increase_upon_renewal_type": {
+ "type": "number"
+ },
+ "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": "boolean"
+ },
+ "include_license_limits": {
+ "type": "boolean"
+ },
+ "include_license_limits_description": {
+ "type": "boolean"
+ },
+ "include_payment_process_include_billing_email": {
+ "format": "email",
+ "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "include_pilot_period": {
+ "type": "boolean"
+ },
+ "include_pilot_period_duration_amount": {
+ "type": "boolean"
+ },
+ "include_pilot_period_duration_type": {
+ "type": "boolean"
+ },
+ "include_pilot_period_include_fees": {
+ "type": "boolean"
+ },
+ "include_pilot_period_include_fees_amount": {
+ "type": "boolean"
+ },
+ "include_pilot_period_include_modifications": {
+ "type": "boolean"
+ },
+ "include_pilot_period_include_modifications_description": {
+ "type": "boolean"
+ },
+ "include_services": {
+ "type": "boolean"
+ },
+ "include_services_description": {
+ "type": "boolean"
+ },
+ "negotiations_allowed": {
+ "type": "string"
+ },
+ "order_date_date": {
+ "type": "string"
+ },
+ "order_date_type": {
+ "type": "string"
+ },
+ "payment_process_automatic_frequency": {
+ "type": "string"
+ },
+ "payment_process_type": {
+ "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": {
+ "type": "string"
+ },
+ "payment_process_type_invoice_duration_start": {
+ "type": "string"
+ },
+ "payment_process_type_invoice_type": {
+ "type": "string"
+ },
+ "permitted_uses_include_custom": {
+ "type": "string"
+ },
+ "permitted_uses_include_custom_description": {
+ "type": "string"
+ },
+ "permitted_uses_include_customers_affiliates": {
+ "type": "string"
+ },
+ "permitted_uses_include_internal_business": {
+ "type": "string"
+ },
+ "pilot_period_stripe_product_id": {
+ "type": "number"
+ },
+ "software_description": {
+ "type": "string"
+ },
+ "subscription_auto_renew": {
+ "type": "string"
+ },
+ "subscription_period": {
+ "type": "number"
+ },
+ "subscription_period_unit": {
+ "type": "number"
+ },
+ "subscription_renewal_notice_days": {
+ "type": "number"
+ },
+ "warranty_period_description_amount": {
+ "type": "number"
+ },
+ "warranty_period_description_duration": {
+ "type": "number"
+ },
+ "warranty_period_description_duration_start": {
+ "type": "number"
+ },
+ "warranty_period_type": {
+ "type": "number"
+ }
+ },
+ "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-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-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": {
+ "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": "number"
+ },
+ "aggregation_limitations_permitted_val": {
+ "type": "number"
+ },
+ "breach_notification_unit": {
+ "type": "string"
+ },
+ "breach_notification_val": {
+ "type": "number"
+ },
+ "business_associate_relationship_type": {
+ "type": "string"
+ },
+ "deidentification_limitations_include_purpose": {
+ "type": "number"
+ },
+ "deidentification_limitations_include_requirements": {
+ "type": "number"
+ },
+ "deidentification_limitations_permitted": {
+ "type": "number"
+ },
+ "deidentification_limitations_purpose_val": {
+ "type": "number"
+ },
+ "deidentification_limitations_requirements_val": {
+ "type": "number"
+ },
+ "designated_record_set_provider_maintains": {
+ "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_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": "number"
+ },
+ "offshore_limitations_permitted_val": {
+ "type": "number"
+ },
+ "subcontract_limitations_include_notice": {
+ "type": "number"
+ },
+ "subcontract_limitations_include_permission": {
+ "type": "number"
+ },
+ "subcontract_limitations_notice_val": {
+ "type": "number"
+ },
+ "subcontract_limitations_permission_val": {
+ "type": "number"
+ },
+ "subcontract_limitations_permitted": {
+ "type": "number"
+ },
+ "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"
+ },
+ "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-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"
+ },
+ "default_signer_email": {
+ "format": "email",
+ "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "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": {
+ "type": "string"
+ },
+ "effective_date_type": {
+ "type": "string"
+ },
+ "general_cap_amount": {
+ "type": "number"
+ },
+ "general_cap_amount_type": {
+ "type": "number"
+ },
+ "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": "boolean"
+ },
+ "include_acceptable_use_policy_type": {
+ "type": "boolean"
+ },
+ "include_additional_warranties": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_by_customer": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_by_provider": {
+ "type": "boolean"
+ },
+ "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": "boolean"
+ },
+ "include_covered_claims_include_customer_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_include_provider_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_provider_claims": {
+ "type": "boolean"
+ },
+ "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": "boolean"
+ },
+ "include_dpa_type": {
+ "type": "boolean"
+ },
+ "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": "boolean"
+ },
+ "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": "boolean"
+ },
+ "include_insurance_minimums_cyber_liability_aggregate": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_cyber_liability_minimum": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_employer_liability_aggregate": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_employer_liability_minimum": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_general_liability_aggregate": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_general_liability_minimum": {
+ "type": "boolean"
+ },
+ "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": {
+ "type": "boolean"
+ },
+ "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": "boolean"
+ },
+ "include_security_policy_other": {
+ "type": "boolean"
+ },
+ "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": {
+ "type": "boolean"
+ },
+ "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_terms": {
+ "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": "boolean"
+ },
+ "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": {
+ "type": "number"
+ },
+ "negotiations_allowed": {
+ "type": "string"
+ },
+ "provider": {
+ "type": "string"
+ },
+ "sender_last_to_sign": {
+ "type": "boolean"
+ },
+ "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": "number"
+ },
+ "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": {
+ "type": "number"
+ },
+ "fees_attributes": {
+ "additionalProperties": {
+ "anyOf": [
+ {
+ "additionalProperties": false,
+ "properties": {
+ "cost": {
+ "type": "number"
+ },
+ "description": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class discriminator.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "cost": {
+ "type": "number"
+ },
+ "description": {
+ "type": "string"
+ },
+ "discount_duration_amount": {
+ "type": "number"
+ },
+ "discount_duration_type": {
+ "type": "string"
+ },
+ "discount_type": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class discriminator.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "cost": {
+ "type": "number"
+ },
+ "description": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "quantity": {
+ "type": "number"
+ },
+ "stripe_product_id": {
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class discriminator.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "attachment_id": {
+ "type": "string"
+ },
+ "description": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class discriminator.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "description": {
+ "type": "string"
+ },
+ "fee_type": {
+ "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": {
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class discriminator.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "description": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class discriminator.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "cost": {
+ "type": "number"
+ },
+ "description": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class discriminator.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "cost": {
+ "type": "number"
+ },
+ "description": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class discriminator.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "description": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class discriminator.",
+ "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": {
+ "type": "string"
+ },
+ "fees_include_fee_increase_upon_renewal": {
+ "type": "number"
+ },
+ "fees_include_fee_increase_upon_renewal_fee": {
+ "type": "number"
+ },
+ "fees_include_fee_increase_upon_renewal_type": {
+ "type": "number"
+ },
+ "fees_inclusive_of_taxes": {
+ "type": "boolean"
+ },
+ "framework_terms_type": {
+ "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": "boolean"
+ },
+ "include_fees_table": {
+ "type": "boolean"
+ },
+ "include_fees_table_period": {
+ "type": "boolean"
+ },
+ "include_free_trial": {
+ "type": "boolean"
+ },
+ "include_max_users": {
+ "type": "boolean"
+ },
+ "include_pilot_period": {
+ "type": "boolean"
+ },
+ "include_pilot_period_duration_amount": {
+ "type": "boolean"
+ },
+ "include_pilot_period_duration_type": {
+ "type": "boolean"
+ },
+ "include_pilot_period_include_fees": {
+ "type": "boolean"
+ },
+ "include_pilot_period_include_fees_amount": {
+ "type": "boolean"
+ },
+ "include_pilot_period_include_modifications": {
+ "type": "boolean"
+ },
+ "include_pilot_period_include_modifications_description": {
+ "type": "boolean"
+ },
+ "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": "boolean"
+ },
+ "include_product_support_type": {
+ "type": "boolean"
+ },
+ "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": "boolean"
+ },
+ "include_professional_services_description": {
+ "type": "boolean"
+ },
+ "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": "boolean"
+ },
+ "include_professional_services_include_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_include_fees_description": {
+ "type": "boolean"
+ },
+ "include_professional_services_type": {
+ "type": "boolean"
+ },
+ "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": "boolean"
+ },
+ "include_sla_include_response_time": {
+ "type": "boolean"
+ },
+ "include_sla_include_response_time_amount": {
+ "type": "boolean"
+ },
+ "include_sla_include_response_time_credit": {
+ "type": "boolean"
+ },
+ "include_sla_include_response_time_duration": {
+ "type": "boolean"
+ },
+ "include_sla_include_response_time_support_channel": {
+ "type": "boolean"
+ },
+ "include_sla_include_target_uptime": {
+ "type": "boolean"
+ },
+ "include_sla_maintenance_notice": {
+ "type": "boolean"
+ },
+ "include_sla_maintenance_window": {
+ "type": "boolean"
+ },
+ "include_sla_maintenance_window_type": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_notice_qty": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_notice_unit": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_end_time": {
+ "type": "boolean"
+ },
+ "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": "boolean"
+ },
+ "include_sla_standard_maintenance_window_sunday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_thursday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_time_zone": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_tuesday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_wednesday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_target_uptime": {
+ "type": "boolean"
+ },
+ "include_sla_type": {
+ "type": "boolean"
+ },
+ "include_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"
+ },
+ "include_subscription_start_date_date": {
+ "type": "boolean"
+ },
+ "include_usage_review": {
+ "type": "boolean"
+ },
+ "include_usage_review_val": {
+ "type": "boolean"
+ },
+ "include_use_limitations": {
+ "type": "boolean"
+ },
+ "include_use_limitations_val": {
+ "type": "boolean"
+ },
+ "invoice_period": {
+ "type": "number"
+ },
+ "invoice_period_custom_unit": {
+ "type": "number"
+ },
+ "max_consumption": {
+ "type": "number"
+ },
+ "max_users": {
+ "type": "number"
+ },
+ "negotiations_allowed": {
+ "type": "string"
+ },
+ "order_date_date": {
+ "type": "string"
+ },
+ "order_date_other": {
+ "type": "string"
+ },
+ "order_date_type": {
+ "type": "string"
+ },
+ "payment_period": {
+ "type": "number"
+ },
+ "payment_period_timeframe": {
+ "type": "number"
+ },
+ "payment_period_unit": {
+ "type": "number"
+ },
+ "payment_process_automatic_frequency": {
+ "type": "string"
+ },
+ "payment_process_type": {
+ "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": {
+ "type": "string"
+ },
+ "payment_process_type_invoice_duration_start": {
+ "type": "string"
+ },
+ "payment_process_type_invoice_type": {
+ "type": "string"
+ },
+ "pilot_period_stripe_product_id": {
+ "type": "number"
+ },
+ "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": {
+ "type": "string"
+ },
+ "subscription_period": {
+ "type": "number"
+ },
+ "subscription_period_unit": {
+ "type": "number"
+ },
+ "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": {
+ "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": "boolean"
+ },
+ "include_fees_description": {
+ "type": "boolean"
+ },
+ "include_fees_pay_by_amount": {
+ "type": "boolean"
+ },
+ "include_fees_type": {
+ "type": "boolean"
+ },
+ "include_fees_unit": {
+ "type": "boolean"
+ },
+ "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": "boolean"
+ },
+ "include_program_discount": {
+ "type": "boolean"
+ },
+ "include_program_discount_amount": {
+ "type": "boolean"
+ },
+ "include_program_discount_unit": {
+ "type": "boolean"
+ },
+ "include_program_participation_feedback": {
+ "type": "boolean"
+ },
+ "include_program_participation_feedback_amount": {
+ "type": "boolean"
+ },
+ "include_program_participation_feedback_unit": {
+ "type": "boolean"
+ },
+ "include_program_partner_other": {
+ "type": "boolean"
+ },
+ "include_program_partner_other_val": {
+ "type": "boolean"
+ },
+ "include_program_provider_other": {
+ "type": "boolean"
+ },
+ "include_program_provider_other_val": {
+ "type": "boolean"
+ },
+ "include_program_reference": {
+ "type": "boolean"
+ },
+ "product_description": {
+ "type": "string"
+ },
+ "term_amount": {
+ "type": "number"
+ },
+ "term_unit": {
+ "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.",
+ "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-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"
+ },
+ "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": "string"
+ },
+ "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": "string"
+ },
+ "confidentiality_nda_type": {
+ "type": "string"
+ },
+ "confidentiality_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"
+ },
+ "include_custom_details": {
+ "type": "boolean"
+ },
+ "include_custom_details_val": {
+ "type": "boolean"
+ },
+ "include_fees": {
+ "type": "boolean"
+ },
+ "include_fees_amount": {
+ "type": "boolean"
+ },
+ "include_fees_amount_duration": {
+ "type": "boolean"
+ },
+ "include_fees_include_amount": {
+ "type": "boolean"
+ },
+ "include_fees_include_other": {
+ "type": "boolean"
+ },
+ "include_fees_other": {
+ "type": "boolean"
+ },
+ "include_functionality": {
+ "type": "boolean"
+ },
+ "include_functionality_val": {
+ "type": "boolean"
+ },
+ "include_launch_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_launch_date_custom": {
+ "type": "boolean"
+ },
+ "include_launch_date_date": {
+ "type": "boolean"
+ },
+ "include_launch_date_type": {
+ "type": "boolean"
+ },
+ "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"
+ },
+ "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": {
+ "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": {
+ "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_include_company": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_include_company_val": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_include_partner": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_include_partner_val": {
+ "type": "boolean"
+ },
+ "include_brand_guidelines": {
+ "type": "boolean"
+ },
+ "include_brand_guidelines_include_company": {
+ "type": "boolean"
+ },
+ "include_brand_guidelines_include_company_val": {
+ "type": "boolean"
+ },
+ "include_brand_guidelines_include_partner": {
+ "type": "boolean"
+ },
+ "include_brand_guidelines_include_partner_val": {
+ "type": "boolean"
+ },
+ "include_covered_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_company_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_include_company_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_include_partner_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_partner_claims": {
+ "type": "boolean"
+ },
+ "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": "boolean"
+ },
+ "include_dpa_type": {
+ "type": "boolean"
+ },
+ "include_increased_cap_amount": {
+ "type": "boolean"
+ },
+ "include_increased_cap_amount_currency": {
+ "type": "boolean"
+ },
+ "include_increased_cap_amount_either_currency": {
+ "type": "boolean"
+ },
+ "include_increased_cap_amount_either_multiple": {
+ "type": "boolean"
+ },
+ "include_increased_cap_amount_multiple": {
+ "type": "boolean"
+ },
+ "include_increased_cap_amount_type": {
+ "type": "boolean"
+ },
+ "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": "boolean"
+ },
+ "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": "boolean"
+ },
+ "negotiations_allowed": {
+ "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": {
+ "type": "string"
+ },
+ "end_date_date": {
+ "type": "string"
+ },
+ "end_date_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"
+ },
+ "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": "boolean"
+ },
+ "include_obligations_company_promotion_include_materials": {
+ "type": "boolean"
+ },
+ "include_obligations_company_promotion_include_materials_val": {
+ "type": "boolean"
+ },
+ "include_obligations_company_referral": {
+ "type": "boolean"
+ },
+ "include_obligations_company_referral_include_criteria": {
+ "type": "boolean"
+ },
+ "include_obligations_company_referral_include_criteria_val": {
+ "type": "boolean"
+ },
+ "include_obligations_company_referral_include_pay_sch": {
+ "type": "boolean"
+ },
+ "include_obligations_company_referral_include_pay_sch_amount": {
+ "type": "boolean"
+ },
+ "include_obligations_company_referral_include_pay_sch_custom": {
+ "type": "boolean"
+ },
+ "include_obligations_company_referral_include_pay_sch_unit": {
+ "type": "boolean"
+ },
+ "include_obligations_company_sponsorship": {
+ "type": "boolean"
+ },
+ "include_obligations_company_sponsorship_include_benefits": {
+ "type": "boolean"
+ },
+ "include_obligations_company_sponsorship_include_benefits_val": {
+ "type": "boolean"
+ },
+ "include_obligations_company_sponsorship_include_payments": {
+ "type": "boolean"
+ },
+ "include_obligations_company_sponsorship_include_payments_amount": {
+ "type": "boolean"
+ },
+ "include_obligations_company_sponsorship_include_payments_unit": {
+ "type": "boolean"
+ },
+ "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": "boolean"
+ },
+ "include_obligations_partner_promotion_include_materials": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_promotion_include_materials_val": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_referral": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_referral_include_criteria": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_referral_include_criteria_val": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_referral_include_pay_sch": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_referral_include_pay_sch_amount": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_referral_include_pay_sch_custom": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_referral_include_pay_sch_unit": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_sponsorship": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_sponsorship_include_benefits": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_sponsorship_include_benefits_val": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_sponsorship_include_payments": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_sponsorship_include_payments_amount": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_sponsorship_include_payments_unit": {
+ "type": "boolean"
+ },
+ "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": "boolean"
+ },
+ "include_payment_process_company_include_address_country": {
+ "type": "boolean"
+ },
+ "include_payment_process_company_include_address_state": {
+ "type": "boolean"
+ },
+ "include_payment_process_company_include_address_street_address": {
+ "type": "boolean"
+ },
+ "include_payment_process_company_include_address_zipcode": {
+ "type": "boolean"
+ },
+ "include_payment_process_company_include_email": {
+ "format": "email",
+ "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "include_payment_process_company_include_email_val": {
+ "type": "boolean"
+ },
+ "include_payment_process_partner": {
+ "type": "boolean"
+ },
+ "include_payment_process_partner_include_address": {
+ "type": "boolean"
+ },
+ "include_payment_process_partner_include_address_city": {
+ "type": "boolean"
+ },
+ "include_payment_process_partner_include_address_country": {
+ "type": "boolean"
+ },
+ "include_payment_process_partner_include_address_state": {
+ "type": "boolean"
+ },
+ "include_payment_process_partner_include_address_street_address": {
+ "type": "boolean"
+ },
+ "include_payment_process_partner_include_address_zipcode": {
+ "type": "boolean"
+ },
+ "include_payment_process_partner_include_email": {
+ "format": "email",
+ "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "include_payment_process_partner_include_email_val": {
+ "type": "boolean"
+ },
+ "include_payment_schedule": {
+ "type": "boolean"
+ },
+ "include_payment_schedule_custom": {
+ "type": "boolean"
+ },
+ "include_payment_schedule_specified_amount": {
+ "type": "boolean"
+ },
+ "include_payment_schedule_specified_timeframe": {
+ "type": "boolean"
+ },
+ "include_payment_schedule_specified_unit": {
+ "type": "boolean"
+ },
+ "include_payment_schedule_type": {
+ "type": "boolean"
+ },
+ "negotiations_allowed": {
+ "type": "string"
+ },
+ "territory_type": {
+ "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": {
+ "type": "string"
+ },
+ "general_cap_amount": {
+ "type": "number"
+ },
+ "general_cap_amount_type": {
+ "type": "number"
+ },
+ "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": "boolean"
+ },
+ "include_dpa_type": {
+ "type": "boolean"
+ },
+ "include_payment_process": {
+ "type": "boolean"
+ },
+ "include_technical_support": {
+ "type": "boolean"
+ },
+ "negotiations_allowed": {
+ "type": "string"
+ },
+ "payment_process_automatic_frequency": {
+ "type": "string"
+ },
+ "payment_process_invoice_days": {
+ "type": "number"
+ },
+ "payment_process_invoice_from": {
+ "type": "string"
+ },
+ "payment_process_invoice_timeframe": {
+ "type": "string"
+ },
+ "payment_process_type": {
+ "type": "string"
+ },
+ "pilot_period_description": {
+ "type": "number"
+ },
+ "pilot_period_fees_description": {
+ "type": "number"
+ },
+ "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"
+ },
+ "default_signer_email": {
+ "format": "email",
+ "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "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": {
+ "type": "string"
+ },
+ "general_cap_amount": {
+ "type": "number"
+ },
+ "general_cap_amount_type": {
+ "type": "number"
+ },
+ "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": "boolean"
+ },
+ "include_additional_warranties_by_provider": {
+ "type": "boolean"
+ },
+ "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": "boolean"
+ },
+ "include_covered_claims_include_customer_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_include_provider_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_provider_claims": {
+ "type": "boolean"
+ },
+ "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": "boolean"
+ },
+ "include_customer_insurance_min_auto_liability_minimum": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_cyber_liability_aggregate": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_cyber_liability_minimum": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_employer_liability_aggregate": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_employer_liability_minimum": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_general_liability_aggregate": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_general_liability_minimum": {
+ "type": "boolean"
+ },
+ "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": "boolean"
+ },
+ "include_customer_policies_type": {
+ "type": "boolean"
+ },
+ "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": "boolean"
+ },
+ "include_dpa_type": {
+ "type": "boolean"
+ },
+ "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": "boolean"
+ },
+ "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": "boolean"
+ },
+ "include_provider_insurance_min_auto_liability_minimum": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_cyber_liability_aggregate": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_cyber_liability_minimum": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_employer_liability_aggregate": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_employer_liability_minimum": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_general_liability_aggregate": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_general_liability_minimum": {
+ "type": "boolean"
+ },
+ "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": {
+ "type": "boolean"
+ },
+ "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": "boolean"
+ },
+ "include_security_policy_iso27001": {
+ "type": "boolean"
+ },
+ "include_security_policy_location": {
+ "type": "boolean"
+ },
+ "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": {
+ "type": "boolean"
+ },
+ "include_terms": {
+ "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_negligence": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_other": {
+ "type": "boolean"
+ },
+ "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": {
+ "type": "number"
+ },
+ "negotiations_allowed": {
+ "type": "string"
+ },
+ "sender_last_to_sign": {
+ "type": "boolean"
+ }
+ },
+ "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,
+ "properties": {
+ "cost": {
+ "type": "number"
+ },
+ "description": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class discriminator.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "cost": {
+ "type": "number"
+ },
+ "description": {
+ "type": "string"
+ },
+ "discount_duration_amount": {
+ "type": "number"
+ },
+ "discount_duration_type": {
+ "type": "string"
+ },
+ "discount_type": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class discriminator.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "cost": {
+ "type": "number"
+ },
+ "description": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "quantity": {
+ "type": "number"
+ },
+ "stripe_product_id": {
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class discriminator.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "attachment_id": {
+ "type": "string"
+ },
+ "description": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class discriminator.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "description": {
+ "type": "string"
+ },
+ "fee_type": {
+ "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": {
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class discriminator.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "description": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class discriminator.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "cost": {
+ "type": "number"
+ },
+ "description": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class discriminator.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "cost": {
+ "type": "number"
+ },
+ "description": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class discriminator.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "description": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class discriminator.",
+ "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": "boolean"
+ },
+ "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": "boolean"
+ },
+ "include_deliverables_include_acceptance": {
+ "type": "boolean"
+ },
+ "include_deliverables_include_attachment": {
+ "type": "boolean"
+ },
+ "include_deliverables_include_draft_deliverables": {
+ "type": "boolean"
+ },
+ "include_deliverables_rejection_amount": {
+ "type": "boolean"
+ },
+ "include_deliverables_rejection_unit": {
+ "type": "boolean"
+ },
+ "include_deliverables_resubmission_amount": {
+ "type": "boolean"
+ },
+ "include_deliverables_resubmission_unit": {
+ "type": "boolean"
+ },
+ "include_fees_other": {
+ "type": "boolean"
+ },
+ "include_fees_other_val": {
+ "type": "boolean"
+ },
+ "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": {
+ "type": "boolean"
+ },
+ "include_fees_travel_val": {
+ "type": "boolean"
+ },
+ "include_third_party_customer": {
+ "type": "boolean"
+ },
+ "include_third_party_include_description": {
+ "type": "boolean"
+ },
+ "include_third_party_include_description_val": {
+ "type": "boolean"
+ },
+ "include_third_party_materials": {
+ "type": "boolean"
+ },
+ "include_third_party_provider": {
+ "type": "boolean"
+ },
+ "include_time_of_assignment": {
+ "type": "boolean"
+ },
+ "include_time_of_assignment_type": {
+ "type": "boolean"
+ },
+ "invoice_period_description": {
+ "type": "number"
+ },
+ "negotiations_allowed": {
+ "type": "string"
+ },
+ "payment_period": {
+ "type": "number"
+ },
+ "payment_period_other": {
+ "type": "number"
+ },
+ "payment_period_timeframe": {
+ "type": "number"
+ },
+ "payment_period_type": {
+ "type": "number"
+ },
+ "payment_period_unit": {
+ "type": "number"
+ },
+ "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": {
+ "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": {
+ "type": "string"
+ },
+ "sow_term_unit": {
+ "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-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-z]{2,}$",
+ "type": "string"
+ },
+ "recipient_organization": {
+ "type": "string"
+ },
+ "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-z]{2,}$",
+ "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": {
+ "type": "string"
+ },
+ "general_cap_amount": {
+ "type": "number"
+ },
+ "general_cap_amount_type": {
+ "type": "number"
+ },
+ "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": "boolean"
+ },
+ "include_additional_warranties_by_provider": {
+ "type": "boolean"
+ },
+ "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": "boolean"
+ },
+ "include_covered_claims_include_customer_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_include_provider_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_provider_claims": {
+ "type": "boolean"
+ },
+ "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": "boolean"
+ },
+ "include_dpa_type": {
+ "type": "boolean"
+ },
+ "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": "boolean"
+ },
+ "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": "boolean"
+ },
+ "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": {
+ "type": "number"
+ }
+ },
+ "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": "string"
+ },
+ "deletion_procedure_include_custom_description": {
+ "type": "string"
+ },
+ "deletion_procedure_include_customer_disable": {
+ "type": "string"
+ },
+ "deletion_procedure_include_customer_proof": {
+ "type": "string"
+ },
+ "deletion_procedure_include_provider_disable": {
+ "type": "string"
+ },
+ "fee_custom_unit": {
+ "type": "string"
+ },
+ "fee_period": {
+ "type": "number"
+ },
+ "fees_attributes": {
+ "additionalProperties": {
+ "anyOf": [
+ {
+ "additionalProperties": false,
+ "properties": {
+ "cost": {
+ "type": "number"
+ },
+ "description": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class discriminator.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "cost": {
+ "type": "number"
+ },
+ "description": {
+ "type": "string"
+ },
+ "discount_duration_amount": {
+ "type": "number"
+ },
+ "discount_duration_type": {
+ "type": "string"
+ },
+ "discount_type": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class discriminator.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "cost": {
+ "type": "number"
+ },
+ "description": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "quantity": {
+ "type": "number"
+ },
+ "stripe_product_id": {
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class discriminator.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "attachment_id": {
+ "type": "string"
+ },
+ "description": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class discriminator.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "description": {
+ "type": "string"
+ },
+ "fee_type": {
+ "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": {
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class discriminator.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "description": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class discriminator.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "cost": {
+ "type": "number"
+ },
+ "description": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class discriminator.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "cost": {
+ "type": "number"
+ },
+ "description": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class discriminator.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "description": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class discriminator.",
+ "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": {
+ "type": "string"
+ },
+ "fees_include_fee_increase_upon_renewal": {
+ "type": "number"
+ },
+ "fees_include_fee_increase_upon_renewal_fee": {
+ "type": "number"
+ },
+ "fees_include_fee_increase_upon_renewal_type": {
+ "type": "number"
+ },
+ "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": "boolean"
+ },
+ "include_license_limits": {
+ "type": "boolean"
+ },
+ "include_license_limits_description": {
+ "type": "boolean"
+ },
+ "include_payment_process_include_billing_email": {
+ "format": "email",
+ "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "include_pilot_period": {
+ "type": "boolean"
+ },
+ "include_pilot_period_duration_amount": {
+ "type": "boolean"
+ },
+ "include_pilot_period_duration_type": {
+ "type": "boolean"
+ },
+ "include_pilot_period_include_fees": {
+ "type": "boolean"
+ },
+ "include_pilot_period_include_fees_amount": {
+ "type": "boolean"
+ },
+ "include_pilot_period_include_modifications": {
+ "type": "boolean"
+ },
+ "include_pilot_period_include_modifications_description": {
+ "type": "boolean"
+ },
+ "include_services": {
+ "type": "boolean"
+ },
+ "include_services_description": {
+ "type": "boolean"
+ },
+ "negotiations_allowed": {
+ "type": "string"
+ },
+ "order_date_date": {
+ "type": "string"
+ },
+ "order_date_type": {
+ "type": "string"
+ },
+ "payment_process_automatic_frequency": {
+ "type": "string"
+ },
+ "payment_process_type": {
+ "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": {
+ "type": "string"
+ },
+ "payment_process_type_invoice_duration_start": {
+ "type": "string"
+ },
+ "payment_process_type_invoice_type": {
+ "type": "string"
+ },
+ "permitted_uses_include_custom": {
+ "type": "string"
+ },
+ "permitted_uses_include_custom_description": {
+ "type": "string"
+ },
+ "permitted_uses_include_customers_affiliates": {
+ "type": "string"
+ },
+ "permitted_uses_include_internal_business": {
+ "type": "string"
+ },
+ "pilot_period_stripe_product_id": {
+ "type": "number"
+ },
+ "software_description": {
+ "type": "string"
+ },
+ "subscription_auto_renew": {
+ "type": "string"
+ },
+ "subscription_period": {
+ "type": "number"
+ },
+ "subscription_period_unit": {
+ "type": "number"
+ },
+ "subscription_renewal_notice_days": {
+ "type": "number"
+ },
+ "warranty_period_description_amount": {
+ "type": "number"
+ },
+ "warranty_period_description_duration": {
+ "type": "number"
+ },
+ "warranty_period_description_duration_start": {
+ "type": "number"
+ },
+ "warranty_period_type": {
+ "type": "number"
+ }
+ },
+ "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-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": {
+ "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": "number"
+ },
+ "aggregation_limitations_permitted_val": {
+ "type": "number"
+ },
+ "breach_notification_unit": {
+ "type": "string"
+ },
+ "breach_notification_val": {
+ "type": "number"
+ },
+ "business_associate_relationship_type": {
+ "type": "string"
+ },
+ "deidentification_limitations_include_purpose": {
+ "type": "number"
+ },
+ "deidentification_limitations_include_requirements": {
+ "type": "number"
+ },
+ "deidentification_limitations_permitted": {
+ "type": "number"
+ },
+ "deidentification_limitations_purpose_val": {
+ "type": "number"
+ },
+ "deidentification_limitations_requirements_val": {
+ "type": "number"
+ },
+ "designated_record_set_provider_maintains": {
+ "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_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": "number"
+ },
+ "offshore_limitations_permitted_val": {
+ "type": "number"
+ },
+ "subcontract_limitations_include_notice": {
+ "type": "number"
+ },
+ "subcontract_limitations_include_permission": {
+ "type": "number"
+ },
+ "subcontract_limitations_notice_val": {
+ "type": "number"
+ },
+ "subcontract_limitations_permission_val": {
+ "type": "number"
+ },
+ "subcontract_limitations_permitted": {
+ "type": "number"
+ },
+ "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"
+ },
+ "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-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"
+ },
+ "default_signer_email": {
+ "format": "email",
+ "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "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": {
+ "type": "string"
+ },
+ "effective_date_type": {
+ "type": "string"
+ },
+ "general_cap_amount": {
+ "type": "number"
+ },
+ "general_cap_amount_type": {
+ "type": "number"
+ },
+ "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": "boolean"
+ },
+ "include_acceptable_use_policy_type": {
+ "type": "boolean"
+ },
+ "include_additional_warranties": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_by_customer": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_by_provider": {
+ "type": "boolean"
+ },
+ "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": "boolean"
+ },
+ "include_covered_claims_include_customer_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_include_provider_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_provider_claims": {
+ "type": "boolean"
+ },
+ "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": "boolean"
+ },
+ "include_dpa_type": {
+ "type": "boolean"
+ },
+ "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": "boolean"
+ },
+ "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": "boolean"
+ },
+ "include_insurance_minimums_cyber_liability_aggregate": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_cyber_liability_minimum": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_employer_liability_aggregate": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_employer_liability_minimum": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_general_liability_aggregate": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_general_liability_minimum": {
+ "type": "boolean"
+ },
+ "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": {
+ "type": "boolean"
+ },
+ "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": "boolean"
+ },
+ "include_security_policy_other": {
+ "type": "boolean"
+ },
+ "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": {
+ "type": "boolean"
+ },
+ "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_terms": {
+ "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": "boolean"
+ },
+ "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": {
+ "type": "number"
+ },
+ "negotiations_allowed": {
+ "type": "string"
+ },
+ "provider": {
+ "type": "string"
+ },
+ "sender_last_to_sign": {
+ "type": "boolean"
+ },
+ "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": "number"
+ },
+ "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": {
+ "type": "number"
+ },
+ "fees_attributes": {
+ "additionalProperties": {
+ "anyOf": [
+ {
+ "additionalProperties": false,
+ "properties": {
+ "cost": {
+ "type": "number"
+ },
+ "description": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class discriminator.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "cost": {
+ "type": "number"
+ },
+ "description": {
+ "type": "string"
+ },
+ "discount_duration_amount": {
+ "type": "number"
+ },
+ "discount_duration_type": {
+ "type": "string"
+ },
+ "discount_type": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class discriminator.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "cost": {
+ "type": "number"
+ },
+ "description": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "quantity": {
+ "type": "number"
+ },
+ "stripe_product_id": {
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class discriminator.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "attachment_id": {
+ "type": "string"
+ },
+ "description": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class discriminator.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "description": {
+ "type": "string"
+ },
+ "fee_type": {
+ "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": {
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class discriminator.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "description": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class discriminator.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "cost": {
+ "type": "number"
+ },
+ "description": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class discriminator.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "cost": {
+ "type": "number"
+ },
+ "description": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class discriminator.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "description": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class discriminator.",
+ "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": {
+ "type": "string"
+ },
+ "fees_include_fee_increase_upon_renewal": {
+ "type": "number"
+ },
+ "fees_include_fee_increase_upon_renewal_fee": {
+ "type": "number"
+ },
+ "fees_include_fee_increase_upon_renewal_type": {
+ "type": "number"
+ },
+ "fees_inclusive_of_taxes": {
+ "type": "boolean"
+ },
+ "framework_terms_type": {
+ "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": "boolean"
+ },
+ "include_fees_table": {
+ "type": "boolean"
+ },
+ "include_fees_table_period": {
+ "type": "boolean"
+ },
+ "include_free_trial": {
+ "type": "boolean"
+ },
+ "include_max_users": {
+ "type": "boolean"
+ },
+ "include_pilot_period": {
+ "type": "boolean"
+ },
+ "include_pilot_period_duration_amount": {
+ "type": "boolean"
+ },
+ "include_pilot_period_duration_type": {
+ "type": "boolean"
+ },
+ "include_pilot_period_include_fees": {
+ "type": "boolean"
+ },
+ "include_pilot_period_include_fees_amount": {
+ "type": "boolean"
+ },
+ "include_pilot_period_include_modifications": {
+ "type": "boolean"
+ },
+ "include_pilot_period_include_modifications_description": {
+ "type": "boolean"
+ },
+ "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": "boolean"
+ },
+ "include_product_support_type": {
+ "type": "boolean"
+ },
+ "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": "boolean"
+ },
+ "include_professional_services_description": {
+ "type": "boolean"
+ },
+ "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": "boolean"
+ },
+ "include_professional_services_include_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_include_fees_description": {
+ "type": "boolean"
+ },
+ "include_professional_services_type": {
+ "type": "boolean"
+ },
+ "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": "boolean"
+ },
+ "include_sla_include_response_time": {
+ "type": "boolean"
+ },
+ "include_sla_include_response_time_amount": {
+ "type": "boolean"
+ },
+ "include_sla_include_response_time_credit": {
+ "type": "boolean"
+ },
+ "include_sla_include_response_time_duration": {
+ "type": "boolean"
+ },
+ "include_sla_include_response_time_support_channel": {
+ "type": "boolean"
+ },
+ "include_sla_include_target_uptime": {
+ "type": "boolean"
+ },
+ "include_sla_maintenance_notice": {
+ "type": "boolean"
+ },
+ "include_sla_maintenance_window": {
+ "type": "boolean"
+ },
+ "include_sla_maintenance_window_type": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_notice_qty": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_notice_unit": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_end_time": {
+ "type": "boolean"
+ },
+ "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": "boolean"
+ },
+ "include_sla_standard_maintenance_window_sunday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_thursday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_time_zone": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_tuesday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_wednesday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_target_uptime": {
+ "type": "boolean"
+ },
+ "include_sla_type": {
+ "type": "boolean"
+ },
+ "include_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"
+ },
+ "include_subscription_start_date_date": {
+ "type": "boolean"
+ },
+ "include_usage_review": {
+ "type": "boolean"
+ },
+ "include_usage_review_val": {
+ "type": "boolean"
+ },
+ "include_use_limitations": {
+ "type": "boolean"
+ },
+ "include_use_limitations_val": {
+ "type": "boolean"
+ },
+ "invoice_period": {
+ "type": "number"
+ },
+ "invoice_period_custom_unit": {
+ "type": "number"
+ },
+ "max_consumption": {
+ "type": "number"
+ },
+ "max_users": {
+ "type": "number"
+ },
+ "negotiations_allowed": {
+ "type": "string"
+ },
+ "order_date_date": {
+ "type": "string"
+ },
+ "order_date_other": {
+ "type": "string"
+ },
+ "order_date_type": {
+ "type": "string"
+ },
+ "payment_period": {
+ "type": "number"
+ },
+ "payment_period_timeframe": {
+ "type": "number"
+ },
+ "payment_period_unit": {
+ "type": "number"
+ },
+ "payment_process_automatic_frequency": {
+ "type": "string"
+ },
+ "payment_process_type": {
+ "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": {
+ "type": "string"
+ },
+ "payment_process_type_invoice_duration_start": {
+ "type": "string"
+ },
+ "payment_process_type_invoice_type": {
+ "type": "string"
+ },
+ "pilot_period_stripe_product_id": {
+ "type": "number"
+ },
+ "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": {
+ "type": "string"
+ },
+ "subscription_period": {
+ "type": "number"
+ },
+ "subscription_period_unit": {
+ "type": "number"
+ },
+ "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": {
+ "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": "boolean"
+ },
+ "include_fees_description": {
+ "type": "boolean"
+ },
+ "include_fees_pay_by_amount": {
+ "type": "boolean"
+ },
+ "include_fees_type": {
+ "type": "boolean"
+ },
+ "include_fees_unit": {
+ "type": "boolean"
+ },
+ "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": "boolean"
+ },
+ "include_program_discount": {
+ "type": "boolean"
+ },
+ "include_program_discount_amount": {
+ "type": "boolean"
+ },
+ "include_program_discount_unit": {
+ "type": "boolean"
+ },
+ "include_program_participation_feedback": {
+ "type": "boolean"
+ },
+ "include_program_participation_feedback_amount": {
+ "type": "boolean"
+ },
+ "include_program_participation_feedback_unit": {
+ "type": "boolean"
+ },
+ "include_program_partner_other": {
+ "type": "boolean"
+ },
+ "include_program_partner_other_val": {
+ "type": "boolean"
+ },
+ "include_program_provider_other": {
+ "type": "boolean"
+ },
+ "include_program_provider_other_val": {
+ "type": "boolean"
+ },
+ "include_program_reference": {
+ "type": "boolean"
+ },
+ "product_description": {
+ "type": "string"
+ },
+ "term_amount": {
+ "type": "number"
+ },
+ "term_unit": {
+ "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.",
+ "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-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"
+ },
+ "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": "string"
+ },
+ "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": "string"
+ },
+ "confidentiality_nda_type": {
+ "type": "string"
+ },
+ "confidentiality_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"
+ },
+ "include_custom_details": {
+ "type": "boolean"
+ },
+ "include_custom_details_val": {
+ "type": "boolean"
+ },
+ "include_fees": {
+ "type": "boolean"
+ },
+ "include_fees_amount": {
+ "type": "boolean"
+ },
+ "include_fees_amount_duration": {
+ "type": "boolean"
+ },
+ "include_fees_include_amount": {
+ "type": "boolean"
+ },
+ "include_fees_include_other": {
+ "type": "boolean"
+ },
+ "include_fees_other": {
+ "type": "boolean"
+ },
+ "include_functionality": {
+ "type": "boolean"
+ },
+ "include_functionality_val": {
+ "type": "boolean"
+ },
+ "include_launch_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_launch_date_custom": {
+ "type": "boolean"
+ },
+ "include_launch_date_date": {
+ "type": "boolean"
+ },
+ "include_launch_date_type": {
+ "type": "boolean"
+ },
+ "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"
+ },
+ "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": {
+ "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": {
+ "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_include_company": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_include_company_val": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_include_partner": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_include_partner_val": {
+ "type": "boolean"
+ },
+ "include_brand_guidelines": {
+ "type": "boolean"
+ },
+ "include_brand_guidelines_include_company": {
+ "type": "boolean"
+ },
+ "include_brand_guidelines_include_company_val": {
+ "type": "boolean"
+ },
+ "include_brand_guidelines_include_partner": {
+ "type": "boolean"
+ },
+ "include_brand_guidelines_include_partner_val": {
+ "type": "boolean"
+ },
+ "include_covered_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_company_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_include_company_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_include_partner_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_partner_claims": {
+ "type": "boolean"
+ },
+ "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": "boolean"
+ },
+ "include_dpa_type": {
+ "type": "boolean"
+ },
+ "include_increased_cap_amount": {
+ "type": "boolean"
+ },
+ "include_increased_cap_amount_currency": {
+ "type": "boolean"
+ },
+ "include_increased_cap_amount_either_currency": {
+ "type": "boolean"
+ },
+ "include_increased_cap_amount_either_multiple": {
+ "type": "boolean"
+ },
+ "include_increased_cap_amount_multiple": {
+ "type": "boolean"
+ },
+ "include_increased_cap_amount_type": {
+ "type": "boolean"
+ },
+ "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": "boolean"
+ },
+ "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": "boolean"
+ },
+ "negotiations_allowed": {
+ "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": {
+ "type": "string"
+ },
+ "end_date_date": {
+ "type": "string"
+ },
+ "end_date_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"
+ },
+ "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": "boolean"
+ },
+ "include_obligations_company_promotion_include_materials": {
+ "type": "boolean"
+ },
+ "include_obligations_company_promotion_include_materials_val": {
+ "type": "boolean"
+ },
+ "include_obligations_company_referral": {
+ "type": "boolean"
+ },
+ "include_obligations_company_referral_include_criteria": {
+ "type": "boolean"
+ },
+ "include_obligations_company_referral_include_criteria_val": {
+ "type": "boolean"
+ },
+ "include_obligations_company_referral_include_pay_sch": {
+ "type": "boolean"
+ },
+ "include_obligations_company_referral_include_pay_sch_amount": {
+ "type": "boolean"
+ },
+ "include_obligations_company_referral_include_pay_sch_custom": {
+ "type": "boolean"
+ },
+ "include_obligations_company_referral_include_pay_sch_unit": {
+ "type": "boolean"
+ },
+ "include_obligations_company_sponsorship": {
+ "type": "boolean"
+ },
+ "include_obligations_company_sponsorship_include_benefits": {
+ "type": "boolean"
+ },
+ "include_obligations_company_sponsorship_include_benefits_val": {
+ "type": "boolean"
+ },
+ "include_obligations_company_sponsorship_include_payments": {
+ "type": "boolean"
+ },
+ "include_obligations_company_sponsorship_include_payments_amount": {
+ "type": "boolean"
+ },
+ "include_obligations_company_sponsorship_include_payments_unit": {
+ "type": "boolean"
+ },
+ "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": "boolean"
+ },
+ "include_obligations_partner_promotion_include_materials": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_promotion_include_materials_val": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_referral": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_referral_include_criteria": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_referral_include_criteria_val": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_referral_include_pay_sch": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_referral_include_pay_sch_amount": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_referral_include_pay_sch_custom": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_referral_include_pay_sch_unit": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_sponsorship": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_sponsorship_include_benefits": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_sponsorship_include_benefits_val": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_sponsorship_include_payments": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_sponsorship_include_payments_amount": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_sponsorship_include_payments_unit": {
+ "type": "boolean"
+ },
+ "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": "boolean"
+ },
+ "include_payment_process_company_include_address_country": {
+ "type": "boolean"
+ },
+ "include_payment_process_company_include_address_state": {
+ "type": "boolean"
+ },
+ "include_payment_process_company_include_address_street_address": {
+ "type": "boolean"
+ },
+ "include_payment_process_company_include_address_zipcode": {
+ "type": "boolean"
+ },
+ "include_payment_process_company_include_email": {
+ "format": "email",
+ "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "include_payment_process_company_include_email_val": {
+ "type": "boolean"
+ },
+ "include_payment_process_partner": {
+ "type": "boolean"
+ },
+ "include_payment_process_partner_include_address": {
+ "type": "boolean"
+ },
+ "include_payment_process_partner_include_address_city": {
+ "type": "boolean"
+ },
+ "include_payment_process_partner_include_address_country": {
+ "type": "boolean"
+ },
+ "include_payment_process_partner_include_address_state": {
+ "type": "boolean"
+ },
+ "include_payment_process_partner_include_address_street_address": {
+ "type": "boolean"
+ },
+ "include_payment_process_partner_include_address_zipcode": {
+ "type": "boolean"
+ },
+ "include_payment_process_partner_include_email": {
+ "format": "email",
+ "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "include_payment_process_partner_include_email_val": {
+ "type": "boolean"
+ },
+ "include_payment_schedule": {
+ "type": "boolean"
+ },
+ "include_payment_schedule_custom": {
+ "type": "boolean"
+ },
+ "include_payment_schedule_specified_amount": {
+ "type": "boolean"
+ },
+ "include_payment_schedule_specified_timeframe": {
+ "type": "boolean"
+ },
+ "include_payment_schedule_specified_unit": {
+ "type": "boolean"
+ },
+ "include_payment_schedule_type": {
+ "type": "boolean"
+ },
+ "negotiations_allowed": {
+ "type": "string"
+ },
+ "territory_type": {
+ "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": {
+ "type": "string"
+ },
+ "general_cap_amount": {
+ "type": "number"
+ },
+ "general_cap_amount_type": {
+ "type": "number"
+ },
+ "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": "boolean"
+ },
+ "include_dpa_type": {
+ "type": "boolean"
+ },
+ "include_payment_process": {
+ "type": "boolean"
+ },
+ "include_technical_support": {
+ "type": "boolean"
+ },
+ "negotiations_allowed": {
+ "type": "string"
+ },
+ "payment_process_automatic_frequency": {
+ "type": "string"
+ },
+ "payment_process_invoice_days": {
+ "type": "number"
+ },
+ "payment_process_invoice_from": {
+ "type": "string"
+ },
+ "payment_process_invoice_timeframe": {
+ "type": "string"
+ },
+ "payment_process_type": {
+ "type": "string"
+ },
+ "pilot_period_description": {
+ "type": "number"
+ },
+ "pilot_period_fees_description": {
+ "type": "number"
+ },
+ "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"
+ },
+ "default_signer_email": {
+ "format": "email",
+ "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "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": {
+ "type": "string"
+ },
+ "general_cap_amount": {
+ "type": "number"
+ },
+ "general_cap_amount_type": {
+ "type": "number"
+ },
+ "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": "boolean"
+ },
+ "include_additional_warranties_by_provider": {
+ "type": "boolean"
+ },
+ "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": "boolean"
+ },
+ "include_covered_claims_include_customer_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_include_provider_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_provider_claims": {
+ "type": "boolean"
+ },
+ "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": "boolean"
+ },
+ "include_customer_insurance_min_auto_liability_minimum": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_cyber_liability_aggregate": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_cyber_liability_minimum": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_employer_liability_aggregate": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_employer_liability_minimum": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_general_liability_aggregate": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_general_liability_minimum": {
+ "type": "boolean"
+ },
+ "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": "boolean"
+ },
+ "include_customer_policies_type": {
+ "type": "boolean"
+ },
+ "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": "boolean"
+ },
+ "include_dpa_type": {
+ "type": "boolean"
+ },
+ "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": "boolean"
+ },
+ "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": "boolean"
+ },
+ "include_provider_insurance_min_auto_liability_minimum": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_cyber_liability_aggregate": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_cyber_liability_minimum": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_employer_liability_aggregate": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_employer_liability_minimum": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_general_liability_aggregate": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_general_liability_minimum": {
+ "type": "boolean"
+ },
+ "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": {
+ "type": "boolean"
+ },
+ "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": "boolean"
+ },
+ "include_security_policy_iso27001": {
+ "type": "boolean"
+ },
+ "include_security_policy_location": {
+ "type": "boolean"
+ },
+ "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": {
+ "type": "boolean"
+ },
+ "include_terms": {
+ "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_negligence": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_other": {
+ "type": "boolean"
+ },
+ "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": {
+ "type": "number"
+ },
+ "negotiations_allowed": {
+ "type": "string"
+ },
+ "sender_last_to_sign": {
+ "type": "boolean"
+ }
+ },
+ "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,
+ "properties": {
+ "cost": {
+ "type": "number"
+ },
+ "description": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class discriminator.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "cost": {
+ "type": "number"
+ },
+ "description": {
+ "type": "string"
+ },
+ "discount_duration_amount": {
+ "type": "number"
+ },
+ "discount_duration_type": {
+ "type": "string"
+ },
+ "discount_type": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class discriminator.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "cost": {
+ "type": "number"
+ },
+ "description": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "quantity": {
+ "type": "number"
+ },
+ "stripe_product_id": {
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class discriminator.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "attachment_id": {
+ "type": "string"
+ },
+ "description": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class discriminator.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "description": {
+ "type": "string"
+ },
+ "fee_type": {
+ "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": {
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class discriminator.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "description": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class discriminator.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "cost": {
+ "type": "number"
+ },
+ "description": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class discriminator.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "cost": {
+ "type": "number"
+ },
+ "description": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class discriminator.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "description": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class discriminator.",
+ "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": "boolean"
+ },
+ "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": "boolean"
+ },
+ "include_deliverables_include_acceptance": {
+ "type": "boolean"
+ },
+ "include_deliverables_include_attachment": {
+ "type": "boolean"
+ },
+ "include_deliverables_include_draft_deliverables": {
+ "type": "boolean"
+ },
+ "include_deliverables_rejection_amount": {
+ "type": "boolean"
+ },
+ "include_deliverables_rejection_unit": {
+ "type": "boolean"
+ },
+ "include_deliverables_resubmission_amount": {
+ "type": "boolean"
+ },
+ "include_deliverables_resubmission_unit": {
+ "type": "boolean"
+ },
+ "include_fees_other": {
+ "type": "boolean"
+ },
+ "include_fees_other_val": {
+ "type": "boolean"
+ },
+ "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": {
+ "type": "boolean"
+ },
+ "include_fees_travel_val": {
+ "type": "boolean"
+ },
+ "include_third_party_customer": {
+ "type": "boolean"
+ },
+ "include_third_party_include_description": {
+ "type": "boolean"
+ },
+ "include_third_party_include_description_val": {
+ "type": "boolean"
+ },
+ "include_third_party_materials": {
+ "type": "boolean"
+ },
+ "include_third_party_provider": {
+ "type": "boolean"
+ },
+ "include_time_of_assignment": {
+ "type": "boolean"
+ },
+ "include_time_of_assignment_type": {
+ "type": "boolean"
+ },
+ "invoice_period_description": {
+ "type": "number"
+ },
+ "negotiations_allowed": {
+ "type": "string"
+ },
+ "payment_period": {
+ "type": "number"
+ },
+ "payment_period_other": {
+ "type": "number"
+ },
+ "payment_period_timeframe": {
+ "type": "number"
+ },
+ "payment_period_type": {
+ "type": "number"
+ },
+ "payment_period_unit": {
+ "type": "number"
+ },
+ "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": {
+ "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": {
+ "type": "string"
+ },
+ "sow_term_unit": {
+ "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-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-z]{2,}$",
+ "type": "string"
+ },
+ "recipient_organization": {
+ "type": "string"
+ },
+ "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-z]{2,}$",
+ "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": {
+ "type": "string"
+ },
+ "general_cap_amount": {
+ "type": "number"
+ },
+ "general_cap_amount_type": {
+ "type": "number"
+ },
+ "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": "boolean"
+ },
+ "include_additional_warranties_by_provider": {
+ "type": "boolean"
+ },
+ "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": "boolean"
+ },
+ "include_covered_claims_include_customer_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_include_provider_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_provider_claims": {
+ "type": "boolean"
+ },
+ "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": "boolean"
+ },
+ "include_dpa_type": {
+ "type": "boolean"
+ },
+ "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": "boolean"
+ },
+ "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": "boolean"
+ },
+ "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": {
+ "type": "number"
+ }
+ },
+ "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": "string"
+ },
+ "deletion_procedure_include_custom_description": {
+ "type": "string"
+ },
+ "deletion_procedure_include_customer_disable": {
+ "type": "string"
+ },
+ "deletion_procedure_include_customer_proof": {
+ "type": "string"
+ },
+ "deletion_procedure_include_provider_disable": {
+ "type": "string"
+ },
+ "fee_custom_unit": {
+ "type": "string"
+ },
+ "fee_period": {
+ "type": "number"
+ },
+ "fees_attributes": {
+ "additionalProperties": {
+ "anyOf": [
+ {
+ "additionalProperties": false,
+ "properties": {
+ "cost": {
+ "type": "number"
+ },
+ "description": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class discriminator.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "cost": {
+ "type": "number"
+ },
+ "description": {
+ "type": "string"
+ },
+ "discount_duration_amount": {
+ "type": "number"
+ },
+ "discount_duration_type": {
+ "type": "string"
+ },
+ "discount_type": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class discriminator.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "cost": {
+ "type": "number"
+ },
+ "description": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "quantity": {
+ "type": "number"
+ },
+ "stripe_product_id": {
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class discriminator.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "attachment_id": {
+ "type": "string"
+ },
+ "description": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class discriminator.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "description": {
+ "type": "string"
+ },
+ "fee_type": {
+ "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": {
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class discriminator.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "description": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class discriminator.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "cost": {
+ "type": "number"
+ },
+ "description": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class discriminator.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "cost": {
+ "type": "number"
+ },
+ "description": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class discriminator.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "description": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class discriminator.",
+ "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": {
+ "type": "string"
+ },
+ "fees_include_fee_increase_upon_renewal": {
+ "type": "number"
+ },
+ "fees_include_fee_increase_upon_renewal_fee": {
+ "type": "number"
+ },
+ "fees_include_fee_increase_upon_renewal_type": {
+ "type": "number"
+ },
+ "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": "boolean"
+ },
+ "include_license_limits": {
+ "type": "boolean"
+ },
+ "include_license_limits_description": {
+ "type": "boolean"
+ },
+ "include_payment_process_include_billing_email": {
+ "format": "email",
+ "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "include_pilot_period": {
+ "type": "boolean"
+ },
+ "include_pilot_period_duration_amount": {
+ "type": "boolean"
+ },
+ "include_pilot_period_duration_type": {
+ "type": "boolean"
+ },
+ "include_pilot_period_include_fees": {
+ "type": "boolean"
+ },
+ "include_pilot_period_include_fees_amount": {
+ "type": "boolean"
+ },
+ "include_pilot_period_include_modifications": {
+ "type": "boolean"
+ },
+ "include_pilot_period_include_modifications_description": {
+ "type": "boolean"
+ },
+ "include_services": {
+ "type": "boolean"
+ },
+ "include_services_description": {
+ "type": "boolean"
+ },
+ "negotiations_allowed": {
+ "type": "string"
+ },
+ "order_date_date": {
+ "type": "string"
+ },
+ "order_date_type": {
+ "type": "string"
+ },
+ "payment_process_automatic_frequency": {
+ "type": "string"
+ },
+ "payment_process_type": {
+ "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": {
+ "type": "string"
+ },
+ "payment_process_type_invoice_duration_start": {
+ "type": "string"
+ },
+ "payment_process_type_invoice_type": {
+ "type": "string"
+ },
+ "permitted_uses_include_custom": {
+ "type": "string"
+ },
+ "permitted_uses_include_custom_description": {
+ "type": "string"
+ },
+ "permitted_uses_include_customers_affiliates": {
+ "type": "string"
+ },
+ "permitted_uses_include_internal_business": {
+ "type": "string"
+ },
+ "pilot_period_stripe_product_id": {
+ "type": "number"
+ },
+ "software_description": {
+ "type": "string"
+ },
+ "subscription_auto_renew": {
+ "type": "string"
+ },
+ "subscription_period": {
+ "type": "number"
+ },
+ "subscription_period_unit": {
+ "type": "number"
+ },
+ "subscription_renewal_notice_days": {
+ "type": "number"
+ },
+ "warranty_period_description_amount": {
+ "type": "number"
+ },
+ "warranty_period_description_duration": {
+ "type": "number"
+ },
+ "warranty_period_description_duration_start": {
+ "type": "number"
+ },
+ "warranty_period_type": {
+ "type": "number"
+ }
+ },
+ "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-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-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": {
+ "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": "number"
+ },
+ "aggregation_limitations_permitted_val": {
+ "type": "number"
+ },
+ "breach_notification_unit": {
+ "type": "string"
+ },
+ "breach_notification_val": {
+ "type": "number"
+ },
+ "business_associate_relationship_type": {
+ "type": "string"
+ },
+ "deidentification_limitations_include_purpose": {
+ "type": "number"
+ },
+ "deidentification_limitations_include_requirements": {
+ "type": "number"
+ },
+ "deidentification_limitations_permitted": {
+ "type": "number"
+ },
+ "deidentification_limitations_purpose_val": {
+ "type": "number"
+ },
+ "deidentification_limitations_requirements_val": {
+ "type": "number"
+ },
+ "designated_record_set_provider_maintains": {
+ "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_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": "number"
+ },
+ "offshore_limitations_permitted_val": {
+ "type": "number"
+ },
+ "subcontract_limitations_include_notice": {
+ "type": "number"
+ },
+ "subcontract_limitations_include_permission": {
+ "type": "number"
+ },
+ "subcontract_limitations_notice_val": {
+ "type": "number"
+ },
+ "subcontract_limitations_permission_val": {
+ "type": "number"
+ },
+ "subcontract_limitations_permitted": {
+ "type": "number"
+ },
+ "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"
+ },
+ "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-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"
+ },
+ "default_signer_email": {
+ "format": "email",
+ "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "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": {
+ "type": "string"
+ },
+ "effective_date_type": {
+ "type": "string"
+ },
+ "general_cap_amount": {
+ "type": "number"
+ },
+ "general_cap_amount_type": {
+ "type": "number"
+ },
+ "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": "boolean"
+ },
+ "include_acceptable_use_policy_type": {
+ "type": "boolean"
+ },
+ "include_additional_warranties": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_by_customer": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_by_provider": {
+ "type": "boolean"
+ },
+ "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": "boolean"
+ },
+ "include_covered_claims_include_customer_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_include_provider_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_provider_claims": {
+ "type": "boolean"
+ },
+ "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": "boolean"
+ },
+ "include_dpa_type": {
+ "type": "boolean"
+ },
+ "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": "boolean"
+ },
+ "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": "boolean"
+ },
+ "include_insurance_minimums_cyber_liability_aggregate": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_cyber_liability_minimum": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_employer_liability_aggregate": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_employer_liability_minimum": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_general_liability_aggregate": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_general_liability_minimum": {
+ "type": "boolean"
+ },
+ "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": {
+ "type": "boolean"
+ },
+ "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": "boolean"
+ },
+ "include_security_policy_other": {
+ "type": "boolean"
+ },
+ "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": {
+ "type": "boolean"
+ },
+ "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_terms": {
+ "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": "boolean"
+ },
+ "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": {
+ "type": "number"
+ },
+ "negotiations_allowed": {
+ "type": "string"
+ },
+ "provider": {
+ "type": "string"
+ },
+ "sender_last_to_sign": {
+ "type": "boolean"
+ },
+ "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": "number"
+ },
+ "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": {
+ "type": "number"
+ },
+ "fees_attributes": {
+ "additionalProperties": {
+ "anyOf": [
+ {
+ "additionalProperties": false,
+ "properties": {
+ "cost": {
+ "type": "number"
+ },
+ "description": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class discriminator.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "cost": {
+ "type": "number"
+ },
+ "description": {
+ "type": "string"
+ },
+ "discount_duration_amount": {
+ "type": "number"
+ },
+ "discount_duration_type": {
+ "type": "string"
+ },
+ "discount_type": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class discriminator.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "cost": {
+ "type": "number"
+ },
+ "description": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "quantity": {
+ "type": "number"
+ },
+ "stripe_product_id": {
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class discriminator.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "attachment_id": {
+ "type": "string"
+ },
+ "description": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class discriminator.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "description": {
+ "type": "string"
+ },
+ "fee_type": {
+ "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": {
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class discriminator.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "description": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class discriminator.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "cost": {
+ "type": "number"
+ },
+ "description": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class discriminator.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "cost": {
+ "type": "number"
+ },
+ "description": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class discriminator.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "description": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class discriminator.",
+ "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": {
+ "type": "string"
+ },
+ "fees_include_fee_increase_upon_renewal": {
+ "type": "number"
+ },
+ "fees_include_fee_increase_upon_renewal_fee": {
+ "type": "number"
+ },
+ "fees_include_fee_increase_upon_renewal_type": {
+ "type": "number"
+ },
+ "fees_inclusive_of_taxes": {
+ "type": "boolean"
+ },
+ "framework_terms_type": {
+ "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": "boolean"
+ },
+ "include_fees_table": {
+ "type": "boolean"
+ },
+ "include_fees_table_period": {
+ "type": "boolean"
+ },
+ "include_free_trial": {
+ "type": "boolean"
+ },
+ "include_max_users": {
+ "type": "boolean"
+ },
+ "include_pilot_period": {
+ "type": "boolean"
+ },
+ "include_pilot_period_duration_amount": {
+ "type": "boolean"
+ },
+ "include_pilot_period_duration_type": {
+ "type": "boolean"
+ },
+ "include_pilot_period_include_fees": {
+ "type": "boolean"
+ },
+ "include_pilot_period_include_fees_amount": {
+ "type": "boolean"
+ },
+ "include_pilot_period_include_modifications": {
+ "type": "boolean"
+ },
+ "include_pilot_period_include_modifications_description": {
+ "type": "boolean"
+ },
+ "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": "boolean"
+ },
+ "include_product_support_type": {
+ "type": "boolean"
+ },
+ "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": "boolean"
+ },
+ "include_professional_services_description": {
+ "type": "boolean"
+ },
+ "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": "boolean"
+ },
+ "include_professional_services_include_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_include_fees_description": {
+ "type": "boolean"
+ },
+ "include_professional_services_type": {
+ "type": "boolean"
+ },
+ "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": "boolean"
+ },
+ "include_sla_include_response_time": {
+ "type": "boolean"
+ },
+ "include_sla_include_response_time_amount": {
+ "type": "boolean"
+ },
+ "include_sla_include_response_time_credit": {
+ "type": "boolean"
+ },
+ "include_sla_include_response_time_duration": {
+ "type": "boolean"
+ },
+ "include_sla_include_response_time_support_channel": {
+ "type": "boolean"
+ },
+ "include_sla_include_target_uptime": {
+ "type": "boolean"
+ },
+ "include_sla_maintenance_notice": {
+ "type": "boolean"
+ },
+ "include_sla_maintenance_window": {
+ "type": "boolean"
+ },
+ "include_sla_maintenance_window_type": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_notice_qty": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_notice_unit": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_end_time": {
+ "type": "boolean"
+ },
+ "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": "boolean"
+ },
+ "include_sla_standard_maintenance_window_sunday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_thursday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_time_zone": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_tuesday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_wednesday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_target_uptime": {
+ "type": "boolean"
+ },
+ "include_sla_type": {
+ "type": "boolean"
+ },
+ "include_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"
+ },
+ "include_subscription_start_date_date": {
+ "type": "boolean"
+ },
+ "include_usage_review": {
+ "type": "boolean"
+ },
+ "include_usage_review_val": {
+ "type": "boolean"
+ },
+ "include_use_limitations": {
+ "type": "boolean"
+ },
+ "include_use_limitations_val": {
+ "type": "boolean"
+ },
+ "invoice_period": {
+ "type": "number"
+ },
+ "invoice_period_custom_unit": {
+ "type": "number"
+ },
+ "max_consumption": {
+ "type": "number"
+ },
+ "max_users": {
+ "type": "number"
+ },
+ "negotiations_allowed": {
+ "type": "string"
+ },
+ "order_date_date": {
+ "type": "string"
+ },
+ "order_date_other": {
+ "type": "string"
+ },
+ "order_date_type": {
+ "type": "string"
+ },
+ "payment_period": {
+ "type": "number"
+ },
+ "payment_period_timeframe": {
+ "type": "number"
+ },
+ "payment_period_unit": {
+ "type": "number"
+ },
+ "payment_process_automatic_frequency": {
+ "type": "string"
+ },
+ "payment_process_type": {
+ "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": {
+ "type": "string"
+ },
+ "payment_process_type_invoice_duration_start": {
+ "type": "string"
+ },
+ "payment_process_type_invoice_type": {
+ "type": "string"
+ },
+ "pilot_period_stripe_product_id": {
+ "type": "number"
+ },
+ "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": {
+ "type": "string"
+ },
+ "subscription_period": {
+ "type": "number"
+ },
+ "subscription_period_unit": {
+ "type": "number"
+ },
+ "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": {
+ "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": "boolean"
+ },
+ "include_fees_description": {
+ "type": "boolean"
+ },
+ "include_fees_pay_by_amount": {
+ "type": "boolean"
+ },
+ "include_fees_type": {
+ "type": "boolean"
+ },
+ "include_fees_unit": {
+ "type": "boolean"
+ },
+ "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": "boolean"
+ },
+ "include_program_discount": {
+ "type": "boolean"
+ },
+ "include_program_discount_amount": {
+ "type": "boolean"
+ },
+ "include_program_discount_unit": {
+ "type": "boolean"
+ },
+ "include_program_participation_feedback": {
+ "type": "boolean"
+ },
+ "include_program_participation_feedback_amount": {
+ "type": "boolean"
+ },
+ "include_program_participation_feedback_unit": {
+ "type": "boolean"
+ },
+ "include_program_partner_other": {
+ "type": "boolean"
+ },
+ "include_program_partner_other_val": {
+ "type": "boolean"
+ },
+ "include_program_provider_other": {
+ "type": "boolean"
+ },
+ "include_program_provider_other_val": {
+ "type": "boolean"
+ },
+ "include_program_reference": {
+ "type": "boolean"
+ },
+ "product_description": {
+ "type": "string"
+ },
+ "term_amount": {
+ "type": "number"
+ },
+ "term_unit": {
+ "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.",
+ "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-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"
+ },
+ "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": "string"
+ },
+ "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": "string"
+ },
+ "confidentiality_nda_type": {
+ "type": "string"
+ },
+ "confidentiality_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"
+ },
+ "include_custom_details": {
+ "type": "boolean"
+ },
+ "include_custom_details_val": {
+ "type": "boolean"
+ },
+ "include_fees": {
+ "type": "boolean"
+ },
+ "include_fees_amount": {
+ "type": "boolean"
+ },
+ "include_fees_amount_duration": {
+ "type": "boolean"
+ },
+ "include_fees_include_amount": {
+ "type": "boolean"
+ },
+ "include_fees_include_other": {
+ "type": "boolean"
+ },
+ "include_fees_other": {
+ "type": "boolean"
+ },
+ "include_functionality": {
+ "type": "boolean"
+ },
+ "include_functionality_val": {
+ "type": "boolean"
+ },
+ "include_launch_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_launch_date_custom": {
+ "type": "boolean"
+ },
+ "include_launch_date_date": {
+ "type": "boolean"
+ },
+ "include_launch_date_type": {
+ "type": "boolean"
+ },
+ "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"
+ },
+ "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": {
+ "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": {
+ "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_include_company": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_include_company_val": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_include_partner": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_include_partner_val": {
+ "type": "boolean"
+ },
+ "include_brand_guidelines": {
+ "type": "boolean"
+ },
+ "include_brand_guidelines_include_company": {
+ "type": "boolean"
+ },
+ "include_brand_guidelines_include_company_val": {
+ "type": "boolean"
+ },
+ "include_brand_guidelines_include_partner": {
+ "type": "boolean"
+ },
+ "include_brand_guidelines_include_partner_val": {
+ "type": "boolean"
+ },
+ "include_covered_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_company_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_include_company_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_include_partner_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_partner_claims": {
+ "type": "boolean"
+ },
+ "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": "boolean"
+ },
+ "include_dpa_type": {
+ "type": "boolean"
+ },
+ "include_increased_cap_amount": {
+ "type": "boolean"
+ },
+ "include_increased_cap_amount_currency": {
+ "type": "boolean"
+ },
+ "include_increased_cap_amount_either_currency": {
+ "type": "boolean"
+ },
+ "include_increased_cap_amount_either_multiple": {
+ "type": "boolean"
+ },
+ "include_increased_cap_amount_multiple": {
+ "type": "boolean"
+ },
+ "include_increased_cap_amount_type": {
+ "type": "boolean"
+ },
+ "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": "boolean"
+ },
+ "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": "boolean"
+ },
+ "negotiations_allowed": {
+ "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": {
+ "type": "string"
+ },
+ "end_date_date": {
+ "type": "string"
+ },
+ "end_date_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"
+ },
+ "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": "boolean"
+ },
+ "include_obligations_company_promotion_include_materials": {
+ "type": "boolean"
+ },
+ "include_obligations_company_promotion_include_materials_val": {
+ "type": "boolean"
+ },
+ "include_obligations_company_referral": {
+ "type": "boolean"
+ },
+ "include_obligations_company_referral_include_criteria": {
+ "type": "boolean"
+ },
+ "include_obligations_company_referral_include_criteria_val": {
+ "type": "boolean"
+ },
+ "include_obligations_company_referral_include_pay_sch": {
+ "type": "boolean"
+ },
+ "include_obligations_company_referral_include_pay_sch_amount": {
+ "type": "boolean"
+ },
+ "include_obligations_company_referral_include_pay_sch_custom": {
+ "type": "boolean"
+ },
+ "include_obligations_company_referral_include_pay_sch_unit": {
+ "type": "boolean"
+ },
+ "include_obligations_company_sponsorship": {
+ "type": "boolean"
+ },
+ "include_obligations_company_sponsorship_include_benefits": {
+ "type": "boolean"
+ },
+ "include_obligations_company_sponsorship_include_benefits_val": {
+ "type": "boolean"
+ },
+ "include_obligations_company_sponsorship_include_payments": {
+ "type": "boolean"
+ },
+ "include_obligations_company_sponsorship_include_payments_amount": {
+ "type": "boolean"
+ },
+ "include_obligations_company_sponsorship_include_payments_unit": {
+ "type": "boolean"
+ },
+ "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": "boolean"
+ },
+ "include_obligations_partner_promotion_include_materials": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_promotion_include_materials_val": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_referral": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_referral_include_criteria": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_referral_include_criteria_val": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_referral_include_pay_sch": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_referral_include_pay_sch_amount": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_referral_include_pay_sch_custom": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_referral_include_pay_sch_unit": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_sponsorship": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_sponsorship_include_benefits": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_sponsorship_include_benefits_val": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_sponsorship_include_payments": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_sponsorship_include_payments_amount": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_sponsorship_include_payments_unit": {
+ "type": "boolean"
+ },
+ "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": "boolean"
+ },
+ "include_payment_process_company_include_address_country": {
+ "type": "boolean"
+ },
+ "include_payment_process_company_include_address_state": {
+ "type": "boolean"
+ },
+ "include_payment_process_company_include_address_street_address": {
+ "type": "boolean"
+ },
+ "include_payment_process_company_include_address_zipcode": {
+ "type": "boolean"
+ },
+ "include_payment_process_company_include_email": {
+ "format": "email",
+ "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "include_payment_process_company_include_email_val": {
+ "type": "boolean"
+ },
+ "include_payment_process_partner": {
+ "type": "boolean"
+ },
+ "include_payment_process_partner_include_address": {
+ "type": "boolean"
+ },
+ "include_payment_process_partner_include_address_city": {
+ "type": "boolean"
+ },
+ "include_payment_process_partner_include_address_country": {
+ "type": "boolean"
+ },
+ "include_payment_process_partner_include_address_state": {
+ "type": "boolean"
+ },
+ "include_payment_process_partner_include_address_street_address": {
+ "type": "boolean"
+ },
+ "include_payment_process_partner_include_address_zipcode": {
+ "type": "boolean"
+ },
+ "include_payment_process_partner_include_email": {
+ "format": "email",
+ "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "include_payment_process_partner_include_email_val": {
+ "type": "boolean"
+ },
+ "include_payment_schedule": {
+ "type": "boolean"
+ },
+ "include_payment_schedule_custom": {
+ "type": "boolean"
+ },
+ "include_payment_schedule_specified_amount": {
+ "type": "boolean"
+ },
+ "include_payment_schedule_specified_timeframe": {
+ "type": "boolean"
+ },
+ "include_payment_schedule_specified_unit": {
+ "type": "boolean"
+ },
+ "include_payment_schedule_type": {
+ "type": "boolean"
+ },
+ "negotiations_allowed": {
+ "type": "string"
+ },
+ "territory_type": {
+ "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": {
+ "type": "string"
+ },
+ "general_cap_amount": {
+ "type": "number"
+ },
+ "general_cap_amount_type": {
+ "type": "number"
+ },
+ "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": "boolean"
+ },
+ "include_dpa_type": {
+ "type": "boolean"
+ },
+ "include_payment_process": {
+ "type": "boolean"
+ },
+ "include_technical_support": {
+ "type": "boolean"
+ },
+ "negotiations_allowed": {
+ "type": "string"
+ },
+ "payment_process_automatic_frequency": {
+ "type": "string"
+ },
+ "payment_process_invoice_days": {
+ "type": "number"
+ },
+ "payment_process_invoice_from": {
+ "type": "string"
+ },
+ "payment_process_invoice_timeframe": {
+ "type": "string"
+ },
+ "payment_process_type": {
+ "type": "string"
+ },
+ "pilot_period_description": {
+ "type": "number"
+ },
+ "pilot_period_fees_description": {
+ "type": "number"
+ },
+ "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"
+ },
+ "default_signer_email": {
+ "format": "email",
+ "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "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": {
+ "type": "string"
+ },
+ "general_cap_amount": {
+ "type": "number"
+ },
+ "general_cap_amount_type": {
+ "type": "number"
+ },
+ "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": "boolean"
+ },
+ "include_additional_warranties_by_provider": {
+ "type": "boolean"
+ },
+ "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": "boolean"
+ },
+ "include_covered_claims_include_customer_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_include_provider_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_provider_claims": {
+ "type": "boolean"
+ },
+ "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": "boolean"
+ },
+ "include_customer_insurance_min_auto_liability_minimum": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_cyber_liability_aggregate": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_cyber_liability_minimum": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_employer_liability_aggregate": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_employer_liability_minimum": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_general_liability_aggregate": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_general_liability_minimum": {
+ "type": "boolean"
+ },
+ "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": "boolean"
+ },
+ "include_customer_policies_type": {
+ "type": "boolean"
+ },
+ "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": "boolean"
+ },
+ "include_dpa_type": {
+ "type": "boolean"
+ },
+ "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": "boolean"
+ },
+ "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": "boolean"
+ },
+ "include_provider_insurance_min_auto_liability_minimum": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_cyber_liability_aggregate": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_cyber_liability_minimum": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_employer_liability_aggregate": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_employer_liability_minimum": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_general_liability_aggregate": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_general_liability_minimum": {
+ "type": "boolean"
+ },
+ "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": {
+ "type": "boolean"
+ },
+ "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": "boolean"
+ },
+ "include_security_policy_iso27001": {
+ "type": "boolean"
+ },
+ "include_security_policy_location": {
+ "type": "boolean"
+ },
+ "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": {
+ "type": "boolean"
+ },
+ "include_terms": {
+ "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_negligence": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_other": {
+ "type": "boolean"
+ },
+ "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": {
+ "type": "number"
+ },
+ "negotiations_allowed": {
+ "type": "string"
+ },
+ "sender_last_to_sign": {
+ "type": "boolean"
+ }
+ },
+ "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,
+ "properties": {
+ "cost": {
+ "type": "number"
+ },
+ "description": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class discriminator.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "cost": {
+ "type": "number"
+ },
+ "description": {
+ "type": "string"
+ },
+ "discount_duration_amount": {
+ "type": "number"
+ },
+ "discount_duration_type": {
+ "type": "string"
+ },
+ "discount_type": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class discriminator.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "cost": {
+ "type": "number"
+ },
+ "description": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "quantity": {
+ "type": "number"
+ },
+ "stripe_product_id": {
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class discriminator.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "attachment_id": {
+ "type": "string"
+ },
+ "description": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class discriminator.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "description": {
+ "type": "string"
+ },
+ "fee_type": {
+ "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": {
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class discriminator.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "description": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class discriminator.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "cost": {
+ "type": "number"
+ },
+ "description": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class discriminator.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "cost": {
+ "type": "number"
+ },
+ "description": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class discriminator.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "description": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class discriminator.",
+ "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": "boolean"
+ },
+ "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": "boolean"
+ },
+ "include_deliverables_include_acceptance": {
+ "type": "boolean"
+ },
+ "include_deliverables_include_attachment": {
+ "type": "boolean"
+ },
+ "include_deliverables_include_draft_deliverables": {
+ "type": "boolean"
+ },
+ "include_deliverables_rejection_amount": {
+ "type": "boolean"
+ },
+ "include_deliverables_rejection_unit": {
+ "type": "boolean"
+ },
+ "include_deliverables_resubmission_amount": {
+ "type": "boolean"
+ },
+ "include_deliverables_resubmission_unit": {
+ "type": "boolean"
+ },
+ "include_fees_other": {
+ "type": "boolean"
+ },
+ "include_fees_other_val": {
+ "type": "boolean"
+ },
+ "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": {
+ "type": "boolean"
+ },
+ "include_fees_travel_val": {
+ "type": "boolean"
+ },
+ "include_third_party_customer": {
+ "type": "boolean"
+ },
+ "include_third_party_include_description": {
+ "type": "boolean"
+ },
+ "include_third_party_include_description_val": {
+ "type": "boolean"
+ },
+ "include_third_party_materials": {
+ "type": "boolean"
+ },
+ "include_third_party_provider": {
+ "type": "boolean"
+ },
+ "include_time_of_assignment": {
+ "type": "boolean"
+ },
+ "include_time_of_assignment_type": {
+ "type": "boolean"
+ },
+ "invoice_period_description": {
+ "type": "number"
+ },
+ "negotiations_allowed": {
+ "type": "string"
+ },
+ "payment_period": {
+ "type": "number"
+ },
+ "payment_period_other": {
+ "type": "number"
+ },
+ "payment_period_timeframe": {
+ "type": "number"
+ },
+ "payment_period_type": {
+ "type": "number"
+ },
+ "payment_period_unit": {
+ "type": "number"
+ },
+ "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": {
+ "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": {
+ "type": "string"
+ },
+ "sow_term_unit": {
+ "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-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-z]{2,}$",
+ "type": "string"
+ },
+ "recipient_organization": {
+ "type": "string"
+ },
+ "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-z]{2,}$",
+ "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": {
+ "type": "string"
+ },
+ "general_cap_amount": {
+ "type": "number"
+ },
+ "general_cap_amount_type": {
+ "type": "number"
+ },
+ "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": "boolean"
+ },
+ "include_additional_warranties_by_provider": {
+ "type": "boolean"
+ },
+ "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": "boolean"
+ },
+ "include_covered_claims_include_customer_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_include_provider_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_provider_claims": {
+ "type": "boolean"
+ },
+ "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": "boolean"
+ },
+ "include_dpa_type": {
+ "type": "boolean"
+ },
+ "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": "boolean"
+ },
+ "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": "boolean"
+ },
+ "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": {
+ "type": "number"
+ }
+ },
+ "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": "string"
+ },
+ "deletion_procedure_include_custom_description": {
+ "type": "string"
+ },
+ "deletion_procedure_include_customer_disable": {
+ "type": "string"
+ },
+ "deletion_procedure_include_customer_proof": {
+ "type": "string"
+ },
+ "deletion_procedure_include_provider_disable": {
+ "type": "string"
+ },
+ "fee_custom_unit": {
+ "type": "string"
+ },
+ "fee_period": {
+ "type": "number"
+ },
+ "fees_attributes": {
+ "additionalProperties": {
+ "anyOf": [
+ {
+ "additionalProperties": false,
+ "properties": {
+ "cost": {
+ "type": "number"
+ },
+ "description": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class discriminator.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "cost": {
+ "type": "number"
+ },
+ "description": {
+ "type": "string"
+ },
+ "discount_duration_amount": {
+ "type": "number"
+ },
+ "discount_duration_type": {
+ "type": "string"
+ },
+ "discount_type": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class discriminator.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "cost": {
+ "type": "number"
+ },
+ "description": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "quantity": {
+ "type": "number"
+ },
+ "stripe_product_id": {
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class discriminator.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "attachment_id": {
+ "type": "string"
+ },
+ "description": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class discriminator.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "description": {
+ "type": "string"
+ },
+ "fee_type": {
+ "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": {
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class discriminator.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "description": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class discriminator.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "cost": {
+ "type": "number"
+ },
+ "description": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class discriminator.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "cost": {
+ "type": "number"
+ },
+ "description": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class discriminator.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "description": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class discriminator.",
+ "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": {
+ "type": "string"
+ },
+ "fees_include_fee_increase_upon_renewal": {
+ "type": "number"
+ },
+ "fees_include_fee_increase_upon_renewal_fee": {
+ "type": "number"
+ },
+ "fees_include_fee_increase_upon_renewal_type": {
+ "type": "number"
+ },
+ "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": "boolean"
+ },
+ "include_license_limits": {
+ "type": "boolean"
+ },
+ "include_license_limits_description": {
+ "type": "boolean"
+ },
+ "include_payment_process_include_billing_email": {
+ "format": "email",
+ "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "include_pilot_period": {
+ "type": "boolean"
+ },
+ "include_pilot_period_duration_amount": {
+ "type": "boolean"
+ },
+ "include_pilot_period_duration_type": {
+ "type": "boolean"
+ },
+ "include_pilot_period_include_fees": {
+ "type": "boolean"
+ },
+ "include_pilot_period_include_fees_amount": {
+ "type": "boolean"
+ },
+ "include_pilot_period_include_modifications": {
+ "type": "boolean"
+ },
+ "include_pilot_period_include_modifications_description": {
+ "type": "boolean"
+ },
+ "include_services": {
+ "type": "boolean"
+ },
+ "include_services_description": {
+ "type": "boolean"
+ },
+ "negotiations_allowed": {
+ "type": "string"
+ },
+ "order_date_date": {
+ "type": "string"
+ },
+ "order_date_type": {
+ "type": "string"
+ },
+ "payment_process_automatic_frequency": {
+ "type": "string"
+ },
+ "payment_process_type": {
+ "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": {
+ "type": "string"
+ },
+ "payment_process_type_invoice_duration_start": {
+ "type": "string"
+ },
+ "payment_process_type_invoice_type": {
+ "type": "string"
+ },
+ "permitted_uses_include_custom": {
+ "type": "string"
+ },
+ "permitted_uses_include_custom_description": {
+ "type": "string"
+ },
+ "permitted_uses_include_customers_affiliates": {
+ "type": "string"
+ },
+ "permitted_uses_include_internal_business": {
+ "type": "string"
+ },
+ "pilot_period_stripe_product_id": {
+ "type": "number"
+ },
+ "software_description": {
+ "type": "string"
+ },
+ "subscription_auto_renew": {
+ "type": "string"
+ },
+ "subscription_period": {
+ "type": "number"
+ },
+ "subscription_period_unit": {
+ "type": "number"
+ },
+ "subscription_renewal_notice_days": {
+ "type": "number"
+ },
+ "warranty_period_description_amount": {
+ "type": "number"
+ },
+ "warranty_period_description_duration": {
+ "type": "number"
+ },
+ "warranty_period_description_duration_start": {
+ "type": "number"
+ },
+ "warranty_period_type": {
+ "type": "number"
+ }
+ },
+ "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-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"
+ }
+]create-template1 field changedInput schema / properties / body / anyOfPrevious value: -[
- {
- "additionalProperties": false,
- "properties": {
- "additional_changes": {
- "description": "Text of additional changes to include when include_additional_changes is true.",
- "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"
- },
- "confidentiality_period": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "confidentiality_period_perpetual": {
- "type": "boolean"
- },
- "default_signer_email": {
- "description": "Default email address pre-filled as the signer when creating agreements from this template.",
- "format": "email",
- "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
- "type": "string"
- },
- "district_or_county": {
- "description": "The district or county for dispute resolution.",
- "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_of_confidentiality": {
- "type": "string"
- },
- "effective_date_type": {
- "type": "string"
- },
- "governing_law_country": {
- "description": "The country whose laws govern agreements created from this template.",
- "type": "string"
- },
- "governing_law_region": {
- "description": "The state or region whose laws govern agreements created from this template.",
- "type": "string"
- },
- "include_additional_changes": {
- "description": "Whether to include the additional changes section.",
- "type": "boolean"
- },
- "include_terms": {
- "description": "Whether to include standard terms in the agreement.",
- "type": "boolean"
- },
- "name": {
- "description": "A name for the template.",
- "type": "string"
- },
- "negotiations_allowed": {
- "description": "Whether counterparties can propose changes to agreements created from this template.",
- "type": "boolean"
- },
- "purpose": {
- "type": "string"
- },
- "recipient_role": {
- "description": "The label for the receiving party in the agreement.",
- "type": "string"
- },
- "sender_last_to_sign": {
- "description": "When true, the sender signs after the recipient.",
- "type": "boolean"
- },
- "sender_role": {
- "description": "The label for the sending party in the agreement.",
- "type": "string"
- },
- "template_setting_attributes": {
- "additionalProperties": false,
- "description": "Template settings such as standard version and message.",
- "properties": {
- "include_message": {
- "type": "boolean"
- },
- "message": {
- "type": "string"
- },
- "standard_version": {
- "type": "string"
- },
- "subsidiary_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"
- }
- },
- "type": "object"
- },
- "term": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "term_period_perpetual": {
- "type": "boolean"
- },
- "type": {
- "description": "Optional. When omitted, the template defaults to NDA.",
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "additional_changes": {
- "description": "Text of additional changes to include when include_additional_changes is true.",
- "type": "string"
- },
- "attachment_ids": {
- "description": "UUIDs of attachments to include with the template.",
- "items": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "type": "array"
- },
- "billing_workflow_type": {
- "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"
- },
- "customer_description": {
- "type": "string"
- },
- "default_signer_email": {
- "description": "Default email address pre-filled as the signer when creating agreements from this template.",
- "format": "email",
- "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
- "type": "string"
- },
- "district_or_county": {
- "description": "The district or county for dispute resolution.",
- "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": {
- "type": "string"
- },
- "effective_date_type": {
- "type": "string"
- },
- "general_cap_amount": {
- "type": "number"
- },
- "general_cap_amount_type": {
- "type": "string"
- },
- "general_cap_period_currency": {
- "type": "number"
- },
- "general_cap_period_qty": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "general_cap_preceding_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "governing_law_country": {
- "description": "The country whose laws govern agreements created from this template.",
- "type": "string"
- },
- "governing_law_region": {
- "description": "The state or region whose laws govern agreements created from this template.",
- "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": {
- "type": "string"
- },
- "include_additional_changes": {
- "description": "Whether to include the additional changes section.",
- "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_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_billing_workflow": {
- "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_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": {
- "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": {
- "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": {
- "type": "string"
- },
- "include_terms": {
- "description": "Whether to include standard terms in the agreement.",
- "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": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "increased_cap_amount_qty": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "increased_cap_amount_type": {
- "type": "string"
- },
- "name": {
- "description": "A name for the template.",
- "type": "string"
- },
- "negotiations_allowed": {
- "description": "Whether counterparties can propose changes to agreements created from this template.",
- "type": "boolean"
- },
- "payment_link_url": {
- "type": "string"
- },
- "provider": {
- "type": "string"
- },
- "recipient_role": {
- "description": "The label for the receiving party in the agreement.",
- "type": "string"
- },
- "sender_last_to_sign": {
- "description": "When true, the sender signs after the recipient.",
- "type": "boolean"
- },
- "sender_role": {
- "description": "The label for the sending party in the agreement.",
- "type": "string"
- },
- "stripe_invoice_delivery": {
- "type": "string"
- },
- "stripe_payment_link_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"
- },
- "stripe_product_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"
- },
- "stripe_product_name": {
- "type": "string"
- },
- "stripe_subsequent_bill_method": {
- "type": "string"
- },
- "template_csa_order_form_attributes": {
- "additionalProperties": false,
- "description": "Nested CSA order form defaults. See Template Parameters docs for CSA Order Form.",
- "properties": {
- "additional_changes": {
- "description": "Text of additional changes to include when include_additional_changes is true.",
- "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": {
- "type": "string"
- },
- "fees_attributes": {
- "items": {
- "additionalProperties": false,
- "properties": {
- "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"
- },
- "cost": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "description": {
- "type": "string"
- },
- "discount_duration_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "discount_duration_type": {
- "type": "string"
- },
- "discount_type": {
- "type": "string"
- },
- "fee_type": {
- "type": "string"
- },
- "graduated_fee_tiers_attributes": {
- "items": {
- "additionalProperties": false,
- "properties": {
- "flat_price": {
- "type": "string"
- },
- "price_per_unit": {
- "type": "string"
- },
- "upper_limit": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- }
- },
- "type": "object"
- },
- "type": "array"
- },
- "quantity": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "stripe_product_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"
- },
- "type": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "type": "array"
- },
- "fees_currency": {
- "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": {
- "type": "string"
- },
- "fees_inclusive_of_taxes": {
- "type": "boolean"
- },
- "free_trial_days": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_additional_changes": {
- "description": "Whether to include the additional changes section.",
- "type": "boolean"
- },
- "include_additional_parameters_or_limitations": {
- "type": "boolean"
- },
- "include_billing_info": {
- "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": {
- "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": {
- "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": {
- "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": {
- "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": {
- "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": {
- "type": "string"
- },
- "include_sla_standard_maintenance_notice_qty": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_sla_standard_maintenance_notice_unit": {
- "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": {
- "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": {
- "type": "string"
- },
- "invoice_period_custom_unit": {
- "type": "string"
- },
- "max_consumption": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "max_users": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "negotiations_allowed": {
- "description": "Whether counterparties can propose changes to agreements created from this template.",
- "type": "boolean"
- },
- "order_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"
- },
- "order_date_other": {
- "type": "string"
- },
- "order_date_type": {
- "type": "string"
- },
- "payment_period": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "payment_period_timeframe": {
- "type": "string"
- },
- "payment_period_unit": {
- "type": "string"
- },
- "payment_process_automatic_frequency": {
- "type": "string"
- },
- "payment_process_type": {
- "type": "string"
- },
- "payment_process_type_custom_val": {
- "type": "string"
- },
- "payment_process_type_invoice_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "payment_process_type_invoice_custom_unit": {
- "type": "string"
- },
- "payment_process_type_invoice_duration": {
- "type": "string"
- },
- "payment_process_type_invoice_duration_start": {
- "type": "string"
- },
- "payment_process_type_invoice_type": {
- "type": "string"
- },
- "pilot_period_stripe_product_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"
- },
- "service_credits_attributes": {
- "items": {
- "additionalProperties": false,
- "properties": {
- "credit": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "max": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "min": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- }
- },
- "type": "object"
- },
- "type": "array"
- },
- "subscription_auto_renew": {
- "type": "string"
- },
- "subscription_period": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "subscription_period_unit": {
- "type": "string"
- },
- "subscription_renewal_notice_days": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "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": {
- "type": "string"
- },
- "use_limitations_attributes": {
- "items": {
- "additionalProperties": false,
- "properties": {
- "amount": {
- "type": "string"
- },
- "limitation_type": {
- "type": "string"
- },
- "unit": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "type": "array"
- }
- },
- "type": "object"
- },
- "template_setting_attributes": {
- "additionalProperties": false,
- "description": "Template settings such as standard version and message.",
- "properties": {
- "include_message": {
- "type": "boolean"
- },
- "message": {
- "type": "string"
- },
- "standard_version": {
- "type": "string"
- },
- "subsidiary_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"
- }
- },
- "type": "object"
- },
- "type": {
- "description": "The type of template to create.",
- "type": "string"
- }
- },
- "required": [
- "type"
- ],
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "additional_changes": {
- "description": "Text of additional changes to include when include_additional_changes is true.",
- "type": "string"
- },
- "approved_subprocessor_type": {
- "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"
- },
- "cloud_service_product_name": {
- "type": "string"
- },
- "competent_supervisory_authority": {
- "type": "string"
- },
- "customer_description": {
- "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"
- },
- "default_signer_email": {
- "description": "Default email address pre-filled as the signer when creating agreements from this template.",
- "format": "email",
- "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
- "type": "string"
- },
- "district_or_county": {
- "description": "The district or county for dispute resolution.",
- "type": "string"
- },
- "duration_of_processing": {
- "type": "string"
- },
- "governing_law_country": {
- "description": "The country whose laws govern agreements created from this template.",
- "type": "string"
- },
- "governing_law_region": {
- "description": "The state or region whose laws govern agreements created from this template.",
- "type": "string"
- },
- "include_additional_changes": {
- "description": "Whether to include the additional changes section.",
- "type": "boolean"
- },
- "include_covered_claim": {
- "type": "boolean"
- },
- "include_covered_claim_external_val": {
- "type": "string"
- },
- "include_covered_claim_internal_val": {
- "type": "string"
- },
- "include_covered_claim_type": {
- "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": {
- "type": "boolean"
- },
- "include_increased_claim_amount_currency": {
- "type": "string"
- },
- "include_increased_claim_amount_qty": {},
- "include_increased_claim_amount_type": {
- "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": {
- "type": "string"
- },
- "include_liability_cap_amount_currency_internal": {
- "type": "string"
- },
- "include_liability_cap_csa_type": {
- "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-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_provider": {
- "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"
- },
- "include_terms": {
- "description": "Whether to include standard terms in the agreement.",
- "type": "boolean"
- },
- "name": {
- "description": "A name for the template.",
- "type": "string"
- },
- "negotiations_allowed": {
- "description": "Whether counterparties can propose changes to agreements created from this template.",
- "type": "boolean"
- },
- "provider": {
- "type": "string"
- },
- "recipient_role": {
- "description": "The label for the receiving party in the agreement.",
- "type": "string"
- },
- "security_policy_available_at": {
- "type": "string"
- },
- "security_policy_type": {
- "type": "string"
- },
- "sender_last_to_sign": {
- "description": "When true, the sender signs after the recipient.",
- "type": "boolean"
- },
- "sender_role": {
- "description": "The label for the sending party in the agreement.",
- "type": "string"
- },
- "subprocessors_attributes": {
- "description": "List of subprocessors. Each item may include name, country, and processing_task.",
- "items": {
- "additionalProperties": false,
- "properties": {
- "country": {
- "type": "string"
- },
- "name": {
- "description": "A name for the template.",
- "type": "string"
- },
- "processing_task": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "type": "array"
- },
- "template_setting_attributes": {
- "additionalProperties": false,
- "description": "Template settings such as standard version and message.",
- "properties": {
- "include_message": {
- "type": "boolean"
- },
- "message": {
- "type": "string"
- },
- "standard_version": {
- "type": "string"
- },
- "subsidiary_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"
- }
- },
- "type": "object"
- },
- "type": {
- "description": "The type of template to create.",
- "type": "string"
- },
- "underlying_agreement_val": {
- "type": "string"
- }
- },
- "required": [
- "type"
- ],
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "additional_changes": {
- "description": "Text of additional changes to include when include_additional_changes is true.",
- "type": "string"
- },
- "attachment_ids": {
- "description": "UUIDs of attachments to include with the template.",
- "items": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "type": "array"
- },
- "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"
- },
- "default_signer_email": {
- "description": "Default email address pre-filled as the signer when creating agreements from this template.",
- "format": "email",
- "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
- "type": "string"
- },
- "district_or_county": {
- "description": "The district or county for dispute resolution.",
- "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": {
- "type": "string"
- },
- "general_cap_amount": {
- "type": "number"
- },
- "general_cap_amount_type": {
- "type": "string"
- },
- "general_cap_period_currency": {
- "type": "number"
- },
- "general_cap_period_qty": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "general_cap_preceding_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "governing_law_country": {
- "description": "The country whose laws govern agreements created from this template.",
- "type": "string"
- },
- "governing_law_region": {
- "description": "The state or region whose laws govern agreements created from this template.",
- "type": "string"
- },
- "include_additional_changes": {
- "description": "Whether to include the additional changes section.",
- "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": {
- "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": {
- "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": {
- "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": {
- "type": "string"
- },
- "include_terms": {
- "description": "Whether to include standard terms in the agreement.",
- "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_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": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "increased_cap_amount_qty": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "increased_cap_amount_type": {
- "type": "string"
- },
- "name": {
- "description": "A name for the template.",
- "type": "string"
- },
- "negotiations_allowed": {
- "description": "Whether counterparties can propose changes to agreements created from this template.",
- "type": "boolean"
- },
- "recipient_role": {
- "description": "The label for the receiving party in the agreement.",
- "type": "string"
- },
- "sender_last_to_sign": {
- "description": "When true, the sender signs after the recipient.",
- "type": "boolean"
- },
- "sender_role": {
- "description": "The label for the sending party in the agreement.",
- "type": "string"
- },
- "template_psa_statement_of_work_attributes": {
- "additionalProperties": false,
- "description": "Nested PSA statement of work defaults.",
- "properties": {
- "additional_changes": {
- "description": "Text of additional changes to include when include_additional_changes is true.",
- "type": "string"
- },
- "fees_attributes": {
- "items": {
- "additionalProperties": false,
- "properties": {
- "cost": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "description": {
- "type": "string"
- },
- "fee_type": {
- "type": "string"
- },
- "quantity": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- }
- },
- "type": "object"
- },
- "type": "array"
- },
- "include_additional_changes": {
- "description": "Whether to include the additional changes section.",
- "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": {
- "type": "string"
- },
- "include_deliverables_resubmission_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_deliverables_resubmission_unit": {
- "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": {
- "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": {
- "type": "string"
- },
- "invoice_period_description": {
- "type": "string"
- },
- "negotiations_allowed": {
- "description": "Whether counterparties can propose changes to agreements created from this template.",
- "type": "boolean"
- },
- "payment_period": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "payment_period_other": {
- "type": "string"
- },
- "payment_period_timeframe": {
- "type": "string"
- },
- "payment_period_type": {
- "type": "string"
- },
- "payment_period_unit": {
- "type": "string"
- },
- "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": {
- "type": "string"
- },
- "sow_term_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "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": {
- "type": "string"
- },
- "sow_term_unit": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "template_setting_attributes": {
- "additionalProperties": false,
- "description": "Template settings such as standard version and message.",
- "properties": {
- "include_message": {
- "type": "boolean"
- },
- "message": {
- "type": "string"
- },
- "standard_version": {
- "type": "string"
- },
- "subsidiary_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"
- }
- },
- "type": "object"
- },
- "type": {
- "description": "The type of template to create.",
- "type": "string"
- },
- "version": {
- "type": "string"
- }
- },
- "required": [
- "type"
- ],
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "additional_changes": {
- "description": "Text of additional changes to include when include_additional_changes is true.",
- "type": "string"
- },
- "attachment_ids": {
- "description": "UUIDs of attachments to include with the template.",
- "items": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "type": "array"
- },
- "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"
- },
- "customer_description": {
- "type": "string"
- },
- "default_signer_email": {
- "description": "Default email address pre-filled as the signer when creating agreements from this template.",
- "format": "email",
- "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
- "type": "string"
- },
- "district_or_county": {
- "description": "The district or county for dispute resolution.",
- "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": {
- "type": "string"
- },
- "governing_law_country": {
- "description": "The country whose laws govern agreements created from this template.",
- "type": "string"
- },
- "governing_law_region": {
- "description": "The state or region whose laws govern agreements created from this template.",
- "type": "string"
- },
- "include_additional_changes": {
- "description": "Whether to include the additional changes section.",
- "type": "boolean"
- },
- "include_fees": {
- "type": "boolean"
- },
- "include_fees_amount": {
- "type": "number"
- },
- "include_fees_description": {
- "type": "string"
- },
- "include_fees_pay_by_amount": {},
- "include_fees_type": {
- "type": "string"
- },
- "include_fees_unit": {
- "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": {
- "type": "string"
- },
- "include_program_participation_feedback": {
- "type": "boolean"
- },
- "include_program_participation_feedback_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_program_participation_feedback_unit": {
- "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"
- },
- "include_terms": {
- "description": "Whether to include standard terms in the agreement.",
- "type": "boolean"
- },
- "name": {
- "description": "A name for the template.",
- "type": "string"
- },
- "negotiations_allowed": {
- "description": "Whether counterparties can propose changes to agreements created from this template.",
- "type": "boolean"
- },
- "product_description": {
- "type": "string"
- },
- "recipient_role": {
- "description": "The label for the receiving party in the agreement.",
- "type": "string"
- },
- "sender_last_to_sign": {
- "description": "When true, the sender signs after the recipient.",
- "type": "boolean"
- },
- "sender_role": {
- "description": "The label for the sending party in the agreement.",
- "type": "string"
- },
- "template_setting_attributes": {
- "additionalProperties": false,
- "description": "Template settings such as standard version and message.",
- "properties": {
- "include_message": {
- "type": "boolean"
- },
- "message": {
- "type": "string"
- },
- "standard_version": {
- "type": "string"
- },
- "subsidiary_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"
- }
- },
- "type": "object"
- },
- "term_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "term_unit": {
- "type": "string"
- },
- "type": {
- "description": "The type of template to create.",
- "type": "string"
- },
- "version": {
- "type": "string"
- }
- },
- "required": [
- "type"
- ],
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "additional_changes": {
- "description": "Text of additional changes to include when include_additional_changes is true.",
- "type": "string"
- },
- "attachment_ids": {
- "description": "UUIDs of attachments to include with the template.",
- "items": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "type": "array"
- },
- "billing_workflow_type": {
- "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"
- },
- "default_signer_email": {
- "description": "Default email address pre-filled as the signer when creating agreements from this template.",
- "format": "email",
- "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
- "type": "string"
- },
- "district_or_county": {
- "description": "The district or county for dispute resolution.",
- "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": {
- "type": "string"
- },
- "general_cap_amount": {
- "type": "number"
- },
- "general_cap_amount_type": {
- "type": "string"
- },
- "general_cap_period_currency": {
- "type": "number"
- },
- "general_cap_period_qty": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "general_cap_preceding_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "governing_law_country": {
- "description": "The country whose laws govern agreements created from this template.",
- "type": "string"
- },
- "governing_law_region": {
- "description": "The state or region whose laws govern agreements created from this template.",
- "type": "string"
- },
- "include_additional_changes": {
- "description": "Whether to include the additional changes section.",
- "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_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_billing_workflow": {
- "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_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": {
- "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_terms": {
- "description": "Whether to include standard terms in the agreement.",
- "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": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "increased_cap_amount_qty": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "increased_cap_amount_type": {
- "type": "string"
- },
- "name": {
- "description": "A name for the template.",
- "type": "string"
- },
- "negotiations_allowed": {
- "description": "Whether counterparties can propose changes to agreements created from this template.",
- "type": "boolean"
- },
- "payment_link_url": {
- "type": "string"
- },
- "recipient_role": {
- "description": "The label for the receiving party in the agreement.",
- "type": "string"
- },
- "sender_last_to_sign": {
- "description": "When true, the sender signs after the recipient.",
- "type": "boolean"
- },
- "sender_role": {
- "description": "The label for the sending party in the agreement.",
- "type": "string"
- },
- "stripe_invoice_delivery": {
- "type": "string"
- },
- "stripe_payment_link_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"
- },
- "stripe_product_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"
- },
- "stripe_product_name": {
- "type": "string"
- },
- "stripe_subsequent_bill_method": {
- "type": "string"
- },
- "template_setting_attributes": {
- "additionalProperties": false,
- "description": "Template settings such as standard version and message.",
- "properties": {
- "include_message": {
- "type": "boolean"
- },
- "message": {
- "type": "string"
- },
- "standard_version": {
- "type": "string"
- },
- "subsidiary_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"
- }
- },
- "type": "object"
- },
- "template_software_license_order_form_attributes": {
- "additionalProperties": false,
- "description": "Nested software license order form defaults.",
- "properties": {
- "additional_changes": {
- "description": "Text of additional changes to include when include_additional_changes is true.",
- "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": {
- "type": "string"
- },
- "fees_attributes": {
- "items": {
- "additionalProperties": false,
- "properties": {
- "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"
- },
- "cost": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "description": {
- "type": "string"
- },
- "discount_duration_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "discount_duration_type": {
- "type": "string"
- },
- "discount_type": {
- "type": "string"
- },
- "fee_type": {
- "type": "string"
- },
- "graduated_fee_tiers_attributes": {
- "items": {
- "additionalProperties": false,
- "properties": {
- "flat_price": {
- "type": "string"
- },
- "price_per_unit": {
- "type": "string"
- },
- "upper_limit": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- }
- },
- "type": "object"
- },
- "type": "array"
- },
- "quantity": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "stripe_product_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"
- },
- "type": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "type": "array"
- },
- "fees_currency": {
- "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": {
- "type": "string"
- },
- "fees_inclusive_of_taxes": {
- "type": "boolean"
- },
- "include_additional_changes": {
- "description": "Whether to include the additional changes section.",
- "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": {
- "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": "Whether counterparties can propose changes to agreements created from this template.",
- "type": "boolean"
- },
- "order_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"
- },
- "order_date_type": {
- "type": "string"
- },
- "payment_process_automatic_frequency": {
- "type": "string"
- },
- "payment_process_type": {
- "type": "string"
- },
- "payment_process_type_custom_val": {
- "type": "string"
- },
- "payment_process_type_invoice_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "payment_process_type_invoice_custom_unit": {
- "type": "string"
- },
- "payment_process_type_invoice_duration": {
- "type": "string"
- },
- "payment_process_type_invoice_duration_start": {
- "type": "string"
- },
- "payment_process_type_invoice_type": {
- "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": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "software_description": {
- "type": "string"
- },
- "subscription_auto_renew": {
- "type": "string"
- },
- "subscription_period": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "subscription_period_unit": {
- "type": "string"
- },
- "subscription_renewal_notice_days": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "warranty_period_description_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "warranty_period_description_duration": {
- "type": "string"
- },
- "warranty_period_description_duration_start": {
- "type": "string"
- },
- "warranty_period_type": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "type": {
- "description": "The type of template to create.",
- "type": "string"
- }
- },
- "required": [
- "type"
- ],
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "additional_changes": {
- "description": "Text of additional changes to include when include_additional_changes is true.",
- "type": "string"
- },
- "additional_terms": {
- "type": "string"
- },
- "attachment_ids": {
- "description": "UUIDs of attachments to include with the template.",
- "items": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "type": "array"
- },
- "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"
- },
- "default_signer_email": {
- "description": "Default email address pre-filled as the signer when creating agreements from this template.",
- "format": "email",
- "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
- "type": "string"
- },
- "district_or_county": {
- "description": "The district or county for dispute resolution.",
- "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": {
- "type": "string"
- },
- "fees_type": {
- "type": "string"
- },
- "general_cap_amount": {
- "type": "number"
- },
- "general_cap_amount_type": {
- "type": "string"
- },
- "general_cap_period_currency": {
- "type": "number"
- },
- "general_cap_period_qty": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "general_cap_preceding_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "governing_law_country": {
- "description": "The country whose laws govern agreements created from this template.",
- "type": "string"
- },
- "governing_law_region": {
- "description": "The state or region whose laws govern agreements created from this template.",
- "type": "string"
- },
- "include_additional_changes": {
- "description": "Whether to include the additional changes section.",
- "type": "boolean"
- },
- "include_additional_terms": {
- "type": "boolean"
- },
- "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": {
- "type": "string"
- },
- "include_payment_process": {
- "type": "boolean"
- },
- "include_technical_support": {
- "type": "boolean"
- },
- "include_terms": {
- "description": "Whether to include standard terms in the agreement.",
- "type": "boolean"
- },
- "name": {
- "description": "A name for the template.",
- "type": "string"
- },
- "negotiations_allowed": {
- "description": "Whether counterparties can propose changes to agreements created from this template.",
- "type": "boolean"
- },
- "payment_process_automatic_frequency": {
- "type": "string"
- },
- "payment_process_invoice_days": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "payment_process_invoice_from": {
- "type": "string"
- },
- "payment_process_invoice_timeframe": {
- "type": "string"
- },
- "payment_process_type": {
- "type": "string"
- },
- "pilot_period_description": {
- "type": "string"
- },
- "pilot_period_fees_description": {
- "type": "string"
- },
- "product_description": {
- "type": "string"
- },
- "recipient_role": {
- "description": "The label for the receiving party in the agreement.",
- "type": "string"
- },
- "sender_last_to_sign": {
- "description": "When true, the sender signs after the recipient.",
- "type": "boolean"
- },
- "sender_role": {
- "description": "The label for the sending party in the agreement.",
- "type": "string"
- },
- "technical_support_description": {
- "type": "string"
- },
- "template_setting_attributes": {
- "additionalProperties": false,
- "description": "Template settings such as standard version and message.",
- "properties": {
- "include_message": {
- "type": "boolean"
- },
- "message": {
- "type": "string"
- },
- "standard_version": {
- "type": "string"
- },
- "subsidiary_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"
- }
- },
- "type": "object"
- },
- "type": {
- "description": "The type of template to create.",
- "type": "string"
- }
- },
- "required": [
- "type"
- ],
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "additional_changes": {
- "description": "Text of additional changes to include when include_additional_changes is true.",
- "type": "string"
- },
- "attachment_ids": {
- "description": "UUIDs of attachments to include with the template.",
- "items": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "type": "array"
- },
- "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"
- },
- "default_signer_email": {
- "description": "Default email address pre-filled as the signer when creating agreements from this template.",
- "format": "email",
- "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
- "type": "string"
- },
- "district_or_county": {
- "description": "The district or county for dispute resolution.",
- "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": {
- "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": {
- "type": "string"
- },
- "governing_law_country": {
- "description": "The country whose laws govern agreements created from this template.",
- "type": "string"
- },
- "governing_law_region": {
- "description": "The state or region whose laws govern agreements created from this template.",
- "type": "string"
- },
- "include_additional_changes": {
- "description": "Whether to include the additional changes section.",
- "type": "boolean"
- },
- "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": {
- "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": {},
- "include_increased_cap_amount_multiple": {},
- "include_increased_cap_amount_type": {
- "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_terms": {
- "description": "Whether to include standard terms in the agreement.",
- "type": "boolean"
- },
- "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"
- },
- "name": {
- "description": "A name for the template.",
- "type": "string"
- },
- "negotiations_allowed": {
- "description": "Whether counterparties can propose changes to agreements created from this template.",
- "type": "boolean"
- },
- "recipient_role": {
- "description": "The label for the receiving party in the agreement.",
- "type": "string"
- },
- "sender_last_to_sign": {
- "description": "When true, the sender signs after the recipient.",
- "type": "boolean"
- },
- "sender_role": {
- "description": "The label for the sending party in the agreement.",
- "type": "string"
- },
- "template_partnership_business_terms_attributes": {
- "additionalProperties": false,
- "description": "Nested partnership business terms defaults.",
- "properties": {
- "end_date_after_effective_date_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "end_date_after_effective_date_unit": {
- "type": "string"
- },
- "end_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"
- },
- "end_date_type": {
- "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": {
- "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": {
- "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": {
- "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": {
- "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": {
- "format": "email",
- "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
- "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": {
- "format": "email",
- "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
- "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": {
- "type": "string"
- },
- "include_payment_schedule_specified_unit": {
- "type": "string"
- },
- "include_payment_schedule_type": {
- "type": "string"
- },
- "negotiations_allowed": {
- "description": "Whether counterparties can propose changes to agreements created from this template.",
- "type": "boolean"
- },
- "territory_type": {
- "type": "string"
- },
- "territory_type_val": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "template_setting_attributes": {
- "additionalProperties": false,
- "description": "Template settings such as standard version and message.",
- "properties": {
- "include_message": {
- "type": "boolean"
- },
- "message": {
- "type": "string"
- },
- "standard_version": {
- "type": "string"
- },
- "subsidiary_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"
- }
- },
- "type": "object"
- },
- "type": {
- "description": "The type of template to create.",
- "type": "string"
- }
- },
- "required": [
- "type"
- ],
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "additional_changes": {
- "description": "Text of additional changes to include when include_additional_changes is true.",
- "type": "string"
- },
- "aggregation_limitations_permitted": {
- "type": "boolean"
- },
- "aggregation_limitations_permitted_val": {
- "type": "string"
- },
- "attachment_ids": {
- "description": "UUIDs of attachments to include with the template.",
- "items": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "type": "array"
- },
- "breach_notification_unit": {
- "type": "string"
- },
- "breach_notification_val": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "business_associate_relationship_type": {
- "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"
- },
- "default_signer_email": {
- "description": "Default email address pre-filled as the signer when creating agreements from this template.",
- "format": "email",
- "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
- "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"
- },
- "district_or_county": {
- "description": "The district or county for dispute resolution.",
- "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": {
- "type": "string"
- },
- "governing_law_country": {
- "description": "The country whose laws govern agreements created from this template.",
- "type": "string"
- },
- "governing_law_region": {
- "description": "The state or region whose laws govern agreements created from this template.",
- "type": "string"
- },
- "include_additional_changes": {
- "description": "Whether to include the additional changes section.",
- "type": "boolean"
- },
- "include_aggregation_limitations": {
- "type": "boolean"
- },
- "include_deidentification_limitations": {
- "type": "boolean"
- },
- "include_limitations": {
- "type": "boolean"
- },
- "include_offshore_limitations": {
- "type": "boolean"
- },
- "include_subcontract_limitations": {
- "type": "boolean"
- },
- "include_terms": {
- "description": "Whether to include standard terms in the agreement.",
- "type": "boolean"
- },
- "name": {
- "description": "A name for the template.",
- "type": "string"
- },
- "negotiations_allowed": {
- "description": "Whether counterparties can propose changes to agreements created from this template.",
- "type": "boolean"
- },
- "offshore_limitations_permitted": {
- "type": "boolean"
- },
- "offshore_limitations_permitted_val": {
- "type": "string"
- },
- "recipient_role": {
- "description": "The label for the receiving party in the agreement.",
- "type": "string"
- },
- "sender_last_to_sign": {
- "description": "When true, the sender signs after the recipient.",
- "type": "boolean"
- },
- "sender_role": {
- "description": "The label for the sending party in the agreement.",
- "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"
- },
- "template_setting_attributes": {
- "additionalProperties": false,
- "description": "Template settings such as standard version and message.",
- "properties": {
- "include_message": {
- "type": "boolean"
- },
- "message": {
- "type": "string"
- },
- "standard_version": {
- "type": "string"
- },
- "subsidiary_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"
- }
- },
- "type": "object"
- },
- "type": {
- "description": "The type of template to create.",
- "type": "string"
- }
- },
- "required": [
- "type"
- ],
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "additional_changes": {
- "description": "Text of additional changes to include when include_additional_changes is true.",
- "type": "string"
- },
- "attachment_ids": {
- "description": "UUIDs of attachments to include with the template.",
- "items": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "type": "array"
- },
- "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"
- },
- "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": {
- "type": "string"
- },
- "confidentiality_type": {
- "type": "string"
- },
- "default_signer_email": {
- "description": "Default email address pre-filled as the signer when creating agreements from this template.",
- "format": "email",
- "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
- "type": "string"
- },
- "district_or_county": {
- "description": "The district or county for dispute resolution.",
- "type": "string"
- },
- "governing_law_country": {
- "description": "The country whose laws govern agreements created from this template.",
- "type": "string"
- },
- "governing_law_region": {
- "description": "The state or region whose laws govern agreements created from this template.",
- "type": "string"
- },
- "include_additional_changes": {
- "description": "Whether to include the additional changes section.",
- "type": "boolean"
- },
- "include_custom_details": {
- "type": "boolean"
- },
- "include_custom_details_val": {
- "type": "string"
- },
- "include_fees": {
- "type": "boolean"
- },
- "include_fees_amount": {
- "type": "number"
- },
- "include_fees_amount_duration": {
- "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": {
- "type": "string"
- },
- "include_terms": {
- "description": "Whether to include standard terms in the agreement.",
- "type": "boolean"
- },
- "name": {
- "description": "A name for the template.",
- "type": "string"
- },
- "negotiations_allowed": {
- "description": "Whether counterparties can propose changes to agreements created from this template.",
- "type": "boolean"
- },
- "product_name": {
- "type": "string"
- },
- "recipient_role": {
- "description": "The label for the receiving party in the agreement.",
- "type": "string"
- },
- "sender_last_to_sign": {
- "description": "When true, the sender signs after the recipient.",
- "type": "boolean"
- },
- "sender_role": {
- "description": "The label for the sending party in the agreement.",
- "type": "string"
- },
- "template_setting_attributes": {
- "additionalProperties": false,
- "description": "Template settings such as standard version and message.",
- "properties": {
- "include_message": {
- "type": "boolean"
- },
- "message": {
- "type": "string"
- },
- "standard_version": {
- "type": "string"
- },
- "subsidiary_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"
- }
- },
- "type": "object"
- },
- "type": {
- "description": "The type of template to create.",
- "type": "string"
- }
- },
- "required": [
- "type"
- ],
- "type": "object"
- }
-]New value: +[
+ {
+ "additionalProperties": false,
+ "properties": {
+ "additional_changes": {
+ "description": "Text of additional changes to include when include_additional_changes is true.",
+ "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"
+ },
+ "confidentiality_period": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "confidentiality_period_perpetual": {
+ "type": "boolean"
+ },
+ "default_signer_email": {
+ "description": "Default email address pre-filled as the signer when creating agreements from this template.",
+ "format": "email",
+ "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "district_or_county": {
+ "description": "The district or county for dispute resolution.",
+ "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_of_confidentiality": {
+ "type": "string"
+ },
+ "effective_date_type": {
+ "type": "string"
+ },
+ "governing_law_country": {
+ "description": "The country whose laws govern agreements created from this template.",
+ "type": "string"
+ },
+ "governing_law_region": {
+ "description": "The state or region whose laws govern agreements created from this template.",
+ "type": "string"
+ },
+ "include_additional_changes": {
+ "description": "Whether to include the additional changes section.",
+ "type": "boolean"
+ },
+ "include_terms": {
+ "description": "Whether to include standard terms in the agreement.",
+ "type": "boolean"
+ },
+ "name": {
+ "description": "A name for the template.",
+ "type": "string"
+ },
+ "negotiations_allowed": {
+ "description": "Whether counterparties can propose changes to agreements created from this template.",
+ "type": "boolean"
+ },
+ "purpose": {
+ "type": "string"
+ },
+ "recipient_role": {
+ "description": "The label for the receiving party in the agreement.",
+ "type": "string"
+ },
+ "sender_last_to_sign": {
+ "description": "When true, the sender signs after the recipient.",
+ "type": "boolean"
+ },
+ "sender_role": {
+ "description": "The label for the sending party in the agreement.",
+ "type": "string"
+ },
+ "template_setting_attributes": {
+ "additionalProperties": false,
+ "description": "Template settings such as standard version and message.",
+ "properties": {
+ "include_message": {
+ "type": "boolean"
+ },
+ "message": {
+ "type": "string"
+ },
+ "standard_version": {
+ "type": "string"
+ },
+ "subsidiary_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"
+ }
+ },
+ "type": "object"
+ },
+ "term": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "term_period_perpetual": {
+ "type": "boolean"
+ },
+ "type": {
+ "description": "Optional. When omitted, the template defaults to NDA.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "additional_changes": {
+ "description": "Text of additional changes to include when include_additional_changes is true.",
+ "type": "string"
+ },
+ "attachment_ids": {
+ "description": "UUIDs of attachments to include with the template.",
+ "items": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "billing_workflow_type": {
+ "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"
+ },
+ "customer_description": {
+ "type": "string"
+ },
+ "default_signer_email": {
+ "description": "Default email address pre-filled as the signer when creating agreements from this template.",
+ "format": "email",
+ "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "district_or_county": {
+ "description": "The district or county for dispute resolution.",
+ "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": {
+ "type": "string"
+ },
+ "effective_date_type": {
+ "type": "string"
+ },
+ "general_cap_amount": {
+ "type": "number"
+ },
+ "general_cap_amount_type": {
+ "type": "string"
+ },
+ "general_cap_period_currency": {
+ "type": "number"
+ },
+ "general_cap_period_qty": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "general_cap_preceding_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "governing_law_country": {
+ "description": "The country whose laws govern agreements created from this template.",
+ "type": "string"
+ },
+ "governing_law_region": {
+ "description": "The state or region whose laws govern agreements created from this template.",
+ "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": {
+ "type": "string"
+ },
+ "include_additional_changes": {
+ "description": "Whether to include the additional changes section.",
+ "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_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_billing_workflow": {
+ "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_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": {
+ "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": {
+ "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": {
+ "type": "string"
+ },
+ "include_terms": {
+ "description": "Whether to include standard terms in the agreement.",
+ "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": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "increased_cap_amount_qty": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "increased_cap_amount_type": {
+ "type": "string"
+ },
+ "name": {
+ "description": "A name for the template.",
+ "type": "string"
+ },
+ "negotiations_allowed": {
+ "description": "Whether counterparties can propose changes to agreements created from this template.",
+ "type": "boolean"
+ },
+ "payment_link_url": {
+ "type": "string"
+ },
+ "provider": {
+ "type": "string"
+ },
+ "recipient_role": {
+ "description": "The label for the receiving party in the agreement.",
+ "type": "string"
+ },
+ "sender_last_to_sign": {
+ "description": "When true, the sender signs after the recipient.",
+ "type": "boolean"
+ },
+ "sender_role": {
+ "description": "The label for the sending party in the agreement.",
+ "type": "string"
+ },
+ "stripe_invoice_delivery": {
+ "type": "string"
+ },
+ "stripe_payment_link_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"
+ },
+ "stripe_product_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"
+ },
+ "stripe_product_name": {
+ "type": "string"
+ },
+ "stripe_subsequent_bill_method": {
+ "type": "string"
+ },
+ "template_csa_order_form_attributes": {
+ "additionalProperties": false,
+ "description": "Nested CSA order form defaults. See Template Parameters docs for CSA Order Form.",
+ "properties": {
+ "additional_changes": {
+ "description": "Text of additional changes to include when include_additional_changes is true.",
+ "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": {
+ "type": "string"
+ },
+ "fees_attributes": {
+ "items": {
+ "additionalProperties": false,
+ "properties": {
+ "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"
+ },
+ "cost": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "description": {
+ "type": "string"
+ },
+ "discount_duration_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "discount_duration_type": {
+ "type": "string"
+ },
+ "discount_type": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "graduated_fee_tiers_attributes": {
+ "items": {
+ "additionalProperties": false,
+ "properties": {
+ "flat_price": {
+ "type": "string"
+ },
+ "price_per_unit": {
+ "type": "string"
+ },
+ "upper_limit": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "quantity": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "stripe_product_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"
+ },
+ "type": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "fees_currency": {
+ "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": {
+ "type": "string"
+ },
+ "fees_inclusive_of_taxes": {
+ "type": "boolean"
+ },
+ "free_trial_days": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_additional_changes": {
+ "description": "Whether to include the additional changes section.",
+ "type": "boolean"
+ },
+ "include_additional_parameters_or_limitations": {
+ "type": "boolean"
+ },
+ "include_billing_info": {
+ "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": {
+ "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": {
+ "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": {
+ "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": {
+ "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": {
+ "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": {
+ "type": "string"
+ },
+ "include_sla_standard_maintenance_notice_qty": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_sla_standard_maintenance_notice_unit": {
+ "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": {
+ "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": {
+ "type": "string"
+ },
+ "invoice_period_custom_unit": {
+ "type": "string"
+ },
+ "max_consumption": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "max_users": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "negotiations_allowed": {
+ "description": "Whether counterparties can propose changes to agreements created from this template.",
+ "type": "boolean"
+ },
+ "order_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"
+ },
+ "order_date_other": {
+ "type": "string"
+ },
+ "order_date_type": {
+ "type": "string"
+ },
+ "payment_period": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "payment_period_timeframe": {
+ "type": "string"
+ },
+ "payment_period_unit": {
+ "type": "string"
+ },
+ "payment_process_automatic_frequency": {
+ "type": "string"
+ },
+ "payment_process_type": {
+ "type": "string"
+ },
+ "payment_process_type_custom_val": {
+ "type": "string"
+ },
+ "payment_process_type_invoice_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "payment_process_type_invoice_custom_unit": {
+ "type": "string"
+ },
+ "payment_process_type_invoice_duration": {
+ "type": "string"
+ },
+ "payment_process_type_invoice_duration_start": {
+ "type": "string"
+ },
+ "payment_process_type_invoice_type": {
+ "type": "string"
+ },
+ "pilot_period_stripe_product_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"
+ },
+ "service_credits_attributes": {
+ "items": {
+ "additionalProperties": false,
+ "properties": {
+ "credit": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "max": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "min": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "subscription_auto_renew": {
+ "type": "string"
+ },
+ "subscription_period": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "subscription_period_unit": {
+ "type": "string"
+ },
+ "subscription_renewal_notice_days": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "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": {
+ "type": "string"
+ },
+ "use_limitations_attributes": {
+ "items": {
+ "additionalProperties": false,
+ "properties": {
+ "amount": {
+ "type": "string"
+ },
+ "limitation_type": {
+ "type": "string"
+ },
+ "unit": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "template_setting_attributes": {
+ "additionalProperties": false,
+ "description": "Template settings such as standard version and message.",
+ "properties": {
+ "include_message": {
+ "type": "boolean"
+ },
+ "message": {
+ "type": "string"
+ },
+ "standard_version": {
+ "type": "string"
+ },
+ "subsidiary_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"
+ }
+ },
+ "type": "object"
+ },
+ "type": {
+ "description": "The type of template to create.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "type"
+ ],
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "additional_changes": {
+ "description": "Text of additional changes to include when include_additional_changes is true.",
+ "type": "string"
+ },
+ "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_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"
+ },
+ "default_signer_email": {
+ "description": "Default email address pre-filled as the signer when creating agreements from this template.",
+ "format": "email",
+ "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "duration_of_processing": {
+ "type": "string"
+ },
+ "include_additional_changes": {
+ "description": "Whether to include the additional changes section.",
+ "type": "boolean"
+ },
+ "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-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"
+ },
+ "include_terms": {
+ "description": "Whether to include standard terms in the agreement.",
+ "type": "boolean"
+ },
+ "name": {
+ "description": "A name for the template.",
+ "type": "string"
+ },
+ "negotiations_allowed": {
+ "description": "Whether counterparties can propose changes to agreements created from this template.",
+ "type": "boolean"
+ },
+ "provider": {
+ "type": "string"
+ },
+ "recipient_role": {
+ "description": "The label for the receiving party in the agreement.",
+ "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"
+ },
+ "sender_last_to_sign": {
+ "description": "When true, the sender signs after the recipient.",
+ "type": "boolean"
+ },
+ "sender_role": {
+ "description": "The label for the sending party in the agreement.",
+ "type": "string"
+ },
+ "subprocessors_attributes": {
+ "description": "List of subprocessors. Each item may include name, country, and processing_task. On update, an item without `id` adds a subprocessor; pass `id` to change one and `id` with `_destroy: true` to remove one.",
+ "items": {
+ "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": {
+ "description": "Subprocessor name.",
+ "type": "string"
+ },
+ "processing_task": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "template_setting_attributes": {
+ "additionalProperties": false,
+ "description": "Template settings such as standard version and message.",
+ "properties": {
+ "include_message": {
+ "type": "boolean"
+ },
+ "message": {
+ "type": "string"
+ },
+ "standard_version": {
+ "type": "string"
+ },
+ "subsidiary_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"
+ }
+ },
+ "type": "object"
+ },
+ "type": {
+ "description": "The type of template to create.",
+ "type": "string"
+ },
+ "underlying_agreement_val": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "type"
+ ],
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "additional_changes": {
+ "description": "Text of additional changes to include when include_additional_changes is true.",
+ "type": "string"
+ },
+ "attachment_ids": {
+ "description": "UUIDs of attachments to include with the template.",
+ "items": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "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"
+ },
+ "default_signer_email": {
+ "description": "Default email address pre-filled as the signer when creating agreements from this template.",
+ "format": "email",
+ "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "district_or_county": {
+ "description": "The district or county for dispute resolution.",
+ "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": {
+ "type": "string"
+ },
+ "general_cap_amount": {
+ "type": "number"
+ },
+ "general_cap_amount_type": {
+ "type": "string"
+ },
+ "general_cap_period_currency": {
+ "type": "number"
+ },
+ "general_cap_period_qty": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "general_cap_preceding_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "governing_law_country": {
+ "description": "The country whose laws govern agreements created from this template.",
+ "type": "string"
+ },
+ "governing_law_region": {
+ "description": "The state or region whose laws govern agreements created from this template.",
+ "type": "string"
+ },
+ "include_additional_changes": {
+ "description": "Whether to include the additional changes section.",
+ "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": {
+ "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": {
+ "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": {
+ "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": {
+ "type": "string"
+ },
+ "include_terms": {
+ "description": "Whether to include standard terms in the agreement.",
+ "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_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": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "increased_cap_amount_qty": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "increased_cap_amount_type": {
+ "type": "string"
+ },
+ "name": {
+ "description": "A name for the template.",
+ "type": "string"
+ },
+ "negotiations_allowed": {
+ "description": "Whether counterparties can propose changes to agreements created from this template.",
+ "type": "boolean"
+ },
+ "recipient_role": {
+ "description": "The label for the receiving party in the agreement.",
+ "type": "string"
+ },
+ "sender_last_to_sign": {
+ "description": "When true, the sender signs after the recipient.",
+ "type": "boolean"
+ },
+ "sender_role": {
+ "description": "The label for the sending party in the agreement.",
+ "type": "string"
+ },
+ "template_psa_statement_of_work_attributes": {
+ "additionalProperties": false,
+ "description": "Nested PSA statement of work defaults.",
+ "properties": {
+ "additional_changes": {
+ "description": "Text of additional changes to include when include_additional_changes is true.",
+ "type": "string"
+ },
+ "fees_attributes": {
+ "items": {
+ "additionalProperties": false,
+ "properties": {
+ "cost": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "description": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "quantity": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "include_additional_changes": {
+ "description": "Whether to include the additional changes section.",
+ "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": {
+ "type": "string"
+ },
+ "include_deliverables_resubmission_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_deliverables_resubmission_unit": {
+ "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": {
+ "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": {
+ "type": "string"
+ },
+ "invoice_period_description": {
+ "type": "string"
+ },
+ "negotiations_allowed": {
+ "description": "Whether counterparties can propose changes to agreements created from this template.",
+ "type": "boolean"
+ },
+ "payment_period": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "payment_period_other": {
+ "type": "string"
+ },
+ "payment_period_timeframe": {
+ "type": "string"
+ },
+ "payment_period_type": {
+ "type": "string"
+ },
+ "payment_period_unit": {
+ "type": "string"
+ },
+ "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": {
+ "type": "string"
+ },
+ "sow_term_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "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": {
+ "type": "string"
+ },
+ "sow_term_unit": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "template_setting_attributes": {
+ "additionalProperties": false,
+ "description": "Template settings such as standard version and message.",
+ "properties": {
+ "include_message": {
+ "type": "boolean"
+ },
+ "message": {
+ "type": "string"
+ },
+ "standard_version": {
+ "type": "string"
+ },
+ "subsidiary_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"
+ }
+ },
+ "type": "object"
+ },
+ "type": {
+ "description": "The type of template to create.",
+ "type": "string"
+ },
+ "version": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "type"
+ ],
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "additional_changes": {
+ "description": "Text of additional changes to include when include_additional_changes is true.",
+ "type": "string"
+ },
+ "attachment_ids": {
+ "description": "UUIDs of attachments to include with the template.",
+ "items": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "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"
+ },
+ "customer_description": {
+ "type": "string"
+ },
+ "default_signer_email": {
+ "description": "Default email address pre-filled as the signer when creating agreements from this template.",
+ "format": "email",
+ "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "district_or_county": {
+ "description": "The district or county for dispute resolution.",
+ "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": {
+ "type": "string"
+ },
+ "governing_law_country": {
+ "description": "The country whose laws govern agreements created from this template.",
+ "type": "string"
+ },
+ "governing_law_region": {
+ "description": "The state or region whose laws govern agreements created from this template.",
+ "type": "string"
+ },
+ "include_additional_changes": {
+ "description": "Whether to include the additional changes section.",
+ "type": "boolean"
+ },
+ "include_fees": {
+ "type": "boolean"
+ },
+ "include_fees_amount": {
+ "type": "number"
+ },
+ "include_fees_description": {
+ "type": "string"
+ },
+ "include_fees_pay_by_amount": {},
+ "include_fees_type": {
+ "type": "string"
+ },
+ "include_fees_unit": {
+ "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": {
+ "type": "string"
+ },
+ "include_program_participation_feedback": {
+ "type": "boolean"
+ },
+ "include_program_participation_feedback_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_program_participation_feedback_unit": {
+ "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"
+ },
+ "include_terms": {
+ "description": "Whether to include standard terms in the agreement.",
+ "type": "boolean"
+ },
+ "name": {
+ "description": "A name for the template.",
+ "type": "string"
+ },
+ "negotiations_allowed": {
+ "description": "Whether counterparties can propose changes to agreements created from this template.",
+ "type": "boolean"
+ },
+ "product_description": {
+ "type": "string"
+ },
+ "recipient_role": {
+ "description": "The label for the receiving party in the agreement.",
+ "type": "string"
+ },
+ "sender_last_to_sign": {
+ "description": "When true, the sender signs after the recipient.",
+ "type": "boolean"
+ },
+ "sender_role": {
+ "description": "The label for the sending party in the agreement.",
+ "type": "string"
+ },
+ "template_setting_attributes": {
+ "additionalProperties": false,
+ "description": "Template settings such as standard version and message.",
+ "properties": {
+ "include_message": {
+ "type": "boolean"
+ },
+ "message": {
+ "type": "string"
+ },
+ "standard_version": {
+ "type": "string"
+ },
+ "subsidiary_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"
+ }
+ },
+ "type": "object"
+ },
+ "term_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "term_unit": {
+ "type": "string"
+ },
+ "type": {
+ "description": "The type of template to create.",
+ "type": "string"
+ },
+ "version": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "type"
+ ],
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "additional_changes": {
+ "description": "Text of additional changes to include when include_additional_changes is true.",
+ "type": "string"
+ },
+ "attachment_ids": {
+ "description": "UUIDs of attachments to include with the template.",
+ "items": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "billing_workflow_type": {
+ "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"
+ },
+ "default_signer_email": {
+ "description": "Default email address pre-filled as the signer when creating agreements from this template.",
+ "format": "email",
+ "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "district_or_county": {
+ "description": "The district or county for dispute resolution.",
+ "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": {
+ "type": "string"
+ },
+ "general_cap_amount": {
+ "type": "number"
+ },
+ "general_cap_amount_type": {
+ "type": "string"
+ },
+ "general_cap_period_currency": {
+ "type": "number"
+ },
+ "general_cap_period_qty": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "general_cap_preceding_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "governing_law_country": {
+ "description": "The country whose laws govern agreements created from this template.",
+ "type": "string"
+ },
+ "governing_law_region": {
+ "description": "The state or region whose laws govern agreements created from this template.",
+ "type": "string"
+ },
+ "include_additional_changes": {
+ "description": "Whether to include the additional changes section.",
+ "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_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_billing_workflow": {
+ "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_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": {
+ "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_terms": {
+ "description": "Whether to include standard terms in the agreement.",
+ "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": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "increased_cap_amount_qty": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "increased_cap_amount_type": {
+ "type": "string"
+ },
+ "name": {
+ "description": "A name for the template.",
+ "type": "string"
+ },
+ "negotiations_allowed": {
+ "description": "Whether counterparties can propose changes to agreements created from this template.",
+ "type": "boolean"
+ },
+ "payment_link_url": {
+ "type": "string"
+ },
+ "recipient_role": {
+ "description": "The label for the receiving party in the agreement.",
+ "type": "string"
+ },
+ "sender_last_to_sign": {
+ "description": "When true, the sender signs after the recipient.",
+ "type": "boolean"
+ },
+ "sender_role": {
+ "description": "The label for the sending party in the agreement.",
+ "type": "string"
+ },
+ "stripe_invoice_delivery": {
+ "type": "string"
+ },
+ "stripe_payment_link_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"
+ },
+ "stripe_product_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"
+ },
+ "stripe_product_name": {
+ "type": "string"
+ },
+ "stripe_subsequent_bill_method": {
+ "type": "string"
+ },
+ "template_setting_attributes": {
+ "additionalProperties": false,
+ "description": "Template settings such as standard version and message.",
+ "properties": {
+ "include_message": {
+ "type": "boolean"
+ },
+ "message": {
+ "type": "string"
+ },
+ "standard_version": {
+ "type": "string"
+ },
+ "subsidiary_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"
+ }
+ },
+ "type": "object"
+ },
+ "template_software_license_order_form_attributes": {
+ "additionalProperties": false,
+ "description": "Nested software license order form defaults.",
+ "properties": {
+ "additional_changes": {
+ "description": "Text of additional changes to include when include_additional_changes is true.",
+ "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": {
+ "type": "string"
+ },
+ "fees_attributes": {
+ "items": {
+ "additionalProperties": false,
+ "properties": {
+ "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"
+ },
+ "cost": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "description": {
+ "type": "string"
+ },
+ "discount_duration_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "discount_duration_type": {
+ "type": "string"
+ },
+ "discount_type": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "graduated_fee_tiers_attributes": {
+ "items": {
+ "additionalProperties": false,
+ "properties": {
+ "flat_price": {
+ "type": "string"
+ },
+ "price_per_unit": {
+ "type": "string"
+ },
+ "upper_limit": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "quantity": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "stripe_product_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"
+ },
+ "type": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "fees_currency": {
+ "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": {
+ "type": "string"
+ },
+ "fees_inclusive_of_taxes": {
+ "type": "boolean"
+ },
+ "include_additional_changes": {
+ "description": "Whether to include the additional changes section.",
+ "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": {
+ "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": "Whether counterparties can propose changes to agreements created from this template.",
+ "type": "boolean"
+ },
+ "order_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"
+ },
+ "order_date_type": {
+ "type": "string"
+ },
+ "payment_process_automatic_frequency": {
+ "type": "string"
+ },
+ "payment_process_type": {
+ "type": "string"
+ },
+ "payment_process_type_custom_val": {
+ "type": "string"
+ },
+ "payment_process_type_invoice_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "payment_process_type_invoice_custom_unit": {
+ "type": "string"
+ },
+ "payment_process_type_invoice_duration": {
+ "type": "string"
+ },
+ "payment_process_type_invoice_duration_start": {
+ "type": "string"
+ },
+ "payment_process_type_invoice_type": {
+ "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": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "software_description": {
+ "type": "string"
+ },
+ "subscription_auto_renew": {
+ "type": "string"
+ },
+ "subscription_period": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "subscription_period_unit": {
+ "type": "string"
+ },
+ "subscription_renewal_notice_days": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "warranty_period_description_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "warranty_period_description_duration": {
+ "type": "string"
+ },
+ "warranty_period_description_duration_start": {
+ "type": "string"
+ },
+ "warranty_period_type": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "type": {
+ "description": "The type of template to create.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "type"
+ ],
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "additional_changes": {
+ "description": "Text of additional changes to include when include_additional_changes is true.",
+ "type": "string"
+ },
+ "additional_terms": {
+ "type": "string"
+ },
+ "attachment_ids": {
+ "description": "UUIDs of attachments to include with the template.",
+ "items": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "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"
+ },
+ "default_signer_email": {
+ "description": "Default email address pre-filled as the signer when creating agreements from this template.",
+ "format": "email",
+ "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "district_or_county": {
+ "description": "The district or county for dispute resolution.",
+ "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": {
+ "type": "string"
+ },
+ "fees_type": {
+ "type": "string"
+ },
+ "general_cap_amount": {
+ "type": "number"
+ },
+ "general_cap_amount_type": {
+ "type": "string"
+ },
+ "general_cap_period_currency": {
+ "type": "number"
+ },
+ "general_cap_period_qty": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "general_cap_preceding_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "governing_law_country": {
+ "description": "The country whose laws govern agreements created from this template.",
+ "type": "string"
+ },
+ "governing_law_region": {
+ "description": "The state or region whose laws govern agreements created from this template.",
+ "type": "string"
+ },
+ "include_additional_changes": {
+ "description": "Whether to include the additional changes section.",
+ "type": "boolean"
+ },
+ "include_additional_terms": {
+ "type": "boolean"
+ },
+ "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": {
+ "type": "string"
+ },
+ "include_payment_process": {
+ "type": "boolean"
+ },
+ "include_technical_support": {
+ "type": "boolean"
+ },
+ "include_terms": {
+ "description": "Whether to include standard terms in the agreement.",
+ "type": "boolean"
+ },
+ "name": {
+ "description": "A name for the template.",
+ "type": "string"
+ },
+ "negotiations_allowed": {
+ "description": "Whether counterparties can propose changes to agreements created from this template.",
+ "type": "boolean"
+ },
+ "payment_process_automatic_frequency": {
+ "type": "string"
+ },
+ "payment_process_invoice_days": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "payment_process_invoice_from": {
+ "type": "string"
+ },
+ "payment_process_invoice_timeframe": {
+ "type": "string"
+ },
+ "payment_process_type": {
+ "type": "string"
+ },
+ "pilot_period_description": {
+ "type": "string"
+ },
+ "pilot_period_fees_description": {
+ "type": "string"
+ },
+ "product_description": {
+ "type": "string"
+ },
+ "recipient_role": {
+ "description": "The label for the receiving party in the agreement.",
+ "type": "string"
+ },
+ "sender_last_to_sign": {
+ "description": "When true, the sender signs after the recipient.",
+ "type": "boolean"
+ },
+ "sender_role": {
+ "description": "The label for the sending party in the agreement.",
+ "type": "string"
+ },
+ "technical_support_description": {
+ "type": "string"
+ },
+ "template_setting_attributes": {
+ "additionalProperties": false,
+ "description": "Template settings such as standard version and message.",
+ "properties": {
+ "include_message": {
+ "type": "boolean"
+ },
+ "message": {
+ "type": "string"
+ },
+ "standard_version": {
+ "type": "string"
+ },
+ "subsidiary_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"
+ }
+ },
+ "type": "object"
+ },
+ "type": {
+ "description": "The type of template to create.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "type"
+ ],
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "additional_changes": {
+ "description": "Text of additional changes to include when include_additional_changes is true.",
+ "type": "string"
+ },
+ "attachment_ids": {
+ "description": "UUIDs of attachments to include with the template.",
+ "items": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "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"
+ },
+ "default_signer_email": {
+ "description": "Default email address pre-filled as the signer when creating agreements from this template.",
+ "format": "email",
+ "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "district_or_county": {
+ "description": "The district or county for dispute resolution.",
+ "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": {
+ "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": {
+ "type": "string"
+ },
+ "governing_law_country": {
+ "description": "The country whose laws govern agreements created from this template.",
+ "type": "string"
+ },
+ "governing_law_region": {
+ "description": "The state or region whose laws govern agreements created from this template.",
+ "type": "string"
+ },
+ "include_additional_changes": {
+ "description": "Whether to include the additional changes section.",
+ "type": "boolean"
+ },
+ "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": {
+ "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": {},
+ "include_increased_cap_amount_multiple": {},
+ "include_increased_cap_amount_type": {
+ "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_terms": {
+ "description": "Whether to include standard terms in the agreement.",
+ "type": "boolean"
+ },
+ "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"
+ },
+ "name": {
+ "description": "A name for the template.",
+ "type": "string"
+ },
+ "negotiations_allowed": {
+ "description": "Whether counterparties can propose changes to agreements created from this template.",
+ "type": "boolean"
+ },
+ "recipient_role": {
+ "description": "The label for the receiving party in the agreement.",
+ "type": "string"
+ },
+ "sender_last_to_sign": {
+ "description": "When true, the sender signs after the recipient.",
+ "type": "boolean"
+ },
+ "sender_role": {
+ "description": "The label for the sending party in the agreement.",
+ "type": "string"
+ },
+ "template_partnership_business_terms_attributes": {
+ "additionalProperties": false,
+ "description": "Nested partnership business terms defaults.",
+ "properties": {
+ "end_date_after_effective_date_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "end_date_after_effective_date_unit": {
+ "type": "string"
+ },
+ "end_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"
+ },
+ "end_date_type": {
+ "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": {
+ "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": {
+ "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": {
+ "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": {
+ "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": {
+ "format": "email",
+ "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "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": {
+ "format": "email",
+ "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "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": {
+ "type": "string"
+ },
+ "include_payment_schedule_specified_unit": {
+ "type": "string"
+ },
+ "include_payment_schedule_type": {
+ "type": "string"
+ },
+ "negotiations_allowed": {
+ "description": "Whether counterparties can propose changes to agreements created from this template.",
+ "type": "boolean"
+ },
+ "territory_type": {
+ "type": "string"
+ },
+ "territory_type_val": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "template_setting_attributes": {
+ "additionalProperties": false,
+ "description": "Template settings such as standard version and message.",
+ "properties": {
+ "include_message": {
+ "type": "boolean"
+ },
+ "message": {
+ "type": "string"
+ },
+ "standard_version": {
+ "type": "string"
+ },
+ "subsidiary_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"
+ }
+ },
+ "type": "object"
+ },
+ "type": {
+ "description": "The type of template to create.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "type"
+ ],
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "additional_changes": {
+ "description": "Text of additional changes to include when include_additional_changes is true.",
+ "type": "string"
+ },
+ "aggregation_limitations_permitted": {
+ "type": "boolean"
+ },
+ "aggregation_limitations_permitted_val": {
+ "type": "string"
+ },
+ "attachment_ids": {
+ "description": "UUIDs of attachments to include with the template.",
+ "items": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "breach_notification_unit": {
+ "type": "string"
+ },
+ "breach_notification_val": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "business_associate_relationship_type": {
+ "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"
+ },
+ "default_signer_email": {
+ "description": "Default email address pre-filled as the signer when creating agreements from this template.",
+ "format": "email",
+ "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "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"
+ },
+ "district_or_county": {
+ "description": "The district or county for dispute resolution.",
+ "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": {
+ "type": "string"
+ },
+ "governing_law_country": {
+ "description": "The country whose laws govern agreements created from this template.",
+ "type": "string"
+ },
+ "governing_law_region": {
+ "description": "The state or region whose laws govern agreements created from this template.",
+ "type": "string"
+ },
+ "include_additional_changes": {
+ "description": "Whether to include the additional changes section.",
+ "type": "boolean"
+ },
+ "include_aggregation_limitations": {
+ "type": "boolean"
+ },
+ "include_deidentification_limitations": {
+ "type": "boolean"
+ },
+ "include_limitations": {
+ "type": "boolean"
+ },
+ "include_offshore_limitations": {
+ "type": "boolean"
+ },
+ "include_subcontract_limitations": {
+ "type": "boolean"
+ },
+ "include_terms": {
+ "description": "Whether to include standard terms in the agreement.",
+ "type": "boolean"
+ },
+ "name": {
+ "description": "A name for the template.",
+ "type": "string"
+ },
+ "negotiations_allowed": {
+ "description": "Whether counterparties can propose changes to agreements created from this template.",
+ "type": "boolean"
+ },
+ "offshore_limitations_permitted": {
+ "type": "boolean"
+ },
+ "offshore_limitations_permitted_val": {
+ "type": "string"
+ },
+ "recipient_role": {
+ "description": "The label for the receiving party in the agreement.",
+ "type": "string"
+ },
+ "sender_last_to_sign": {
+ "description": "When true, the sender signs after the recipient.",
+ "type": "boolean"
+ },
+ "sender_role": {
+ "description": "The label for the sending party in the agreement.",
+ "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"
+ },
+ "template_setting_attributes": {
+ "additionalProperties": false,
+ "description": "Template settings such as standard version and message.",
+ "properties": {
+ "include_message": {
+ "type": "boolean"
+ },
+ "message": {
+ "type": "string"
+ },
+ "standard_version": {
+ "type": "string"
+ },
+ "subsidiary_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"
+ }
+ },
+ "type": "object"
+ },
+ "type": {
+ "description": "The type of template to create.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "type"
+ ],
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "additional_changes": {
+ "description": "Text of additional changes to include when include_additional_changes is true.",
+ "type": "string"
+ },
+ "attachment_ids": {
+ "description": "UUIDs of attachments to include with the template.",
+ "items": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "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"
+ },
+ "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": {
+ "type": "string"
+ },
+ "confidentiality_type": {
+ "type": "string"
+ },
+ "default_signer_email": {
+ "description": "Default email address pre-filled as the signer when creating agreements from this template.",
+ "format": "email",
+ "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "district_or_county": {
+ "description": "The district or county for dispute resolution.",
+ "type": "string"
+ },
+ "governing_law_country": {
+ "description": "The country whose laws govern agreements created from this template.",
+ "type": "string"
+ },
+ "governing_law_region": {
+ "description": "The state or region whose laws govern agreements created from this template.",
+ "type": "string"
+ },
+ "include_additional_changes": {
+ "description": "Whether to include the additional changes section.",
+ "type": "boolean"
+ },
+ "include_custom_details": {
+ "type": "boolean"
+ },
+ "include_custom_details_val": {
+ "type": "string"
+ },
+ "include_fees": {
+ "type": "boolean"
+ },
+ "include_fees_amount": {
+ "type": "number"
+ },
+ "include_fees_amount_duration": {
+ "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": {
+ "type": "string"
+ },
+ "include_terms": {
+ "description": "Whether to include standard terms in the agreement.",
+ "type": "boolean"
+ },
+ "name": {
+ "description": "A name for the template.",
+ "type": "string"
+ },
+ "negotiations_allowed": {
+ "description": "Whether counterparties can propose changes to agreements created from this template.",
+ "type": "boolean"
+ },
+ "product_name": {
+ "type": "string"
+ },
+ "recipient_role": {
+ "description": "The label for the receiving party in the agreement.",
+ "type": "string"
+ },
+ "sender_last_to_sign": {
+ "description": "When true, the sender signs after the recipient.",
+ "type": "boolean"
+ },
+ "sender_role": {
+ "description": "The label for the sending party in the agreement.",
+ "type": "string"
+ },
+ "template_setting_attributes": {
+ "additionalProperties": false,
+ "description": "Template settings such as standard version and message.",
+ "properties": {
+ "include_message": {
+ "type": "boolean"
+ },
+ "message": {
+ "type": "string"
+ },
+ "standard_version": {
+ "type": "string"
+ },
+ "subsidiary_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"
+ }
+ },
+ "type": "object"
+ },
+ "type": {
+ "description": "The type of template to create.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "type"
+ ],
+ "type": "object"
+ }
+]update-template1 field changedInput schema / properties / body / anyOfPrevious value: -[
- {
- "additionalProperties": false,
- "properties": {
- "additional_changes": {
- "description": "Text of additional changes to include when include_additional_changes is true.",
- "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"
- },
- "confidentiality_period": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "confidentiality_period_perpetual": {
- "type": "boolean"
- },
- "default_signer_email": {
- "description": "Default email address pre-filled as the signer when creating agreements from this template.",
- "format": "email",
- "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
- "type": "string"
- },
- "district_or_county": {
- "description": "The district or county for dispute resolution.",
- "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_of_confidentiality": {
- "type": "string"
- },
- "effective_date_type": {
- "type": "string"
- },
- "governing_law_country": {
- "description": "The country whose laws govern agreements created from this template.",
- "type": "string"
- },
- "governing_law_region": {
- "description": "The state or region whose laws govern agreements created from this template.",
- "type": "string"
- },
- "include_additional_changes": {
- "description": "Whether to include the additional changes section.",
- "type": "boolean"
- },
- "include_terms": {
- "description": "Whether to include standard terms in the agreement.",
- "type": "boolean"
- },
- "name": {
- "description": "A name for the template.",
- "type": "string"
- },
- "negotiations_allowed": {
- "description": "Whether counterparties can propose changes to agreements created from this template.",
- "type": "boolean"
- },
- "purpose": {
- "type": "string"
- },
- "recipient_role": {
- "description": "The label for the receiving party in the agreement.",
- "type": "string"
- },
- "sender_last_to_sign": {
- "description": "When true, the sender signs after the recipient.",
- "type": "boolean"
- },
- "sender_role": {
- "description": "The label for the sending party in the agreement.",
- "type": "string"
- },
- "template_setting_attributes": {
- "additionalProperties": false,
- "description": "Template settings such as standard version and message.",
- "properties": {
- "include_message": {
- "type": "boolean"
- },
- "message": {
- "type": "string"
- },
- "standard_version": {
- "type": "string"
- },
- "subsidiary_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"
- }
- },
- "type": "object"
- },
- "term": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "term_period_perpetual": {
- "type": "boolean"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "additional_changes": {
- "description": "Text of additional changes to include when include_additional_changes is true.",
- "type": "string"
- },
- "attachment_ids": {
- "description": "UUIDs of attachments to include with the template.",
- "items": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "type": "array"
- },
- "billing_workflow_type": {
- "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"
- },
- "customer_description": {
- "type": "string"
- },
- "default_signer_email": {
- "description": "Default email address pre-filled as the signer when creating agreements from this template.",
- "format": "email",
- "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
- "type": "string"
- },
- "district_or_county": {
- "description": "The district or county for dispute resolution.",
- "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": {
- "type": "string"
- },
- "effective_date_type": {
- "type": "string"
- },
- "general_cap_amount": {
- "type": "number"
- },
- "general_cap_amount_type": {
- "type": "string"
- },
- "general_cap_period_currency": {
- "type": "number"
- },
- "general_cap_period_qty": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "general_cap_preceding_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "governing_law_country": {
- "description": "The country whose laws govern agreements created from this template.",
- "type": "string"
- },
- "governing_law_region": {
- "description": "The state or region whose laws govern agreements created from this template.",
- "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": {
- "type": "string"
- },
- "include_additional_changes": {
- "description": "Whether to include the additional changes section.",
- "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_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_billing_workflow": {
- "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_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": {
- "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": {
- "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": {
- "type": "string"
- },
- "include_terms": {
- "description": "Whether to include standard terms in the agreement.",
- "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": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "increased_cap_amount_qty": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "increased_cap_amount_type": {
- "type": "string"
- },
- "name": {
- "description": "A name for the template.",
- "type": "string"
- },
- "negotiations_allowed": {
- "description": "Whether counterparties can propose changes to agreements created from this template.",
- "type": "boolean"
- },
- "payment_link_url": {
- "type": "string"
- },
- "provider": {
- "type": "string"
- },
- "recipient_role": {
- "description": "The label for the receiving party in the agreement.",
- "type": "string"
- },
- "sender_last_to_sign": {
- "description": "When true, the sender signs after the recipient.",
- "type": "boolean"
- },
- "sender_role": {
- "description": "The label for the sending party in the agreement.",
- "type": "string"
- },
- "stripe_invoice_delivery": {
- "type": "string"
- },
- "stripe_payment_link_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"
- },
- "stripe_product_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"
- },
- "stripe_product_name": {
- "type": "string"
- },
- "stripe_subsequent_bill_method": {
- "type": "string"
- },
- "template_csa_order_form_attributes": {
- "additionalProperties": false,
- "description": "Nested CSA order form defaults. See Template Parameters docs for CSA Order Form.",
- "properties": {
- "additional_changes": {
- "description": "Text of additional changes to include when include_additional_changes is true.",
- "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": {
- "type": "string"
- },
- "fees_attributes": {
- "items": {
- "additionalProperties": false,
- "properties": {
- "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"
- },
- "cost": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "description": {
- "type": "string"
- },
- "discount_duration_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "discount_duration_type": {
- "type": "string"
- },
- "discount_type": {
- "type": "string"
- },
- "fee_type": {
- "type": "string"
- },
- "graduated_fee_tiers_attributes": {
- "items": {
- "additionalProperties": false,
- "properties": {
- "flat_price": {
- "type": "string"
- },
- "price_per_unit": {
- "type": "string"
- },
- "upper_limit": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- }
- },
- "type": "object"
- },
- "type": "array"
- },
- "quantity": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "stripe_product_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"
- },
- "type": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "type": "array"
- },
- "fees_currency": {
- "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": {
- "type": "string"
- },
- "fees_inclusive_of_taxes": {
- "type": "boolean"
- },
- "free_trial_days": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_additional_changes": {
- "description": "Whether to include the additional changes section.",
- "type": "boolean"
- },
- "include_additional_parameters_or_limitations": {
- "type": "boolean"
- },
- "include_billing_info": {
- "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": {
- "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": {
- "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": {
- "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": {
- "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": {
- "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": {
- "type": "string"
- },
- "include_sla_standard_maintenance_notice_qty": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_sla_standard_maintenance_notice_unit": {
- "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": {
- "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": {
- "type": "string"
- },
- "invoice_period_custom_unit": {
- "type": "string"
- },
- "max_consumption": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "max_users": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "negotiations_allowed": {
- "description": "Whether counterparties can propose changes to agreements created from this template.",
- "type": "boolean"
- },
- "order_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"
- },
- "order_date_other": {
- "type": "string"
- },
- "order_date_type": {
- "type": "string"
- },
- "payment_period": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "payment_period_timeframe": {
- "type": "string"
- },
- "payment_period_unit": {
- "type": "string"
- },
- "payment_process_automatic_frequency": {
- "type": "string"
- },
- "payment_process_type": {
- "type": "string"
- },
- "payment_process_type_custom_val": {
- "type": "string"
- },
- "payment_process_type_invoice_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "payment_process_type_invoice_custom_unit": {
- "type": "string"
- },
- "payment_process_type_invoice_duration": {
- "type": "string"
- },
- "payment_process_type_invoice_duration_start": {
- "type": "string"
- },
- "payment_process_type_invoice_type": {
- "type": "string"
- },
- "pilot_period_stripe_product_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"
- },
- "service_credits_attributes": {
- "items": {
- "additionalProperties": false,
- "properties": {
- "credit": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "max": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "min": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- }
- },
- "type": "object"
- },
- "type": "array"
- },
- "subscription_auto_renew": {
- "type": "string"
- },
- "subscription_period": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "subscription_period_unit": {
- "type": "string"
- },
- "subscription_renewal_notice_days": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "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": {
- "type": "string"
- },
- "use_limitations_attributes": {
- "items": {
- "additionalProperties": false,
- "properties": {
- "amount": {
- "type": "string"
- },
- "limitation_type": {
- "type": "string"
- },
- "unit": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "type": "array"
- }
- },
- "type": "object"
- },
- "template_setting_attributes": {
- "additionalProperties": false,
- "description": "Template settings such as standard version and message.",
- "properties": {
- "include_message": {
- "type": "boolean"
- },
- "message": {
- "type": "string"
- },
- "standard_version": {
- "type": "string"
- },
- "subsidiary_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"
- }
- },
- "type": "object"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "additional_changes": {
- "description": "Text of additional changes to include when include_additional_changes is true.",
- "type": "string"
- },
- "approved_subprocessor_type": {
- "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"
- },
- "cloud_service_product_name": {
- "type": "string"
- },
- "competent_supervisory_authority": {
- "type": "string"
- },
- "customer_description": {
- "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"
- },
- "default_signer_email": {
- "description": "Default email address pre-filled as the signer when creating agreements from this template.",
- "format": "email",
- "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
- "type": "string"
- },
- "district_or_county": {
- "description": "The district or county for dispute resolution.",
- "type": "string"
- },
- "duration_of_processing": {
- "type": "string"
- },
- "governing_law_country": {
- "description": "The country whose laws govern agreements created from this template.",
- "type": "string"
- },
- "governing_law_region": {
- "description": "The state or region whose laws govern agreements created from this template.",
- "type": "string"
- },
- "include_additional_changes": {
- "description": "Whether to include the additional changes section.",
- "type": "boolean"
- },
- "include_covered_claim": {
- "type": "boolean"
- },
- "include_covered_claim_external_val": {
- "type": "string"
- },
- "include_covered_claim_internal_val": {
- "type": "string"
- },
- "include_covered_claim_type": {
- "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": {
- "type": "boolean"
- },
- "include_increased_claim_amount_currency": {
- "type": "string"
- },
- "include_increased_claim_amount_qty": {},
- "include_increased_claim_amount_type": {
- "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": {
- "type": "string"
- },
- "include_liability_cap_amount_currency_internal": {
- "type": "string"
- },
- "include_liability_cap_csa_type": {
- "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-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_provider": {
- "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"
- },
- "include_terms": {
- "description": "Whether to include standard terms in the agreement.",
- "type": "boolean"
- },
- "name": {
- "description": "A name for the template.",
- "type": "string"
- },
- "negotiations_allowed": {
- "description": "Whether counterparties can propose changes to agreements created from this template.",
- "type": "boolean"
- },
- "provider": {
- "type": "string"
- },
- "recipient_role": {
- "description": "The label for the receiving party in the agreement.",
- "type": "string"
- },
- "security_policy_available_at": {
- "type": "string"
- },
- "security_policy_type": {
- "type": "string"
- },
- "sender_last_to_sign": {
- "description": "When true, the sender signs after the recipient.",
- "type": "boolean"
- },
- "sender_role": {
- "description": "The label for the sending party in the agreement.",
- "type": "string"
- },
- "subprocessors_attributes": {
- "description": "List of subprocessors. Each item may include name, country, and processing_task.",
- "items": {
- "additionalProperties": false,
- "properties": {
- "country": {
- "type": "string"
- },
- "name": {
- "description": "A name for the template.",
- "type": "string"
- },
- "processing_task": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "type": "array"
- },
- "template_setting_attributes": {
- "additionalProperties": false,
- "description": "Template settings such as standard version and message.",
- "properties": {
- "include_message": {
- "type": "boolean"
- },
- "message": {
- "type": "string"
- },
- "standard_version": {
- "type": "string"
- },
- "subsidiary_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"
- }
- },
- "type": "object"
- },
- "underlying_agreement_val": {
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "additional_changes": {
- "description": "Text of additional changes to include when include_additional_changes is true.",
- "type": "string"
- },
- "attachment_ids": {
- "description": "UUIDs of attachments to include with the template.",
- "items": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "type": "array"
- },
- "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"
- },
- "default_signer_email": {
- "description": "Default email address pre-filled as the signer when creating agreements from this template.",
- "format": "email",
- "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
- "type": "string"
- },
- "district_or_county": {
- "description": "The district or county for dispute resolution.",
- "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": {
- "type": "string"
- },
- "general_cap_amount": {
- "type": "number"
- },
- "general_cap_amount_type": {
- "type": "string"
- },
- "general_cap_period_currency": {
- "type": "number"
- },
- "general_cap_period_qty": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "general_cap_preceding_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "governing_law_country": {
- "description": "The country whose laws govern agreements created from this template.",
- "type": "string"
- },
- "governing_law_region": {
- "description": "The state or region whose laws govern agreements created from this template.",
- "type": "string"
- },
- "include_additional_changes": {
- "description": "Whether to include the additional changes section.",
- "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": {
- "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": {
- "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": {
- "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": {
- "type": "string"
- },
- "include_terms": {
- "description": "Whether to include standard terms in the agreement.",
- "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_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": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "increased_cap_amount_qty": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "increased_cap_amount_type": {
- "type": "string"
- },
- "name": {
- "description": "A name for the template.",
- "type": "string"
- },
- "negotiations_allowed": {
- "description": "Whether counterparties can propose changes to agreements created from this template.",
- "type": "boolean"
- },
- "recipient_role": {
- "description": "The label for the receiving party in the agreement.",
- "type": "string"
- },
- "sender_last_to_sign": {
- "description": "When true, the sender signs after the recipient.",
- "type": "boolean"
- },
- "sender_role": {
- "description": "The label for the sending party in the agreement.",
- "type": "string"
- },
- "template_psa_statement_of_work_attributes": {
- "additionalProperties": false,
- "description": "Nested PSA statement of work defaults.",
- "properties": {
- "additional_changes": {
- "description": "Text of additional changes to include when include_additional_changes is true.",
- "type": "string"
- },
- "fees_attributes": {
- "items": {
- "additionalProperties": false,
- "properties": {
- "cost": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "description": {
- "type": "string"
- },
- "fee_type": {
- "type": "string"
- },
- "quantity": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- }
- },
- "type": "object"
- },
- "type": "array"
- },
- "include_additional_changes": {
- "description": "Whether to include the additional changes section.",
- "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": {
- "type": "string"
- },
- "include_deliverables_resubmission_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_deliverables_resubmission_unit": {
- "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": {
- "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": {
- "type": "string"
- },
- "invoice_period_description": {
- "type": "string"
- },
- "negotiations_allowed": {
- "description": "Whether counterparties can propose changes to agreements created from this template.",
- "type": "boolean"
- },
- "payment_period": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "payment_period_other": {
- "type": "string"
- },
- "payment_period_timeframe": {
- "type": "string"
- },
- "payment_period_type": {
- "type": "string"
- },
- "payment_period_unit": {
- "type": "string"
- },
- "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": {
- "type": "string"
- },
- "sow_term_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "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": {
- "type": "string"
- },
- "sow_term_unit": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "template_setting_attributes": {
- "additionalProperties": false,
- "description": "Template settings such as standard version and message.",
- "properties": {
- "include_message": {
- "type": "boolean"
- },
- "message": {
- "type": "string"
- },
- "standard_version": {
- "type": "string"
- },
- "subsidiary_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"
- }
- },
- "type": "object"
- },
- "version": {
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "additional_changes": {
- "description": "Text of additional changes to include when include_additional_changes is true.",
- "type": "string"
- },
- "attachment_ids": {
- "description": "UUIDs of attachments to include with the template.",
- "items": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "type": "array"
- },
- "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"
- },
- "customer_description": {
- "type": "string"
- },
- "default_signer_email": {
- "description": "Default email address pre-filled as the signer when creating agreements from this template.",
- "format": "email",
- "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
- "type": "string"
- },
- "district_or_county": {
- "description": "The district or county for dispute resolution.",
- "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": {
- "type": "string"
- },
- "governing_law_country": {
- "description": "The country whose laws govern agreements created from this template.",
- "type": "string"
- },
- "governing_law_region": {
- "description": "The state or region whose laws govern agreements created from this template.",
- "type": "string"
- },
- "include_additional_changes": {
- "description": "Whether to include the additional changes section.",
- "type": "boolean"
- },
- "include_fees": {
- "type": "boolean"
- },
- "include_fees_amount": {
- "type": "number"
- },
- "include_fees_description": {
- "type": "string"
- },
- "include_fees_pay_by_amount": {},
- "include_fees_type": {
- "type": "string"
- },
- "include_fees_unit": {
- "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": {
- "type": "string"
- },
- "include_program_participation_feedback": {
- "type": "boolean"
- },
- "include_program_participation_feedback_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_program_participation_feedback_unit": {
- "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"
- },
- "include_terms": {
- "description": "Whether to include standard terms in the agreement.",
- "type": "boolean"
- },
- "name": {
- "description": "A name for the template.",
- "type": "string"
- },
- "negotiations_allowed": {
- "description": "Whether counterparties can propose changes to agreements created from this template.",
- "type": "boolean"
- },
- "product_description": {
- "type": "string"
- },
- "recipient_role": {
- "description": "The label for the receiving party in the agreement.",
- "type": "string"
- },
- "sender_last_to_sign": {
- "description": "When true, the sender signs after the recipient.",
- "type": "boolean"
- },
- "sender_role": {
- "description": "The label for the sending party in the agreement.",
- "type": "string"
- },
- "template_setting_attributes": {
- "additionalProperties": false,
- "description": "Template settings such as standard version and message.",
- "properties": {
- "include_message": {
- "type": "boolean"
- },
- "message": {
- "type": "string"
- },
- "standard_version": {
- "type": "string"
- },
- "subsidiary_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"
- }
- },
- "type": "object"
- },
- "term_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "term_unit": {
- "type": "string"
- },
- "version": {
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "additional_changes": {
- "description": "Text of additional changes to include when include_additional_changes is true.",
- "type": "string"
- },
- "attachment_ids": {
- "description": "UUIDs of attachments to include with the template.",
- "items": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "type": "array"
- },
- "billing_workflow_type": {
- "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"
- },
- "default_signer_email": {
- "description": "Default email address pre-filled as the signer when creating agreements from this template.",
- "format": "email",
- "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
- "type": "string"
- },
- "district_or_county": {
- "description": "The district or county for dispute resolution.",
- "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": {
- "type": "string"
- },
- "general_cap_amount": {
- "type": "number"
- },
- "general_cap_amount_type": {
- "type": "string"
- },
- "general_cap_period_currency": {
- "type": "number"
- },
- "general_cap_period_qty": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "general_cap_preceding_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "governing_law_country": {
- "description": "The country whose laws govern agreements created from this template.",
- "type": "string"
- },
- "governing_law_region": {
- "description": "The state or region whose laws govern agreements created from this template.",
- "type": "string"
- },
- "include_additional_changes": {
- "description": "Whether to include the additional changes section.",
- "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_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_billing_workflow": {
- "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_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": {
- "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_terms": {
- "description": "Whether to include standard terms in the agreement.",
- "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": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "increased_cap_amount_qty": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "increased_cap_amount_type": {
- "type": "string"
- },
- "name": {
- "description": "A name for the template.",
- "type": "string"
- },
- "negotiations_allowed": {
- "description": "Whether counterparties can propose changes to agreements created from this template.",
- "type": "boolean"
- },
- "payment_link_url": {
- "type": "string"
- },
- "recipient_role": {
- "description": "The label for the receiving party in the agreement.",
- "type": "string"
- },
- "sender_last_to_sign": {
- "description": "When true, the sender signs after the recipient.",
- "type": "boolean"
- },
- "sender_role": {
- "description": "The label for the sending party in the agreement.",
- "type": "string"
- },
- "stripe_invoice_delivery": {
- "type": "string"
- },
- "stripe_payment_link_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"
- },
- "stripe_product_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"
- },
- "stripe_product_name": {
- "type": "string"
- },
- "stripe_subsequent_bill_method": {
- "type": "string"
- },
- "template_setting_attributes": {
- "additionalProperties": false,
- "description": "Template settings such as standard version and message.",
- "properties": {
- "include_message": {
- "type": "boolean"
- },
- "message": {
- "type": "string"
- },
- "standard_version": {
- "type": "string"
- },
- "subsidiary_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"
- }
- },
- "type": "object"
- },
- "template_software_license_order_form_attributes": {
- "additionalProperties": false,
- "description": "Nested software license order form defaults.",
- "properties": {
- "additional_changes": {
- "description": "Text of additional changes to include when include_additional_changes is true.",
- "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": {
- "type": "string"
- },
- "fees_attributes": {
- "items": {
- "additionalProperties": false,
- "properties": {
- "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"
- },
- "cost": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "description": {
- "type": "string"
- },
- "discount_duration_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "discount_duration_type": {
- "type": "string"
- },
- "discount_type": {
- "type": "string"
- },
- "fee_type": {
- "type": "string"
- },
- "graduated_fee_tiers_attributes": {
- "items": {
- "additionalProperties": false,
- "properties": {
- "flat_price": {
- "type": "string"
- },
- "price_per_unit": {
- "type": "string"
- },
- "upper_limit": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- }
- },
- "type": "object"
- },
- "type": "array"
- },
- "quantity": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "stripe_product_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"
- },
- "type": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "type": "array"
- },
- "fees_currency": {
- "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": {
- "type": "string"
- },
- "fees_inclusive_of_taxes": {
- "type": "boolean"
- },
- "include_additional_changes": {
- "description": "Whether to include the additional changes section.",
- "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": {
- "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": "Whether counterparties can propose changes to agreements created from this template.",
- "type": "boolean"
- },
- "order_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"
- },
- "order_date_type": {
- "type": "string"
- },
- "payment_process_automatic_frequency": {
- "type": "string"
- },
- "payment_process_type": {
- "type": "string"
- },
- "payment_process_type_custom_val": {
- "type": "string"
- },
- "payment_process_type_invoice_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "payment_process_type_invoice_custom_unit": {
- "type": "string"
- },
- "payment_process_type_invoice_duration": {
- "type": "string"
- },
- "payment_process_type_invoice_duration_start": {
- "type": "string"
- },
- "payment_process_type_invoice_type": {
- "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": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "software_description": {
- "type": "string"
- },
- "subscription_auto_renew": {
- "type": "string"
- },
- "subscription_period": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "subscription_period_unit": {
- "type": "string"
- },
- "subscription_renewal_notice_days": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "warranty_period_description_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "warranty_period_description_duration": {
- "type": "string"
- },
- "warranty_period_description_duration_start": {
- "type": "string"
- },
- "warranty_period_type": {
- "type": "string"
- }
- },
- "type": "object"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "additional_changes": {
- "description": "Text of additional changes to include when include_additional_changes is true.",
- "type": "string"
- },
- "additional_terms": {
- "type": "string"
- },
- "attachment_ids": {
- "description": "UUIDs of attachments to include with the template.",
- "items": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "type": "array"
- },
- "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"
- },
- "default_signer_email": {
- "description": "Default email address pre-filled as the signer when creating agreements from this template.",
- "format": "email",
- "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
- "type": "string"
- },
- "district_or_county": {
- "description": "The district or county for dispute resolution.",
- "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": {
- "type": "string"
- },
- "fees_type": {
- "type": "string"
- },
- "general_cap_amount": {
- "type": "number"
- },
- "general_cap_amount_type": {
- "type": "string"
- },
- "general_cap_period_currency": {
- "type": "number"
- },
- "general_cap_period_qty": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "general_cap_preceding_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "governing_law_country": {
- "description": "The country whose laws govern agreements created from this template.",
- "type": "string"
- },
- "governing_law_region": {
- "description": "The state or region whose laws govern agreements created from this template.",
- "type": "string"
- },
- "include_additional_changes": {
- "description": "Whether to include the additional changes section.",
- "type": "boolean"
- },
- "include_additional_terms": {
- "type": "boolean"
- },
- "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": {
- "type": "string"
- },
- "include_payment_process": {
- "type": "boolean"
- },
- "include_technical_support": {
- "type": "boolean"
- },
- "include_terms": {
- "description": "Whether to include standard terms in the agreement.",
- "type": "boolean"
- },
- "name": {
- "description": "A name for the template.",
- "type": "string"
- },
- "negotiations_allowed": {
- "description": "Whether counterparties can propose changes to agreements created from this template.",
- "type": "boolean"
- },
- "payment_process_automatic_frequency": {
- "type": "string"
- },
- "payment_process_invoice_days": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "payment_process_invoice_from": {
- "type": "string"
- },
- "payment_process_invoice_timeframe": {
- "type": "string"
- },
- "payment_process_type": {
- "type": "string"
- },
- "pilot_period_description": {
- "type": "string"
- },
- "pilot_period_fees_description": {
- "type": "string"
- },
- "product_description": {
- "type": "string"
- },
- "recipient_role": {
- "description": "The label for the receiving party in the agreement.",
- "type": "string"
- },
- "sender_last_to_sign": {
- "description": "When true, the sender signs after the recipient.",
- "type": "boolean"
- },
- "sender_role": {
- "description": "The label for the sending party in the agreement.",
- "type": "string"
- },
- "technical_support_description": {
- "type": "string"
- },
- "template_setting_attributes": {
- "additionalProperties": false,
- "description": "Template settings such as standard version and message.",
- "properties": {
- "include_message": {
- "type": "boolean"
- },
- "message": {
- "type": "string"
- },
- "standard_version": {
- "type": "string"
- },
- "subsidiary_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"
- }
- },
- "type": "object"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "additional_changes": {
- "description": "Text of additional changes to include when include_additional_changes is true.",
- "type": "string"
- },
- "attachment_ids": {
- "description": "UUIDs of attachments to include with the template.",
- "items": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "type": "array"
- },
- "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"
- },
- "default_signer_email": {
- "description": "Default email address pre-filled as the signer when creating agreements from this template.",
- "format": "email",
- "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
- "type": "string"
- },
- "district_or_county": {
- "description": "The district or county for dispute resolution.",
- "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": {
- "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": {
- "type": "string"
- },
- "governing_law_country": {
- "description": "The country whose laws govern agreements created from this template.",
- "type": "string"
- },
- "governing_law_region": {
- "description": "The state or region whose laws govern agreements created from this template.",
- "type": "string"
- },
- "include_additional_changes": {
- "description": "Whether to include the additional changes section.",
- "type": "boolean"
- },
- "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": {
- "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": {},
- "include_increased_cap_amount_multiple": {},
- "include_increased_cap_amount_type": {
- "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_terms": {
- "description": "Whether to include standard terms in the agreement.",
- "type": "boolean"
- },
- "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"
- },
- "name": {
- "description": "A name for the template.",
- "type": "string"
- },
- "negotiations_allowed": {
- "description": "Whether counterparties can propose changes to agreements created from this template.",
- "type": "boolean"
- },
- "recipient_role": {
- "description": "The label for the receiving party in the agreement.",
- "type": "string"
- },
- "sender_last_to_sign": {
- "description": "When true, the sender signs after the recipient.",
- "type": "boolean"
- },
- "sender_role": {
- "description": "The label for the sending party in the agreement.",
- "type": "string"
- },
- "template_partnership_business_terms_attributes": {
- "additionalProperties": false,
- "description": "Nested partnership business terms defaults.",
- "properties": {
- "end_date_after_effective_date_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "end_date_after_effective_date_unit": {
- "type": "string"
- },
- "end_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"
- },
- "end_date_type": {
- "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": {
- "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": {
- "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": {
- "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": {
- "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": {
- "format": "email",
- "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
- "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": {
- "format": "email",
- "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
- "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": {
- "type": "string"
- },
- "include_payment_schedule_specified_unit": {
- "type": "string"
- },
- "include_payment_schedule_type": {
- "type": "string"
- },
- "negotiations_allowed": {
- "description": "Whether counterparties can propose changes to agreements created from this template.",
- "type": "boolean"
- },
- "territory_type": {
- "type": "string"
- },
- "territory_type_val": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "template_setting_attributes": {
- "additionalProperties": false,
- "description": "Template settings such as standard version and message.",
- "properties": {
- "include_message": {
- "type": "boolean"
- },
- "message": {
- "type": "string"
- },
- "standard_version": {
- "type": "string"
- },
- "subsidiary_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"
- }
- },
- "type": "object"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "additional_changes": {
- "description": "Text of additional changes to include when include_additional_changes is true.",
- "type": "string"
- },
- "aggregation_limitations_permitted": {
- "type": "boolean"
- },
- "aggregation_limitations_permitted_val": {
- "type": "string"
- },
- "attachment_ids": {
- "description": "UUIDs of attachments to include with the template.",
- "items": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "type": "array"
- },
- "breach_notification_unit": {
- "type": "string"
- },
- "breach_notification_val": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "business_associate_relationship_type": {
- "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"
- },
- "default_signer_email": {
- "description": "Default email address pre-filled as the signer when creating agreements from this template.",
- "format": "email",
- "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
- "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"
- },
- "district_or_county": {
- "description": "The district or county for dispute resolution.",
- "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": {
- "type": "string"
- },
- "governing_law_country": {
- "description": "The country whose laws govern agreements created from this template.",
- "type": "string"
- },
- "governing_law_region": {
- "description": "The state or region whose laws govern agreements created from this template.",
- "type": "string"
- },
- "include_additional_changes": {
- "description": "Whether to include the additional changes section.",
- "type": "boolean"
- },
- "include_aggregation_limitations": {
- "type": "boolean"
- },
- "include_deidentification_limitations": {
- "type": "boolean"
- },
- "include_limitations": {
- "type": "boolean"
- },
- "include_offshore_limitations": {
- "type": "boolean"
- },
- "include_subcontract_limitations": {
- "type": "boolean"
- },
- "include_terms": {
- "description": "Whether to include standard terms in the agreement.",
- "type": "boolean"
- },
- "name": {
- "description": "A name for the template.",
- "type": "string"
- },
- "negotiations_allowed": {
- "description": "Whether counterparties can propose changes to agreements created from this template.",
- "type": "boolean"
- },
- "offshore_limitations_permitted": {
- "type": "boolean"
- },
- "offshore_limitations_permitted_val": {
- "type": "string"
- },
- "recipient_role": {
- "description": "The label for the receiving party in the agreement.",
- "type": "string"
- },
- "sender_last_to_sign": {
- "description": "When true, the sender signs after the recipient.",
- "type": "boolean"
- },
- "sender_role": {
- "description": "The label for the sending party in the agreement.",
- "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"
- },
- "template_setting_attributes": {
- "additionalProperties": false,
- "description": "Template settings such as standard version and message.",
- "properties": {
- "include_message": {
- "type": "boolean"
- },
- "message": {
- "type": "string"
- },
- "standard_version": {
- "type": "string"
- },
- "subsidiary_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"
- }
- },
- "type": "object"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "additional_changes": {
- "description": "Text of additional changes to include when include_additional_changes is true.",
- "type": "string"
- },
- "attachment_ids": {
- "description": "UUIDs of attachments to include with the template.",
- "items": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "type": "array"
- },
- "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"
- },
- "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": {
- "type": "string"
- },
- "confidentiality_type": {
- "type": "string"
- },
- "default_signer_email": {
- "description": "Default email address pre-filled as the signer when creating agreements from this template.",
- "format": "email",
- "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
- "type": "string"
- },
- "district_or_county": {
- "description": "The district or county for dispute resolution.",
- "type": "string"
- },
- "governing_law_country": {
- "description": "The country whose laws govern agreements created from this template.",
- "type": "string"
- },
- "governing_law_region": {
- "description": "The state or region whose laws govern agreements created from this template.",
- "type": "string"
- },
- "include_additional_changes": {
- "description": "Whether to include the additional changes section.",
- "type": "boolean"
- },
- "include_custom_details": {
- "type": "boolean"
- },
- "include_custom_details_val": {
- "type": "string"
- },
- "include_fees": {
- "type": "boolean"
- },
- "include_fees_amount": {
- "type": "number"
- },
- "include_fees_amount_duration": {
- "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": {
- "type": "string"
- },
- "include_terms": {
- "description": "Whether to include standard terms in the agreement.",
- "type": "boolean"
- },
- "name": {
- "description": "A name for the template.",
- "type": "string"
- },
- "negotiations_allowed": {
- "description": "Whether counterparties can propose changes to agreements created from this template.",
- "type": "boolean"
- },
- "product_name": {
- "type": "string"
- },
- "recipient_role": {
- "description": "The label for the receiving party in the agreement.",
- "type": "string"
- },
- "sender_last_to_sign": {
- "description": "When true, the sender signs after the recipient.",
- "type": "boolean"
- },
- "sender_role": {
- "description": "The label for the sending party in the agreement.",
- "type": "string"
- },
- "template_setting_attributes": {
- "additionalProperties": false,
- "description": "Template settings such as standard version and message.",
- "properties": {
- "include_message": {
- "type": "boolean"
- },
- "message": {
- "type": "string"
- },
- "standard_version": {
- "type": "string"
- },
- "subsidiary_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"
- }
- },
- "type": "object"
- }
- },
- "type": "object"
- }
-]New value: +[
+ {
+ "additionalProperties": false,
+ "properties": {
+ "additional_changes": {
+ "description": "Text of additional changes to include when include_additional_changes is true.",
+ "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"
+ },
+ "confidentiality_period": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "confidentiality_period_perpetual": {
+ "type": "boolean"
+ },
+ "default_signer_email": {
+ "description": "Default email address pre-filled as the signer when creating agreements from this template.",
+ "format": "email",
+ "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "district_or_county": {
+ "description": "The district or county for dispute resolution.",
+ "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_of_confidentiality": {
+ "type": "string"
+ },
+ "effective_date_type": {
+ "type": "string"
+ },
+ "governing_law_country": {
+ "description": "The country whose laws govern agreements created from this template.",
+ "type": "string"
+ },
+ "governing_law_region": {
+ "description": "The state or region whose laws govern agreements created from this template.",
+ "type": "string"
+ },
+ "include_additional_changes": {
+ "description": "Whether to include the additional changes section.",
+ "type": "boolean"
+ },
+ "include_terms": {
+ "description": "Whether to include standard terms in the agreement.",
+ "type": "boolean"
+ },
+ "name": {
+ "description": "A name for the template.",
+ "type": "string"
+ },
+ "negotiations_allowed": {
+ "description": "Whether counterparties can propose changes to agreements created from this template.",
+ "type": "boolean"
+ },
+ "purpose": {
+ "type": "string"
+ },
+ "recipient_role": {
+ "description": "The label for the receiving party in the agreement.",
+ "type": "string"
+ },
+ "sender_last_to_sign": {
+ "description": "When true, the sender signs after the recipient.",
+ "type": "boolean"
+ },
+ "sender_role": {
+ "description": "The label for the sending party in the agreement.",
+ "type": "string"
+ },
+ "template_setting_attributes": {
+ "additionalProperties": false,
+ "description": "Template settings such as standard version and message.",
+ "properties": {
+ "include_message": {
+ "type": "boolean"
+ },
+ "message": {
+ "type": "string"
+ },
+ "standard_version": {
+ "type": "string"
+ },
+ "subsidiary_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"
+ }
+ },
+ "type": "object"
+ },
+ "term": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "term_period_perpetual": {
+ "type": "boolean"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "additional_changes": {
+ "description": "Text of additional changes to include when include_additional_changes is true.",
+ "type": "string"
+ },
+ "attachment_ids": {
+ "description": "UUIDs of attachments to include with the template.",
+ "items": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "billing_workflow_type": {
+ "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"
+ },
+ "customer_description": {
+ "type": "string"
+ },
+ "default_signer_email": {
+ "description": "Default email address pre-filled as the signer when creating agreements from this template.",
+ "format": "email",
+ "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "district_or_county": {
+ "description": "The district or county for dispute resolution.",
+ "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": {
+ "type": "string"
+ },
+ "effective_date_type": {
+ "type": "string"
+ },
+ "general_cap_amount": {
+ "type": "number"
+ },
+ "general_cap_amount_type": {
+ "type": "string"
+ },
+ "general_cap_period_currency": {
+ "type": "number"
+ },
+ "general_cap_period_qty": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "general_cap_preceding_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "governing_law_country": {
+ "description": "The country whose laws govern agreements created from this template.",
+ "type": "string"
+ },
+ "governing_law_region": {
+ "description": "The state or region whose laws govern agreements created from this template.",
+ "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": {
+ "type": "string"
+ },
+ "include_additional_changes": {
+ "description": "Whether to include the additional changes section.",
+ "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_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_billing_workflow": {
+ "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_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": {
+ "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": {
+ "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": {
+ "type": "string"
+ },
+ "include_terms": {
+ "description": "Whether to include standard terms in the agreement.",
+ "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": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "increased_cap_amount_qty": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "increased_cap_amount_type": {
+ "type": "string"
+ },
+ "name": {
+ "description": "A name for the template.",
+ "type": "string"
+ },
+ "negotiations_allowed": {
+ "description": "Whether counterparties can propose changes to agreements created from this template.",
+ "type": "boolean"
+ },
+ "payment_link_url": {
+ "type": "string"
+ },
+ "provider": {
+ "type": "string"
+ },
+ "recipient_role": {
+ "description": "The label for the receiving party in the agreement.",
+ "type": "string"
+ },
+ "sender_last_to_sign": {
+ "description": "When true, the sender signs after the recipient.",
+ "type": "boolean"
+ },
+ "sender_role": {
+ "description": "The label for the sending party in the agreement.",
+ "type": "string"
+ },
+ "stripe_invoice_delivery": {
+ "type": "string"
+ },
+ "stripe_payment_link_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"
+ },
+ "stripe_product_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"
+ },
+ "stripe_product_name": {
+ "type": "string"
+ },
+ "stripe_subsequent_bill_method": {
+ "type": "string"
+ },
+ "template_csa_order_form_attributes": {
+ "additionalProperties": false,
+ "description": "Nested CSA order form defaults. See Template Parameters docs for CSA Order Form.",
+ "properties": {
+ "additional_changes": {
+ "description": "Text of additional changes to include when include_additional_changes is true.",
+ "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": {
+ "type": "string"
+ },
+ "fees_attributes": {
+ "items": {
+ "additionalProperties": false,
+ "properties": {
+ "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"
+ },
+ "cost": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "description": {
+ "type": "string"
+ },
+ "discount_duration_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "discount_duration_type": {
+ "type": "string"
+ },
+ "discount_type": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "graduated_fee_tiers_attributes": {
+ "items": {
+ "additionalProperties": false,
+ "properties": {
+ "flat_price": {
+ "type": "string"
+ },
+ "price_per_unit": {
+ "type": "string"
+ },
+ "upper_limit": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "quantity": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "stripe_product_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"
+ },
+ "type": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "fees_currency": {
+ "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": {
+ "type": "string"
+ },
+ "fees_inclusive_of_taxes": {
+ "type": "boolean"
+ },
+ "free_trial_days": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_additional_changes": {
+ "description": "Whether to include the additional changes section.",
+ "type": "boolean"
+ },
+ "include_additional_parameters_or_limitations": {
+ "type": "boolean"
+ },
+ "include_billing_info": {
+ "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": {
+ "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": {
+ "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": {
+ "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": {
+ "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": {
+ "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": {
+ "type": "string"
+ },
+ "include_sla_standard_maintenance_notice_qty": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_sla_standard_maintenance_notice_unit": {
+ "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": {
+ "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": {
+ "type": "string"
+ },
+ "invoice_period_custom_unit": {
+ "type": "string"
+ },
+ "max_consumption": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "max_users": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "negotiations_allowed": {
+ "description": "Whether counterparties can propose changes to agreements created from this template.",
+ "type": "boolean"
+ },
+ "order_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"
+ },
+ "order_date_other": {
+ "type": "string"
+ },
+ "order_date_type": {
+ "type": "string"
+ },
+ "payment_period": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "payment_period_timeframe": {
+ "type": "string"
+ },
+ "payment_period_unit": {
+ "type": "string"
+ },
+ "payment_process_automatic_frequency": {
+ "type": "string"
+ },
+ "payment_process_type": {
+ "type": "string"
+ },
+ "payment_process_type_custom_val": {
+ "type": "string"
+ },
+ "payment_process_type_invoice_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "payment_process_type_invoice_custom_unit": {
+ "type": "string"
+ },
+ "payment_process_type_invoice_duration": {
+ "type": "string"
+ },
+ "payment_process_type_invoice_duration_start": {
+ "type": "string"
+ },
+ "payment_process_type_invoice_type": {
+ "type": "string"
+ },
+ "pilot_period_stripe_product_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"
+ },
+ "service_credits_attributes": {
+ "items": {
+ "additionalProperties": false,
+ "properties": {
+ "credit": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "max": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "min": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "subscription_auto_renew": {
+ "type": "string"
+ },
+ "subscription_period": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "subscription_period_unit": {
+ "type": "string"
+ },
+ "subscription_renewal_notice_days": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "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": {
+ "type": "string"
+ },
+ "use_limitations_attributes": {
+ "items": {
+ "additionalProperties": false,
+ "properties": {
+ "amount": {
+ "type": "string"
+ },
+ "limitation_type": {
+ "type": "string"
+ },
+ "unit": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "template_setting_attributes": {
+ "additionalProperties": false,
+ "description": "Template settings such as standard version and message.",
+ "properties": {
+ "include_message": {
+ "type": "boolean"
+ },
+ "message": {
+ "type": "string"
+ },
+ "standard_version": {
+ "type": "string"
+ },
+ "subsidiary_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"
+ }
+ },
+ "type": "object"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "additional_changes": {
+ "description": "Text of additional changes to include when include_additional_changes is true.",
+ "type": "string"
+ },
+ "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_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"
+ },
+ "default_signer_email": {
+ "description": "Default email address pre-filled as the signer when creating agreements from this template.",
+ "format": "email",
+ "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "duration_of_processing": {
+ "type": "string"
+ },
+ "include_additional_changes": {
+ "description": "Whether to include the additional changes section.",
+ "type": "boolean"
+ },
+ "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-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"
+ },
+ "include_terms": {
+ "description": "Whether to include standard terms in the agreement.",
+ "type": "boolean"
+ },
+ "name": {
+ "description": "A name for the template.",
+ "type": "string"
+ },
+ "negotiations_allowed": {
+ "description": "Whether counterparties can propose changes to agreements created from this template.",
+ "type": "boolean"
+ },
+ "provider": {
+ "type": "string"
+ },
+ "recipient_role": {
+ "description": "The label for the receiving party in the agreement.",
+ "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"
+ },
+ "sender_last_to_sign": {
+ "description": "When true, the sender signs after the recipient.",
+ "type": "boolean"
+ },
+ "sender_role": {
+ "description": "The label for the sending party in the agreement.",
+ "type": "string"
+ },
+ "subprocessors_attributes": {
+ "description": "List of subprocessors. Each item may include name, country, and processing_task. On update, an item without `id` adds a subprocessor; pass `id` to change one and `id` with `_destroy: true` to remove one.",
+ "items": {
+ "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": {
+ "description": "Subprocessor name.",
+ "type": "string"
+ },
+ "processing_task": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "template_setting_attributes": {
+ "additionalProperties": false,
+ "description": "Template settings such as standard version and message.",
+ "properties": {
+ "include_message": {
+ "type": "boolean"
+ },
+ "message": {
+ "type": "string"
+ },
+ "standard_version": {
+ "type": "string"
+ },
+ "subsidiary_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"
+ }
+ },
+ "type": "object"
+ },
+ "underlying_agreement_val": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "additional_changes": {
+ "description": "Text of additional changes to include when include_additional_changes is true.",
+ "type": "string"
+ },
+ "attachment_ids": {
+ "description": "UUIDs of attachments to include with the template.",
+ "items": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "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"
+ },
+ "default_signer_email": {
+ "description": "Default email address pre-filled as the signer when creating agreements from this template.",
+ "format": "email",
+ "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "district_or_county": {
+ "description": "The district or county for dispute resolution.",
+ "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": {
+ "type": "string"
+ },
+ "general_cap_amount": {
+ "type": "number"
+ },
+ "general_cap_amount_type": {
+ "type": "string"
+ },
+ "general_cap_period_currency": {
+ "type": "number"
+ },
+ "general_cap_period_qty": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "general_cap_preceding_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "governing_law_country": {
+ "description": "The country whose laws govern agreements created from this template.",
+ "type": "string"
+ },
+ "governing_law_region": {
+ "description": "The state or region whose laws govern agreements created from this template.",
+ "type": "string"
+ },
+ "include_additional_changes": {
+ "description": "Whether to include the additional changes section.",
+ "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": {
+ "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": {
+ "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": {
+ "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": {
+ "type": "string"
+ },
+ "include_terms": {
+ "description": "Whether to include standard terms in the agreement.",
+ "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_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": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "increased_cap_amount_qty": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "increased_cap_amount_type": {
+ "type": "string"
+ },
+ "name": {
+ "description": "A name for the template.",
+ "type": "string"
+ },
+ "negotiations_allowed": {
+ "description": "Whether counterparties can propose changes to agreements created from this template.",
+ "type": "boolean"
+ },
+ "recipient_role": {
+ "description": "The label for the receiving party in the agreement.",
+ "type": "string"
+ },
+ "sender_last_to_sign": {
+ "description": "When true, the sender signs after the recipient.",
+ "type": "boolean"
+ },
+ "sender_role": {
+ "description": "The label for the sending party in the agreement.",
+ "type": "string"
+ },
+ "template_psa_statement_of_work_attributes": {
+ "additionalProperties": false,
+ "description": "Nested PSA statement of work defaults.",
+ "properties": {
+ "additional_changes": {
+ "description": "Text of additional changes to include when include_additional_changes is true.",
+ "type": "string"
+ },
+ "fees_attributes": {
+ "items": {
+ "additionalProperties": false,
+ "properties": {
+ "cost": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "description": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "quantity": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "include_additional_changes": {
+ "description": "Whether to include the additional changes section.",
+ "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": {
+ "type": "string"
+ },
+ "include_deliverables_resubmission_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_deliverables_resubmission_unit": {
+ "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": {
+ "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": {
+ "type": "string"
+ },
+ "invoice_period_description": {
+ "type": "string"
+ },
+ "negotiations_allowed": {
+ "description": "Whether counterparties can propose changes to agreements created from this template.",
+ "type": "boolean"
+ },
+ "payment_period": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "payment_period_other": {
+ "type": "string"
+ },
+ "payment_period_timeframe": {
+ "type": "string"
+ },
+ "payment_period_type": {
+ "type": "string"
+ },
+ "payment_period_unit": {
+ "type": "string"
+ },
+ "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": {
+ "type": "string"
+ },
+ "sow_term_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "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": {
+ "type": "string"
+ },
+ "sow_term_unit": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "template_setting_attributes": {
+ "additionalProperties": false,
+ "description": "Template settings such as standard version and message.",
+ "properties": {
+ "include_message": {
+ "type": "boolean"
+ },
+ "message": {
+ "type": "string"
+ },
+ "standard_version": {
+ "type": "string"
+ },
+ "subsidiary_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"
+ }
+ },
+ "type": "object"
+ },
+ "version": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "additional_changes": {
+ "description": "Text of additional changes to include when include_additional_changes is true.",
+ "type": "string"
+ },
+ "attachment_ids": {
+ "description": "UUIDs of attachments to include with the template.",
+ "items": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "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"
+ },
+ "customer_description": {
+ "type": "string"
+ },
+ "default_signer_email": {
+ "description": "Default email address pre-filled as the signer when creating agreements from this template.",
+ "format": "email",
+ "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "district_or_county": {
+ "description": "The district or county for dispute resolution.",
+ "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": {
+ "type": "string"
+ },
+ "governing_law_country": {
+ "description": "The country whose laws govern agreements created from this template.",
+ "type": "string"
+ },
+ "governing_law_region": {
+ "description": "The state or region whose laws govern agreements created from this template.",
+ "type": "string"
+ },
+ "include_additional_changes": {
+ "description": "Whether to include the additional changes section.",
+ "type": "boolean"
+ },
+ "include_fees": {
+ "type": "boolean"
+ },
+ "include_fees_amount": {
+ "type": "number"
+ },
+ "include_fees_description": {
+ "type": "string"
+ },
+ "include_fees_pay_by_amount": {},
+ "include_fees_type": {
+ "type": "string"
+ },
+ "include_fees_unit": {
+ "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": {
+ "type": "string"
+ },
+ "include_program_participation_feedback": {
+ "type": "boolean"
+ },
+ "include_program_participation_feedback_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_program_participation_feedback_unit": {
+ "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"
+ },
+ "include_terms": {
+ "description": "Whether to include standard terms in the agreement.",
+ "type": "boolean"
+ },
+ "name": {
+ "description": "A name for the template.",
+ "type": "string"
+ },
+ "negotiations_allowed": {
+ "description": "Whether counterparties can propose changes to agreements created from this template.",
+ "type": "boolean"
+ },
+ "product_description": {
+ "type": "string"
+ },
+ "recipient_role": {
+ "description": "The label for the receiving party in the agreement.",
+ "type": "string"
+ },
+ "sender_last_to_sign": {
+ "description": "When true, the sender signs after the recipient.",
+ "type": "boolean"
+ },
+ "sender_role": {
+ "description": "The label for the sending party in the agreement.",
+ "type": "string"
+ },
+ "template_setting_attributes": {
+ "additionalProperties": false,
+ "description": "Template settings such as standard version and message.",
+ "properties": {
+ "include_message": {
+ "type": "boolean"
+ },
+ "message": {
+ "type": "string"
+ },
+ "standard_version": {
+ "type": "string"
+ },
+ "subsidiary_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"
+ }
+ },
+ "type": "object"
+ },
+ "term_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "term_unit": {
+ "type": "string"
+ },
+ "version": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "additional_changes": {
+ "description": "Text of additional changes to include when include_additional_changes is true.",
+ "type": "string"
+ },
+ "attachment_ids": {
+ "description": "UUIDs of attachments to include with the template.",
+ "items": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "billing_workflow_type": {
+ "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"
+ },
+ "default_signer_email": {
+ "description": "Default email address pre-filled as the signer when creating agreements from this template.",
+ "format": "email",
+ "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "district_or_county": {
+ "description": "The district or county for dispute resolution.",
+ "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": {
+ "type": "string"
+ },
+ "general_cap_amount": {
+ "type": "number"
+ },
+ "general_cap_amount_type": {
+ "type": "string"
+ },
+ "general_cap_period_currency": {
+ "type": "number"
+ },
+ "general_cap_period_qty": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "general_cap_preceding_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "governing_law_country": {
+ "description": "The country whose laws govern agreements created from this template.",
+ "type": "string"
+ },
+ "governing_law_region": {
+ "description": "The state or region whose laws govern agreements created from this template.",
+ "type": "string"
+ },
+ "include_additional_changes": {
+ "description": "Whether to include the additional changes section.",
+ "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_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_billing_workflow": {
+ "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_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": {
+ "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_terms": {
+ "description": "Whether to include standard terms in the agreement.",
+ "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": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "increased_cap_amount_qty": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "increased_cap_amount_type": {
+ "type": "string"
+ },
+ "name": {
+ "description": "A name for the template.",
+ "type": "string"
+ },
+ "negotiations_allowed": {
+ "description": "Whether counterparties can propose changes to agreements created from this template.",
+ "type": "boolean"
+ },
+ "payment_link_url": {
+ "type": "string"
+ },
+ "recipient_role": {
+ "description": "The label for the receiving party in the agreement.",
+ "type": "string"
+ },
+ "sender_last_to_sign": {
+ "description": "When true, the sender signs after the recipient.",
+ "type": "boolean"
+ },
+ "sender_role": {
+ "description": "The label for the sending party in the agreement.",
+ "type": "string"
+ },
+ "stripe_invoice_delivery": {
+ "type": "string"
+ },
+ "stripe_payment_link_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"
+ },
+ "stripe_product_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"
+ },
+ "stripe_product_name": {
+ "type": "string"
+ },
+ "stripe_subsequent_bill_method": {
+ "type": "string"
+ },
+ "template_setting_attributes": {
+ "additionalProperties": false,
+ "description": "Template settings such as standard version and message.",
+ "properties": {
+ "include_message": {
+ "type": "boolean"
+ },
+ "message": {
+ "type": "string"
+ },
+ "standard_version": {
+ "type": "string"
+ },
+ "subsidiary_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"
+ }
+ },
+ "type": "object"
+ },
+ "template_software_license_order_form_attributes": {
+ "additionalProperties": false,
+ "description": "Nested software license order form defaults.",
+ "properties": {
+ "additional_changes": {
+ "description": "Text of additional changes to include when include_additional_changes is true.",
+ "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": {
+ "type": "string"
+ },
+ "fees_attributes": {
+ "items": {
+ "additionalProperties": false,
+ "properties": {
+ "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"
+ },
+ "cost": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "description": {
+ "type": "string"
+ },
+ "discount_duration_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "discount_duration_type": {
+ "type": "string"
+ },
+ "discount_type": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "graduated_fee_tiers_attributes": {
+ "items": {
+ "additionalProperties": false,
+ "properties": {
+ "flat_price": {
+ "type": "string"
+ },
+ "price_per_unit": {
+ "type": "string"
+ },
+ "upper_limit": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "quantity": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "stripe_product_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"
+ },
+ "type": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "fees_currency": {
+ "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": {
+ "type": "string"
+ },
+ "fees_inclusive_of_taxes": {
+ "type": "boolean"
+ },
+ "include_additional_changes": {
+ "description": "Whether to include the additional changes section.",
+ "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": {
+ "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": "Whether counterparties can propose changes to agreements created from this template.",
+ "type": "boolean"
+ },
+ "order_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"
+ },
+ "order_date_type": {
+ "type": "string"
+ },
+ "payment_process_automatic_frequency": {
+ "type": "string"
+ },
+ "payment_process_type": {
+ "type": "string"
+ },
+ "payment_process_type_custom_val": {
+ "type": "string"
+ },
+ "payment_process_type_invoice_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "payment_process_type_invoice_custom_unit": {
+ "type": "string"
+ },
+ "payment_process_type_invoice_duration": {
+ "type": "string"
+ },
+ "payment_process_type_invoice_duration_start": {
+ "type": "string"
+ },
+ "payment_process_type_invoice_type": {
+ "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": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "software_description": {
+ "type": "string"
+ },
+ "subscription_auto_renew": {
+ "type": "string"
+ },
+ "subscription_period": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "subscription_period_unit": {
+ "type": "string"
+ },
+ "subscription_renewal_notice_days": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "warranty_period_description_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "warranty_period_description_duration": {
+ "type": "string"
+ },
+ "warranty_period_description_duration_start": {
+ "type": "string"
+ },
+ "warranty_period_type": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "additional_changes": {
+ "description": "Text of additional changes to include when include_additional_changes is true.",
+ "type": "string"
+ },
+ "additional_terms": {
+ "type": "string"
+ },
+ "attachment_ids": {
+ "description": "UUIDs of attachments to include with the template.",
+ "items": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "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"
+ },
+ "default_signer_email": {
+ "description": "Default email address pre-filled as the signer when creating agreements from this template.",
+ "format": "email",
+ "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "district_or_county": {
+ "description": "The district or county for dispute resolution.",
+ "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": {
+ "type": "string"
+ },
+ "fees_type": {
+ "type": "string"
+ },
+ "general_cap_amount": {
+ "type": "number"
+ },
+ "general_cap_amount_type": {
+ "type": "string"
+ },
+ "general_cap_period_currency": {
+ "type": "number"
+ },
+ "general_cap_period_qty": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "general_cap_preceding_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "governing_law_country": {
+ "description": "The country whose laws govern agreements created from this template.",
+ "type": "string"
+ },
+ "governing_law_region": {
+ "description": "The state or region whose laws govern agreements created from this template.",
+ "type": "string"
+ },
+ "include_additional_changes": {
+ "description": "Whether to include the additional changes section.",
+ "type": "boolean"
+ },
+ "include_additional_terms": {
+ "type": "boolean"
+ },
+ "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": {
+ "type": "string"
+ },
+ "include_payment_process": {
+ "type": "boolean"
+ },
+ "include_technical_support": {
+ "type": "boolean"
+ },
+ "include_terms": {
+ "description": "Whether to include standard terms in the agreement.",
+ "type": "boolean"
+ },
+ "name": {
+ "description": "A name for the template.",
+ "type": "string"
+ },
+ "negotiations_allowed": {
+ "description": "Whether counterparties can propose changes to agreements created from this template.",
+ "type": "boolean"
+ },
+ "payment_process_automatic_frequency": {
+ "type": "string"
+ },
+ "payment_process_invoice_days": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "payment_process_invoice_from": {
+ "type": "string"
+ },
+ "payment_process_invoice_timeframe": {
+ "type": "string"
+ },
+ "payment_process_type": {
+ "type": "string"
+ },
+ "pilot_period_description": {
+ "type": "string"
+ },
+ "pilot_period_fees_description": {
+ "type": "string"
+ },
+ "product_description": {
+ "type": "string"
+ },
+ "recipient_role": {
+ "description": "The label for the receiving party in the agreement.",
+ "type": "string"
+ },
+ "sender_last_to_sign": {
+ "description": "When true, the sender signs after the recipient.",
+ "type": "boolean"
+ },
+ "sender_role": {
+ "description": "The label for the sending party in the agreement.",
+ "type": "string"
+ },
+ "technical_support_description": {
+ "type": "string"
+ },
+ "template_setting_attributes": {
+ "additionalProperties": false,
+ "description": "Template settings such as standard version and message.",
+ "properties": {
+ "include_message": {
+ "type": "boolean"
+ },
+ "message": {
+ "type": "string"
+ },
+ "standard_version": {
+ "type": "string"
+ },
+ "subsidiary_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"
+ }
+ },
+ "type": "object"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "additional_changes": {
+ "description": "Text of additional changes to include when include_additional_changes is true.",
+ "type": "string"
+ },
+ "attachment_ids": {
+ "description": "UUIDs of attachments to include with the template.",
+ "items": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "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"
+ },
+ "default_signer_email": {
+ "description": "Default email address pre-filled as the signer when creating agreements from this template.",
+ "format": "email",
+ "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "district_or_county": {
+ "description": "The district or county for dispute resolution.",
+ "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": {
+ "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": {
+ "type": "string"
+ },
+ "governing_law_country": {
+ "description": "The country whose laws govern agreements created from this template.",
+ "type": "string"
+ },
+ "governing_law_region": {
+ "description": "The state or region whose laws govern agreements created from this template.",
+ "type": "string"
+ },
+ "include_additional_changes": {
+ "description": "Whether to include the additional changes section.",
+ "type": "boolean"
+ },
+ "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": {
+ "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": {},
+ "include_increased_cap_amount_multiple": {},
+ "include_increased_cap_amount_type": {
+ "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_terms": {
+ "description": "Whether to include standard terms in the agreement.",
+ "type": "boolean"
+ },
+ "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"
+ },
+ "name": {
+ "description": "A name for the template.",
+ "type": "string"
+ },
+ "negotiations_allowed": {
+ "description": "Whether counterparties can propose changes to agreements created from this template.",
+ "type": "boolean"
+ },
+ "recipient_role": {
+ "description": "The label for the receiving party in the agreement.",
+ "type": "string"
+ },
+ "sender_last_to_sign": {
+ "description": "When true, the sender signs after the recipient.",
+ "type": "boolean"
+ },
+ "sender_role": {
+ "description": "The label for the sending party in the agreement.",
+ "type": "string"
+ },
+ "template_partnership_business_terms_attributes": {
+ "additionalProperties": false,
+ "description": "Nested partnership business terms defaults.",
+ "properties": {
+ "end_date_after_effective_date_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "end_date_after_effective_date_unit": {
+ "type": "string"
+ },
+ "end_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"
+ },
+ "end_date_type": {
+ "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": {
+ "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": {
+ "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": {
+ "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": {
+ "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": {
+ "format": "email",
+ "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "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": {
+ "format": "email",
+ "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "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": {
+ "type": "string"
+ },
+ "include_payment_schedule_specified_unit": {
+ "type": "string"
+ },
+ "include_payment_schedule_type": {
+ "type": "string"
+ },
+ "negotiations_allowed": {
+ "description": "Whether counterparties can propose changes to agreements created from this template.",
+ "type": "boolean"
+ },
+ "territory_type": {
+ "type": "string"
+ },
+ "territory_type_val": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "template_setting_attributes": {
+ "additionalProperties": false,
+ "description": "Template settings such as standard version and message.",
+ "properties": {
+ "include_message": {
+ "type": "boolean"
+ },
+ "message": {
+ "type": "string"
+ },
+ "standard_version": {
+ "type": "string"
+ },
+ "subsidiary_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"
+ }
+ },
+ "type": "object"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "additional_changes": {
+ "description": "Text of additional changes to include when include_additional_changes is true.",
+ "type": "string"
+ },
+ "aggregation_limitations_permitted": {
+ "type": "boolean"
+ },
+ "aggregation_limitations_permitted_val": {
+ "type": "string"
+ },
+ "attachment_ids": {
+ "description": "UUIDs of attachments to include with the template.",
+ "items": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "breach_notification_unit": {
+ "type": "string"
+ },
+ "breach_notification_val": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "business_associate_relationship_type": {
+ "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"
+ },
+ "default_signer_email": {
+ "description": "Default email address pre-filled as the signer when creating agreements from this template.",
+ "format": "email",
+ "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "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"
+ },
+ "district_or_county": {
+ "description": "The district or county for dispute resolution.",
+ "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": {
+ "type": "string"
+ },
+ "governing_law_country": {
+ "description": "The country whose laws govern agreements created from this template.",
+ "type": "string"
+ },
+ "governing_law_region": {
+ "description": "The state or region whose laws govern agreements created from this template.",
+ "type": "string"
+ },
+ "include_additional_changes": {
+ "description": "Whether to include the additional changes section.",
+ "type": "boolean"
+ },
+ "include_aggregation_limitations": {
+ "type": "boolean"
+ },
+ "include_deidentification_limitations": {
+ "type": "boolean"
+ },
+ "include_limitations": {
+ "type": "boolean"
+ },
+ "include_offshore_limitations": {
+ "type": "boolean"
+ },
+ "include_subcontract_limitations": {
+ "type": "boolean"
+ },
+ "include_terms": {
+ "description": "Whether to include standard terms in the agreement.",
+ "type": "boolean"
+ },
+ "name": {
+ "description": "A name for the template.",
+ "type": "string"
+ },
+ "negotiations_allowed": {
+ "description": "Whether counterparties can propose changes to agreements created from this template.",
+ "type": "boolean"
+ },
+ "offshore_limitations_permitted": {
+ "type": "boolean"
+ },
+ "offshore_limitations_permitted_val": {
+ "type": "string"
+ },
+ "recipient_role": {
+ "description": "The label for the receiving party in the agreement.",
+ "type": "string"
+ },
+ "sender_last_to_sign": {
+ "description": "When true, the sender signs after the recipient.",
+ "type": "boolean"
+ },
+ "sender_role": {
+ "description": "The label for the sending party in the agreement.",
+ "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"
+ },
+ "template_setting_attributes": {
+ "additionalProperties": false,
+ "description": "Template settings such as standard version and message.",
+ "properties": {
+ "include_message": {
+ "type": "boolean"
+ },
+ "message": {
+ "type": "string"
+ },
+ "standard_version": {
+ "type": "string"
+ },
+ "subsidiary_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"
+ }
+ },
+ "type": "object"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "additional_changes": {
+ "description": "Text of additional changes to include when include_additional_changes is true.",
+ "type": "string"
+ },
+ "attachment_ids": {
+ "description": "UUIDs of attachments to include with the template.",
+ "items": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "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"
+ },
+ "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": {
+ "type": "string"
+ },
+ "confidentiality_type": {
+ "type": "string"
+ },
+ "default_signer_email": {
+ "description": "Default email address pre-filled as the signer when creating agreements from this template.",
+ "format": "email",
+ "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "district_or_county": {
+ "description": "The district or county for dispute resolution.",
+ "type": "string"
+ },
+ "governing_law_country": {
+ "description": "The country whose laws govern agreements created from this template.",
+ "type": "string"
+ },
+ "governing_law_region": {
+ "description": "The state or region whose laws govern agreements created from this template.",
+ "type": "string"
+ },
+ "include_additional_changes": {
+ "description": "Whether to include the additional changes section.",
+ "type": "boolean"
+ },
+ "include_custom_details": {
+ "type": "boolean"
+ },
+ "include_custom_details_val": {
+ "type": "string"
+ },
+ "include_fees": {
+ "type": "boolean"
+ },
+ "include_fees_amount": {
+ "type": "number"
+ },
+ "include_fees_amount_duration": {
+ "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": {
+ "type": "string"
+ },
+ "include_terms": {
+ "description": "Whether to include standard terms in the agreement.",
+ "type": "boolean"
+ },
+ "name": {
+ "description": "A name for the template.",
+ "type": "string"
+ },
+ "negotiations_allowed": {
+ "description": "Whether counterparties can propose changes to agreements created from this template.",
+ "type": "boolean"
+ },
+ "product_name": {
+ "type": "string"
+ },
+ "recipient_role": {
+ "description": "The label for the receiving party in the agreement.",
+ "type": "string"
+ },
+ "sender_last_to_sign": {
+ "description": "When true, the sender signs after the recipient.",
+ "type": "boolean"
+ },
+ "sender_role": {
+ "description": "The label for the sending party in the agreement.",
+ "type": "string"
+ },
+ "template_setting_attributes": {
+ "additionalProperties": false,
+ "description": "Template settings such as standard version and message.",
+ "properties": {
+ "include_message": {
+ "type": "boolean"
+ },
+ "message": {
+ "type": "string"
+ },
+ "standard_version": {
+ "type": "string"
+ },
+ "subsidiary_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"
+ }
+ },
+ "type": "object"
+ }
+ },
+ "type": "object"
+ }
+]create-template1 field changedInput schema / properties / body / anyOfPrevious value: -[
- {
- "additionalProperties": false,
- "properties": {
- "additional_changes": {
- "description": "Text of additional changes to include when include_additional_changes is true.",
- "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"
- },
- "confidentiality_period": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "confidentiality_period_perpetual": {
- "type": "boolean"
- },
- "default_signer_email": {
- "description": "Default email address pre-filled as the signer when creating agreements from this template.",
- "format": "email",
- "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
- "type": "string"
- },
- "district_or_county": {
- "description": "The district or county for dispute resolution.",
- "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_of_confidentiality": {
- "type": "string"
- },
- "effective_date_type": {
- "type": "string"
- },
- "governing_law_country": {
- "description": "The country whose laws govern agreements created from this template.",
- "type": "string"
- },
- "governing_law_region": {
- "description": "The state or region whose laws govern agreements created from this template.",
- "type": "string"
- },
- "include_additional_changes": {
- "description": "Whether to include the additional changes section.",
- "type": "boolean"
- },
- "include_terms": {
- "description": "Whether to include standard terms in the agreement.",
- "type": "boolean"
- },
- "name": {
- "description": "A name for the template.",
- "type": "string"
- },
- "negotiations_allowed": {
- "description": "Whether counterparties can propose changes to agreements created from this template.",
- "type": "boolean"
- },
- "purpose": {
- "type": "string"
- },
- "recipient_role": {
- "description": "The label for the receiving party in the agreement.",
- "type": "string"
- },
- "sender_last_to_sign": {
- "description": "When true, the sender signs after the recipient.",
- "type": "boolean"
- },
- "sender_role": {
- "description": "The label for the sending party in the agreement.",
- "type": "string"
- },
- "template_setting_attributes": {
- "additionalProperties": false,
- "description": "Template settings such as standard version and message.",
- "properties": {
- "include_message": {
- "type": "boolean"
- },
- "message": {
- "type": "string"
- },
- "standard_version": {
- "type": "string"
- },
- "subsidiary_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"
- }
- },
- "type": "object"
- },
- "term": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "term_period_perpetual": {
- "type": "boolean"
- },
- "type": {
- "description": "Optional. When omitted, the template defaults to NDA.",
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "additional_changes": {
- "description": "Text of additional changes to include when include_additional_changes is true.",
- "type": "string"
- },
- "attachment_ids": {
- "description": "UUIDs of attachments to include with the template.",
- "items": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "type": "array"
- },
- "billing_workflow_type": {
- "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"
- },
- "customer_description": {
- "type": "string"
- },
- "default_signer_email": {
- "description": "Default email address pre-filled as the signer when creating agreements from this template.",
- "format": "email",
- "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
- "type": "string"
- },
- "district_or_county": {
- "description": "The district or county for dispute resolution.",
- "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": {
- "type": "string"
- },
- "effective_date_type": {
- "type": "string"
- },
- "general_cap_amount": {
- "type": "number"
- },
- "general_cap_amount_type": {
- "type": "string"
- },
- "general_cap_period_currency": {
- "type": "number"
- },
- "general_cap_period_qty": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "general_cap_preceding_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "governing_law_country": {
- "description": "The country whose laws govern agreements created from this template.",
- "type": "string"
- },
- "governing_law_region": {
- "description": "The state or region whose laws govern agreements created from this template.",
- "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": {
- "type": "string"
- },
- "include_additional_changes": {
- "description": "Whether to include the additional changes section.",
- "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_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_billing_workflow": {
- "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_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": {
- "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": {
- "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": {
- "type": "string"
- },
- "include_terms": {
- "description": "Whether to include standard terms in the agreement.",
- "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": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "increased_cap_amount_qty": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "increased_cap_amount_type": {
- "type": "string"
- },
- "name": {
- "description": "A name for the template.",
- "type": "string"
- },
- "negotiations_allowed": {
- "description": "Whether counterparties can propose changes to agreements created from this template.",
- "type": "boolean"
- },
- "payment_link_url": {
- "type": "string"
- },
- "provider": {
- "type": "string"
- },
- "recipient_role": {
- "description": "The label for the receiving party in the agreement.",
- "type": "string"
- },
- "sender_last_to_sign": {
- "description": "When true, the sender signs after the recipient.",
- "type": "boolean"
- },
- "sender_role": {
- "description": "The label for the sending party in the agreement.",
- "type": "string"
- },
- "stripe_invoice_delivery": {
- "type": "string"
- },
- "stripe_payment_link_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"
- },
- "stripe_product_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"
- },
- "stripe_product_name": {
- "type": "string"
- },
- "stripe_subsequent_bill_method": {
- "type": "string"
- },
- "template_csa_order_form_attributes": {
- "additionalProperties": false,
- "description": "Nested CSA order form defaults. See Template Parameters docs for CSA Order Form.",
- "properties": {
- "additional_changes": {
- "description": "Text of additional changes to include when include_additional_changes is true.",
- "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": {
- "type": "string"
- },
- "fees_attributes": {
- "items": {
- "additionalProperties": false,
- "properties": {
- "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"
- },
- "cost": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "description": {
- "type": "string"
- },
- "discount_duration_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "discount_duration_type": {
- "type": "string"
- },
- "discount_type": {
- "type": "string"
- },
- "fee_type": {
- "type": "string"
- },
- "graduated_fee_tiers_attributes": {
- "items": {
- "additionalProperties": false,
- "properties": {
- "flat_price": {
- "type": "string"
- },
- "price_per_unit": {
- "type": "string"
- },
- "upper_limit": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- }
- },
- "type": "object"
- },
- "type": "array"
- },
- "quantity": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "stripe_product_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"
- },
- "type": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "type": "array"
- },
- "fees_currency": {
- "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": {
- "type": "string"
- },
- "fees_inclusive_of_taxes": {
- "type": "boolean"
- },
- "free_trial_days": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_additional_changes": {
- "description": "Whether to include the additional changes section.",
- "type": "boolean"
- },
- "include_additional_parameters_or_limitations": {
- "type": "boolean"
- },
- "include_billing_info": {
- "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": {
- "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": {
- "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": {
- "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": {
- "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": {
- "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": {
- "type": "string"
- },
- "include_sla_standard_maintenance_notice_qty": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_sla_standard_maintenance_notice_unit": {
- "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": {
- "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": {
- "type": "string"
- },
- "invoice_period_custom_unit": {
- "type": "string"
- },
- "max_consumption": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "max_users": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "negotiations_allowed": {
- "description": "Whether counterparties can propose changes to agreements created from this template.",
- "type": "boolean"
- },
- "order_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"
- },
- "order_date_other": {
- "type": "string"
- },
- "order_date_type": {
- "type": "string"
- },
- "payment_period": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "payment_period_timeframe": {
- "type": "string"
- },
- "payment_period_unit": {
- "type": "string"
- },
- "payment_process_automatic_frequency": {
- "type": "string"
- },
- "payment_process_type": {
- "type": "string"
- },
- "payment_process_type_custom_val": {
- "type": "string"
- },
- "payment_process_type_invoice_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "payment_process_type_invoice_custom_unit": {
- "type": "string"
- },
- "payment_process_type_invoice_duration": {
- "type": "string"
- },
- "payment_process_type_invoice_duration_start": {
- "type": "string"
- },
- "payment_process_type_invoice_type": {
- "type": "string"
- },
- "pilot_period_stripe_product_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"
- },
- "service_credits_attributes": {
- "items": {
- "additionalProperties": false,
- "properties": {
- "credit": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "max": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "min": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- }
- },
- "type": "object"
- },
- "type": "array"
- },
- "subscription_auto_renew": {
- "type": "string"
- },
- "subscription_period": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "subscription_period_unit": {
- "type": "string"
- },
- "subscription_renewal_notice_days": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "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": {
- "type": "string"
- },
- "use_limitations_attributes": {
- "items": {
- "additionalProperties": false,
- "properties": {
- "amount": {
- "type": "string"
- },
- "limitation_type": {
- "type": "string"
- },
- "unit": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "type": "array"
- }
- },
- "type": "object"
- },
- "template_setting_attributes": {
- "additionalProperties": false,
- "description": "Template settings such as standard version and message.",
- "properties": {
- "include_message": {
- "type": "boolean"
- },
- "message": {
- "type": "string"
- },
- "standard_version": {
- "type": "string"
- },
- "subsidiary_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"
- }
- },
- "type": "object"
- },
- "type": {
- "description": "The type of template to create.",
- "type": "string"
- }
- },
- "required": [
- "type"
- ],
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "additional_changes": {
- "description": "Text of additional changes to include when include_additional_changes is true.",
- "type": "string"
- },
- "approved_subprocessor_type": {
- "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"
- },
- "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": {
- "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"
- },
- "default_signer_email": {
- "description": "Default email address pre-filled as the signer when creating agreements from this template.",
- "format": "email",
- "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
- "type": "string"
- },
- "district_or_county": {
- "description": "The district or county for dispute resolution.",
- "type": "string"
- },
- "duration_of_processing": {
- "type": "string"
- },
- "governing_law_country": {
- "description": "The country whose laws govern agreements created from this template.",
- "type": "string"
- },
- "governing_law_region": {
- "description": "The state or region whose laws govern agreements created from this template.",
- "type": "string"
- },
- "include_additional_changes": {
- "description": "Whether to include the additional changes section.",
- "type": "boolean"
- },
- "include_covered_claim": {
- "type": "boolean"
- },
- "include_covered_claim_external_val": {
- "type": "string"
- },
- "include_covered_claim_internal_val": {
- "type": "string"
- },
- "include_covered_claim_type": {
- "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": {
- "type": "boolean"
- },
- "include_increased_claim_amount_currency": {
- "type": "string"
- },
- "include_increased_claim_amount_qty": {},
- "include_increased_claim_amount_type": {
- "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": {
- "type": "string"
- },
- "include_liability_cap_amount_currency_internal": {
- "type": "string"
- },
- "include_liability_cap_csa_type": {
- "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-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_provider": {
- "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"
- },
- "include_terms": {
- "description": "Whether to include standard terms in the agreement.",
- "type": "boolean"
- },
- "name": {
- "description": "A name for the template.",
- "type": "string"
- },
- "negotiations_allowed": {
- "description": "Whether counterparties can propose changes to agreements created from this template.",
- "type": "boolean"
- },
- "provider": {
- "type": "string"
- },
- "recipient_role": {
- "description": "The label for the receiving party in the agreement.",
- "type": "string"
- },
- "security_policy_available_at": {
- "type": "string"
- },
- "security_policy_type": {
- "type": "string"
- },
- "sender_last_to_sign": {
- "description": "When true, the sender signs after the recipient.",
- "type": "boolean"
- },
- "sender_role": {
- "description": "The label for the sending party in the agreement.",
- "type": "string"
- },
- "subprocessors_attributes": {
- "description": "List of subprocessors. Each item may include name, country, and processing_task.",
- "items": {
- "additionalProperties": false,
- "properties": {
- "country": {
- "type": "string"
- },
- "name": {
- "description": "A name for the template.",
- "type": "string"
- },
- "processing_task": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "type": "array"
- },
- "template_setting_attributes": {
- "additionalProperties": false,
- "description": "Template settings such as standard version and message.",
- "properties": {
- "include_message": {
- "type": "boolean"
- },
- "message": {
- "type": "string"
- },
- "standard_version": {
- "type": "string"
- },
- "subsidiary_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"
- }
- },
- "type": "object"
- },
- "type": {
- "description": "The type of template to create.",
- "type": "string"
- },
- "underlying_agreement_val": {
- "type": "string"
- }
- },
- "required": [
- "type"
- ],
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "additional_changes": {
- "description": "Text of additional changes to include when include_additional_changes is true.",
- "type": "string"
- },
- "attachment_ids": {
- "description": "UUIDs of attachments to include with the template.",
- "items": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "type": "array"
- },
- "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"
- },
- "default_signer_email": {
- "description": "Default email address pre-filled as the signer when creating agreements from this template.",
- "format": "email",
- "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
- "type": "string"
- },
- "district_or_county": {
- "description": "The district or county for dispute resolution.",
- "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": {
- "type": "string"
- },
- "general_cap_amount": {
- "type": "number"
- },
- "general_cap_amount_type": {
- "type": "string"
- },
- "general_cap_period_currency": {
- "type": "number"
- },
- "general_cap_period_qty": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "general_cap_preceding_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "governing_law_country": {
- "description": "The country whose laws govern agreements created from this template.",
- "type": "string"
- },
- "governing_law_region": {
- "description": "The state or region whose laws govern agreements created from this template.",
- "type": "string"
- },
- "include_additional_changes": {
- "description": "Whether to include the additional changes section.",
- "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": {
- "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": {
- "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": {
- "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": {
- "type": "string"
- },
- "include_terms": {
- "description": "Whether to include standard terms in the agreement.",
- "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_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": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "increased_cap_amount_qty": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "increased_cap_amount_type": {
- "type": "string"
- },
- "name": {
- "description": "A name for the template.",
- "type": "string"
- },
- "negotiations_allowed": {
- "description": "Whether counterparties can propose changes to agreements created from this template.",
- "type": "boolean"
- },
- "recipient_role": {
- "description": "The label for the receiving party in the agreement.",
- "type": "string"
- },
- "sender_last_to_sign": {
- "description": "When true, the sender signs after the recipient.",
- "type": "boolean"
- },
- "sender_role": {
- "description": "The label for the sending party in the agreement.",
- "type": "string"
- },
- "template_psa_statement_of_work_attributes": {
- "additionalProperties": false,
- "description": "Nested PSA statement of work defaults.",
- "properties": {
- "additional_changes": {
- "description": "Text of additional changes to include when include_additional_changes is true.",
- "type": "string"
- },
- "fees_attributes": {
- "items": {
- "additionalProperties": false,
- "properties": {
- "cost": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "description": {
- "type": "string"
- },
- "fee_type": {
- "type": "string"
- },
- "quantity": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- }
- },
- "type": "object"
- },
- "type": "array"
- },
- "include_additional_changes": {
- "description": "Whether to include the additional changes section.",
- "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": {
- "type": "string"
- },
- "include_deliverables_resubmission_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_deliverables_resubmission_unit": {
- "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": {
- "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": {
- "type": "string"
- },
- "invoice_period_description": {
- "type": "string"
- },
- "negotiations_allowed": {
- "description": "Whether counterparties can propose changes to agreements created from this template.",
- "type": "boolean"
- },
- "payment_period": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "payment_period_other": {
- "type": "string"
- },
- "payment_period_timeframe": {
- "type": "string"
- },
- "payment_period_type": {
- "type": "string"
- },
- "payment_period_unit": {
- "type": "string"
- },
- "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": {
- "type": "string"
- },
- "sow_term_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "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": {
- "type": "string"
- },
- "sow_term_unit": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "template_setting_attributes": {
- "additionalProperties": false,
- "description": "Template settings such as standard version and message.",
- "properties": {
- "include_message": {
- "type": "boolean"
- },
- "message": {
- "type": "string"
- },
- "standard_version": {
- "type": "string"
- },
- "subsidiary_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"
- }
- },
- "type": "object"
- },
- "type": {
- "description": "The type of template to create.",
- "type": "string"
- },
- "version": {
- "type": "string"
- }
- },
- "required": [
- "type"
- ],
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "additional_changes": {
- "description": "Text of additional changes to include when include_additional_changes is true.",
- "type": "string"
- },
- "attachment_ids": {
- "description": "UUIDs of attachments to include with the template.",
- "items": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "type": "array"
- },
- "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"
- },
- "customer_description": {
- "type": "string"
- },
- "default_signer_email": {
- "description": "Default email address pre-filled as the signer when creating agreements from this template.",
- "format": "email",
- "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
- "type": "string"
- },
- "district_or_county": {
- "description": "The district or county for dispute resolution.",
- "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": {
- "type": "string"
- },
- "governing_law_country": {
- "description": "The country whose laws govern agreements created from this template.",
- "type": "string"
- },
- "governing_law_region": {
- "description": "The state or region whose laws govern agreements created from this template.",
- "type": "string"
- },
- "include_additional_changes": {
- "description": "Whether to include the additional changes section.",
- "type": "boolean"
- },
- "include_fees": {
- "type": "boolean"
- },
- "include_fees_amount": {
- "type": "number"
- },
- "include_fees_description": {
- "type": "string"
- },
- "include_fees_pay_by_amount": {},
- "include_fees_type": {
- "type": "string"
- },
- "include_fees_unit": {
- "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": {
- "type": "string"
- },
- "include_program_participation_feedback": {
- "type": "boolean"
- },
- "include_program_participation_feedback_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_program_participation_feedback_unit": {
- "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"
- },
- "include_terms": {
- "description": "Whether to include standard terms in the agreement.",
- "type": "boolean"
- },
- "name": {
- "description": "A name for the template.",
- "type": "string"
- },
- "negotiations_allowed": {
- "description": "Whether counterparties can propose changes to agreements created from this template.",
- "type": "boolean"
- },
- "product_description": {
- "type": "string"
- },
- "recipient_role": {
- "description": "The label for the receiving party in the agreement.",
- "type": "string"
- },
- "sender_last_to_sign": {
- "description": "When true, the sender signs after the recipient.",
- "type": "boolean"
- },
- "sender_role": {
- "description": "The label for the sending party in the agreement.",
- "type": "string"
- },
- "template_setting_attributes": {
- "additionalProperties": false,
- "description": "Template settings such as standard version and message.",
- "properties": {
- "include_message": {
- "type": "boolean"
- },
- "message": {
- "type": "string"
- },
- "standard_version": {
- "type": "string"
- },
- "subsidiary_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"
- }
- },
- "type": "object"
- },
- "term_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "term_unit": {
- "type": "string"
- },
- "type": {
- "description": "The type of template to create.",
- "type": "string"
- },
- "version": {
- "type": "string"
- }
- },
- "required": [
- "type"
- ],
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "additional_changes": {
- "description": "Text of additional changes to include when include_additional_changes is true.",
- "type": "string"
- },
- "attachment_ids": {
- "description": "UUIDs of attachments to include with the template.",
- "items": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "type": "array"
- },
- "billing_workflow_type": {
- "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"
- },
- "default_signer_email": {
- "description": "Default email address pre-filled as the signer when creating agreements from this template.",
- "format": "email",
- "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
- "type": "string"
- },
- "district_or_county": {
- "description": "The district or county for dispute resolution.",
- "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": {
- "type": "string"
- },
- "general_cap_amount": {
- "type": "number"
- },
- "general_cap_amount_type": {
- "type": "string"
- },
- "general_cap_period_currency": {
- "type": "number"
- },
- "general_cap_period_qty": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "general_cap_preceding_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "governing_law_country": {
- "description": "The country whose laws govern agreements created from this template.",
- "type": "string"
- },
- "governing_law_region": {
- "description": "The state or region whose laws govern agreements created from this template.",
- "type": "string"
- },
- "include_additional_changes": {
- "description": "Whether to include the additional changes section.",
- "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_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_billing_workflow": {
- "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_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": {
- "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_terms": {
- "description": "Whether to include standard terms in the agreement.",
- "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": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "increased_cap_amount_qty": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "increased_cap_amount_type": {
- "type": "string"
- },
- "name": {
- "description": "A name for the template.",
- "type": "string"
- },
- "negotiations_allowed": {
- "description": "Whether counterparties can propose changes to agreements created from this template.",
- "type": "boolean"
- },
- "payment_link_url": {
- "type": "string"
- },
- "recipient_role": {
- "description": "The label for the receiving party in the agreement.",
- "type": "string"
- },
- "sender_last_to_sign": {
- "description": "When true, the sender signs after the recipient.",
- "type": "boolean"
- },
- "sender_role": {
- "description": "The label for the sending party in the agreement.",
- "type": "string"
- },
- "stripe_invoice_delivery": {
- "type": "string"
- },
- "stripe_payment_link_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"
- },
- "stripe_product_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"
- },
- "stripe_product_name": {
- "type": "string"
- },
- "stripe_subsequent_bill_method": {
- "type": "string"
- },
- "template_setting_attributes": {
- "additionalProperties": false,
- "description": "Template settings such as standard version and message.",
- "properties": {
- "include_message": {
- "type": "boolean"
- },
- "message": {
- "type": "string"
- },
- "standard_version": {
- "type": "string"
- },
- "subsidiary_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"
- }
- },
- "type": "object"
- },
- "template_software_license_order_form_attributes": {
- "additionalProperties": false,
- "description": "Nested software license order form defaults.",
- "properties": {
- "additional_changes": {
- "description": "Text of additional changes to include when include_additional_changes is true.",
- "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": {
- "type": "string"
- },
- "fees_attributes": {
- "items": {
- "additionalProperties": false,
- "properties": {
- "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"
- },
- "cost": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "description": {
- "type": "string"
- },
- "discount_duration_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "discount_duration_type": {
- "type": "string"
- },
- "discount_type": {
- "type": "string"
- },
- "fee_type": {
- "type": "string"
- },
- "graduated_fee_tiers_attributes": {
- "items": {
- "additionalProperties": false,
- "properties": {
- "flat_price": {
- "type": "string"
- },
- "price_per_unit": {
- "type": "string"
- },
- "upper_limit": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- }
- },
- "type": "object"
- },
- "type": "array"
- },
- "quantity": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "stripe_product_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"
- },
- "type": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "type": "array"
- },
- "fees_currency": {
- "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": {
- "type": "string"
- },
- "fees_inclusive_of_taxes": {
- "type": "boolean"
- },
- "include_additional_changes": {
- "description": "Whether to include the additional changes section.",
- "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": {
- "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": "Whether counterparties can propose changes to agreements created from this template.",
- "type": "boolean"
- },
- "order_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"
- },
- "order_date_type": {
- "type": "string"
- },
- "payment_process_automatic_frequency": {
- "type": "string"
- },
- "payment_process_type": {
- "type": "string"
- },
- "payment_process_type_custom_val": {
- "type": "string"
- },
- "payment_process_type_invoice_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "payment_process_type_invoice_custom_unit": {
- "type": "string"
- },
- "payment_process_type_invoice_duration": {
- "type": "string"
- },
- "payment_process_type_invoice_duration_start": {
- "type": "string"
- },
- "payment_process_type_invoice_type": {
- "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": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "software_description": {
- "type": "string"
- },
- "subscription_auto_renew": {
- "type": "string"
- },
- "subscription_period": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "subscription_period_unit": {
- "type": "string"
- },
- "subscription_renewal_notice_days": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "warranty_period_description_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "warranty_period_description_duration": {
- "type": "string"
- },
- "warranty_period_description_duration_start": {
- "type": "string"
- },
- "warranty_period_type": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "type": {
- "description": "The type of template to create.",
- "type": "string"
- }
- },
- "required": [
- "type"
- ],
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "additional_changes": {
- "description": "Text of additional changes to include when include_additional_changes is true.",
- "type": "string"
- },
- "additional_terms": {
- "type": "string"
- },
- "attachment_ids": {
- "description": "UUIDs of attachments to include with the template.",
- "items": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "type": "array"
- },
- "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"
- },
- "default_signer_email": {
- "description": "Default email address pre-filled as the signer when creating agreements from this template.",
- "format": "email",
- "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
- "type": "string"
- },
- "district_or_county": {
- "description": "The district or county for dispute resolution.",
- "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": {
- "type": "string"
- },
- "fees_type": {
- "type": "string"
- },
- "general_cap_amount": {
- "type": "number"
- },
- "general_cap_amount_type": {
- "type": "string"
- },
- "general_cap_period_currency": {
- "type": "number"
- },
- "general_cap_period_qty": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "general_cap_preceding_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "governing_law_country": {
- "description": "The country whose laws govern agreements created from this template.",
- "type": "string"
- },
- "governing_law_region": {
- "description": "The state or region whose laws govern agreements created from this template.",
- "type": "string"
- },
- "include_additional_changes": {
- "description": "Whether to include the additional changes section.",
- "type": "boolean"
- },
- "include_additional_terms": {
- "type": "boolean"
- },
- "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": {
- "type": "string"
- },
- "include_payment_process": {
- "type": "boolean"
- },
- "include_technical_support": {
- "type": "boolean"
- },
- "include_terms": {
- "description": "Whether to include standard terms in the agreement.",
- "type": "boolean"
- },
- "name": {
- "description": "A name for the template.",
- "type": "string"
- },
- "negotiations_allowed": {
- "description": "Whether counterparties can propose changes to agreements created from this template.",
- "type": "boolean"
- },
- "payment_process_automatic_frequency": {
- "type": "string"
- },
- "payment_process_invoice_days": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "payment_process_invoice_from": {
- "type": "string"
- },
- "payment_process_invoice_timeframe": {
- "type": "string"
- },
- "payment_process_type": {
- "type": "string"
- },
- "pilot_period_description": {
- "type": "string"
- },
- "pilot_period_fees_description": {
- "type": "string"
- },
- "product_description": {
- "type": "string"
- },
- "recipient_role": {
- "description": "The label for the receiving party in the agreement.",
- "type": "string"
- },
- "sender_last_to_sign": {
- "description": "When true, the sender signs after the recipient.",
- "type": "boolean"
- },
- "sender_role": {
- "description": "The label for the sending party in the agreement.",
- "type": "string"
- },
- "technical_support_description": {
- "type": "string"
- },
- "template_setting_attributes": {
- "additionalProperties": false,
- "description": "Template settings such as standard version and message.",
- "properties": {
- "include_message": {
- "type": "boolean"
- },
- "message": {
- "type": "string"
- },
- "standard_version": {
- "type": "string"
- },
- "subsidiary_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"
- }
- },
- "type": "object"
- },
- "type": {
- "description": "The type of template to create.",
- "type": "string"
- }
- },
- "required": [
- "type"
- ],
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "additional_changes": {
- "description": "Text of additional changes to include when include_additional_changes is true.",
- "type": "string"
- },
- "attachment_ids": {
- "description": "UUIDs of attachments to include with the template.",
- "items": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "type": "array"
- },
- "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"
- },
- "default_signer_email": {
- "description": "Default email address pre-filled as the signer when creating agreements from this template.",
- "format": "email",
- "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
- "type": "string"
- },
- "district_or_county": {
- "description": "The district or county for dispute resolution.",
- "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": {
- "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": {
- "type": "string"
- },
- "governing_law_country": {
- "description": "The country whose laws govern agreements created from this template.",
- "type": "string"
- },
- "governing_law_region": {
- "description": "The state or region whose laws govern agreements created from this template.",
- "type": "string"
- },
- "include_additional_changes": {
- "description": "Whether to include the additional changes section.",
- "type": "boolean"
- },
- "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": {
- "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": {},
- "include_increased_cap_amount_multiple": {},
- "include_increased_cap_amount_type": {
- "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_terms": {
- "description": "Whether to include standard terms in the agreement.",
- "type": "boolean"
- },
- "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"
- },
- "name": {
- "description": "A name for the template.",
- "type": "string"
- },
- "negotiations_allowed": {
- "description": "Whether counterparties can propose changes to agreements created from this template.",
- "type": "boolean"
- },
- "recipient_role": {
- "description": "The label for the receiving party in the agreement.",
- "type": "string"
- },
- "sender_last_to_sign": {
- "description": "When true, the sender signs after the recipient.",
- "type": "boolean"
- },
- "sender_role": {
- "description": "The label for the sending party in the agreement.",
- "type": "string"
- },
- "template_partnership_business_terms_attributes": {
- "additionalProperties": false,
- "description": "Nested partnership business terms defaults.",
- "properties": {
- "end_date_after_effective_date_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "end_date_after_effective_date_unit": {
- "type": "string"
- },
- "end_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"
- },
- "end_date_type": {
- "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": {
- "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": {
- "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": {
- "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": {
- "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": {
- "format": "email",
- "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
- "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": {
- "format": "email",
- "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
- "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": {
- "type": "string"
- },
- "include_payment_schedule_specified_unit": {
- "type": "string"
- },
- "include_payment_schedule_type": {
- "type": "string"
- },
- "negotiations_allowed": {
- "description": "Whether counterparties can propose changes to agreements created from this template.",
- "type": "boolean"
- },
- "territory_type": {
- "type": "string"
- },
- "territory_type_val": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "template_setting_attributes": {
- "additionalProperties": false,
- "description": "Template settings such as standard version and message.",
- "properties": {
- "include_message": {
- "type": "boolean"
- },
- "message": {
- "type": "string"
- },
- "standard_version": {
- "type": "string"
- },
- "subsidiary_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"
- }
- },
- "type": "object"
- },
- "type": {
- "description": "The type of template to create.",
- "type": "string"
- }
- },
- "required": [
- "type"
- ],
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "additional_changes": {
- "description": "Text of additional changes to include when include_additional_changes is true.",
- "type": "string"
- },
- "aggregation_limitations_permitted": {
- "type": "boolean"
- },
- "aggregation_limitations_permitted_val": {
- "type": "string"
- },
- "attachment_ids": {
- "description": "UUIDs of attachments to include with the template.",
- "items": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "type": "array"
- },
- "breach_notification_unit": {
- "type": "string"
- },
- "breach_notification_val": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "business_associate_relationship_type": {
- "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"
- },
- "default_signer_email": {
- "description": "Default email address pre-filled as the signer when creating agreements from this template.",
- "format": "email",
- "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
- "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"
- },
- "district_or_county": {
- "description": "The district or county for dispute resolution.",
- "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": {
- "type": "string"
- },
- "governing_law_country": {
- "description": "The country whose laws govern agreements created from this template.",
- "type": "string"
- },
- "governing_law_region": {
- "description": "The state or region whose laws govern agreements created from this template.",
- "type": "string"
- },
- "include_additional_changes": {
- "description": "Whether to include the additional changes section.",
- "type": "boolean"
- },
- "include_aggregation_limitations": {
- "type": "boolean"
- },
- "include_deidentification_limitations": {
- "type": "boolean"
- },
- "include_limitations": {
- "type": "boolean"
- },
- "include_offshore_limitations": {
- "type": "boolean"
- },
- "include_subcontract_limitations": {
- "type": "boolean"
- },
- "include_terms": {
- "description": "Whether to include standard terms in the agreement.",
- "type": "boolean"
- },
- "name": {
- "description": "A name for the template.",
- "type": "string"
- },
- "negotiations_allowed": {
- "description": "Whether counterparties can propose changes to agreements created from this template.",
- "type": "boolean"
- },
- "offshore_limitations_permitted": {
- "type": "boolean"
- },
- "offshore_limitations_permitted_val": {
- "type": "string"
- },
- "recipient_role": {
- "description": "The label for the receiving party in the agreement.",
- "type": "string"
- },
- "sender_last_to_sign": {
- "description": "When true, the sender signs after the recipient.",
- "type": "boolean"
- },
- "sender_role": {
- "description": "The label for the sending party in the agreement.",
- "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"
- },
- "template_setting_attributes": {
- "additionalProperties": false,
- "description": "Template settings such as standard version and message.",
- "properties": {
- "include_message": {
- "type": "boolean"
- },
- "message": {
- "type": "string"
- },
- "standard_version": {
- "type": "string"
- },
- "subsidiary_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"
- }
- },
- "type": "object"
- },
- "type": {
- "description": "The type of template to create.",
- "type": "string"
- }
- },
- "required": [
- "type"
- ],
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "additional_changes": {
- "description": "Text of additional changes to include when include_additional_changes is true.",
- "type": "string"
- },
- "attachment_ids": {
- "description": "UUIDs of attachments to include with the template.",
- "items": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "type": "array"
- },
- "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"
- },
- "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": {
- "type": "string"
- },
- "confidentiality_type": {
- "type": "string"
- },
- "default_signer_email": {
- "description": "Default email address pre-filled as the signer when creating agreements from this template.",
- "format": "email",
- "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
- "type": "string"
- },
- "district_or_county": {
- "description": "The district or county for dispute resolution.",
- "type": "string"
- },
- "governing_law_country": {
- "description": "The country whose laws govern agreements created from this template.",
- "type": "string"
- },
- "governing_law_region": {
- "description": "The state or region whose laws govern agreements created from this template.",
- "type": "string"
- },
- "include_additional_changes": {
- "description": "Whether to include the additional changes section.",
- "type": "boolean"
- },
- "include_custom_details": {
- "type": "boolean"
- },
- "include_custom_details_val": {
- "type": "string"
- },
- "include_fees": {
- "type": "boolean"
- },
- "include_fees_amount": {
- "type": "number"
- },
- "include_fees_amount_duration": {
- "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": {
- "type": "string"
- },
- "include_terms": {
- "description": "Whether to include standard terms in the agreement.",
- "type": "boolean"
- },
- "name": {
- "description": "A name for the template.",
- "type": "string"
- },
- "negotiations_allowed": {
- "description": "Whether counterparties can propose changes to agreements created from this template.",
- "type": "boolean"
- },
- "product_name": {
- "type": "string"
- },
- "recipient_role": {
- "description": "The label for the receiving party in the agreement.",
- "type": "string"
- },
- "sender_last_to_sign": {
- "description": "When true, the sender signs after the recipient.",
- "type": "boolean"
- },
- "sender_role": {
- "description": "The label for the sending party in the agreement.",
- "type": "string"
- },
- "template_setting_attributes": {
- "additionalProperties": false,
- "description": "Template settings such as standard version and message.",
- "properties": {
- "include_message": {
- "type": "boolean"
- },
- "message": {
- "type": "string"
- },
- "standard_version": {
- "type": "string"
- },
- "subsidiary_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"
- }
- },
- "type": "object"
- },
- "type": {
- "description": "The type of template to create.",
- "type": "string"
- }
- },
- "required": [
- "type"
- ],
- "type": "object"
- }
-]New value: +[
+ {
+ "additionalProperties": false,
+ "properties": {
+ "additional_changes": {
+ "description": "Text of additional changes to include when include_additional_changes is true.",
+ "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"
+ },
+ "confidentiality_period": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "confidentiality_period_perpetual": {
+ "type": "boolean"
+ },
+ "default_signer_email": {
+ "description": "Default email address pre-filled as the signer when creating agreements from this template.",
+ "format": "email",
+ "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "district_or_county": {
+ "description": "The district or county for dispute resolution.",
+ "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_of_confidentiality": {
+ "type": "string"
+ },
+ "effective_date_type": {
+ "type": "string"
+ },
+ "governing_law_country": {
+ "description": "The country whose laws govern agreements created from this template.",
+ "type": "string"
+ },
+ "governing_law_region": {
+ "description": "The state or region whose laws govern agreements created from this template.",
+ "type": "string"
+ },
+ "include_additional_changes": {
+ "description": "Whether to include the additional changes section.",
+ "type": "boolean"
+ },
+ "include_terms": {
+ "description": "Whether to include standard terms in the agreement.",
+ "type": "boolean"
+ },
+ "name": {
+ "description": "A name for the template.",
+ "type": "string"
+ },
+ "negotiations_allowed": {
+ "description": "Whether counterparties can propose changes to agreements created from this template.",
+ "type": "boolean"
+ },
+ "purpose": {
+ "type": "string"
+ },
+ "recipient_role": {
+ "description": "The label for the receiving party in the agreement.",
+ "type": "string"
+ },
+ "sender_last_to_sign": {
+ "description": "When true, the sender signs after the recipient.",
+ "type": "boolean"
+ },
+ "sender_role": {
+ "description": "The label for the sending party in the agreement.",
+ "type": "string"
+ },
+ "template_setting_attributes": {
+ "additionalProperties": false,
+ "description": "Template settings such as standard version and message.",
+ "properties": {
+ "include_message": {
+ "type": "boolean"
+ },
+ "message": {
+ "type": "string"
+ },
+ "standard_version": {
+ "type": "string"
+ },
+ "subsidiary_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"
+ }
+ },
+ "type": "object"
+ },
+ "term": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "term_period_perpetual": {
+ "type": "boolean"
+ },
+ "type": {
+ "description": "Optional. When omitted, the template defaults to NDA.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "additional_changes": {
+ "description": "Text of additional changes to include when include_additional_changes is true.",
+ "type": "string"
+ },
+ "attachment_ids": {
+ "description": "UUIDs of attachments to include with the template.",
+ "items": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "billing_workflow_type": {
+ "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"
+ },
+ "customer_description": {
+ "type": "string"
+ },
+ "default_signer_email": {
+ "description": "Default email address pre-filled as the signer when creating agreements from this template.",
+ "format": "email",
+ "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "district_or_county": {
+ "description": "The district or county for dispute resolution.",
+ "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": {
+ "type": "string"
+ },
+ "effective_date_type": {
+ "type": "string"
+ },
+ "general_cap_amount": {
+ "type": "number"
+ },
+ "general_cap_amount_type": {
+ "type": "string"
+ },
+ "general_cap_period_currency": {
+ "type": "number"
+ },
+ "general_cap_period_qty": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "general_cap_preceding_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "governing_law_country": {
+ "description": "The country whose laws govern agreements created from this template.",
+ "type": "string"
+ },
+ "governing_law_region": {
+ "description": "The state or region whose laws govern agreements created from this template.",
+ "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": {
+ "type": "string"
+ },
+ "include_additional_changes": {
+ "description": "Whether to include the additional changes section.",
+ "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_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_billing_workflow": {
+ "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_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": {
+ "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": {
+ "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": {
+ "type": "string"
+ },
+ "include_terms": {
+ "description": "Whether to include standard terms in the agreement.",
+ "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": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "increased_cap_amount_qty": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "increased_cap_amount_type": {
+ "type": "string"
+ },
+ "name": {
+ "description": "A name for the template.",
+ "type": "string"
+ },
+ "negotiations_allowed": {
+ "description": "Whether counterparties can propose changes to agreements created from this template.",
+ "type": "boolean"
+ },
+ "payment_link_url": {
+ "type": "string"
+ },
+ "provider": {
+ "type": "string"
+ },
+ "recipient_role": {
+ "description": "The label for the receiving party in the agreement.",
+ "type": "string"
+ },
+ "sender_last_to_sign": {
+ "description": "When true, the sender signs after the recipient.",
+ "type": "boolean"
+ },
+ "sender_role": {
+ "description": "The label for the sending party in the agreement.",
+ "type": "string"
+ },
+ "stripe_invoice_delivery": {
+ "type": "string"
+ },
+ "stripe_payment_link_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"
+ },
+ "stripe_product_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"
+ },
+ "stripe_product_name": {
+ "type": "string"
+ },
+ "stripe_subsequent_bill_method": {
+ "type": "string"
+ },
+ "template_csa_order_form_attributes": {
+ "additionalProperties": false,
+ "description": "Nested CSA order form defaults. See Template Parameters docs for CSA Order Form.",
+ "properties": {
+ "additional_changes": {
+ "description": "Text of additional changes to include when include_additional_changes is true.",
+ "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": {
+ "type": "string"
+ },
+ "fees_attributes": {
+ "items": {
+ "additionalProperties": false,
+ "properties": {
+ "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"
+ },
+ "cost": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "description": {
+ "type": "string"
+ },
+ "discount_duration_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "discount_duration_type": {
+ "type": "string"
+ },
+ "discount_type": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "graduated_fee_tiers_attributes": {
+ "items": {
+ "additionalProperties": false,
+ "properties": {
+ "flat_price": {
+ "type": "string"
+ },
+ "price_per_unit": {
+ "type": "string"
+ },
+ "upper_limit": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "quantity": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "stripe_product_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"
+ },
+ "type": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "fees_currency": {
+ "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": {
+ "type": "string"
+ },
+ "fees_inclusive_of_taxes": {
+ "type": "boolean"
+ },
+ "free_trial_days": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_additional_changes": {
+ "description": "Whether to include the additional changes section.",
+ "type": "boolean"
+ },
+ "include_additional_parameters_or_limitations": {
+ "type": "boolean"
+ },
+ "include_billing_info": {
+ "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": {
+ "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": {
+ "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": {
+ "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": {
+ "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": {
+ "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": {
+ "type": "string"
+ },
+ "include_sla_standard_maintenance_notice_qty": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_sla_standard_maintenance_notice_unit": {
+ "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": {
+ "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": {
+ "type": "string"
+ },
+ "invoice_period_custom_unit": {
+ "type": "string"
+ },
+ "max_consumption": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "max_users": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "negotiations_allowed": {
+ "description": "Whether counterparties can propose changes to agreements created from this template.",
+ "type": "boolean"
+ },
+ "order_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"
+ },
+ "order_date_other": {
+ "type": "string"
+ },
+ "order_date_type": {
+ "type": "string"
+ },
+ "payment_period": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "payment_period_timeframe": {
+ "type": "string"
+ },
+ "payment_period_unit": {
+ "type": "string"
+ },
+ "payment_process_automatic_frequency": {
+ "type": "string"
+ },
+ "payment_process_type": {
+ "type": "string"
+ },
+ "payment_process_type_custom_val": {
+ "type": "string"
+ },
+ "payment_process_type_invoice_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "payment_process_type_invoice_custom_unit": {
+ "type": "string"
+ },
+ "payment_process_type_invoice_duration": {
+ "type": "string"
+ },
+ "payment_process_type_invoice_duration_start": {
+ "type": "string"
+ },
+ "payment_process_type_invoice_type": {
+ "type": "string"
+ },
+ "pilot_period_stripe_product_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"
+ },
+ "service_credits_attributes": {
+ "items": {
+ "additionalProperties": false,
+ "properties": {
+ "credit": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "max": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "min": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "subscription_auto_renew": {
+ "type": "string"
+ },
+ "subscription_period": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "subscription_period_unit": {
+ "type": "string"
+ },
+ "subscription_renewal_notice_days": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "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": {
+ "type": "string"
+ },
+ "use_limitations_attributes": {
+ "items": {
+ "additionalProperties": false,
+ "properties": {
+ "amount": {
+ "type": "string"
+ },
+ "limitation_type": {
+ "type": "string"
+ },
+ "unit": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "template_setting_attributes": {
+ "additionalProperties": false,
+ "description": "Template settings such as standard version and message.",
+ "properties": {
+ "include_message": {
+ "type": "boolean"
+ },
+ "message": {
+ "type": "string"
+ },
+ "standard_version": {
+ "type": "string"
+ },
+ "subsidiary_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"
+ }
+ },
+ "type": "object"
+ },
+ "type": {
+ "description": "The type of template to create.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "type"
+ ],
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "additional_changes": {
+ "description": "Text of additional changes to include when include_additional_changes is true.",
+ "type": "string"
+ },
+ "approved_subprocessor_type": {
+ "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"
+ },
+ "cloud_service_product_name": {
+ "type": "string"
+ },
+ "competent_supervisory_authority": {
+ "type": "string"
+ },
+ "customer_description": {
+ "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"
+ },
+ "default_signer_email": {
+ "description": "Default email address pre-filled as the signer when creating agreements from this template.",
+ "format": "email",
+ "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "district_or_county": {
+ "description": "The district or county for dispute resolution.",
+ "type": "string"
+ },
+ "duration_of_processing": {
+ "type": "string"
+ },
+ "governing_law_country": {
+ "description": "The country whose laws govern agreements created from this template.",
+ "type": "string"
+ },
+ "governing_law_region": {
+ "description": "The state or region whose laws govern agreements created from this template.",
+ "type": "string"
+ },
+ "include_additional_changes": {
+ "description": "Whether to include the additional changes section.",
+ "type": "boolean"
+ },
+ "include_covered_claim": {
+ "type": "boolean"
+ },
+ "include_covered_claim_external_val": {
+ "type": "string"
+ },
+ "include_covered_claim_internal_val": {
+ "type": "string"
+ },
+ "include_covered_claim_type": {
+ "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": {
+ "type": "boolean"
+ },
+ "include_increased_claim_amount_currency": {
+ "type": "string"
+ },
+ "include_increased_claim_amount_qty": {},
+ "include_increased_claim_amount_type": {
+ "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": {
+ "type": "string"
+ },
+ "include_liability_cap_amount_currency_internal": {
+ "type": "string"
+ },
+ "include_liability_cap_csa_type": {
+ "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-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_provider": {
+ "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"
+ },
+ "include_terms": {
+ "description": "Whether to include standard terms in the agreement.",
+ "type": "boolean"
+ },
+ "name": {
+ "description": "A name for the template.",
+ "type": "string"
+ },
+ "negotiations_allowed": {
+ "description": "Whether counterparties can propose changes to agreements created from this template.",
+ "type": "boolean"
+ },
+ "provider": {
+ "type": "string"
+ },
+ "recipient_role": {
+ "description": "The label for the receiving party in the agreement.",
+ "type": "string"
+ },
+ "security_policy_available_at": {
+ "type": "string"
+ },
+ "security_policy_type": {
+ "type": "string"
+ },
+ "sender_last_to_sign": {
+ "description": "When true, the sender signs after the recipient.",
+ "type": "boolean"
+ },
+ "sender_role": {
+ "description": "The label for the sending party in the agreement.",
+ "type": "string"
+ },
+ "subprocessors_attributes": {
+ "description": "List of subprocessors. Each item may include name, country, and processing_task.",
+ "items": {
+ "additionalProperties": false,
+ "properties": {
+ "country": {
+ "type": "string"
+ },
+ "name": {
+ "description": "A name for the template.",
+ "type": "string"
+ },
+ "processing_task": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "template_setting_attributes": {
+ "additionalProperties": false,
+ "description": "Template settings such as standard version and message.",
+ "properties": {
+ "include_message": {
+ "type": "boolean"
+ },
+ "message": {
+ "type": "string"
+ },
+ "standard_version": {
+ "type": "string"
+ },
+ "subsidiary_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"
+ }
+ },
+ "type": "object"
+ },
+ "type": {
+ "description": "The type of template to create.",
+ "type": "string"
+ },
+ "underlying_agreement_val": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "type"
+ ],
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "additional_changes": {
+ "description": "Text of additional changes to include when include_additional_changes is true.",
+ "type": "string"
+ },
+ "attachment_ids": {
+ "description": "UUIDs of attachments to include with the template.",
+ "items": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "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"
+ },
+ "default_signer_email": {
+ "description": "Default email address pre-filled as the signer when creating agreements from this template.",
+ "format": "email",
+ "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "district_or_county": {
+ "description": "The district or county for dispute resolution.",
+ "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": {
+ "type": "string"
+ },
+ "general_cap_amount": {
+ "type": "number"
+ },
+ "general_cap_amount_type": {
+ "type": "string"
+ },
+ "general_cap_period_currency": {
+ "type": "number"
+ },
+ "general_cap_period_qty": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "general_cap_preceding_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "governing_law_country": {
+ "description": "The country whose laws govern agreements created from this template.",
+ "type": "string"
+ },
+ "governing_law_region": {
+ "description": "The state or region whose laws govern agreements created from this template.",
+ "type": "string"
+ },
+ "include_additional_changes": {
+ "description": "Whether to include the additional changes section.",
+ "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": {
+ "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": {
+ "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": {
+ "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": {
+ "type": "string"
+ },
+ "include_terms": {
+ "description": "Whether to include standard terms in the agreement.",
+ "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_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": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "increased_cap_amount_qty": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "increased_cap_amount_type": {
+ "type": "string"
+ },
+ "name": {
+ "description": "A name for the template.",
+ "type": "string"
+ },
+ "negotiations_allowed": {
+ "description": "Whether counterparties can propose changes to agreements created from this template.",
+ "type": "boolean"
+ },
+ "recipient_role": {
+ "description": "The label for the receiving party in the agreement.",
+ "type": "string"
+ },
+ "sender_last_to_sign": {
+ "description": "When true, the sender signs after the recipient.",
+ "type": "boolean"
+ },
+ "sender_role": {
+ "description": "The label for the sending party in the agreement.",
+ "type": "string"
+ },
+ "template_psa_statement_of_work_attributes": {
+ "additionalProperties": false,
+ "description": "Nested PSA statement of work defaults.",
+ "properties": {
+ "additional_changes": {
+ "description": "Text of additional changes to include when include_additional_changes is true.",
+ "type": "string"
+ },
+ "fees_attributes": {
+ "items": {
+ "additionalProperties": false,
+ "properties": {
+ "cost": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "description": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "quantity": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "include_additional_changes": {
+ "description": "Whether to include the additional changes section.",
+ "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": {
+ "type": "string"
+ },
+ "include_deliverables_resubmission_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_deliverables_resubmission_unit": {
+ "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": {
+ "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": {
+ "type": "string"
+ },
+ "invoice_period_description": {
+ "type": "string"
+ },
+ "negotiations_allowed": {
+ "description": "Whether counterparties can propose changes to agreements created from this template.",
+ "type": "boolean"
+ },
+ "payment_period": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "payment_period_other": {
+ "type": "string"
+ },
+ "payment_period_timeframe": {
+ "type": "string"
+ },
+ "payment_period_type": {
+ "type": "string"
+ },
+ "payment_period_unit": {
+ "type": "string"
+ },
+ "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": {
+ "type": "string"
+ },
+ "sow_term_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "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": {
+ "type": "string"
+ },
+ "sow_term_unit": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "template_setting_attributes": {
+ "additionalProperties": false,
+ "description": "Template settings such as standard version and message.",
+ "properties": {
+ "include_message": {
+ "type": "boolean"
+ },
+ "message": {
+ "type": "string"
+ },
+ "standard_version": {
+ "type": "string"
+ },
+ "subsidiary_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"
+ }
+ },
+ "type": "object"
+ },
+ "type": {
+ "description": "The type of template to create.",
+ "type": "string"
+ },
+ "version": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "type"
+ ],
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "additional_changes": {
+ "description": "Text of additional changes to include when include_additional_changes is true.",
+ "type": "string"
+ },
+ "attachment_ids": {
+ "description": "UUIDs of attachments to include with the template.",
+ "items": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "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"
+ },
+ "customer_description": {
+ "type": "string"
+ },
+ "default_signer_email": {
+ "description": "Default email address pre-filled as the signer when creating agreements from this template.",
+ "format": "email",
+ "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "district_or_county": {
+ "description": "The district or county for dispute resolution.",
+ "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": {
+ "type": "string"
+ },
+ "governing_law_country": {
+ "description": "The country whose laws govern agreements created from this template.",
+ "type": "string"
+ },
+ "governing_law_region": {
+ "description": "The state or region whose laws govern agreements created from this template.",
+ "type": "string"
+ },
+ "include_additional_changes": {
+ "description": "Whether to include the additional changes section.",
+ "type": "boolean"
+ },
+ "include_fees": {
+ "type": "boolean"
+ },
+ "include_fees_amount": {
+ "type": "number"
+ },
+ "include_fees_description": {
+ "type": "string"
+ },
+ "include_fees_pay_by_amount": {},
+ "include_fees_type": {
+ "type": "string"
+ },
+ "include_fees_unit": {
+ "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": {
+ "type": "string"
+ },
+ "include_program_participation_feedback": {
+ "type": "boolean"
+ },
+ "include_program_participation_feedback_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_program_participation_feedback_unit": {
+ "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"
+ },
+ "include_terms": {
+ "description": "Whether to include standard terms in the agreement.",
+ "type": "boolean"
+ },
+ "name": {
+ "description": "A name for the template.",
+ "type": "string"
+ },
+ "negotiations_allowed": {
+ "description": "Whether counterparties can propose changes to agreements created from this template.",
+ "type": "boolean"
+ },
+ "product_description": {
+ "type": "string"
+ },
+ "recipient_role": {
+ "description": "The label for the receiving party in the agreement.",
+ "type": "string"
+ },
+ "sender_last_to_sign": {
+ "description": "When true, the sender signs after the recipient.",
+ "type": "boolean"
+ },
+ "sender_role": {
+ "description": "The label for the sending party in the agreement.",
+ "type": "string"
+ },
+ "template_setting_attributes": {
+ "additionalProperties": false,
+ "description": "Template settings such as standard version and message.",
+ "properties": {
+ "include_message": {
+ "type": "boolean"
+ },
+ "message": {
+ "type": "string"
+ },
+ "standard_version": {
+ "type": "string"
+ },
+ "subsidiary_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"
+ }
+ },
+ "type": "object"
+ },
+ "term_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "term_unit": {
+ "type": "string"
+ },
+ "type": {
+ "description": "The type of template to create.",
+ "type": "string"
+ },
+ "version": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "type"
+ ],
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "additional_changes": {
+ "description": "Text of additional changes to include when include_additional_changes is true.",
+ "type": "string"
+ },
+ "attachment_ids": {
+ "description": "UUIDs of attachments to include with the template.",
+ "items": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "billing_workflow_type": {
+ "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"
+ },
+ "default_signer_email": {
+ "description": "Default email address pre-filled as the signer when creating agreements from this template.",
+ "format": "email",
+ "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "district_or_county": {
+ "description": "The district or county for dispute resolution.",
+ "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": {
+ "type": "string"
+ },
+ "general_cap_amount": {
+ "type": "number"
+ },
+ "general_cap_amount_type": {
+ "type": "string"
+ },
+ "general_cap_period_currency": {
+ "type": "number"
+ },
+ "general_cap_period_qty": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "general_cap_preceding_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "governing_law_country": {
+ "description": "The country whose laws govern agreements created from this template.",
+ "type": "string"
+ },
+ "governing_law_region": {
+ "description": "The state or region whose laws govern agreements created from this template.",
+ "type": "string"
+ },
+ "include_additional_changes": {
+ "description": "Whether to include the additional changes section.",
+ "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_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_billing_workflow": {
+ "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_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": {
+ "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_terms": {
+ "description": "Whether to include standard terms in the agreement.",
+ "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": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "increased_cap_amount_qty": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "increased_cap_amount_type": {
+ "type": "string"
+ },
+ "name": {
+ "description": "A name for the template.",
+ "type": "string"
+ },
+ "negotiations_allowed": {
+ "description": "Whether counterparties can propose changes to agreements created from this template.",
+ "type": "boolean"
+ },
+ "payment_link_url": {
+ "type": "string"
+ },
+ "recipient_role": {
+ "description": "The label for the receiving party in the agreement.",
+ "type": "string"
+ },
+ "sender_last_to_sign": {
+ "description": "When true, the sender signs after the recipient.",
+ "type": "boolean"
+ },
+ "sender_role": {
+ "description": "The label for the sending party in the agreement.",
+ "type": "string"
+ },
+ "stripe_invoice_delivery": {
+ "type": "string"
+ },
+ "stripe_payment_link_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"
+ },
+ "stripe_product_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"
+ },
+ "stripe_product_name": {
+ "type": "string"
+ },
+ "stripe_subsequent_bill_method": {
+ "type": "string"
+ },
+ "template_setting_attributes": {
+ "additionalProperties": false,
+ "description": "Template settings such as standard version and message.",
+ "properties": {
+ "include_message": {
+ "type": "boolean"
+ },
+ "message": {
+ "type": "string"
+ },
+ "standard_version": {
+ "type": "string"
+ },
+ "subsidiary_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"
+ }
+ },
+ "type": "object"
+ },
+ "template_software_license_order_form_attributes": {
+ "additionalProperties": false,
+ "description": "Nested software license order form defaults.",
+ "properties": {
+ "additional_changes": {
+ "description": "Text of additional changes to include when include_additional_changes is true.",
+ "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": {
+ "type": "string"
+ },
+ "fees_attributes": {
+ "items": {
+ "additionalProperties": false,
+ "properties": {
+ "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"
+ },
+ "cost": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "description": {
+ "type": "string"
+ },
+ "discount_duration_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "discount_duration_type": {
+ "type": "string"
+ },
+ "discount_type": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "graduated_fee_tiers_attributes": {
+ "items": {
+ "additionalProperties": false,
+ "properties": {
+ "flat_price": {
+ "type": "string"
+ },
+ "price_per_unit": {
+ "type": "string"
+ },
+ "upper_limit": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "quantity": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "stripe_product_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"
+ },
+ "type": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "fees_currency": {
+ "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": {
+ "type": "string"
+ },
+ "fees_inclusive_of_taxes": {
+ "type": "boolean"
+ },
+ "include_additional_changes": {
+ "description": "Whether to include the additional changes section.",
+ "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": {
+ "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": "Whether counterparties can propose changes to agreements created from this template.",
+ "type": "boolean"
+ },
+ "order_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"
+ },
+ "order_date_type": {
+ "type": "string"
+ },
+ "payment_process_automatic_frequency": {
+ "type": "string"
+ },
+ "payment_process_type": {
+ "type": "string"
+ },
+ "payment_process_type_custom_val": {
+ "type": "string"
+ },
+ "payment_process_type_invoice_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "payment_process_type_invoice_custom_unit": {
+ "type": "string"
+ },
+ "payment_process_type_invoice_duration": {
+ "type": "string"
+ },
+ "payment_process_type_invoice_duration_start": {
+ "type": "string"
+ },
+ "payment_process_type_invoice_type": {
+ "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": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "software_description": {
+ "type": "string"
+ },
+ "subscription_auto_renew": {
+ "type": "string"
+ },
+ "subscription_period": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "subscription_period_unit": {
+ "type": "string"
+ },
+ "subscription_renewal_notice_days": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "warranty_period_description_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "warranty_period_description_duration": {
+ "type": "string"
+ },
+ "warranty_period_description_duration_start": {
+ "type": "string"
+ },
+ "warranty_period_type": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "type": {
+ "description": "The type of template to create.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "type"
+ ],
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "additional_changes": {
+ "description": "Text of additional changes to include when include_additional_changes is true.",
+ "type": "string"
+ },
+ "additional_terms": {
+ "type": "string"
+ },
+ "attachment_ids": {
+ "description": "UUIDs of attachments to include with the template.",
+ "items": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "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"
+ },
+ "default_signer_email": {
+ "description": "Default email address pre-filled as the signer when creating agreements from this template.",
+ "format": "email",
+ "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "district_or_county": {
+ "description": "The district or county for dispute resolution.",
+ "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": {
+ "type": "string"
+ },
+ "fees_type": {
+ "type": "string"
+ },
+ "general_cap_amount": {
+ "type": "number"
+ },
+ "general_cap_amount_type": {
+ "type": "string"
+ },
+ "general_cap_period_currency": {
+ "type": "number"
+ },
+ "general_cap_period_qty": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "general_cap_preceding_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "governing_law_country": {
+ "description": "The country whose laws govern agreements created from this template.",
+ "type": "string"
+ },
+ "governing_law_region": {
+ "description": "The state or region whose laws govern agreements created from this template.",
+ "type": "string"
+ },
+ "include_additional_changes": {
+ "description": "Whether to include the additional changes section.",
+ "type": "boolean"
+ },
+ "include_additional_terms": {
+ "type": "boolean"
+ },
+ "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": {
+ "type": "string"
+ },
+ "include_payment_process": {
+ "type": "boolean"
+ },
+ "include_technical_support": {
+ "type": "boolean"
+ },
+ "include_terms": {
+ "description": "Whether to include standard terms in the agreement.",
+ "type": "boolean"
+ },
+ "name": {
+ "description": "A name for the template.",
+ "type": "string"
+ },
+ "negotiations_allowed": {
+ "description": "Whether counterparties can propose changes to agreements created from this template.",
+ "type": "boolean"
+ },
+ "payment_process_automatic_frequency": {
+ "type": "string"
+ },
+ "payment_process_invoice_days": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "payment_process_invoice_from": {
+ "type": "string"
+ },
+ "payment_process_invoice_timeframe": {
+ "type": "string"
+ },
+ "payment_process_type": {
+ "type": "string"
+ },
+ "pilot_period_description": {
+ "type": "string"
+ },
+ "pilot_period_fees_description": {
+ "type": "string"
+ },
+ "product_description": {
+ "type": "string"
+ },
+ "recipient_role": {
+ "description": "The label for the receiving party in the agreement.",
+ "type": "string"
+ },
+ "sender_last_to_sign": {
+ "description": "When true, the sender signs after the recipient.",
+ "type": "boolean"
+ },
+ "sender_role": {
+ "description": "The label for the sending party in the agreement.",
+ "type": "string"
+ },
+ "technical_support_description": {
+ "type": "string"
+ },
+ "template_setting_attributes": {
+ "additionalProperties": false,
+ "description": "Template settings such as standard version and message.",
+ "properties": {
+ "include_message": {
+ "type": "boolean"
+ },
+ "message": {
+ "type": "string"
+ },
+ "standard_version": {
+ "type": "string"
+ },
+ "subsidiary_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"
+ }
+ },
+ "type": "object"
+ },
+ "type": {
+ "description": "The type of template to create.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "type"
+ ],
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "additional_changes": {
+ "description": "Text of additional changes to include when include_additional_changes is true.",
+ "type": "string"
+ },
+ "attachment_ids": {
+ "description": "UUIDs of attachments to include with the template.",
+ "items": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "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"
+ },
+ "default_signer_email": {
+ "description": "Default email address pre-filled as the signer when creating agreements from this template.",
+ "format": "email",
+ "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "district_or_county": {
+ "description": "The district or county for dispute resolution.",
+ "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": {
+ "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": {
+ "type": "string"
+ },
+ "governing_law_country": {
+ "description": "The country whose laws govern agreements created from this template.",
+ "type": "string"
+ },
+ "governing_law_region": {
+ "description": "The state or region whose laws govern agreements created from this template.",
+ "type": "string"
+ },
+ "include_additional_changes": {
+ "description": "Whether to include the additional changes section.",
+ "type": "boolean"
+ },
+ "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": {
+ "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": {},
+ "include_increased_cap_amount_multiple": {},
+ "include_increased_cap_amount_type": {
+ "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_terms": {
+ "description": "Whether to include standard terms in the agreement.",
+ "type": "boolean"
+ },
+ "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"
+ },
+ "name": {
+ "description": "A name for the template.",
+ "type": "string"
+ },
+ "negotiations_allowed": {
+ "description": "Whether counterparties can propose changes to agreements created from this template.",
+ "type": "boolean"
+ },
+ "recipient_role": {
+ "description": "The label for the receiving party in the agreement.",
+ "type": "string"
+ },
+ "sender_last_to_sign": {
+ "description": "When true, the sender signs after the recipient.",
+ "type": "boolean"
+ },
+ "sender_role": {
+ "description": "The label for the sending party in the agreement.",
+ "type": "string"
+ },
+ "template_partnership_business_terms_attributes": {
+ "additionalProperties": false,
+ "description": "Nested partnership business terms defaults.",
+ "properties": {
+ "end_date_after_effective_date_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "end_date_after_effective_date_unit": {
+ "type": "string"
+ },
+ "end_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"
+ },
+ "end_date_type": {
+ "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": {
+ "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": {
+ "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": {
+ "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": {
+ "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": {
+ "format": "email",
+ "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "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": {
+ "format": "email",
+ "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "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": {
+ "type": "string"
+ },
+ "include_payment_schedule_specified_unit": {
+ "type": "string"
+ },
+ "include_payment_schedule_type": {
+ "type": "string"
+ },
+ "negotiations_allowed": {
+ "description": "Whether counterparties can propose changes to agreements created from this template.",
+ "type": "boolean"
+ },
+ "territory_type": {
+ "type": "string"
+ },
+ "territory_type_val": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "template_setting_attributes": {
+ "additionalProperties": false,
+ "description": "Template settings such as standard version and message.",
+ "properties": {
+ "include_message": {
+ "type": "boolean"
+ },
+ "message": {
+ "type": "string"
+ },
+ "standard_version": {
+ "type": "string"
+ },
+ "subsidiary_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"
+ }
+ },
+ "type": "object"
+ },
+ "type": {
+ "description": "The type of template to create.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "type"
+ ],
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "additional_changes": {
+ "description": "Text of additional changes to include when include_additional_changes is true.",
+ "type": "string"
+ },
+ "aggregation_limitations_permitted": {
+ "type": "boolean"
+ },
+ "aggregation_limitations_permitted_val": {
+ "type": "string"
+ },
+ "attachment_ids": {
+ "description": "UUIDs of attachments to include with the template.",
+ "items": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "breach_notification_unit": {
+ "type": "string"
+ },
+ "breach_notification_val": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "business_associate_relationship_type": {
+ "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"
+ },
+ "default_signer_email": {
+ "description": "Default email address pre-filled as the signer when creating agreements from this template.",
+ "format": "email",
+ "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "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"
+ },
+ "district_or_county": {
+ "description": "The district or county for dispute resolution.",
+ "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": {
+ "type": "string"
+ },
+ "governing_law_country": {
+ "description": "The country whose laws govern agreements created from this template.",
+ "type": "string"
+ },
+ "governing_law_region": {
+ "description": "The state or region whose laws govern agreements created from this template.",
+ "type": "string"
+ },
+ "include_additional_changes": {
+ "description": "Whether to include the additional changes section.",
+ "type": "boolean"
+ },
+ "include_aggregation_limitations": {
+ "type": "boolean"
+ },
+ "include_deidentification_limitations": {
+ "type": "boolean"
+ },
+ "include_limitations": {
+ "type": "boolean"
+ },
+ "include_offshore_limitations": {
+ "type": "boolean"
+ },
+ "include_subcontract_limitations": {
+ "type": "boolean"
+ },
+ "include_terms": {
+ "description": "Whether to include standard terms in the agreement.",
+ "type": "boolean"
+ },
+ "name": {
+ "description": "A name for the template.",
+ "type": "string"
+ },
+ "negotiations_allowed": {
+ "description": "Whether counterparties can propose changes to agreements created from this template.",
+ "type": "boolean"
+ },
+ "offshore_limitations_permitted": {
+ "type": "boolean"
+ },
+ "offshore_limitations_permitted_val": {
+ "type": "string"
+ },
+ "recipient_role": {
+ "description": "The label for the receiving party in the agreement.",
+ "type": "string"
+ },
+ "sender_last_to_sign": {
+ "description": "When true, the sender signs after the recipient.",
+ "type": "boolean"
+ },
+ "sender_role": {
+ "description": "The label for the sending party in the agreement.",
+ "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"
+ },
+ "template_setting_attributes": {
+ "additionalProperties": false,
+ "description": "Template settings such as standard version and message.",
+ "properties": {
+ "include_message": {
+ "type": "boolean"
+ },
+ "message": {
+ "type": "string"
+ },
+ "standard_version": {
+ "type": "string"
+ },
+ "subsidiary_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"
+ }
+ },
+ "type": "object"
+ },
+ "type": {
+ "description": "The type of template to create.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "type"
+ ],
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "additional_changes": {
+ "description": "Text of additional changes to include when include_additional_changes is true.",
+ "type": "string"
+ },
+ "attachment_ids": {
+ "description": "UUIDs of attachments to include with the template.",
+ "items": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "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"
+ },
+ "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": {
+ "type": "string"
+ },
+ "confidentiality_type": {
+ "type": "string"
+ },
+ "default_signer_email": {
+ "description": "Default email address pre-filled as the signer when creating agreements from this template.",
+ "format": "email",
+ "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "district_or_county": {
+ "description": "The district or county for dispute resolution.",
+ "type": "string"
+ },
+ "governing_law_country": {
+ "description": "The country whose laws govern agreements created from this template.",
+ "type": "string"
+ },
+ "governing_law_region": {
+ "description": "The state or region whose laws govern agreements created from this template.",
+ "type": "string"
+ },
+ "include_additional_changes": {
+ "description": "Whether to include the additional changes section.",
+ "type": "boolean"
+ },
+ "include_custom_details": {
+ "type": "boolean"
+ },
+ "include_custom_details_val": {
+ "type": "string"
+ },
+ "include_fees": {
+ "type": "boolean"
+ },
+ "include_fees_amount": {
+ "type": "number"
+ },
+ "include_fees_amount_duration": {
+ "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": {
+ "type": "string"
+ },
+ "include_terms": {
+ "description": "Whether to include standard terms in the agreement.",
+ "type": "boolean"
+ },
+ "name": {
+ "description": "A name for the template.",
+ "type": "string"
+ },
+ "negotiations_allowed": {
+ "description": "Whether counterparties can propose changes to agreements created from this template.",
+ "type": "boolean"
+ },
+ "product_name": {
+ "type": "string"
+ },
+ "recipient_role": {
+ "description": "The label for the receiving party in the agreement.",
+ "type": "string"
+ },
+ "sender_last_to_sign": {
+ "description": "When true, the sender signs after the recipient.",
+ "type": "boolean"
+ },
+ "sender_role": {
+ "description": "The label for the sending party in the agreement.",
+ "type": "string"
+ },
+ "template_setting_attributes": {
+ "additionalProperties": false,
+ "description": "Template settings such as standard version and message.",
+ "properties": {
+ "include_message": {
+ "type": "boolean"
+ },
+ "message": {
+ "type": "string"
+ },
+ "standard_version": {
+ "type": "string"
+ },
+ "subsidiary_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"
+ }
+ },
+ "type": "object"
+ },
+ "type": {
+ "description": "The type of template to create.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "type"
+ ],
+ "type": "object"
+ }
+]update-template1 field changedInput schema / properties / body / anyOfPrevious value: -[
- {
- "additionalProperties": false,
- "properties": {
- "additional_changes": {
- "description": "Text of additional changes to include when include_additional_changes is true.",
- "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"
- },
- "confidentiality_period": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "confidentiality_period_perpetual": {
- "type": "boolean"
- },
- "default_signer_email": {
- "description": "Default email address pre-filled as the signer when creating agreements from this template.",
- "format": "email",
- "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
- "type": "string"
- },
- "district_or_county": {
- "description": "The district or county for dispute resolution.",
- "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_of_confidentiality": {
- "type": "string"
- },
- "effective_date_type": {
- "type": "string"
- },
- "governing_law_country": {
- "description": "The country whose laws govern agreements created from this template.",
- "type": "string"
- },
- "governing_law_region": {
- "description": "The state or region whose laws govern agreements created from this template.",
- "type": "string"
- },
- "include_additional_changes": {
- "description": "Whether to include the additional changes section.",
- "type": "boolean"
- },
- "include_terms": {
- "description": "Whether to include standard terms in the agreement.",
- "type": "boolean"
- },
- "name": {
- "description": "A name for the template.",
- "type": "string"
- },
- "negotiations_allowed": {
- "description": "Whether counterparties can propose changes to agreements created from this template.",
- "type": "boolean"
- },
- "purpose": {
- "type": "string"
- },
- "recipient_role": {
- "description": "The label for the receiving party in the agreement.",
- "type": "string"
- },
- "sender_last_to_sign": {
- "description": "When true, the sender signs after the recipient.",
- "type": "boolean"
- },
- "sender_role": {
- "description": "The label for the sending party in the agreement.",
- "type": "string"
- },
- "template_setting_attributes": {
- "additionalProperties": false,
- "description": "Template settings such as standard version and message.",
- "properties": {
- "include_message": {
- "type": "boolean"
- },
- "message": {
- "type": "string"
- },
- "standard_version": {
- "type": "string"
- },
- "subsidiary_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"
- }
- },
- "type": "object"
- },
- "term": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "term_period_perpetual": {
- "type": "boolean"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "additional_changes": {
- "description": "Text of additional changes to include when include_additional_changes is true.",
- "type": "string"
- },
- "attachment_ids": {
- "description": "UUIDs of attachments to include with the template.",
- "items": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "type": "array"
- },
- "billing_workflow_type": {
- "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"
- },
- "customer_description": {
- "type": "string"
- },
- "default_signer_email": {
- "description": "Default email address pre-filled as the signer when creating agreements from this template.",
- "format": "email",
- "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
- "type": "string"
- },
- "district_or_county": {
- "description": "The district or county for dispute resolution.",
- "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": {
- "type": "string"
- },
- "effective_date_type": {
- "type": "string"
- },
- "general_cap_amount": {
- "type": "number"
- },
- "general_cap_amount_type": {
- "type": "string"
- },
- "general_cap_period_currency": {
- "type": "number"
- },
- "general_cap_period_qty": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "general_cap_preceding_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "governing_law_country": {
- "description": "The country whose laws govern agreements created from this template.",
- "type": "string"
- },
- "governing_law_region": {
- "description": "The state or region whose laws govern agreements created from this template.",
- "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": {
- "type": "string"
- },
- "include_additional_changes": {
- "description": "Whether to include the additional changes section.",
- "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_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_billing_workflow": {
- "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_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": {
- "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": {
- "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": {
- "type": "string"
- },
- "include_terms": {
- "description": "Whether to include standard terms in the agreement.",
- "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": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "increased_cap_amount_qty": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "increased_cap_amount_type": {
- "type": "string"
- },
- "name": {
- "description": "A name for the template.",
- "type": "string"
- },
- "negotiations_allowed": {
- "description": "Whether counterparties can propose changes to agreements created from this template.",
- "type": "boolean"
- },
- "payment_link_url": {
- "type": "string"
- },
- "provider": {
- "type": "string"
- },
- "recipient_role": {
- "description": "The label for the receiving party in the agreement.",
- "type": "string"
- },
- "sender_last_to_sign": {
- "description": "When true, the sender signs after the recipient.",
- "type": "boolean"
- },
- "sender_role": {
- "description": "The label for the sending party in the agreement.",
- "type": "string"
- },
- "stripe_invoice_delivery": {
- "type": "string"
- },
- "stripe_payment_link_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"
- },
- "stripe_product_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"
- },
- "stripe_product_name": {
- "type": "string"
- },
- "stripe_subsequent_bill_method": {
- "type": "string"
- },
- "template_csa_order_form_attributes": {
- "additionalProperties": false,
- "description": "Nested CSA order form defaults. See Template Parameters docs for CSA Order Form.",
- "properties": {
- "additional_changes": {
- "description": "Text of additional changes to include when include_additional_changes is true.",
- "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": {
- "type": "string"
- },
- "fees_attributes": {
- "items": {
- "additionalProperties": false,
- "properties": {
- "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"
- },
- "cost": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "description": {
- "type": "string"
- },
- "discount_duration_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "discount_duration_type": {
- "type": "string"
- },
- "discount_type": {
- "type": "string"
- },
- "fee_type": {
- "type": "string"
- },
- "graduated_fee_tiers_attributes": {
- "items": {
- "additionalProperties": false,
- "properties": {
- "flat_price": {
- "type": "string"
- },
- "price_per_unit": {
- "type": "string"
- },
- "upper_limit": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- }
- },
- "type": "object"
- },
- "type": "array"
- },
- "quantity": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "stripe_product_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"
- },
- "type": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "type": "array"
- },
- "fees_currency": {
- "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": {
- "type": "string"
- },
- "fees_inclusive_of_taxes": {
- "type": "boolean"
- },
- "free_trial_days": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_additional_changes": {
- "description": "Whether to include the additional changes section.",
- "type": "boolean"
- },
- "include_additional_parameters_or_limitations": {
- "type": "boolean"
- },
- "include_billing_info": {
- "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": {
- "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": {
- "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": {
- "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": {
- "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": {
- "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": {
- "type": "string"
- },
- "include_sla_standard_maintenance_notice_qty": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_sla_standard_maintenance_notice_unit": {
- "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": {
- "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": {
- "type": "string"
- },
- "invoice_period_custom_unit": {
- "type": "string"
- },
- "max_consumption": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "max_users": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "negotiations_allowed": {
- "description": "Whether counterparties can propose changes to agreements created from this template.",
- "type": "boolean"
- },
- "order_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"
- },
- "order_date_other": {
- "type": "string"
- },
- "order_date_type": {
- "type": "string"
- },
- "payment_period": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "payment_period_timeframe": {
- "type": "string"
- },
- "payment_period_unit": {
- "type": "string"
- },
- "payment_process_automatic_frequency": {
- "type": "string"
- },
- "payment_process_type": {
- "type": "string"
- },
- "payment_process_type_custom_val": {
- "type": "string"
- },
- "payment_process_type_invoice_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "payment_process_type_invoice_custom_unit": {
- "type": "string"
- },
- "payment_process_type_invoice_duration": {
- "type": "string"
- },
- "payment_process_type_invoice_duration_start": {
- "type": "string"
- },
- "payment_process_type_invoice_type": {
- "type": "string"
- },
- "pilot_period_stripe_product_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"
- },
- "service_credits_attributes": {
- "items": {
- "additionalProperties": false,
- "properties": {
- "credit": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "max": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "min": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- }
- },
- "type": "object"
- },
- "type": "array"
- },
- "subscription_auto_renew": {
- "type": "string"
- },
- "subscription_period": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "subscription_period_unit": {
- "type": "string"
- },
- "subscription_renewal_notice_days": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "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": {
- "type": "string"
- },
- "use_limitations_attributes": {
- "items": {
- "additionalProperties": false,
- "properties": {
- "amount": {
- "type": "string"
- },
- "limitation_type": {
- "type": "string"
- },
- "unit": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "type": "array"
- }
- },
- "type": "object"
- },
- "template_setting_attributes": {
- "additionalProperties": false,
- "description": "Template settings such as standard version and message.",
- "properties": {
- "include_message": {
- "type": "boolean"
- },
- "message": {
- "type": "string"
- },
- "standard_version": {
- "type": "string"
- },
- "subsidiary_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"
- }
- },
- "type": "object"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "additional_changes": {
- "description": "Text of additional changes to include when include_additional_changes is true.",
- "type": "string"
- },
- "approved_subprocessor_type": {
- "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"
- },
- "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": {
- "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"
- },
- "default_signer_email": {
- "description": "Default email address pre-filled as the signer when creating agreements from this template.",
- "format": "email",
- "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
- "type": "string"
- },
- "district_or_county": {
- "description": "The district or county for dispute resolution.",
- "type": "string"
- },
- "duration_of_processing": {
- "type": "string"
- },
- "governing_law_country": {
- "description": "The country whose laws govern agreements created from this template.",
- "type": "string"
- },
- "governing_law_region": {
- "description": "The state or region whose laws govern agreements created from this template.",
- "type": "string"
- },
- "include_additional_changes": {
- "description": "Whether to include the additional changes section.",
- "type": "boolean"
- },
- "include_covered_claim": {
- "type": "boolean"
- },
- "include_covered_claim_external_val": {
- "type": "string"
- },
- "include_covered_claim_internal_val": {
- "type": "string"
- },
- "include_covered_claim_type": {
- "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": {
- "type": "boolean"
- },
- "include_increased_claim_amount_currency": {
- "type": "string"
- },
- "include_increased_claim_amount_qty": {},
- "include_increased_claim_amount_type": {
- "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": {
- "type": "string"
- },
- "include_liability_cap_amount_currency_internal": {
- "type": "string"
- },
- "include_liability_cap_csa_type": {
- "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-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_provider": {
- "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"
- },
- "include_terms": {
- "description": "Whether to include standard terms in the agreement.",
- "type": "boolean"
- },
- "name": {
- "description": "A name for the template.",
- "type": "string"
- },
- "negotiations_allowed": {
- "description": "Whether counterparties can propose changes to agreements created from this template.",
- "type": "boolean"
- },
- "provider": {
- "type": "string"
- },
- "recipient_role": {
- "description": "The label for the receiving party in the agreement.",
- "type": "string"
- },
- "security_policy_available_at": {
- "type": "string"
- },
- "security_policy_type": {
- "type": "string"
- },
- "sender_last_to_sign": {
- "description": "When true, the sender signs after the recipient.",
- "type": "boolean"
- },
- "sender_role": {
- "description": "The label for the sending party in the agreement.",
- "type": "string"
- },
- "subprocessors_attributes": {
- "description": "List of subprocessors. Each item may include name, country, and processing_task.",
- "items": {
- "additionalProperties": false,
- "properties": {
- "country": {
- "type": "string"
- },
- "name": {
- "description": "A name for the template.",
- "type": "string"
- },
- "processing_task": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "type": "array"
- },
- "template_setting_attributes": {
- "additionalProperties": false,
- "description": "Template settings such as standard version and message.",
- "properties": {
- "include_message": {
- "type": "boolean"
- },
- "message": {
- "type": "string"
- },
- "standard_version": {
- "type": "string"
- },
- "subsidiary_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"
- }
- },
- "type": "object"
- },
- "underlying_agreement_val": {
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "additional_changes": {
- "description": "Text of additional changes to include when include_additional_changes is true.",
- "type": "string"
- },
- "attachment_ids": {
- "description": "UUIDs of attachments to include with the template.",
- "items": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "type": "array"
- },
- "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"
- },
- "default_signer_email": {
- "description": "Default email address pre-filled as the signer when creating agreements from this template.",
- "format": "email",
- "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
- "type": "string"
- },
- "district_or_county": {
- "description": "The district or county for dispute resolution.",
- "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": {
- "type": "string"
- },
- "general_cap_amount": {
- "type": "number"
- },
- "general_cap_amount_type": {
- "type": "string"
- },
- "general_cap_period_currency": {
- "type": "number"
- },
- "general_cap_period_qty": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "general_cap_preceding_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "governing_law_country": {
- "description": "The country whose laws govern agreements created from this template.",
- "type": "string"
- },
- "governing_law_region": {
- "description": "The state or region whose laws govern agreements created from this template.",
- "type": "string"
- },
- "include_additional_changes": {
- "description": "Whether to include the additional changes section.",
- "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": {
- "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": {
- "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": {
- "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": {
- "type": "string"
- },
- "include_terms": {
- "description": "Whether to include standard terms in the agreement.",
- "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_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": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "increased_cap_amount_qty": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "increased_cap_amount_type": {
- "type": "string"
- },
- "name": {
- "description": "A name for the template.",
- "type": "string"
- },
- "negotiations_allowed": {
- "description": "Whether counterparties can propose changes to agreements created from this template.",
- "type": "boolean"
- },
- "recipient_role": {
- "description": "The label for the receiving party in the agreement.",
- "type": "string"
- },
- "sender_last_to_sign": {
- "description": "When true, the sender signs after the recipient.",
- "type": "boolean"
- },
- "sender_role": {
- "description": "The label for the sending party in the agreement.",
- "type": "string"
- },
- "template_psa_statement_of_work_attributes": {
- "additionalProperties": false,
- "description": "Nested PSA statement of work defaults.",
- "properties": {
- "additional_changes": {
- "description": "Text of additional changes to include when include_additional_changes is true.",
- "type": "string"
- },
- "fees_attributes": {
- "items": {
- "additionalProperties": false,
- "properties": {
- "cost": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "description": {
- "type": "string"
- },
- "fee_type": {
- "type": "string"
- },
- "quantity": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- }
- },
- "type": "object"
- },
- "type": "array"
- },
- "include_additional_changes": {
- "description": "Whether to include the additional changes section.",
- "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": {
- "type": "string"
- },
- "include_deliverables_resubmission_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_deliverables_resubmission_unit": {
- "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": {
- "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": {
- "type": "string"
- },
- "invoice_period_description": {
- "type": "string"
- },
- "negotiations_allowed": {
- "description": "Whether counterparties can propose changes to agreements created from this template.",
- "type": "boolean"
- },
- "payment_period": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "payment_period_other": {
- "type": "string"
- },
- "payment_period_timeframe": {
- "type": "string"
- },
- "payment_period_type": {
- "type": "string"
- },
- "payment_period_unit": {
- "type": "string"
- },
- "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": {
- "type": "string"
- },
- "sow_term_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "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": {
- "type": "string"
- },
- "sow_term_unit": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "template_setting_attributes": {
- "additionalProperties": false,
- "description": "Template settings such as standard version and message.",
- "properties": {
- "include_message": {
- "type": "boolean"
- },
- "message": {
- "type": "string"
- },
- "standard_version": {
- "type": "string"
- },
- "subsidiary_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"
- }
- },
- "type": "object"
- },
- "version": {
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "additional_changes": {
- "description": "Text of additional changes to include when include_additional_changes is true.",
- "type": "string"
- },
- "attachment_ids": {
- "description": "UUIDs of attachments to include with the template.",
- "items": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "type": "array"
- },
- "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"
- },
- "customer_description": {
- "type": "string"
- },
- "default_signer_email": {
- "description": "Default email address pre-filled as the signer when creating agreements from this template.",
- "format": "email",
- "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
- "type": "string"
- },
- "district_or_county": {
- "description": "The district or county for dispute resolution.",
- "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": {
- "type": "string"
- },
- "governing_law_country": {
- "description": "The country whose laws govern agreements created from this template.",
- "type": "string"
- },
- "governing_law_region": {
- "description": "The state or region whose laws govern agreements created from this template.",
- "type": "string"
- },
- "include_additional_changes": {
- "description": "Whether to include the additional changes section.",
- "type": "boolean"
- },
- "include_fees": {
- "type": "boolean"
- },
- "include_fees_amount": {
- "type": "number"
- },
- "include_fees_description": {
- "type": "string"
- },
- "include_fees_pay_by_amount": {},
- "include_fees_type": {
- "type": "string"
- },
- "include_fees_unit": {
- "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": {
- "type": "string"
- },
- "include_program_participation_feedback": {
- "type": "boolean"
- },
- "include_program_participation_feedback_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_program_participation_feedback_unit": {
- "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"
- },
- "include_terms": {
- "description": "Whether to include standard terms in the agreement.",
- "type": "boolean"
- },
- "name": {
- "description": "A name for the template.",
- "type": "string"
- },
- "negotiations_allowed": {
- "description": "Whether counterparties can propose changes to agreements created from this template.",
- "type": "boolean"
- },
- "product_description": {
- "type": "string"
- },
- "recipient_role": {
- "description": "The label for the receiving party in the agreement.",
- "type": "string"
- },
- "sender_last_to_sign": {
- "description": "When true, the sender signs after the recipient.",
- "type": "boolean"
- },
- "sender_role": {
- "description": "The label for the sending party in the agreement.",
- "type": "string"
- },
- "template_setting_attributes": {
- "additionalProperties": false,
- "description": "Template settings such as standard version and message.",
- "properties": {
- "include_message": {
- "type": "boolean"
- },
- "message": {
- "type": "string"
- },
- "standard_version": {
- "type": "string"
- },
- "subsidiary_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"
- }
- },
- "type": "object"
- },
- "term_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "term_unit": {
- "type": "string"
- },
- "version": {
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "additional_changes": {
- "description": "Text of additional changes to include when include_additional_changes is true.",
- "type": "string"
- },
- "attachment_ids": {
- "description": "UUIDs of attachments to include with the template.",
- "items": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "type": "array"
- },
- "billing_workflow_type": {
- "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"
- },
- "default_signer_email": {
- "description": "Default email address pre-filled as the signer when creating agreements from this template.",
- "format": "email",
- "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
- "type": "string"
- },
- "district_or_county": {
- "description": "The district or county for dispute resolution.",
- "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": {
- "type": "string"
- },
- "general_cap_amount": {
- "type": "number"
- },
- "general_cap_amount_type": {
- "type": "string"
- },
- "general_cap_period_currency": {
- "type": "number"
- },
- "general_cap_period_qty": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "general_cap_preceding_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "governing_law_country": {
- "description": "The country whose laws govern agreements created from this template.",
- "type": "string"
- },
- "governing_law_region": {
- "description": "The state or region whose laws govern agreements created from this template.",
- "type": "string"
- },
- "include_additional_changes": {
- "description": "Whether to include the additional changes section.",
- "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_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_billing_workflow": {
- "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_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": {
- "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_terms": {
- "description": "Whether to include standard terms in the agreement.",
- "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": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "increased_cap_amount_qty": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "increased_cap_amount_type": {
- "type": "string"
- },
- "name": {
- "description": "A name for the template.",
- "type": "string"
- },
- "negotiations_allowed": {
- "description": "Whether counterparties can propose changes to agreements created from this template.",
- "type": "boolean"
- },
- "payment_link_url": {
- "type": "string"
- },
- "recipient_role": {
- "description": "The label for the receiving party in the agreement.",
- "type": "string"
- },
- "sender_last_to_sign": {
- "description": "When true, the sender signs after the recipient.",
- "type": "boolean"
- },
- "sender_role": {
- "description": "The label for the sending party in the agreement.",
- "type": "string"
- },
- "stripe_invoice_delivery": {
- "type": "string"
- },
- "stripe_payment_link_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"
- },
- "stripe_product_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"
- },
- "stripe_product_name": {
- "type": "string"
- },
- "stripe_subsequent_bill_method": {
- "type": "string"
- },
- "template_setting_attributes": {
- "additionalProperties": false,
- "description": "Template settings such as standard version and message.",
- "properties": {
- "include_message": {
- "type": "boolean"
- },
- "message": {
- "type": "string"
- },
- "standard_version": {
- "type": "string"
- },
- "subsidiary_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"
- }
- },
- "type": "object"
- },
- "template_software_license_order_form_attributes": {
- "additionalProperties": false,
- "description": "Nested software license order form defaults.",
- "properties": {
- "additional_changes": {
- "description": "Text of additional changes to include when include_additional_changes is true.",
- "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": {
- "type": "string"
- },
- "fees_attributes": {
- "items": {
- "additionalProperties": false,
- "properties": {
- "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"
- },
- "cost": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "description": {
- "type": "string"
- },
- "discount_duration_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "discount_duration_type": {
- "type": "string"
- },
- "discount_type": {
- "type": "string"
- },
- "fee_type": {
- "type": "string"
- },
- "graduated_fee_tiers_attributes": {
- "items": {
- "additionalProperties": false,
- "properties": {
- "flat_price": {
- "type": "string"
- },
- "price_per_unit": {
- "type": "string"
- },
- "upper_limit": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- }
- },
- "type": "object"
- },
- "type": "array"
- },
- "quantity": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "stripe_product_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"
- },
- "type": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "type": "array"
- },
- "fees_currency": {
- "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": {
- "type": "string"
- },
- "fees_inclusive_of_taxes": {
- "type": "boolean"
- },
- "include_additional_changes": {
- "description": "Whether to include the additional changes section.",
- "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": {
- "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": "Whether counterparties can propose changes to agreements created from this template.",
- "type": "boolean"
- },
- "order_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"
- },
- "order_date_type": {
- "type": "string"
- },
- "payment_process_automatic_frequency": {
- "type": "string"
- },
- "payment_process_type": {
- "type": "string"
- },
- "payment_process_type_custom_val": {
- "type": "string"
- },
- "payment_process_type_invoice_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "payment_process_type_invoice_custom_unit": {
- "type": "string"
- },
- "payment_process_type_invoice_duration": {
- "type": "string"
- },
- "payment_process_type_invoice_duration_start": {
- "type": "string"
- },
- "payment_process_type_invoice_type": {
- "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": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "software_description": {
- "type": "string"
- },
- "subscription_auto_renew": {
- "type": "string"
- },
- "subscription_period": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "subscription_period_unit": {
- "type": "string"
- },
- "subscription_renewal_notice_days": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "warranty_period_description_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "warranty_period_description_duration": {
- "type": "string"
- },
- "warranty_period_description_duration_start": {
- "type": "string"
- },
- "warranty_period_type": {
- "type": "string"
- }
- },
- "type": "object"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "additional_changes": {
- "description": "Text of additional changes to include when include_additional_changes is true.",
- "type": "string"
- },
- "additional_terms": {
- "type": "string"
- },
- "attachment_ids": {
- "description": "UUIDs of attachments to include with the template.",
- "items": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "type": "array"
- },
- "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"
- },
- "default_signer_email": {
- "description": "Default email address pre-filled as the signer when creating agreements from this template.",
- "format": "email",
- "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
- "type": "string"
- },
- "district_or_county": {
- "description": "The district or county for dispute resolution.",
- "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": {
- "type": "string"
- },
- "fees_type": {
- "type": "string"
- },
- "general_cap_amount": {
- "type": "number"
- },
- "general_cap_amount_type": {
- "type": "string"
- },
- "general_cap_period_currency": {
- "type": "number"
- },
- "general_cap_period_qty": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "general_cap_preceding_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "governing_law_country": {
- "description": "The country whose laws govern agreements created from this template.",
- "type": "string"
- },
- "governing_law_region": {
- "description": "The state or region whose laws govern agreements created from this template.",
- "type": "string"
- },
- "include_additional_changes": {
- "description": "Whether to include the additional changes section.",
- "type": "boolean"
- },
- "include_additional_terms": {
- "type": "boolean"
- },
- "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": {
- "type": "string"
- },
- "include_payment_process": {
- "type": "boolean"
- },
- "include_technical_support": {
- "type": "boolean"
- },
- "include_terms": {
- "description": "Whether to include standard terms in the agreement.",
- "type": "boolean"
- },
- "name": {
- "description": "A name for the template.",
- "type": "string"
- },
- "negotiations_allowed": {
- "description": "Whether counterparties can propose changes to agreements created from this template.",
- "type": "boolean"
- },
- "payment_process_automatic_frequency": {
- "type": "string"
- },
- "payment_process_invoice_days": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "payment_process_invoice_from": {
- "type": "string"
- },
- "payment_process_invoice_timeframe": {
- "type": "string"
- },
- "payment_process_type": {
- "type": "string"
- },
- "pilot_period_description": {
- "type": "string"
- },
- "pilot_period_fees_description": {
- "type": "string"
- },
- "product_description": {
- "type": "string"
- },
- "recipient_role": {
- "description": "The label for the receiving party in the agreement.",
- "type": "string"
- },
- "sender_last_to_sign": {
- "description": "When true, the sender signs after the recipient.",
- "type": "boolean"
- },
- "sender_role": {
- "description": "The label for the sending party in the agreement.",
- "type": "string"
- },
- "technical_support_description": {
- "type": "string"
- },
- "template_setting_attributes": {
- "additionalProperties": false,
- "description": "Template settings such as standard version and message.",
- "properties": {
- "include_message": {
- "type": "boolean"
- },
- "message": {
- "type": "string"
- },
- "standard_version": {
- "type": "string"
- },
- "subsidiary_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"
- }
- },
- "type": "object"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "additional_changes": {
- "description": "Text of additional changes to include when include_additional_changes is true.",
- "type": "string"
- },
- "attachment_ids": {
- "description": "UUIDs of attachments to include with the template.",
- "items": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "type": "array"
- },
- "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"
- },
- "default_signer_email": {
- "description": "Default email address pre-filled as the signer when creating agreements from this template.",
- "format": "email",
- "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
- "type": "string"
- },
- "district_or_county": {
- "description": "The district or county for dispute resolution.",
- "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": {
- "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": {
- "type": "string"
- },
- "governing_law_country": {
- "description": "The country whose laws govern agreements created from this template.",
- "type": "string"
- },
- "governing_law_region": {
- "description": "The state or region whose laws govern agreements created from this template.",
- "type": "string"
- },
- "include_additional_changes": {
- "description": "Whether to include the additional changes section.",
- "type": "boolean"
- },
- "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": {
- "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": {},
- "include_increased_cap_amount_multiple": {},
- "include_increased_cap_amount_type": {
- "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_terms": {
- "description": "Whether to include standard terms in the agreement.",
- "type": "boolean"
- },
- "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"
- },
- "name": {
- "description": "A name for the template.",
- "type": "string"
- },
- "negotiations_allowed": {
- "description": "Whether counterparties can propose changes to agreements created from this template.",
- "type": "boolean"
- },
- "recipient_role": {
- "description": "The label for the receiving party in the agreement.",
- "type": "string"
- },
- "sender_last_to_sign": {
- "description": "When true, the sender signs after the recipient.",
- "type": "boolean"
- },
- "sender_role": {
- "description": "The label for the sending party in the agreement.",
- "type": "string"
- },
- "template_partnership_business_terms_attributes": {
- "additionalProperties": false,
- "description": "Nested partnership business terms defaults.",
- "properties": {
- "end_date_after_effective_date_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "end_date_after_effective_date_unit": {
- "type": "string"
- },
- "end_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"
- },
- "end_date_type": {
- "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": {
- "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": {
- "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": {
- "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": {
- "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": {
- "format": "email",
- "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
- "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": {
- "format": "email",
- "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
- "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": {
- "type": "string"
- },
- "include_payment_schedule_specified_unit": {
- "type": "string"
- },
- "include_payment_schedule_type": {
- "type": "string"
- },
- "negotiations_allowed": {
- "description": "Whether counterparties can propose changes to agreements created from this template.",
- "type": "boolean"
- },
- "territory_type": {
- "type": "string"
- },
- "territory_type_val": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "template_setting_attributes": {
- "additionalProperties": false,
- "description": "Template settings such as standard version and message.",
- "properties": {
- "include_message": {
- "type": "boolean"
- },
- "message": {
- "type": "string"
- },
- "standard_version": {
- "type": "string"
- },
- "subsidiary_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"
- }
- },
- "type": "object"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "additional_changes": {
- "description": "Text of additional changes to include when include_additional_changes is true.",
- "type": "string"
- },
- "aggregation_limitations_permitted": {
- "type": "boolean"
- },
- "aggregation_limitations_permitted_val": {
- "type": "string"
- },
- "attachment_ids": {
- "description": "UUIDs of attachments to include with the template.",
- "items": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "type": "array"
- },
- "breach_notification_unit": {
- "type": "string"
- },
- "breach_notification_val": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "business_associate_relationship_type": {
- "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"
- },
- "default_signer_email": {
- "description": "Default email address pre-filled as the signer when creating agreements from this template.",
- "format": "email",
- "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
- "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"
- },
- "district_or_county": {
- "description": "The district or county for dispute resolution.",
- "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": {
- "type": "string"
- },
- "governing_law_country": {
- "description": "The country whose laws govern agreements created from this template.",
- "type": "string"
- },
- "governing_law_region": {
- "description": "The state or region whose laws govern agreements created from this template.",
- "type": "string"
- },
- "include_additional_changes": {
- "description": "Whether to include the additional changes section.",
- "type": "boolean"
- },
- "include_aggregation_limitations": {
- "type": "boolean"
- },
- "include_deidentification_limitations": {
- "type": "boolean"
- },
- "include_limitations": {
- "type": "boolean"
- },
- "include_offshore_limitations": {
- "type": "boolean"
- },
- "include_subcontract_limitations": {
- "type": "boolean"
- },
- "include_terms": {
- "description": "Whether to include standard terms in the agreement.",
- "type": "boolean"
- },
- "name": {
- "description": "A name for the template.",
- "type": "string"
- },
- "negotiations_allowed": {
- "description": "Whether counterparties can propose changes to agreements created from this template.",
- "type": "boolean"
- },
- "offshore_limitations_permitted": {
- "type": "boolean"
- },
- "offshore_limitations_permitted_val": {
- "type": "string"
- },
- "recipient_role": {
- "description": "The label for the receiving party in the agreement.",
- "type": "string"
- },
- "sender_last_to_sign": {
- "description": "When true, the sender signs after the recipient.",
- "type": "boolean"
- },
- "sender_role": {
- "description": "The label for the sending party in the agreement.",
- "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"
- },
- "template_setting_attributes": {
- "additionalProperties": false,
- "description": "Template settings such as standard version and message.",
- "properties": {
- "include_message": {
- "type": "boolean"
- },
- "message": {
- "type": "string"
- },
- "standard_version": {
- "type": "string"
- },
- "subsidiary_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"
- }
- },
- "type": "object"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "additional_changes": {
- "description": "Text of additional changes to include when include_additional_changes is true.",
- "type": "string"
- },
- "attachment_ids": {
- "description": "UUIDs of attachments to include with the template.",
- "items": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "type": "array"
- },
- "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"
- },
- "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": {
- "type": "string"
- },
- "confidentiality_type": {
- "type": "string"
- },
- "default_signer_email": {
- "description": "Default email address pre-filled as the signer when creating agreements from this template.",
- "format": "email",
- "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
- "type": "string"
- },
- "district_or_county": {
- "description": "The district or county for dispute resolution.",
- "type": "string"
- },
- "governing_law_country": {
- "description": "The country whose laws govern agreements created from this template.",
- "type": "string"
- },
- "governing_law_region": {
- "description": "The state or region whose laws govern agreements created from this template.",
- "type": "string"
- },
- "include_additional_changes": {
- "description": "Whether to include the additional changes section.",
- "type": "boolean"
- },
- "include_custom_details": {
- "type": "boolean"
- },
- "include_custom_details_val": {
- "type": "string"
- },
- "include_fees": {
- "type": "boolean"
- },
- "include_fees_amount": {
- "type": "number"
- },
- "include_fees_amount_duration": {
- "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": {
- "type": "string"
- },
- "include_terms": {
- "description": "Whether to include standard terms in the agreement.",
- "type": "boolean"
- },
- "name": {
- "description": "A name for the template.",
- "type": "string"
- },
- "negotiations_allowed": {
- "description": "Whether counterparties can propose changes to agreements created from this template.",
- "type": "boolean"
- },
- "product_name": {
- "type": "string"
- },
- "recipient_role": {
- "description": "The label for the receiving party in the agreement.",
- "type": "string"
- },
- "sender_last_to_sign": {
- "description": "When true, the sender signs after the recipient.",
- "type": "boolean"
- },
- "sender_role": {
- "description": "The label for the sending party in the agreement.",
- "type": "string"
- },
- "template_setting_attributes": {
- "additionalProperties": false,
- "description": "Template settings such as standard version and message.",
- "properties": {
- "include_message": {
- "type": "boolean"
- },
- "message": {
- "type": "string"
- },
- "standard_version": {
- "type": "string"
- },
- "subsidiary_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"
- }
- },
- "type": "object"
- }
- },
- "type": "object"
- }
-]New value: +[
+ {
+ "additionalProperties": false,
+ "properties": {
+ "additional_changes": {
+ "description": "Text of additional changes to include when include_additional_changes is true.",
+ "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"
+ },
+ "confidentiality_period": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "confidentiality_period_perpetual": {
+ "type": "boolean"
+ },
+ "default_signer_email": {
+ "description": "Default email address pre-filled as the signer when creating agreements from this template.",
+ "format": "email",
+ "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "district_or_county": {
+ "description": "The district or county for dispute resolution.",
+ "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_of_confidentiality": {
+ "type": "string"
+ },
+ "effective_date_type": {
+ "type": "string"
+ },
+ "governing_law_country": {
+ "description": "The country whose laws govern agreements created from this template.",
+ "type": "string"
+ },
+ "governing_law_region": {
+ "description": "The state or region whose laws govern agreements created from this template.",
+ "type": "string"
+ },
+ "include_additional_changes": {
+ "description": "Whether to include the additional changes section.",
+ "type": "boolean"
+ },
+ "include_terms": {
+ "description": "Whether to include standard terms in the agreement.",
+ "type": "boolean"
+ },
+ "name": {
+ "description": "A name for the template.",
+ "type": "string"
+ },
+ "negotiations_allowed": {
+ "description": "Whether counterparties can propose changes to agreements created from this template.",
+ "type": "boolean"
+ },
+ "purpose": {
+ "type": "string"
+ },
+ "recipient_role": {
+ "description": "The label for the receiving party in the agreement.",
+ "type": "string"
+ },
+ "sender_last_to_sign": {
+ "description": "When true, the sender signs after the recipient.",
+ "type": "boolean"
+ },
+ "sender_role": {
+ "description": "The label for the sending party in the agreement.",
+ "type": "string"
+ },
+ "template_setting_attributes": {
+ "additionalProperties": false,
+ "description": "Template settings such as standard version and message.",
+ "properties": {
+ "include_message": {
+ "type": "boolean"
+ },
+ "message": {
+ "type": "string"
+ },
+ "standard_version": {
+ "type": "string"
+ },
+ "subsidiary_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"
+ }
+ },
+ "type": "object"
+ },
+ "term": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "term_period_perpetual": {
+ "type": "boolean"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "additional_changes": {
+ "description": "Text of additional changes to include when include_additional_changes is true.",
+ "type": "string"
+ },
+ "attachment_ids": {
+ "description": "UUIDs of attachments to include with the template.",
+ "items": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "billing_workflow_type": {
+ "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"
+ },
+ "customer_description": {
+ "type": "string"
+ },
+ "default_signer_email": {
+ "description": "Default email address pre-filled as the signer when creating agreements from this template.",
+ "format": "email",
+ "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "district_or_county": {
+ "description": "The district or county for dispute resolution.",
+ "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": {
+ "type": "string"
+ },
+ "effective_date_type": {
+ "type": "string"
+ },
+ "general_cap_amount": {
+ "type": "number"
+ },
+ "general_cap_amount_type": {
+ "type": "string"
+ },
+ "general_cap_period_currency": {
+ "type": "number"
+ },
+ "general_cap_period_qty": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "general_cap_preceding_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "governing_law_country": {
+ "description": "The country whose laws govern agreements created from this template.",
+ "type": "string"
+ },
+ "governing_law_region": {
+ "description": "The state or region whose laws govern agreements created from this template.",
+ "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": {
+ "type": "string"
+ },
+ "include_additional_changes": {
+ "description": "Whether to include the additional changes section.",
+ "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_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_billing_workflow": {
+ "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_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": {
+ "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": {
+ "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": {
+ "type": "string"
+ },
+ "include_terms": {
+ "description": "Whether to include standard terms in the agreement.",
+ "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": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "increased_cap_amount_qty": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "increased_cap_amount_type": {
+ "type": "string"
+ },
+ "name": {
+ "description": "A name for the template.",
+ "type": "string"
+ },
+ "negotiations_allowed": {
+ "description": "Whether counterparties can propose changes to agreements created from this template.",
+ "type": "boolean"
+ },
+ "payment_link_url": {
+ "type": "string"
+ },
+ "provider": {
+ "type": "string"
+ },
+ "recipient_role": {
+ "description": "The label for the receiving party in the agreement.",
+ "type": "string"
+ },
+ "sender_last_to_sign": {
+ "description": "When true, the sender signs after the recipient.",
+ "type": "boolean"
+ },
+ "sender_role": {
+ "description": "The label for the sending party in the agreement.",
+ "type": "string"
+ },
+ "stripe_invoice_delivery": {
+ "type": "string"
+ },
+ "stripe_payment_link_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"
+ },
+ "stripe_product_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"
+ },
+ "stripe_product_name": {
+ "type": "string"
+ },
+ "stripe_subsequent_bill_method": {
+ "type": "string"
+ },
+ "template_csa_order_form_attributes": {
+ "additionalProperties": false,
+ "description": "Nested CSA order form defaults. See Template Parameters docs for CSA Order Form.",
+ "properties": {
+ "additional_changes": {
+ "description": "Text of additional changes to include when include_additional_changes is true.",
+ "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": {
+ "type": "string"
+ },
+ "fees_attributes": {
+ "items": {
+ "additionalProperties": false,
+ "properties": {
+ "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"
+ },
+ "cost": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "description": {
+ "type": "string"
+ },
+ "discount_duration_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "discount_duration_type": {
+ "type": "string"
+ },
+ "discount_type": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "graduated_fee_tiers_attributes": {
+ "items": {
+ "additionalProperties": false,
+ "properties": {
+ "flat_price": {
+ "type": "string"
+ },
+ "price_per_unit": {
+ "type": "string"
+ },
+ "upper_limit": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "quantity": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "stripe_product_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"
+ },
+ "type": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "fees_currency": {
+ "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": {
+ "type": "string"
+ },
+ "fees_inclusive_of_taxes": {
+ "type": "boolean"
+ },
+ "free_trial_days": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_additional_changes": {
+ "description": "Whether to include the additional changes section.",
+ "type": "boolean"
+ },
+ "include_additional_parameters_or_limitations": {
+ "type": "boolean"
+ },
+ "include_billing_info": {
+ "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": {
+ "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": {
+ "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": {
+ "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": {
+ "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": {
+ "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": {
+ "type": "string"
+ },
+ "include_sla_standard_maintenance_notice_qty": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_sla_standard_maintenance_notice_unit": {
+ "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": {
+ "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": {
+ "type": "string"
+ },
+ "invoice_period_custom_unit": {
+ "type": "string"
+ },
+ "max_consumption": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "max_users": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "negotiations_allowed": {
+ "description": "Whether counterparties can propose changes to agreements created from this template.",
+ "type": "boolean"
+ },
+ "order_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"
+ },
+ "order_date_other": {
+ "type": "string"
+ },
+ "order_date_type": {
+ "type": "string"
+ },
+ "payment_period": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "payment_period_timeframe": {
+ "type": "string"
+ },
+ "payment_period_unit": {
+ "type": "string"
+ },
+ "payment_process_automatic_frequency": {
+ "type": "string"
+ },
+ "payment_process_type": {
+ "type": "string"
+ },
+ "payment_process_type_custom_val": {
+ "type": "string"
+ },
+ "payment_process_type_invoice_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "payment_process_type_invoice_custom_unit": {
+ "type": "string"
+ },
+ "payment_process_type_invoice_duration": {
+ "type": "string"
+ },
+ "payment_process_type_invoice_duration_start": {
+ "type": "string"
+ },
+ "payment_process_type_invoice_type": {
+ "type": "string"
+ },
+ "pilot_period_stripe_product_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"
+ },
+ "service_credits_attributes": {
+ "items": {
+ "additionalProperties": false,
+ "properties": {
+ "credit": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "max": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "min": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "subscription_auto_renew": {
+ "type": "string"
+ },
+ "subscription_period": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "subscription_period_unit": {
+ "type": "string"
+ },
+ "subscription_renewal_notice_days": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "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": {
+ "type": "string"
+ },
+ "use_limitations_attributes": {
+ "items": {
+ "additionalProperties": false,
+ "properties": {
+ "amount": {
+ "type": "string"
+ },
+ "limitation_type": {
+ "type": "string"
+ },
+ "unit": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "template_setting_attributes": {
+ "additionalProperties": false,
+ "description": "Template settings such as standard version and message.",
+ "properties": {
+ "include_message": {
+ "type": "boolean"
+ },
+ "message": {
+ "type": "string"
+ },
+ "standard_version": {
+ "type": "string"
+ },
+ "subsidiary_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"
+ }
+ },
+ "type": "object"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "additional_changes": {
+ "description": "Text of additional changes to include when include_additional_changes is true.",
+ "type": "string"
+ },
+ "approved_subprocessor_type": {
+ "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"
+ },
+ "cloud_service_product_name": {
+ "type": "string"
+ },
+ "competent_supervisory_authority": {
+ "type": "string"
+ },
+ "customer_description": {
+ "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"
+ },
+ "default_signer_email": {
+ "description": "Default email address pre-filled as the signer when creating agreements from this template.",
+ "format": "email",
+ "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "district_or_county": {
+ "description": "The district or county for dispute resolution.",
+ "type": "string"
+ },
+ "duration_of_processing": {
+ "type": "string"
+ },
+ "governing_law_country": {
+ "description": "The country whose laws govern agreements created from this template.",
+ "type": "string"
+ },
+ "governing_law_region": {
+ "description": "The state or region whose laws govern agreements created from this template.",
+ "type": "string"
+ },
+ "include_additional_changes": {
+ "description": "Whether to include the additional changes section.",
+ "type": "boolean"
+ },
+ "include_covered_claim": {
+ "type": "boolean"
+ },
+ "include_covered_claim_external_val": {
+ "type": "string"
+ },
+ "include_covered_claim_internal_val": {
+ "type": "string"
+ },
+ "include_covered_claim_type": {
+ "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": {
+ "type": "boolean"
+ },
+ "include_increased_claim_amount_currency": {
+ "type": "string"
+ },
+ "include_increased_claim_amount_qty": {},
+ "include_increased_claim_amount_type": {
+ "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": {
+ "type": "string"
+ },
+ "include_liability_cap_amount_currency_internal": {
+ "type": "string"
+ },
+ "include_liability_cap_csa_type": {
+ "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-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_provider": {
+ "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"
+ },
+ "include_terms": {
+ "description": "Whether to include standard terms in the agreement.",
+ "type": "boolean"
+ },
+ "name": {
+ "description": "A name for the template.",
+ "type": "string"
+ },
+ "negotiations_allowed": {
+ "description": "Whether counterparties can propose changes to agreements created from this template.",
+ "type": "boolean"
+ },
+ "provider": {
+ "type": "string"
+ },
+ "recipient_role": {
+ "description": "The label for the receiving party in the agreement.",
+ "type": "string"
+ },
+ "security_policy_available_at": {
+ "type": "string"
+ },
+ "security_policy_type": {
+ "type": "string"
+ },
+ "sender_last_to_sign": {
+ "description": "When true, the sender signs after the recipient.",
+ "type": "boolean"
+ },
+ "sender_role": {
+ "description": "The label for the sending party in the agreement.",
+ "type": "string"
+ },
+ "subprocessors_attributes": {
+ "description": "List of subprocessors. Each item may include name, country, and processing_task.",
+ "items": {
+ "additionalProperties": false,
+ "properties": {
+ "country": {
+ "type": "string"
+ },
+ "name": {
+ "description": "A name for the template.",
+ "type": "string"
+ },
+ "processing_task": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "template_setting_attributes": {
+ "additionalProperties": false,
+ "description": "Template settings such as standard version and message.",
+ "properties": {
+ "include_message": {
+ "type": "boolean"
+ },
+ "message": {
+ "type": "string"
+ },
+ "standard_version": {
+ "type": "string"
+ },
+ "subsidiary_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"
+ }
+ },
+ "type": "object"
+ },
+ "underlying_agreement_val": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "additional_changes": {
+ "description": "Text of additional changes to include when include_additional_changes is true.",
+ "type": "string"
+ },
+ "attachment_ids": {
+ "description": "UUIDs of attachments to include with the template.",
+ "items": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "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"
+ },
+ "default_signer_email": {
+ "description": "Default email address pre-filled as the signer when creating agreements from this template.",
+ "format": "email",
+ "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "district_or_county": {
+ "description": "The district or county for dispute resolution.",
+ "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": {
+ "type": "string"
+ },
+ "general_cap_amount": {
+ "type": "number"
+ },
+ "general_cap_amount_type": {
+ "type": "string"
+ },
+ "general_cap_period_currency": {
+ "type": "number"
+ },
+ "general_cap_period_qty": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "general_cap_preceding_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "governing_law_country": {
+ "description": "The country whose laws govern agreements created from this template.",
+ "type": "string"
+ },
+ "governing_law_region": {
+ "description": "The state or region whose laws govern agreements created from this template.",
+ "type": "string"
+ },
+ "include_additional_changes": {
+ "description": "Whether to include the additional changes section.",
+ "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": {
+ "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": {
+ "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": {
+ "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": {
+ "type": "string"
+ },
+ "include_terms": {
+ "description": "Whether to include standard terms in the agreement.",
+ "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_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": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "increased_cap_amount_qty": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "increased_cap_amount_type": {
+ "type": "string"
+ },
+ "name": {
+ "description": "A name for the template.",
+ "type": "string"
+ },
+ "negotiations_allowed": {
+ "description": "Whether counterparties can propose changes to agreements created from this template.",
+ "type": "boolean"
+ },
+ "recipient_role": {
+ "description": "The label for the receiving party in the agreement.",
+ "type": "string"
+ },
+ "sender_last_to_sign": {
+ "description": "When true, the sender signs after the recipient.",
+ "type": "boolean"
+ },
+ "sender_role": {
+ "description": "The label for the sending party in the agreement.",
+ "type": "string"
+ },
+ "template_psa_statement_of_work_attributes": {
+ "additionalProperties": false,
+ "description": "Nested PSA statement of work defaults.",
+ "properties": {
+ "additional_changes": {
+ "description": "Text of additional changes to include when include_additional_changes is true.",
+ "type": "string"
+ },
+ "fees_attributes": {
+ "items": {
+ "additionalProperties": false,
+ "properties": {
+ "cost": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "description": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "quantity": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "include_additional_changes": {
+ "description": "Whether to include the additional changes section.",
+ "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": {
+ "type": "string"
+ },
+ "include_deliverables_resubmission_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_deliverables_resubmission_unit": {
+ "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": {
+ "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": {
+ "type": "string"
+ },
+ "invoice_period_description": {
+ "type": "string"
+ },
+ "negotiations_allowed": {
+ "description": "Whether counterparties can propose changes to agreements created from this template.",
+ "type": "boolean"
+ },
+ "payment_period": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "payment_period_other": {
+ "type": "string"
+ },
+ "payment_period_timeframe": {
+ "type": "string"
+ },
+ "payment_period_type": {
+ "type": "string"
+ },
+ "payment_period_unit": {
+ "type": "string"
+ },
+ "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": {
+ "type": "string"
+ },
+ "sow_term_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "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": {
+ "type": "string"
+ },
+ "sow_term_unit": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "template_setting_attributes": {
+ "additionalProperties": false,
+ "description": "Template settings such as standard version and message.",
+ "properties": {
+ "include_message": {
+ "type": "boolean"
+ },
+ "message": {
+ "type": "string"
+ },
+ "standard_version": {
+ "type": "string"
+ },
+ "subsidiary_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"
+ }
+ },
+ "type": "object"
+ },
+ "version": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "additional_changes": {
+ "description": "Text of additional changes to include when include_additional_changes is true.",
+ "type": "string"
+ },
+ "attachment_ids": {
+ "description": "UUIDs of attachments to include with the template.",
+ "items": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "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"
+ },
+ "customer_description": {
+ "type": "string"
+ },
+ "default_signer_email": {
+ "description": "Default email address pre-filled as the signer when creating agreements from this template.",
+ "format": "email",
+ "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "district_or_county": {
+ "description": "The district or county for dispute resolution.",
+ "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": {
+ "type": "string"
+ },
+ "governing_law_country": {
+ "description": "The country whose laws govern agreements created from this template.",
+ "type": "string"
+ },
+ "governing_law_region": {
+ "description": "The state or region whose laws govern agreements created from this template.",
+ "type": "string"
+ },
+ "include_additional_changes": {
+ "description": "Whether to include the additional changes section.",
+ "type": "boolean"
+ },
+ "include_fees": {
+ "type": "boolean"
+ },
+ "include_fees_amount": {
+ "type": "number"
+ },
+ "include_fees_description": {
+ "type": "string"
+ },
+ "include_fees_pay_by_amount": {},
+ "include_fees_type": {
+ "type": "string"
+ },
+ "include_fees_unit": {
+ "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": {
+ "type": "string"
+ },
+ "include_program_participation_feedback": {
+ "type": "boolean"
+ },
+ "include_program_participation_feedback_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_program_participation_feedback_unit": {
+ "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"
+ },
+ "include_terms": {
+ "description": "Whether to include standard terms in the agreement.",
+ "type": "boolean"
+ },
+ "name": {
+ "description": "A name for the template.",
+ "type": "string"
+ },
+ "negotiations_allowed": {
+ "description": "Whether counterparties can propose changes to agreements created from this template.",
+ "type": "boolean"
+ },
+ "product_description": {
+ "type": "string"
+ },
+ "recipient_role": {
+ "description": "The label for the receiving party in the agreement.",
+ "type": "string"
+ },
+ "sender_last_to_sign": {
+ "description": "When true, the sender signs after the recipient.",
+ "type": "boolean"
+ },
+ "sender_role": {
+ "description": "The label for the sending party in the agreement.",
+ "type": "string"
+ },
+ "template_setting_attributes": {
+ "additionalProperties": false,
+ "description": "Template settings such as standard version and message.",
+ "properties": {
+ "include_message": {
+ "type": "boolean"
+ },
+ "message": {
+ "type": "string"
+ },
+ "standard_version": {
+ "type": "string"
+ },
+ "subsidiary_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"
+ }
+ },
+ "type": "object"
+ },
+ "term_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "term_unit": {
+ "type": "string"
+ },
+ "version": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "additional_changes": {
+ "description": "Text of additional changes to include when include_additional_changes is true.",
+ "type": "string"
+ },
+ "attachment_ids": {
+ "description": "UUIDs of attachments to include with the template.",
+ "items": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "billing_workflow_type": {
+ "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"
+ },
+ "default_signer_email": {
+ "description": "Default email address pre-filled as the signer when creating agreements from this template.",
+ "format": "email",
+ "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "district_or_county": {
+ "description": "The district or county for dispute resolution.",
+ "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": {
+ "type": "string"
+ },
+ "general_cap_amount": {
+ "type": "number"
+ },
+ "general_cap_amount_type": {
+ "type": "string"
+ },
+ "general_cap_period_currency": {
+ "type": "number"
+ },
+ "general_cap_period_qty": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "general_cap_preceding_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "governing_law_country": {
+ "description": "The country whose laws govern agreements created from this template.",
+ "type": "string"
+ },
+ "governing_law_region": {
+ "description": "The state or region whose laws govern agreements created from this template.",
+ "type": "string"
+ },
+ "include_additional_changes": {
+ "description": "Whether to include the additional changes section.",
+ "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_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_billing_workflow": {
+ "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_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": {
+ "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_terms": {
+ "description": "Whether to include standard terms in the agreement.",
+ "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": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "increased_cap_amount_qty": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "increased_cap_amount_type": {
+ "type": "string"
+ },
+ "name": {
+ "description": "A name for the template.",
+ "type": "string"
+ },
+ "negotiations_allowed": {
+ "description": "Whether counterparties can propose changes to agreements created from this template.",
+ "type": "boolean"
+ },
+ "payment_link_url": {
+ "type": "string"
+ },
+ "recipient_role": {
+ "description": "The label for the receiving party in the agreement.",
+ "type": "string"
+ },
+ "sender_last_to_sign": {
+ "description": "When true, the sender signs after the recipient.",
+ "type": "boolean"
+ },
+ "sender_role": {
+ "description": "The label for the sending party in the agreement.",
+ "type": "string"
+ },
+ "stripe_invoice_delivery": {
+ "type": "string"
+ },
+ "stripe_payment_link_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"
+ },
+ "stripe_product_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"
+ },
+ "stripe_product_name": {
+ "type": "string"
+ },
+ "stripe_subsequent_bill_method": {
+ "type": "string"
+ },
+ "template_setting_attributes": {
+ "additionalProperties": false,
+ "description": "Template settings such as standard version and message.",
+ "properties": {
+ "include_message": {
+ "type": "boolean"
+ },
+ "message": {
+ "type": "string"
+ },
+ "standard_version": {
+ "type": "string"
+ },
+ "subsidiary_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"
+ }
+ },
+ "type": "object"
+ },
+ "template_software_license_order_form_attributes": {
+ "additionalProperties": false,
+ "description": "Nested software license order form defaults.",
+ "properties": {
+ "additional_changes": {
+ "description": "Text of additional changes to include when include_additional_changes is true.",
+ "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": {
+ "type": "string"
+ },
+ "fees_attributes": {
+ "items": {
+ "additionalProperties": false,
+ "properties": {
+ "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"
+ },
+ "cost": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "description": {
+ "type": "string"
+ },
+ "discount_duration_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "discount_duration_type": {
+ "type": "string"
+ },
+ "discount_type": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "graduated_fee_tiers_attributes": {
+ "items": {
+ "additionalProperties": false,
+ "properties": {
+ "flat_price": {
+ "type": "string"
+ },
+ "price_per_unit": {
+ "type": "string"
+ },
+ "upper_limit": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "quantity": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "stripe_product_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"
+ },
+ "type": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "fees_currency": {
+ "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": {
+ "type": "string"
+ },
+ "fees_inclusive_of_taxes": {
+ "type": "boolean"
+ },
+ "include_additional_changes": {
+ "description": "Whether to include the additional changes section.",
+ "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": {
+ "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": "Whether counterparties can propose changes to agreements created from this template.",
+ "type": "boolean"
+ },
+ "order_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"
+ },
+ "order_date_type": {
+ "type": "string"
+ },
+ "payment_process_automatic_frequency": {
+ "type": "string"
+ },
+ "payment_process_type": {
+ "type": "string"
+ },
+ "payment_process_type_custom_val": {
+ "type": "string"
+ },
+ "payment_process_type_invoice_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "payment_process_type_invoice_custom_unit": {
+ "type": "string"
+ },
+ "payment_process_type_invoice_duration": {
+ "type": "string"
+ },
+ "payment_process_type_invoice_duration_start": {
+ "type": "string"
+ },
+ "payment_process_type_invoice_type": {
+ "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": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "software_description": {
+ "type": "string"
+ },
+ "subscription_auto_renew": {
+ "type": "string"
+ },
+ "subscription_period": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "subscription_period_unit": {
+ "type": "string"
+ },
+ "subscription_renewal_notice_days": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "warranty_period_description_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "warranty_period_description_duration": {
+ "type": "string"
+ },
+ "warranty_period_description_duration_start": {
+ "type": "string"
+ },
+ "warranty_period_type": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "additional_changes": {
+ "description": "Text of additional changes to include when include_additional_changes is true.",
+ "type": "string"
+ },
+ "additional_terms": {
+ "type": "string"
+ },
+ "attachment_ids": {
+ "description": "UUIDs of attachments to include with the template.",
+ "items": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "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"
+ },
+ "default_signer_email": {
+ "description": "Default email address pre-filled as the signer when creating agreements from this template.",
+ "format": "email",
+ "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "district_or_county": {
+ "description": "The district or county for dispute resolution.",
+ "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": {
+ "type": "string"
+ },
+ "fees_type": {
+ "type": "string"
+ },
+ "general_cap_amount": {
+ "type": "number"
+ },
+ "general_cap_amount_type": {
+ "type": "string"
+ },
+ "general_cap_period_currency": {
+ "type": "number"
+ },
+ "general_cap_period_qty": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "general_cap_preceding_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "governing_law_country": {
+ "description": "The country whose laws govern agreements created from this template.",
+ "type": "string"
+ },
+ "governing_law_region": {
+ "description": "The state or region whose laws govern agreements created from this template.",
+ "type": "string"
+ },
+ "include_additional_changes": {
+ "description": "Whether to include the additional changes section.",
+ "type": "boolean"
+ },
+ "include_additional_terms": {
+ "type": "boolean"
+ },
+ "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": {
+ "type": "string"
+ },
+ "include_payment_process": {
+ "type": "boolean"
+ },
+ "include_technical_support": {
+ "type": "boolean"
+ },
+ "include_terms": {
+ "description": "Whether to include standard terms in the agreement.",
+ "type": "boolean"
+ },
+ "name": {
+ "description": "A name for the template.",
+ "type": "string"
+ },
+ "negotiations_allowed": {
+ "description": "Whether counterparties can propose changes to agreements created from this template.",
+ "type": "boolean"
+ },
+ "payment_process_automatic_frequency": {
+ "type": "string"
+ },
+ "payment_process_invoice_days": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "payment_process_invoice_from": {
+ "type": "string"
+ },
+ "payment_process_invoice_timeframe": {
+ "type": "string"
+ },
+ "payment_process_type": {
+ "type": "string"
+ },
+ "pilot_period_description": {
+ "type": "string"
+ },
+ "pilot_period_fees_description": {
+ "type": "string"
+ },
+ "product_description": {
+ "type": "string"
+ },
+ "recipient_role": {
+ "description": "The label for the receiving party in the agreement.",
+ "type": "string"
+ },
+ "sender_last_to_sign": {
+ "description": "When true, the sender signs after the recipient.",
+ "type": "boolean"
+ },
+ "sender_role": {
+ "description": "The label for the sending party in the agreement.",
+ "type": "string"
+ },
+ "technical_support_description": {
+ "type": "string"
+ },
+ "template_setting_attributes": {
+ "additionalProperties": false,
+ "description": "Template settings such as standard version and message.",
+ "properties": {
+ "include_message": {
+ "type": "boolean"
+ },
+ "message": {
+ "type": "string"
+ },
+ "standard_version": {
+ "type": "string"
+ },
+ "subsidiary_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"
+ }
+ },
+ "type": "object"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "additional_changes": {
+ "description": "Text of additional changes to include when include_additional_changes is true.",
+ "type": "string"
+ },
+ "attachment_ids": {
+ "description": "UUIDs of attachments to include with the template.",
+ "items": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "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"
+ },
+ "default_signer_email": {
+ "description": "Default email address pre-filled as the signer when creating agreements from this template.",
+ "format": "email",
+ "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "district_or_county": {
+ "description": "The district or county for dispute resolution.",
+ "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": {
+ "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": {
+ "type": "string"
+ },
+ "governing_law_country": {
+ "description": "The country whose laws govern agreements created from this template.",
+ "type": "string"
+ },
+ "governing_law_region": {
+ "description": "The state or region whose laws govern agreements created from this template.",
+ "type": "string"
+ },
+ "include_additional_changes": {
+ "description": "Whether to include the additional changes section.",
+ "type": "boolean"
+ },
+ "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": {
+ "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": {},
+ "include_increased_cap_amount_multiple": {},
+ "include_increased_cap_amount_type": {
+ "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_terms": {
+ "description": "Whether to include standard terms in the agreement.",
+ "type": "boolean"
+ },
+ "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"
+ },
+ "name": {
+ "description": "A name for the template.",
+ "type": "string"
+ },
+ "negotiations_allowed": {
+ "description": "Whether counterparties can propose changes to agreements created from this template.",
+ "type": "boolean"
+ },
+ "recipient_role": {
+ "description": "The label for the receiving party in the agreement.",
+ "type": "string"
+ },
+ "sender_last_to_sign": {
+ "description": "When true, the sender signs after the recipient.",
+ "type": "boolean"
+ },
+ "sender_role": {
+ "description": "The label for the sending party in the agreement.",
+ "type": "string"
+ },
+ "template_partnership_business_terms_attributes": {
+ "additionalProperties": false,
+ "description": "Nested partnership business terms defaults.",
+ "properties": {
+ "end_date_after_effective_date_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "end_date_after_effective_date_unit": {
+ "type": "string"
+ },
+ "end_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"
+ },
+ "end_date_type": {
+ "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": {
+ "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": {
+ "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": {
+ "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": {
+ "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": {
+ "format": "email",
+ "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "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": {
+ "format": "email",
+ "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "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": {
+ "type": "string"
+ },
+ "include_payment_schedule_specified_unit": {
+ "type": "string"
+ },
+ "include_payment_schedule_type": {
+ "type": "string"
+ },
+ "negotiations_allowed": {
+ "description": "Whether counterparties can propose changes to agreements created from this template.",
+ "type": "boolean"
+ },
+ "territory_type": {
+ "type": "string"
+ },
+ "territory_type_val": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "template_setting_attributes": {
+ "additionalProperties": false,
+ "description": "Template settings such as standard version and message.",
+ "properties": {
+ "include_message": {
+ "type": "boolean"
+ },
+ "message": {
+ "type": "string"
+ },
+ "standard_version": {
+ "type": "string"
+ },
+ "subsidiary_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"
+ }
+ },
+ "type": "object"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "additional_changes": {
+ "description": "Text of additional changes to include when include_additional_changes is true.",
+ "type": "string"
+ },
+ "aggregation_limitations_permitted": {
+ "type": "boolean"
+ },
+ "aggregation_limitations_permitted_val": {
+ "type": "string"
+ },
+ "attachment_ids": {
+ "description": "UUIDs of attachments to include with the template.",
+ "items": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "breach_notification_unit": {
+ "type": "string"
+ },
+ "breach_notification_val": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "business_associate_relationship_type": {
+ "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"
+ },
+ "default_signer_email": {
+ "description": "Default email address pre-filled as the signer when creating agreements from this template.",
+ "format": "email",
+ "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "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"
+ },
+ "district_or_county": {
+ "description": "The district or county for dispute resolution.",
+ "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": {
+ "type": "string"
+ },
+ "governing_law_country": {
+ "description": "The country whose laws govern agreements created from this template.",
+ "type": "string"
+ },
+ "governing_law_region": {
+ "description": "The state or region whose laws govern agreements created from this template.",
+ "type": "string"
+ },
+ "include_additional_changes": {
+ "description": "Whether to include the additional changes section.",
+ "type": "boolean"
+ },
+ "include_aggregation_limitations": {
+ "type": "boolean"
+ },
+ "include_deidentification_limitations": {
+ "type": "boolean"
+ },
+ "include_limitations": {
+ "type": "boolean"
+ },
+ "include_offshore_limitations": {
+ "type": "boolean"
+ },
+ "include_subcontract_limitations": {
+ "type": "boolean"
+ },
+ "include_terms": {
+ "description": "Whether to include standard terms in the agreement.",
+ "type": "boolean"
+ },
+ "name": {
+ "description": "A name for the template.",
+ "type": "string"
+ },
+ "negotiations_allowed": {
+ "description": "Whether counterparties can propose changes to agreements created from this template.",
+ "type": "boolean"
+ },
+ "offshore_limitations_permitted": {
+ "type": "boolean"
+ },
+ "offshore_limitations_permitted_val": {
+ "type": "string"
+ },
+ "recipient_role": {
+ "description": "The label for the receiving party in the agreement.",
+ "type": "string"
+ },
+ "sender_last_to_sign": {
+ "description": "When true, the sender signs after the recipient.",
+ "type": "boolean"
+ },
+ "sender_role": {
+ "description": "The label for the sending party in the agreement.",
+ "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"
+ },
+ "template_setting_attributes": {
+ "additionalProperties": false,
+ "description": "Template settings such as standard version and message.",
+ "properties": {
+ "include_message": {
+ "type": "boolean"
+ },
+ "message": {
+ "type": "string"
+ },
+ "standard_version": {
+ "type": "string"
+ },
+ "subsidiary_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"
+ }
+ },
+ "type": "object"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "additional_changes": {
+ "description": "Text of additional changes to include when include_additional_changes is true.",
+ "type": "string"
+ },
+ "attachment_ids": {
+ "description": "UUIDs of attachments to include with the template.",
+ "items": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "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"
+ },
+ "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": {
+ "type": "string"
+ },
+ "confidentiality_type": {
+ "type": "string"
+ },
+ "default_signer_email": {
+ "description": "Default email address pre-filled as the signer when creating agreements from this template.",
+ "format": "email",
+ "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "district_or_county": {
+ "description": "The district or county for dispute resolution.",
+ "type": "string"
+ },
+ "governing_law_country": {
+ "description": "The country whose laws govern agreements created from this template.",
+ "type": "string"
+ },
+ "governing_law_region": {
+ "description": "The state or region whose laws govern agreements created from this template.",
+ "type": "string"
+ },
+ "include_additional_changes": {
+ "description": "Whether to include the additional changes section.",
+ "type": "boolean"
+ },
+ "include_custom_details": {
+ "type": "boolean"
+ },
+ "include_custom_details_val": {
+ "type": "string"
+ },
+ "include_fees": {
+ "type": "boolean"
+ },
+ "include_fees_amount": {
+ "type": "number"
+ },
+ "include_fees_amount_duration": {
+ "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": {
+ "type": "string"
+ },
+ "include_terms": {
+ "description": "Whether to include standard terms in the agreement.",
+ "type": "boolean"
+ },
+ "name": {
+ "description": "A name for the template.",
+ "type": "string"
+ },
+ "negotiations_allowed": {
+ "description": "Whether counterparties can propose changes to agreements created from this template.",
+ "type": "boolean"
+ },
+ "product_name": {
+ "type": "string"
+ },
+ "recipient_role": {
+ "description": "The label for the receiving party in the agreement.",
+ "type": "string"
+ },
+ "sender_last_to_sign": {
+ "description": "When true, the sender signs after the recipient.",
+ "type": "boolean"
+ },
+ "sender_role": {
+ "description": "The label for the sending party in the agreement.",
+ "type": "string"
+ },
+ "template_setting_attributes": {
+ "additionalProperties": false,
+ "description": "Template settings such as standard version and message.",
+ "properties": {
+ "include_message": {
+ "type": "boolean"
+ },
+ "message": {
+ "type": "string"
+ },
+ "standard_version": {
+ "type": "string"
+ },
+ "subsidiary_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"
+ }
+ },
+ "type": "object"
+ }
+ },
+ "type": "object"
+ }
+]create-template1 field changedInput schema / properties / body / anyOfPrevious value: -[
- {
- "additionalProperties": false,
- "properties": {
- "additional_changes": {
- "description": "Text of additional changes to include when include_additional_changes is true.",
- "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"
- },
- "confidentiality_period": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "confidentiality_period_perpetual": {
- "type": "boolean"
- },
- "default_signer_email": {
- "description": "Default email address pre-filled as the signer when creating agreements from this template.",
- "format": "email",
- "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
- "type": "string"
- },
- "district_or_county": {
- "description": "The district or county for dispute resolution.",
- "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_of_confidentiality": {
- "type": "string"
- },
- "effective_date_type": {
- "type": "string"
- },
- "governing_law_country": {
- "description": "The country whose laws govern agreements created from this template.",
- "type": "string"
- },
- "governing_law_region": {
- "description": "The state or region whose laws govern agreements created from this template.",
- "type": "string"
- },
- "include_additional_changes": {
- "description": "Whether to include the additional changes section.",
- "type": "boolean"
- },
- "include_terms": {
- "description": "Whether to include standard terms in the agreement.",
- "type": "boolean"
- },
- "name": {
- "description": "A name for the template.",
- "type": "string"
- },
- "negotiations_allowed": {
- "description": "Whether counterparties can propose changes to agreements created from this template.",
- "type": "boolean"
- },
- "purpose": {
- "type": "string"
- },
- "recipient_role": {
- "description": "The label for the receiving party in the agreement.",
- "type": "string"
- },
- "sender_last_to_sign": {
- "description": "When true, the sender signs after the recipient.",
- "type": "boolean"
- },
- "sender_role": {
- "description": "The label for the sending party in the agreement.",
- "type": "string"
- },
- "template_setting_attributes": {
- "additionalProperties": false,
- "description": "Template settings such as standard version and message.",
- "properties": {
- "include_message": {
- "type": "boolean"
- },
- "message": {
- "type": "string"
- },
- "standard_version": {
- "type": "string"
- },
- "subsidiary_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"
- }
- },
- "type": "object"
- },
- "term": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "term_period_perpetual": {
- "type": "boolean"
- },
- "type": {
- "description": "Optional. When omitted, the template defaults to NDA.",
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "additional_changes": {
- "description": "Text of additional changes to include when include_additional_changes is true.",
- "type": "string"
- },
- "attachment_ids": {
- "description": "UUIDs of attachments to include with the template.",
- "items": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "type": "array"
- },
- "billing_workflow_type": {
- "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"
- },
- "customer_description": {
- "type": "string"
- },
- "default_signer_email": {
- "description": "Default email address pre-filled as the signer when creating agreements from this template.",
- "format": "email",
- "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
- "type": "string"
- },
- "district_or_county": {
- "description": "The district or county for dispute resolution.",
- "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": {
- "type": "string"
- },
- "effective_date_type": {
- "type": "string"
- },
- "general_cap_amount": {
- "type": "number"
- },
- "general_cap_amount_type": {
- "type": "string"
- },
- "general_cap_period_currency": {
- "type": "number"
- },
- "general_cap_period_qty": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "general_cap_preceding_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "governing_law_country": {
- "description": "The country whose laws govern agreements created from this template.",
- "type": "string"
- },
- "governing_law_region": {
- "description": "The state or region whose laws govern agreements created from this template.",
- "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": "boolean"
- },
- "include_acceptable_use_policy_type": {
- "type": "string"
- },
- "include_additional_changes": {
- "description": "Whether to include the additional changes section.",
- "type": "boolean"
- },
- "include_additional_warranties": {
- "type": "boolean"
- },
- "include_additional_warranties_by_customer": {
- "type": "boolean"
- },
- "include_additional_warranties_by_provider": {
- "type": "boolean"
- },
- "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_billing_workflow": {
- "type": "boolean"
- },
- "include_covered_claims": {
- "type": "boolean"
- },
- "include_covered_claims_customer_claims": {
- "type": "boolean"
- },
- "include_covered_claims_include_customer_claims": {
- "type": "boolean"
- },
- "include_covered_claims_include_provider_claims": {
- "type": "boolean"
- },
- "include_covered_claims_provider_claims": {
- "type": "boolean"
- },
- "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": "boolean"
- },
- "include_dpa_type": {
- "type": "string"
- },
- "include_increased_cap_amount": {
- "type": "number"
- },
- "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": "boolean"
- },
- "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": "boolean"
- },
- "include_insurance_minimums_cyber_liability_aggregate": {
- "type": "boolean"
- },
- "include_insurance_minimums_cyber_liability_minimum": {
- "type": "boolean"
- },
- "include_insurance_minimums_employer_liability_aggregate": {
- "type": "boolean"
- },
- "include_insurance_minimums_employer_liability_minimum": {
- "type": "boolean"
- },
- "include_insurance_minimums_general_liability_aggregate": {
- "type": "boolean"
- },
- "include_insurance_minimums_general_liability_minimum": {
- "type": "boolean"
- },
- "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": {
- "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": "boolean"
- },
- "include_security_policy_other": {
- "type": "boolean"
- },
- "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": {
- "type": "string"
- },
- "include_terms": {
- "description": "Whether to include standard terms in the agreement.",
- "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": "boolean"
- },
- "increased_cap_amount_currency": {
- "type": "number"
- },
- "increased_cap_amount_period_currency": {
- "type": "number"
- },
- "increased_cap_amount_period_qty": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "increased_cap_amount_qty": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "increased_cap_amount_type": {
- "type": "string"
- },
- "name": {
- "description": "A name for the template.",
- "type": "string"
- },
- "negotiations_allowed": {
- "description": "Whether counterparties can propose changes to agreements created from this template.",
- "type": "boolean"
- },
- "payment_link_url": {
- "type": "string"
- },
- "provider": {
- "type": "string"
- },
- "recipient_role": {
- "description": "The label for the receiving party in the agreement.",
- "type": "string"
- },
- "sender_last_to_sign": {
- "description": "When true, the sender signs after the recipient.",
- "type": "boolean"
- },
- "sender_role": {
- "description": "The label for the sending party in the agreement.",
- "type": "string"
- },
- "stripe_invoice_delivery": {
- "type": "string"
- },
- "stripe_payment_link_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"
- },
- "stripe_product_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"
- },
- "stripe_product_name": {
- "type": "string"
- },
- "stripe_subsequent_bill_method": {
- "type": "string"
- },
- "template_csa_order_form_attributes": {
- "additionalProperties": false,
- "description": "Nested CSA order form defaults. See Template Parameters docs for CSA Order Form.",
- "properties": {
- "additional_changes": {
- "description": "Text of additional changes to include when include_additional_changes is true.",
- "type": "string"
- },
- "additional_parameters_or_limitations": {
- "type": "string"
- },
- "affiliates_as_users": {
- "type": "string"
- },
- "cloud_service_description": {
- "type": "string"
- },
- "consumption_units": {
- "type": "string"
- },
- "fee_amount": {
- "type": "number"
- },
- "fee_custom_unit": {
- "type": "string"
- },
- "fee_period": {
- "type": "string"
- },
- "fees_attributes": {
- "items": {
- "additionalProperties": false,
- "properties": {
- "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"
- },
- "cost": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "description": {
- "type": "string"
- },
- "discount_duration_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "discount_duration_type": {
- "type": "string"
- },
- "discount_type": {
- "type": "string"
- },
- "fee_type": {
- "type": "string"
- },
- "graduated_fee_tiers_attributes": {
- "items": {
- "additionalProperties": false,
- "properties": {
- "flat_price": {
- "type": "string"
- },
- "price_per_unit": {
- "type": "string"
- },
- "upper_limit": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- }
- },
- "type": "object"
- },
- "type": "array"
- },
- "quantity": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "stripe_product_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"
- },
- "type": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "type": "array"
- },
- "fees_currency": {
- "type": "number"
- },
- "fees_include_fee_increase_upon_renewal": {
- "type": "boolean"
- },
- "fees_include_fee_increase_upon_renewal_fee": {
- "type": "number"
- },
- "fees_include_fee_increase_upon_renewal_type": {
- "type": "string"
- },
- "fees_inclusive_of_taxes": {
- "type": "string"
- },
- "free_trial_days": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_additional_changes": {
- "description": "Whether to include the additional changes section.",
- "type": "boolean"
- },
- "include_additional_parameters_or_limitations": {
- "type": "boolean"
- },
- "include_billing_info": {
- "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": "number"
- },
- "include_fees_table": {
- "type": "boolean"
- },
- "include_fees_table_period": {
- "type": "boolean"
- },
- "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": {
- "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": {
- "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": "boolean"
- },
- "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": "string"
- },
- "include_professional_services_include_fees_description": {
- "type": "string"
- },
- "include_professional_services_type": {
- "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": "string"
- },
- "include_sla_include_response_time_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_sla_include_response_time_credit": {
- "type": "string"
- },
- "include_sla_include_response_time_duration": {
- "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": {
- "type": "string"
- },
- "include_sla_standard_maintenance_notice_qty": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_sla_standard_maintenance_notice_unit": {
- "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": "boolean"
- },
- "include_sla_standard_maintenance_window_tuesday": {
- "type": "boolean"
- },
- "include_sla_standard_maintenance_window_wednesday": {
- "type": "boolean"
- },
- "include_sla_standard_target_uptime": {
- "type": "boolean"
- },
- "include_sla_type": {
- "type": "string"
- },
- "include_subscription_start_date": {
- "type": "string"
- },
- "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": "number"
- },
- "include_use_limitations": {
- "type": "boolean"
- },
- "include_use_limitations_val": {
- "type": "number"
- },
- "invoice_period": {
- "type": "string"
- },
- "invoice_period_custom_unit": {
- "type": "string"
- },
- "max_consumption": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "max_users": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "negotiations_allowed": {
- "description": "Whether counterparties can propose changes to agreements created from this template.",
- "type": "boolean"
- },
- "order_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"
- },
- "order_date_other": {
- "type": "string"
- },
- "order_date_type": {
- "type": "string"
- },
- "payment_period": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "payment_period_timeframe": {
- "type": "string"
- },
- "payment_period_unit": {
- "type": "string"
- },
- "payment_process_automatic_frequency": {
- "type": "string"
- },
- "payment_process_type": {
- "type": "string"
- },
- "payment_process_type_custom_val": {
- "type": "number"
- },
- "payment_process_type_invoice_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "payment_process_type_invoice_custom_unit": {
- "type": "string"
- },
- "payment_process_type_invoice_duration": {
- "type": "string"
- },
- "payment_process_type_invoice_duration_start": {
- "type": "string"
- },
- "payment_process_type_invoice_type": {
- "type": "string"
- },
- "pilot_period_stripe_product_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"
- },
- "service_credits_attributes": {
- "items": {
- "additionalProperties": false,
- "properties": {
- "credit": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "max": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "min": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- }
- },
- "type": "object"
- },
- "type": "array"
- },
- "subscription_auto_renew": {
- "type": "string"
- },
- "subscription_period": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "subscription_period_unit": {
- "type": "string"
- },
- "subscription_renewal_notice_days": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "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": {
- "type": "string"
- },
- "use_limitations_attributes": {
- "items": {
- "additionalProperties": false,
- "properties": {
- "amount": {
- "type": "string"
- },
- "limitation_type": {
- "type": "string"
- },
- "unit": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "type": "array"
- }
- },
- "type": "object"
- },
- "template_setting_attributes": {
- "additionalProperties": false,
- "description": "Template settings such as standard version and message.",
- "properties": {
- "include_message": {
- "type": "boolean"
- },
- "message": {
- "type": "string"
- },
- "standard_version": {
- "type": "string"
- },
- "subsidiary_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"
- }
- },
- "type": "object"
- },
- "type": {
- "description": "The type of template to create.",
- "type": "string"
- }
- },
- "required": [
- "type"
- ],
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "additional_changes": {
- "description": "Text of additional changes to include when include_additional_changes is true.",
- "type": "string"
- },
- "approved_subprocessor_type": {
- "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"
- },
- "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": {
- "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"
- },
- "default_signer_email": {
- "description": "Default email address pre-filled as the signer when creating agreements from this template.",
- "format": "email",
- "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
- "type": "string"
- },
- "district_or_county": {
- "description": "The district or county for dispute resolution.",
- "type": "string"
- },
- "duration_of_processing": {
- "type": "string"
- },
- "governing_law_country": {
- "description": "The country whose laws govern agreements created from this template.",
- "type": "string"
- },
- "governing_law_region": {
- "description": "The state or region whose laws govern agreements created from this template.",
- "type": "string"
- },
- "include_additional_changes": {
- "description": "Whether to include the additional changes section.",
- "type": "boolean"
- },
- "include_covered_claim": {
- "type": "boolean"
- },
- "include_covered_claim_external_val": {
- "type": "number"
- },
- "include_covered_claim_internal_val": {
- "type": "number"
- },
- "include_covered_claim_type": {
- "type": "string"
- },
- "include_data_subjects_custom": {
- "type": "string"
- },
- "include_data_subjects_custom_val": {
- "type": "number"
- },
- "include_data_subjects_employees": {
- "type": "boolean"
- },
- "include_data_subjects_end_users": {
- "type": "boolean"
- },
- "include_external_subprocessor_location": {
- "type": "boolean"
- },
- "include_frequency_of_transfer_continuous": {
- "type": "boolean"
- },
- "include_frequency_of_transfer_custom": {
- "type": "string"
- },
- "include_frequency_of_transfer_custom_val": {
- "type": "number"
- },
- "include_governing_country_eu": {
- "type": "boolean"
- },
- "include_governing_country_eu_val": {
- "type": "number"
- },
- "include_governing_country_uk": {
- "type": "boolean"
- },
- "include_governing_country_uk_val": {
- "type": "number"
- },
- "include_governing_law": {
- "type": "boolean"
- },
- "include_governing_law_country": {
- "type": "boolean"
- },
- "include_governing_law_state": {
- "type": "boolean"
- },
- "include_increased_claim_amount": {
- "type": "number"
- },
- "include_increased_claim_amount_currency": {
- "type": "boolean"
- },
- "include_increased_claim_amount_qty": {
- "type": "number"
- },
- "include_increased_claim_amount_type": {
- "type": "string"
- },
- "include_liability_cap": {
- "type": "boolean"
- },
- "include_liability_cap_amount_constant_external": {
- "type": "boolean"
- },
- "include_liability_cap_amount_constant_internal": {
- "type": "boolean"
- },
- "include_liability_cap_amount_currency_external": {
- "type": "boolean"
- },
- "include_liability_cap_amount_currency_internal": {
- "type": "boolean"
- },
- "include_liability_cap_csa_type": {
- "type": "string"
- },
- "include_personal_data_biographic_info": {
- "type": "boolean"
- },
- "include_personal_data_contact_info": {
- "type": "boolean"
- },
- "include_personal_data_custom": {
- "type": "string"
- },
- "include_personal_data_custom_val": {
- "type": "number"
- },
- "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": "string"
- },
- "include_processing_purpose_custom_val": {
- "type": "number"
- },
- "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": "boolean"
- },
- "include_provider_security_contact_address_country": {
- "type": "boolean"
- },
- "include_provider_security_contact_address_state": {
- "type": "boolean"
- },
- "include_provider_security_contact_address_street_address": {
- "type": "boolean"
- },
- "include_provider_security_contact_address_zipcode": {
- "type": "boolean"
- },
- "include_provider_security_contact_email": {
- "format": "email",
- "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
- "type": "string"
- },
- "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-z]{2,}$",
- "type": "string"
- },
- "include_security_measures_accountability": {
- "type": "boolean"
- },
- "include_security_measures_accountability_val": {
- "type": "number"
- },
- "include_security_measures_certification_or_assurance": {
- "type": "boolean"
- },
- "include_security_measures_certification_or_assurance_val": {
- "type": "number"
- },
- "include_security_measures_confidentiality_integrity": {
- "type": "boolean"
- },
- "include_security_measures_confidentiality_integrity_val": {
- "type": "number"
- },
- "include_security_measures_data_at_rest": {
- "type": "boolean"
- },
- "include_security_measures_data_at_rest_val": {
- "type": "number"
- },
- "include_security_measures_data_minimization": {
- "type": "boolean"
- },
- "include_security_measures_data_minimization_val": {
- "type": "number"
- },
- "include_security_measures_data_quality": {
- "type": "boolean"
- },
- "include_security_measures_data_quality_val": {
- "type": "number"
- },
- "include_security_measures_data_retention": {
- "type": "boolean"
- },
- "include_security_measures_data_retention_val": {
- "type": "number"
- },
- "include_security_measures_data_transmission": {
- "type": "boolean"
- },
- "include_security_measures_data_transmission_val": {
- "type": "number"
- },
- "include_security_measures_event_logging": {
- "type": "boolean"
- },
- "include_security_measures_event_logging_val": {
- "type": "number"
- },
- "include_security_measures_identity_auth": {
- "type": "boolean"
- },
- "include_security_measures_identity_auth_val": {
- "type": "number"
- },
- "include_security_measures_it_security_governance": {
- "type": "boolean"
- },
- "include_security_measures_it_security_governance_val": {
- "type": "number"
- },
- "include_security_measures_physical_security": {
- "type": "boolean"
- },
- "include_security_measures_physical_security_val": {
- "type": "number"
- },
- "include_security_measures_portability_and_erasure": {
- "type": "boolean"
- },
- "include_security_measures_portability_and_erasure_val": {
- "type": "number"
- },
- "include_security_measures_pseudonym_encryption": {
- "type": "boolean"
- },
- "include_security_measures_pseudonym_encryption_val": {
- "type": "number"
- },
- "include_security_measures_restore_data_access": {
- "type": "boolean"
- },
- "include_security_measures_restore_data_access_val": {
- "type": "number"
- },
- "include_security_measures_security_policy": {
- "type": "boolean"
- },
- "include_security_measures_system_configuration": {
- "type": "boolean"
- },
- "include_security_measures_system_configuration_val": {
- "type": "number"
- },
- "include_security_measures_testing_assessment": {
- "type": "boolean"
- },
- "include_security_measures_testing_assessment_val": {
- "type": "number"
- },
- "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": "boolean"
- },
- "include_security_policy_pci1": {
- "type": "boolean"
- },
- "include_security_policy_pci2": {
- "type": "boolean"
- },
- "include_security_policy_penetration_testing": {
- "type": "boolean"
- },
- "include_security_policy_provider": {
- "type": "boolean"
- },
- "include_security_policy_soc2": {
- "type": "boolean"
- },
- "include_security_policy_soc2_type2": {
- "type": "boolean"
- },
- "include_sensitive_data_restrictions_custom": {
- "type": "string"
- },
- "include_sensitive_data_restrictions_custom_val": {
- "type": "number"
- },
- "include_sensitive_data_restrictions_security_policy": {
- "type": "boolean"
- },
- "include_service_provider_relationship": {
- "type": "boolean"
- },
- "include_special_category_data": {
- "type": "boolean"
- },
- "include_terms": {
- "description": "Whether to include standard terms in the agreement.",
- "type": "boolean"
- },
- "name": {
- "description": "A name for the template.",
- "type": "string"
- },
- "negotiations_allowed": {
- "description": "Whether counterparties can propose changes to agreements created from this template.",
- "type": "boolean"
- },
- "provider": {
- "type": "string"
- },
- "recipient_role": {
- "description": "The label for the receiving party in the agreement.",
- "type": "string"
- },
- "security_policy_available_at": {
- "type": "string"
- },
- "security_policy_type": {
- "type": "string"
- },
- "sender_last_to_sign": {
- "description": "When true, the sender signs after the recipient.",
- "type": "boolean"
- },
- "sender_role": {
- "description": "The label for the sending party in the agreement.",
- "type": "string"
- },
- "subprocessors_attributes": {
- "description": "List of subprocessors. Each item may include name, country, and processing_task.",
- "items": {
- "additionalProperties": false,
- "properties": {
- "country": {
- "type": "string"
- },
- "name": {
- "description": "A name for the template.",
- "type": "string"
- },
- "processing_task": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "type": "array"
- },
- "template_setting_attributes": {
- "additionalProperties": false,
- "description": "Template settings such as standard version and message.",
- "properties": {
- "include_message": {
- "type": "boolean"
- },
- "message": {
- "type": "string"
- },
- "standard_version": {
- "type": "string"
- },
- "subsidiary_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"
- }
- },
- "type": "object"
- },
- "type": {
- "description": "The type of template to create.",
- "type": "string"
- },
- "underlying_agreement_val": {
- "type": "number"
- }
- },
- "required": [
- "type"
- ],
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "additional_changes": {
- "description": "Text of additional changes to include when include_additional_changes is true.",
- "type": "string"
- },
- "attachment_ids": {
- "description": "UUIDs of attachments to include with the template.",
- "items": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "type": "array"
- },
- "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"
- },
- "default_signer_email": {
- "description": "Default email address pre-filled as the signer when creating agreements from this template.",
- "format": "email",
- "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
- "type": "string"
- },
- "district_or_county": {
- "description": "The district or county for dispute resolution.",
- "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": {
- "type": "string"
- },
- "general_cap_amount": {
- "type": "number"
- },
- "general_cap_amount_type": {
- "type": "string"
- },
- "general_cap_period_currency": {
- "type": "number"
- },
- "general_cap_period_qty": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "general_cap_preceding_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "governing_law_country": {
- "description": "The country whose laws govern agreements created from this template.",
- "type": "string"
- },
- "governing_law_region": {
- "description": "The state or region whose laws govern agreements created from this template.",
- "type": "string"
- },
- "include_additional_changes": {
- "description": "Whether to include the additional changes section.",
- "type": "boolean"
- },
- "include_additional_warranties": {
- "type": "boolean"
- },
- "include_additional_warranties_by_customer": {
- "type": "boolean"
- },
- "include_additional_warranties_by_provider": {
- "type": "boolean"
- },
- "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": "boolean"
- },
- "include_covered_claims_include_customer_claims": {
- "type": "boolean"
- },
- "include_covered_claims_include_provider_claims": {
- "type": "boolean"
- },
- "include_covered_claims_provider_claims": {
- "type": "boolean"
- },
- "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": "boolean"
- },
- "include_customer_insurance_min_auto_liability_minimum": {
- "type": "boolean"
- },
- "include_customer_insurance_min_cyber_liability_aggregate": {
- "type": "boolean"
- },
- "include_customer_insurance_min_cyber_liability_minimum": {
- "type": "boolean"
- },
- "include_customer_insurance_min_employer_liability_aggregate": {
- "type": "boolean"
- },
- "include_customer_insurance_min_employer_liability_minimum": {
- "type": "boolean"
- },
- "include_customer_insurance_min_general_liability_aggregate": {
- "type": "boolean"
- },
- "include_customer_insurance_min_general_liability_minimum": {
- "type": "boolean"
- },
- "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": "boolean"
- },
- "include_customer_policies_type": {
- "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": "boolean"
- },
- "include_dpa_type": {
- "type": "string"
- },
- "include_increased_cap_amount": {
- "type": "number"
- },
- "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": "boolean"
- },
- "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": "boolean"
- },
- "include_provider_insurance_min_auto_liability_minimum": {
- "type": "boolean"
- },
- "include_provider_insurance_min_cyber_liability_aggregate": {
- "type": "boolean"
- },
- "include_provider_insurance_min_cyber_liability_minimum": {
- "type": "boolean"
- },
- "include_provider_insurance_min_employer_liability_aggregate": {
- "type": "boolean"
- },
- "include_provider_insurance_min_employer_liability_minimum": {
- "type": "boolean"
- },
- "include_provider_insurance_min_general_liability_aggregate": {
- "type": "boolean"
- },
- "include_provider_insurance_min_general_liability_minimum": {
- "type": "boolean"
- },
- "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": {
- "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": "number"
- },
- "include_security_policy_iso27001": {
- "type": "boolean"
- },
- "include_security_policy_location": {
- "type": "boolean"
- },
- "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": {
- "type": "string"
- },
- "include_terms": {
- "description": "Whether to include standard terms in the agreement.",
- "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_negligence": {
- "type": "boolean"
- },
- "include_unlimited_claims_other": {
- "type": "boolean"
- },
- "increased_cap_amount_currency": {
- "type": "number"
- },
- "increased_cap_amount_period_currency": {
- "type": "number"
- },
- "increased_cap_amount_period_qty": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "increased_cap_amount_qty": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "increased_cap_amount_type": {
- "type": "string"
- },
- "name": {
- "description": "A name for the template.",
- "type": "string"
- },
- "negotiations_allowed": {
- "description": "Whether counterparties can propose changes to agreements created from this template.",
- "type": "boolean"
- },
- "recipient_role": {
- "description": "The label for the receiving party in the agreement.",
- "type": "string"
- },
- "sender_last_to_sign": {
- "description": "When true, the sender signs after the recipient.",
- "type": "boolean"
- },
- "sender_role": {
- "description": "The label for the sending party in the agreement.",
- "type": "string"
- },
- "template_psa_statement_of_work_attributes": {
- "additionalProperties": false,
- "description": "Nested PSA statement of work defaults.",
- "properties": {
- "additional_changes": {
- "description": "Text of additional changes to include when include_additional_changes is true.",
- "type": "string"
- },
- "fees_attributes": {
- "items": {
- "additionalProperties": false,
- "properties": {
- "cost": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "description": {
- "type": "string"
- },
- "fee_type": {
- "type": "string"
- },
- "quantity": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- }
- },
- "type": "object"
- },
- "type": "array"
- },
- "include_additional_changes": {
- "description": "Whether to include the additional changes section.",
- "type": "boolean"
- },
- "include_customer_obligation": {
- "type": "boolean"
- },
- "include_customer_obligation_val": {
- "type": "number"
- },
- "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": {
- "type": "string"
- },
- "include_deliverables_resubmission_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_deliverables_resubmission_unit": {
- "type": "string"
- },
- "include_fees_other": {
- "type": "boolean"
- },
- "include_fees_other_val": {
- "type": "number"
- },
- "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": {
- "type": "string"
- },
- "include_fees_travel_val": {
- "type": "number"
- },
- "include_third_party_customer": {
- "type": "boolean"
- },
- "include_third_party_include_description": {
- "type": "string"
- },
- "include_third_party_include_description_val": {
- "type": "number"
- },
- "include_third_party_materials": {
- "type": "boolean"
- },
- "include_third_party_provider": {
- "type": "boolean"
- },
- "include_time_of_assignment": {
- "type": "boolean"
- },
- "include_time_of_assignment_type": {
- "type": "string"
- },
- "invoice_period_description": {
- "type": "string"
- },
- "negotiations_allowed": {
- "description": "Whether counterparties can propose changes to agreements created from this template.",
- "type": "boolean"
- },
- "payment_period": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "payment_period_other": {
- "type": "string"
- },
- "payment_period_timeframe": {
- "type": "string"
- },
- "payment_period_type": {
- "type": "string"
- },
- "payment_period_unit": {
- "type": "string"
- },
- "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": {
- "type": "string"
- },
- "sow_term_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "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": {
- "type": "string"
- },
- "sow_term_unit": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "template_setting_attributes": {
- "additionalProperties": false,
- "description": "Template settings such as standard version and message.",
- "properties": {
- "include_message": {
- "type": "boolean"
- },
- "message": {
- "type": "string"
- },
- "standard_version": {
- "type": "string"
- },
- "subsidiary_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"
- }
- },
- "type": "object"
- },
- "type": {
- "description": "The type of template to create.",
- "type": "string"
- },
- "version": {
- "type": "string"
- }
- },
- "required": [
- "type"
- ],
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "additional_changes": {
- "description": "Text of additional changes to include when include_additional_changes is true.",
- "type": "string"
- },
- "attachment_ids": {
- "description": "UUIDs of attachments to include with the template.",
- "items": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "type": "array"
- },
- "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"
- },
- "customer_description": {
- "type": "string"
- },
- "default_signer_email": {
- "description": "Default email address pre-filled as the signer when creating agreements from this template.",
- "format": "email",
- "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
- "type": "string"
- },
- "district_or_county": {
- "description": "The district or county for dispute resolution.",
- "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": {
- "type": "string"
- },
- "governing_law_country": {
- "description": "The country whose laws govern agreements created from this template.",
- "type": "string"
- },
- "governing_law_region": {
- "description": "The state or region whose laws govern agreements created from this template.",
- "type": "string"
- },
- "include_additional_changes": {
- "description": "Whether to include the additional changes section.",
- "type": "boolean"
- },
- "include_fees": {
- "type": "boolean"
- },
- "include_fees_amount": {
- "type": "number"
- },
- "include_fees_description": {
- "type": "string"
- },
- "include_fees_pay_by_amount": {
- "type": "number"
- },
- "include_fees_type": {
- "type": "string"
- },
- "include_fees_unit": {
- "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": "number"
- },
- "include_program_discount": {
- "type": "boolean"
- },
- "include_program_discount_amount": {
- "type": "number"
- },
- "include_program_discount_unit": {
- "type": "string"
- },
- "include_program_participation_feedback": {
- "type": "boolean"
- },
- "include_program_participation_feedback_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_program_participation_feedback_unit": {
- "type": "string"
- },
- "include_program_partner_other": {
- "type": "boolean"
- },
- "include_program_partner_other_val": {
- "type": "number"
- },
- "include_program_provider_other": {
- "type": "boolean"
- },
- "include_program_provider_other_val": {
- "type": "number"
- },
- "include_program_reference": {
- "type": "boolean"
- },
- "include_terms": {
- "description": "Whether to include standard terms in the agreement.",
- "type": "boolean"
- },
- "name": {
- "description": "A name for the template.",
- "type": "string"
- },
- "negotiations_allowed": {
- "description": "Whether counterparties can propose changes to agreements created from this template.",
- "type": "boolean"
- },
- "product_description": {
- "type": "string"
- },
- "recipient_role": {
- "description": "The label for the receiving party in the agreement.",
- "type": "string"
- },
- "sender_last_to_sign": {
- "description": "When true, the sender signs after the recipient.",
- "type": "boolean"
- },
- "sender_role": {
- "description": "The label for the sending party in the agreement.",
- "type": "string"
- },
- "template_setting_attributes": {
- "additionalProperties": false,
- "description": "Template settings such as standard version and message.",
- "properties": {
- "include_message": {
- "type": "boolean"
- },
- "message": {
- "type": "string"
- },
- "standard_version": {
- "type": "string"
- },
- "subsidiary_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"
- }
- },
- "type": "object"
- },
- "term_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "term_unit": {
- "type": "string"
- },
- "type": {
- "description": "The type of template to create.",
- "type": "string"
- },
- "version": {
- "type": "string"
- }
- },
- "required": [
- "type"
- ],
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "additional_changes": {
- "description": "Text of additional changes to include when include_additional_changes is true.",
- "type": "string"
- },
- "attachment_ids": {
- "description": "UUIDs of attachments to include with the template.",
- "items": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "type": "array"
- },
- "billing_workflow_type": {
- "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"
- },
- "default_signer_email": {
- "description": "Default email address pre-filled as the signer when creating agreements from this template.",
- "format": "email",
- "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
- "type": "string"
- },
- "district_or_county": {
- "description": "The district or county for dispute resolution.",
- "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": {
- "type": "string"
- },
- "general_cap_amount": {
- "type": "number"
- },
- "general_cap_amount_type": {
- "type": "string"
- },
- "general_cap_period_currency": {
- "type": "number"
- },
- "general_cap_period_qty": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "general_cap_preceding_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "governing_law_country": {
- "description": "The country whose laws govern agreements created from this template.",
- "type": "string"
- },
- "governing_law_region": {
- "description": "The state or region whose laws govern agreements created from this template.",
- "type": "string"
- },
- "include_additional_changes": {
- "description": "Whether to include the additional changes section.",
- "type": "boolean"
- },
- "include_additional_warranties": {
- "type": "boolean"
- },
- "include_additional_warranties_by_customer": {
- "type": "boolean"
- },
- "include_additional_warranties_by_provider": {
- "type": "boolean"
- },
- "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_billing_workflow": {
- "type": "boolean"
- },
- "include_covered_claims": {
- "type": "boolean"
- },
- "include_covered_claims_customer_claims": {
- "type": "boolean"
- },
- "include_covered_claims_include_customer_claims": {
- "type": "boolean"
- },
- "include_covered_claims_include_provider_claims": {
- "type": "boolean"
- },
- "include_covered_claims_provider_claims": {
- "type": "boolean"
- },
- "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": "boolean"
- },
- "include_dpa_type": {
- "type": "string"
- },
- "include_increased_cap_amount": {
- "type": "number"
- },
- "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": "boolean"
- },
- "include_increased_claims_restrictions": {
- "type": "boolean"
- },
- "include_terms": {
- "description": "Whether to include standard terms in the agreement.",
- "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": "boolean"
- },
- "increased_cap_amount_currency": {
- "type": "number"
- },
- "increased_cap_amount_period_currency": {
- "type": "number"
- },
- "increased_cap_amount_period_qty": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "increased_cap_amount_qty": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "increased_cap_amount_type": {
- "type": "string"
- },
- "name": {
- "description": "A name for the template.",
- "type": "string"
- },
- "negotiations_allowed": {
- "description": "Whether counterparties can propose changes to agreements created from this template.",
- "type": "boolean"
- },
- "payment_link_url": {
- "type": "string"
- },
- "recipient_role": {
- "description": "The label for the receiving party in the agreement.",
- "type": "string"
- },
- "sender_last_to_sign": {
- "description": "When true, the sender signs after the recipient.",
- "type": "boolean"
- },
- "sender_role": {
- "description": "The label for the sending party in the agreement.",
- "type": "string"
- },
- "stripe_invoice_delivery": {
- "type": "string"
- },
- "stripe_payment_link_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"
- },
- "stripe_product_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"
- },
- "stripe_product_name": {
- "type": "string"
- },
- "stripe_subsequent_bill_method": {
- "type": "string"
- },
- "template_setting_attributes": {
- "additionalProperties": false,
- "description": "Template settings such as standard version and message.",
- "properties": {
- "include_message": {
- "type": "boolean"
- },
- "message": {
- "type": "string"
- },
- "standard_version": {
- "type": "string"
- },
- "subsidiary_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"
- }
- },
- "type": "object"
- },
- "template_software_license_order_form_attributes": {
- "additionalProperties": false,
- "description": "Nested software license order form defaults.",
- "properties": {
- "additional_changes": {
- "description": "Text of additional changes to include when include_additional_changes is true.",
- "type": "string"
- },
- "deletion_procedure_include_custom": {
- "type": "string"
- },
- "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": {
- "type": "string"
- },
- "fees_attributes": {
- "items": {
- "additionalProperties": false,
- "properties": {
- "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"
- },
- "cost": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "description": {
- "type": "string"
- },
- "discount_duration_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "discount_duration_type": {
- "type": "string"
- },
- "discount_type": {
- "type": "string"
- },
- "fee_type": {
- "type": "string"
- },
- "graduated_fee_tiers_attributes": {
- "items": {
- "additionalProperties": false,
- "properties": {
- "flat_price": {
- "type": "string"
- },
- "price_per_unit": {
- "type": "string"
- },
- "upper_limit": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- }
- },
- "type": "object"
- },
- "type": "array"
- },
- "quantity": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "stripe_product_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"
- },
- "type": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "type": "array"
- },
- "fees_currency": {
- "type": "number"
- },
- "fees_include_fee_increase_upon_renewal": {
- "type": "boolean"
- },
- "fees_include_fee_increase_upon_renewal_fee": {
- "type": "number"
- },
- "fees_include_fee_increase_upon_renewal_type": {
- "type": "string"
- },
- "fees_inclusive_of_taxes": {
- "type": "string"
- },
- "include_additional_changes": {
- "description": "Whether to include the additional changes section.",
- "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": {
- "format": "email",
- "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
- "type": "string"
- },
- "include_pilot_period": {
- "type": "boolean"
- },
- "include_pilot_period_duration_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_pilot_period_duration_type": {
- "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": "Whether counterparties can propose changes to agreements created from this template.",
- "type": "boolean"
- },
- "order_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"
- },
- "order_date_type": {
- "type": "string"
- },
- "payment_process_automatic_frequency": {
- "type": "string"
- },
- "payment_process_type": {
- "type": "string"
- },
- "payment_process_type_custom_val": {
- "type": "number"
- },
- "payment_process_type_invoice_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "payment_process_type_invoice_custom_unit": {
- "type": "string"
- },
- "payment_process_type_invoice_duration": {
- "type": "string"
- },
- "payment_process_type_invoice_duration_start": {
- "type": "string"
- },
- "payment_process_type_invoice_type": {
- "type": "string"
- },
- "permitted_uses_include_custom": {
- "type": "string"
- },
- "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": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "software_description": {
- "type": "string"
- },
- "subscription_auto_renew": {
- "type": "string"
- },
- "subscription_period": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "subscription_period_unit": {
- "type": "string"
- },
- "subscription_renewal_notice_days": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "warranty_period_description_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "warranty_period_description_duration": {
- "type": "string"
- },
- "warranty_period_description_duration_start": {
- "type": "string"
- },
- "warranty_period_type": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "type": {
- "description": "The type of template to create.",
- "type": "string"
- }
- },
- "required": [
- "type"
- ],
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "additional_changes": {
- "description": "Text of additional changes to include when include_additional_changes is true.",
- "type": "string"
- },
- "additional_terms": {
- "type": "string"
- },
- "attachment_ids": {
- "description": "UUIDs of attachments to include with the template.",
- "items": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "type": "array"
- },
- "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"
- },
- "default_signer_email": {
- "description": "Default email address pre-filled as the signer when creating agreements from this template.",
- "format": "email",
- "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
- "type": "string"
- },
- "district_or_county": {
- "description": "The district or county for dispute resolution.",
- "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": {
- "type": "string"
- },
- "fees_type": {
- "type": "string"
- },
- "general_cap_amount": {
- "type": "number"
- },
- "general_cap_amount_type": {
- "type": "string"
- },
- "general_cap_period_currency": {
- "type": "number"
- },
- "general_cap_period_qty": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "general_cap_preceding_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "governing_law_country": {
- "description": "The country whose laws govern agreements created from this template.",
- "type": "string"
- },
- "governing_law_region": {
- "description": "The state or region whose laws govern agreements created from this template.",
- "type": "string"
- },
- "include_additional_changes": {
- "description": "Whether to include the additional changes section.",
- "type": "boolean"
- },
- "include_additional_terms": {
- "type": "boolean"
- },
- "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": "boolean"
- },
- "include_dpa_type": {
- "type": "string"
- },
- "include_payment_process": {
- "type": "boolean"
- },
- "include_technical_support": {
- "type": "boolean"
- },
- "include_terms": {
- "description": "Whether to include standard terms in the agreement.",
- "type": "boolean"
- },
- "name": {
- "description": "A name for the template.",
- "type": "string"
- },
- "negotiations_allowed": {
- "description": "Whether counterparties can propose changes to agreements created from this template.",
- "type": "boolean"
- },
- "payment_process_automatic_frequency": {
- "type": "string"
- },
- "payment_process_invoice_days": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "payment_process_invoice_from": {
- "type": "string"
- },
- "payment_process_invoice_timeframe": {
- "type": "string"
- },
- "payment_process_type": {
- "type": "string"
- },
- "pilot_period_description": {
- "type": "string"
- },
- "pilot_period_fees_description": {
- "type": "string"
- },
- "product_description": {
- "type": "string"
- },
- "recipient_role": {
- "description": "The label for the receiving party in the agreement.",
- "type": "string"
- },
- "sender_last_to_sign": {
- "description": "When true, the sender signs after the recipient.",
- "type": "boolean"
- },
- "sender_role": {
- "description": "The label for the sending party in the agreement.",
- "type": "string"
- },
- "technical_support_description": {
- "type": "string"
- },
- "template_setting_attributes": {
- "additionalProperties": false,
- "description": "Template settings such as standard version and message.",
- "properties": {
- "include_message": {
- "type": "boolean"
- },
- "message": {
- "type": "string"
- },
- "standard_version": {
- "type": "string"
- },
- "subsidiary_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"
- }
- },
- "type": "object"
- },
- "type": {
- "description": "The type of template to create.",
- "type": "string"
- }
- },
- "required": [
- "type"
- ],
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "additional_changes": {
- "description": "Text of additional changes to include when include_additional_changes is true.",
- "type": "string"
- },
- "attachment_ids": {
- "description": "UUIDs of attachments to include with the template.",
- "items": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "type": "array"
- },
- "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"
- },
- "default_signer_email": {
- "description": "Default email address pre-filled as the signer when creating agreements from this template.",
- "format": "email",
- "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
- "type": "string"
- },
- "district_or_county": {
- "description": "The district or county for dispute resolution.",
- "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": {
- "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": {
- "type": "string"
- },
- "governing_law_country": {
- "description": "The country whose laws govern agreements created from this template.",
- "type": "string"
- },
- "governing_law_region": {
- "description": "The state or region whose laws govern agreements created from this template.",
- "type": "string"
- },
- "include_additional_changes": {
- "description": "Whether to include the additional changes section.",
- "type": "boolean"
- },
- "include_additional_warranties": {
- "type": "boolean"
- },
- "include_additional_warranties_include_company": {
- "type": "boolean"
- },
- "include_additional_warranties_include_company_val": {
- "type": "number"
- },
- "include_additional_warranties_include_partner": {
- "type": "boolean"
- },
- "include_additional_warranties_include_partner_val": {
- "type": "number"
- },
- "include_brand_guidelines": {
- "type": "boolean"
- },
- "include_brand_guidelines_include_company": {
- "type": "boolean"
- },
- "include_brand_guidelines_include_company_val": {
- "type": "number"
- },
- "include_brand_guidelines_include_partner": {
- "type": "boolean"
- },
- "include_brand_guidelines_include_partner_val": {
- "type": "number"
- },
- "include_covered_claims": {
- "type": "boolean"
- },
- "include_covered_claims_company_claims": {
- "type": "boolean"
- },
- "include_covered_claims_include_company_claims": {
- "type": "boolean"
- },
- "include_covered_claims_include_partner_claims": {
- "type": "boolean"
- },
- "include_covered_claims_partner_claims": {
- "type": "boolean"
- },
- "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": "boolean"
- },
- "include_dpa_type": {
- "type": "string"
- },
- "include_increased_cap_amount": {
- "type": "number"
- },
- "include_increased_cap_amount_currency": {
- "type": "boolean"
- },
- "include_increased_cap_amount_either_currency": {
- "type": "boolean"
- },
- "include_increased_cap_amount_either_multiple": {
- "type": "boolean"
- },
- "include_increased_cap_amount_multiple": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_increased_cap_amount_type": {
- "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": "number"
- },
- "include_terms": {
- "description": "Whether to include standard terms in the agreement.",
- "type": "boolean"
- },
- "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": "number"
- },
- "name": {
- "description": "A name for the template.",
- "type": "string"
- },
- "negotiations_allowed": {
- "description": "Whether counterparties can propose changes to agreements created from this template.",
- "type": "boolean"
- },
- "recipient_role": {
- "description": "The label for the receiving party in the agreement.",
- "type": "string"
- },
- "sender_last_to_sign": {
- "description": "When true, the sender signs after the recipient.",
- "type": "boolean"
- },
- "sender_role": {
- "description": "The label for the sending party in the agreement.",
- "type": "string"
- },
- "template_partnership_business_terms_attributes": {
- "additionalProperties": false,
- "description": "Nested partnership business terms defaults.",
- "properties": {
- "end_date_after_effective_date_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "end_date_after_effective_date_unit": {
- "type": "string"
- },
- "end_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"
- },
- "end_date_type": {
- "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": "number"
- },
- "include_obligations_company_promotion_include_materials": {
- "type": "boolean"
- },
- "include_obligations_company_promotion_include_materials_val": {
- "type": "number"
- },
- "include_obligations_company_referral": {
- "type": "boolean"
- },
- "include_obligations_company_referral_include_criteria": {
- "type": "boolean"
- },
- "include_obligations_company_referral_include_criteria_val": {
- "type": "number"
- },
- "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": {
- "type": "string"
- },
- "include_obligations_company_sponsorship": {
- "type": "boolean"
- },
- "include_obligations_company_sponsorship_include_benefits": {
- "type": "boolean"
- },
- "include_obligations_company_sponsorship_include_benefits_val": {
- "type": "number"
- },
- "include_obligations_company_sponsorship_include_payments": {
- "type": "boolean"
- },
- "include_obligations_company_sponsorship_include_payments_amount": {
- "type": "number"
- },
- "include_obligations_company_sponsorship_include_payments_unit": {
- "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": "number"
- },
- "include_obligations_partner_promotion_include_materials": {
- "type": "boolean"
- },
- "include_obligations_partner_promotion_include_materials_val": {
- "type": "number"
- },
- "include_obligations_partner_referral": {
- "type": "boolean"
- },
- "include_obligations_partner_referral_include_criteria": {
- "type": "boolean"
- },
- "include_obligations_partner_referral_include_criteria_val": {
- "type": "number"
- },
- "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": {
- "type": "string"
- },
- "include_obligations_partner_sponsorship": {
- "type": "boolean"
- },
- "include_obligations_partner_sponsorship_include_benefits": {
- "type": "boolean"
- },
- "include_obligations_partner_sponsorship_include_benefits_val": {
- "type": "number"
- },
- "include_obligations_partner_sponsorship_include_payments": {
- "type": "boolean"
- },
- "include_obligations_partner_sponsorship_include_payments_amount": {
- "type": "number"
- },
- "include_obligations_partner_sponsorship_include_payments_unit": {
- "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": "boolean"
- },
- "include_payment_process_company_include_address_country": {
- "type": "boolean"
- },
- "include_payment_process_company_include_address_state": {
- "type": "boolean"
- },
- "include_payment_process_company_include_address_street_address": {
- "type": "boolean"
- },
- "include_payment_process_company_include_address_zipcode": {
- "type": "boolean"
- },
- "include_payment_process_company_include_email": {
- "format": "email",
- "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
- "type": "string"
- },
- "include_payment_process_company_include_email_val": {
- "format": "email",
- "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
- "type": "string"
- },
- "include_payment_process_partner": {
- "type": "boolean"
- },
- "include_payment_process_partner_include_address": {
- "type": "boolean"
- },
- "include_payment_process_partner_include_address_city": {
- "type": "boolean"
- },
- "include_payment_process_partner_include_address_country": {
- "type": "boolean"
- },
- "include_payment_process_partner_include_address_state": {
- "type": "boolean"
- },
- "include_payment_process_partner_include_address_street_address": {
- "type": "boolean"
- },
- "include_payment_process_partner_include_address_zipcode": {
- "type": "boolean"
- },
- "include_payment_process_partner_include_email": {
- "format": "email",
- "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
- "type": "string"
- },
- "include_payment_process_partner_include_email_val": {
- "format": "email",
- "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
- "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": {
- "type": "boolean"
- },
- "include_payment_schedule_specified_unit": {
- "type": "string"
- },
- "include_payment_schedule_type": {
- "type": "string"
- },
- "negotiations_allowed": {
- "description": "Whether counterparties can propose changes to agreements created from this template.",
- "type": "boolean"
- },
- "territory_type": {
- "type": "string"
- },
- "territory_type_val": {
- "type": "number"
- }
- },
- "type": "object"
- },
- "template_setting_attributes": {
- "additionalProperties": false,
- "description": "Template settings such as standard version and message.",
- "properties": {
- "include_message": {
- "type": "boolean"
- },
- "message": {
- "type": "string"
- },
- "standard_version": {
- "type": "string"
- },
- "subsidiary_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"
- }
- },
- "type": "object"
- },
- "type": {
- "description": "The type of template to create.",
- "type": "string"
- }
- },
- "required": [
- "type"
- ],
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "additional_changes": {
- "description": "Text of additional changes to include when include_additional_changes is true.",
- "type": "string"
- },
- "aggregation_limitations_permitted": {
- "type": "boolean"
- },
- "aggregation_limitations_permitted_val": {
- "type": "number"
- },
- "attachment_ids": {
- "description": "UUIDs of attachments to include with the template.",
- "items": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "type": "array"
- },
- "breach_notification_unit": {
- "type": "string"
- },
- "breach_notification_val": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "business_associate_relationship_type": {
- "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"
- },
- "default_signer_email": {
- "description": "Default email address pre-filled as the signer when creating agreements from this template.",
- "format": "email",
- "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
- "type": "string"
- },
- "deidentification_limitations_include_purpose": {
- "type": "boolean"
- },
- "deidentification_limitations_include_requirements": {
- "type": "boolean"
- },
- "deidentification_limitations_permitted": {
- "type": "boolean"
- },
- "deidentification_limitations_purpose_val": {
- "type": "number"
- },
- "deidentification_limitations_requirements_val": {
- "type": "number"
- },
- "designated_record_set_provider_maintains": {
- "type": "boolean"
- },
- "district_or_county": {
- "description": "The district or county for dispute resolution.",
- "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": {
- "type": "string"
- },
- "governing_law_country": {
- "description": "The country whose laws govern agreements created from this template.",
- "type": "string"
- },
- "governing_law_region": {
- "description": "The state or region whose laws govern agreements created from this template.",
- "type": "string"
- },
- "include_additional_changes": {
- "description": "Whether to include the additional changes section.",
- "type": "boolean"
- },
- "include_aggregation_limitations": {
- "type": "boolean"
- },
- "include_deidentification_limitations": {
- "type": "boolean"
- },
- "include_limitations": {
- "type": "boolean"
- },
- "include_offshore_limitations": {
- "type": "boolean"
- },
- "include_subcontract_limitations": {
- "type": "boolean"
- },
- "include_terms": {
- "description": "Whether to include standard terms in the agreement.",
- "type": "boolean"
- },
- "name": {
- "description": "A name for the template.",
- "type": "string"
- },
- "negotiations_allowed": {
- "description": "Whether counterparties can propose changes to agreements created from this template.",
- "type": "boolean"
- },
- "offshore_limitations_permitted": {
- "type": "boolean"
- },
- "offshore_limitations_permitted_val": {
- "type": "number"
- },
- "recipient_role": {
- "description": "The label for the receiving party in the agreement.",
- "type": "string"
- },
- "sender_last_to_sign": {
- "description": "When true, the sender signs after the recipient.",
- "type": "boolean"
- },
- "sender_role": {
- "description": "The label for the sending party in the agreement.",
- "type": "string"
- },
- "subcontract_limitations_include_notice": {
- "type": "boolean"
- },
- "subcontract_limitations_include_permission": {
- "type": "boolean"
- },
- "subcontract_limitations_notice_val": {
- "type": "number"
- },
- "subcontract_limitations_permission_val": {
- "type": "number"
- },
- "subcontract_limitations_permitted": {
- "type": "boolean"
- },
- "template_setting_attributes": {
- "additionalProperties": false,
- "description": "Template settings such as standard version and message.",
- "properties": {
- "include_message": {
- "type": "boolean"
- },
- "message": {
- "type": "string"
- },
- "standard_version": {
- "type": "string"
- },
- "subsidiary_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"
- }
- },
- "type": "object"
- },
- "type": {
- "description": "The type of template to create.",
- "type": "string"
- }
- },
- "required": [
- "type"
- ],
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "additional_changes": {
- "description": "Text of additional changes to include when include_additional_changes is true.",
- "type": "string"
- },
- "attachment_ids": {
- "description": "UUIDs of attachments to include with the template.",
- "items": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "type": "array"
- },
- "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"
- },
- "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": {
- "type": "string"
- },
- "confidentiality_type": {
- "type": "string"
- },
- "default_signer_email": {
- "description": "Default email address pre-filled as the signer when creating agreements from this template.",
- "format": "email",
- "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
- "type": "string"
- },
- "district_or_county": {
- "description": "The district or county for dispute resolution.",
- "type": "string"
- },
- "governing_law_country": {
- "description": "The country whose laws govern agreements created from this template.",
- "type": "string"
- },
- "governing_law_region": {
- "description": "The state or region whose laws govern agreements created from this template.",
- "type": "string"
- },
- "include_additional_changes": {
- "description": "Whether to include the additional changes section.",
- "type": "boolean"
- },
- "include_custom_details": {
- "type": "boolean"
- },
- "include_custom_details_val": {
- "type": "number"
- },
- "include_fees": {
- "type": "boolean"
- },
- "include_fees_amount": {
- "type": "number"
- },
- "include_fees_amount_duration": {
- "type": "string"
- },
- "include_fees_include_amount": {
- "type": "number"
- },
- "include_fees_include_other": {
- "type": "boolean"
- },
- "include_fees_other": {
- "type": "boolean"
- },
- "include_functionality": {
- "type": "boolean"
- },
- "include_functionality_val": {
- "type": "number"
- },
- "include_launch_date": {
- "type": "string"
- },
- "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": {
- "type": "string"
- },
- "include_terms": {
- "description": "Whether to include standard terms in the agreement.",
- "type": "boolean"
- },
- "name": {
- "description": "A name for the template.",
- "type": "string"
- },
- "negotiations_allowed": {
- "description": "Whether counterparties can propose changes to agreements created from this template.",
- "type": "boolean"
- },
- "product_name": {
- "type": "string"
- },
- "recipient_role": {
- "description": "The label for the receiving party in the agreement.",
- "type": "string"
- },
- "sender_last_to_sign": {
- "description": "When true, the sender signs after the recipient.",
- "type": "boolean"
- },
- "sender_role": {
- "description": "The label for the sending party in the agreement.",
- "type": "string"
- },
- "template_setting_attributes": {
- "additionalProperties": false,
- "description": "Template settings such as standard version and message.",
- "properties": {
- "include_message": {
- "type": "boolean"
- },
- "message": {
- "type": "string"
- },
- "standard_version": {
- "type": "string"
- },
- "subsidiary_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"
- }
- },
- "type": "object"
- },
- "type": {
- "description": "The type of template to create.",
- "type": "string"
- }
- },
- "required": [
- "type"
- ],
- "type": "object"
- }
-]New value: +[
+ {
+ "additionalProperties": false,
+ "properties": {
+ "additional_changes": {
+ "description": "Text of additional changes to include when include_additional_changes is true.",
+ "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"
+ },
+ "confidentiality_period": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "confidentiality_period_perpetual": {
+ "type": "boolean"
+ },
+ "default_signer_email": {
+ "description": "Default email address pre-filled as the signer when creating agreements from this template.",
+ "format": "email",
+ "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "district_or_county": {
+ "description": "The district or county for dispute resolution.",
+ "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_of_confidentiality": {
+ "type": "string"
+ },
+ "effective_date_type": {
+ "type": "string"
+ },
+ "governing_law_country": {
+ "description": "The country whose laws govern agreements created from this template.",
+ "type": "string"
+ },
+ "governing_law_region": {
+ "description": "The state or region whose laws govern agreements created from this template.",
+ "type": "string"
+ },
+ "include_additional_changes": {
+ "description": "Whether to include the additional changes section.",
+ "type": "boolean"
+ },
+ "include_terms": {
+ "description": "Whether to include standard terms in the agreement.",
+ "type": "boolean"
+ },
+ "name": {
+ "description": "A name for the template.",
+ "type": "string"
+ },
+ "negotiations_allowed": {
+ "description": "Whether counterparties can propose changes to agreements created from this template.",
+ "type": "boolean"
+ },
+ "purpose": {
+ "type": "string"
+ },
+ "recipient_role": {
+ "description": "The label for the receiving party in the agreement.",
+ "type": "string"
+ },
+ "sender_last_to_sign": {
+ "description": "When true, the sender signs after the recipient.",
+ "type": "boolean"
+ },
+ "sender_role": {
+ "description": "The label for the sending party in the agreement.",
+ "type": "string"
+ },
+ "template_setting_attributes": {
+ "additionalProperties": false,
+ "description": "Template settings such as standard version and message.",
+ "properties": {
+ "include_message": {
+ "type": "boolean"
+ },
+ "message": {
+ "type": "string"
+ },
+ "standard_version": {
+ "type": "string"
+ },
+ "subsidiary_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"
+ }
+ },
+ "type": "object"
+ },
+ "term": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "term_period_perpetual": {
+ "type": "boolean"
+ },
+ "type": {
+ "description": "Optional. When omitted, the template defaults to NDA.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "additional_changes": {
+ "description": "Text of additional changes to include when include_additional_changes is true.",
+ "type": "string"
+ },
+ "attachment_ids": {
+ "description": "UUIDs of attachments to include with the template.",
+ "items": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "billing_workflow_type": {
+ "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"
+ },
+ "customer_description": {
+ "type": "string"
+ },
+ "default_signer_email": {
+ "description": "Default email address pre-filled as the signer when creating agreements from this template.",
+ "format": "email",
+ "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "district_or_county": {
+ "description": "The district or county for dispute resolution.",
+ "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": {
+ "type": "string"
+ },
+ "effective_date_type": {
+ "type": "string"
+ },
+ "general_cap_amount": {
+ "type": "number"
+ },
+ "general_cap_amount_type": {
+ "type": "string"
+ },
+ "general_cap_period_currency": {
+ "type": "number"
+ },
+ "general_cap_period_qty": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "general_cap_preceding_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "governing_law_country": {
+ "description": "The country whose laws govern agreements created from this template.",
+ "type": "string"
+ },
+ "governing_law_region": {
+ "description": "The state or region whose laws govern agreements created from this template.",
+ "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": {
+ "type": "string"
+ },
+ "include_additional_changes": {
+ "description": "Whether to include the additional changes section.",
+ "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_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_billing_workflow": {
+ "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_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": {
+ "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": {
+ "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": {
+ "type": "string"
+ },
+ "include_terms": {
+ "description": "Whether to include standard terms in the agreement.",
+ "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": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "increased_cap_amount_qty": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "increased_cap_amount_type": {
+ "type": "string"
+ },
+ "name": {
+ "description": "A name for the template.",
+ "type": "string"
+ },
+ "negotiations_allowed": {
+ "description": "Whether counterparties can propose changes to agreements created from this template.",
+ "type": "boolean"
+ },
+ "payment_link_url": {
+ "type": "string"
+ },
+ "provider": {
+ "type": "string"
+ },
+ "recipient_role": {
+ "description": "The label for the receiving party in the agreement.",
+ "type": "string"
+ },
+ "sender_last_to_sign": {
+ "description": "When true, the sender signs after the recipient.",
+ "type": "boolean"
+ },
+ "sender_role": {
+ "description": "The label for the sending party in the agreement.",
+ "type": "string"
+ },
+ "stripe_invoice_delivery": {
+ "type": "string"
+ },
+ "stripe_payment_link_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"
+ },
+ "stripe_product_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"
+ },
+ "stripe_product_name": {
+ "type": "string"
+ },
+ "stripe_subsequent_bill_method": {
+ "type": "string"
+ },
+ "template_csa_order_form_attributes": {
+ "additionalProperties": false,
+ "description": "Nested CSA order form defaults. See Template Parameters docs for CSA Order Form.",
+ "properties": {
+ "additional_changes": {
+ "description": "Text of additional changes to include when include_additional_changes is true.",
+ "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": {
+ "type": "string"
+ },
+ "fees_attributes": {
+ "items": {
+ "additionalProperties": false,
+ "properties": {
+ "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"
+ },
+ "cost": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "description": {
+ "type": "string"
+ },
+ "discount_duration_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "discount_duration_type": {
+ "type": "string"
+ },
+ "discount_type": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "graduated_fee_tiers_attributes": {
+ "items": {
+ "additionalProperties": false,
+ "properties": {
+ "flat_price": {
+ "type": "string"
+ },
+ "price_per_unit": {
+ "type": "string"
+ },
+ "upper_limit": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "quantity": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "stripe_product_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"
+ },
+ "type": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "fees_currency": {
+ "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": {
+ "type": "string"
+ },
+ "fees_inclusive_of_taxes": {
+ "type": "boolean"
+ },
+ "free_trial_days": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_additional_changes": {
+ "description": "Whether to include the additional changes section.",
+ "type": "boolean"
+ },
+ "include_additional_parameters_or_limitations": {
+ "type": "boolean"
+ },
+ "include_billing_info": {
+ "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": {
+ "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": {
+ "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": {
+ "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": {
+ "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": {
+ "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": {
+ "type": "string"
+ },
+ "include_sla_standard_maintenance_notice_qty": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_sla_standard_maintenance_notice_unit": {
+ "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": {
+ "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": {
+ "type": "string"
+ },
+ "invoice_period_custom_unit": {
+ "type": "string"
+ },
+ "max_consumption": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "max_users": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "negotiations_allowed": {
+ "description": "Whether counterparties can propose changes to agreements created from this template.",
+ "type": "boolean"
+ },
+ "order_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"
+ },
+ "order_date_other": {
+ "type": "string"
+ },
+ "order_date_type": {
+ "type": "string"
+ },
+ "payment_period": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "payment_period_timeframe": {
+ "type": "string"
+ },
+ "payment_period_unit": {
+ "type": "string"
+ },
+ "payment_process_automatic_frequency": {
+ "type": "string"
+ },
+ "payment_process_type": {
+ "type": "string"
+ },
+ "payment_process_type_custom_val": {
+ "type": "string"
+ },
+ "payment_process_type_invoice_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "payment_process_type_invoice_custom_unit": {
+ "type": "string"
+ },
+ "payment_process_type_invoice_duration": {
+ "type": "string"
+ },
+ "payment_process_type_invoice_duration_start": {
+ "type": "string"
+ },
+ "payment_process_type_invoice_type": {
+ "type": "string"
+ },
+ "pilot_period_stripe_product_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"
+ },
+ "service_credits_attributes": {
+ "items": {
+ "additionalProperties": false,
+ "properties": {
+ "credit": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "max": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "min": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "subscription_auto_renew": {
+ "type": "string"
+ },
+ "subscription_period": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "subscription_period_unit": {
+ "type": "string"
+ },
+ "subscription_renewal_notice_days": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "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": {
+ "type": "string"
+ },
+ "use_limitations_attributes": {
+ "items": {
+ "additionalProperties": false,
+ "properties": {
+ "amount": {
+ "type": "string"
+ },
+ "limitation_type": {
+ "type": "string"
+ },
+ "unit": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "template_setting_attributes": {
+ "additionalProperties": false,
+ "description": "Template settings such as standard version and message.",
+ "properties": {
+ "include_message": {
+ "type": "boolean"
+ },
+ "message": {
+ "type": "string"
+ },
+ "standard_version": {
+ "type": "string"
+ },
+ "subsidiary_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"
+ }
+ },
+ "type": "object"
+ },
+ "type": {
+ "description": "The type of template to create.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "type"
+ ],
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "additional_changes": {
+ "description": "Text of additional changes to include when include_additional_changes is true.",
+ "type": "string"
+ },
+ "approved_subprocessor_type": {
+ "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"
+ },
+ "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": {
+ "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"
+ },
+ "default_signer_email": {
+ "description": "Default email address pre-filled as the signer when creating agreements from this template.",
+ "format": "email",
+ "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "district_or_county": {
+ "description": "The district or county for dispute resolution.",
+ "type": "string"
+ },
+ "duration_of_processing": {
+ "type": "string"
+ },
+ "governing_law_country": {
+ "description": "The country whose laws govern agreements created from this template.",
+ "type": "string"
+ },
+ "governing_law_region": {
+ "description": "The state or region whose laws govern agreements created from this template.",
+ "type": "string"
+ },
+ "include_additional_changes": {
+ "description": "Whether to include the additional changes section.",
+ "type": "boolean"
+ },
+ "include_covered_claim": {
+ "type": "boolean"
+ },
+ "include_covered_claim_external_val": {
+ "type": "string"
+ },
+ "include_covered_claim_internal_val": {
+ "type": "string"
+ },
+ "include_covered_claim_type": {
+ "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": {
+ "type": "boolean"
+ },
+ "include_increased_claim_amount_currency": {
+ "type": "string"
+ },
+ "include_increased_claim_amount_qty": {},
+ "include_increased_claim_amount_type": {
+ "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": {
+ "type": "string"
+ },
+ "include_liability_cap_amount_currency_internal": {
+ "type": "string"
+ },
+ "include_liability_cap_csa_type": {
+ "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-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_provider": {
+ "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"
+ },
+ "include_terms": {
+ "description": "Whether to include standard terms in the agreement.",
+ "type": "boolean"
+ },
+ "name": {
+ "description": "A name for the template.",
+ "type": "string"
+ },
+ "negotiations_allowed": {
+ "description": "Whether counterparties can propose changes to agreements created from this template.",
+ "type": "boolean"
+ },
+ "provider": {
+ "type": "string"
+ },
+ "recipient_role": {
+ "description": "The label for the receiving party in the agreement.",
+ "type": "string"
+ },
+ "security_policy_available_at": {
+ "type": "string"
+ },
+ "security_policy_type": {
+ "type": "string"
+ },
+ "sender_last_to_sign": {
+ "description": "When true, the sender signs after the recipient.",
+ "type": "boolean"
+ },
+ "sender_role": {
+ "description": "The label for the sending party in the agreement.",
+ "type": "string"
+ },
+ "subprocessors_attributes": {
+ "description": "List of subprocessors. Each item may include name, country, and processing_task.",
+ "items": {
+ "additionalProperties": false,
+ "properties": {
+ "country": {
+ "type": "string"
+ },
+ "name": {
+ "description": "A name for the template.",
+ "type": "string"
+ },
+ "processing_task": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "template_setting_attributes": {
+ "additionalProperties": false,
+ "description": "Template settings such as standard version and message.",
+ "properties": {
+ "include_message": {
+ "type": "boolean"
+ },
+ "message": {
+ "type": "string"
+ },
+ "standard_version": {
+ "type": "string"
+ },
+ "subsidiary_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"
+ }
+ },
+ "type": "object"
+ },
+ "type": {
+ "description": "The type of template to create.",
+ "type": "string"
+ },
+ "underlying_agreement_val": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "type"
+ ],
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "additional_changes": {
+ "description": "Text of additional changes to include when include_additional_changes is true.",
+ "type": "string"
+ },
+ "attachment_ids": {
+ "description": "UUIDs of attachments to include with the template.",
+ "items": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "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"
+ },
+ "default_signer_email": {
+ "description": "Default email address pre-filled as the signer when creating agreements from this template.",
+ "format": "email",
+ "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "district_or_county": {
+ "description": "The district or county for dispute resolution.",
+ "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": {
+ "type": "string"
+ },
+ "general_cap_amount": {
+ "type": "number"
+ },
+ "general_cap_amount_type": {
+ "type": "string"
+ },
+ "general_cap_period_currency": {
+ "type": "number"
+ },
+ "general_cap_period_qty": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "general_cap_preceding_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "governing_law_country": {
+ "description": "The country whose laws govern agreements created from this template.",
+ "type": "string"
+ },
+ "governing_law_region": {
+ "description": "The state or region whose laws govern agreements created from this template.",
+ "type": "string"
+ },
+ "include_additional_changes": {
+ "description": "Whether to include the additional changes section.",
+ "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": {
+ "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": {
+ "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": {
+ "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": {
+ "type": "string"
+ },
+ "include_terms": {
+ "description": "Whether to include standard terms in the agreement.",
+ "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_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": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "increased_cap_amount_qty": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "increased_cap_amount_type": {
+ "type": "string"
+ },
+ "name": {
+ "description": "A name for the template.",
+ "type": "string"
+ },
+ "negotiations_allowed": {
+ "description": "Whether counterparties can propose changes to agreements created from this template.",
+ "type": "boolean"
+ },
+ "recipient_role": {
+ "description": "The label for the receiving party in the agreement.",
+ "type": "string"
+ },
+ "sender_last_to_sign": {
+ "description": "When true, the sender signs after the recipient.",
+ "type": "boolean"
+ },
+ "sender_role": {
+ "description": "The label for the sending party in the agreement.",
+ "type": "string"
+ },
+ "template_psa_statement_of_work_attributes": {
+ "additionalProperties": false,
+ "description": "Nested PSA statement of work defaults.",
+ "properties": {
+ "additional_changes": {
+ "description": "Text of additional changes to include when include_additional_changes is true.",
+ "type": "string"
+ },
+ "fees_attributes": {
+ "items": {
+ "additionalProperties": false,
+ "properties": {
+ "cost": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "description": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "quantity": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "include_additional_changes": {
+ "description": "Whether to include the additional changes section.",
+ "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": {
+ "type": "string"
+ },
+ "include_deliverables_resubmission_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_deliverables_resubmission_unit": {
+ "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": {
+ "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": {
+ "type": "string"
+ },
+ "invoice_period_description": {
+ "type": "string"
+ },
+ "negotiations_allowed": {
+ "description": "Whether counterparties can propose changes to agreements created from this template.",
+ "type": "boolean"
+ },
+ "payment_period": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "payment_period_other": {
+ "type": "string"
+ },
+ "payment_period_timeframe": {
+ "type": "string"
+ },
+ "payment_period_type": {
+ "type": "string"
+ },
+ "payment_period_unit": {
+ "type": "string"
+ },
+ "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": {
+ "type": "string"
+ },
+ "sow_term_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "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": {
+ "type": "string"
+ },
+ "sow_term_unit": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "template_setting_attributes": {
+ "additionalProperties": false,
+ "description": "Template settings such as standard version and message.",
+ "properties": {
+ "include_message": {
+ "type": "boolean"
+ },
+ "message": {
+ "type": "string"
+ },
+ "standard_version": {
+ "type": "string"
+ },
+ "subsidiary_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"
+ }
+ },
+ "type": "object"
+ },
+ "type": {
+ "description": "The type of template to create.",
+ "type": "string"
+ },
+ "version": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "type"
+ ],
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "additional_changes": {
+ "description": "Text of additional changes to include when include_additional_changes is true.",
+ "type": "string"
+ },
+ "attachment_ids": {
+ "description": "UUIDs of attachments to include with the template.",
+ "items": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "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"
+ },
+ "customer_description": {
+ "type": "string"
+ },
+ "default_signer_email": {
+ "description": "Default email address pre-filled as the signer when creating agreements from this template.",
+ "format": "email",
+ "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "district_or_county": {
+ "description": "The district or county for dispute resolution.",
+ "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": {
+ "type": "string"
+ },
+ "governing_law_country": {
+ "description": "The country whose laws govern agreements created from this template.",
+ "type": "string"
+ },
+ "governing_law_region": {
+ "description": "The state or region whose laws govern agreements created from this template.",
+ "type": "string"
+ },
+ "include_additional_changes": {
+ "description": "Whether to include the additional changes section.",
+ "type": "boolean"
+ },
+ "include_fees": {
+ "type": "boolean"
+ },
+ "include_fees_amount": {
+ "type": "number"
+ },
+ "include_fees_description": {
+ "type": "string"
+ },
+ "include_fees_pay_by_amount": {},
+ "include_fees_type": {
+ "type": "string"
+ },
+ "include_fees_unit": {
+ "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": {
+ "type": "string"
+ },
+ "include_program_participation_feedback": {
+ "type": "boolean"
+ },
+ "include_program_participation_feedback_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_program_participation_feedback_unit": {
+ "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"
+ },
+ "include_terms": {
+ "description": "Whether to include standard terms in the agreement.",
+ "type": "boolean"
+ },
+ "name": {
+ "description": "A name for the template.",
+ "type": "string"
+ },
+ "negotiations_allowed": {
+ "description": "Whether counterparties can propose changes to agreements created from this template.",
+ "type": "boolean"
+ },
+ "product_description": {
+ "type": "string"
+ },
+ "recipient_role": {
+ "description": "The label for the receiving party in the agreement.",
+ "type": "string"
+ },
+ "sender_last_to_sign": {
+ "description": "When true, the sender signs after the recipient.",
+ "type": "boolean"
+ },
+ "sender_role": {
+ "description": "The label for the sending party in the agreement.",
+ "type": "string"
+ },
+ "template_setting_attributes": {
+ "additionalProperties": false,
+ "description": "Template settings such as standard version and message.",
+ "properties": {
+ "include_message": {
+ "type": "boolean"
+ },
+ "message": {
+ "type": "string"
+ },
+ "standard_version": {
+ "type": "string"
+ },
+ "subsidiary_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"
+ }
+ },
+ "type": "object"
+ },
+ "term_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "term_unit": {
+ "type": "string"
+ },
+ "type": {
+ "description": "The type of template to create.",
+ "type": "string"
+ },
+ "version": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "type"
+ ],
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "additional_changes": {
+ "description": "Text of additional changes to include when include_additional_changes is true.",
+ "type": "string"
+ },
+ "attachment_ids": {
+ "description": "UUIDs of attachments to include with the template.",
+ "items": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "billing_workflow_type": {
+ "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"
+ },
+ "default_signer_email": {
+ "description": "Default email address pre-filled as the signer when creating agreements from this template.",
+ "format": "email",
+ "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "district_or_county": {
+ "description": "The district or county for dispute resolution.",
+ "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": {
+ "type": "string"
+ },
+ "general_cap_amount": {
+ "type": "number"
+ },
+ "general_cap_amount_type": {
+ "type": "string"
+ },
+ "general_cap_period_currency": {
+ "type": "number"
+ },
+ "general_cap_period_qty": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "general_cap_preceding_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "governing_law_country": {
+ "description": "The country whose laws govern agreements created from this template.",
+ "type": "string"
+ },
+ "governing_law_region": {
+ "description": "The state or region whose laws govern agreements created from this template.",
+ "type": "string"
+ },
+ "include_additional_changes": {
+ "description": "Whether to include the additional changes section.",
+ "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_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_billing_workflow": {
+ "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_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": {
+ "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_terms": {
+ "description": "Whether to include standard terms in the agreement.",
+ "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": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "increased_cap_amount_qty": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "increased_cap_amount_type": {
+ "type": "string"
+ },
+ "name": {
+ "description": "A name for the template.",
+ "type": "string"
+ },
+ "negotiations_allowed": {
+ "description": "Whether counterparties can propose changes to agreements created from this template.",
+ "type": "boolean"
+ },
+ "payment_link_url": {
+ "type": "string"
+ },
+ "recipient_role": {
+ "description": "The label for the receiving party in the agreement.",
+ "type": "string"
+ },
+ "sender_last_to_sign": {
+ "description": "When true, the sender signs after the recipient.",
+ "type": "boolean"
+ },
+ "sender_role": {
+ "description": "The label for the sending party in the agreement.",
+ "type": "string"
+ },
+ "stripe_invoice_delivery": {
+ "type": "string"
+ },
+ "stripe_payment_link_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"
+ },
+ "stripe_product_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"
+ },
+ "stripe_product_name": {
+ "type": "string"
+ },
+ "stripe_subsequent_bill_method": {
+ "type": "string"
+ },
+ "template_setting_attributes": {
+ "additionalProperties": false,
+ "description": "Template settings such as standard version and message.",
+ "properties": {
+ "include_message": {
+ "type": "boolean"
+ },
+ "message": {
+ "type": "string"
+ },
+ "standard_version": {
+ "type": "string"
+ },
+ "subsidiary_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"
+ }
+ },
+ "type": "object"
+ },
+ "template_software_license_order_form_attributes": {
+ "additionalProperties": false,
+ "description": "Nested software license order form defaults.",
+ "properties": {
+ "additional_changes": {
+ "description": "Text of additional changes to include when include_additional_changes is true.",
+ "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": {
+ "type": "string"
+ },
+ "fees_attributes": {
+ "items": {
+ "additionalProperties": false,
+ "properties": {
+ "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"
+ },
+ "cost": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "description": {
+ "type": "string"
+ },
+ "discount_duration_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "discount_duration_type": {
+ "type": "string"
+ },
+ "discount_type": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "graduated_fee_tiers_attributes": {
+ "items": {
+ "additionalProperties": false,
+ "properties": {
+ "flat_price": {
+ "type": "string"
+ },
+ "price_per_unit": {
+ "type": "string"
+ },
+ "upper_limit": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "quantity": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "stripe_product_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"
+ },
+ "type": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "fees_currency": {
+ "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": {
+ "type": "string"
+ },
+ "fees_inclusive_of_taxes": {
+ "type": "boolean"
+ },
+ "include_additional_changes": {
+ "description": "Whether to include the additional changes section.",
+ "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": {
+ "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": "Whether counterparties can propose changes to agreements created from this template.",
+ "type": "boolean"
+ },
+ "order_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"
+ },
+ "order_date_type": {
+ "type": "string"
+ },
+ "payment_process_automatic_frequency": {
+ "type": "string"
+ },
+ "payment_process_type": {
+ "type": "string"
+ },
+ "payment_process_type_custom_val": {
+ "type": "string"
+ },
+ "payment_process_type_invoice_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "payment_process_type_invoice_custom_unit": {
+ "type": "string"
+ },
+ "payment_process_type_invoice_duration": {
+ "type": "string"
+ },
+ "payment_process_type_invoice_duration_start": {
+ "type": "string"
+ },
+ "payment_process_type_invoice_type": {
+ "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": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "software_description": {
+ "type": "string"
+ },
+ "subscription_auto_renew": {
+ "type": "string"
+ },
+ "subscription_period": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "subscription_period_unit": {
+ "type": "string"
+ },
+ "subscription_renewal_notice_days": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "warranty_period_description_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "warranty_period_description_duration": {
+ "type": "string"
+ },
+ "warranty_period_description_duration_start": {
+ "type": "string"
+ },
+ "warranty_period_type": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "type": {
+ "description": "The type of template to create.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "type"
+ ],
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "additional_changes": {
+ "description": "Text of additional changes to include when include_additional_changes is true.",
+ "type": "string"
+ },
+ "additional_terms": {
+ "type": "string"
+ },
+ "attachment_ids": {
+ "description": "UUIDs of attachments to include with the template.",
+ "items": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "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"
+ },
+ "default_signer_email": {
+ "description": "Default email address pre-filled as the signer when creating agreements from this template.",
+ "format": "email",
+ "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "district_or_county": {
+ "description": "The district or county for dispute resolution.",
+ "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": {
+ "type": "string"
+ },
+ "fees_type": {
+ "type": "string"
+ },
+ "general_cap_amount": {
+ "type": "number"
+ },
+ "general_cap_amount_type": {
+ "type": "string"
+ },
+ "general_cap_period_currency": {
+ "type": "number"
+ },
+ "general_cap_period_qty": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "general_cap_preceding_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "governing_law_country": {
+ "description": "The country whose laws govern agreements created from this template.",
+ "type": "string"
+ },
+ "governing_law_region": {
+ "description": "The state or region whose laws govern agreements created from this template.",
+ "type": "string"
+ },
+ "include_additional_changes": {
+ "description": "Whether to include the additional changes section.",
+ "type": "boolean"
+ },
+ "include_additional_terms": {
+ "type": "boolean"
+ },
+ "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": {
+ "type": "string"
+ },
+ "include_payment_process": {
+ "type": "boolean"
+ },
+ "include_technical_support": {
+ "type": "boolean"
+ },
+ "include_terms": {
+ "description": "Whether to include standard terms in the agreement.",
+ "type": "boolean"
+ },
+ "name": {
+ "description": "A name for the template.",
+ "type": "string"
+ },
+ "negotiations_allowed": {
+ "description": "Whether counterparties can propose changes to agreements created from this template.",
+ "type": "boolean"
+ },
+ "payment_process_automatic_frequency": {
+ "type": "string"
+ },
+ "payment_process_invoice_days": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "payment_process_invoice_from": {
+ "type": "string"
+ },
+ "payment_process_invoice_timeframe": {
+ "type": "string"
+ },
+ "payment_process_type": {
+ "type": "string"
+ },
+ "pilot_period_description": {
+ "type": "string"
+ },
+ "pilot_period_fees_description": {
+ "type": "string"
+ },
+ "product_description": {
+ "type": "string"
+ },
+ "recipient_role": {
+ "description": "The label for the receiving party in the agreement.",
+ "type": "string"
+ },
+ "sender_last_to_sign": {
+ "description": "When true, the sender signs after the recipient.",
+ "type": "boolean"
+ },
+ "sender_role": {
+ "description": "The label for the sending party in the agreement.",
+ "type": "string"
+ },
+ "technical_support_description": {
+ "type": "string"
+ },
+ "template_setting_attributes": {
+ "additionalProperties": false,
+ "description": "Template settings such as standard version and message.",
+ "properties": {
+ "include_message": {
+ "type": "boolean"
+ },
+ "message": {
+ "type": "string"
+ },
+ "standard_version": {
+ "type": "string"
+ },
+ "subsidiary_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"
+ }
+ },
+ "type": "object"
+ },
+ "type": {
+ "description": "The type of template to create.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "type"
+ ],
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "additional_changes": {
+ "description": "Text of additional changes to include when include_additional_changes is true.",
+ "type": "string"
+ },
+ "attachment_ids": {
+ "description": "UUIDs of attachments to include with the template.",
+ "items": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "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"
+ },
+ "default_signer_email": {
+ "description": "Default email address pre-filled as the signer when creating agreements from this template.",
+ "format": "email",
+ "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "district_or_county": {
+ "description": "The district or county for dispute resolution.",
+ "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": {
+ "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": {
+ "type": "string"
+ },
+ "governing_law_country": {
+ "description": "The country whose laws govern agreements created from this template.",
+ "type": "string"
+ },
+ "governing_law_region": {
+ "description": "The state or region whose laws govern agreements created from this template.",
+ "type": "string"
+ },
+ "include_additional_changes": {
+ "description": "Whether to include the additional changes section.",
+ "type": "boolean"
+ },
+ "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": {
+ "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": {},
+ "include_increased_cap_amount_multiple": {},
+ "include_increased_cap_amount_type": {
+ "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_terms": {
+ "description": "Whether to include standard terms in the agreement.",
+ "type": "boolean"
+ },
+ "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"
+ },
+ "name": {
+ "description": "A name for the template.",
+ "type": "string"
+ },
+ "negotiations_allowed": {
+ "description": "Whether counterparties can propose changes to agreements created from this template.",
+ "type": "boolean"
+ },
+ "recipient_role": {
+ "description": "The label for the receiving party in the agreement.",
+ "type": "string"
+ },
+ "sender_last_to_sign": {
+ "description": "When true, the sender signs after the recipient.",
+ "type": "boolean"
+ },
+ "sender_role": {
+ "description": "The label for the sending party in the agreement.",
+ "type": "string"
+ },
+ "template_partnership_business_terms_attributes": {
+ "additionalProperties": false,
+ "description": "Nested partnership business terms defaults.",
+ "properties": {
+ "end_date_after_effective_date_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "end_date_after_effective_date_unit": {
+ "type": "string"
+ },
+ "end_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"
+ },
+ "end_date_type": {
+ "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": {
+ "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": {
+ "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": {
+ "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": {
+ "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": {
+ "format": "email",
+ "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "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": {
+ "format": "email",
+ "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "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": {
+ "type": "string"
+ },
+ "include_payment_schedule_specified_unit": {
+ "type": "string"
+ },
+ "include_payment_schedule_type": {
+ "type": "string"
+ },
+ "negotiations_allowed": {
+ "description": "Whether counterparties can propose changes to agreements created from this template.",
+ "type": "boolean"
+ },
+ "territory_type": {
+ "type": "string"
+ },
+ "territory_type_val": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "template_setting_attributes": {
+ "additionalProperties": false,
+ "description": "Template settings such as standard version and message.",
+ "properties": {
+ "include_message": {
+ "type": "boolean"
+ },
+ "message": {
+ "type": "string"
+ },
+ "standard_version": {
+ "type": "string"
+ },
+ "subsidiary_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"
+ }
+ },
+ "type": "object"
+ },
+ "type": {
+ "description": "The type of template to create.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "type"
+ ],
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "additional_changes": {
+ "description": "Text of additional changes to include when include_additional_changes is true.",
+ "type": "string"
+ },
+ "aggregation_limitations_permitted": {
+ "type": "boolean"
+ },
+ "aggregation_limitations_permitted_val": {
+ "type": "string"
+ },
+ "attachment_ids": {
+ "description": "UUIDs of attachments to include with the template.",
+ "items": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "breach_notification_unit": {
+ "type": "string"
+ },
+ "breach_notification_val": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "business_associate_relationship_type": {
+ "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"
+ },
+ "default_signer_email": {
+ "description": "Default email address pre-filled as the signer when creating agreements from this template.",
+ "format": "email",
+ "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "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"
+ },
+ "district_or_county": {
+ "description": "The district or county for dispute resolution.",
+ "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": {
+ "type": "string"
+ },
+ "governing_law_country": {
+ "description": "The country whose laws govern agreements created from this template.",
+ "type": "string"
+ },
+ "governing_law_region": {
+ "description": "The state or region whose laws govern agreements created from this template.",
+ "type": "string"
+ },
+ "include_additional_changes": {
+ "description": "Whether to include the additional changes section.",
+ "type": "boolean"
+ },
+ "include_aggregation_limitations": {
+ "type": "boolean"
+ },
+ "include_deidentification_limitations": {
+ "type": "boolean"
+ },
+ "include_limitations": {
+ "type": "boolean"
+ },
+ "include_offshore_limitations": {
+ "type": "boolean"
+ },
+ "include_subcontract_limitations": {
+ "type": "boolean"
+ },
+ "include_terms": {
+ "description": "Whether to include standard terms in the agreement.",
+ "type": "boolean"
+ },
+ "name": {
+ "description": "A name for the template.",
+ "type": "string"
+ },
+ "negotiations_allowed": {
+ "description": "Whether counterparties can propose changes to agreements created from this template.",
+ "type": "boolean"
+ },
+ "offshore_limitations_permitted": {
+ "type": "boolean"
+ },
+ "offshore_limitations_permitted_val": {
+ "type": "string"
+ },
+ "recipient_role": {
+ "description": "The label for the receiving party in the agreement.",
+ "type": "string"
+ },
+ "sender_last_to_sign": {
+ "description": "When true, the sender signs after the recipient.",
+ "type": "boolean"
+ },
+ "sender_role": {
+ "description": "The label for the sending party in the agreement.",
+ "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"
+ },
+ "template_setting_attributes": {
+ "additionalProperties": false,
+ "description": "Template settings such as standard version and message.",
+ "properties": {
+ "include_message": {
+ "type": "boolean"
+ },
+ "message": {
+ "type": "string"
+ },
+ "standard_version": {
+ "type": "string"
+ },
+ "subsidiary_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"
+ }
+ },
+ "type": "object"
+ },
+ "type": {
+ "description": "The type of template to create.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "type"
+ ],
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "additional_changes": {
+ "description": "Text of additional changes to include when include_additional_changes is true.",
+ "type": "string"
+ },
+ "attachment_ids": {
+ "description": "UUIDs of attachments to include with the template.",
+ "items": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "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"
+ },
+ "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": {
+ "type": "string"
+ },
+ "confidentiality_type": {
+ "type": "string"
+ },
+ "default_signer_email": {
+ "description": "Default email address pre-filled as the signer when creating agreements from this template.",
+ "format": "email",
+ "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "district_or_county": {
+ "description": "The district or county for dispute resolution.",
+ "type": "string"
+ },
+ "governing_law_country": {
+ "description": "The country whose laws govern agreements created from this template.",
+ "type": "string"
+ },
+ "governing_law_region": {
+ "description": "The state or region whose laws govern agreements created from this template.",
+ "type": "string"
+ },
+ "include_additional_changes": {
+ "description": "Whether to include the additional changes section.",
+ "type": "boolean"
+ },
+ "include_custom_details": {
+ "type": "boolean"
+ },
+ "include_custom_details_val": {
+ "type": "string"
+ },
+ "include_fees": {
+ "type": "boolean"
+ },
+ "include_fees_amount": {
+ "type": "number"
+ },
+ "include_fees_amount_duration": {
+ "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": {
+ "type": "string"
+ },
+ "include_terms": {
+ "description": "Whether to include standard terms in the agreement.",
+ "type": "boolean"
+ },
+ "name": {
+ "description": "A name for the template.",
+ "type": "string"
+ },
+ "negotiations_allowed": {
+ "description": "Whether counterparties can propose changes to agreements created from this template.",
+ "type": "boolean"
+ },
+ "product_name": {
+ "type": "string"
+ },
+ "recipient_role": {
+ "description": "The label for the receiving party in the agreement.",
+ "type": "string"
+ },
+ "sender_last_to_sign": {
+ "description": "When true, the sender signs after the recipient.",
+ "type": "boolean"
+ },
+ "sender_role": {
+ "description": "The label for the sending party in the agreement.",
+ "type": "string"
+ },
+ "template_setting_attributes": {
+ "additionalProperties": false,
+ "description": "Template settings such as standard version and message.",
+ "properties": {
+ "include_message": {
+ "type": "boolean"
+ },
+ "message": {
+ "type": "string"
+ },
+ "standard_version": {
+ "type": "string"
+ },
+ "subsidiary_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"
+ }
+ },
+ "type": "object"
+ },
+ "type": {
+ "description": "The type of template to create.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "type"
+ ],
+ "type": "object"
+ }
+]update-template1 field changedInput schema / properties / body / anyOfPrevious value: -[
- {
- "additionalProperties": false,
- "properties": {
- "additional_changes": {
- "description": "Text of additional changes to include when include_additional_changes is true.",
- "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"
- },
- "confidentiality_period": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "confidentiality_period_perpetual": {
- "type": "boolean"
- },
- "default_signer_email": {
- "description": "Default email address pre-filled as the signer when creating agreements from this template.",
- "format": "email",
- "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
- "type": "string"
- },
- "district_or_county": {
- "description": "The district or county for dispute resolution.",
- "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_of_confidentiality": {
- "type": "string"
- },
- "effective_date_type": {
- "type": "string"
- },
- "governing_law_country": {
- "description": "The country whose laws govern agreements created from this template.",
- "type": "string"
- },
- "governing_law_region": {
- "description": "The state or region whose laws govern agreements created from this template.",
- "type": "string"
- },
- "include_additional_changes": {
- "description": "Whether to include the additional changes section.",
- "type": "boolean"
- },
- "include_terms": {
- "description": "Whether to include standard terms in the agreement.",
- "type": "boolean"
- },
- "name": {
- "description": "A name for the template.",
- "type": "string"
- },
- "negotiations_allowed": {
- "description": "Whether counterparties can propose changes to agreements created from this template.",
- "type": "boolean"
- },
- "purpose": {
- "type": "string"
- },
- "recipient_role": {
- "description": "The label for the receiving party in the agreement.",
- "type": "string"
- },
- "sender_last_to_sign": {
- "description": "When true, the sender signs after the recipient.",
- "type": "boolean"
- },
- "sender_role": {
- "description": "The label for the sending party in the agreement.",
- "type": "string"
- },
- "template_setting_attributes": {
- "additionalProperties": false,
- "description": "Template settings such as standard version and message.",
- "properties": {
- "include_message": {
- "type": "boolean"
- },
- "message": {
- "type": "string"
- },
- "standard_version": {
- "type": "string"
- },
- "subsidiary_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"
- }
- },
- "type": "object"
- },
- "term": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "term_period_perpetual": {
- "type": "boolean"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "additional_changes": {
- "description": "Text of additional changes to include when include_additional_changes is true.",
- "type": "string"
- },
- "attachment_ids": {
- "description": "UUIDs of attachments to include with the template.",
- "items": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "type": "array"
- },
- "billing_workflow_type": {
- "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"
- },
- "customer_description": {
- "type": "string"
- },
- "default_signer_email": {
- "description": "Default email address pre-filled as the signer when creating agreements from this template.",
- "format": "email",
- "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
- "type": "string"
- },
- "district_or_county": {
- "description": "The district or county for dispute resolution.",
- "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": {
- "type": "string"
- },
- "effective_date_type": {
- "type": "string"
- },
- "general_cap_amount": {
- "type": "number"
- },
- "general_cap_amount_type": {
- "type": "string"
- },
- "general_cap_period_currency": {
- "type": "number"
- },
- "general_cap_period_qty": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "general_cap_preceding_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "governing_law_country": {
- "description": "The country whose laws govern agreements created from this template.",
- "type": "string"
- },
- "governing_law_region": {
- "description": "The state or region whose laws govern agreements created from this template.",
- "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": "boolean"
- },
- "include_acceptable_use_policy_type": {
- "type": "string"
- },
- "include_additional_changes": {
- "description": "Whether to include the additional changes section.",
- "type": "boolean"
- },
- "include_additional_warranties": {
- "type": "boolean"
- },
- "include_additional_warranties_by_customer": {
- "type": "boolean"
- },
- "include_additional_warranties_by_provider": {
- "type": "boolean"
- },
- "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_billing_workflow": {
- "type": "boolean"
- },
- "include_covered_claims": {
- "type": "boolean"
- },
- "include_covered_claims_customer_claims": {
- "type": "boolean"
- },
- "include_covered_claims_include_customer_claims": {
- "type": "boolean"
- },
- "include_covered_claims_include_provider_claims": {
- "type": "boolean"
- },
- "include_covered_claims_provider_claims": {
- "type": "boolean"
- },
- "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": "boolean"
- },
- "include_dpa_type": {
- "type": "string"
- },
- "include_increased_cap_amount": {
- "type": "number"
- },
- "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": "boolean"
- },
- "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": "boolean"
- },
- "include_insurance_minimums_cyber_liability_aggregate": {
- "type": "boolean"
- },
- "include_insurance_minimums_cyber_liability_minimum": {
- "type": "boolean"
- },
- "include_insurance_minimums_employer_liability_aggregate": {
- "type": "boolean"
- },
- "include_insurance_minimums_employer_liability_minimum": {
- "type": "boolean"
- },
- "include_insurance_minimums_general_liability_aggregate": {
- "type": "boolean"
- },
- "include_insurance_minimums_general_liability_minimum": {
- "type": "boolean"
- },
- "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": {
- "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": "boolean"
- },
- "include_security_policy_other": {
- "type": "boolean"
- },
- "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": {
- "type": "string"
- },
- "include_terms": {
- "description": "Whether to include standard terms in the agreement.",
- "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": "boolean"
- },
- "increased_cap_amount_currency": {
- "type": "number"
- },
- "increased_cap_amount_period_currency": {
- "type": "number"
- },
- "increased_cap_amount_period_qty": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "increased_cap_amount_qty": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "increased_cap_amount_type": {
- "type": "string"
- },
- "name": {
- "description": "A name for the template.",
- "type": "string"
- },
- "negotiations_allowed": {
- "description": "Whether counterparties can propose changes to agreements created from this template.",
- "type": "boolean"
- },
- "payment_link_url": {
- "type": "string"
- },
- "provider": {
- "type": "string"
- },
- "recipient_role": {
- "description": "The label for the receiving party in the agreement.",
- "type": "string"
- },
- "sender_last_to_sign": {
- "description": "When true, the sender signs after the recipient.",
- "type": "boolean"
- },
- "sender_role": {
- "description": "The label for the sending party in the agreement.",
- "type": "string"
- },
- "stripe_invoice_delivery": {
- "type": "string"
- },
- "stripe_payment_link_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"
- },
- "stripe_product_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"
- },
- "stripe_product_name": {
- "type": "string"
- },
- "stripe_subsequent_bill_method": {
- "type": "string"
- },
- "template_csa_order_form_attributes": {
- "additionalProperties": false,
- "description": "Nested CSA order form defaults. See Template Parameters docs for CSA Order Form.",
- "properties": {
- "additional_changes": {
- "description": "Text of additional changes to include when include_additional_changes is true.",
- "type": "string"
- },
- "additional_parameters_or_limitations": {
- "type": "string"
- },
- "affiliates_as_users": {
- "type": "string"
- },
- "cloud_service_description": {
- "type": "string"
- },
- "consumption_units": {
- "type": "string"
- },
- "fee_amount": {
- "type": "number"
- },
- "fee_custom_unit": {
- "type": "string"
- },
- "fee_period": {
- "type": "string"
- },
- "fees_attributes": {
- "items": {
- "additionalProperties": false,
- "properties": {
- "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"
- },
- "cost": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "description": {
- "type": "string"
- },
- "discount_duration_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "discount_duration_type": {
- "type": "string"
- },
- "discount_type": {
- "type": "string"
- },
- "fee_type": {
- "type": "string"
- },
- "graduated_fee_tiers_attributes": {
- "items": {
- "additionalProperties": false,
- "properties": {
- "flat_price": {
- "type": "string"
- },
- "price_per_unit": {
- "type": "string"
- },
- "upper_limit": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- }
- },
- "type": "object"
- },
- "type": "array"
- },
- "quantity": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "stripe_product_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"
- },
- "type": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "type": "array"
- },
- "fees_currency": {
- "type": "number"
- },
- "fees_include_fee_increase_upon_renewal": {
- "type": "boolean"
- },
- "fees_include_fee_increase_upon_renewal_fee": {
- "type": "number"
- },
- "fees_include_fee_increase_upon_renewal_type": {
- "type": "string"
- },
- "fees_inclusive_of_taxes": {
- "type": "string"
- },
- "free_trial_days": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_additional_changes": {
- "description": "Whether to include the additional changes section.",
- "type": "boolean"
- },
- "include_additional_parameters_or_limitations": {
- "type": "boolean"
- },
- "include_billing_info": {
- "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": "number"
- },
- "include_fees_table": {
- "type": "boolean"
- },
- "include_fees_table_period": {
- "type": "boolean"
- },
- "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": {
- "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": {
- "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": "boolean"
- },
- "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": "string"
- },
- "include_professional_services_include_fees_description": {
- "type": "string"
- },
- "include_professional_services_type": {
- "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": "string"
- },
- "include_sla_include_response_time_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_sla_include_response_time_credit": {
- "type": "string"
- },
- "include_sla_include_response_time_duration": {
- "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": {
- "type": "string"
- },
- "include_sla_standard_maintenance_notice_qty": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_sla_standard_maintenance_notice_unit": {
- "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": "boolean"
- },
- "include_sla_standard_maintenance_window_tuesday": {
- "type": "boolean"
- },
- "include_sla_standard_maintenance_window_wednesday": {
- "type": "boolean"
- },
- "include_sla_standard_target_uptime": {
- "type": "boolean"
- },
- "include_sla_type": {
- "type": "string"
- },
- "include_subscription_start_date": {
- "type": "string"
- },
- "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": "number"
- },
- "include_use_limitations": {
- "type": "boolean"
- },
- "include_use_limitations_val": {
- "type": "number"
- },
- "invoice_period": {
- "type": "string"
- },
- "invoice_period_custom_unit": {
- "type": "string"
- },
- "max_consumption": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "max_users": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "negotiations_allowed": {
- "description": "Whether counterparties can propose changes to agreements created from this template.",
- "type": "boolean"
- },
- "order_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"
- },
- "order_date_other": {
- "type": "string"
- },
- "order_date_type": {
- "type": "string"
- },
- "payment_period": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "payment_period_timeframe": {
- "type": "string"
- },
- "payment_period_unit": {
- "type": "string"
- },
- "payment_process_automatic_frequency": {
- "type": "string"
- },
- "payment_process_type": {
- "type": "string"
- },
- "payment_process_type_custom_val": {
- "type": "number"
- },
- "payment_process_type_invoice_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "payment_process_type_invoice_custom_unit": {
- "type": "string"
- },
- "payment_process_type_invoice_duration": {
- "type": "string"
- },
- "payment_process_type_invoice_duration_start": {
- "type": "string"
- },
- "payment_process_type_invoice_type": {
- "type": "string"
- },
- "pilot_period_stripe_product_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"
- },
- "service_credits_attributes": {
- "items": {
- "additionalProperties": false,
- "properties": {
- "credit": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "max": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "min": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- }
- },
- "type": "object"
- },
- "type": "array"
- },
- "subscription_auto_renew": {
- "type": "string"
- },
- "subscription_period": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "subscription_period_unit": {
- "type": "string"
- },
- "subscription_renewal_notice_days": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "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": {
- "type": "string"
- },
- "use_limitations_attributes": {
- "items": {
- "additionalProperties": false,
- "properties": {
- "amount": {
- "type": "string"
- },
- "limitation_type": {
- "type": "string"
- },
- "unit": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "type": "array"
- }
- },
- "type": "object"
- },
- "template_setting_attributes": {
- "additionalProperties": false,
- "description": "Template settings such as standard version and message.",
- "properties": {
- "include_message": {
- "type": "boolean"
- },
- "message": {
- "type": "string"
- },
- "standard_version": {
- "type": "string"
- },
- "subsidiary_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"
- }
- },
- "type": "object"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "additional_changes": {
- "description": "Text of additional changes to include when include_additional_changes is true.",
- "type": "string"
- },
- "approved_subprocessor_type": {
- "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"
- },
- "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": {
- "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"
- },
- "default_signer_email": {
- "description": "Default email address pre-filled as the signer when creating agreements from this template.",
- "format": "email",
- "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
- "type": "string"
- },
- "district_or_county": {
- "description": "The district or county for dispute resolution.",
- "type": "string"
- },
- "duration_of_processing": {
- "type": "string"
- },
- "governing_law_country": {
- "description": "The country whose laws govern agreements created from this template.",
- "type": "string"
- },
- "governing_law_region": {
- "description": "The state or region whose laws govern agreements created from this template.",
- "type": "string"
- },
- "include_additional_changes": {
- "description": "Whether to include the additional changes section.",
- "type": "boolean"
- },
- "include_covered_claim": {
- "type": "boolean"
- },
- "include_covered_claim_external_val": {
- "type": "number"
- },
- "include_covered_claim_internal_val": {
- "type": "number"
- },
- "include_covered_claim_type": {
- "type": "string"
- },
- "include_data_subjects_custom": {
- "type": "string"
- },
- "include_data_subjects_custom_val": {
- "type": "number"
- },
- "include_data_subjects_employees": {
- "type": "boolean"
- },
- "include_data_subjects_end_users": {
- "type": "boolean"
- },
- "include_external_subprocessor_location": {
- "type": "boolean"
- },
- "include_frequency_of_transfer_continuous": {
- "type": "boolean"
- },
- "include_frequency_of_transfer_custom": {
- "type": "string"
- },
- "include_frequency_of_transfer_custom_val": {
- "type": "number"
- },
- "include_governing_country_eu": {
- "type": "boolean"
- },
- "include_governing_country_eu_val": {
- "type": "number"
- },
- "include_governing_country_uk": {
- "type": "boolean"
- },
- "include_governing_country_uk_val": {
- "type": "number"
- },
- "include_governing_law": {
- "type": "boolean"
- },
- "include_governing_law_country": {
- "type": "boolean"
- },
- "include_governing_law_state": {
- "type": "boolean"
- },
- "include_increased_claim_amount": {
- "type": "number"
- },
- "include_increased_claim_amount_currency": {
- "type": "boolean"
- },
- "include_increased_claim_amount_qty": {
- "type": "number"
- },
- "include_increased_claim_amount_type": {
- "type": "string"
- },
- "include_liability_cap": {
- "type": "boolean"
- },
- "include_liability_cap_amount_constant_external": {
- "type": "boolean"
- },
- "include_liability_cap_amount_constant_internal": {
- "type": "boolean"
- },
- "include_liability_cap_amount_currency_external": {
- "type": "boolean"
- },
- "include_liability_cap_amount_currency_internal": {
- "type": "boolean"
- },
- "include_liability_cap_csa_type": {
- "type": "string"
- },
- "include_personal_data_biographic_info": {
- "type": "boolean"
- },
- "include_personal_data_contact_info": {
- "type": "boolean"
- },
- "include_personal_data_custom": {
- "type": "string"
- },
- "include_personal_data_custom_val": {
- "type": "number"
- },
- "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": "string"
- },
- "include_processing_purpose_custom_val": {
- "type": "number"
- },
- "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": "boolean"
- },
- "include_provider_security_contact_address_country": {
- "type": "boolean"
- },
- "include_provider_security_contact_address_state": {
- "type": "boolean"
- },
- "include_provider_security_contact_address_street_address": {
- "type": "boolean"
- },
- "include_provider_security_contact_address_zipcode": {
- "type": "boolean"
- },
- "include_provider_security_contact_email": {
- "format": "email",
- "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
- "type": "string"
- },
- "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-z]{2,}$",
- "type": "string"
- },
- "include_security_measures_accountability": {
- "type": "boolean"
- },
- "include_security_measures_accountability_val": {
- "type": "number"
- },
- "include_security_measures_certification_or_assurance": {
- "type": "boolean"
- },
- "include_security_measures_certification_or_assurance_val": {
- "type": "number"
- },
- "include_security_measures_confidentiality_integrity": {
- "type": "boolean"
- },
- "include_security_measures_confidentiality_integrity_val": {
- "type": "number"
- },
- "include_security_measures_data_at_rest": {
- "type": "boolean"
- },
- "include_security_measures_data_at_rest_val": {
- "type": "number"
- },
- "include_security_measures_data_minimization": {
- "type": "boolean"
- },
- "include_security_measures_data_minimization_val": {
- "type": "number"
- },
- "include_security_measures_data_quality": {
- "type": "boolean"
- },
- "include_security_measures_data_quality_val": {
- "type": "number"
- },
- "include_security_measures_data_retention": {
- "type": "boolean"
- },
- "include_security_measures_data_retention_val": {
- "type": "number"
- },
- "include_security_measures_data_transmission": {
- "type": "boolean"
- },
- "include_security_measures_data_transmission_val": {
- "type": "number"
- },
- "include_security_measures_event_logging": {
- "type": "boolean"
- },
- "include_security_measures_event_logging_val": {
- "type": "number"
- },
- "include_security_measures_identity_auth": {
- "type": "boolean"
- },
- "include_security_measures_identity_auth_val": {
- "type": "number"
- },
- "include_security_measures_it_security_governance": {
- "type": "boolean"
- },
- "include_security_measures_it_security_governance_val": {
- "type": "number"
- },
- "include_security_measures_physical_security": {
- "type": "boolean"
- },
- "include_security_measures_physical_security_val": {
- "type": "number"
- },
- "include_security_measures_portability_and_erasure": {
- "type": "boolean"
- },
- "include_security_measures_portability_and_erasure_val": {
- "type": "number"
- },
- "include_security_measures_pseudonym_encryption": {
- "type": "boolean"
- },
- "include_security_measures_pseudonym_encryption_val": {
- "type": "number"
- },
- "include_security_measures_restore_data_access": {
- "type": "boolean"
- },
- "include_security_measures_restore_data_access_val": {
- "type": "number"
- },
- "include_security_measures_security_policy": {
- "type": "boolean"
- },
- "include_security_measures_system_configuration": {
- "type": "boolean"
- },
- "include_security_measures_system_configuration_val": {
- "type": "number"
- },
- "include_security_measures_testing_assessment": {
- "type": "boolean"
- },
- "include_security_measures_testing_assessment_val": {
- "type": "number"
- },
- "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": "boolean"
- },
- "include_security_policy_pci1": {
- "type": "boolean"
- },
- "include_security_policy_pci2": {
- "type": "boolean"
- },
- "include_security_policy_penetration_testing": {
- "type": "boolean"
- },
- "include_security_policy_provider": {
- "type": "boolean"
- },
- "include_security_policy_soc2": {
- "type": "boolean"
- },
- "include_security_policy_soc2_type2": {
- "type": "boolean"
- },
- "include_sensitive_data_restrictions_custom": {
- "type": "string"
- },
- "include_sensitive_data_restrictions_custom_val": {
- "type": "number"
- },
- "include_sensitive_data_restrictions_security_policy": {
- "type": "boolean"
- },
- "include_service_provider_relationship": {
- "type": "boolean"
- },
- "include_special_category_data": {
- "type": "boolean"
- },
- "include_terms": {
- "description": "Whether to include standard terms in the agreement.",
- "type": "boolean"
- },
- "name": {
- "description": "A name for the template.",
- "type": "string"
- },
- "negotiations_allowed": {
- "description": "Whether counterparties can propose changes to agreements created from this template.",
- "type": "boolean"
- },
- "provider": {
- "type": "string"
- },
- "recipient_role": {
- "description": "The label for the receiving party in the agreement.",
- "type": "string"
- },
- "security_policy_available_at": {
- "type": "string"
- },
- "security_policy_type": {
- "type": "string"
- },
- "sender_last_to_sign": {
- "description": "When true, the sender signs after the recipient.",
- "type": "boolean"
- },
- "sender_role": {
- "description": "The label for the sending party in the agreement.",
- "type": "string"
- },
- "subprocessors_attributes": {
- "description": "List of subprocessors. Each item may include name, country, and processing_task.",
- "items": {
- "additionalProperties": false,
- "properties": {
- "country": {
- "type": "string"
- },
- "name": {
- "description": "A name for the template.",
- "type": "string"
- },
- "processing_task": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "type": "array"
- },
- "template_setting_attributes": {
- "additionalProperties": false,
- "description": "Template settings such as standard version and message.",
- "properties": {
- "include_message": {
- "type": "boolean"
- },
- "message": {
- "type": "string"
- },
- "standard_version": {
- "type": "string"
- },
- "subsidiary_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"
- }
- },
- "type": "object"
- },
- "underlying_agreement_val": {
- "type": "number"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "additional_changes": {
- "description": "Text of additional changes to include when include_additional_changes is true.",
- "type": "string"
- },
- "attachment_ids": {
- "description": "UUIDs of attachments to include with the template.",
- "items": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "type": "array"
- },
- "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"
- },
- "default_signer_email": {
- "description": "Default email address pre-filled as the signer when creating agreements from this template.",
- "format": "email",
- "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
- "type": "string"
- },
- "district_or_county": {
- "description": "The district or county for dispute resolution.",
- "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": {
- "type": "string"
- },
- "general_cap_amount": {
- "type": "number"
- },
- "general_cap_amount_type": {
- "type": "string"
- },
- "general_cap_period_currency": {
- "type": "number"
- },
- "general_cap_period_qty": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "general_cap_preceding_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "governing_law_country": {
- "description": "The country whose laws govern agreements created from this template.",
- "type": "string"
- },
- "governing_law_region": {
- "description": "The state or region whose laws govern agreements created from this template.",
- "type": "string"
- },
- "include_additional_changes": {
- "description": "Whether to include the additional changes section.",
- "type": "boolean"
- },
- "include_additional_warranties": {
- "type": "boolean"
- },
- "include_additional_warranties_by_customer": {
- "type": "boolean"
- },
- "include_additional_warranties_by_provider": {
- "type": "boolean"
- },
- "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": "boolean"
- },
- "include_covered_claims_include_customer_claims": {
- "type": "boolean"
- },
- "include_covered_claims_include_provider_claims": {
- "type": "boolean"
- },
- "include_covered_claims_provider_claims": {
- "type": "boolean"
- },
- "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": "boolean"
- },
- "include_customer_insurance_min_auto_liability_minimum": {
- "type": "boolean"
- },
- "include_customer_insurance_min_cyber_liability_aggregate": {
- "type": "boolean"
- },
- "include_customer_insurance_min_cyber_liability_minimum": {
- "type": "boolean"
- },
- "include_customer_insurance_min_employer_liability_aggregate": {
- "type": "boolean"
- },
- "include_customer_insurance_min_employer_liability_minimum": {
- "type": "boolean"
- },
- "include_customer_insurance_min_general_liability_aggregate": {
- "type": "boolean"
- },
- "include_customer_insurance_min_general_liability_minimum": {
- "type": "boolean"
- },
- "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": "boolean"
- },
- "include_customer_policies_type": {
- "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": "boolean"
- },
- "include_dpa_type": {
- "type": "string"
- },
- "include_increased_cap_amount": {
- "type": "number"
- },
- "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": "boolean"
- },
- "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": "boolean"
- },
- "include_provider_insurance_min_auto_liability_minimum": {
- "type": "boolean"
- },
- "include_provider_insurance_min_cyber_liability_aggregate": {
- "type": "boolean"
- },
- "include_provider_insurance_min_cyber_liability_minimum": {
- "type": "boolean"
- },
- "include_provider_insurance_min_employer_liability_aggregate": {
- "type": "boolean"
- },
- "include_provider_insurance_min_employer_liability_minimum": {
- "type": "boolean"
- },
- "include_provider_insurance_min_general_liability_aggregate": {
- "type": "boolean"
- },
- "include_provider_insurance_min_general_liability_minimum": {
- "type": "boolean"
- },
- "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": {
- "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": "number"
- },
- "include_security_policy_iso27001": {
- "type": "boolean"
- },
- "include_security_policy_location": {
- "type": "boolean"
- },
- "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": {
- "type": "string"
- },
- "include_terms": {
- "description": "Whether to include standard terms in the agreement.",
- "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_negligence": {
- "type": "boolean"
- },
- "include_unlimited_claims_other": {
- "type": "boolean"
- },
- "increased_cap_amount_currency": {
- "type": "number"
- },
- "increased_cap_amount_period_currency": {
- "type": "number"
- },
- "increased_cap_amount_period_qty": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "increased_cap_amount_qty": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "increased_cap_amount_type": {
- "type": "string"
- },
- "name": {
- "description": "A name for the template.",
- "type": "string"
- },
- "negotiations_allowed": {
- "description": "Whether counterparties can propose changes to agreements created from this template.",
- "type": "boolean"
- },
- "recipient_role": {
- "description": "The label for the receiving party in the agreement.",
- "type": "string"
- },
- "sender_last_to_sign": {
- "description": "When true, the sender signs after the recipient.",
- "type": "boolean"
- },
- "sender_role": {
- "description": "The label for the sending party in the agreement.",
- "type": "string"
- },
- "template_psa_statement_of_work_attributes": {
- "additionalProperties": false,
- "description": "Nested PSA statement of work defaults.",
- "properties": {
- "additional_changes": {
- "description": "Text of additional changes to include when include_additional_changes is true.",
- "type": "string"
- },
- "fees_attributes": {
- "items": {
- "additionalProperties": false,
- "properties": {
- "cost": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "description": {
- "type": "string"
- },
- "fee_type": {
- "type": "string"
- },
- "quantity": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- }
- },
- "type": "object"
- },
- "type": "array"
- },
- "include_additional_changes": {
- "description": "Whether to include the additional changes section.",
- "type": "boolean"
- },
- "include_customer_obligation": {
- "type": "boolean"
- },
- "include_customer_obligation_val": {
- "type": "number"
- },
- "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": {
- "type": "string"
- },
- "include_deliverables_resubmission_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_deliverables_resubmission_unit": {
- "type": "string"
- },
- "include_fees_other": {
- "type": "boolean"
- },
- "include_fees_other_val": {
- "type": "number"
- },
- "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": {
- "type": "string"
- },
- "include_fees_travel_val": {
- "type": "number"
- },
- "include_third_party_customer": {
- "type": "boolean"
- },
- "include_third_party_include_description": {
- "type": "string"
- },
- "include_third_party_include_description_val": {
- "type": "number"
- },
- "include_third_party_materials": {
- "type": "boolean"
- },
- "include_third_party_provider": {
- "type": "boolean"
- },
- "include_time_of_assignment": {
- "type": "boolean"
- },
- "include_time_of_assignment_type": {
- "type": "string"
- },
- "invoice_period_description": {
- "type": "string"
- },
- "negotiations_allowed": {
- "description": "Whether counterparties can propose changes to agreements created from this template.",
- "type": "boolean"
- },
- "payment_period": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "payment_period_other": {
- "type": "string"
- },
- "payment_period_timeframe": {
- "type": "string"
- },
- "payment_period_type": {
- "type": "string"
- },
- "payment_period_unit": {
- "type": "string"
- },
- "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": {
- "type": "string"
- },
- "sow_term_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "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": {
- "type": "string"
- },
- "sow_term_unit": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "template_setting_attributes": {
- "additionalProperties": false,
- "description": "Template settings such as standard version and message.",
- "properties": {
- "include_message": {
- "type": "boolean"
- },
- "message": {
- "type": "string"
- },
- "standard_version": {
- "type": "string"
- },
- "subsidiary_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"
- }
- },
- "type": "object"
- },
- "version": {
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "additional_changes": {
- "description": "Text of additional changes to include when include_additional_changes is true.",
- "type": "string"
- },
- "attachment_ids": {
- "description": "UUIDs of attachments to include with the template.",
- "items": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "type": "array"
- },
- "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"
- },
- "customer_description": {
- "type": "string"
- },
- "default_signer_email": {
- "description": "Default email address pre-filled as the signer when creating agreements from this template.",
- "format": "email",
- "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
- "type": "string"
- },
- "district_or_county": {
- "description": "The district or county for dispute resolution.",
- "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": {
- "type": "string"
- },
- "governing_law_country": {
- "description": "The country whose laws govern agreements created from this template.",
- "type": "string"
- },
- "governing_law_region": {
- "description": "The state or region whose laws govern agreements created from this template.",
- "type": "string"
- },
- "include_additional_changes": {
- "description": "Whether to include the additional changes section.",
- "type": "boolean"
- },
- "include_fees": {
- "type": "boolean"
- },
- "include_fees_amount": {
- "type": "number"
- },
- "include_fees_description": {
- "type": "string"
- },
- "include_fees_pay_by_amount": {
- "type": "number"
- },
- "include_fees_type": {
- "type": "string"
- },
- "include_fees_unit": {
- "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": "number"
- },
- "include_program_discount": {
- "type": "boolean"
- },
- "include_program_discount_amount": {
- "type": "number"
- },
- "include_program_discount_unit": {
- "type": "string"
- },
- "include_program_participation_feedback": {
- "type": "boolean"
- },
- "include_program_participation_feedback_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_program_participation_feedback_unit": {
- "type": "string"
- },
- "include_program_partner_other": {
- "type": "boolean"
- },
- "include_program_partner_other_val": {
- "type": "number"
- },
- "include_program_provider_other": {
- "type": "boolean"
- },
- "include_program_provider_other_val": {
- "type": "number"
- },
- "include_program_reference": {
- "type": "boolean"
- },
- "include_terms": {
- "description": "Whether to include standard terms in the agreement.",
- "type": "boolean"
- },
- "name": {
- "description": "A name for the template.",
- "type": "string"
- },
- "negotiations_allowed": {
- "description": "Whether counterparties can propose changes to agreements created from this template.",
- "type": "boolean"
- },
- "product_description": {
- "type": "string"
- },
- "recipient_role": {
- "description": "The label for the receiving party in the agreement.",
- "type": "string"
- },
- "sender_last_to_sign": {
- "description": "When true, the sender signs after the recipient.",
- "type": "boolean"
- },
- "sender_role": {
- "description": "The label for the sending party in the agreement.",
- "type": "string"
- },
- "template_setting_attributes": {
- "additionalProperties": false,
- "description": "Template settings such as standard version and message.",
- "properties": {
- "include_message": {
- "type": "boolean"
- },
- "message": {
- "type": "string"
- },
- "standard_version": {
- "type": "string"
- },
- "subsidiary_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"
- }
- },
- "type": "object"
- },
- "term_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "term_unit": {
- "type": "string"
- },
- "version": {
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "additional_changes": {
- "description": "Text of additional changes to include when include_additional_changes is true.",
- "type": "string"
- },
- "attachment_ids": {
- "description": "UUIDs of attachments to include with the template.",
- "items": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "type": "array"
- },
- "billing_workflow_type": {
- "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"
- },
- "default_signer_email": {
- "description": "Default email address pre-filled as the signer when creating agreements from this template.",
- "format": "email",
- "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
- "type": "string"
- },
- "district_or_county": {
- "description": "The district or county for dispute resolution.",
- "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": {
- "type": "string"
- },
- "general_cap_amount": {
- "type": "number"
- },
- "general_cap_amount_type": {
- "type": "string"
- },
- "general_cap_period_currency": {
- "type": "number"
- },
- "general_cap_period_qty": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "general_cap_preceding_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "governing_law_country": {
- "description": "The country whose laws govern agreements created from this template.",
- "type": "string"
- },
- "governing_law_region": {
- "description": "The state or region whose laws govern agreements created from this template.",
- "type": "string"
- },
- "include_additional_changes": {
- "description": "Whether to include the additional changes section.",
- "type": "boolean"
- },
- "include_additional_warranties": {
- "type": "boolean"
- },
- "include_additional_warranties_by_customer": {
- "type": "boolean"
- },
- "include_additional_warranties_by_provider": {
- "type": "boolean"
- },
- "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_billing_workflow": {
- "type": "boolean"
- },
- "include_covered_claims": {
- "type": "boolean"
- },
- "include_covered_claims_customer_claims": {
- "type": "boolean"
- },
- "include_covered_claims_include_customer_claims": {
- "type": "boolean"
- },
- "include_covered_claims_include_provider_claims": {
- "type": "boolean"
- },
- "include_covered_claims_provider_claims": {
- "type": "boolean"
- },
- "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": "boolean"
- },
- "include_dpa_type": {
- "type": "string"
- },
- "include_increased_cap_amount": {
- "type": "number"
- },
- "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": "boolean"
- },
- "include_increased_claims_restrictions": {
- "type": "boolean"
- },
- "include_terms": {
- "description": "Whether to include standard terms in the agreement.",
- "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": "boolean"
- },
- "increased_cap_amount_currency": {
- "type": "number"
- },
- "increased_cap_amount_period_currency": {
- "type": "number"
- },
- "increased_cap_amount_period_qty": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "increased_cap_amount_qty": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "increased_cap_amount_type": {
- "type": "string"
- },
- "name": {
- "description": "A name for the template.",
- "type": "string"
- },
- "negotiations_allowed": {
- "description": "Whether counterparties can propose changes to agreements created from this template.",
- "type": "boolean"
- },
- "payment_link_url": {
- "type": "string"
- },
- "recipient_role": {
- "description": "The label for the receiving party in the agreement.",
- "type": "string"
- },
- "sender_last_to_sign": {
- "description": "When true, the sender signs after the recipient.",
- "type": "boolean"
- },
- "sender_role": {
- "description": "The label for the sending party in the agreement.",
- "type": "string"
- },
- "stripe_invoice_delivery": {
- "type": "string"
- },
- "stripe_payment_link_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"
- },
- "stripe_product_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"
- },
- "stripe_product_name": {
- "type": "string"
- },
- "stripe_subsequent_bill_method": {
- "type": "string"
- },
- "template_setting_attributes": {
- "additionalProperties": false,
- "description": "Template settings such as standard version and message.",
- "properties": {
- "include_message": {
- "type": "boolean"
- },
- "message": {
- "type": "string"
- },
- "standard_version": {
- "type": "string"
- },
- "subsidiary_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"
- }
- },
- "type": "object"
- },
- "template_software_license_order_form_attributes": {
- "additionalProperties": false,
- "description": "Nested software license order form defaults.",
- "properties": {
- "additional_changes": {
- "description": "Text of additional changes to include when include_additional_changes is true.",
- "type": "string"
- },
- "deletion_procedure_include_custom": {
- "type": "string"
- },
- "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": {
- "type": "string"
- },
- "fees_attributes": {
- "items": {
- "additionalProperties": false,
- "properties": {
- "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"
- },
- "cost": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "description": {
- "type": "string"
- },
- "discount_duration_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "discount_duration_type": {
- "type": "string"
- },
- "discount_type": {
- "type": "string"
- },
- "fee_type": {
- "type": "string"
- },
- "graduated_fee_tiers_attributes": {
- "items": {
- "additionalProperties": false,
- "properties": {
- "flat_price": {
- "type": "string"
- },
- "price_per_unit": {
- "type": "string"
- },
- "upper_limit": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- }
- },
- "type": "object"
- },
- "type": "array"
- },
- "quantity": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "stripe_product_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"
- },
- "type": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "type": "array"
- },
- "fees_currency": {
- "type": "number"
- },
- "fees_include_fee_increase_upon_renewal": {
- "type": "boolean"
- },
- "fees_include_fee_increase_upon_renewal_fee": {
- "type": "number"
- },
- "fees_include_fee_increase_upon_renewal_type": {
- "type": "string"
- },
- "fees_inclusive_of_taxes": {
- "type": "string"
- },
- "include_additional_changes": {
- "description": "Whether to include the additional changes section.",
- "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": {
- "format": "email",
- "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
- "type": "string"
- },
- "include_pilot_period": {
- "type": "boolean"
- },
- "include_pilot_period_duration_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_pilot_period_duration_type": {
- "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": "Whether counterparties can propose changes to agreements created from this template.",
- "type": "boolean"
- },
- "order_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"
- },
- "order_date_type": {
- "type": "string"
- },
- "payment_process_automatic_frequency": {
- "type": "string"
- },
- "payment_process_type": {
- "type": "string"
- },
- "payment_process_type_custom_val": {
- "type": "number"
- },
- "payment_process_type_invoice_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "payment_process_type_invoice_custom_unit": {
- "type": "string"
- },
- "payment_process_type_invoice_duration": {
- "type": "string"
- },
- "payment_process_type_invoice_duration_start": {
- "type": "string"
- },
- "payment_process_type_invoice_type": {
- "type": "string"
- },
- "permitted_uses_include_custom": {
- "type": "string"
- },
- "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": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "software_description": {
- "type": "string"
- },
- "subscription_auto_renew": {
- "type": "string"
- },
- "subscription_period": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "subscription_period_unit": {
- "type": "string"
- },
- "subscription_renewal_notice_days": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "warranty_period_description_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "warranty_period_description_duration": {
- "type": "string"
- },
- "warranty_period_description_duration_start": {
- "type": "string"
- },
- "warranty_period_type": {
- "type": "string"
- }
- },
- "type": "object"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "additional_changes": {
- "description": "Text of additional changes to include when include_additional_changes is true.",
- "type": "string"
- },
- "additional_terms": {
- "type": "string"
- },
- "attachment_ids": {
- "description": "UUIDs of attachments to include with the template.",
- "items": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "type": "array"
- },
- "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"
- },
- "default_signer_email": {
- "description": "Default email address pre-filled as the signer when creating agreements from this template.",
- "format": "email",
- "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
- "type": "string"
- },
- "district_or_county": {
- "description": "The district or county for dispute resolution.",
- "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": {
- "type": "string"
- },
- "fees_type": {
- "type": "string"
- },
- "general_cap_amount": {
- "type": "number"
- },
- "general_cap_amount_type": {
- "type": "string"
- },
- "general_cap_period_currency": {
- "type": "number"
- },
- "general_cap_period_qty": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "general_cap_preceding_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "governing_law_country": {
- "description": "The country whose laws govern agreements created from this template.",
- "type": "string"
- },
- "governing_law_region": {
- "description": "The state or region whose laws govern agreements created from this template.",
- "type": "string"
- },
- "include_additional_changes": {
- "description": "Whether to include the additional changes section.",
- "type": "boolean"
- },
- "include_additional_terms": {
- "type": "boolean"
- },
- "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": "boolean"
- },
- "include_dpa_type": {
- "type": "string"
- },
- "include_payment_process": {
- "type": "boolean"
- },
- "include_technical_support": {
- "type": "boolean"
- },
- "include_terms": {
- "description": "Whether to include standard terms in the agreement.",
- "type": "boolean"
- },
- "name": {
- "description": "A name for the template.",
- "type": "string"
- },
- "negotiations_allowed": {
- "description": "Whether counterparties can propose changes to agreements created from this template.",
- "type": "boolean"
- },
- "payment_process_automatic_frequency": {
- "type": "string"
- },
- "payment_process_invoice_days": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "payment_process_invoice_from": {
- "type": "string"
- },
- "payment_process_invoice_timeframe": {
- "type": "string"
- },
- "payment_process_type": {
- "type": "string"
- },
- "pilot_period_description": {
- "type": "string"
- },
- "pilot_period_fees_description": {
- "type": "string"
- },
- "product_description": {
- "type": "string"
- },
- "recipient_role": {
- "description": "The label for the receiving party in the agreement.",
- "type": "string"
- },
- "sender_last_to_sign": {
- "description": "When true, the sender signs after the recipient.",
- "type": "boolean"
- },
- "sender_role": {
- "description": "The label for the sending party in the agreement.",
- "type": "string"
- },
- "technical_support_description": {
- "type": "string"
- },
- "template_setting_attributes": {
- "additionalProperties": false,
- "description": "Template settings such as standard version and message.",
- "properties": {
- "include_message": {
- "type": "boolean"
- },
- "message": {
- "type": "string"
- },
- "standard_version": {
- "type": "string"
- },
- "subsidiary_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"
- }
- },
- "type": "object"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "additional_changes": {
- "description": "Text of additional changes to include when include_additional_changes is true.",
- "type": "string"
- },
- "attachment_ids": {
- "description": "UUIDs of attachments to include with the template.",
- "items": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "type": "array"
- },
- "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"
- },
- "default_signer_email": {
- "description": "Default email address pre-filled as the signer when creating agreements from this template.",
- "format": "email",
- "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
- "type": "string"
- },
- "district_or_county": {
- "description": "The district or county for dispute resolution.",
- "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": {
- "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": {
- "type": "string"
- },
- "governing_law_country": {
- "description": "The country whose laws govern agreements created from this template.",
- "type": "string"
- },
- "governing_law_region": {
- "description": "The state or region whose laws govern agreements created from this template.",
- "type": "string"
- },
- "include_additional_changes": {
- "description": "Whether to include the additional changes section.",
- "type": "boolean"
- },
- "include_additional_warranties": {
- "type": "boolean"
- },
- "include_additional_warranties_include_company": {
- "type": "boolean"
- },
- "include_additional_warranties_include_company_val": {
- "type": "number"
- },
- "include_additional_warranties_include_partner": {
- "type": "boolean"
- },
- "include_additional_warranties_include_partner_val": {
- "type": "number"
- },
- "include_brand_guidelines": {
- "type": "boolean"
- },
- "include_brand_guidelines_include_company": {
- "type": "boolean"
- },
- "include_brand_guidelines_include_company_val": {
- "type": "number"
- },
- "include_brand_guidelines_include_partner": {
- "type": "boolean"
- },
- "include_brand_guidelines_include_partner_val": {
- "type": "number"
- },
- "include_covered_claims": {
- "type": "boolean"
- },
- "include_covered_claims_company_claims": {
- "type": "boolean"
- },
- "include_covered_claims_include_company_claims": {
- "type": "boolean"
- },
- "include_covered_claims_include_partner_claims": {
- "type": "boolean"
- },
- "include_covered_claims_partner_claims": {
- "type": "boolean"
- },
- "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": "boolean"
- },
- "include_dpa_type": {
- "type": "string"
- },
- "include_increased_cap_amount": {
- "type": "number"
- },
- "include_increased_cap_amount_currency": {
- "type": "boolean"
- },
- "include_increased_cap_amount_either_currency": {
- "type": "boolean"
- },
- "include_increased_cap_amount_either_multiple": {
- "type": "boolean"
- },
- "include_increased_cap_amount_multiple": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_increased_cap_amount_type": {
- "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": "number"
- },
- "include_terms": {
- "description": "Whether to include standard terms in the agreement.",
- "type": "boolean"
- },
- "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": "number"
- },
- "name": {
- "description": "A name for the template.",
- "type": "string"
- },
- "negotiations_allowed": {
- "description": "Whether counterparties can propose changes to agreements created from this template.",
- "type": "boolean"
- },
- "recipient_role": {
- "description": "The label for the receiving party in the agreement.",
- "type": "string"
- },
- "sender_last_to_sign": {
- "description": "When true, the sender signs after the recipient.",
- "type": "boolean"
- },
- "sender_role": {
- "description": "The label for the sending party in the agreement.",
- "type": "string"
- },
- "template_partnership_business_terms_attributes": {
- "additionalProperties": false,
- "description": "Nested partnership business terms defaults.",
- "properties": {
- "end_date_after_effective_date_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "end_date_after_effective_date_unit": {
- "type": "string"
- },
- "end_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"
- },
- "end_date_type": {
- "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": "number"
- },
- "include_obligations_company_promotion_include_materials": {
- "type": "boolean"
- },
- "include_obligations_company_promotion_include_materials_val": {
- "type": "number"
- },
- "include_obligations_company_referral": {
- "type": "boolean"
- },
- "include_obligations_company_referral_include_criteria": {
- "type": "boolean"
- },
- "include_obligations_company_referral_include_criteria_val": {
- "type": "number"
- },
- "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": {
- "type": "string"
- },
- "include_obligations_company_sponsorship": {
- "type": "boolean"
- },
- "include_obligations_company_sponsorship_include_benefits": {
- "type": "boolean"
- },
- "include_obligations_company_sponsorship_include_benefits_val": {
- "type": "number"
- },
- "include_obligations_company_sponsorship_include_payments": {
- "type": "boolean"
- },
- "include_obligations_company_sponsorship_include_payments_amount": {
- "type": "number"
- },
- "include_obligations_company_sponsorship_include_payments_unit": {
- "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": "number"
- },
- "include_obligations_partner_promotion_include_materials": {
- "type": "boolean"
- },
- "include_obligations_partner_promotion_include_materials_val": {
- "type": "number"
- },
- "include_obligations_partner_referral": {
- "type": "boolean"
- },
- "include_obligations_partner_referral_include_criteria": {
- "type": "boolean"
- },
- "include_obligations_partner_referral_include_criteria_val": {
- "type": "number"
- },
- "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": {
- "type": "string"
- },
- "include_obligations_partner_sponsorship": {
- "type": "boolean"
- },
- "include_obligations_partner_sponsorship_include_benefits": {
- "type": "boolean"
- },
- "include_obligations_partner_sponsorship_include_benefits_val": {
- "type": "number"
- },
- "include_obligations_partner_sponsorship_include_payments": {
- "type": "boolean"
- },
- "include_obligations_partner_sponsorship_include_payments_amount": {
- "type": "number"
- },
- "include_obligations_partner_sponsorship_include_payments_unit": {
- "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": "boolean"
- },
- "include_payment_process_company_include_address_country": {
- "type": "boolean"
- },
- "include_payment_process_company_include_address_state": {
- "type": "boolean"
- },
- "include_payment_process_company_include_address_street_address": {
- "type": "boolean"
- },
- "include_payment_process_company_include_address_zipcode": {
- "type": "boolean"
- },
- "include_payment_process_company_include_email": {
- "format": "email",
- "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
- "type": "string"
- },
- "include_payment_process_company_include_email_val": {
- "format": "email",
- "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
- "type": "string"
- },
- "include_payment_process_partner": {
- "type": "boolean"
- },
- "include_payment_process_partner_include_address": {
- "type": "boolean"
- },
- "include_payment_process_partner_include_address_city": {
- "type": "boolean"
- },
- "include_payment_process_partner_include_address_country": {
- "type": "boolean"
- },
- "include_payment_process_partner_include_address_state": {
- "type": "boolean"
- },
- "include_payment_process_partner_include_address_street_address": {
- "type": "boolean"
- },
- "include_payment_process_partner_include_address_zipcode": {
- "type": "boolean"
- },
- "include_payment_process_partner_include_email": {
- "format": "email",
- "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
- "type": "string"
- },
- "include_payment_process_partner_include_email_val": {
- "format": "email",
- "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
- "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": {
- "type": "boolean"
- },
- "include_payment_schedule_specified_unit": {
- "type": "string"
- },
- "include_payment_schedule_type": {
- "type": "string"
- },
- "negotiations_allowed": {
- "description": "Whether counterparties can propose changes to agreements created from this template.",
- "type": "boolean"
- },
- "territory_type": {
- "type": "string"
- },
- "territory_type_val": {
- "type": "number"
- }
- },
- "type": "object"
- },
- "template_setting_attributes": {
- "additionalProperties": false,
- "description": "Template settings such as standard version and message.",
- "properties": {
- "include_message": {
- "type": "boolean"
- },
- "message": {
- "type": "string"
- },
- "standard_version": {
- "type": "string"
- },
- "subsidiary_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"
- }
- },
- "type": "object"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "additional_changes": {
- "description": "Text of additional changes to include when include_additional_changes is true.",
- "type": "string"
- },
- "aggregation_limitations_permitted": {
- "type": "boolean"
- },
- "aggregation_limitations_permitted_val": {
- "type": "number"
- },
- "attachment_ids": {
- "description": "UUIDs of attachments to include with the template.",
- "items": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "type": "array"
- },
- "breach_notification_unit": {
- "type": "string"
- },
- "breach_notification_val": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "business_associate_relationship_type": {
- "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"
- },
- "default_signer_email": {
- "description": "Default email address pre-filled as the signer when creating agreements from this template.",
- "format": "email",
- "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
- "type": "string"
- },
- "deidentification_limitations_include_purpose": {
- "type": "boolean"
- },
- "deidentification_limitations_include_requirements": {
- "type": "boolean"
- },
- "deidentification_limitations_permitted": {
- "type": "boolean"
- },
- "deidentification_limitations_purpose_val": {
- "type": "number"
- },
- "deidentification_limitations_requirements_val": {
- "type": "number"
- },
- "designated_record_set_provider_maintains": {
- "type": "boolean"
- },
- "district_or_county": {
- "description": "The district or county for dispute resolution.",
- "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": {
- "type": "string"
- },
- "governing_law_country": {
- "description": "The country whose laws govern agreements created from this template.",
- "type": "string"
- },
- "governing_law_region": {
- "description": "The state or region whose laws govern agreements created from this template.",
- "type": "string"
- },
- "include_additional_changes": {
- "description": "Whether to include the additional changes section.",
- "type": "boolean"
- },
- "include_aggregation_limitations": {
- "type": "boolean"
- },
- "include_deidentification_limitations": {
- "type": "boolean"
- },
- "include_limitations": {
- "type": "boolean"
- },
- "include_offshore_limitations": {
- "type": "boolean"
- },
- "include_subcontract_limitations": {
- "type": "boolean"
- },
- "include_terms": {
- "description": "Whether to include standard terms in the agreement.",
- "type": "boolean"
- },
- "name": {
- "description": "A name for the template.",
- "type": "string"
- },
- "negotiations_allowed": {
- "description": "Whether counterparties can propose changes to agreements created from this template.",
- "type": "boolean"
- },
- "offshore_limitations_permitted": {
- "type": "boolean"
- },
- "offshore_limitations_permitted_val": {
- "type": "number"
- },
- "recipient_role": {
- "description": "The label for the receiving party in the agreement.",
- "type": "string"
- },
- "sender_last_to_sign": {
- "description": "When true, the sender signs after the recipient.",
- "type": "boolean"
- },
- "sender_role": {
- "description": "The label for the sending party in the agreement.",
- "type": "string"
- },
- "subcontract_limitations_include_notice": {
- "type": "boolean"
- },
- "subcontract_limitations_include_permission": {
- "type": "boolean"
- },
- "subcontract_limitations_notice_val": {
- "type": "number"
- },
- "subcontract_limitations_permission_val": {
- "type": "number"
- },
- "subcontract_limitations_permitted": {
- "type": "boolean"
- },
- "template_setting_attributes": {
- "additionalProperties": false,
- "description": "Template settings such as standard version and message.",
- "properties": {
- "include_message": {
- "type": "boolean"
- },
- "message": {
- "type": "string"
- },
- "standard_version": {
- "type": "string"
- },
- "subsidiary_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"
- }
- },
- "type": "object"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "additional_changes": {
- "description": "Text of additional changes to include when include_additional_changes is true.",
- "type": "string"
- },
- "attachment_ids": {
- "description": "UUIDs of attachments to include with the template.",
- "items": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "type": "array"
- },
- "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"
- },
- "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": {
- "type": "string"
- },
- "confidentiality_type": {
- "type": "string"
- },
- "default_signer_email": {
- "description": "Default email address pre-filled as the signer when creating agreements from this template.",
- "format": "email",
- "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
- "type": "string"
- },
- "district_or_county": {
- "description": "The district or county for dispute resolution.",
- "type": "string"
- },
- "governing_law_country": {
- "description": "The country whose laws govern agreements created from this template.",
- "type": "string"
- },
- "governing_law_region": {
- "description": "The state or region whose laws govern agreements created from this template.",
- "type": "string"
- },
- "include_additional_changes": {
- "description": "Whether to include the additional changes section.",
- "type": "boolean"
- },
- "include_custom_details": {
- "type": "boolean"
- },
- "include_custom_details_val": {
- "type": "number"
- },
- "include_fees": {
- "type": "boolean"
- },
- "include_fees_amount": {
- "type": "number"
- },
- "include_fees_amount_duration": {
- "type": "string"
- },
- "include_fees_include_amount": {
- "type": "number"
- },
- "include_fees_include_other": {
- "type": "boolean"
- },
- "include_fees_other": {
- "type": "boolean"
- },
- "include_functionality": {
- "type": "boolean"
- },
- "include_functionality_val": {
- "type": "number"
- },
- "include_launch_date": {
- "type": "string"
- },
- "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": {
- "type": "string"
- },
- "include_terms": {
- "description": "Whether to include standard terms in the agreement.",
- "type": "boolean"
- },
- "name": {
- "description": "A name for the template.",
- "type": "string"
- },
- "negotiations_allowed": {
- "description": "Whether counterparties can propose changes to agreements created from this template.",
- "type": "boolean"
- },
- "product_name": {
- "type": "string"
- },
- "recipient_role": {
- "description": "The label for the receiving party in the agreement.",
- "type": "string"
- },
- "sender_last_to_sign": {
- "description": "When true, the sender signs after the recipient.",
- "type": "boolean"
- },
- "sender_role": {
- "description": "The label for the sending party in the agreement.",
- "type": "string"
- },
- "template_setting_attributes": {
- "additionalProperties": false,
- "description": "Template settings such as standard version and message.",
- "properties": {
- "include_message": {
- "type": "boolean"
- },
- "message": {
- "type": "string"
- },
- "standard_version": {
- "type": "string"
- },
- "subsidiary_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"
- }
- },
- "type": "object"
- }
- },
- "type": "object"
- }
-]New value: +[
+ {
+ "additionalProperties": false,
+ "properties": {
+ "additional_changes": {
+ "description": "Text of additional changes to include when include_additional_changes is true.",
+ "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"
+ },
+ "confidentiality_period": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "confidentiality_period_perpetual": {
+ "type": "boolean"
+ },
+ "default_signer_email": {
+ "description": "Default email address pre-filled as the signer when creating agreements from this template.",
+ "format": "email",
+ "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "district_or_county": {
+ "description": "The district or county for dispute resolution.",
+ "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_of_confidentiality": {
+ "type": "string"
+ },
+ "effective_date_type": {
+ "type": "string"
+ },
+ "governing_law_country": {
+ "description": "The country whose laws govern agreements created from this template.",
+ "type": "string"
+ },
+ "governing_law_region": {
+ "description": "The state or region whose laws govern agreements created from this template.",
+ "type": "string"
+ },
+ "include_additional_changes": {
+ "description": "Whether to include the additional changes section.",
+ "type": "boolean"
+ },
+ "include_terms": {
+ "description": "Whether to include standard terms in the agreement.",
+ "type": "boolean"
+ },
+ "name": {
+ "description": "A name for the template.",
+ "type": "string"
+ },
+ "negotiations_allowed": {
+ "description": "Whether counterparties can propose changes to agreements created from this template.",
+ "type": "boolean"
+ },
+ "purpose": {
+ "type": "string"
+ },
+ "recipient_role": {
+ "description": "The label for the receiving party in the agreement.",
+ "type": "string"
+ },
+ "sender_last_to_sign": {
+ "description": "When true, the sender signs after the recipient.",
+ "type": "boolean"
+ },
+ "sender_role": {
+ "description": "The label for the sending party in the agreement.",
+ "type": "string"
+ },
+ "template_setting_attributes": {
+ "additionalProperties": false,
+ "description": "Template settings such as standard version and message.",
+ "properties": {
+ "include_message": {
+ "type": "boolean"
+ },
+ "message": {
+ "type": "string"
+ },
+ "standard_version": {
+ "type": "string"
+ },
+ "subsidiary_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"
+ }
+ },
+ "type": "object"
+ },
+ "term": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "term_period_perpetual": {
+ "type": "boolean"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "additional_changes": {
+ "description": "Text of additional changes to include when include_additional_changes is true.",
+ "type": "string"
+ },
+ "attachment_ids": {
+ "description": "UUIDs of attachments to include with the template.",
+ "items": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "billing_workflow_type": {
+ "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"
+ },
+ "customer_description": {
+ "type": "string"
+ },
+ "default_signer_email": {
+ "description": "Default email address pre-filled as the signer when creating agreements from this template.",
+ "format": "email",
+ "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "district_or_county": {
+ "description": "The district or county for dispute resolution.",
+ "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": {
+ "type": "string"
+ },
+ "effective_date_type": {
+ "type": "string"
+ },
+ "general_cap_amount": {
+ "type": "number"
+ },
+ "general_cap_amount_type": {
+ "type": "string"
+ },
+ "general_cap_period_currency": {
+ "type": "number"
+ },
+ "general_cap_period_qty": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "general_cap_preceding_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "governing_law_country": {
+ "description": "The country whose laws govern agreements created from this template.",
+ "type": "string"
+ },
+ "governing_law_region": {
+ "description": "The state or region whose laws govern agreements created from this template.",
+ "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": {
+ "type": "string"
+ },
+ "include_additional_changes": {
+ "description": "Whether to include the additional changes section.",
+ "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_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_billing_workflow": {
+ "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_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": {
+ "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": {
+ "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": {
+ "type": "string"
+ },
+ "include_terms": {
+ "description": "Whether to include standard terms in the agreement.",
+ "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": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "increased_cap_amount_qty": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "increased_cap_amount_type": {
+ "type": "string"
+ },
+ "name": {
+ "description": "A name for the template.",
+ "type": "string"
+ },
+ "negotiations_allowed": {
+ "description": "Whether counterparties can propose changes to agreements created from this template.",
+ "type": "boolean"
+ },
+ "payment_link_url": {
+ "type": "string"
+ },
+ "provider": {
+ "type": "string"
+ },
+ "recipient_role": {
+ "description": "The label for the receiving party in the agreement.",
+ "type": "string"
+ },
+ "sender_last_to_sign": {
+ "description": "When true, the sender signs after the recipient.",
+ "type": "boolean"
+ },
+ "sender_role": {
+ "description": "The label for the sending party in the agreement.",
+ "type": "string"
+ },
+ "stripe_invoice_delivery": {
+ "type": "string"
+ },
+ "stripe_payment_link_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"
+ },
+ "stripe_product_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"
+ },
+ "stripe_product_name": {
+ "type": "string"
+ },
+ "stripe_subsequent_bill_method": {
+ "type": "string"
+ },
+ "template_csa_order_form_attributes": {
+ "additionalProperties": false,
+ "description": "Nested CSA order form defaults. See Template Parameters docs for CSA Order Form.",
+ "properties": {
+ "additional_changes": {
+ "description": "Text of additional changes to include when include_additional_changes is true.",
+ "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": {
+ "type": "string"
+ },
+ "fees_attributes": {
+ "items": {
+ "additionalProperties": false,
+ "properties": {
+ "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"
+ },
+ "cost": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "description": {
+ "type": "string"
+ },
+ "discount_duration_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "discount_duration_type": {
+ "type": "string"
+ },
+ "discount_type": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "graduated_fee_tiers_attributes": {
+ "items": {
+ "additionalProperties": false,
+ "properties": {
+ "flat_price": {
+ "type": "string"
+ },
+ "price_per_unit": {
+ "type": "string"
+ },
+ "upper_limit": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "quantity": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "stripe_product_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"
+ },
+ "type": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "fees_currency": {
+ "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": {
+ "type": "string"
+ },
+ "fees_inclusive_of_taxes": {
+ "type": "boolean"
+ },
+ "free_trial_days": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_additional_changes": {
+ "description": "Whether to include the additional changes section.",
+ "type": "boolean"
+ },
+ "include_additional_parameters_or_limitations": {
+ "type": "boolean"
+ },
+ "include_billing_info": {
+ "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": {
+ "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": {
+ "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": {
+ "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": {
+ "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": {
+ "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": {
+ "type": "string"
+ },
+ "include_sla_standard_maintenance_notice_qty": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_sla_standard_maintenance_notice_unit": {
+ "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": {
+ "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": {
+ "type": "string"
+ },
+ "invoice_period_custom_unit": {
+ "type": "string"
+ },
+ "max_consumption": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "max_users": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "negotiations_allowed": {
+ "description": "Whether counterparties can propose changes to agreements created from this template.",
+ "type": "boolean"
+ },
+ "order_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"
+ },
+ "order_date_other": {
+ "type": "string"
+ },
+ "order_date_type": {
+ "type": "string"
+ },
+ "payment_period": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "payment_period_timeframe": {
+ "type": "string"
+ },
+ "payment_period_unit": {
+ "type": "string"
+ },
+ "payment_process_automatic_frequency": {
+ "type": "string"
+ },
+ "payment_process_type": {
+ "type": "string"
+ },
+ "payment_process_type_custom_val": {
+ "type": "string"
+ },
+ "payment_process_type_invoice_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "payment_process_type_invoice_custom_unit": {
+ "type": "string"
+ },
+ "payment_process_type_invoice_duration": {
+ "type": "string"
+ },
+ "payment_process_type_invoice_duration_start": {
+ "type": "string"
+ },
+ "payment_process_type_invoice_type": {
+ "type": "string"
+ },
+ "pilot_period_stripe_product_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"
+ },
+ "service_credits_attributes": {
+ "items": {
+ "additionalProperties": false,
+ "properties": {
+ "credit": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "max": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "min": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "subscription_auto_renew": {
+ "type": "string"
+ },
+ "subscription_period": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "subscription_period_unit": {
+ "type": "string"
+ },
+ "subscription_renewal_notice_days": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "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": {
+ "type": "string"
+ },
+ "use_limitations_attributes": {
+ "items": {
+ "additionalProperties": false,
+ "properties": {
+ "amount": {
+ "type": "string"
+ },
+ "limitation_type": {
+ "type": "string"
+ },
+ "unit": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "template_setting_attributes": {
+ "additionalProperties": false,
+ "description": "Template settings such as standard version and message.",
+ "properties": {
+ "include_message": {
+ "type": "boolean"
+ },
+ "message": {
+ "type": "string"
+ },
+ "standard_version": {
+ "type": "string"
+ },
+ "subsidiary_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"
+ }
+ },
+ "type": "object"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "additional_changes": {
+ "description": "Text of additional changes to include when include_additional_changes is true.",
+ "type": "string"
+ },
+ "approved_subprocessor_type": {
+ "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"
+ },
+ "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": {
+ "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"
+ },
+ "default_signer_email": {
+ "description": "Default email address pre-filled as the signer when creating agreements from this template.",
+ "format": "email",
+ "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "district_or_county": {
+ "description": "The district or county for dispute resolution.",
+ "type": "string"
+ },
+ "duration_of_processing": {
+ "type": "string"
+ },
+ "governing_law_country": {
+ "description": "The country whose laws govern agreements created from this template.",
+ "type": "string"
+ },
+ "governing_law_region": {
+ "description": "The state or region whose laws govern agreements created from this template.",
+ "type": "string"
+ },
+ "include_additional_changes": {
+ "description": "Whether to include the additional changes section.",
+ "type": "boolean"
+ },
+ "include_covered_claim": {
+ "type": "boolean"
+ },
+ "include_covered_claim_external_val": {
+ "type": "string"
+ },
+ "include_covered_claim_internal_val": {
+ "type": "string"
+ },
+ "include_covered_claim_type": {
+ "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": {
+ "type": "boolean"
+ },
+ "include_increased_claim_amount_currency": {
+ "type": "string"
+ },
+ "include_increased_claim_amount_qty": {},
+ "include_increased_claim_amount_type": {
+ "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": {
+ "type": "string"
+ },
+ "include_liability_cap_amount_currency_internal": {
+ "type": "string"
+ },
+ "include_liability_cap_csa_type": {
+ "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-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_provider": {
+ "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"
+ },
+ "include_terms": {
+ "description": "Whether to include standard terms in the agreement.",
+ "type": "boolean"
+ },
+ "name": {
+ "description": "A name for the template.",
+ "type": "string"
+ },
+ "negotiations_allowed": {
+ "description": "Whether counterparties can propose changes to agreements created from this template.",
+ "type": "boolean"
+ },
+ "provider": {
+ "type": "string"
+ },
+ "recipient_role": {
+ "description": "The label for the receiving party in the agreement.",
+ "type": "string"
+ },
+ "security_policy_available_at": {
+ "type": "string"
+ },
+ "security_policy_type": {
+ "type": "string"
+ },
+ "sender_last_to_sign": {
+ "description": "When true, the sender signs after the recipient.",
+ "type": "boolean"
+ },
+ "sender_role": {
+ "description": "The label for the sending party in the agreement.",
+ "type": "string"
+ },
+ "subprocessors_attributes": {
+ "description": "List of subprocessors. Each item may include name, country, and processing_task.",
+ "items": {
+ "additionalProperties": false,
+ "properties": {
+ "country": {
+ "type": "string"
+ },
+ "name": {
+ "description": "A name for the template.",
+ "type": "string"
+ },
+ "processing_task": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "template_setting_attributes": {
+ "additionalProperties": false,
+ "description": "Template settings such as standard version and message.",
+ "properties": {
+ "include_message": {
+ "type": "boolean"
+ },
+ "message": {
+ "type": "string"
+ },
+ "standard_version": {
+ "type": "string"
+ },
+ "subsidiary_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"
+ }
+ },
+ "type": "object"
+ },
+ "underlying_agreement_val": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "additional_changes": {
+ "description": "Text of additional changes to include when include_additional_changes is true.",
+ "type": "string"
+ },
+ "attachment_ids": {
+ "description": "UUIDs of attachments to include with the template.",
+ "items": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "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"
+ },
+ "default_signer_email": {
+ "description": "Default email address pre-filled as the signer when creating agreements from this template.",
+ "format": "email",
+ "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "district_or_county": {
+ "description": "The district or county for dispute resolution.",
+ "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": {
+ "type": "string"
+ },
+ "general_cap_amount": {
+ "type": "number"
+ },
+ "general_cap_amount_type": {
+ "type": "string"
+ },
+ "general_cap_period_currency": {
+ "type": "number"
+ },
+ "general_cap_period_qty": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "general_cap_preceding_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "governing_law_country": {
+ "description": "The country whose laws govern agreements created from this template.",
+ "type": "string"
+ },
+ "governing_law_region": {
+ "description": "The state or region whose laws govern agreements created from this template.",
+ "type": "string"
+ },
+ "include_additional_changes": {
+ "description": "Whether to include the additional changes section.",
+ "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": {
+ "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": {
+ "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": {
+ "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": {
+ "type": "string"
+ },
+ "include_terms": {
+ "description": "Whether to include standard terms in the agreement.",
+ "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_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": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "increased_cap_amount_qty": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "increased_cap_amount_type": {
+ "type": "string"
+ },
+ "name": {
+ "description": "A name for the template.",
+ "type": "string"
+ },
+ "negotiations_allowed": {
+ "description": "Whether counterparties can propose changes to agreements created from this template.",
+ "type": "boolean"
+ },
+ "recipient_role": {
+ "description": "The label for the receiving party in the agreement.",
+ "type": "string"
+ },
+ "sender_last_to_sign": {
+ "description": "When true, the sender signs after the recipient.",
+ "type": "boolean"
+ },
+ "sender_role": {
+ "description": "The label for the sending party in the agreement.",
+ "type": "string"
+ },
+ "template_psa_statement_of_work_attributes": {
+ "additionalProperties": false,
+ "description": "Nested PSA statement of work defaults.",
+ "properties": {
+ "additional_changes": {
+ "description": "Text of additional changes to include when include_additional_changes is true.",
+ "type": "string"
+ },
+ "fees_attributes": {
+ "items": {
+ "additionalProperties": false,
+ "properties": {
+ "cost": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "description": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "quantity": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "include_additional_changes": {
+ "description": "Whether to include the additional changes section.",
+ "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": {
+ "type": "string"
+ },
+ "include_deliverables_resubmission_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_deliverables_resubmission_unit": {
+ "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": {
+ "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": {
+ "type": "string"
+ },
+ "invoice_period_description": {
+ "type": "string"
+ },
+ "negotiations_allowed": {
+ "description": "Whether counterparties can propose changes to agreements created from this template.",
+ "type": "boolean"
+ },
+ "payment_period": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "payment_period_other": {
+ "type": "string"
+ },
+ "payment_period_timeframe": {
+ "type": "string"
+ },
+ "payment_period_type": {
+ "type": "string"
+ },
+ "payment_period_unit": {
+ "type": "string"
+ },
+ "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": {
+ "type": "string"
+ },
+ "sow_term_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "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": {
+ "type": "string"
+ },
+ "sow_term_unit": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "template_setting_attributes": {
+ "additionalProperties": false,
+ "description": "Template settings such as standard version and message.",
+ "properties": {
+ "include_message": {
+ "type": "boolean"
+ },
+ "message": {
+ "type": "string"
+ },
+ "standard_version": {
+ "type": "string"
+ },
+ "subsidiary_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"
+ }
+ },
+ "type": "object"
+ },
+ "version": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "additional_changes": {
+ "description": "Text of additional changes to include when include_additional_changes is true.",
+ "type": "string"
+ },
+ "attachment_ids": {
+ "description": "UUIDs of attachments to include with the template.",
+ "items": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "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"
+ },
+ "customer_description": {
+ "type": "string"
+ },
+ "default_signer_email": {
+ "description": "Default email address pre-filled as the signer when creating agreements from this template.",
+ "format": "email",
+ "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "district_or_county": {
+ "description": "The district or county for dispute resolution.",
+ "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": {
+ "type": "string"
+ },
+ "governing_law_country": {
+ "description": "The country whose laws govern agreements created from this template.",
+ "type": "string"
+ },
+ "governing_law_region": {
+ "description": "The state or region whose laws govern agreements created from this template.",
+ "type": "string"
+ },
+ "include_additional_changes": {
+ "description": "Whether to include the additional changes section.",
+ "type": "boolean"
+ },
+ "include_fees": {
+ "type": "boolean"
+ },
+ "include_fees_amount": {
+ "type": "number"
+ },
+ "include_fees_description": {
+ "type": "string"
+ },
+ "include_fees_pay_by_amount": {},
+ "include_fees_type": {
+ "type": "string"
+ },
+ "include_fees_unit": {
+ "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": {
+ "type": "string"
+ },
+ "include_program_participation_feedback": {
+ "type": "boolean"
+ },
+ "include_program_participation_feedback_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_program_participation_feedback_unit": {
+ "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"
+ },
+ "include_terms": {
+ "description": "Whether to include standard terms in the agreement.",
+ "type": "boolean"
+ },
+ "name": {
+ "description": "A name for the template.",
+ "type": "string"
+ },
+ "negotiations_allowed": {
+ "description": "Whether counterparties can propose changes to agreements created from this template.",
+ "type": "boolean"
+ },
+ "product_description": {
+ "type": "string"
+ },
+ "recipient_role": {
+ "description": "The label for the receiving party in the agreement.",
+ "type": "string"
+ },
+ "sender_last_to_sign": {
+ "description": "When true, the sender signs after the recipient.",
+ "type": "boolean"
+ },
+ "sender_role": {
+ "description": "The label for the sending party in the agreement.",
+ "type": "string"
+ },
+ "template_setting_attributes": {
+ "additionalProperties": false,
+ "description": "Template settings such as standard version and message.",
+ "properties": {
+ "include_message": {
+ "type": "boolean"
+ },
+ "message": {
+ "type": "string"
+ },
+ "standard_version": {
+ "type": "string"
+ },
+ "subsidiary_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"
+ }
+ },
+ "type": "object"
+ },
+ "term_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "term_unit": {
+ "type": "string"
+ },
+ "version": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "additional_changes": {
+ "description": "Text of additional changes to include when include_additional_changes is true.",
+ "type": "string"
+ },
+ "attachment_ids": {
+ "description": "UUIDs of attachments to include with the template.",
+ "items": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "billing_workflow_type": {
+ "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"
+ },
+ "default_signer_email": {
+ "description": "Default email address pre-filled as the signer when creating agreements from this template.",
+ "format": "email",
+ "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "district_or_county": {
+ "description": "The district or county for dispute resolution.",
+ "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": {
+ "type": "string"
+ },
+ "general_cap_amount": {
+ "type": "number"
+ },
+ "general_cap_amount_type": {
+ "type": "string"
+ },
+ "general_cap_period_currency": {
+ "type": "number"
+ },
+ "general_cap_period_qty": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "general_cap_preceding_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "governing_law_country": {
+ "description": "The country whose laws govern agreements created from this template.",
+ "type": "string"
+ },
+ "governing_law_region": {
+ "description": "The state or region whose laws govern agreements created from this template.",
+ "type": "string"
+ },
+ "include_additional_changes": {
+ "description": "Whether to include the additional changes section.",
+ "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_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_billing_workflow": {
+ "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_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": {
+ "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_terms": {
+ "description": "Whether to include standard terms in the agreement.",
+ "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": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "increased_cap_amount_qty": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "increased_cap_amount_type": {
+ "type": "string"
+ },
+ "name": {
+ "description": "A name for the template.",
+ "type": "string"
+ },
+ "negotiations_allowed": {
+ "description": "Whether counterparties can propose changes to agreements created from this template.",
+ "type": "boolean"
+ },
+ "payment_link_url": {
+ "type": "string"
+ },
+ "recipient_role": {
+ "description": "The label for the receiving party in the agreement.",
+ "type": "string"
+ },
+ "sender_last_to_sign": {
+ "description": "When true, the sender signs after the recipient.",
+ "type": "boolean"
+ },
+ "sender_role": {
+ "description": "The label for the sending party in the agreement.",
+ "type": "string"
+ },
+ "stripe_invoice_delivery": {
+ "type": "string"
+ },
+ "stripe_payment_link_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"
+ },
+ "stripe_product_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"
+ },
+ "stripe_product_name": {
+ "type": "string"
+ },
+ "stripe_subsequent_bill_method": {
+ "type": "string"
+ },
+ "template_setting_attributes": {
+ "additionalProperties": false,
+ "description": "Template settings such as standard version and message.",
+ "properties": {
+ "include_message": {
+ "type": "boolean"
+ },
+ "message": {
+ "type": "string"
+ },
+ "standard_version": {
+ "type": "string"
+ },
+ "subsidiary_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"
+ }
+ },
+ "type": "object"
+ },
+ "template_software_license_order_form_attributes": {
+ "additionalProperties": false,
+ "description": "Nested software license order form defaults.",
+ "properties": {
+ "additional_changes": {
+ "description": "Text of additional changes to include when include_additional_changes is true.",
+ "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": {
+ "type": "string"
+ },
+ "fees_attributes": {
+ "items": {
+ "additionalProperties": false,
+ "properties": {
+ "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"
+ },
+ "cost": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "description": {
+ "type": "string"
+ },
+ "discount_duration_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "discount_duration_type": {
+ "type": "string"
+ },
+ "discount_type": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "graduated_fee_tiers_attributes": {
+ "items": {
+ "additionalProperties": false,
+ "properties": {
+ "flat_price": {
+ "type": "string"
+ },
+ "price_per_unit": {
+ "type": "string"
+ },
+ "upper_limit": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "quantity": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "stripe_product_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"
+ },
+ "type": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "fees_currency": {
+ "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": {
+ "type": "string"
+ },
+ "fees_inclusive_of_taxes": {
+ "type": "boolean"
+ },
+ "include_additional_changes": {
+ "description": "Whether to include the additional changes section.",
+ "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": {
+ "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": "Whether counterparties can propose changes to agreements created from this template.",
+ "type": "boolean"
+ },
+ "order_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"
+ },
+ "order_date_type": {
+ "type": "string"
+ },
+ "payment_process_automatic_frequency": {
+ "type": "string"
+ },
+ "payment_process_type": {
+ "type": "string"
+ },
+ "payment_process_type_custom_val": {
+ "type": "string"
+ },
+ "payment_process_type_invoice_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "payment_process_type_invoice_custom_unit": {
+ "type": "string"
+ },
+ "payment_process_type_invoice_duration": {
+ "type": "string"
+ },
+ "payment_process_type_invoice_duration_start": {
+ "type": "string"
+ },
+ "payment_process_type_invoice_type": {
+ "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": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "software_description": {
+ "type": "string"
+ },
+ "subscription_auto_renew": {
+ "type": "string"
+ },
+ "subscription_period": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "subscription_period_unit": {
+ "type": "string"
+ },
+ "subscription_renewal_notice_days": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "warranty_period_description_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "warranty_period_description_duration": {
+ "type": "string"
+ },
+ "warranty_period_description_duration_start": {
+ "type": "string"
+ },
+ "warranty_period_type": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "additional_changes": {
+ "description": "Text of additional changes to include when include_additional_changes is true.",
+ "type": "string"
+ },
+ "additional_terms": {
+ "type": "string"
+ },
+ "attachment_ids": {
+ "description": "UUIDs of attachments to include with the template.",
+ "items": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "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"
+ },
+ "default_signer_email": {
+ "description": "Default email address pre-filled as the signer when creating agreements from this template.",
+ "format": "email",
+ "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "district_or_county": {
+ "description": "The district or county for dispute resolution.",
+ "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": {
+ "type": "string"
+ },
+ "fees_type": {
+ "type": "string"
+ },
+ "general_cap_amount": {
+ "type": "number"
+ },
+ "general_cap_amount_type": {
+ "type": "string"
+ },
+ "general_cap_period_currency": {
+ "type": "number"
+ },
+ "general_cap_period_qty": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "general_cap_preceding_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "governing_law_country": {
+ "description": "The country whose laws govern agreements created from this template.",
+ "type": "string"
+ },
+ "governing_law_region": {
+ "description": "The state or region whose laws govern agreements created from this template.",
+ "type": "string"
+ },
+ "include_additional_changes": {
+ "description": "Whether to include the additional changes section.",
+ "type": "boolean"
+ },
+ "include_additional_terms": {
+ "type": "boolean"
+ },
+ "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": {
+ "type": "string"
+ },
+ "include_payment_process": {
+ "type": "boolean"
+ },
+ "include_technical_support": {
+ "type": "boolean"
+ },
+ "include_terms": {
+ "description": "Whether to include standard terms in the agreement.",
+ "type": "boolean"
+ },
+ "name": {
+ "description": "A name for the template.",
+ "type": "string"
+ },
+ "negotiations_allowed": {
+ "description": "Whether counterparties can propose changes to agreements created from this template.",
+ "type": "boolean"
+ },
+ "payment_process_automatic_frequency": {
+ "type": "string"
+ },
+ "payment_process_invoice_days": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "payment_process_invoice_from": {
+ "type": "string"
+ },
+ "payment_process_invoice_timeframe": {
+ "type": "string"
+ },
+ "payment_process_type": {
+ "type": "string"
+ },
+ "pilot_period_description": {
+ "type": "string"
+ },
+ "pilot_period_fees_description": {
+ "type": "string"
+ },
+ "product_description": {
+ "type": "string"
+ },
+ "recipient_role": {
+ "description": "The label for the receiving party in the agreement.",
+ "type": "string"
+ },
+ "sender_last_to_sign": {
+ "description": "When true, the sender signs after the recipient.",
+ "type": "boolean"
+ },
+ "sender_role": {
+ "description": "The label for the sending party in the agreement.",
+ "type": "string"
+ },
+ "technical_support_description": {
+ "type": "string"
+ },
+ "template_setting_attributes": {
+ "additionalProperties": false,
+ "description": "Template settings such as standard version and message.",
+ "properties": {
+ "include_message": {
+ "type": "boolean"
+ },
+ "message": {
+ "type": "string"
+ },
+ "standard_version": {
+ "type": "string"
+ },
+ "subsidiary_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"
+ }
+ },
+ "type": "object"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "additional_changes": {
+ "description": "Text of additional changes to include when include_additional_changes is true.",
+ "type": "string"
+ },
+ "attachment_ids": {
+ "description": "UUIDs of attachments to include with the template.",
+ "items": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "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"
+ },
+ "default_signer_email": {
+ "description": "Default email address pre-filled as the signer when creating agreements from this template.",
+ "format": "email",
+ "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "district_or_county": {
+ "description": "The district or county for dispute resolution.",
+ "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": {
+ "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": {
+ "type": "string"
+ },
+ "governing_law_country": {
+ "description": "The country whose laws govern agreements created from this template.",
+ "type": "string"
+ },
+ "governing_law_region": {
+ "description": "The state or region whose laws govern agreements created from this template.",
+ "type": "string"
+ },
+ "include_additional_changes": {
+ "description": "Whether to include the additional changes section.",
+ "type": "boolean"
+ },
+ "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": {
+ "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": {},
+ "include_increased_cap_amount_multiple": {},
+ "include_increased_cap_amount_type": {
+ "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_terms": {
+ "description": "Whether to include standard terms in the agreement.",
+ "type": "boolean"
+ },
+ "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"
+ },
+ "name": {
+ "description": "A name for the template.",
+ "type": "string"
+ },
+ "negotiations_allowed": {
+ "description": "Whether counterparties can propose changes to agreements created from this template.",
+ "type": "boolean"
+ },
+ "recipient_role": {
+ "description": "The label for the receiving party in the agreement.",
+ "type": "string"
+ },
+ "sender_last_to_sign": {
+ "description": "When true, the sender signs after the recipient.",
+ "type": "boolean"
+ },
+ "sender_role": {
+ "description": "The label for the sending party in the agreement.",
+ "type": "string"
+ },
+ "template_partnership_business_terms_attributes": {
+ "additionalProperties": false,
+ "description": "Nested partnership business terms defaults.",
+ "properties": {
+ "end_date_after_effective_date_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "end_date_after_effective_date_unit": {
+ "type": "string"
+ },
+ "end_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"
+ },
+ "end_date_type": {
+ "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": {
+ "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": {
+ "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": {
+ "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": {
+ "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": {
+ "format": "email",
+ "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "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": {
+ "format": "email",
+ "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "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": {
+ "type": "string"
+ },
+ "include_payment_schedule_specified_unit": {
+ "type": "string"
+ },
+ "include_payment_schedule_type": {
+ "type": "string"
+ },
+ "negotiations_allowed": {
+ "description": "Whether counterparties can propose changes to agreements created from this template.",
+ "type": "boolean"
+ },
+ "territory_type": {
+ "type": "string"
+ },
+ "territory_type_val": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "template_setting_attributes": {
+ "additionalProperties": false,
+ "description": "Template settings such as standard version and message.",
+ "properties": {
+ "include_message": {
+ "type": "boolean"
+ },
+ "message": {
+ "type": "string"
+ },
+ "standard_version": {
+ "type": "string"
+ },
+ "subsidiary_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"
+ }
+ },
+ "type": "object"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "additional_changes": {
+ "description": "Text of additional changes to include when include_additional_changes is true.",
+ "type": "string"
+ },
+ "aggregation_limitations_permitted": {
+ "type": "boolean"
+ },
+ "aggregation_limitations_permitted_val": {
+ "type": "string"
+ },
+ "attachment_ids": {
+ "description": "UUIDs of attachments to include with the template.",
+ "items": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "breach_notification_unit": {
+ "type": "string"
+ },
+ "breach_notification_val": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "business_associate_relationship_type": {
+ "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"
+ },
+ "default_signer_email": {
+ "description": "Default email address pre-filled as the signer when creating agreements from this template.",
+ "format": "email",
+ "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "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"
+ },
+ "district_or_county": {
+ "description": "The district or county for dispute resolution.",
+ "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": {
+ "type": "string"
+ },
+ "governing_law_country": {
+ "description": "The country whose laws govern agreements created from this template.",
+ "type": "string"
+ },
+ "governing_law_region": {
+ "description": "The state or region whose laws govern agreements created from this template.",
+ "type": "string"
+ },
+ "include_additional_changes": {
+ "description": "Whether to include the additional changes section.",
+ "type": "boolean"
+ },
+ "include_aggregation_limitations": {
+ "type": "boolean"
+ },
+ "include_deidentification_limitations": {
+ "type": "boolean"
+ },
+ "include_limitations": {
+ "type": "boolean"
+ },
+ "include_offshore_limitations": {
+ "type": "boolean"
+ },
+ "include_subcontract_limitations": {
+ "type": "boolean"
+ },
+ "include_terms": {
+ "description": "Whether to include standard terms in the agreement.",
+ "type": "boolean"
+ },
+ "name": {
+ "description": "A name for the template.",
+ "type": "string"
+ },
+ "negotiations_allowed": {
+ "description": "Whether counterparties can propose changes to agreements created from this template.",
+ "type": "boolean"
+ },
+ "offshore_limitations_permitted": {
+ "type": "boolean"
+ },
+ "offshore_limitations_permitted_val": {
+ "type": "string"
+ },
+ "recipient_role": {
+ "description": "The label for the receiving party in the agreement.",
+ "type": "string"
+ },
+ "sender_last_to_sign": {
+ "description": "When true, the sender signs after the recipient.",
+ "type": "boolean"
+ },
+ "sender_role": {
+ "description": "The label for the sending party in the agreement.",
+ "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"
+ },
+ "template_setting_attributes": {
+ "additionalProperties": false,
+ "description": "Template settings such as standard version and message.",
+ "properties": {
+ "include_message": {
+ "type": "boolean"
+ },
+ "message": {
+ "type": "string"
+ },
+ "standard_version": {
+ "type": "string"
+ },
+ "subsidiary_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"
+ }
+ },
+ "type": "object"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "additional_changes": {
+ "description": "Text of additional changes to include when include_additional_changes is true.",
+ "type": "string"
+ },
+ "attachment_ids": {
+ "description": "UUIDs of attachments to include with the template.",
+ "items": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "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"
+ },
+ "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": {
+ "type": "string"
+ },
+ "confidentiality_type": {
+ "type": "string"
+ },
+ "default_signer_email": {
+ "description": "Default email address pre-filled as the signer when creating agreements from this template.",
+ "format": "email",
+ "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "district_or_county": {
+ "description": "The district or county for dispute resolution.",
+ "type": "string"
+ },
+ "governing_law_country": {
+ "description": "The country whose laws govern agreements created from this template.",
+ "type": "string"
+ },
+ "governing_law_region": {
+ "description": "The state or region whose laws govern agreements created from this template.",
+ "type": "string"
+ },
+ "include_additional_changes": {
+ "description": "Whether to include the additional changes section.",
+ "type": "boolean"
+ },
+ "include_custom_details": {
+ "type": "boolean"
+ },
+ "include_custom_details_val": {
+ "type": "string"
+ },
+ "include_fees": {
+ "type": "boolean"
+ },
+ "include_fees_amount": {
+ "type": "number"
+ },
+ "include_fees_amount_duration": {
+ "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": {
+ "type": "string"
+ },
+ "include_terms": {
+ "description": "Whether to include standard terms in the agreement.",
+ "type": "boolean"
+ },
+ "name": {
+ "description": "A name for the template.",
+ "type": "string"
+ },
+ "negotiations_allowed": {
+ "description": "Whether counterparties can propose changes to agreements created from this template.",
+ "type": "boolean"
+ },
+ "product_name": {
+ "type": "string"
+ },
+ "recipient_role": {
+ "description": "The label for the receiving party in the agreement.",
+ "type": "string"
+ },
+ "sender_last_to_sign": {
+ "description": "When true, the sender signs after the recipient.",
+ "type": "boolean"
+ },
+ "sender_role": {
+ "description": "The label for the sending party in the agreement.",
+ "type": "string"
+ },
+ "template_setting_attributes": {
+ "additionalProperties": false,
+ "description": "Template settings such as standard version and message.",
+ "properties": {
+ "include_message": {
+ "type": "boolean"
+ },
+ "message": {
+ "type": "string"
+ },
+ "standard_version": {
+ "type": "string"
+ },
+ "subsidiary_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"
+ }
+ },
+ "type": "object"
+ }
+ },
+ "type": "object"
+ }
+]create-agreement1 field changedInput schema / properties / body / anyOfPrevious 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": {
- "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": "number"
- },
- "aggregation_limitations_permitted_val": {
- "type": "number"
- },
- "breach_notification_unit": {
- "type": "string"
- },
- "breach_notification_val": {
- "type": "number"
- },
- "business_associate_relationship_type": {
- "type": "string"
- },
- "deidentification_limitations_include_purpose": {
- "type": "number"
- },
- "deidentification_limitations_include_requirements": {
- "type": "number"
- },
- "deidentification_limitations_permitted": {
- "type": "number"
- },
- "deidentification_limitations_purpose_val": {
- "type": "number"
- },
- "deidentification_limitations_requirements_val": {
- "type": "number"
- },
- "designated_record_set_provider_maintains": {
- "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_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": "number"
- },
- "offshore_limitations_permitted_val": {
- "type": "number"
- },
- "subcontract_limitations_include_notice": {
- "type": "number"
- },
- "subcontract_limitations_include_permission": {
- "type": "number"
- },
- "subcontract_limitations_notice_val": {
- "type": "number"
- },
- "subcontract_limitations_permission_val": {
- "type": "number"
- },
- "subcontract_limitations_permitted": {
- "type": "number"
- },
- "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"
- },
- "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-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"
- },
- "default_signer_email": {
- "format": "email",
- "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
- "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": {
- "type": "string"
- },
- "effective_date_type": {
- "type": "string"
- },
- "general_cap_amount": {
- "type": "number"
- },
- "general_cap_amount_type": {
- "type": "number"
- },
- "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": "boolean"
- },
- "include_acceptable_use_policy_type": {
- "type": "boolean"
- },
- "include_additional_warranties": {
- "type": "boolean"
- },
- "include_additional_warranties_by_customer": {
- "type": "boolean"
- },
- "include_additional_warranties_by_provider": {
- "type": "boolean"
- },
- "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": "boolean"
- },
- "include_covered_claims_include_customer_claims": {
- "type": "boolean"
- },
- "include_covered_claims_include_provider_claims": {
- "type": "boolean"
- },
- "include_covered_claims_provider_claims": {
- "type": "boolean"
- },
- "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": "boolean"
- },
- "include_dpa_type": {
- "type": "boolean"
- },
- "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": "boolean"
- },
- "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": "boolean"
- },
- "include_insurance_minimums_cyber_liability_aggregate": {
- "type": "boolean"
- },
- "include_insurance_minimums_cyber_liability_minimum": {
- "type": "boolean"
- },
- "include_insurance_minimums_employer_liability_aggregate": {
- "type": "boolean"
- },
- "include_insurance_minimums_employer_liability_minimum": {
- "type": "boolean"
- },
- "include_insurance_minimums_general_liability_aggregate": {
- "type": "boolean"
- },
- "include_insurance_minimums_general_liability_minimum": {
- "type": "boolean"
- },
- "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": {
- "type": "boolean"
- },
- "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": "boolean"
- },
- "include_security_policy_other": {
- "type": "boolean"
- },
- "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": {
- "type": "boolean"
- },
- "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_terms": {
- "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": "boolean"
- },
- "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": {
- "type": "number"
- },
- "negotiations_allowed": {
- "type": "string"
- },
- "provider": {
- "type": "string"
- },
- "sender_last_to_sign": {
- "type": "boolean"
- },
- "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": "number"
- },
- "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": {
- "type": "number"
- },
- "fees_attributes": {
- "additionalProperties": {
- "anyOf": [
- {
- "additionalProperties": false,
- "properties": {
- "cost": {
- "type": "number"
- },
- "description": {
- "type": "string"
- },
- "fee_type": {
- "type": "string"
- },
- "stripe_product_id": {
- "type": "string"
- },
- "type": {
- "description": "Fee class discriminator.",
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "cost": {
- "type": "number"
- },
- "description": {
- "type": "string"
- },
- "discount_duration_amount": {
- "type": "number"
- },
- "discount_duration_type": {
- "type": "string"
- },
- "discount_type": {
- "type": "string"
- },
- "fee_type": {
- "type": "string"
- },
- "stripe_product_id": {
- "type": "string"
- },
- "type": {
- "description": "Fee class discriminator.",
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "cost": {
- "type": "number"
- },
- "description": {
- "type": "string"
- },
- "fee_type": {
- "type": "string"
- },
- "quantity": {
- "type": "number"
- },
- "stripe_product_id": {
- "type": "string"
- },
- "type": {
- "description": "Fee class discriminator.",
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "attachment_id": {
- "type": "string"
- },
- "description": {
- "type": "string"
- },
- "fee_type": {
- "type": "string"
- },
- "stripe_product_id": {
- "type": "string"
- },
- "type": {
- "description": "Fee class discriminator.",
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "description": {
- "type": "string"
- },
- "fee_type": {
- "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": {
- "type": "string"
- },
- "type": {
- "description": "Fee class discriminator.",
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "description": {
- "type": "string"
- },
- "fee_type": {
- "type": "string"
- },
- "stripe_product_id": {
- "type": "string"
- },
- "type": {
- "description": "Fee class discriminator.",
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "cost": {
- "type": "number"
- },
- "description": {
- "type": "string"
- },
- "fee_type": {
- "type": "string"
- },
- "stripe_product_id": {
- "type": "string"
- },
- "type": {
- "description": "Fee class discriminator.",
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "cost": {
- "type": "number"
- },
- "description": {
- "type": "string"
- },
- "fee_type": {
- "type": "string"
- },
- "stripe_product_id": {
- "type": "string"
- },
- "type": {
- "description": "Fee class discriminator.",
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "description": {
- "type": "string"
- },
- "fee_type": {
- "type": "string"
- },
- "stripe_product_id": {
- "type": "string"
- },
- "type": {
- "description": "Fee class discriminator.",
- "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": {
- "type": "string"
- },
- "fees_include_fee_increase_upon_renewal": {
- "type": "number"
- },
- "fees_include_fee_increase_upon_renewal_fee": {
- "type": "number"
- },
- "fees_include_fee_increase_upon_renewal_type": {
- "type": "number"
- },
- "fees_inclusive_of_taxes": {
- "type": "boolean"
- },
- "framework_terms_type": {
- "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": "boolean"
- },
- "include_fees_table": {
- "type": "boolean"
- },
- "include_fees_table_period": {
- "type": "boolean"
- },
- "include_free_trial": {
- "type": "boolean"
- },
- "include_max_users": {
- "type": "boolean"
- },
- "include_pilot_period": {
- "type": "boolean"
- },
- "include_pilot_period_duration_amount": {
- "type": "boolean"
- },
- "include_pilot_period_duration_type": {
- "type": "boolean"
- },
- "include_pilot_period_include_fees": {
- "type": "boolean"
- },
- "include_pilot_period_include_fees_amount": {
- "type": "boolean"
- },
- "include_pilot_period_include_modifications": {
- "type": "boolean"
- },
- "include_pilot_period_include_modifications_description": {
- "type": "boolean"
- },
- "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": "boolean"
- },
- "include_product_support_type": {
- "type": "boolean"
- },
- "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": "boolean"
- },
- "include_professional_services_description": {
- "type": "boolean"
- },
- "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": "boolean"
- },
- "include_professional_services_include_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_include_fees_description": {
- "type": "boolean"
- },
- "include_professional_services_type": {
- "type": "boolean"
- },
- "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": "boolean"
- },
- "include_sla_include_response_time": {
- "type": "boolean"
- },
- "include_sla_include_response_time_amount": {
- "type": "boolean"
- },
- "include_sla_include_response_time_credit": {
- "type": "boolean"
- },
- "include_sla_include_response_time_duration": {
- "type": "boolean"
- },
- "include_sla_include_response_time_support_channel": {
- "type": "boolean"
- },
- "include_sla_include_target_uptime": {
- "type": "boolean"
- },
- "include_sla_maintenance_notice": {
- "type": "boolean"
- },
- "include_sla_maintenance_window": {
- "type": "boolean"
- },
- "include_sla_maintenance_window_type": {
- "type": "boolean"
- },
- "include_sla_standard_maintenance_notice_qty": {
- "type": "boolean"
- },
- "include_sla_standard_maintenance_notice_unit": {
- "type": "boolean"
- },
- "include_sla_standard_maintenance_window_end_time": {
- "type": "boolean"
- },
- "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": "boolean"
- },
- "include_sla_standard_maintenance_window_sunday": {
- "type": "boolean"
- },
- "include_sla_standard_maintenance_window_thursday": {
- "type": "boolean"
- },
- "include_sla_standard_maintenance_window_time_zone": {
- "type": "boolean"
- },
- "include_sla_standard_maintenance_window_tuesday": {
- "type": "boolean"
- },
- "include_sla_standard_maintenance_window_wednesday": {
- "type": "boolean"
- },
- "include_sla_standard_target_uptime": {
- "type": "boolean"
- },
- "include_sla_type": {
- "type": "boolean"
- },
- "include_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"
- },
- "include_subscription_start_date_date": {
- "type": "boolean"
- },
- "include_usage_review": {
- "type": "boolean"
- },
- "include_usage_review_val": {
- "type": "boolean"
- },
- "include_use_limitations": {
- "type": "boolean"
- },
- "include_use_limitations_val": {
- "type": "boolean"
- },
- "invoice_period": {
- "type": "number"
- },
- "invoice_period_custom_unit": {
- "type": "number"
- },
- "max_consumption": {
- "type": "number"
- },
- "max_users": {
- "type": "number"
- },
- "negotiations_allowed": {
- "type": "string"
- },
- "order_date_date": {
- "type": "string"
- },
- "order_date_other": {
- "type": "string"
- },
- "order_date_type": {
- "type": "string"
- },
- "payment_period": {
- "type": "number"
- },
- "payment_period_timeframe": {
- "type": "number"
- },
- "payment_period_unit": {
- "type": "number"
- },
- "payment_process_automatic_frequency": {
- "type": "string"
- },
- "payment_process_type": {
- "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": {
- "type": "string"
- },
- "payment_process_type_invoice_duration_start": {
- "type": "string"
- },
- "payment_process_type_invoice_type": {
- "type": "string"
- },
- "pilot_period_stripe_product_id": {
- "type": "number"
- },
- "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": {
- "type": "string"
- },
- "subscription_period": {
- "type": "number"
- },
- "subscription_period_unit": {
- "type": "number"
- },
- "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": {
- "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": "boolean"
- },
- "include_fees_description": {
- "type": "boolean"
- },
- "include_fees_pay_by_amount": {
- "type": "boolean"
- },
- "include_fees_type": {
- "type": "boolean"
- },
- "include_fees_unit": {
- "type": "boolean"
- },
- "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": "boolean"
- },
- "include_program_discount": {
- "type": "boolean"
- },
- "include_program_discount_amount": {
- "type": "boolean"
- },
- "include_program_discount_unit": {
- "type": "boolean"
- },
- "include_program_participation_feedback": {
- "type": "boolean"
- },
- "include_program_participation_feedback_amount": {
- "type": "boolean"
- },
- "include_program_participation_feedback_unit": {
- "type": "boolean"
- },
- "include_program_partner_other": {
- "type": "boolean"
- },
- "include_program_partner_other_val": {
- "type": "boolean"
- },
- "include_program_provider_other": {
- "type": "boolean"
- },
- "include_program_provider_other_val": {
- "type": "boolean"
- },
- "include_program_reference": {
- "type": "boolean"
- },
- "product_description": {
- "type": "string"
- },
- "term_amount": {
- "type": "number"
- },
- "term_unit": {
- "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": {
- "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": "number"
- },
- "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": {
- "type": "string"
- },
- "data_importer_address": {
- "type": "string"
- },
- "data_importer_address_city": {
- "type": "string"
- },
- "data_importer_address_country": {
- "type": "number"
- },
- "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": "boolean"
- },
- "include_covered_claim_internal_val": {
- "type": "boolean"
- },
- "include_covered_claim_type": {
- "type": "boolean"
- },
- "include_data_subjects_custom": {
- "type": "boolean"
- },
- "include_data_subjects_custom_val": {
- "type": "boolean"
- },
- "include_data_subjects_employees": {
- "type": "boolean"
- },
- "include_data_subjects_end_users": {
- "type": "boolean"
- },
- "include_external_subprocessor_location": {
- "type": "boolean"
- },
- "include_frequency_of_transfer_continuous": {
- "type": "boolean"
- },
- "include_frequency_of_transfer_custom": {
- "type": "boolean"
- },
- "include_frequency_of_transfer_custom_val": {
- "type": "boolean"
- },
- "include_governing_country_eu": {
- "type": "boolean"
- },
- "include_governing_country_eu_val": {
- "type": "boolean"
- },
- "include_governing_country_uk": {
- "type": "boolean"
- },
- "include_governing_country_uk_val": {
- "type": "boolean"
- },
- "include_governing_law": {
- "type": "boolean"
- },
- "include_governing_law_country": {
- "type": "boolean"
- },
- "include_governing_law_state": {
- "type": "boolean"
- },
- "include_increased_claim_amount": {
- "type": "boolean"
- },
- "include_increased_claim_amount_currency": {
- "type": "boolean"
- },
- "include_increased_claim_amount_qty": {
- "type": "boolean"
- },
- "include_increased_claim_amount_type": {
- "type": "boolean"
- },
- "include_liability_cap": {
- "type": "boolean"
- },
- "include_liability_cap_amount_constant_external": {
- "type": "boolean"
- },
- "include_liability_cap_amount_constant_internal": {
- "type": "boolean"
- },
- "include_liability_cap_amount_currency_external": {
- "type": "boolean"
- },
- "include_liability_cap_amount_currency_internal": {
- "type": "boolean"
- },
- "include_liability_cap_csa_type": {
- "type": "boolean"
- },
- "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": "boolean"
- },
- "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": "boolean"
- },
- "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": "boolean"
- },
- "include_provider_security_contact_address_country": {
- "type": "boolean"
- },
- "include_provider_security_contact_address_state": {
- "type": "boolean"
- },
- "include_provider_security_contact_address_street_address": {
- "type": "boolean"
- },
- "include_provider_security_contact_address_zipcode": {
- "type": "boolean"
- },
- "include_provider_security_contact_email": {
- "format": "email",
- "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
- "type": "string"
- },
- "include_provider_security_contact_email_val": {
- "type": "boolean"
- },
- "include_security_measures_accountability": {
- "type": "boolean"
- },
- "include_security_measures_accountability_val": {
- "type": "boolean"
- },
- "include_security_measures_certification_or_assurance": {
- "type": "boolean"
- },
- "include_security_measures_certification_or_assurance_val": {
- "type": "boolean"
- },
- "include_security_measures_confidentiality_integrity": {
- "type": "boolean"
- },
- "include_security_measures_confidentiality_integrity_val": {
- "type": "boolean"
- },
- "include_security_measures_data_at_rest": {
- "type": "boolean"
- },
- "include_security_measures_data_at_rest_val": {
- "type": "boolean"
- },
- "include_security_measures_data_minimization": {
- "type": "boolean"
- },
- "include_security_measures_data_minimization_val": {
- "type": "boolean"
- },
- "include_security_measures_data_quality": {
- "type": "boolean"
- },
- "include_security_measures_data_quality_val": {
- "type": "boolean"
- },
- "include_security_measures_data_retention": {
- "type": "boolean"
- },
- "include_security_measures_data_retention_val": {
- "type": "boolean"
- },
- "include_security_measures_data_transmission": {
- "type": "boolean"
- },
- "include_security_measures_data_transmission_val": {
- "type": "boolean"
- },
- "include_security_measures_event_logging": {
- "type": "boolean"
- },
- "include_security_measures_event_logging_val": {
- "type": "boolean"
- },
- "include_security_measures_identity_auth": {
- "type": "boolean"
- },
- "include_security_measures_identity_auth_val": {
- "type": "boolean"
- },
- "include_security_measures_it_security_governance": {
- "type": "boolean"
- },
- "include_security_measures_it_security_governance_val": {
- "type": "boolean"
- },
- "include_security_measures_physical_security": {
- "type": "boolean"
- },
- "include_security_measures_physical_security_val": {
- "type": "boolean"
- },
- "include_security_measures_portability_and_erasure": {
- "type": "boolean"
- },
- "include_security_measures_portability_and_erasure_val": {
- "type": "boolean"
- },
- "include_security_measures_pseudonym_encryption": {
- "type": "boolean"
- },
- "include_security_measures_pseudonym_encryption_val": {
- "type": "boolean"
- },
- "include_security_measures_restore_data_access": {
- "type": "boolean"
- },
- "include_security_measures_restore_data_access_val": {
- "type": "boolean"
- },
- "include_security_measures_security_policy": {
- "type": "boolean"
- },
- "include_security_measures_system_configuration": {
- "type": "boolean"
- },
- "include_security_measures_system_configuration_val": {
- "type": "boolean"
- },
- "include_security_measures_testing_assessment": {
- "type": "boolean"
- },
- "include_security_measures_testing_assessment_val": {
- "type": "boolean"
- },
- "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": "boolean"
- },
- "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": "boolean"
- },
- "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": {
- "type": "string"
- },
- "subprocessors_attributes": {
- "additionalProperties": {
- "additionalProperties": false,
- "properties": {
- "country": {
- "type": "string"
- },
- "name": {
- "type": "string"
- },
- "processing_task": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "description": "Subprocessors. Use string keys such as \"0\", \"1\".",
- "propertyNames": {
- "type": "string"
- },
- "type": "object"
- },
- "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"
- },
- "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"
- },
- "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": "string"
- },
- "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": "string"
- },
- "confidentiality_nda_type": {
- "type": "string"
- },
- "confidentiality_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"
- },
- "include_custom_details": {
- "type": "boolean"
- },
- "include_custom_details_val": {
- "type": "boolean"
- },
- "include_fees": {
- "type": "boolean"
- },
- "include_fees_amount": {
- "type": "boolean"
- },
- "include_fees_amount_duration": {
- "type": "boolean"
- },
- "include_fees_include_amount": {
- "type": "boolean"
- },
- "include_fees_include_other": {
- "type": "boolean"
- },
- "include_fees_other": {
- "type": "boolean"
- },
- "include_functionality": {
- "type": "boolean"
- },
- "include_functionality_val": {
- "type": "boolean"
- },
- "include_launch_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_launch_date_custom": {
- "type": "boolean"
- },
- "include_launch_date_date": {
- "type": "boolean"
- },
- "include_launch_date_type": {
- "type": "boolean"
- },
- "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"
- },
- "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": {
- "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": {
- "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_include_company": {
- "type": "boolean"
- },
- "include_additional_warranties_include_company_val": {
- "type": "boolean"
- },
- "include_additional_warranties_include_partner": {
- "type": "boolean"
- },
- "include_additional_warranties_include_partner_val": {
- "type": "boolean"
- },
- "include_brand_guidelines": {
- "type": "boolean"
- },
- "include_brand_guidelines_include_company": {
- "type": "boolean"
- },
- "include_brand_guidelines_include_company_val": {
- "type": "boolean"
- },
- "include_brand_guidelines_include_partner": {
- "type": "boolean"
- },
- "include_brand_guidelines_include_partner_val": {
- "type": "boolean"
- },
- "include_covered_claims": {
- "type": "boolean"
- },
- "include_covered_claims_company_claims": {
- "type": "boolean"
- },
- "include_covered_claims_include_company_claims": {
- "type": "boolean"
- },
- "include_covered_claims_include_partner_claims": {
- "type": "boolean"
- },
- "include_covered_claims_partner_claims": {
- "type": "boolean"
- },
- "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": "boolean"
- },
- "include_dpa_type": {
- "type": "boolean"
- },
- "include_increased_cap_amount": {
- "type": "boolean"
- },
- "include_increased_cap_amount_currency": {
- "type": "boolean"
- },
- "include_increased_cap_amount_either_currency": {
- "type": "boolean"
- },
- "include_increased_cap_amount_either_multiple": {
- "type": "boolean"
- },
- "include_increased_cap_amount_multiple": {
- "type": "boolean"
- },
- "include_increased_cap_amount_type": {
- "type": "boolean"
- },
- "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": "boolean"
- },
- "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": "boolean"
- },
- "negotiations_allowed": {
- "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": {
- "type": "string"
- },
- "end_date_date": {
- "type": "string"
- },
- "end_date_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"
- },
- "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": "boolean"
- },
- "include_obligations_company_promotion_include_materials": {
- "type": "boolean"
- },
- "include_obligations_company_promotion_include_materials_val": {
- "type": "boolean"
- },
- "include_obligations_company_referral": {
- "type": "boolean"
- },
- "include_obligations_company_referral_include_criteria": {
- "type": "boolean"
- },
- "include_obligations_company_referral_include_criteria_val": {
- "type": "boolean"
- },
- "include_obligations_company_referral_include_pay_sch": {
- "type": "boolean"
- },
- "include_obligations_company_referral_include_pay_sch_amount": {
- "type": "boolean"
- },
- "include_obligations_company_referral_include_pay_sch_custom": {
- "type": "boolean"
- },
- "include_obligations_company_referral_include_pay_sch_unit": {
- "type": "boolean"
- },
- "include_obligations_company_sponsorship": {
- "type": "boolean"
- },
- "include_obligations_company_sponsorship_include_benefits": {
- "type": "boolean"
- },
- "include_obligations_company_sponsorship_include_benefits_val": {
- "type": "boolean"
- },
- "include_obligations_company_sponsorship_include_payments": {
- "type": "boolean"
- },
- "include_obligations_company_sponsorship_include_payments_amount": {
- "type": "boolean"
- },
- "include_obligations_company_sponsorship_include_payments_unit": {
- "type": "boolean"
- },
- "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": "boolean"
- },
- "include_obligations_partner_promotion_include_materials": {
- "type": "boolean"
- },
- "include_obligations_partner_promotion_include_materials_val": {
- "type": "boolean"
- },
- "include_obligations_partner_referral": {
- "type": "boolean"
- },
- "include_obligations_partner_referral_include_criteria": {
- "type": "boolean"
- },
- "include_obligations_partner_referral_include_criteria_val": {
- "type": "boolean"
- },
- "include_obligations_partner_referral_include_pay_sch": {
- "type": "boolean"
- },
- "include_obligations_partner_referral_include_pay_sch_amount": {
- "type": "boolean"
- },
- "include_obligations_partner_referral_include_pay_sch_custom": {
- "type": "boolean"
- },
- "include_obligations_partner_referral_include_pay_sch_unit": {
- "type": "boolean"
- },
- "include_obligations_partner_sponsorship": {
- "type": "boolean"
- },
- "include_obligations_partner_sponsorship_include_benefits": {
- "type": "boolean"
- },
- "include_obligations_partner_sponsorship_include_benefits_val": {
- "type": "boolean"
- },
- "include_obligations_partner_sponsorship_include_payments": {
- "type": "boolean"
- },
- "include_obligations_partner_sponsorship_include_payments_amount": {
- "type": "boolean"
- },
- "include_obligations_partner_sponsorship_include_payments_unit": {
- "type": "boolean"
- },
- "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": "boolean"
- },
- "include_payment_process_company_include_address_country": {
- "type": "boolean"
- },
- "include_payment_process_company_include_address_state": {
- "type": "boolean"
- },
- "include_payment_process_company_include_address_street_address": {
- "type": "boolean"
- },
- "include_payment_process_company_include_address_zipcode": {
- "type": "boolean"
- },
- "include_payment_process_company_include_email": {
- "format": "email",
- "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
- "type": "string"
- },
- "include_payment_process_company_include_email_val": {
- "type": "boolean"
- },
- "include_payment_process_partner": {
- "type": "boolean"
- },
- "include_payment_process_partner_include_address": {
- "type": "boolean"
- },
- "include_payment_process_partner_include_address_city": {
- "type": "boolean"
- },
- "include_payment_process_partner_include_address_country": {
- "type": "boolean"
- },
- "include_payment_process_partner_include_address_state": {
- "type": "boolean"
- },
- "include_payment_process_partner_include_address_street_address": {
- "type": "boolean"
- },
- "include_payment_process_partner_include_address_zipcode": {
- "type": "boolean"
- },
- "include_payment_process_partner_include_email": {
- "format": "email",
- "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
- "type": "string"
- },
- "include_payment_process_partner_include_email_val": {
- "type": "boolean"
- },
- "include_payment_schedule": {
- "type": "boolean"
- },
- "include_payment_schedule_custom": {
- "type": "boolean"
- },
- "include_payment_schedule_specified_amount": {
- "type": "boolean"
- },
- "include_payment_schedule_specified_timeframe": {
- "type": "boolean"
- },
- "include_payment_schedule_specified_unit": {
- "type": "boolean"
- },
- "include_payment_schedule_type": {
- "type": "boolean"
- },
- "negotiations_allowed": {
- "type": "string"
- },
- "territory_type": {
- "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": {
- "type": "string"
- },
- "general_cap_amount": {
- "type": "number"
- },
- "general_cap_amount_type": {
- "type": "number"
- },
- "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": "boolean"
- },
- "include_dpa_type": {
- "type": "boolean"
- },
- "include_payment_process": {
- "type": "boolean"
- },
- "include_technical_support": {
- "type": "boolean"
- },
- "negotiations_allowed": {
- "type": "string"
- },
- "payment_process_automatic_frequency": {
- "type": "string"
- },
- "payment_process_invoice_days": {
- "type": "number"
- },
- "payment_process_invoice_from": {
- "type": "string"
- },
- "payment_process_invoice_timeframe": {
- "type": "string"
- },
- "payment_process_type": {
- "type": "string"
- },
- "pilot_period_description": {
- "type": "number"
- },
- "pilot_period_fees_description": {
- "type": "number"
- },
- "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"
- },
- "default_signer_email": {
- "format": "email",
- "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
- "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": {
- "type": "string"
- },
- "general_cap_amount": {
- "type": "number"
- },
- "general_cap_amount_type": {
- "type": "number"
- },
- "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": "boolean"
- },
- "include_additional_warranties_by_provider": {
- "type": "boolean"
- },
- "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": "boolean"
- },
- "include_covered_claims_include_customer_claims": {
- "type": "boolean"
- },
- "include_covered_claims_include_provider_claims": {
- "type": "boolean"
- },
- "include_covered_claims_provider_claims": {
- "type": "boolean"
- },
- "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": "boolean"
- },
- "include_customer_insurance_min_auto_liability_minimum": {
- "type": "boolean"
- },
- "include_customer_insurance_min_cyber_liability_aggregate": {
- "type": "boolean"
- },
- "include_customer_insurance_min_cyber_liability_minimum": {
- "type": "boolean"
- },
- "include_customer_insurance_min_employer_liability_aggregate": {
- "type": "boolean"
- },
- "include_customer_insurance_min_employer_liability_minimum": {
- "type": "boolean"
- },
- "include_customer_insurance_min_general_liability_aggregate": {
- "type": "boolean"
- },
- "include_customer_insurance_min_general_liability_minimum": {
- "type": "boolean"
- },
- "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": "boolean"
- },
- "include_customer_policies_type": {
- "type": "boolean"
- },
- "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": "boolean"
- },
- "include_dpa_type": {
- "type": "boolean"
- },
- "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": "boolean"
- },
- "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": "boolean"
- },
- "include_provider_insurance_min_auto_liability_minimum": {
- "type": "boolean"
- },
- "include_provider_insurance_min_cyber_liability_aggregate": {
- "type": "boolean"
- },
- "include_provider_insurance_min_cyber_liability_minimum": {
- "type": "boolean"
- },
- "include_provider_insurance_min_employer_liability_aggregate": {
- "type": "boolean"
- },
- "include_provider_insurance_min_employer_liability_minimum": {
- "type": "boolean"
- },
- "include_provider_insurance_min_general_liability_aggregate": {
- "type": "boolean"
- },
- "include_provider_insurance_min_general_liability_minimum": {
- "type": "boolean"
- },
- "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": {
- "type": "boolean"
- },
- "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": "boolean"
- },
- "include_security_policy_iso27001": {
- "type": "boolean"
- },
- "include_security_policy_location": {
- "type": "boolean"
- },
- "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": {
- "type": "boolean"
- },
- "include_terms": {
- "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_negligence": {
- "type": "boolean"
- },
- "include_unlimited_claims_other": {
- "type": "boolean"
- },
- "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": {
- "type": "number"
- },
- "negotiations_allowed": {
- "type": "string"
- },
- "sender_last_to_sign": {
- "type": "boolean"
- }
- },
- "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": {
- "description": "Fee line items. Use string keys such as \"0\", \"1\". Replaces template fees when provided."
- },
- "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": "boolean"
- },
- "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": "boolean"
- },
- "include_deliverables_include_acceptance": {
- "type": "boolean"
- },
- "include_deliverables_include_attachment": {
- "type": "boolean"
- },
- "include_deliverables_include_draft_deliverables": {
- "type": "boolean"
- },
- "include_deliverables_rejection_amount": {
- "type": "boolean"
- },
- "include_deliverables_rejection_unit": {
- "type": "boolean"
- },
- "include_deliverables_resubmission_amount": {
- "type": "boolean"
- },
- "include_deliverables_resubmission_unit": {
- "type": "boolean"
- },
- "include_fees_other": {
- "type": "boolean"
- },
- "include_fees_other_val": {
- "type": "boolean"
- },
- "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": {
- "type": "boolean"
- },
- "include_fees_travel_val": {
- "type": "boolean"
- },
- "include_third_party_customer": {
- "type": "boolean"
- },
- "include_third_party_include_description": {
- "type": "boolean"
- },
- "include_third_party_include_description_val": {
- "type": "boolean"
- },
- "include_third_party_materials": {
- "type": "boolean"
- },
- "include_third_party_provider": {
- "type": "boolean"
- },
- "include_time_of_assignment": {
- "type": "boolean"
- },
- "include_time_of_assignment_type": {
- "type": "boolean"
- },
- "invoice_period_description": {
- "type": "number"
- },
- "negotiations_allowed": {
- "type": "string"
- },
- "payment_period": {
- "type": "number"
- },
- "payment_period_other": {
- "type": "number"
- },
- "payment_period_timeframe": {
- "type": "number"
- },
- "payment_period_type": {
- "type": "number"
- },
- "payment_period_unit": {
- "type": "number"
- },
- "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": {
- "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": {
- "type": "string"
- },
- "sow_term_unit": {
- "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-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-z]{2,}$",
- "type": "string"
- },
- "recipient_organization": {
- "type": "string"
- },
- "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-z]{2,}$",
- "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": {
- "type": "string"
- },
- "general_cap_amount": {
- "type": "number"
- },
- "general_cap_amount_type": {
- "type": "number"
- },
- "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": "boolean"
- },
- "include_additional_warranties_by_provider": {
- "type": "boolean"
- },
- "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": "boolean"
- },
- "include_covered_claims_include_customer_claims": {
- "type": "boolean"
- },
- "include_covered_claims_include_provider_claims": {
- "type": "boolean"
- },
- "include_covered_claims_provider_claims": {
- "type": "boolean"
- },
- "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": "boolean"
- },
- "include_dpa_type": {
- "type": "boolean"
- },
- "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": "boolean"
- },
- "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": "boolean"
- },
- "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": {
- "type": "number"
- }
- },
- "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": "string"
- },
- "deletion_procedure_include_custom_description": {
- "type": "string"
- },
- "deletion_procedure_include_customer_disable": {
- "type": "string"
- },
- "deletion_procedure_include_customer_proof": {
- "type": "string"
- },
- "deletion_procedure_include_provider_disable": {
- "type": "string"
- },
- "fee_custom_unit": {
- "type": "string"
- },
- "fee_period": {
- "type": "number"
- },
- "fees_attributes": {
- "description": "Fee line items. Use string keys such as \"0\", \"1\". Replaces template fees when provided."
- },
- "fees_currency": {
- "type": "string"
- },
- "fees_include_fee_increase_upon_renewal": {
- "type": "number"
- },
- "fees_include_fee_increase_upon_renewal_fee": {
- "type": "number"
- },
- "fees_include_fee_increase_upon_renewal_type": {
- "type": "number"
- },
- "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": "boolean"
- },
- "include_license_limits": {
- "type": "boolean"
- },
- "include_license_limits_description": {
- "type": "boolean"
- },
- "include_payment_process_include_billing_email": {
- "format": "email",
- "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
- "type": "string"
- },
- "include_pilot_period": {
- "type": "boolean"
- },
- "include_pilot_period_duration_amount": {
- "type": "boolean"
- },
- "include_pilot_period_duration_type": {
- "type": "boolean"
- },
- "include_pilot_period_include_fees": {
- "type": "boolean"
- },
- "include_pilot_period_include_fees_amount": {
- "type": "boolean"
- },
- "include_pilot_period_include_modifications": {
- "type": "boolean"
- },
- "include_pilot_period_include_modifications_description": {
- "type": "boolean"
- },
- "include_services": {
- "type": "boolean"
- },
- "include_services_description": {
- "type": "boolean"
- },
- "negotiations_allowed": {
- "type": "string"
- },
- "order_date_date": {
- "type": "string"
- },
- "order_date_type": {
- "type": "string"
- },
- "payment_process_automatic_frequency": {
- "type": "string"
- },
- "payment_process_type": {
- "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": {
- "type": "string"
- },
- "payment_process_type_invoice_duration_start": {
- "type": "string"
- },
- "payment_process_type_invoice_type": {
- "type": "string"
- },
- "permitted_uses_include_custom": {
- "type": "string"
- },
- "permitted_uses_include_custom_description": {
- "type": "string"
- },
- "permitted_uses_include_customers_affiliates": {
- "type": "string"
- },
- "permitted_uses_include_internal_business": {
- "type": "string"
- },
- "pilot_period_stripe_product_id": {
- "type": "number"
- },
- "software_description": {
- "type": "string"
- },
- "subscription_auto_renew": {
- "type": "string"
- },
- "subscription_period": {
- "type": "number"
- },
- "subscription_period_unit": {
- "type": "number"
- },
- "subscription_renewal_notice_days": {
- "type": "number"
- },
- "warranty_period_description_amount": {
- "type": "number"
- },
- "warranty_period_description_duration": {
- "type": "number"
- },
- "warranty_period_description_duration_start": {
- "type": "number"
- },
- "warranty_period_type": {
- "type": "number"
- }
- },
- "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-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-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": {},
- "cc_users": {
- "items": {
- "format": "email",
- "pattern": "^(?!\\.)(?!.*\\.\\.)([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": {},
- "cc_users": {
- "items": {
- "format": "email",
- "pattern": "^(?!\\.)(?!.*\\.\\.)([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-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": {},
- "cc_users": {
- "items": {
- "format": "email",
- "pattern": "^(?!\\.)(?!.*\\.\\.)([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": {
+ "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": "number"
+ },
+ "aggregation_limitations_permitted_val": {
+ "type": "number"
+ },
+ "breach_notification_unit": {
+ "type": "string"
+ },
+ "breach_notification_val": {
+ "type": "number"
+ },
+ "business_associate_relationship_type": {
+ "type": "string"
+ },
+ "deidentification_limitations_include_purpose": {
+ "type": "number"
+ },
+ "deidentification_limitations_include_requirements": {
+ "type": "number"
+ },
+ "deidentification_limitations_permitted": {
+ "type": "number"
+ },
+ "deidentification_limitations_purpose_val": {
+ "type": "number"
+ },
+ "deidentification_limitations_requirements_val": {
+ "type": "number"
+ },
+ "designated_record_set_provider_maintains": {
+ "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_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": "number"
+ },
+ "offshore_limitations_permitted_val": {
+ "type": "number"
+ },
+ "subcontract_limitations_include_notice": {
+ "type": "number"
+ },
+ "subcontract_limitations_include_permission": {
+ "type": "number"
+ },
+ "subcontract_limitations_notice_val": {
+ "type": "number"
+ },
+ "subcontract_limitations_permission_val": {
+ "type": "number"
+ },
+ "subcontract_limitations_permitted": {
+ "type": "number"
+ },
+ "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"
+ },
+ "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-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"
+ },
+ "default_signer_email": {
+ "format": "email",
+ "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "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": {
+ "type": "string"
+ },
+ "effective_date_type": {
+ "type": "string"
+ },
+ "general_cap_amount": {
+ "type": "number"
+ },
+ "general_cap_amount_type": {
+ "type": "number"
+ },
+ "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": "boolean"
+ },
+ "include_acceptable_use_policy_type": {
+ "type": "boolean"
+ },
+ "include_additional_warranties": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_by_customer": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_by_provider": {
+ "type": "boolean"
+ },
+ "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": "boolean"
+ },
+ "include_covered_claims_include_customer_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_include_provider_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_provider_claims": {
+ "type": "boolean"
+ },
+ "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": "boolean"
+ },
+ "include_dpa_type": {
+ "type": "boolean"
+ },
+ "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": "boolean"
+ },
+ "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": "boolean"
+ },
+ "include_insurance_minimums_cyber_liability_aggregate": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_cyber_liability_minimum": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_employer_liability_aggregate": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_employer_liability_minimum": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_general_liability_aggregate": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_general_liability_minimum": {
+ "type": "boolean"
+ },
+ "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": {
+ "type": "boolean"
+ },
+ "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": "boolean"
+ },
+ "include_security_policy_other": {
+ "type": "boolean"
+ },
+ "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": {
+ "type": "boolean"
+ },
+ "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_terms": {
+ "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": "boolean"
+ },
+ "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": {
+ "type": "number"
+ },
+ "negotiations_allowed": {
+ "type": "string"
+ },
+ "provider": {
+ "type": "string"
+ },
+ "sender_last_to_sign": {
+ "type": "boolean"
+ },
+ "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": "number"
+ },
+ "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": {
+ "type": "number"
+ },
+ "fees_attributes": {
+ "additionalProperties": {
+ "anyOf": [
+ {
+ "additionalProperties": false,
+ "properties": {
+ "cost": {
+ "type": "number"
+ },
+ "description": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class discriminator.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "cost": {
+ "type": "number"
+ },
+ "description": {
+ "type": "string"
+ },
+ "discount_duration_amount": {
+ "type": "number"
+ },
+ "discount_duration_type": {
+ "type": "string"
+ },
+ "discount_type": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class discriminator.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "cost": {
+ "type": "number"
+ },
+ "description": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "quantity": {
+ "type": "number"
+ },
+ "stripe_product_id": {
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class discriminator.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "attachment_id": {
+ "type": "string"
+ },
+ "description": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class discriminator.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "description": {
+ "type": "string"
+ },
+ "fee_type": {
+ "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": {
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class discriminator.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "description": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class discriminator.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "cost": {
+ "type": "number"
+ },
+ "description": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class discriminator.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "cost": {
+ "type": "number"
+ },
+ "description": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class discriminator.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "description": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class discriminator.",
+ "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": {
+ "type": "string"
+ },
+ "fees_include_fee_increase_upon_renewal": {
+ "type": "number"
+ },
+ "fees_include_fee_increase_upon_renewal_fee": {
+ "type": "number"
+ },
+ "fees_include_fee_increase_upon_renewal_type": {
+ "type": "number"
+ },
+ "fees_inclusive_of_taxes": {
+ "type": "boolean"
+ },
+ "framework_terms_type": {
+ "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": "boolean"
+ },
+ "include_fees_table": {
+ "type": "boolean"
+ },
+ "include_fees_table_period": {
+ "type": "boolean"
+ },
+ "include_free_trial": {
+ "type": "boolean"
+ },
+ "include_max_users": {
+ "type": "boolean"
+ },
+ "include_pilot_period": {
+ "type": "boolean"
+ },
+ "include_pilot_period_duration_amount": {
+ "type": "boolean"
+ },
+ "include_pilot_period_duration_type": {
+ "type": "boolean"
+ },
+ "include_pilot_period_include_fees": {
+ "type": "boolean"
+ },
+ "include_pilot_period_include_fees_amount": {
+ "type": "boolean"
+ },
+ "include_pilot_period_include_modifications": {
+ "type": "boolean"
+ },
+ "include_pilot_period_include_modifications_description": {
+ "type": "boolean"
+ },
+ "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": "boolean"
+ },
+ "include_product_support_type": {
+ "type": "boolean"
+ },
+ "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": "boolean"
+ },
+ "include_professional_services_description": {
+ "type": "boolean"
+ },
+ "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": "boolean"
+ },
+ "include_professional_services_include_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_include_fees_description": {
+ "type": "boolean"
+ },
+ "include_professional_services_type": {
+ "type": "boolean"
+ },
+ "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": "boolean"
+ },
+ "include_sla_include_response_time": {
+ "type": "boolean"
+ },
+ "include_sla_include_response_time_amount": {
+ "type": "boolean"
+ },
+ "include_sla_include_response_time_credit": {
+ "type": "boolean"
+ },
+ "include_sla_include_response_time_duration": {
+ "type": "boolean"
+ },
+ "include_sla_include_response_time_support_channel": {
+ "type": "boolean"
+ },
+ "include_sla_include_target_uptime": {
+ "type": "boolean"
+ },
+ "include_sla_maintenance_notice": {
+ "type": "boolean"
+ },
+ "include_sla_maintenance_window": {
+ "type": "boolean"
+ },
+ "include_sla_maintenance_window_type": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_notice_qty": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_notice_unit": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_end_time": {
+ "type": "boolean"
+ },
+ "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": "boolean"
+ },
+ "include_sla_standard_maintenance_window_sunday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_thursday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_time_zone": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_tuesday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_wednesday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_target_uptime": {
+ "type": "boolean"
+ },
+ "include_sla_type": {
+ "type": "boolean"
+ },
+ "include_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"
+ },
+ "include_subscription_start_date_date": {
+ "type": "boolean"
+ },
+ "include_usage_review": {
+ "type": "boolean"
+ },
+ "include_usage_review_val": {
+ "type": "boolean"
+ },
+ "include_use_limitations": {
+ "type": "boolean"
+ },
+ "include_use_limitations_val": {
+ "type": "boolean"
+ },
+ "invoice_period": {
+ "type": "number"
+ },
+ "invoice_period_custom_unit": {
+ "type": "number"
+ },
+ "max_consumption": {
+ "type": "number"
+ },
+ "max_users": {
+ "type": "number"
+ },
+ "negotiations_allowed": {
+ "type": "string"
+ },
+ "order_date_date": {
+ "type": "string"
+ },
+ "order_date_other": {
+ "type": "string"
+ },
+ "order_date_type": {
+ "type": "string"
+ },
+ "payment_period": {
+ "type": "number"
+ },
+ "payment_period_timeframe": {
+ "type": "number"
+ },
+ "payment_period_unit": {
+ "type": "number"
+ },
+ "payment_process_automatic_frequency": {
+ "type": "string"
+ },
+ "payment_process_type": {
+ "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": {
+ "type": "string"
+ },
+ "payment_process_type_invoice_duration_start": {
+ "type": "string"
+ },
+ "payment_process_type_invoice_type": {
+ "type": "string"
+ },
+ "pilot_period_stripe_product_id": {
+ "type": "number"
+ },
+ "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": {
+ "type": "string"
+ },
+ "subscription_period": {
+ "type": "number"
+ },
+ "subscription_period_unit": {
+ "type": "number"
+ },
+ "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": {
+ "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": "boolean"
+ },
+ "include_fees_description": {
+ "type": "boolean"
+ },
+ "include_fees_pay_by_amount": {
+ "type": "boolean"
+ },
+ "include_fees_type": {
+ "type": "boolean"
+ },
+ "include_fees_unit": {
+ "type": "boolean"
+ },
+ "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": "boolean"
+ },
+ "include_program_discount": {
+ "type": "boolean"
+ },
+ "include_program_discount_amount": {
+ "type": "boolean"
+ },
+ "include_program_discount_unit": {
+ "type": "boolean"
+ },
+ "include_program_participation_feedback": {
+ "type": "boolean"
+ },
+ "include_program_participation_feedback_amount": {
+ "type": "boolean"
+ },
+ "include_program_participation_feedback_unit": {
+ "type": "boolean"
+ },
+ "include_program_partner_other": {
+ "type": "boolean"
+ },
+ "include_program_partner_other_val": {
+ "type": "boolean"
+ },
+ "include_program_provider_other": {
+ "type": "boolean"
+ },
+ "include_program_provider_other_val": {
+ "type": "boolean"
+ },
+ "include_program_reference": {
+ "type": "boolean"
+ },
+ "product_description": {
+ "type": "string"
+ },
+ "term_amount": {
+ "type": "number"
+ },
+ "term_unit": {
+ "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": {
+ "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": "number"
+ },
+ "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": {
+ "type": "string"
+ },
+ "data_importer_address": {
+ "type": "string"
+ },
+ "data_importer_address_city": {
+ "type": "string"
+ },
+ "data_importer_address_country": {
+ "type": "number"
+ },
+ "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": "boolean"
+ },
+ "include_covered_claim_internal_val": {
+ "type": "boolean"
+ },
+ "include_covered_claim_type": {
+ "type": "boolean"
+ },
+ "include_data_subjects_custom": {
+ "type": "boolean"
+ },
+ "include_data_subjects_custom_val": {
+ "type": "boolean"
+ },
+ "include_data_subjects_employees": {
+ "type": "boolean"
+ },
+ "include_data_subjects_end_users": {
+ "type": "boolean"
+ },
+ "include_external_subprocessor_location": {
+ "type": "boolean"
+ },
+ "include_frequency_of_transfer_continuous": {
+ "type": "boolean"
+ },
+ "include_frequency_of_transfer_custom": {
+ "type": "boolean"
+ },
+ "include_frequency_of_transfer_custom_val": {
+ "type": "boolean"
+ },
+ "include_governing_country_eu": {
+ "type": "boolean"
+ },
+ "include_governing_country_eu_val": {
+ "type": "boolean"
+ },
+ "include_governing_country_uk": {
+ "type": "boolean"
+ },
+ "include_governing_country_uk_val": {
+ "type": "boolean"
+ },
+ "include_governing_law": {
+ "type": "boolean"
+ },
+ "include_governing_law_country": {
+ "type": "boolean"
+ },
+ "include_governing_law_state": {
+ "type": "boolean"
+ },
+ "include_increased_claim_amount": {
+ "type": "boolean"
+ },
+ "include_increased_claim_amount_currency": {
+ "type": "boolean"
+ },
+ "include_increased_claim_amount_qty": {
+ "type": "boolean"
+ },
+ "include_increased_claim_amount_type": {
+ "type": "boolean"
+ },
+ "include_liability_cap": {
+ "type": "boolean"
+ },
+ "include_liability_cap_amount_constant_external": {
+ "type": "boolean"
+ },
+ "include_liability_cap_amount_constant_internal": {
+ "type": "boolean"
+ },
+ "include_liability_cap_amount_currency_external": {
+ "type": "boolean"
+ },
+ "include_liability_cap_amount_currency_internal": {
+ "type": "boolean"
+ },
+ "include_liability_cap_csa_type": {
+ "type": "boolean"
+ },
+ "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": "boolean"
+ },
+ "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": "boolean"
+ },
+ "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": "boolean"
+ },
+ "include_provider_security_contact_address_country": {
+ "type": "boolean"
+ },
+ "include_provider_security_contact_address_state": {
+ "type": "boolean"
+ },
+ "include_provider_security_contact_address_street_address": {
+ "type": "boolean"
+ },
+ "include_provider_security_contact_address_zipcode": {
+ "type": "boolean"
+ },
+ "include_provider_security_contact_email": {
+ "format": "email",
+ "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "include_provider_security_contact_email_val": {
+ "type": "boolean"
+ },
+ "include_security_measures_accountability": {
+ "type": "boolean"
+ },
+ "include_security_measures_accountability_val": {
+ "type": "boolean"
+ },
+ "include_security_measures_certification_or_assurance": {
+ "type": "boolean"
+ },
+ "include_security_measures_certification_or_assurance_val": {
+ "type": "boolean"
+ },
+ "include_security_measures_confidentiality_integrity": {
+ "type": "boolean"
+ },
+ "include_security_measures_confidentiality_integrity_val": {
+ "type": "boolean"
+ },
+ "include_security_measures_data_at_rest": {
+ "type": "boolean"
+ },
+ "include_security_measures_data_at_rest_val": {
+ "type": "boolean"
+ },
+ "include_security_measures_data_minimization": {
+ "type": "boolean"
+ },
+ "include_security_measures_data_minimization_val": {
+ "type": "boolean"
+ },
+ "include_security_measures_data_quality": {
+ "type": "boolean"
+ },
+ "include_security_measures_data_quality_val": {
+ "type": "boolean"
+ },
+ "include_security_measures_data_retention": {
+ "type": "boolean"
+ },
+ "include_security_measures_data_retention_val": {
+ "type": "boolean"
+ },
+ "include_security_measures_data_transmission": {
+ "type": "boolean"
+ },
+ "include_security_measures_data_transmission_val": {
+ "type": "boolean"
+ },
+ "include_security_measures_event_logging": {
+ "type": "boolean"
+ },
+ "include_security_measures_event_logging_val": {
+ "type": "boolean"
+ },
+ "include_security_measures_identity_auth": {
+ "type": "boolean"
+ },
+ "include_security_measures_identity_auth_val": {
+ "type": "boolean"
+ },
+ "include_security_measures_it_security_governance": {
+ "type": "boolean"
+ },
+ "include_security_measures_it_security_governance_val": {
+ "type": "boolean"
+ },
+ "include_security_measures_physical_security": {
+ "type": "boolean"
+ },
+ "include_security_measures_physical_security_val": {
+ "type": "boolean"
+ },
+ "include_security_measures_portability_and_erasure": {
+ "type": "boolean"
+ },
+ "include_security_measures_portability_and_erasure_val": {
+ "type": "boolean"
+ },
+ "include_security_measures_pseudonym_encryption": {
+ "type": "boolean"
+ },
+ "include_security_measures_pseudonym_encryption_val": {
+ "type": "boolean"
+ },
+ "include_security_measures_restore_data_access": {
+ "type": "boolean"
+ },
+ "include_security_measures_restore_data_access_val": {
+ "type": "boolean"
+ },
+ "include_security_measures_security_policy": {
+ "type": "boolean"
+ },
+ "include_security_measures_system_configuration": {
+ "type": "boolean"
+ },
+ "include_security_measures_system_configuration_val": {
+ "type": "boolean"
+ },
+ "include_security_measures_testing_assessment": {
+ "type": "boolean"
+ },
+ "include_security_measures_testing_assessment_val": {
+ "type": "boolean"
+ },
+ "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": "boolean"
+ },
+ "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": "boolean"
+ },
+ "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": {
+ "type": "string"
+ },
+ "subprocessors_attributes": {
+ "additionalProperties": {
+ "additionalProperties": false,
+ "properties": {
+ "country": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "processing_task": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "description": "Subprocessors. Use string keys such as \"0\", \"1\".",
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+ },
+ "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"
+ },
+ "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"
+ },
+ "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": "string"
+ },
+ "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": "string"
+ },
+ "confidentiality_nda_type": {
+ "type": "string"
+ },
+ "confidentiality_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"
+ },
+ "include_custom_details": {
+ "type": "boolean"
+ },
+ "include_custom_details_val": {
+ "type": "boolean"
+ },
+ "include_fees": {
+ "type": "boolean"
+ },
+ "include_fees_amount": {
+ "type": "boolean"
+ },
+ "include_fees_amount_duration": {
+ "type": "boolean"
+ },
+ "include_fees_include_amount": {
+ "type": "boolean"
+ },
+ "include_fees_include_other": {
+ "type": "boolean"
+ },
+ "include_fees_other": {
+ "type": "boolean"
+ },
+ "include_functionality": {
+ "type": "boolean"
+ },
+ "include_functionality_val": {
+ "type": "boolean"
+ },
+ "include_launch_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_launch_date_custom": {
+ "type": "boolean"
+ },
+ "include_launch_date_date": {
+ "type": "boolean"
+ },
+ "include_launch_date_type": {
+ "type": "boolean"
+ },
+ "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"
+ },
+ "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": {
+ "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": {
+ "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_include_company": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_include_company_val": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_include_partner": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_include_partner_val": {
+ "type": "boolean"
+ },
+ "include_brand_guidelines": {
+ "type": "boolean"
+ },
+ "include_brand_guidelines_include_company": {
+ "type": "boolean"
+ },
+ "include_brand_guidelines_include_company_val": {
+ "type": "boolean"
+ },
+ "include_brand_guidelines_include_partner": {
+ "type": "boolean"
+ },
+ "include_brand_guidelines_include_partner_val": {
+ "type": "boolean"
+ },
+ "include_covered_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_company_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_include_company_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_include_partner_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_partner_claims": {
+ "type": "boolean"
+ },
+ "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": "boolean"
+ },
+ "include_dpa_type": {
+ "type": "boolean"
+ },
+ "include_increased_cap_amount": {
+ "type": "boolean"
+ },
+ "include_increased_cap_amount_currency": {
+ "type": "boolean"
+ },
+ "include_increased_cap_amount_either_currency": {
+ "type": "boolean"
+ },
+ "include_increased_cap_amount_either_multiple": {
+ "type": "boolean"
+ },
+ "include_increased_cap_amount_multiple": {
+ "type": "boolean"
+ },
+ "include_increased_cap_amount_type": {
+ "type": "boolean"
+ },
+ "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": "boolean"
+ },
+ "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": "boolean"
+ },
+ "negotiations_allowed": {
+ "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": {
+ "type": "string"
+ },
+ "end_date_date": {
+ "type": "string"
+ },
+ "end_date_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"
+ },
+ "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": "boolean"
+ },
+ "include_obligations_company_promotion_include_materials": {
+ "type": "boolean"
+ },
+ "include_obligations_company_promotion_include_materials_val": {
+ "type": "boolean"
+ },
+ "include_obligations_company_referral": {
+ "type": "boolean"
+ },
+ "include_obligations_company_referral_include_criteria": {
+ "type": "boolean"
+ },
+ "include_obligations_company_referral_include_criteria_val": {
+ "type": "boolean"
+ },
+ "include_obligations_company_referral_include_pay_sch": {
+ "type": "boolean"
+ },
+ "include_obligations_company_referral_include_pay_sch_amount": {
+ "type": "boolean"
+ },
+ "include_obligations_company_referral_include_pay_sch_custom": {
+ "type": "boolean"
+ },
+ "include_obligations_company_referral_include_pay_sch_unit": {
+ "type": "boolean"
+ },
+ "include_obligations_company_sponsorship": {
+ "type": "boolean"
+ },
+ "include_obligations_company_sponsorship_include_benefits": {
+ "type": "boolean"
+ },
+ "include_obligations_company_sponsorship_include_benefits_val": {
+ "type": "boolean"
+ },
+ "include_obligations_company_sponsorship_include_payments": {
+ "type": "boolean"
+ },
+ "include_obligations_company_sponsorship_include_payments_amount": {
+ "type": "boolean"
+ },
+ "include_obligations_company_sponsorship_include_payments_unit": {
+ "type": "boolean"
+ },
+ "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": "boolean"
+ },
+ "include_obligations_partner_promotion_include_materials": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_promotion_include_materials_val": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_referral": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_referral_include_criteria": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_referral_include_criteria_val": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_referral_include_pay_sch": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_referral_include_pay_sch_amount": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_referral_include_pay_sch_custom": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_referral_include_pay_sch_unit": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_sponsorship": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_sponsorship_include_benefits": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_sponsorship_include_benefits_val": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_sponsorship_include_payments": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_sponsorship_include_payments_amount": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_sponsorship_include_payments_unit": {
+ "type": "boolean"
+ },
+ "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": "boolean"
+ },
+ "include_payment_process_company_include_address_country": {
+ "type": "boolean"
+ },
+ "include_payment_process_company_include_address_state": {
+ "type": "boolean"
+ },
+ "include_payment_process_company_include_address_street_address": {
+ "type": "boolean"
+ },
+ "include_payment_process_company_include_address_zipcode": {
+ "type": "boolean"
+ },
+ "include_payment_process_company_include_email": {
+ "format": "email",
+ "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "include_payment_process_company_include_email_val": {
+ "type": "boolean"
+ },
+ "include_payment_process_partner": {
+ "type": "boolean"
+ },
+ "include_payment_process_partner_include_address": {
+ "type": "boolean"
+ },
+ "include_payment_process_partner_include_address_city": {
+ "type": "boolean"
+ },
+ "include_payment_process_partner_include_address_country": {
+ "type": "boolean"
+ },
+ "include_payment_process_partner_include_address_state": {
+ "type": "boolean"
+ },
+ "include_payment_process_partner_include_address_street_address": {
+ "type": "boolean"
+ },
+ "include_payment_process_partner_include_address_zipcode": {
+ "type": "boolean"
+ },
+ "include_payment_process_partner_include_email": {
+ "format": "email",
+ "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "include_payment_process_partner_include_email_val": {
+ "type": "boolean"
+ },
+ "include_payment_schedule": {
+ "type": "boolean"
+ },
+ "include_payment_schedule_custom": {
+ "type": "boolean"
+ },
+ "include_payment_schedule_specified_amount": {
+ "type": "boolean"
+ },
+ "include_payment_schedule_specified_timeframe": {
+ "type": "boolean"
+ },
+ "include_payment_schedule_specified_unit": {
+ "type": "boolean"
+ },
+ "include_payment_schedule_type": {
+ "type": "boolean"
+ },
+ "negotiations_allowed": {
+ "type": "string"
+ },
+ "territory_type": {
+ "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": {
+ "type": "string"
+ },
+ "general_cap_amount": {
+ "type": "number"
+ },
+ "general_cap_amount_type": {
+ "type": "number"
+ },
+ "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": "boolean"
+ },
+ "include_dpa_type": {
+ "type": "boolean"
+ },
+ "include_payment_process": {
+ "type": "boolean"
+ },
+ "include_technical_support": {
+ "type": "boolean"
+ },
+ "negotiations_allowed": {
+ "type": "string"
+ },
+ "payment_process_automatic_frequency": {
+ "type": "string"
+ },
+ "payment_process_invoice_days": {
+ "type": "number"
+ },
+ "payment_process_invoice_from": {
+ "type": "string"
+ },
+ "payment_process_invoice_timeframe": {
+ "type": "string"
+ },
+ "payment_process_type": {
+ "type": "string"
+ },
+ "pilot_period_description": {
+ "type": "number"
+ },
+ "pilot_period_fees_description": {
+ "type": "number"
+ },
+ "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"
+ },
+ "default_signer_email": {
+ "format": "email",
+ "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "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": {
+ "type": "string"
+ },
+ "general_cap_amount": {
+ "type": "number"
+ },
+ "general_cap_amount_type": {
+ "type": "number"
+ },
+ "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": "boolean"
+ },
+ "include_additional_warranties_by_provider": {
+ "type": "boolean"
+ },
+ "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": "boolean"
+ },
+ "include_covered_claims_include_customer_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_include_provider_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_provider_claims": {
+ "type": "boolean"
+ },
+ "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": "boolean"
+ },
+ "include_customer_insurance_min_auto_liability_minimum": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_cyber_liability_aggregate": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_cyber_liability_minimum": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_employer_liability_aggregate": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_employer_liability_minimum": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_general_liability_aggregate": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_general_liability_minimum": {
+ "type": "boolean"
+ },
+ "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": "boolean"
+ },
+ "include_customer_policies_type": {
+ "type": "boolean"
+ },
+ "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": "boolean"
+ },
+ "include_dpa_type": {
+ "type": "boolean"
+ },
+ "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": "boolean"
+ },
+ "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": "boolean"
+ },
+ "include_provider_insurance_min_auto_liability_minimum": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_cyber_liability_aggregate": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_cyber_liability_minimum": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_employer_liability_aggregate": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_employer_liability_minimum": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_general_liability_aggregate": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_general_liability_minimum": {
+ "type": "boolean"
+ },
+ "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": {
+ "type": "boolean"
+ },
+ "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": "boolean"
+ },
+ "include_security_policy_iso27001": {
+ "type": "boolean"
+ },
+ "include_security_policy_location": {
+ "type": "boolean"
+ },
+ "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": {
+ "type": "boolean"
+ },
+ "include_terms": {
+ "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_negligence": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_other": {
+ "type": "boolean"
+ },
+ "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": {
+ "type": "number"
+ },
+ "negotiations_allowed": {
+ "type": "string"
+ },
+ "sender_last_to_sign": {
+ "type": "boolean"
+ }
+ },
+ "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,
+ "properties": {
+ "cost": {
+ "type": "number"
+ },
+ "description": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class discriminator.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "cost": {
+ "type": "number"
+ },
+ "description": {
+ "type": "string"
+ },
+ "discount_duration_amount": {
+ "type": "number"
+ },
+ "discount_duration_type": {
+ "type": "string"
+ },
+ "discount_type": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class discriminator.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "cost": {
+ "type": "number"
+ },
+ "description": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "quantity": {
+ "type": "number"
+ },
+ "stripe_product_id": {
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class discriminator.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "attachment_id": {
+ "type": "string"
+ },
+ "description": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class discriminator.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "description": {
+ "type": "string"
+ },
+ "fee_type": {
+ "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": {
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class discriminator.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "description": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class discriminator.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "cost": {
+ "type": "number"
+ },
+ "description": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class discriminator.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "cost": {
+ "type": "number"
+ },
+ "description": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class discriminator.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "description": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class discriminator.",
+ "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": "boolean"
+ },
+ "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": "boolean"
+ },
+ "include_deliverables_include_acceptance": {
+ "type": "boolean"
+ },
+ "include_deliverables_include_attachment": {
+ "type": "boolean"
+ },
+ "include_deliverables_include_draft_deliverables": {
+ "type": "boolean"
+ },
+ "include_deliverables_rejection_amount": {
+ "type": "boolean"
+ },
+ "include_deliverables_rejection_unit": {
+ "type": "boolean"
+ },
+ "include_deliverables_resubmission_amount": {
+ "type": "boolean"
+ },
+ "include_deliverables_resubmission_unit": {
+ "type": "boolean"
+ },
+ "include_fees_other": {
+ "type": "boolean"
+ },
+ "include_fees_other_val": {
+ "type": "boolean"
+ },
+ "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": {
+ "type": "boolean"
+ },
+ "include_fees_travel_val": {
+ "type": "boolean"
+ },
+ "include_third_party_customer": {
+ "type": "boolean"
+ },
+ "include_third_party_include_description": {
+ "type": "boolean"
+ },
+ "include_third_party_include_description_val": {
+ "type": "boolean"
+ },
+ "include_third_party_materials": {
+ "type": "boolean"
+ },
+ "include_third_party_provider": {
+ "type": "boolean"
+ },
+ "include_time_of_assignment": {
+ "type": "boolean"
+ },
+ "include_time_of_assignment_type": {
+ "type": "boolean"
+ },
+ "invoice_period_description": {
+ "type": "number"
+ },
+ "negotiations_allowed": {
+ "type": "string"
+ },
+ "payment_period": {
+ "type": "number"
+ },
+ "payment_period_other": {
+ "type": "number"
+ },
+ "payment_period_timeframe": {
+ "type": "number"
+ },
+ "payment_period_type": {
+ "type": "number"
+ },
+ "payment_period_unit": {
+ "type": "number"
+ },
+ "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": {
+ "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": {
+ "type": "string"
+ },
+ "sow_term_unit": {
+ "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-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-z]{2,}$",
+ "type": "string"
+ },
+ "recipient_organization": {
+ "type": "string"
+ },
+ "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-z]{2,}$",
+ "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": {
+ "type": "string"
+ },
+ "general_cap_amount": {
+ "type": "number"
+ },
+ "general_cap_amount_type": {
+ "type": "number"
+ },
+ "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": "boolean"
+ },
+ "include_additional_warranties_by_provider": {
+ "type": "boolean"
+ },
+ "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": "boolean"
+ },
+ "include_covered_claims_include_customer_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_include_provider_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_provider_claims": {
+ "type": "boolean"
+ },
+ "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": "boolean"
+ },
+ "include_dpa_type": {
+ "type": "boolean"
+ },
+ "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": "boolean"
+ },
+ "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": "boolean"
+ },
+ "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": {
+ "type": "number"
+ }
+ },
+ "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": "string"
+ },
+ "deletion_procedure_include_custom_description": {
+ "type": "string"
+ },
+ "deletion_procedure_include_customer_disable": {
+ "type": "string"
+ },
+ "deletion_procedure_include_customer_proof": {
+ "type": "string"
+ },
+ "deletion_procedure_include_provider_disable": {
+ "type": "string"
+ },
+ "fee_custom_unit": {
+ "type": "string"
+ },
+ "fee_period": {
+ "type": "number"
+ },
+ "fees_attributes": {
+ "additionalProperties": {
+ "anyOf": [
+ {
+ "additionalProperties": false,
+ "properties": {
+ "cost": {
+ "type": "number"
+ },
+ "description": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class discriminator.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "cost": {
+ "type": "number"
+ },
+ "description": {
+ "type": "string"
+ },
+ "discount_duration_amount": {
+ "type": "number"
+ },
+ "discount_duration_type": {
+ "type": "string"
+ },
+ "discount_type": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class discriminator.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "cost": {
+ "type": "number"
+ },
+ "description": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "quantity": {
+ "type": "number"
+ },
+ "stripe_product_id": {
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class discriminator.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "attachment_id": {
+ "type": "string"
+ },
+ "description": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class discriminator.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "description": {
+ "type": "string"
+ },
+ "fee_type": {
+ "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": {
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class discriminator.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "description": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class discriminator.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "cost": {
+ "type": "number"
+ },
+ "description": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class discriminator.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "cost": {
+ "type": "number"
+ },
+ "description": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class discriminator.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "description": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class discriminator.",
+ "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": {
+ "type": "string"
+ },
+ "fees_include_fee_increase_upon_renewal": {
+ "type": "number"
+ },
+ "fees_include_fee_increase_upon_renewal_fee": {
+ "type": "number"
+ },
+ "fees_include_fee_increase_upon_renewal_type": {
+ "type": "number"
+ },
+ "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": "boolean"
+ },
+ "include_license_limits": {
+ "type": "boolean"
+ },
+ "include_license_limits_description": {
+ "type": "boolean"
+ },
+ "include_payment_process_include_billing_email": {
+ "format": "email",
+ "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "include_pilot_period": {
+ "type": "boolean"
+ },
+ "include_pilot_period_duration_amount": {
+ "type": "boolean"
+ },
+ "include_pilot_period_duration_type": {
+ "type": "boolean"
+ },
+ "include_pilot_period_include_fees": {
+ "type": "boolean"
+ },
+ "include_pilot_period_include_fees_amount": {
+ "type": "boolean"
+ },
+ "include_pilot_period_include_modifications": {
+ "type": "boolean"
+ },
+ "include_pilot_period_include_modifications_description": {
+ "type": "boolean"
+ },
+ "include_services": {
+ "type": "boolean"
+ },
+ "include_services_description": {
+ "type": "boolean"
+ },
+ "negotiations_allowed": {
+ "type": "string"
+ },
+ "order_date_date": {
+ "type": "string"
+ },
+ "order_date_type": {
+ "type": "string"
+ },
+ "payment_process_automatic_frequency": {
+ "type": "string"
+ },
+ "payment_process_type": {
+ "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": {
+ "type": "string"
+ },
+ "payment_process_type_invoice_duration_start": {
+ "type": "string"
+ },
+ "payment_process_type_invoice_type": {
+ "type": "string"
+ },
+ "permitted_uses_include_custom": {
+ "type": "string"
+ },
+ "permitted_uses_include_custom_description": {
+ "type": "string"
+ },
+ "permitted_uses_include_customers_affiliates": {
+ "type": "string"
+ },
+ "permitted_uses_include_internal_business": {
+ "type": "string"
+ },
+ "pilot_period_stripe_product_id": {
+ "type": "number"
+ },
+ "software_description": {
+ "type": "string"
+ },
+ "subscription_auto_renew": {
+ "type": "string"
+ },
+ "subscription_period": {
+ "type": "number"
+ },
+ "subscription_period_unit": {
+ "type": "number"
+ },
+ "subscription_renewal_notice_days": {
+ "type": "number"
+ },
+ "warranty_period_description_amount": {
+ "type": "number"
+ },
+ "warranty_period_description_duration": {
+ "type": "number"
+ },
+ "warranty_period_description_duration_start": {
+ "type": "number"
+ },
+ "warranty_period_type": {
+ "type": "number"
+ }
+ },
+ "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-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-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": {
+ "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": "number"
+ },
+ "aggregation_limitations_permitted_val": {
+ "type": "number"
+ },
+ "breach_notification_unit": {
+ "type": "string"
+ },
+ "breach_notification_val": {
+ "type": "number"
+ },
+ "business_associate_relationship_type": {
+ "type": "string"
+ },
+ "deidentification_limitations_include_purpose": {
+ "type": "number"
+ },
+ "deidentification_limitations_include_requirements": {
+ "type": "number"
+ },
+ "deidentification_limitations_permitted": {
+ "type": "number"
+ },
+ "deidentification_limitations_purpose_val": {
+ "type": "number"
+ },
+ "deidentification_limitations_requirements_val": {
+ "type": "number"
+ },
+ "designated_record_set_provider_maintains": {
+ "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_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": "number"
+ },
+ "offshore_limitations_permitted_val": {
+ "type": "number"
+ },
+ "subcontract_limitations_include_notice": {
+ "type": "number"
+ },
+ "subcontract_limitations_include_permission": {
+ "type": "number"
+ },
+ "subcontract_limitations_notice_val": {
+ "type": "number"
+ },
+ "subcontract_limitations_permission_val": {
+ "type": "number"
+ },
+ "subcontract_limitations_permitted": {
+ "type": "number"
+ },
+ "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"
+ },
+ "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-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"
+ },
+ "default_signer_email": {
+ "format": "email",
+ "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "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": {
+ "type": "string"
+ },
+ "effective_date_type": {
+ "type": "string"
+ },
+ "general_cap_amount": {
+ "type": "number"
+ },
+ "general_cap_amount_type": {
+ "type": "number"
+ },
+ "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": "boolean"
+ },
+ "include_acceptable_use_policy_type": {
+ "type": "boolean"
+ },
+ "include_additional_warranties": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_by_customer": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_by_provider": {
+ "type": "boolean"
+ },
+ "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": "boolean"
+ },
+ "include_covered_claims_include_customer_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_include_provider_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_provider_claims": {
+ "type": "boolean"
+ },
+ "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": "boolean"
+ },
+ "include_dpa_type": {
+ "type": "boolean"
+ },
+ "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": "boolean"
+ },
+ "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": "boolean"
+ },
+ "include_insurance_minimums_cyber_liability_aggregate": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_cyber_liability_minimum": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_employer_liability_aggregate": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_employer_liability_minimum": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_general_liability_aggregate": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_general_liability_minimum": {
+ "type": "boolean"
+ },
+ "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": {
+ "type": "boolean"
+ },
+ "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": "boolean"
+ },
+ "include_security_policy_other": {
+ "type": "boolean"
+ },
+ "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": {
+ "type": "boolean"
+ },
+ "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_terms": {
+ "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": "boolean"
+ },
+ "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": {
+ "type": "number"
+ },
+ "negotiations_allowed": {
+ "type": "string"
+ },
+ "provider": {
+ "type": "string"
+ },
+ "sender_last_to_sign": {
+ "type": "boolean"
+ },
+ "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": "number"
+ },
+ "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": {
+ "type": "number"
+ },
+ "fees_attributes": {
+ "additionalProperties": {
+ "anyOf": [
+ {
+ "additionalProperties": false,
+ "properties": {
+ "cost": {
+ "type": "number"
+ },
+ "description": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class discriminator.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "cost": {
+ "type": "number"
+ },
+ "description": {
+ "type": "string"
+ },
+ "discount_duration_amount": {
+ "type": "number"
+ },
+ "discount_duration_type": {
+ "type": "string"
+ },
+ "discount_type": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class discriminator.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "cost": {
+ "type": "number"
+ },
+ "description": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "quantity": {
+ "type": "number"
+ },
+ "stripe_product_id": {
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class discriminator.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "attachment_id": {
+ "type": "string"
+ },
+ "description": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class discriminator.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "description": {
+ "type": "string"
+ },
+ "fee_type": {
+ "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": {
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class discriminator.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "description": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class discriminator.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "cost": {
+ "type": "number"
+ },
+ "description": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class discriminator.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "cost": {
+ "type": "number"
+ },
+ "description": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class discriminator.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "description": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class discriminator.",
+ "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": {
+ "type": "string"
+ },
+ "fees_include_fee_increase_upon_renewal": {
+ "type": "number"
+ },
+ "fees_include_fee_increase_upon_renewal_fee": {
+ "type": "number"
+ },
+ "fees_include_fee_increase_upon_renewal_type": {
+ "type": "number"
+ },
+ "fees_inclusive_of_taxes": {
+ "type": "boolean"
+ },
+ "framework_terms_type": {
+ "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": "boolean"
+ },
+ "include_fees_table": {
+ "type": "boolean"
+ },
+ "include_fees_table_period": {
+ "type": "boolean"
+ },
+ "include_free_trial": {
+ "type": "boolean"
+ },
+ "include_max_users": {
+ "type": "boolean"
+ },
+ "include_pilot_period": {
+ "type": "boolean"
+ },
+ "include_pilot_period_duration_amount": {
+ "type": "boolean"
+ },
+ "include_pilot_period_duration_type": {
+ "type": "boolean"
+ },
+ "include_pilot_period_include_fees": {
+ "type": "boolean"
+ },
+ "include_pilot_period_include_fees_amount": {
+ "type": "boolean"
+ },
+ "include_pilot_period_include_modifications": {
+ "type": "boolean"
+ },
+ "include_pilot_period_include_modifications_description": {
+ "type": "boolean"
+ },
+ "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": "boolean"
+ },
+ "include_product_support_type": {
+ "type": "boolean"
+ },
+ "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": "boolean"
+ },
+ "include_professional_services_description": {
+ "type": "boolean"
+ },
+ "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": "boolean"
+ },
+ "include_professional_services_include_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_include_fees_description": {
+ "type": "boolean"
+ },
+ "include_professional_services_type": {
+ "type": "boolean"
+ },
+ "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": "boolean"
+ },
+ "include_sla_include_response_time": {
+ "type": "boolean"
+ },
+ "include_sla_include_response_time_amount": {
+ "type": "boolean"
+ },
+ "include_sla_include_response_time_credit": {
+ "type": "boolean"
+ },
+ "include_sla_include_response_time_duration": {
+ "type": "boolean"
+ },
+ "include_sla_include_response_time_support_channel": {
+ "type": "boolean"
+ },
+ "include_sla_include_target_uptime": {
+ "type": "boolean"
+ },
+ "include_sla_maintenance_notice": {
+ "type": "boolean"
+ },
+ "include_sla_maintenance_window": {
+ "type": "boolean"
+ },
+ "include_sla_maintenance_window_type": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_notice_qty": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_notice_unit": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_end_time": {
+ "type": "boolean"
+ },
+ "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": "boolean"
+ },
+ "include_sla_standard_maintenance_window_sunday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_thursday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_time_zone": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_tuesday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_wednesday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_target_uptime": {
+ "type": "boolean"
+ },
+ "include_sla_type": {
+ "type": "boolean"
+ },
+ "include_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"
+ },
+ "include_subscription_start_date_date": {
+ "type": "boolean"
+ },
+ "include_usage_review": {
+ "type": "boolean"
+ },
+ "include_usage_review_val": {
+ "type": "boolean"
+ },
+ "include_use_limitations": {
+ "type": "boolean"
+ },
+ "include_use_limitations_val": {
+ "type": "boolean"
+ },
+ "invoice_period": {
+ "type": "number"
+ },
+ "invoice_period_custom_unit": {
+ "type": "number"
+ },
+ "max_consumption": {
+ "type": "number"
+ },
+ "max_users": {
+ "type": "number"
+ },
+ "negotiations_allowed": {
+ "type": "string"
+ },
+ "order_date_date": {
+ "type": "string"
+ },
+ "order_date_other": {
+ "type": "string"
+ },
+ "order_date_type": {
+ "type": "string"
+ },
+ "payment_period": {
+ "type": "number"
+ },
+ "payment_period_timeframe": {
+ "type": "number"
+ },
+ "payment_period_unit": {
+ "type": "number"
+ },
+ "payment_process_automatic_frequency": {
+ "type": "string"
+ },
+ "payment_process_type": {
+ "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": {
+ "type": "string"
+ },
+ "payment_process_type_invoice_duration_start": {
+ "type": "string"
+ },
+ "payment_process_type_invoice_type": {
+ "type": "string"
+ },
+ "pilot_period_stripe_product_id": {
+ "type": "number"
+ },
+ "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": {
+ "type": "string"
+ },
+ "subscription_period": {
+ "type": "number"
+ },
+ "subscription_period_unit": {
+ "type": "number"
+ },
+ "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": {
+ "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": "boolean"
+ },
+ "include_fees_description": {
+ "type": "boolean"
+ },
+ "include_fees_pay_by_amount": {
+ "type": "boolean"
+ },
+ "include_fees_type": {
+ "type": "boolean"
+ },
+ "include_fees_unit": {
+ "type": "boolean"
+ },
+ "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": "boolean"
+ },
+ "include_program_discount": {
+ "type": "boolean"
+ },
+ "include_program_discount_amount": {
+ "type": "boolean"
+ },
+ "include_program_discount_unit": {
+ "type": "boolean"
+ },
+ "include_program_participation_feedback": {
+ "type": "boolean"
+ },
+ "include_program_participation_feedback_amount": {
+ "type": "boolean"
+ },
+ "include_program_participation_feedback_unit": {
+ "type": "boolean"
+ },
+ "include_program_partner_other": {
+ "type": "boolean"
+ },
+ "include_program_partner_other_val": {
+ "type": "boolean"
+ },
+ "include_program_provider_other": {
+ "type": "boolean"
+ },
+ "include_program_provider_other_val": {
+ "type": "boolean"
+ },
+ "include_program_reference": {
+ "type": "boolean"
+ },
+ "product_description": {
+ "type": "string"
+ },
+ "term_amount": {
+ "type": "number"
+ },
+ "term_unit": {
+ "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": {
+ "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": "number"
+ },
+ "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": {
+ "type": "string"
+ },
+ "data_importer_address": {
+ "type": "string"
+ },
+ "data_importer_address_city": {
+ "type": "string"
+ },
+ "data_importer_address_country": {
+ "type": "number"
+ },
+ "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": "boolean"
+ },
+ "include_covered_claim_internal_val": {
+ "type": "boolean"
+ },
+ "include_covered_claim_type": {
+ "type": "boolean"
+ },
+ "include_data_subjects_custom": {
+ "type": "boolean"
+ },
+ "include_data_subjects_custom_val": {
+ "type": "boolean"
+ },
+ "include_data_subjects_employees": {
+ "type": "boolean"
+ },
+ "include_data_subjects_end_users": {
+ "type": "boolean"
+ },
+ "include_external_subprocessor_location": {
+ "type": "boolean"
+ },
+ "include_frequency_of_transfer_continuous": {
+ "type": "boolean"
+ },
+ "include_frequency_of_transfer_custom": {
+ "type": "boolean"
+ },
+ "include_frequency_of_transfer_custom_val": {
+ "type": "boolean"
+ },
+ "include_governing_country_eu": {
+ "type": "boolean"
+ },
+ "include_governing_country_eu_val": {
+ "type": "boolean"
+ },
+ "include_governing_country_uk": {
+ "type": "boolean"
+ },
+ "include_governing_country_uk_val": {
+ "type": "boolean"
+ },
+ "include_governing_law": {
+ "type": "boolean"
+ },
+ "include_governing_law_country": {
+ "type": "boolean"
+ },
+ "include_governing_law_state": {
+ "type": "boolean"
+ },
+ "include_increased_claim_amount": {
+ "type": "boolean"
+ },
+ "include_increased_claim_amount_currency": {
+ "type": "boolean"
+ },
+ "include_increased_claim_amount_qty": {
+ "type": "boolean"
+ },
+ "include_increased_claim_amount_type": {
+ "type": "boolean"
+ },
+ "include_liability_cap": {
+ "type": "boolean"
+ },
+ "include_liability_cap_amount_constant_external": {
+ "type": "boolean"
+ },
+ "include_liability_cap_amount_constant_internal": {
+ "type": "boolean"
+ },
+ "include_liability_cap_amount_currency_external": {
+ "type": "boolean"
+ },
+ "include_liability_cap_amount_currency_internal": {
+ "type": "boolean"
+ },
+ "include_liability_cap_csa_type": {
+ "type": "boolean"
+ },
+ "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": "boolean"
+ },
+ "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": "boolean"
+ },
+ "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": "boolean"
+ },
+ "include_provider_security_contact_address_country": {
+ "type": "boolean"
+ },
+ "include_provider_security_contact_address_state": {
+ "type": "boolean"
+ },
+ "include_provider_security_contact_address_street_address": {
+ "type": "boolean"
+ },
+ "include_provider_security_contact_address_zipcode": {
+ "type": "boolean"
+ },
+ "include_provider_security_contact_email": {
+ "format": "email",
+ "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "include_provider_security_contact_email_val": {
+ "type": "boolean"
+ },
+ "include_security_measures_accountability": {
+ "type": "boolean"
+ },
+ "include_security_measures_accountability_val": {
+ "type": "boolean"
+ },
+ "include_security_measures_certification_or_assurance": {
+ "type": "boolean"
+ },
+ "include_security_measures_certification_or_assurance_val": {
+ "type": "boolean"
+ },
+ "include_security_measures_confidentiality_integrity": {
+ "type": "boolean"
+ },
+ "include_security_measures_confidentiality_integrity_val": {
+ "type": "boolean"
+ },
+ "include_security_measures_data_at_rest": {
+ "type": "boolean"
+ },
+ "include_security_measures_data_at_rest_val": {
+ "type": "boolean"
+ },
+ "include_security_measures_data_minimization": {
+ "type": "boolean"
+ },
+ "include_security_measures_data_minimization_val": {
+ "type": "boolean"
+ },
+ "include_security_measures_data_quality": {
+ "type": "boolean"
+ },
+ "include_security_measures_data_quality_val": {
+ "type": "boolean"
+ },
+ "include_security_measures_data_retention": {
+ "type": "boolean"
+ },
+ "include_security_measures_data_retention_val": {
+ "type": "boolean"
+ },
+ "include_security_measures_data_transmission": {
+ "type": "boolean"
+ },
+ "include_security_measures_data_transmission_val": {
+ "type": "boolean"
+ },
+ "include_security_measures_event_logging": {
+ "type": "boolean"
+ },
+ "include_security_measures_event_logging_val": {
+ "type": "boolean"
+ },
+ "include_security_measures_identity_auth": {
+ "type": "boolean"
+ },
+ "include_security_measures_identity_auth_val": {
+ "type": "boolean"
+ },
+ "include_security_measures_it_security_governance": {
+ "type": "boolean"
+ },
+ "include_security_measures_it_security_governance_val": {
+ "type": "boolean"
+ },
+ "include_security_measures_physical_security": {
+ "type": "boolean"
+ },
+ "include_security_measures_physical_security_val": {
+ "type": "boolean"
+ },
+ "include_security_measures_portability_and_erasure": {
+ "type": "boolean"
+ },
+ "include_security_measures_portability_and_erasure_val": {
+ "type": "boolean"
+ },
+ "include_security_measures_pseudonym_encryption": {
+ "type": "boolean"
+ },
+ "include_security_measures_pseudonym_encryption_val": {
+ "type": "boolean"
+ },
+ "include_security_measures_restore_data_access": {
+ "type": "boolean"
+ },
+ "include_security_measures_restore_data_access_val": {
+ "type": "boolean"
+ },
+ "include_security_measures_security_policy": {
+ "type": "boolean"
+ },
+ "include_security_measures_system_configuration": {
+ "type": "boolean"
+ },
+ "include_security_measures_system_configuration_val": {
+ "type": "boolean"
+ },
+ "include_security_measures_testing_assessment": {
+ "type": "boolean"
+ },
+ "include_security_measures_testing_assessment_val": {
+ "type": "boolean"
+ },
+ "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": "boolean"
+ },
+ "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": "boolean"
+ },
+ "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": {
+ "type": "string"
+ },
+ "subprocessors_attributes": {
+ "additionalProperties": {
+ "additionalProperties": false,
+ "properties": {
+ "country": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "processing_task": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "description": "Subprocessors. Use string keys such as \"0\", \"1\".",
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+ },
+ "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"
+ },
+ "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"
+ },
+ "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": "string"
+ },
+ "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": "string"
+ },
+ "confidentiality_nda_type": {
+ "type": "string"
+ },
+ "confidentiality_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"
+ },
+ "include_custom_details": {
+ "type": "boolean"
+ },
+ "include_custom_details_val": {
+ "type": "boolean"
+ },
+ "include_fees": {
+ "type": "boolean"
+ },
+ "include_fees_amount": {
+ "type": "boolean"
+ },
+ "include_fees_amount_duration": {
+ "type": "boolean"
+ },
+ "include_fees_include_amount": {
+ "type": "boolean"
+ },
+ "include_fees_include_other": {
+ "type": "boolean"
+ },
+ "include_fees_other": {
+ "type": "boolean"
+ },
+ "include_functionality": {
+ "type": "boolean"
+ },
+ "include_functionality_val": {
+ "type": "boolean"
+ },
+ "include_launch_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_launch_date_custom": {
+ "type": "boolean"
+ },
+ "include_launch_date_date": {
+ "type": "boolean"
+ },
+ "include_launch_date_type": {
+ "type": "boolean"
+ },
+ "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"
+ },
+ "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": {
+ "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": {
+ "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_include_company": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_include_company_val": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_include_partner": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_include_partner_val": {
+ "type": "boolean"
+ },
+ "include_brand_guidelines": {
+ "type": "boolean"
+ },
+ "include_brand_guidelines_include_company": {
+ "type": "boolean"
+ },
+ "include_brand_guidelines_include_company_val": {
+ "type": "boolean"
+ },
+ "include_brand_guidelines_include_partner": {
+ "type": "boolean"
+ },
+ "include_brand_guidelines_include_partner_val": {
+ "type": "boolean"
+ },
+ "include_covered_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_company_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_include_company_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_include_partner_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_partner_claims": {
+ "type": "boolean"
+ },
+ "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": "boolean"
+ },
+ "include_dpa_type": {
+ "type": "boolean"
+ },
+ "include_increased_cap_amount": {
+ "type": "boolean"
+ },
+ "include_increased_cap_amount_currency": {
+ "type": "boolean"
+ },
+ "include_increased_cap_amount_either_currency": {
+ "type": "boolean"
+ },
+ "include_increased_cap_amount_either_multiple": {
+ "type": "boolean"
+ },
+ "include_increased_cap_amount_multiple": {
+ "type": "boolean"
+ },
+ "include_increased_cap_amount_type": {
+ "type": "boolean"
+ },
+ "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": "boolean"
+ },
+ "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": "boolean"
+ },
+ "negotiations_allowed": {
+ "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": {
+ "type": "string"
+ },
+ "end_date_date": {
+ "type": "string"
+ },
+ "end_date_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"
+ },
+ "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": "boolean"
+ },
+ "include_obligations_company_promotion_include_materials": {
+ "type": "boolean"
+ },
+ "include_obligations_company_promotion_include_materials_val": {
+ "type": "boolean"
+ },
+ "include_obligations_company_referral": {
+ "type": "boolean"
+ },
+ "include_obligations_company_referral_include_criteria": {
+ "type": "boolean"
+ },
+ "include_obligations_company_referral_include_criteria_val": {
+ "type": "boolean"
+ },
+ "include_obligations_company_referral_include_pay_sch": {
+ "type": "boolean"
+ },
+ "include_obligations_company_referral_include_pay_sch_amount": {
+ "type": "boolean"
+ },
+ "include_obligations_company_referral_include_pay_sch_custom": {
+ "type": "boolean"
+ },
+ "include_obligations_company_referral_include_pay_sch_unit": {
+ "type": "boolean"
+ },
+ "include_obligations_company_sponsorship": {
+ "type": "boolean"
+ },
+ "include_obligations_company_sponsorship_include_benefits": {
+ "type": "boolean"
+ },
+ "include_obligations_company_sponsorship_include_benefits_val": {
+ "type": "boolean"
+ },
+ "include_obligations_company_sponsorship_include_payments": {
+ "type": "boolean"
+ },
+ "include_obligations_company_sponsorship_include_payments_amount": {
+ "type": "boolean"
+ },
+ "include_obligations_company_sponsorship_include_payments_unit": {
+ "type": "boolean"
+ },
+ "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": "boolean"
+ },
+ "include_obligations_partner_promotion_include_materials": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_promotion_include_materials_val": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_referral": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_referral_include_criteria": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_referral_include_criteria_val": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_referral_include_pay_sch": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_referral_include_pay_sch_amount": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_referral_include_pay_sch_custom": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_referral_include_pay_sch_unit": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_sponsorship": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_sponsorship_include_benefits": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_sponsorship_include_benefits_val": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_sponsorship_include_payments": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_sponsorship_include_payments_amount": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_sponsorship_include_payments_unit": {
+ "type": "boolean"
+ },
+ "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": "boolean"
+ },
+ "include_payment_process_company_include_address_country": {
+ "type": "boolean"
+ },
+ "include_payment_process_company_include_address_state": {
+ "type": "boolean"
+ },
+ "include_payment_process_company_include_address_street_address": {
+ "type": "boolean"
+ },
+ "include_payment_process_company_include_address_zipcode": {
+ "type": "boolean"
+ },
+ "include_payment_process_company_include_email": {
+ "format": "email",
+ "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "include_payment_process_company_include_email_val": {
+ "type": "boolean"
+ },
+ "include_payment_process_partner": {
+ "type": "boolean"
+ },
+ "include_payment_process_partner_include_address": {
+ "type": "boolean"
+ },
+ "include_payment_process_partner_include_address_city": {
+ "type": "boolean"
+ },
+ "include_payment_process_partner_include_address_country": {
+ "type": "boolean"
+ },
+ "include_payment_process_partner_include_address_state": {
+ "type": "boolean"
+ },
+ "include_payment_process_partner_include_address_street_address": {
+ "type": "boolean"
+ },
+ "include_payment_process_partner_include_address_zipcode": {
+ "type": "boolean"
+ },
+ "include_payment_process_partner_include_email": {
+ "format": "email",
+ "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "include_payment_process_partner_include_email_val": {
+ "type": "boolean"
+ },
+ "include_payment_schedule": {
+ "type": "boolean"
+ },
+ "include_payment_schedule_custom": {
+ "type": "boolean"
+ },
+ "include_payment_schedule_specified_amount": {
+ "type": "boolean"
+ },
+ "include_payment_schedule_specified_timeframe": {
+ "type": "boolean"
+ },
+ "include_payment_schedule_specified_unit": {
+ "type": "boolean"
+ },
+ "include_payment_schedule_type": {
+ "type": "boolean"
+ },
+ "negotiations_allowed": {
+ "type": "string"
+ },
+ "territory_type": {
+ "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": {
+ "type": "string"
+ },
+ "general_cap_amount": {
+ "type": "number"
+ },
+ "general_cap_amount_type": {
+ "type": "number"
+ },
+ "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": "boolean"
+ },
+ "include_dpa_type": {
+ "type": "boolean"
+ },
+ "include_payment_process": {
+ "type": "boolean"
+ },
+ "include_technical_support": {
+ "type": "boolean"
+ },
+ "negotiations_allowed": {
+ "type": "string"
+ },
+ "payment_process_automatic_frequency": {
+ "type": "string"
+ },
+ "payment_process_invoice_days": {
+ "type": "number"
+ },
+ "payment_process_invoice_from": {
+ "type": "string"
+ },
+ "payment_process_invoice_timeframe": {
+ "type": "string"
+ },
+ "payment_process_type": {
+ "type": "string"
+ },
+ "pilot_period_description": {
+ "type": "number"
+ },
+ "pilot_period_fees_description": {
+ "type": "number"
+ },
+ "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"
+ },
+ "default_signer_email": {
+ "format": "email",
+ "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "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": {
+ "type": "string"
+ },
+ "general_cap_amount": {
+ "type": "number"
+ },
+ "general_cap_amount_type": {
+ "type": "number"
+ },
+ "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": "boolean"
+ },
+ "include_additional_warranties_by_provider": {
+ "type": "boolean"
+ },
+ "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": "boolean"
+ },
+ "include_covered_claims_include_customer_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_include_provider_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_provider_claims": {
+ "type": "boolean"
+ },
+ "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": "boolean"
+ },
+ "include_customer_insurance_min_auto_liability_minimum": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_cyber_liability_aggregate": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_cyber_liability_minimum": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_employer_liability_aggregate": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_employer_liability_minimum": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_general_liability_aggregate": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_general_liability_minimum": {
+ "type": "boolean"
+ },
+ "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": "boolean"
+ },
+ "include_customer_policies_type": {
+ "type": "boolean"
+ },
+ "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": "boolean"
+ },
+ "include_dpa_type": {
+ "type": "boolean"
+ },
+ "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": "boolean"
+ },
+ "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": "boolean"
+ },
+ "include_provider_insurance_min_auto_liability_minimum": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_cyber_liability_aggregate": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_cyber_liability_minimum": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_employer_liability_aggregate": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_employer_liability_minimum": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_general_liability_aggregate": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_general_liability_minimum": {
+ "type": "boolean"
+ },
+ "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": {
+ "type": "boolean"
+ },
+ "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": "boolean"
+ },
+ "include_security_policy_iso27001": {
+ "type": "boolean"
+ },
+ "include_security_policy_location": {
+ "type": "boolean"
+ },
+ "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": {
+ "type": "boolean"
+ },
+ "include_terms": {
+ "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_negligence": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_other": {
+ "type": "boolean"
+ },
+ "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": {
+ "type": "number"
+ },
+ "negotiations_allowed": {
+ "type": "string"
+ },
+ "sender_last_to_sign": {
+ "type": "boolean"
+ }
+ },
+ "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,
+ "properties": {
+ "cost": {
+ "type": "number"
+ },
+ "description": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class discriminator.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "cost": {
+ "type": "number"
+ },
+ "description": {
+ "type": "string"
+ },
+ "discount_duration_amount": {
+ "type": "number"
+ },
+ "discount_duration_type": {
+ "type": "string"
+ },
+ "discount_type": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class discriminator.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "cost": {
+ "type": "number"
+ },
+ "description": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "quantity": {
+ "type": "number"
+ },
+ "stripe_product_id": {
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class discriminator.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "attachment_id": {
+ "type": "string"
+ },
+ "description": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class discriminator.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "description": {
+ "type": "string"
+ },
+ "fee_type": {
+ "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": {
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class discriminator.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "description": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class discriminator.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "cost": {
+ "type": "number"
+ },
+ "description": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class discriminator.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "cost": {
+ "type": "number"
+ },
+ "description": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class discriminator.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "description": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class discriminator.",
+ "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": "boolean"
+ },
+ "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": "boolean"
+ },
+ "include_deliverables_include_acceptance": {
+ "type": "boolean"
+ },
+ "include_deliverables_include_attachment": {
+ "type": "boolean"
+ },
+ "include_deliverables_include_draft_deliverables": {
+ "type": "boolean"
+ },
+ "include_deliverables_rejection_amount": {
+ "type": "boolean"
+ },
+ "include_deliverables_rejection_unit": {
+ "type": "boolean"
+ },
+ "include_deliverables_resubmission_amount": {
+ "type": "boolean"
+ },
+ "include_deliverables_resubmission_unit": {
+ "type": "boolean"
+ },
+ "include_fees_other": {
+ "type": "boolean"
+ },
+ "include_fees_other_val": {
+ "type": "boolean"
+ },
+ "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": {
+ "type": "boolean"
+ },
+ "include_fees_travel_val": {
+ "type": "boolean"
+ },
+ "include_third_party_customer": {
+ "type": "boolean"
+ },
+ "include_third_party_include_description": {
+ "type": "boolean"
+ },
+ "include_third_party_include_description_val": {
+ "type": "boolean"
+ },
+ "include_third_party_materials": {
+ "type": "boolean"
+ },
+ "include_third_party_provider": {
+ "type": "boolean"
+ },
+ "include_time_of_assignment": {
+ "type": "boolean"
+ },
+ "include_time_of_assignment_type": {
+ "type": "boolean"
+ },
+ "invoice_period_description": {
+ "type": "number"
+ },
+ "negotiations_allowed": {
+ "type": "string"
+ },
+ "payment_period": {
+ "type": "number"
+ },
+ "payment_period_other": {
+ "type": "number"
+ },
+ "payment_period_timeframe": {
+ "type": "number"
+ },
+ "payment_period_type": {
+ "type": "number"
+ },
+ "payment_period_unit": {
+ "type": "number"
+ },
+ "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": {
+ "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": {
+ "type": "string"
+ },
+ "sow_term_unit": {
+ "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-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-z]{2,}$",
+ "type": "string"
+ },
+ "recipient_organization": {
+ "type": "string"
+ },
+ "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-z]{2,}$",
+ "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": {
+ "type": "string"
+ },
+ "general_cap_amount": {
+ "type": "number"
+ },
+ "general_cap_amount_type": {
+ "type": "number"
+ },
+ "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": "boolean"
+ },
+ "include_additional_warranties_by_provider": {
+ "type": "boolean"
+ },
+ "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": "boolean"
+ },
+ "include_covered_claims_include_customer_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_include_provider_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_provider_claims": {
+ "type": "boolean"
+ },
+ "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": "boolean"
+ },
+ "include_dpa_type": {
+ "type": "boolean"
+ },
+ "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": "boolean"
+ },
+ "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": "boolean"
+ },
+ "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": {
+ "type": "number"
+ }
+ },
+ "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": "string"
+ },
+ "deletion_procedure_include_custom_description": {
+ "type": "string"
+ },
+ "deletion_procedure_include_customer_disable": {
+ "type": "string"
+ },
+ "deletion_procedure_include_customer_proof": {
+ "type": "string"
+ },
+ "deletion_procedure_include_provider_disable": {
+ "type": "string"
+ },
+ "fee_custom_unit": {
+ "type": "string"
+ },
+ "fee_period": {
+ "type": "number"
+ },
+ "fees_attributes": {
+ "additionalProperties": {
+ "anyOf": [
+ {
+ "additionalProperties": false,
+ "properties": {
+ "cost": {
+ "type": "number"
+ },
+ "description": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class discriminator.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "cost": {
+ "type": "number"
+ },
+ "description": {
+ "type": "string"
+ },
+ "discount_duration_amount": {
+ "type": "number"
+ },
+ "discount_duration_type": {
+ "type": "string"
+ },
+ "discount_type": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class discriminator.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "cost": {
+ "type": "number"
+ },
+ "description": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "quantity": {
+ "type": "number"
+ },
+ "stripe_product_id": {
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class discriminator.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "attachment_id": {
+ "type": "string"
+ },
+ "description": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class discriminator.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "description": {
+ "type": "string"
+ },
+ "fee_type": {
+ "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": {
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class discriminator.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "description": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class discriminator.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "cost": {
+ "type": "number"
+ },
+ "description": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class discriminator.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "cost": {
+ "type": "number"
+ },
+ "description": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class discriminator.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "description": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class discriminator.",
+ "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": {
+ "type": "string"
+ },
+ "fees_include_fee_increase_upon_renewal": {
+ "type": "number"
+ },
+ "fees_include_fee_increase_upon_renewal_fee": {
+ "type": "number"
+ },
+ "fees_include_fee_increase_upon_renewal_type": {
+ "type": "number"
+ },
+ "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": "boolean"
+ },
+ "include_license_limits": {
+ "type": "boolean"
+ },
+ "include_license_limits_description": {
+ "type": "boolean"
+ },
+ "include_payment_process_include_billing_email": {
+ "format": "email",
+ "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "include_pilot_period": {
+ "type": "boolean"
+ },
+ "include_pilot_period_duration_amount": {
+ "type": "boolean"
+ },
+ "include_pilot_period_duration_type": {
+ "type": "boolean"
+ },
+ "include_pilot_period_include_fees": {
+ "type": "boolean"
+ },
+ "include_pilot_period_include_fees_amount": {
+ "type": "boolean"
+ },
+ "include_pilot_period_include_modifications": {
+ "type": "boolean"
+ },
+ "include_pilot_period_include_modifications_description": {
+ "type": "boolean"
+ },
+ "include_services": {
+ "type": "boolean"
+ },
+ "include_services_description": {
+ "type": "boolean"
+ },
+ "negotiations_allowed": {
+ "type": "string"
+ },
+ "order_date_date": {
+ "type": "string"
+ },
+ "order_date_type": {
+ "type": "string"
+ },
+ "payment_process_automatic_frequency": {
+ "type": "string"
+ },
+ "payment_process_type": {
+ "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": {
+ "type": "string"
+ },
+ "payment_process_type_invoice_duration_start": {
+ "type": "string"
+ },
+ "payment_process_type_invoice_type": {
+ "type": "string"
+ },
+ "permitted_uses_include_custom": {
+ "type": "string"
+ },
+ "permitted_uses_include_custom_description": {
+ "type": "string"
+ },
+ "permitted_uses_include_customers_affiliates": {
+ "type": "string"
+ },
+ "permitted_uses_include_internal_business": {
+ "type": "string"
+ },
+ "pilot_period_stripe_product_id": {
+ "type": "number"
+ },
+ "software_description": {
+ "type": "string"
+ },
+ "subscription_auto_renew": {
+ "type": "string"
+ },
+ "subscription_period": {
+ "type": "number"
+ },
+ "subscription_period_unit": {
+ "type": "number"
+ },
+ "subscription_renewal_notice_days": {
+ "type": "number"
+ },
+ "warranty_period_description_amount": {
+ "type": "number"
+ },
+ "warranty_period_description_duration": {
+ "type": "number"
+ },
+ "warranty_period_description_duration_start": {
+ "type": "number"
+ },
+ "warranty_period_type": {
+ "type": "number"
+ }
+ },
+ "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-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": {
+ "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": "number"
+ },
+ "aggregation_limitations_permitted_val": {
+ "type": "number"
+ },
+ "breach_notification_unit": {
+ "type": "string"
+ },
+ "breach_notification_val": {
+ "type": "number"
+ },
+ "business_associate_relationship_type": {
+ "type": "string"
+ },
+ "deidentification_limitations_include_purpose": {
+ "type": "number"
+ },
+ "deidentification_limitations_include_requirements": {
+ "type": "number"
+ },
+ "deidentification_limitations_permitted": {
+ "type": "number"
+ },
+ "deidentification_limitations_purpose_val": {
+ "type": "number"
+ },
+ "deidentification_limitations_requirements_val": {
+ "type": "number"
+ },
+ "designated_record_set_provider_maintains": {
+ "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_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": "number"
+ },
+ "offshore_limitations_permitted_val": {
+ "type": "number"
+ },
+ "subcontract_limitations_include_notice": {
+ "type": "number"
+ },
+ "subcontract_limitations_include_permission": {
+ "type": "number"
+ },
+ "subcontract_limitations_notice_val": {
+ "type": "number"
+ },
+ "subcontract_limitations_permission_val": {
+ "type": "number"
+ },
+ "subcontract_limitations_permitted": {
+ "type": "number"
+ },
+ "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"
+ },
+ "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-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"
+ },
+ "default_signer_email": {
+ "format": "email",
+ "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "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": {
+ "type": "string"
+ },
+ "effective_date_type": {
+ "type": "string"
+ },
+ "general_cap_amount": {
+ "type": "number"
+ },
+ "general_cap_amount_type": {
+ "type": "number"
+ },
+ "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": "boolean"
+ },
+ "include_acceptable_use_policy_type": {
+ "type": "boolean"
+ },
+ "include_additional_warranties": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_by_customer": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_by_provider": {
+ "type": "boolean"
+ },
+ "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": "boolean"
+ },
+ "include_covered_claims_include_customer_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_include_provider_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_provider_claims": {
+ "type": "boolean"
+ },
+ "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": "boolean"
+ },
+ "include_dpa_type": {
+ "type": "boolean"
+ },
+ "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": "boolean"
+ },
+ "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": "boolean"
+ },
+ "include_insurance_minimums_cyber_liability_aggregate": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_cyber_liability_minimum": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_employer_liability_aggregate": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_employer_liability_minimum": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_general_liability_aggregate": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_general_liability_minimum": {
+ "type": "boolean"
+ },
+ "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": {
+ "type": "boolean"
+ },
+ "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": "boolean"
+ },
+ "include_security_policy_other": {
+ "type": "boolean"
+ },
+ "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": {
+ "type": "boolean"
+ },
+ "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_terms": {
+ "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": "boolean"
+ },
+ "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": {
+ "type": "number"
+ },
+ "negotiations_allowed": {
+ "type": "string"
+ },
+ "provider": {
+ "type": "string"
+ },
+ "sender_last_to_sign": {
+ "type": "boolean"
+ },
+ "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": "number"
+ },
+ "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": {
+ "type": "number"
+ },
+ "fees_attributes": {
+ "additionalProperties": {
+ "anyOf": [
+ {
+ "additionalProperties": false,
+ "properties": {
+ "cost": {
+ "type": "number"
+ },
+ "description": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class discriminator.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "cost": {
+ "type": "number"
+ },
+ "description": {
+ "type": "string"
+ },
+ "discount_duration_amount": {
+ "type": "number"
+ },
+ "discount_duration_type": {
+ "type": "string"
+ },
+ "discount_type": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class discriminator.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "cost": {
+ "type": "number"
+ },
+ "description": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "quantity": {
+ "type": "number"
+ },
+ "stripe_product_id": {
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class discriminator.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "attachment_id": {
+ "type": "string"
+ },
+ "description": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class discriminator.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "description": {
+ "type": "string"
+ },
+ "fee_type": {
+ "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": {
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class discriminator.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "description": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class discriminator.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "cost": {
+ "type": "number"
+ },
+ "description": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class discriminator.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "cost": {
+ "type": "number"
+ },
+ "description": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class discriminator.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "description": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class discriminator.",
+ "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": {
+ "type": "string"
+ },
+ "fees_include_fee_increase_upon_renewal": {
+ "type": "number"
+ },
+ "fees_include_fee_increase_upon_renewal_fee": {
+ "type": "number"
+ },
+ "fees_include_fee_increase_upon_renewal_type": {
+ "type": "number"
+ },
+ "fees_inclusive_of_taxes": {
+ "type": "boolean"
+ },
+ "framework_terms_type": {
+ "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": "boolean"
+ },
+ "include_fees_table": {
+ "type": "boolean"
+ },
+ "include_fees_table_period": {
+ "type": "boolean"
+ },
+ "include_free_trial": {
+ "type": "boolean"
+ },
+ "include_max_users": {
+ "type": "boolean"
+ },
+ "include_pilot_period": {
+ "type": "boolean"
+ },
+ "include_pilot_period_duration_amount": {
+ "type": "boolean"
+ },
+ "include_pilot_period_duration_type": {
+ "type": "boolean"
+ },
+ "include_pilot_period_include_fees": {
+ "type": "boolean"
+ },
+ "include_pilot_period_include_fees_amount": {
+ "type": "boolean"
+ },
+ "include_pilot_period_include_modifications": {
+ "type": "boolean"
+ },
+ "include_pilot_period_include_modifications_description": {
+ "type": "boolean"
+ },
+ "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": "boolean"
+ },
+ "include_product_support_type": {
+ "type": "boolean"
+ },
+ "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": "boolean"
+ },
+ "include_professional_services_description": {
+ "type": "boolean"
+ },
+ "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": "boolean"
+ },
+ "include_professional_services_include_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_include_fees_description": {
+ "type": "boolean"
+ },
+ "include_professional_services_type": {
+ "type": "boolean"
+ },
+ "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": "boolean"
+ },
+ "include_sla_include_response_time": {
+ "type": "boolean"
+ },
+ "include_sla_include_response_time_amount": {
+ "type": "boolean"
+ },
+ "include_sla_include_response_time_credit": {
+ "type": "boolean"
+ },
+ "include_sla_include_response_time_duration": {
+ "type": "boolean"
+ },
+ "include_sla_include_response_time_support_channel": {
+ "type": "boolean"
+ },
+ "include_sla_include_target_uptime": {
+ "type": "boolean"
+ },
+ "include_sla_maintenance_notice": {
+ "type": "boolean"
+ },
+ "include_sla_maintenance_window": {
+ "type": "boolean"
+ },
+ "include_sla_maintenance_window_type": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_notice_qty": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_notice_unit": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_end_time": {
+ "type": "boolean"
+ },
+ "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": "boolean"
+ },
+ "include_sla_standard_maintenance_window_sunday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_thursday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_time_zone": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_tuesday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_wednesday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_target_uptime": {
+ "type": "boolean"
+ },
+ "include_sla_type": {
+ "type": "boolean"
+ },
+ "include_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"
+ },
+ "include_subscription_start_date_date": {
+ "type": "boolean"
+ },
+ "include_usage_review": {
+ "type": "boolean"
+ },
+ "include_usage_review_val": {
+ "type": "boolean"
+ },
+ "include_use_limitations": {
+ "type": "boolean"
+ },
+ "include_use_limitations_val": {
+ "type": "boolean"
+ },
+ "invoice_period": {
+ "type": "number"
+ },
+ "invoice_period_custom_unit": {
+ "type": "number"
+ },
+ "max_consumption": {
+ "type": "number"
+ },
+ "max_users": {
+ "type": "number"
+ },
+ "negotiations_allowed": {
+ "type": "string"
+ },
+ "order_date_date": {
+ "type": "string"
+ },
+ "order_date_other": {
+ "type": "string"
+ },
+ "order_date_type": {
+ "type": "string"
+ },
+ "payment_period": {
+ "type": "number"
+ },
+ "payment_period_timeframe": {
+ "type": "number"
+ },
+ "payment_period_unit": {
+ "type": "number"
+ },
+ "payment_process_automatic_frequency": {
+ "type": "string"
+ },
+ "payment_process_type": {
+ "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": {
+ "type": "string"
+ },
+ "payment_process_type_invoice_duration_start": {
+ "type": "string"
+ },
+ "payment_process_type_invoice_type": {
+ "type": "string"
+ },
+ "pilot_period_stripe_product_id": {
+ "type": "number"
+ },
+ "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": {
+ "type": "string"
+ },
+ "subscription_period": {
+ "type": "number"
+ },
+ "subscription_period_unit": {
+ "type": "number"
+ },
+ "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": {
+ "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": "boolean"
+ },
+ "include_fees_description": {
+ "type": "boolean"
+ },
+ "include_fees_pay_by_amount": {
+ "type": "boolean"
+ },
+ "include_fees_type": {
+ "type": "boolean"
+ },
+ "include_fees_unit": {
+ "type": "boolean"
+ },
+ "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": "boolean"
+ },
+ "include_program_discount": {
+ "type": "boolean"
+ },
+ "include_program_discount_amount": {
+ "type": "boolean"
+ },
+ "include_program_discount_unit": {
+ "type": "boolean"
+ },
+ "include_program_participation_feedback": {
+ "type": "boolean"
+ },
+ "include_program_participation_feedback_amount": {
+ "type": "boolean"
+ },
+ "include_program_participation_feedback_unit": {
+ "type": "boolean"
+ },
+ "include_program_partner_other": {
+ "type": "boolean"
+ },
+ "include_program_partner_other_val": {
+ "type": "boolean"
+ },
+ "include_program_provider_other": {
+ "type": "boolean"
+ },
+ "include_program_provider_other_val": {
+ "type": "boolean"
+ },
+ "include_program_reference": {
+ "type": "boolean"
+ },
+ "product_description": {
+ "type": "string"
+ },
+ "term_amount": {
+ "type": "number"
+ },
+ "term_unit": {
+ "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": {
+ "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": "number"
+ },
+ "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": {
+ "type": "string"
+ },
+ "data_importer_address": {
+ "type": "string"
+ },
+ "data_importer_address_city": {
+ "type": "string"
+ },
+ "data_importer_address_country": {
+ "type": "number"
+ },
+ "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": "boolean"
+ },
+ "include_covered_claim_internal_val": {
+ "type": "boolean"
+ },
+ "include_covered_claim_type": {
+ "type": "boolean"
+ },
+ "include_data_subjects_custom": {
+ "type": "boolean"
+ },
+ "include_data_subjects_custom_val": {
+ "type": "boolean"
+ },
+ "include_data_subjects_employees": {
+ "type": "boolean"
+ },
+ "include_data_subjects_end_users": {
+ "type": "boolean"
+ },
+ "include_external_subprocessor_location": {
+ "type": "boolean"
+ },
+ "include_frequency_of_transfer_continuous": {
+ "type": "boolean"
+ },
+ "include_frequency_of_transfer_custom": {
+ "type": "boolean"
+ },
+ "include_frequency_of_transfer_custom_val": {
+ "type": "boolean"
+ },
+ "include_governing_country_eu": {
+ "type": "boolean"
+ },
+ "include_governing_country_eu_val": {
+ "type": "boolean"
+ },
+ "include_governing_country_uk": {
+ "type": "boolean"
+ },
+ "include_governing_country_uk_val": {
+ "type": "boolean"
+ },
+ "include_governing_law": {
+ "type": "boolean"
+ },
+ "include_governing_law_country": {
+ "type": "boolean"
+ },
+ "include_governing_law_state": {
+ "type": "boolean"
+ },
+ "include_increased_claim_amount": {
+ "type": "boolean"
+ },
+ "include_increased_claim_amount_currency": {
+ "type": "boolean"
+ },
+ "include_increased_claim_amount_qty": {
+ "type": "boolean"
+ },
+ "include_increased_claim_amount_type": {
+ "type": "boolean"
+ },
+ "include_liability_cap": {
+ "type": "boolean"
+ },
+ "include_liability_cap_amount_constant_external": {
+ "type": "boolean"
+ },
+ "include_liability_cap_amount_constant_internal": {
+ "type": "boolean"
+ },
+ "include_liability_cap_amount_currency_external": {
+ "type": "boolean"
+ },
+ "include_liability_cap_amount_currency_internal": {
+ "type": "boolean"
+ },
+ "include_liability_cap_csa_type": {
+ "type": "boolean"
+ },
+ "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": "boolean"
+ },
+ "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": "boolean"
+ },
+ "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": "boolean"
+ },
+ "include_provider_security_contact_address_country": {
+ "type": "boolean"
+ },
+ "include_provider_security_contact_address_state": {
+ "type": "boolean"
+ },
+ "include_provider_security_contact_address_street_address": {
+ "type": "boolean"
+ },
+ "include_provider_security_contact_address_zipcode": {
+ "type": "boolean"
+ },
+ "include_provider_security_contact_email": {
+ "format": "email",
+ "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "include_provider_security_contact_email_val": {
+ "type": "boolean"
+ },
+ "include_security_measures_accountability": {
+ "type": "boolean"
+ },
+ "include_security_measures_accountability_val": {
+ "type": "boolean"
+ },
+ "include_security_measures_certification_or_assurance": {
+ "type": "boolean"
+ },
+ "include_security_measures_certification_or_assurance_val": {
+ "type": "boolean"
+ },
+ "include_security_measures_confidentiality_integrity": {
+ "type": "boolean"
+ },
+ "include_security_measures_confidentiality_integrity_val": {
+ "type": "boolean"
+ },
+ "include_security_measures_data_at_rest": {
+ "type": "boolean"
+ },
+ "include_security_measures_data_at_rest_val": {
+ "type": "boolean"
+ },
+ "include_security_measures_data_minimization": {
+ "type": "boolean"
+ },
+ "include_security_measures_data_minimization_val": {
+ "type": "boolean"
+ },
+ "include_security_measures_data_quality": {
+ "type": "boolean"
+ },
+ "include_security_measures_data_quality_val": {
+ "type": "boolean"
+ },
+ "include_security_measures_data_retention": {
+ "type": "boolean"
+ },
+ "include_security_measures_data_retention_val": {
+ "type": "boolean"
+ },
+ "include_security_measures_data_transmission": {
+ "type": "boolean"
+ },
+ "include_security_measures_data_transmission_val": {
+ "type": "boolean"
+ },
+ "include_security_measures_event_logging": {
+ "type": "boolean"
+ },
+ "include_security_measures_event_logging_val": {
+ "type": "boolean"
+ },
+ "include_security_measures_identity_auth": {
+ "type": "boolean"
+ },
+ "include_security_measures_identity_auth_val": {
+ "type": "boolean"
+ },
+ "include_security_measures_it_security_governance": {
+ "type": "boolean"
+ },
+ "include_security_measures_it_security_governance_val": {
+ "type": "boolean"
+ },
+ "include_security_measures_physical_security": {
+ "type": "boolean"
+ },
+ "include_security_measures_physical_security_val": {
+ "type": "boolean"
+ },
+ "include_security_measures_portability_and_erasure": {
+ "type": "boolean"
+ },
+ "include_security_measures_portability_and_erasure_val": {
+ "type": "boolean"
+ },
+ "include_security_measures_pseudonym_encryption": {
+ "type": "boolean"
+ },
+ "include_security_measures_pseudonym_encryption_val": {
+ "type": "boolean"
+ },
+ "include_security_measures_restore_data_access": {
+ "type": "boolean"
+ },
+ "include_security_measures_restore_data_access_val": {
+ "type": "boolean"
+ },
+ "include_security_measures_security_policy": {
+ "type": "boolean"
+ },
+ "include_security_measures_system_configuration": {
+ "type": "boolean"
+ },
+ "include_security_measures_system_configuration_val": {
+ "type": "boolean"
+ },
+ "include_security_measures_testing_assessment": {
+ "type": "boolean"
+ },
+ "include_security_measures_testing_assessment_val": {
+ "type": "boolean"
+ },
+ "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": "boolean"
+ },
+ "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": "boolean"
+ },
+ "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": {
+ "type": "string"
+ },
+ "subprocessors_attributes": {
+ "additionalProperties": {
+ "additionalProperties": false,
+ "properties": {
+ "country": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "processing_task": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "description": "Subprocessors. Use string keys such as \"0\", \"1\".",
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+ },
+ "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"
+ },
+ "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"
+ },
+ "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": "string"
+ },
+ "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": "string"
+ },
+ "confidentiality_nda_type": {
+ "type": "string"
+ },
+ "confidentiality_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"
+ },
+ "include_custom_details": {
+ "type": "boolean"
+ },
+ "include_custom_details_val": {
+ "type": "boolean"
+ },
+ "include_fees": {
+ "type": "boolean"
+ },
+ "include_fees_amount": {
+ "type": "boolean"
+ },
+ "include_fees_amount_duration": {
+ "type": "boolean"
+ },
+ "include_fees_include_amount": {
+ "type": "boolean"
+ },
+ "include_fees_include_other": {
+ "type": "boolean"
+ },
+ "include_fees_other": {
+ "type": "boolean"
+ },
+ "include_functionality": {
+ "type": "boolean"
+ },
+ "include_functionality_val": {
+ "type": "boolean"
+ },
+ "include_launch_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_launch_date_custom": {
+ "type": "boolean"
+ },
+ "include_launch_date_date": {
+ "type": "boolean"
+ },
+ "include_launch_date_type": {
+ "type": "boolean"
+ },
+ "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"
+ },
+ "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": {
+ "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": {
+ "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_include_company": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_include_company_val": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_include_partner": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_include_partner_val": {
+ "type": "boolean"
+ },
+ "include_brand_guidelines": {
+ "type": "boolean"
+ },
+ "include_brand_guidelines_include_company": {
+ "type": "boolean"
+ },
+ "include_brand_guidelines_include_company_val": {
+ "type": "boolean"
+ },
+ "include_brand_guidelines_include_partner": {
+ "type": "boolean"
+ },
+ "include_brand_guidelines_include_partner_val": {
+ "type": "boolean"
+ },
+ "include_covered_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_company_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_include_company_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_include_partner_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_partner_claims": {
+ "type": "boolean"
+ },
+ "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": "boolean"
+ },
+ "include_dpa_type": {
+ "type": "boolean"
+ },
+ "include_increased_cap_amount": {
+ "type": "boolean"
+ },
+ "include_increased_cap_amount_currency": {
+ "type": "boolean"
+ },
+ "include_increased_cap_amount_either_currency": {
+ "type": "boolean"
+ },
+ "include_increased_cap_amount_either_multiple": {
+ "type": "boolean"
+ },
+ "include_increased_cap_amount_multiple": {
+ "type": "boolean"
+ },
+ "include_increased_cap_amount_type": {
+ "type": "boolean"
+ },
+ "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": "boolean"
+ },
+ "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": "boolean"
+ },
+ "negotiations_allowed": {
+ "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": {
+ "type": "string"
+ },
+ "end_date_date": {
+ "type": "string"
+ },
+ "end_date_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"
+ },
+ "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": "boolean"
+ },
+ "include_obligations_company_promotion_include_materials": {
+ "type": "boolean"
+ },
+ "include_obligations_company_promotion_include_materials_val": {
+ "type": "boolean"
+ },
+ "include_obligations_company_referral": {
+ "type": "boolean"
+ },
+ "include_obligations_company_referral_include_criteria": {
+ "type": "boolean"
+ },
+ "include_obligations_company_referral_include_criteria_val": {
+ "type": "boolean"
+ },
+ "include_obligations_company_referral_include_pay_sch": {
+ "type": "boolean"
+ },
+ "include_obligations_company_referral_include_pay_sch_amount": {
+ "type": "boolean"
+ },
+ "include_obligations_company_referral_include_pay_sch_custom": {
+ "type": "boolean"
+ },
+ "include_obligations_company_referral_include_pay_sch_unit": {
+ "type": "boolean"
+ },
+ "include_obligations_company_sponsorship": {
+ "type": "boolean"
+ },
+ "include_obligations_company_sponsorship_include_benefits": {
+ "type": "boolean"
+ },
+ "include_obligations_company_sponsorship_include_benefits_val": {
+ "type": "boolean"
+ },
+ "include_obligations_company_sponsorship_include_payments": {
+ "type": "boolean"
+ },
+ "include_obligations_company_sponsorship_include_payments_amount": {
+ "type": "boolean"
+ },
+ "include_obligations_company_sponsorship_include_payments_unit": {
+ "type": "boolean"
+ },
+ "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": "boolean"
+ },
+ "include_obligations_partner_promotion_include_materials": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_promotion_include_materials_val": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_referral": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_referral_include_criteria": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_referral_include_criteria_val": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_referral_include_pay_sch": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_referral_include_pay_sch_amount": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_referral_include_pay_sch_custom": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_referral_include_pay_sch_unit": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_sponsorship": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_sponsorship_include_benefits": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_sponsorship_include_benefits_val": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_sponsorship_include_payments": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_sponsorship_include_payments_amount": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_sponsorship_include_payments_unit": {
+ "type": "boolean"
+ },
+ "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": "boolean"
+ },
+ "include_payment_process_company_include_address_country": {
+ "type": "boolean"
+ },
+ "include_payment_process_company_include_address_state": {
+ "type": "boolean"
+ },
+ "include_payment_process_company_include_address_street_address": {
+ "type": "boolean"
+ },
+ "include_payment_process_company_include_address_zipcode": {
+ "type": "boolean"
+ },
+ "include_payment_process_company_include_email": {
+ "format": "email",
+ "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "include_payment_process_company_include_email_val": {
+ "type": "boolean"
+ },
+ "include_payment_process_partner": {
+ "type": "boolean"
+ },
+ "include_payment_process_partner_include_address": {
+ "type": "boolean"
+ },
+ "include_payment_process_partner_include_address_city": {
+ "type": "boolean"
+ },
+ "include_payment_process_partner_include_address_country": {
+ "type": "boolean"
+ },
+ "include_payment_process_partner_include_address_state": {
+ "type": "boolean"
+ },
+ "include_payment_process_partner_include_address_street_address": {
+ "type": "boolean"
+ },
+ "include_payment_process_partner_include_address_zipcode": {
+ "type": "boolean"
+ },
+ "include_payment_process_partner_include_email": {
+ "format": "email",
+ "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "include_payment_process_partner_include_email_val": {
+ "type": "boolean"
+ },
+ "include_payment_schedule": {
+ "type": "boolean"
+ },
+ "include_payment_schedule_custom": {
+ "type": "boolean"
+ },
+ "include_payment_schedule_specified_amount": {
+ "type": "boolean"
+ },
+ "include_payment_schedule_specified_timeframe": {
+ "type": "boolean"
+ },
+ "include_payment_schedule_specified_unit": {
+ "type": "boolean"
+ },
+ "include_payment_schedule_type": {
+ "type": "boolean"
+ },
+ "negotiations_allowed": {
+ "type": "string"
+ },
+ "territory_type": {
+ "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": {
+ "type": "string"
+ },
+ "general_cap_amount": {
+ "type": "number"
+ },
+ "general_cap_amount_type": {
+ "type": "number"
+ },
+ "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": "boolean"
+ },
+ "include_dpa_type": {
+ "type": "boolean"
+ },
+ "include_payment_process": {
+ "type": "boolean"
+ },
+ "include_technical_support": {
+ "type": "boolean"
+ },
+ "negotiations_allowed": {
+ "type": "string"
+ },
+ "payment_process_automatic_frequency": {
+ "type": "string"
+ },
+ "payment_process_invoice_days": {
+ "type": "number"
+ },
+ "payment_process_invoice_from": {
+ "type": "string"
+ },
+ "payment_process_invoice_timeframe": {
+ "type": "string"
+ },
+ "payment_process_type": {
+ "type": "string"
+ },
+ "pilot_period_description": {
+ "type": "number"
+ },
+ "pilot_period_fees_description": {
+ "type": "number"
+ },
+ "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"
+ },
+ "default_signer_email": {
+ "format": "email",
+ "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "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": {
+ "type": "string"
+ },
+ "general_cap_amount": {
+ "type": "number"
+ },
+ "general_cap_amount_type": {
+ "type": "number"
+ },
+ "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": "boolean"
+ },
+ "include_additional_warranties_by_provider": {
+ "type": "boolean"
+ },
+ "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": "boolean"
+ },
+ "include_covered_claims_include_customer_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_include_provider_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_provider_claims": {
+ "type": "boolean"
+ },
+ "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": "boolean"
+ },
+ "include_customer_insurance_min_auto_liability_minimum": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_cyber_liability_aggregate": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_cyber_liability_minimum": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_employer_liability_aggregate": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_employer_liability_minimum": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_general_liability_aggregate": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_general_liability_minimum": {
+ "type": "boolean"
+ },
+ "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": "boolean"
+ },
+ "include_customer_policies_type": {
+ "type": "boolean"
+ },
+ "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": "boolean"
+ },
+ "include_dpa_type": {
+ "type": "boolean"
+ },
+ "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": "boolean"
+ },
+ "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": "boolean"
+ },
+ "include_provider_insurance_min_auto_liability_minimum": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_cyber_liability_aggregate": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_cyber_liability_minimum": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_employer_liability_aggregate": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_employer_liability_minimum": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_general_liability_aggregate": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_general_liability_minimum": {
+ "type": "boolean"
+ },
+ "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": {
+ "type": "boolean"
+ },
+ "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": "boolean"
+ },
+ "include_security_policy_iso27001": {
+ "type": "boolean"
+ },
+ "include_security_policy_location": {
+ "type": "boolean"
+ },
+ "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": {
+ "type": "boolean"
+ },
+ "include_terms": {
+ "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_negligence": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_other": {
+ "type": "boolean"
+ },
+ "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": {
+ "type": "number"
+ },
+ "negotiations_allowed": {
+ "type": "string"
+ },
+ "sender_last_to_sign": {
+ "type": "boolean"
+ }
+ },
+ "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,
+ "properties": {
+ "cost": {
+ "type": "number"
+ },
+ "description": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class discriminator.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "cost": {
+ "type": "number"
+ },
+ "description": {
+ "type": "string"
+ },
+ "discount_duration_amount": {
+ "type": "number"
+ },
+ "discount_duration_type": {
+ "type": "string"
+ },
+ "discount_type": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class discriminator.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "cost": {
+ "type": "number"
+ },
+ "description": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "quantity": {
+ "type": "number"
+ },
+ "stripe_product_id": {
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class discriminator.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "attachment_id": {
+ "type": "string"
+ },
+ "description": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class discriminator.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "description": {
+ "type": "string"
+ },
+ "fee_type": {
+ "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": {
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class discriminator.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "description": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class discriminator.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "cost": {
+ "type": "number"
+ },
+ "description": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class discriminator.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "cost": {
+ "type": "number"
+ },
+ "description": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class discriminator.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "description": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class discriminator.",
+ "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": "boolean"
+ },
+ "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": "boolean"
+ },
+ "include_deliverables_include_acceptance": {
+ "type": "boolean"
+ },
+ "include_deliverables_include_attachment": {
+ "type": "boolean"
+ },
+ "include_deliverables_include_draft_deliverables": {
+ "type": "boolean"
+ },
+ "include_deliverables_rejection_amount": {
+ "type": "boolean"
+ },
+ "include_deliverables_rejection_unit": {
+ "type": "boolean"
+ },
+ "include_deliverables_resubmission_amount": {
+ "type": "boolean"
+ },
+ "include_deliverables_resubmission_unit": {
+ "type": "boolean"
+ },
+ "include_fees_other": {
+ "type": "boolean"
+ },
+ "include_fees_other_val": {
+ "type": "boolean"
+ },
+ "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": {
+ "type": "boolean"
+ },
+ "include_fees_travel_val": {
+ "type": "boolean"
+ },
+ "include_third_party_customer": {
+ "type": "boolean"
+ },
+ "include_third_party_include_description": {
+ "type": "boolean"
+ },
+ "include_third_party_include_description_val": {
+ "type": "boolean"
+ },
+ "include_third_party_materials": {
+ "type": "boolean"
+ },
+ "include_third_party_provider": {
+ "type": "boolean"
+ },
+ "include_time_of_assignment": {
+ "type": "boolean"
+ },
+ "include_time_of_assignment_type": {
+ "type": "boolean"
+ },
+ "invoice_period_description": {
+ "type": "number"
+ },
+ "negotiations_allowed": {
+ "type": "string"
+ },
+ "payment_period": {
+ "type": "number"
+ },
+ "payment_period_other": {
+ "type": "number"
+ },
+ "payment_period_timeframe": {
+ "type": "number"
+ },
+ "payment_period_type": {
+ "type": "number"
+ },
+ "payment_period_unit": {
+ "type": "number"
+ },
+ "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": {
+ "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": {
+ "type": "string"
+ },
+ "sow_term_unit": {
+ "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-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-z]{2,}$",
+ "type": "string"
+ },
+ "recipient_organization": {
+ "type": "string"
+ },
+ "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-z]{2,}$",
+ "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": {
+ "type": "string"
+ },
+ "general_cap_amount": {
+ "type": "number"
+ },
+ "general_cap_amount_type": {
+ "type": "number"
+ },
+ "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": "boolean"
+ },
+ "include_additional_warranties_by_provider": {
+ "type": "boolean"
+ },
+ "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": "boolean"
+ },
+ "include_covered_claims_include_customer_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_include_provider_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_provider_claims": {
+ "type": "boolean"
+ },
+ "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": "boolean"
+ },
+ "include_dpa_type": {
+ "type": "boolean"
+ },
+ "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": "boolean"
+ },
+ "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": "boolean"
+ },
+ "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": {
+ "type": "number"
+ }
+ },
+ "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": "string"
+ },
+ "deletion_procedure_include_custom_description": {
+ "type": "string"
+ },
+ "deletion_procedure_include_customer_disable": {
+ "type": "string"
+ },
+ "deletion_procedure_include_customer_proof": {
+ "type": "string"
+ },
+ "deletion_procedure_include_provider_disable": {
+ "type": "string"
+ },
+ "fee_custom_unit": {
+ "type": "string"
+ },
+ "fee_period": {
+ "type": "number"
+ },
+ "fees_attributes": {
+ "additionalProperties": {
+ "anyOf": [
+ {
+ "additionalProperties": false,
+ "properties": {
+ "cost": {
+ "type": "number"
+ },
+ "description": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class discriminator.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "cost": {
+ "type": "number"
+ },
+ "description": {
+ "type": "string"
+ },
+ "discount_duration_amount": {
+ "type": "number"
+ },
+ "discount_duration_type": {
+ "type": "string"
+ },
+ "discount_type": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class discriminator.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "cost": {
+ "type": "number"
+ },
+ "description": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "quantity": {
+ "type": "number"
+ },
+ "stripe_product_id": {
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class discriminator.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "attachment_id": {
+ "type": "string"
+ },
+ "description": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class discriminator.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "description": {
+ "type": "string"
+ },
+ "fee_type": {
+ "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": {
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class discriminator.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "description": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class discriminator.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "cost": {
+ "type": "number"
+ },
+ "description": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class discriminator.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "cost": {
+ "type": "number"
+ },
+ "description": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class discriminator.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "description": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class discriminator.",
+ "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": {
+ "type": "string"
+ },
+ "fees_include_fee_increase_upon_renewal": {
+ "type": "number"
+ },
+ "fees_include_fee_increase_upon_renewal_fee": {
+ "type": "number"
+ },
+ "fees_include_fee_increase_upon_renewal_type": {
+ "type": "number"
+ },
+ "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": "boolean"
+ },
+ "include_license_limits": {
+ "type": "boolean"
+ },
+ "include_license_limits_description": {
+ "type": "boolean"
+ },
+ "include_payment_process_include_billing_email": {
+ "format": "email",
+ "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "include_pilot_period": {
+ "type": "boolean"
+ },
+ "include_pilot_period_duration_amount": {
+ "type": "boolean"
+ },
+ "include_pilot_period_duration_type": {
+ "type": "boolean"
+ },
+ "include_pilot_period_include_fees": {
+ "type": "boolean"
+ },
+ "include_pilot_period_include_fees_amount": {
+ "type": "boolean"
+ },
+ "include_pilot_period_include_modifications": {
+ "type": "boolean"
+ },
+ "include_pilot_period_include_modifications_description": {
+ "type": "boolean"
+ },
+ "include_services": {
+ "type": "boolean"
+ },
+ "include_services_description": {
+ "type": "boolean"
+ },
+ "negotiations_allowed": {
+ "type": "string"
+ },
+ "order_date_date": {
+ "type": "string"
+ },
+ "order_date_type": {
+ "type": "string"
+ },
+ "payment_process_automatic_frequency": {
+ "type": "string"
+ },
+ "payment_process_type": {
+ "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": {
+ "type": "string"
+ },
+ "payment_process_type_invoice_duration_start": {
+ "type": "string"
+ },
+ "payment_process_type_invoice_type": {
+ "type": "string"
+ },
+ "permitted_uses_include_custom": {
+ "type": "string"
+ },
+ "permitted_uses_include_custom_description": {
+ "type": "string"
+ },
+ "permitted_uses_include_customers_affiliates": {
+ "type": "string"
+ },
+ "permitted_uses_include_internal_business": {
+ "type": "string"
+ },
+ "pilot_period_stripe_product_id": {
+ "type": "number"
+ },
+ "software_description": {
+ "type": "string"
+ },
+ "subscription_auto_renew": {
+ "type": "string"
+ },
+ "subscription_period": {
+ "type": "number"
+ },
+ "subscription_period_unit": {
+ "type": "number"
+ },
+ "subscription_renewal_notice_days": {
+ "type": "number"
+ },
+ "warranty_period_description_amount": {
+ "type": "number"
+ },
+ "warranty_period_description_duration": {
+ "type": "number"
+ },
+ "warranty_period_description_duration_start": {
+ "type": "number"
+ },
+ "warranty_period_type": {
+ "type": "number"
+ }
+ },
+ "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-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-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": {
+ "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": "number"
+ },
+ "aggregation_limitations_permitted_val": {
+ "type": "number"
+ },
+ "breach_notification_unit": {
+ "type": "string"
+ },
+ "breach_notification_val": {
+ "type": "number"
+ },
+ "business_associate_relationship_type": {
+ "type": "string"
+ },
+ "deidentification_limitations_include_purpose": {
+ "type": "number"
+ },
+ "deidentification_limitations_include_requirements": {
+ "type": "number"
+ },
+ "deidentification_limitations_permitted": {
+ "type": "number"
+ },
+ "deidentification_limitations_purpose_val": {
+ "type": "number"
+ },
+ "deidentification_limitations_requirements_val": {
+ "type": "number"
+ },
+ "designated_record_set_provider_maintains": {
+ "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_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": "number"
+ },
+ "offshore_limitations_permitted_val": {
+ "type": "number"
+ },
+ "subcontract_limitations_include_notice": {
+ "type": "number"
+ },
+ "subcontract_limitations_include_permission": {
+ "type": "number"
+ },
+ "subcontract_limitations_notice_val": {
+ "type": "number"
+ },
+ "subcontract_limitations_permission_val": {
+ "type": "number"
+ },
+ "subcontract_limitations_permitted": {
+ "type": "number"
+ },
+ "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"
+ },
+ "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-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"
+ },
+ "default_signer_email": {
+ "format": "email",
+ "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "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": {
+ "type": "string"
+ },
+ "effective_date_type": {
+ "type": "string"
+ },
+ "general_cap_amount": {
+ "type": "number"
+ },
+ "general_cap_amount_type": {
+ "type": "number"
+ },
+ "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": "boolean"
+ },
+ "include_acceptable_use_policy_type": {
+ "type": "boolean"
+ },
+ "include_additional_warranties": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_by_customer": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_by_provider": {
+ "type": "boolean"
+ },
+ "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": "boolean"
+ },
+ "include_covered_claims_include_customer_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_include_provider_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_provider_claims": {
+ "type": "boolean"
+ },
+ "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": "boolean"
+ },
+ "include_dpa_type": {
+ "type": "boolean"
+ },
+ "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": "boolean"
+ },
+ "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": "boolean"
+ },
+ "include_insurance_minimums_cyber_liability_aggregate": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_cyber_liability_minimum": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_employer_liability_aggregate": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_employer_liability_minimum": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_general_liability_aggregate": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_general_liability_minimum": {
+ "type": "boolean"
+ },
+ "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": {
+ "type": "boolean"
+ },
+ "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": "boolean"
+ },
+ "include_security_policy_other": {
+ "type": "boolean"
+ },
+ "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": {
+ "type": "boolean"
+ },
+ "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_terms": {
+ "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": "boolean"
+ },
+ "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": {
+ "type": "number"
+ },
+ "negotiations_allowed": {
+ "type": "string"
+ },
+ "provider": {
+ "type": "string"
+ },
+ "sender_last_to_sign": {
+ "type": "boolean"
+ },
+ "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": "number"
+ },
+ "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": {
+ "type": "number"
+ },
+ "fees_attributes": {
+ "additionalProperties": {
+ "anyOf": [
+ {
+ "additionalProperties": false,
+ "properties": {
+ "cost": {
+ "type": "number"
+ },
+ "description": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class discriminator.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "cost": {
+ "type": "number"
+ },
+ "description": {
+ "type": "string"
+ },
+ "discount_duration_amount": {
+ "type": "number"
+ },
+ "discount_duration_type": {
+ "type": "string"
+ },
+ "discount_type": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class discriminator.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "cost": {
+ "type": "number"
+ },
+ "description": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "quantity": {
+ "type": "number"
+ },
+ "stripe_product_id": {
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class discriminator.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "attachment_id": {
+ "type": "string"
+ },
+ "description": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class discriminator.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "description": {
+ "type": "string"
+ },
+ "fee_type": {
+ "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": {
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class discriminator.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "description": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class discriminator.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "cost": {
+ "type": "number"
+ },
+ "description": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class discriminator.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "cost": {
+ "type": "number"
+ },
+ "description": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class discriminator.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "description": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class discriminator.",
+ "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": {
+ "type": "string"
+ },
+ "fees_include_fee_increase_upon_renewal": {
+ "type": "number"
+ },
+ "fees_include_fee_increase_upon_renewal_fee": {
+ "type": "number"
+ },
+ "fees_include_fee_increase_upon_renewal_type": {
+ "type": "number"
+ },
+ "fees_inclusive_of_taxes": {
+ "type": "boolean"
+ },
+ "framework_terms_type": {
+ "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": "boolean"
+ },
+ "include_fees_table": {
+ "type": "boolean"
+ },
+ "include_fees_table_period": {
+ "type": "boolean"
+ },
+ "include_free_trial": {
+ "type": "boolean"
+ },
+ "include_max_users": {
+ "type": "boolean"
+ },
+ "include_pilot_period": {
+ "type": "boolean"
+ },
+ "include_pilot_period_duration_amount": {
+ "type": "boolean"
+ },
+ "include_pilot_period_duration_type": {
+ "type": "boolean"
+ },
+ "include_pilot_period_include_fees": {
+ "type": "boolean"
+ },
+ "include_pilot_period_include_fees_amount": {
+ "type": "boolean"
+ },
+ "include_pilot_period_include_modifications": {
+ "type": "boolean"
+ },
+ "include_pilot_period_include_modifications_description": {
+ "type": "boolean"
+ },
+ "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": "boolean"
+ },
+ "include_product_support_type": {
+ "type": "boolean"
+ },
+ "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": "boolean"
+ },
+ "include_professional_services_description": {
+ "type": "boolean"
+ },
+ "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": "boolean"
+ },
+ "include_professional_services_include_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_include_fees_description": {
+ "type": "boolean"
+ },
+ "include_professional_services_type": {
+ "type": "boolean"
+ },
+ "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": "boolean"
+ },
+ "include_sla_include_response_time": {
+ "type": "boolean"
+ },
+ "include_sla_include_response_time_amount": {
+ "type": "boolean"
+ },
+ "include_sla_include_response_time_credit": {
+ "type": "boolean"
+ },
+ "include_sla_include_response_time_duration": {
+ "type": "boolean"
+ },
+ "include_sla_include_response_time_support_channel": {
+ "type": "boolean"
+ },
+ "include_sla_include_target_uptime": {
+ "type": "boolean"
+ },
+ "include_sla_maintenance_notice": {
+ "type": "boolean"
+ },
+ "include_sla_maintenance_window": {
+ "type": "boolean"
+ },
+ "include_sla_maintenance_window_type": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_notice_qty": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_notice_unit": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_end_time": {
+ "type": "boolean"
+ },
+ "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": "boolean"
+ },
+ "include_sla_standard_maintenance_window_sunday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_thursday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_time_zone": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_tuesday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_wednesday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_target_uptime": {
+ "type": "boolean"
+ },
+ "include_sla_type": {
+ "type": "boolean"
+ },
+ "include_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"
+ },
+ "include_subscription_start_date_date": {
+ "type": "boolean"
+ },
+ "include_usage_review": {
+ "type": "boolean"
+ },
+ "include_usage_review_val": {
+ "type": "boolean"
+ },
+ "include_use_limitations": {
+ "type": "boolean"
+ },
+ "include_use_limitations_val": {
+ "type": "boolean"
+ },
+ "invoice_period": {
+ "type": "number"
+ },
+ "invoice_period_custom_unit": {
+ "type": "number"
+ },
+ "max_consumption": {
+ "type": "number"
+ },
+ "max_users": {
+ "type": "number"
+ },
+ "negotiations_allowed": {
+ "type": "string"
+ },
+ "order_date_date": {
+ "type": "string"
+ },
+ "order_date_other": {
+ "type": "string"
+ },
+ "order_date_type": {
+ "type": "string"
+ },
+ "payment_period": {
+ "type": "number"
+ },
+ "payment_period_timeframe": {
+ "type": "number"
+ },
+ "payment_period_unit": {
+ "type": "number"
+ },
+ "payment_process_automatic_frequency": {
+ "type": "string"
+ },
+ "payment_process_type": {
+ "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": {
+ "type": "string"
+ },
+ "payment_process_type_invoice_duration_start": {
+ "type": "string"
+ },
+ "payment_process_type_invoice_type": {
+ "type": "string"
+ },
+ "pilot_period_stripe_product_id": {
+ "type": "number"
+ },
+ "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": {
+ "type": "string"
+ },
+ "subscription_period": {
+ "type": "number"
+ },
+ "subscription_period_unit": {
+ "type": "number"
+ },
+ "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": {
+ "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": "boolean"
+ },
+ "include_fees_description": {
+ "type": "boolean"
+ },
+ "include_fees_pay_by_amount": {
+ "type": "boolean"
+ },
+ "include_fees_type": {
+ "type": "boolean"
+ },
+ "include_fees_unit": {
+ "type": "boolean"
+ },
+ "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": "boolean"
+ },
+ "include_program_discount": {
+ "type": "boolean"
+ },
+ "include_program_discount_amount": {
+ "type": "boolean"
+ },
+ "include_program_discount_unit": {
+ "type": "boolean"
+ },
+ "include_program_participation_feedback": {
+ "type": "boolean"
+ },
+ "include_program_participation_feedback_amount": {
+ "type": "boolean"
+ },
+ "include_program_participation_feedback_unit": {
+ "type": "boolean"
+ },
+ "include_program_partner_other": {
+ "type": "boolean"
+ },
+ "include_program_partner_other_val": {
+ "type": "boolean"
+ },
+ "include_program_provider_other": {
+ "type": "boolean"
+ },
+ "include_program_provider_other_val": {
+ "type": "boolean"
+ },
+ "include_program_reference": {
+ "type": "boolean"
+ },
+ "product_description": {
+ "type": "string"
+ },
+ "term_amount": {
+ "type": "number"
+ },
+ "term_unit": {
+ "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": {
+ "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": "number"
+ },
+ "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": {
+ "type": "string"
+ },
+ "data_importer_address": {
+ "type": "string"
+ },
+ "data_importer_address_city": {
+ "type": "string"
+ },
+ "data_importer_address_country": {
+ "type": "number"
+ },
+ "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": "boolean"
+ },
+ "include_covered_claim_internal_val": {
+ "type": "boolean"
+ },
+ "include_covered_claim_type": {
+ "type": "boolean"
+ },
+ "include_data_subjects_custom": {
+ "type": "boolean"
+ },
+ "include_data_subjects_custom_val": {
+ "type": "boolean"
+ },
+ "include_data_subjects_employees": {
+ "type": "boolean"
+ },
+ "include_data_subjects_end_users": {
+ "type": "boolean"
+ },
+ "include_external_subprocessor_location": {
+ "type": "boolean"
+ },
+ "include_frequency_of_transfer_continuous": {
+ "type": "boolean"
+ },
+ "include_frequency_of_transfer_custom": {
+ "type": "boolean"
+ },
+ "include_frequency_of_transfer_custom_val": {
+ "type": "boolean"
+ },
+ "include_governing_country_eu": {
+ "type": "boolean"
+ },
+ "include_governing_country_eu_val": {
+ "type": "boolean"
+ },
+ "include_governing_country_uk": {
+ "type": "boolean"
+ },
+ "include_governing_country_uk_val": {
+ "type": "boolean"
+ },
+ "include_governing_law": {
+ "type": "boolean"
+ },
+ "include_governing_law_country": {
+ "type": "boolean"
+ },
+ "include_governing_law_state": {
+ "type": "boolean"
+ },
+ "include_increased_claim_amount": {
+ "type": "boolean"
+ },
+ "include_increased_claim_amount_currency": {
+ "type": "boolean"
+ },
+ "include_increased_claim_amount_qty": {
+ "type": "boolean"
+ },
+ "include_increased_claim_amount_type": {
+ "type": "boolean"
+ },
+ "include_liability_cap": {
+ "type": "boolean"
+ },
+ "include_liability_cap_amount_constant_external": {
+ "type": "boolean"
+ },
+ "include_liability_cap_amount_constant_internal": {
+ "type": "boolean"
+ },
+ "include_liability_cap_amount_currency_external": {
+ "type": "boolean"
+ },
+ "include_liability_cap_amount_currency_internal": {
+ "type": "boolean"
+ },
+ "include_liability_cap_csa_type": {
+ "type": "boolean"
+ },
+ "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": "boolean"
+ },
+ "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": "boolean"
+ },
+ "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": "boolean"
+ },
+ "include_provider_security_contact_address_country": {
+ "type": "boolean"
+ },
+ "include_provider_security_contact_address_state": {
+ "type": "boolean"
+ },
+ "include_provider_security_contact_address_street_address": {
+ "type": "boolean"
+ },
+ "include_provider_security_contact_address_zipcode": {
+ "type": "boolean"
+ },
+ "include_provider_security_contact_email": {
+ "format": "email",
+ "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "include_provider_security_contact_email_val": {
+ "type": "boolean"
+ },
+ "include_security_measures_accountability": {
+ "type": "boolean"
+ },
+ "include_security_measures_accountability_val": {
+ "type": "boolean"
+ },
+ "include_security_measures_certification_or_assurance": {
+ "type": "boolean"
+ },
+ "include_security_measures_certification_or_assurance_val": {
+ "type": "boolean"
+ },
+ "include_security_measures_confidentiality_integrity": {
+ "type": "boolean"
+ },
+ "include_security_measures_confidentiality_integrity_val": {
+ "type": "boolean"
+ },
+ "include_security_measures_data_at_rest": {
+ "type": "boolean"
+ },
+ "include_security_measures_data_at_rest_val": {
+ "type": "boolean"
+ },
+ "include_security_measures_data_minimization": {
+ "type": "boolean"
+ },
+ "include_security_measures_data_minimization_val": {
+ "type": "boolean"
+ },
+ "include_security_measures_data_quality": {
+ "type": "boolean"
+ },
+ "include_security_measures_data_quality_val": {
+ "type": "boolean"
+ },
+ "include_security_measures_data_retention": {
+ "type": "boolean"
+ },
+ "include_security_measures_data_retention_val": {
+ "type": "boolean"
+ },
+ "include_security_measures_data_transmission": {
+ "type": "boolean"
+ },
+ "include_security_measures_data_transmission_val": {
+ "type": "boolean"
+ },
+ "include_security_measures_event_logging": {
+ "type": "boolean"
+ },
+ "include_security_measures_event_logging_val": {
+ "type": "boolean"
+ },
+ "include_security_measures_identity_auth": {
+ "type": "boolean"
+ },
+ "include_security_measures_identity_auth_val": {
+ "type": "boolean"
+ },
+ "include_security_measures_it_security_governance": {
+ "type": "boolean"
+ },
+ "include_security_measures_it_security_governance_val": {
+ "type": "boolean"
+ },
+ "include_security_measures_physical_security": {
+ "type": "boolean"
+ },
+ "include_security_measures_physical_security_val": {
+ "type": "boolean"
+ },
+ "include_security_measures_portability_and_erasure": {
+ "type": "boolean"
+ },
+ "include_security_measures_portability_and_erasure_val": {
+ "type": "boolean"
+ },
+ "include_security_measures_pseudonym_encryption": {
+ "type": "boolean"
+ },
+ "include_security_measures_pseudonym_encryption_val": {
+ "type": "boolean"
+ },
+ "include_security_measures_restore_data_access": {
+ "type": "boolean"
+ },
+ "include_security_measures_restore_data_access_val": {
+ "type": "boolean"
+ },
+ "include_security_measures_security_policy": {
+ "type": "boolean"
+ },
+ "include_security_measures_system_configuration": {
+ "type": "boolean"
+ },
+ "include_security_measures_system_configuration_val": {
+ "type": "boolean"
+ },
+ "include_security_measures_testing_assessment": {
+ "type": "boolean"
+ },
+ "include_security_measures_testing_assessment_val": {
+ "type": "boolean"
+ },
+ "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": "boolean"
+ },
+ "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": "boolean"
+ },
+ "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": {
+ "type": "string"
+ },
+ "subprocessors_attributes": {
+ "additionalProperties": {
+ "additionalProperties": false,
+ "properties": {
+ "country": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "processing_task": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "description": "Subprocessors. Use string keys such as \"0\", \"1\".",
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+ },
+ "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"
+ },
+ "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"
+ },
+ "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": "string"
+ },
+ "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": "string"
+ },
+ "confidentiality_nda_type": {
+ "type": "string"
+ },
+ "confidentiality_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"
+ },
+ "include_custom_details": {
+ "type": "boolean"
+ },
+ "include_custom_details_val": {
+ "type": "boolean"
+ },
+ "include_fees": {
+ "type": "boolean"
+ },
+ "include_fees_amount": {
+ "type": "boolean"
+ },
+ "include_fees_amount_duration": {
+ "type": "boolean"
+ },
+ "include_fees_include_amount": {
+ "type": "boolean"
+ },
+ "include_fees_include_other": {
+ "type": "boolean"
+ },
+ "include_fees_other": {
+ "type": "boolean"
+ },
+ "include_functionality": {
+ "type": "boolean"
+ },
+ "include_functionality_val": {
+ "type": "boolean"
+ },
+ "include_launch_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_launch_date_custom": {
+ "type": "boolean"
+ },
+ "include_launch_date_date": {
+ "type": "boolean"
+ },
+ "include_launch_date_type": {
+ "type": "boolean"
+ },
+ "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"
+ },
+ "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": {
+ "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": {
+ "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_include_company": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_include_company_val": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_include_partner": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_include_partner_val": {
+ "type": "boolean"
+ },
+ "include_brand_guidelines": {
+ "type": "boolean"
+ },
+ "include_brand_guidelines_include_company": {
+ "type": "boolean"
+ },
+ "include_brand_guidelines_include_company_val": {
+ "type": "boolean"
+ },
+ "include_brand_guidelines_include_partner": {
+ "type": "boolean"
+ },
+ "include_brand_guidelines_include_partner_val": {
+ "type": "boolean"
+ },
+ "include_covered_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_company_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_include_company_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_include_partner_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_partner_claims": {
+ "type": "boolean"
+ },
+ "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": "boolean"
+ },
+ "include_dpa_type": {
+ "type": "boolean"
+ },
+ "include_increased_cap_amount": {
+ "type": "boolean"
+ },
+ "include_increased_cap_amount_currency": {
+ "type": "boolean"
+ },
+ "include_increased_cap_amount_either_currency": {
+ "type": "boolean"
+ },
+ "include_increased_cap_amount_either_multiple": {
+ "type": "boolean"
+ },
+ "include_increased_cap_amount_multiple": {
+ "type": "boolean"
+ },
+ "include_increased_cap_amount_type": {
+ "type": "boolean"
+ },
+ "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": "boolean"
+ },
+ "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": "boolean"
+ },
+ "negotiations_allowed": {
+ "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": {
+ "type": "string"
+ },
+ "end_date_date": {
+ "type": "string"
+ },
+ "end_date_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"
+ },
+ "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": "boolean"
+ },
+ "include_obligations_company_promotion_include_materials": {
+ "type": "boolean"
+ },
+ "include_obligations_company_promotion_include_materials_val": {
+ "type": "boolean"
+ },
+ "include_obligations_company_referral": {
+ "type": "boolean"
+ },
+ "include_obligations_company_referral_include_criteria": {
+ "type": "boolean"
+ },
+ "include_obligations_company_referral_include_criteria_val": {
+ "type": "boolean"
+ },
+ "include_obligations_company_referral_include_pay_sch": {
+ "type": "boolean"
+ },
+ "include_obligations_company_referral_include_pay_sch_amount": {
+ "type": "boolean"
+ },
+ "include_obligations_company_referral_include_pay_sch_custom": {
+ "type": "boolean"
+ },
+ "include_obligations_company_referral_include_pay_sch_unit": {
+ "type": "boolean"
+ },
+ "include_obligations_company_sponsorship": {
+ "type": "boolean"
+ },
+ "include_obligations_company_sponsorship_include_benefits": {
+ "type": "boolean"
+ },
+ "include_obligations_company_sponsorship_include_benefits_val": {
+ "type": "boolean"
+ },
+ "include_obligations_company_sponsorship_include_payments": {
+ "type": "boolean"
+ },
+ "include_obligations_company_sponsorship_include_payments_amount": {
+ "type": "boolean"
+ },
+ "include_obligations_company_sponsorship_include_payments_unit": {
+ "type": "boolean"
+ },
+ "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": "boolean"
+ },
+ "include_obligations_partner_promotion_include_materials": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_promotion_include_materials_val": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_referral": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_referral_include_criteria": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_referral_include_criteria_val": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_referral_include_pay_sch": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_referral_include_pay_sch_amount": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_referral_include_pay_sch_custom": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_referral_include_pay_sch_unit": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_sponsorship": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_sponsorship_include_benefits": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_sponsorship_include_benefits_val": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_sponsorship_include_payments": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_sponsorship_include_payments_amount": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_sponsorship_include_payments_unit": {
+ "type": "boolean"
+ },
+ "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": "boolean"
+ },
+ "include_payment_process_company_include_address_country": {
+ "type": "boolean"
+ },
+ "include_payment_process_company_include_address_state": {
+ "type": "boolean"
+ },
+ "include_payment_process_company_include_address_street_address": {
+ "type": "boolean"
+ },
+ "include_payment_process_company_include_address_zipcode": {
+ "type": "boolean"
+ },
+ "include_payment_process_company_include_email": {
+ "format": "email",
+ "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "include_payment_process_company_include_email_val": {
+ "type": "boolean"
+ },
+ "include_payment_process_partner": {
+ "type": "boolean"
+ },
+ "include_payment_process_partner_include_address": {
+ "type": "boolean"
+ },
+ "include_payment_process_partner_include_address_city": {
+ "type": "boolean"
+ },
+ "include_payment_process_partner_include_address_country": {
+ "type": "boolean"
+ },
+ "include_payment_process_partner_include_address_state": {
+ "type": "boolean"
+ },
+ "include_payment_process_partner_include_address_street_address": {
+ "type": "boolean"
+ },
+ "include_payment_process_partner_include_address_zipcode": {
+ "type": "boolean"
+ },
+ "include_payment_process_partner_include_email": {
+ "format": "email",
+ "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "include_payment_process_partner_include_email_val": {
+ "type": "boolean"
+ },
+ "include_payment_schedule": {
+ "type": "boolean"
+ },
+ "include_payment_schedule_custom": {
+ "type": "boolean"
+ },
+ "include_payment_schedule_specified_amount": {
+ "type": "boolean"
+ },
+ "include_payment_schedule_specified_timeframe": {
+ "type": "boolean"
+ },
+ "include_payment_schedule_specified_unit": {
+ "type": "boolean"
+ },
+ "include_payment_schedule_type": {
+ "type": "boolean"
+ },
+ "negotiations_allowed": {
+ "type": "string"
+ },
+ "territory_type": {
+ "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": {
+ "type": "string"
+ },
+ "general_cap_amount": {
+ "type": "number"
+ },
+ "general_cap_amount_type": {
+ "type": "number"
+ },
+ "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": "boolean"
+ },
+ "include_dpa_type": {
+ "type": "boolean"
+ },
+ "include_payment_process": {
+ "type": "boolean"
+ },
+ "include_technical_support": {
+ "type": "boolean"
+ },
+ "negotiations_allowed": {
+ "type": "string"
+ },
+ "payment_process_automatic_frequency": {
+ "type": "string"
+ },
+ "payment_process_invoice_days": {
+ "type": "number"
+ },
+ "payment_process_invoice_from": {
+ "type": "string"
+ },
+ "payment_process_invoice_timeframe": {
+ "type": "string"
+ },
+ "payment_process_type": {
+ "type": "string"
+ },
+ "pilot_period_description": {
+ "type": "number"
+ },
+ "pilot_period_fees_description": {
+ "type": "number"
+ },
+ "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"
+ },
+ "default_signer_email": {
+ "format": "email",
+ "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "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": {
+ "type": "string"
+ },
+ "general_cap_amount": {
+ "type": "number"
+ },
+ "general_cap_amount_type": {
+ "type": "number"
+ },
+ "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": "boolean"
+ },
+ "include_additional_warranties_by_provider": {
+ "type": "boolean"
+ },
+ "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": "boolean"
+ },
+ "include_covered_claims_include_customer_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_include_provider_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_provider_claims": {
+ "type": "boolean"
+ },
+ "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": "boolean"
+ },
+ "include_customer_insurance_min_auto_liability_minimum": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_cyber_liability_aggregate": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_cyber_liability_minimum": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_employer_liability_aggregate": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_employer_liability_minimum": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_general_liability_aggregate": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_general_liability_minimum": {
+ "type": "boolean"
+ },
+ "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": "boolean"
+ },
+ "include_customer_policies_type": {
+ "type": "boolean"
+ },
+ "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": "boolean"
+ },
+ "include_dpa_type": {
+ "type": "boolean"
+ },
+ "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": "boolean"
+ },
+ "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": "boolean"
+ },
+ "include_provider_insurance_min_auto_liability_minimum": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_cyber_liability_aggregate": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_cyber_liability_minimum": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_employer_liability_aggregate": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_employer_liability_minimum": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_general_liability_aggregate": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_general_liability_minimum": {
+ "type": "boolean"
+ },
+ "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": {
+ "type": "boolean"
+ },
+ "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": "boolean"
+ },
+ "include_security_policy_iso27001": {
+ "type": "boolean"
+ },
+ "include_security_policy_location": {
+ "type": "boolean"
+ },
+ "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": {
+ "type": "boolean"
+ },
+ "include_terms": {
+ "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_negligence": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_other": {
+ "type": "boolean"
+ },
+ "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": {
+ "type": "number"
+ },
+ "negotiations_allowed": {
+ "type": "string"
+ },
+ "sender_last_to_sign": {
+ "type": "boolean"
+ }
+ },
+ "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,
+ "properties": {
+ "cost": {
+ "type": "number"
+ },
+ "description": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class discriminator.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "cost": {
+ "type": "number"
+ },
+ "description": {
+ "type": "string"
+ },
+ "discount_duration_amount": {
+ "type": "number"
+ },
+ "discount_duration_type": {
+ "type": "string"
+ },
+ "discount_type": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class discriminator.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "cost": {
+ "type": "number"
+ },
+ "description": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "quantity": {
+ "type": "number"
+ },
+ "stripe_product_id": {
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class discriminator.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "attachment_id": {
+ "type": "string"
+ },
+ "description": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class discriminator.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "description": {
+ "type": "string"
+ },
+ "fee_type": {
+ "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": {
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class discriminator.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "description": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class discriminator.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "cost": {
+ "type": "number"
+ },
+ "description": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class discriminator.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "cost": {
+ "type": "number"
+ },
+ "description": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class discriminator.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "description": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class discriminator.",
+ "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": "boolean"
+ },
+ "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": "boolean"
+ },
+ "include_deliverables_include_acceptance": {
+ "type": "boolean"
+ },
+ "include_deliverables_include_attachment": {
+ "type": "boolean"
+ },
+ "include_deliverables_include_draft_deliverables": {
+ "type": "boolean"
+ },
+ "include_deliverables_rejection_amount": {
+ "type": "boolean"
+ },
+ "include_deliverables_rejection_unit": {
+ "type": "boolean"
+ },
+ "include_deliverables_resubmission_amount": {
+ "type": "boolean"
+ },
+ "include_deliverables_resubmission_unit": {
+ "type": "boolean"
+ },
+ "include_fees_other": {
+ "type": "boolean"
+ },
+ "include_fees_other_val": {
+ "type": "boolean"
+ },
+ "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": {
+ "type": "boolean"
+ },
+ "include_fees_travel_val": {
+ "type": "boolean"
+ },
+ "include_third_party_customer": {
+ "type": "boolean"
+ },
+ "include_third_party_include_description": {
+ "type": "boolean"
+ },
+ "include_third_party_include_description_val": {
+ "type": "boolean"
+ },
+ "include_third_party_materials": {
+ "type": "boolean"
+ },
+ "include_third_party_provider": {
+ "type": "boolean"
+ },
+ "include_time_of_assignment": {
+ "type": "boolean"
+ },
+ "include_time_of_assignment_type": {
+ "type": "boolean"
+ },
+ "invoice_period_description": {
+ "type": "number"
+ },
+ "negotiations_allowed": {
+ "type": "string"
+ },
+ "payment_period": {
+ "type": "number"
+ },
+ "payment_period_other": {
+ "type": "number"
+ },
+ "payment_period_timeframe": {
+ "type": "number"
+ },
+ "payment_period_type": {
+ "type": "number"
+ },
+ "payment_period_unit": {
+ "type": "number"
+ },
+ "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": {
+ "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": {
+ "type": "string"
+ },
+ "sow_term_unit": {
+ "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-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-z]{2,}$",
+ "type": "string"
+ },
+ "recipient_organization": {
+ "type": "string"
+ },
+ "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-z]{2,}$",
+ "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": {
+ "type": "string"
+ },
+ "general_cap_amount": {
+ "type": "number"
+ },
+ "general_cap_amount_type": {
+ "type": "number"
+ },
+ "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": "boolean"
+ },
+ "include_additional_warranties_by_provider": {
+ "type": "boolean"
+ },
+ "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": "boolean"
+ },
+ "include_covered_claims_include_customer_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_include_provider_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_provider_claims": {
+ "type": "boolean"
+ },
+ "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": "boolean"
+ },
+ "include_dpa_type": {
+ "type": "boolean"
+ },
+ "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": "boolean"
+ },
+ "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": "boolean"
+ },
+ "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": {
+ "type": "number"
+ }
+ },
+ "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": "string"
+ },
+ "deletion_procedure_include_custom_description": {
+ "type": "string"
+ },
+ "deletion_procedure_include_customer_disable": {
+ "type": "string"
+ },
+ "deletion_procedure_include_customer_proof": {
+ "type": "string"
+ },
+ "deletion_procedure_include_provider_disable": {
+ "type": "string"
+ },
+ "fee_custom_unit": {
+ "type": "string"
+ },
+ "fee_period": {
+ "type": "number"
+ },
+ "fees_attributes": {
+ "additionalProperties": {
+ "anyOf": [
+ {
+ "additionalProperties": false,
+ "properties": {
+ "cost": {
+ "type": "number"
+ },
+ "description": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class discriminator.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "cost": {
+ "type": "number"
+ },
+ "description": {
+ "type": "string"
+ },
+ "discount_duration_amount": {
+ "type": "number"
+ },
+ "discount_duration_type": {
+ "type": "string"
+ },
+ "discount_type": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class discriminator.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "cost": {
+ "type": "number"
+ },
+ "description": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "quantity": {
+ "type": "number"
+ },
+ "stripe_product_id": {
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class discriminator.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "attachment_id": {
+ "type": "string"
+ },
+ "description": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class discriminator.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "description": {
+ "type": "string"
+ },
+ "fee_type": {
+ "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": {
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class discriminator.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "description": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class discriminator.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "cost": {
+ "type": "number"
+ },
+ "description": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class discriminator.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "cost": {
+ "type": "number"
+ },
+ "description": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class discriminator.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "description": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class discriminator.",
+ "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": {
+ "type": "string"
+ },
+ "fees_include_fee_increase_upon_renewal": {
+ "type": "number"
+ },
+ "fees_include_fee_increase_upon_renewal_fee": {
+ "type": "number"
+ },
+ "fees_include_fee_increase_upon_renewal_type": {
+ "type": "number"
+ },
+ "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": "boolean"
+ },
+ "include_license_limits": {
+ "type": "boolean"
+ },
+ "include_license_limits_description": {
+ "type": "boolean"
+ },
+ "include_payment_process_include_billing_email": {
+ "format": "email",
+ "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "include_pilot_period": {
+ "type": "boolean"
+ },
+ "include_pilot_period_duration_amount": {
+ "type": "boolean"
+ },
+ "include_pilot_period_duration_type": {
+ "type": "boolean"
+ },
+ "include_pilot_period_include_fees": {
+ "type": "boolean"
+ },
+ "include_pilot_period_include_fees_amount": {
+ "type": "boolean"
+ },
+ "include_pilot_period_include_modifications": {
+ "type": "boolean"
+ },
+ "include_pilot_period_include_modifications_description": {
+ "type": "boolean"
+ },
+ "include_services": {
+ "type": "boolean"
+ },
+ "include_services_description": {
+ "type": "boolean"
+ },
+ "negotiations_allowed": {
+ "type": "string"
+ },
+ "order_date_date": {
+ "type": "string"
+ },
+ "order_date_type": {
+ "type": "string"
+ },
+ "payment_process_automatic_frequency": {
+ "type": "string"
+ },
+ "payment_process_type": {
+ "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": {
+ "type": "string"
+ },
+ "payment_process_type_invoice_duration_start": {
+ "type": "string"
+ },
+ "payment_process_type_invoice_type": {
+ "type": "string"
+ },
+ "permitted_uses_include_custom": {
+ "type": "string"
+ },
+ "permitted_uses_include_custom_description": {
+ "type": "string"
+ },
+ "permitted_uses_include_customers_affiliates": {
+ "type": "string"
+ },
+ "permitted_uses_include_internal_business": {
+ "type": "string"
+ },
+ "pilot_period_stripe_product_id": {
+ "type": "number"
+ },
+ "software_description": {
+ "type": "string"
+ },
+ "subscription_auto_renew": {
+ "type": "string"
+ },
+ "subscription_period": {
+ "type": "number"
+ },
+ "subscription_period_unit": {
+ "type": "number"
+ },
+ "subscription_renewal_notice_days": {
+ "type": "number"
+ },
+ "warranty_period_description_amount": {
+ "type": "number"
+ },
+ "warranty_period_description_duration": {
+ "type": "number"
+ },
+ "warranty_period_description_duration_start": {
+ "type": "number"
+ },
+ "warranty_period_type": {
+ "type": "number"
+ }
+ },
+ "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-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"
+ }
+]update-draft-agreement1 field changedInput schema / properties / body / anyOfPrevious value: -[
- {
- "additionalProperties": false,
- "description": "Body for a draft whose `agreement_type` is `NDA`. NDA terms live directly on the agreement (`purpose`, `term`, `confidentiality_period`), so an NDA draft has no term object of its own.",
- "properties": {
- "agreement": {
- "additionalProperties": {},
- "description": "The cover page fields every draft accepts, whatever its agreement type. Omitted fields keep their current values.",
- "properties": {
- "additional_changes": {
- "description": "Free-text changes shown on the cover page.",
- "type": "string"
- },
- "agreement_roles_attributes": {
- "description": "The keep-informed (`cc`) users on the draft. Requires `include_cc_users` to be `true`. Add a person by sending `role: \"cc\"` with `user_attributes.email` and no `id`. Remove one by sending its existing `id` with a blank `user_attributes.email`. People are identified by email only, so there is no way to cc someone by user id.",
- "items": {
- "additionalProperties": false,
- "properties": {
- "id": {
- "description": "The UUID of an existing role. Omit when adding a new person.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "role": {
- "description": "The role to manage. Only `cc` roles can be changed through this endpoint.",
- "enum": [
- "cc"
- ],
- "type": "string"
- },
- "user_attributes": {
- "additionalProperties": false,
- "description": "The person to cc. Send a blank `email` with an `id` to remove that person.",
- "properties": {
- "email": {
- "anyOf": [
- {},
- {}
- ]
- }
- },
- "type": "object"
- }
- },
- "required": [
- "role"
- ],
- "type": "object"
- },
- "type": "array"
- },
- "attachment_ids": {
- "description": "The UUIDs of the attachments to include, from `POST /v1/attachments`. Replaces the current list.",
- "items": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "type": "array"
- },
- "billing_email": {
- "description": "Email of the billing contact.",
- "format": "email",
- "pattern": "^(?!\\.)(?!.*\\.\\.)([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.",
- "type": "string"
- },
- "billing_workflow_type": {
- "description": "The type of billing workflow. Use \"link\" with `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"
- },
- "confidentiality_period": {
- "description": "How many years confidentiality obligations last (NDA).",
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "confidentiality_period_perpetual": {
- "description": "When true, confidentiality obligations are perpetual (NDA).",
- "type": "boolean"
- },
- "default_signer_email": {
- "description": "The email of the user in your organization who signs the agreement. Must belong to a user in your organization; changing it moves the signer role to that user. A signer outside your organization returns a 400.",
- "format": "email",
- "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
- "type": "string"
- },
- "district_or_county": {
- "description": "The district or county for dispute resolution.",
- "type": "string"
- },
- "effective_date": {
- "description": "The effective date, when set explicitly.",
- "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_of_confidentiality": {
- "description": "When confidentiality obligations begin (NDA).",
- "type": "string"
- },
- "effective_date_type": {
- "description": "How the effective date is determined.",
- "type": "string"
- },
- "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\" with `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_additional_changes": {
- "description": "When true, `additional_changes` is included on the cover page.",
- "type": "boolean"
- },
- "include_automated_nudges": {
- "description": "When true, reminder emails are sent automatically.",
- "type": "boolean"
- },
- "include_automated_payment_reminders": {
- "description": "When true, payment reminder emails are sent automatically.",
- "type": "boolean"
- },
- "include_billing_info": {
- "description": "When true, `billing_name` and `billing_email` are included.",
- "type": "boolean"
- },
- "include_billing_workflow": {
- "description": "When true, enables a billing workflow after signing.",
- "type": "boolean"
- },
- "include_cc_users": {
- "description": "Whether to keep other people informed. Setting this to `false` removes every keep-informed (`cc`) user on the draft, and while it is `false` new `cc` roles are ignored.",
- "type": "boolean"
- },
- "include_expiration_date": {
- "description": "Expiration date in YYYY-MM-DD format. Use with `include_expiration_type` \"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": "Days until the agreement expires. Use with `include_expiration_type` \"days\".",
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_expiration_type": {
- "description": "How the agreement expires: \"none\" (default), \"days\" (use `include_expiration_days`), or \"date\" (use `include_expiration_date`).",
- "enum": [
- "none",
- "days",
- "date"
- ],
- "type": "string"
- },
- "include_message": {
- "description": "When true, `message` is sent with the agreement.",
- "type": "boolean"
- },
- "manual_send": {
- "description": "When true, the agreement is marked as sent outside the platform.",
- "type": "boolean"
- },
- "message": {
- "description": "The message sent to the recipient.",
- "type": "string"
- },
- "negotiations_allowed": {
- "description": "When true, the recipient can propose changes.",
- "type": "boolean"
- },
- "payment_link_url": {
- "description": "A payment URL shown to the recipient after signing. Requires `include_billing_workflow` and `billing_workflow_type` \"link\".",
- "type": "string"
- },
- "purpose": {
- "description": "The purpose of the agreement (NDA).",
- "type": "string"
- },
- "recipient_city": {
- "description": "The counterparty's city.",
- "type": "string"
- },
- "recipient_country": {
- "description": "The counterparty's country.",
- "type": "string"
- },
- "recipient_email": {
- "description": "The counterparty's email address.",
- "format": "email",
- "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
- "type": "string"
- },
- "recipient_name": {
- "description": "The counterparty's full 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-z]{2,}$",
- "type": "string"
- },
- "recipient_organization": {
- "description": "The counterparty's organization.",
- "type": "string"
- },
- "recipient_state": {
- "description": "The counterparty's state or region.",
- "type": "string"
- },
- "recipient_street_address": {
- "description": "The counterparty's street address.",
- "type": "string"
- },
- "recipient_title": {
- "description": "The counterparty's job title.",
- "type": "string"
- },
- "recipient_zip": {
- "description": "The counterparty's postal code.",
- "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 your organization.",
- "format": "email",
- "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
- "type": "string"
- },
- "subsidiary_id": {
- "description": "The UUID of the subsidiary sending the agreement. Send `null`, an empty string, or an id that no longer exists to clear it. Omit the key entirely to leave the current subsidiary alone."
- },
- "term": {
- "description": "The length of the agreement term in years (NDA).",
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "term_period_perpetual": {
- "description": "When true, the term runs perpetually and `term` is ignored (NDA).",
- "type": "boolean"
- },
- "test_agreement": {
- "description": "When true, marks the agreement as a test. Test agreements do not count against your monthly limit.",
- "type": "boolean"
- }
- },
- "type": "object"
- }
- },
- "required": [
- "agreement"
- ],
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Body for a draft whose `agreement_type` is `CSA`.",
- "properties": {
- "agreement": {}
- },
- "required": [
- "agreement"
- ],
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Body for a draft whose `agreement_type` is `DPA`.",
- "properties": {
- "agreement": {}
- },
- "required": [
- "agreement"
- ],
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Body for a draft whose `agreement_type` is `Design`. The agreement type is `Design` and the term it owns is `design_partner`.",
- "properties": {
- "agreement": {}
- },
- "required": [
- "agreement"
- ],
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Body for a draft whose `agreement_type` is `Pilot`.",
- "properties": {
- "agreement": {}
- },
- "required": [
- "agreement"
- ],
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Body for a draft whose `agreement_type` is `PSA`.",
- "properties": {
- "agreement": {}
- },
- "required": [
- "agreement"
- ],
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Body for a draft whose `agreement_type` is `Partnership`.",
- "properties": {
- "agreement": {}
- },
- "required": [
- "agreement"
- ],
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Body for a draft whose `agreement_type` is `BAA`.",
- "properties": {
- "agreement": {}
- },
- "required": [
- "agreement"
- ],
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Body for a draft whose `agreement_type` is `LOI`.",
- "properties": {
- "agreement": {}
- },
- "required": [
- "agreement"
- ],
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Body for a draft whose `agreement_type` is `Software License`.",
- "properties": {
- "agreement": {}
- },
- "required": [
- "agreement"
- ],
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Body for a draft whose `agreement_type` is `Amendment`.",
- "properties": {
- "agreement": {}
- },
- "required": [
- "agreement"
- ],
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Body for a draft created from a custom template. Drafts created from a custom template have no standard term object; their fields live in `custom_field_values`.",
- "properties": {
- "agreement": {}
- },
- "required": [
- "agreement"
- ],
- "type": "object"
- }
-]New value: +[
+ {
+ "additionalProperties": false,
+ "description": "Body for a draft whose `agreement_type` is `NDA`. NDA terms live directly on the agreement (`purpose`, `term`, `confidentiality_period`), so an NDA draft has no term object of its own.",
+ "properties": {
+ "agreement": {
+ "additionalProperties": {},
+ "description": "The cover page fields every draft accepts, whatever its agreement type. Omitted fields keep their current values.",
+ "properties": {
+ "additional_changes": {
+ "description": "Free-text changes shown on the cover page.",
+ "type": "string"
+ },
+ "agreement_roles_attributes": {
+ "description": "The keep-informed (`cc`) users on the draft. Requires `include_cc_users` to be `true`. Add a person by sending `role: \"cc\"` with `user_attributes.email` and no `id`. Remove one by sending its existing `id` with a blank `user_attributes.email`. People are identified by email only, so there is no way to cc someone by user id.",
+ "items": {
+ "additionalProperties": false,
+ "properties": {
+ "id": {
+ "description": "The UUID of an existing role. Omit when adding a new person.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "role": {
+ "description": "The role to manage. Only `cc` roles can be changed through this endpoint.",
+ "enum": [
+ "cc"
+ ],
+ "type": "string"
+ },
+ "user_attributes": {
+ "additionalProperties": false,
+ "description": "The person to cc. Send a blank `email` with an `id` to remove that person.",
+ "properties": {
+ "email": {
+ "anyOf": [
+ {},
+ {}
+ ]
+ }
+ },
+ "type": "object"
+ }
+ },
+ "required": [
+ "role"
+ ],
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "attachment_ids": {
+ "description": "The UUIDs of the attachments to include, from `POST /v1/attachments`. Replaces the current list.",
+ "items": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "billing_email": {
+ "description": "Email of the billing contact.",
+ "format": "email",
+ "pattern": "^(?!\\.)(?!.*\\.\\.)([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.",
+ "type": "string"
+ },
+ "billing_workflow_type": {
+ "description": "The type of billing workflow. Use \"link\" with `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"
+ },
+ "confidentiality_period": {
+ "description": "How many years confidentiality obligations last (NDA).",
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "confidentiality_period_perpetual": {
+ "description": "When true, confidentiality obligations are perpetual (NDA).",
+ "type": "boolean"
+ },
+ "default_signer_email": {
+ "description": "The email of the user in your organization who signs the agreement. Must belong to a user in your organization; changing it moves the signer role to that user. A signer outside your organization returns a 400.",
+ "format": "email",
+ "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "district_or_county": {
+ "description": "The district or county for dispute resolution.",
+ "type": "string"
+ },
+ "effective_date": {
+ "description": "The effective date, when set explicitly.",
+ "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_of_confidentiality": {
+ "description": "When confidentiality obligations begin (NDA).",
+ "type": "string"
+ },
+ "effective_date_type": {
+ "description": "How the effective date is determined.",
+ "type": "string"
+ },
+ "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\" with `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_additional_changes": {
+ "description": "When true, `additional_changes` is included on the cover page.",
+ "type": "boolean"
+ },
+ "include_automated_nudges": {
+ "description": "When true, reminder emails are sent automatically.",
+ "type": "boolean"
+ },
+ "include_automated_payment_reminders": {
+ "description": "When true, payment reminder emails are sent automatically.",
+ "type": "boolean"
+ },
+ "include_billing_info": {
+ "description": "When true, `billing_name` and `billing_email` are included.",
+ "type": "boolean"
+ },
+ "include_billing_workflow": {
+ "description": "When true, enables a billing workflow after signing.",
+ "type": "boolean"
+ },
+ "include_cc_users": {
+ "description": "Whether to keep other people informed. Setting this to `false` removes every keep-informed (`cc`) user on the draft, and while it is `false` new `cc` roles are ignored.",
+ "type": "boolean"
+ },
+ "include_expiration_date": {
+ "description": "Expiration date in YYYY-MM-DD format. Use with `include_expiration_type` \"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": "Days until the agreement expires. Use with `include_expiration_type` \"days\".",
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_expiration_type": {
+ "description": "How the agreement expires: \"none\" (default), \"days\" (use `include_expiration_days`), or \"date\" (use `include_expiration_date`).",
+ "enum": [
+ "none",
+ "days",
+ "date"
+ ],
+ "type": "string"
+ },
+ "include_message": {
+ "description": "When true, `message` is sent with the agreement.",
+ "type": "boolean"
+ },
+ "manual_send": {
+ "description": "When true, the agreement is marked as sent outside the platform.",
+ "type": "boolean"
+ },
+ "message": {
+ "description": "The message sent to the recipient.",
+ "type": "string"
+ },
+ "negotiations_allowed": {
+ "description": "When true, the recipient can propose changes.",
+ "type": "boolean"
+ },
+ "payment_link_url": {
+ "description": "A payment URL shown to the recipient after signing. Requires `include_billing_workflow` and `billing_workflow_type` \"link\".",
+ "type": "string"
+ },
+ "purpose": {
+ "description": "The purpose of the agreement (NDA).",
+ "type": "string"
+ },
+ "recipient_city": {
+ "description": "The counterparty's city.",
+ "type": "string"
+ },
+ "recipient_country": {
+ "description": "The counterparty's country.",
+ "type": "string"
+ },
+ "recipient_email": {
+ "description": "The counterparty's email address.",
+ "format": "email",
+ "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "recipient_name": {
+ "description": "The counterparty's full 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-z]{2,}$",
+ "type": "string"
+ },
+ "recipient_organization": {
+ "description": "The counterparty's organization.",
+ "type": "string"
+ },
+ "recipient_state": {
+ "description": "The counterparty's state or region.",
+ "type": "string"
+ },
+ "recipient_street_address": {
+ "description": "The counterparty's street address.",
+ "type": "string"
+ },
+ "recipient_title": {
+ "description": "The counterparty's job title.",
+ "type": "string"
+ },
+ "recipient_zip": {
+ "description": "The counterparty's postal code.",
+ "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 your organization.",
+ "format": "email",
+ "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "subsidiary_id": {
+ "description": "The UUID of the subsidiary sending the agreement. Send `null`, an empty string, or an id that no longer exists to clear it. Omit the key entirely to leave the current subsidiary alone."
+ },
+ "term": {
+ "description": "The length of the agreement term in years (NDA).",
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "term_period_perpetual": {
+ "description": "When true, the term runs perpetually and `term` is ignored (NDA).",
+ "type": "boolean"
+ },
+ "test_agreement": {
+ "description": "When true, marks the agreement as a test. Test agreements do not count against your monthly limit.",
+ "type": "boolean"
+ }
+ },
+ "type": "object"
+ }
+ },
+ "required": [
+ "agreement"
+ ],
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Body for a draft whose `agreement_type` is `CSA`.",
+ "properties": {
+ "agreement": {
+ "additionalProperties": {},
+ "description": "The cover page fields every draft accepts, whatever its agreement type. Omitted fields keep their current values.",
+ "properties": {
+ "additional_changes": {
+ "description": "Free-text changes shown on the cover page.",
+ "type": "string"
+ },
+ "agreement_roles_attributes": {
+ "description": "The keep-informed (`cc`) users on the draft. Requires `include_cc_users` to be `true`. Add a person by sending `role: \"cc\"` with `user_attributes.email` and no `id`. Remove one by sending its existing `id` with a blank `user_attributes.email`. People are identified by email only, so there is no way to cc someone by user id.",
+ "items": {
+ "additionalProperties": false,
+ "properties": {
+ "id": {
+ "description": "The UUID of an existing role. Omit when adding a new person.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "role": {
+ "description": "The role to manage. Only `cc` roles can be changed through this endpoint.",
+ "enum": [
+ "cc"
+ ],
+ "type": "string"
+ },
+ "user_attributes": {
+ "additionalProperties": false,
+ "description": "The person to cc. Send a blank `email` with an `id` to remove that person.",
+ "properties": {
+ "email": {
+ "anyOf": [
+ {},
+ {}
+ ]
+ }
+ },
+ "type": "object"
+ }
+ },
+ "required": [
+ "role"
+ ],
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "attachment_ids": {
+ "description": "The UUIDs of the attachments to include, from `POST /v1/attachments`. Replaces the current list.",
+ "items": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "billing_email": {
+ "description": "Email of the billing contact.",
+ "format": "email",
+ "pattern": "^(?!\\.)(?!.*\\.\\.)([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.",
+ "type": "string"
+ },
+ "billing_workflow_type": {
+ "description": "The type of billing workflow. Use \"link\" with `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"
+ },
+ "confidentiality_period": {
+ "description": "How many years confidentiality obligations last (NDA).",
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "confidentiality_period_perpetual": {
+ "description": "When true, confidentiality obligations are perpetual (NDA).",
+ "type": "boolean"
+ },
+ "default_signer_email": {
+ "description": "The email of the user in your organization who signs the agreement. Must belong to a user in your organization; changing it moves the signer role to that user. A signer outside your organization returns a 400.",
+ "format": "email",
+ "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "district_or_county": {
+ "description": "The district or county for dispute resolution.",
+ "type": "string"
+ },
+ "effective_date": {
+ "description": "The effective date, when set explicitly.",
+ "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_of_confidentiality": {
+ "description": "When confidentiality obligations begin (NDA).",
+ "type": "string"
+ },
+ "effective_date_type": {
+ "description": "How the effective date is determined.",
+ "type": "string"
+ },
+ "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\" with `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_additional_changes": {
+ "description": "When true, `additional_changes` is included on the cover page.",
+ "type": "boolean"
+ },
+ "include_automated_nudges": {
+ "description": "When true, reminder emails are sent automatically.",
+ "type": "boolean"
+ },
+ "include_automated_payment_reminders": {
+ "description": "When true, payment reminder emails are sent automatically.",
+ "type": "boolean"
+ },
+ "include_billing_info": {
+ "description": "When true, `billing_name` and `billing_email` are included.",
+ "type": "boolean"
+ },
+ "include_billing_workflow": {
+ "description": "When true, enables a billing workflow after signing.",
+ "type": "boolean"
+ },
+ "include_cc_users": {
+ "description": "Whether to keep other people informed. Setting this to `false` removes every keep-informed (`cc`) user on the draft, and while it is `false` new `cc` roles are ignored.",
+ "type": "boolean"
+ },
+ "include_expiration_date": {
+ "description": "Expiration date in YYYY-MM-DD format. Use with `include_expiration_type` \"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": "Days until the agreement expires. Use with `include_expiration_type` \"days\".",
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_expiration_type": {
+ "description": "How the agreement expires: \"none\" (default), \"days\" (use `include_expiration_days`), or \"date\" (use `include_expiration_date`).",
+ "enum": [
+ "none",
+ "days",
+ "date"
+ ],
+ "type": "string"
+ },
+ "include_message": {
+ "description": "When true, `message` is sent with the agreement.",
+ "type": "boolean"
+ },
+ "manual_send": {
+ "description": "When true, the agreement is marked as sent outside the platform.",
+ "type": "boolean"
+ },
+ "message": {
+ "description": "The message sent to the recipient.",
+ "type": "string"
+ },
+ "negotiations_allowed": {
+ "description": "When true, the recipient can propose changes.",
+ "type": "boolean"
+ },
+ "payment_link_url": {
+ "description": "A payment URL shown to the recipient after signing. Requires `include_billing_workflow` and `billing_workflow_type` \"link\".",
+ "type": "string"
+ },
+ "purpose": {
+ "description": "The purpose of the agreement (NDA).",
+ "type": "string"
+ },
+ "recipient_city": {
+ "description": "The counterparty's city.",
+ "type": "string"
+ },
+ "recipient_country": {
+ "description": "The counterparty's country.",
+ "type": "string"
+ },
+ "recipient_email": {
+ "description": "The counterparty's email address.",
+ "format": "email",
+ "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "recipient_name": {
+ "description": "The counterparty's full 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-z]{2,}$",
+ "type": "string"
+ },
+ "recipient_organization": {
+ "description": "The counterparty's organization.",
+ "type": "string"
+ },
+ "recipient_state": {
+ "description": "The counterparty's state or region.",
+ "type": "string"
+ },
+ "recipient_street_address": {
+ "description": "The counterparty's street address.",
+ "type": "string"
+ },
+ "recipient_title": {
+ "description": "The counterparty's job title.",
+ "type": "string"
+ },
+ "recipient_zip": {
+ "description": "The counterparty's postal code.",
+ "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 your organization.",
+ "format": "email",
+ "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "subsidiary_id": {
+ "description": "The UUID of the subsidiary sending the agreement. Send `null`, an empty string, or an id that no longer exists to clear it. Omit the key entirely to leave the current subsidiary alone."
+ },
+ "term": {
+ "description": "The length of the agreement term in years (NDA).",
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "term_period_perpetual": {
+ "description": "When true, the term runs perpetually and `term` is ignored (NDA).",
+ "type": "boolean"
+ },
+ "test_agreement": {
+ "description": "When true, marks the agreement as a test. Test agreements do not count against your monthly limit.",
+ "type": "boolean"
+ }
+ },
+ "type": "object"
+ }
+ },
+ "required": [
+ "agreement"
+ ],
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Body for a draft whose `agreement_type` is `DPA`.",
+ "properties": {
+ "agreement": {
+ "additionalProperties": {},
+ "description": "The cover page fields every draft accepts, whatever its agreement type. Omitted fields keep their current values.",
+ "properties": {
+ "additional_changes": {
+ "description": "Free-text changes shown on the cover page.",
+ "type": "string"
+ },
+ "agreement_roles_attributes": {
+ "description": "The keep-informed (`cc`) users on the draft. Requires `include_cc_users` to be `true`. Add a person by sending `role: \"cc\"` with `user_attributes.email` and no `id`. Remove one by sending its existing `id` with a blank `user_attributes.email`. People are identified by email only, so there is no way to cc someone by user id.",
+ "items": {
+ "additionalProperties": false,
+ "properties": {
+ "id": {
+ "description": "The UUID of an existing role. Omit when adding a new person.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "role": {
+ "description": "The role to manage. Only `cc` roles can be changed through this endpoint.",
+ "enum": [
+ "cc"
+ ],
+ "type": "string"
+ },
+ "user_attributes": {
+ "additionalProperties": false,
+ "description": "The person to cc. Send a blank `email` with an `id` to remove that person.",
+ "properties": {
+ "email": {
+ "anyOf": [
+ {},
+ {}
+ ]
+ }
+ },
+ "type": "object"
+ }
+ },
+ "required": [
+ "role"
+ ],
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "attachment_ids": {
+ "description": "The UUIDs of the attachments to include, from `POST /v1/attachments`. Replaces the current list.",
+ "items": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "billing_email": {
+ "description": "Email of the billing contact.",
+ "format": "email",
+ "pattern": "^(?!\\.)(?!.*\\.\\.)([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.",
+ "type": "string"
+ },
+ "billing_workflow_type": {
+ "description": "The type of billing workflow. Use \"link\" with `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"
+ },
+ "confidentiality_period": {
+ "description": "How many years confidentiality obligations last (NDA).",
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "confidentiality_period_perpetual": {
+ "description": "When true, confidentiality obligations are perpetual (NDA).",
+ "type": "boolean"
+ },
+ "default_signer_email": {
+ "description": "The email of the user in your organization who signs the agreement. Must belong to a user in your organization; changing it moves the signer role to that user. A signer outside your organization returns a 400.",
+ "format": "email",
+ "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "district_or_county": {
+ "description": "The district or county for dispute resolution.",
+ "type": "string"
+ },
+ "effective_date": {
+ "description": "The effective date, when set explicitly.",
+ "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_of_confidentiality": {
+ "description": "When confidentiality obligations begin (NDA).",
+ "type": "string"
+ },
+ "effective_date_type": {
+ "description": "How the effective date is determined.",
+ "type": "string"
+ },
+ "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\" with `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_additional_changes": {
+ "description": "When true, `additional_changes` is included on the cover page.",
+ "type": "boolean"
+ },
+ "include_automated_nudges": {
+ "description": "When true, reminder emails are sent automatically.",
+ "type": "boolean"
+ },
+ "include_automated_payment_reminders": {
+ "description": "When true, payment reminder emails are sent automatically.",
+ "type": "boolean"
+ },
+ "include_billing_info": {
+ "description": "When true, `billing_name` and `billing_email` are included.",
+ "type": "boolean"
+ },
+ "include_billing_workflow": {
+ "description": "When true, enables a billing workflow after signing.",
+ "type": "boolean"
+ },
+ "include_cc_users": {
+ "description": "Whether to keep other people informed. Setting this to `false` removes every keep-informed (`cc`) user on the draft, and while it is `false` new `cc` roles are ignored.",
+ "type": "boolean"
+ },
+ "include_expiration_date": {
+ "description": "Expiration date in YYYY-MM-DD format. Use with `include_expiration_type` \"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": "Days until the agreement expires. Use with `include_expiration_type` \"days\".",
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_expiration_type": {
+ "description": "How the agreement expires: \"none\" (default), \"days\" (use `include_expiration_days`), or \"date\" (use `include_expiration_date`).",
+ "enum": [
+ "none",
+ "days",
+ "date"
+ ],
+ "type": "string"
+ },
+ "include_message": {
+ "description": "When true, `message` is sent with the agreement.",
+ "type": "boolean"
+ },
+ "manual_send": {
+ "description": "When true, the agreement is marked as sent outside the platform.",
+ "type": "boolean"
+ },
+ "message": {
+ "description": "The message sent to the recipient.",
+ "type": "string"
+ },
+ "negotiations_allowed": {
+ "description": "When true, the recipient can propose changes.",
+ "type": "boolean"
+ },
+ "payment_link_url": {
+ "description": "A payment URL shown to the recipient after signing. Requires `include_billing_workflow` and `billing_workflow_type` \"link\".",
+ "type": "string"
+ },
+ "purpose": {
+ "description": "The purpose of the agreement (NDA).",
+ "type": "string"
+ },
+ "recipient_city": {
+ "description": "The counterparty's city.",
+ "type": "string"
+ },
+ "recipient_country": {
+ "description": "The counterparty's country.",
+ "type": "string"
+ },
+ "recipient_email": {
+ "description": "The counterparty's email address.",
+ "format": "email",
+ "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "recipient_name": {
+ "description": "The counterparty's full 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-z]{2,}$",
+ "type": "string"
+ },
+ "recipient_organization": {
+ "description": "The counterparty's organization.",
+ "type": "string"
+ },
+ "recipient_state": {
+ "description": "The counterparty's state or region.",
+ "type": "string"
+ },
+ "recipient_street_address": {
+ "description": "The counterparty's street address.",
+ "type": "string"
+ },
+ "recipient_title": {
+ "description": "The counterparty's job title.",
+ "type": "string"
+ },
+ "recipient_zip": {
+ "description": "The counterparty's postal code.",
+ "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 your organization.",
+ "format": "email",
+ "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "subsidiary_id": {
+ "description": "The UUID of the subsidiary sending the agreement. Send `null`, an empty string, or an id that no longer exists to clear it. Omit the key entirely to leave the current subsidiary alone."
+ },
+ "term": {
+ "description": "The length of the agreement term in years (NDA).",
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "term_period_perpetual": {
+ "description": "When true, the term runs perpetually and `term` is ignored (NDA).",
+ "type": "boolean"
+ },
+ "test_agreement": {
+ "description": "When true, marks the agreement as a test. Test agreements do not count against your monthly limit.",
+ "type": "boolean"
+ }
+ },
+ "type": "object"
+ }
+ },
+ "required": [
+ "agreement"
+ ],
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Body for a draft whose `agreement_type` is `Design`. The agreement type is `Design` and the term it owns is `design_partner`.",
+ "properties": {
+ "agreement": {
+ "additionalProperties": {},
+ "description": "The cover page fields every draft accepts, whatever its agreement type. Omitted fields keep their current values.",
+ "properties": {
+ "additional_changes": {
+ "description": "Free-text changes shown on the cover page.",
+ "type": "string"
+ },
+ "agreement_roles_attributes": {
+ "description": "The keep-informed (`cc`) users on the draft. Requires `include_cc_users` to be `true`. Add a person by sending `role: \"cc\"` with `user_attributes.email` and no `id`. Remove one by sending its existing `id` with a blank `user_attributes.email`. People are identified by email only, so there is no way to cc someone by user id.",
+ "items": {
+ "additionalProperties": false,
+ "properties": {
+ "id": {
+ "description": "The UUID of an existing role. Omit when adding a new person.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "role": {
+ "description": "The role to manage. Only `cc` roles can be changed through this endpoint.",
+ "enum": [
+ "cc"
+ ],
+ "type": "string"
+ },
+ "user_attributes": {
+ "additionalProperties": false,
+ "description": "The person to cc. Send a blank `email` with an `id` to remove that person.",
+ "properties": {
+ "email": {
+ "anyOf": [
+ {},
+ {}
+ ]
+ }
+ },
+ "type": "object"
+ }
+ },
+ "required": [
+ "role"
+ ],
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "attachment_ids": {
+ "description": "The UUIDs of the attachments to include, from `POST /v1/attachments`. Replaces the current list.",
+ "items": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "billing_email": {
+ "description": "Email of the billing contact.",
+ "format": "email",
+ "pattern": "^(?!\\.)(?!.*\\.\\.)([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.",
+ "type": "string"
+ },
+ "billing_workflow_type": {
+ "description": "The type of billing workflow. Use \"link\" with `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"
+ },
+ "confidentiality_period": {
+ "description": "How many years confidentiality obligations last (NDA).",
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "confidentiality_period_perpetual": {
+ "description": "When true, confidentiality obligations are perpetual (NDA).",
+ "type": "boolean"
+ },
+ "default_signer_email": {
+ "description": "The email of the user in your organization who signs the agreement. Must belong to a user in your organization; changing it moves the signer role to that user. A signer outside your organization returns a 400.",
+ "format": "email",
+ "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "district_or_county": {
+ "description": "The district or county for dispute resolution.",
+ "type": "string"
+ },
+ "effective_date": {
+ "description": "The effective date, when set explicitly.",
+ "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_of_confidentiality": {
+ "description": "When confidentiality obligations begin (NDA).",
+ "type": "string"
+ },
+ "effective_date_type": {
+ "description": "How the effective date is determined.",
+ "type": "string"
+ },
+ "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\" with `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_additional_changes": {
+ "description": "When true, `additional_changes` is included on the cover page.",
+ "type": "boolean"
+ },
+ "include_automated_nudges": {
+ "description": "When true, reminder emails are sent automatically.",
+ "type": "boolean"
+ },
+ "include_automated_payment_reminders": {
+ "description": "When true, payment reminder emails are sent automatically.",
+ "type": "boolean"
+ },
+ "include_billing_info": {
+ "description": "When true, `billing_name` and `billing_email` are included.",
+ "type": "boolean"
+ },
+ "include_billing_workflow": {
+ "description": "When true, enables a billing workflow after signing.",
+ "type": "boolean"
+ },
+ "include_cc_users": {
+ "description": "Whether to keep other people informed. Setting this to `false` removes every keep-informed (`cc`) user on the draft, and while it is `false` new `cc` roles are ignored.",
+ "type": "boolean"
+ },
+ "include_expiration_date": {
+ "description": "Expiration date in YYYY-MM-DD format. Use with `include_expiration_type` \"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": "Days until the agreement expires. Use with `include_expiration_type` \"days\".",
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_expiration_type": {
+ "description": "How the agreement expires: \"none\" (default), \"days\" (use `include_expiration_days`), or \"date\" (use `include_expiration_date`).",
+ "enum": [
+ "none",
+ "days",
+ "date"
+ ],
+ "type": "string"
+ },
+ "include_message": {
+ "description": "When true, `message` is sent with the agreement.",
+ "type": "boolean"
+ },
+ "manual_send": {
+ "description": "When true, the agreement is marked as sent outside the platform.",
+ "type": "boolean"
+ },
+ "message": {
+ "description": "The message sent to the recipient.",
+ "type": "string"
+ },
+ "negotiations_allowed": {
+ "description": "When true, the recipient can propose changes.",
+ "type": "boolean"
+ },
+ "payment_link_url": {
+ "description": "A payment URL shown to the recipient after signing. Requires `include_billing_workflow` and `billing_workflow_type` \"link\".",
+ "type": "string"
+ },
+ "purpose": {
+ "description": "The purpose of the agreement (NDA).",
+ "type": "string"
+ },
+ "recipient_city": {
+ "description": "The counterparty's city.",
+ "type": "string"
+ },
+ "recipient_country": {
+ "description": "The counterparty's country.",
+ "type": "string"
+ },
+ "recipient_email": {
+ "description": "The counterparty's email address.",
+ "format": "email",
+ "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "recipient_name": {
+ "description": "The counterparty's full 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-z]{2,}$",
+ "type": "string"
+ },
+ "recipient_organization": {
+ "description": "The counterparty's organization.",
+ "type": "string"
+ },
+ "recipient_state": {
+ "description": "The counterparty's state or region.",
+ "type": "string"
+ },
+ "recipient_street_address": {
+ "description": "The counterparty's street address.",
+ "type": "string"
+ },
+ "recipient_title": {
+ "description": "The counterparty's job title.",
+ "type": "string"
+ },
+ "recipient_zip": {
+ "description": "The counterparty's postal code.",
+ "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 your organization.",
+ "format": "email",
+ "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "subsidiary_id": {
+ "description": "The UUID of the subsidiary sending the agreement. Send `null`, an empty string, or an id that no longer exists to clear it. Omit the key entirely to leave the current subsidiary alone."
+ },
+ "term": {
+ "description": "The length of the agreement term in years (NDA).",
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "term_period_perpetual": {
+ "description": "When true, the term runs perpetually and `term` is ignored (NDA).",
+ "type": "boolean"
+ },
+ "test_agreement": {
+ "description": "When true, marks the agreement as a test. Test agreements do not count against your monthly limit.",
+ "type": "boolean"
+ }
+ },
+ "type": "object"
+ }
+ },
+ "required": [
+ "agreement"
+ ],
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Body for a draft whose `agreement_type` is `Pilot`.",
+ "properties": {
+ "agreement": {
+ "additionalProperties": {},
+ "description": "The cover page fields every draft accepts, whatever its agreement type. Omitted fields keep their current values.",
+ "properties": {
+ "additional_changes": {
+ "description": "Free-text changes shown on the cover page.",
+ "type": "string"
+ },
+ "agreement_roles_attributes": {
+ "description": "The keep-informed (`cc`) users on the draft. Requires `include_cc_users` to be `true`. Add a person by sending `role: \"cc\"` with `user_attributes.email` and no `id`. Remove one by sending its existing `id` with a blank `user_attributes.email`. People are identified by email only, so there is no way to cc someone by user id.",
+ "items": {
+ "additionalProperties": false,
+ "properties": {
+ "id": {
+ "description": "The UUID of an existing role. Omit when adding a new person.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "role": {
+ "description": "The role to manage. Only `cc` roles can be changed through this endpoint.",
+ "enum": [
+ "cc"
+ ],
+ "type": "string"
+ },
+ "user_attributes": {
+ "additionalProperties": false,
+ "description": "The person to cc. Send a blank `email` with an `id` to remove that person.",
+ "properties": {
+ "email": {
+ "anyOf": [
+ {},
+ {}
+ ]
+ }
+ },
+ "type": "object"
+ }
+ },
+ "required": [
+ "role"
+ ],
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "attachment_ids": {
+ "description": "The UUIDs of the attachments to include, from `POST /v1/attachments`. Replaces the current list.",
+ "items": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "billing_email": {
+ "description": "Email of the billing contact.",
+ "format": "email",
+ "pattern": "^(?!\\.)(?!.*\\.\\.)([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.",
+ "type": "string"
+ },
+ "billing_workflow_type": {
+ "description": "The type of billing workflow. Use \"link\" with `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"
+ },
+ "confidentiality_period": {
+ "description": "How many years confidentiality obligations last (NDA).",
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "confidentiality_period_perpetual": {
+ "description": "When true, confidentiality obligations are perpetual (NDA).",
+ "type": "boolean"
+ },
+ "default_signer_email": {
+ "description": "The email of the user in your organization who signs the agreement. Must belong to a user in your organization; changing it moves the signer role to that user. A signer outside your organization returns a 400.",
+ "format": "email",
+ "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "district_or_county": {
+ "description": "The district or county for dispute resolution.",
+ "type": "string"
+ },
+ "effective_date": {
+ "description": "The effective date, when set explicitly.",
+ "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_of_confidentiality": {
+ "description": "When confidentiality obligations begin (NDA).",
+ "type": "string"
+ },
+ "effective_date_type": {
+ "description": "How the effective date is determined.",
+ "type": "string"
+ },
+ "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\" with `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_additional_changes": {
+ "description": "When true, `additional_changes` is included on the cover page.",
+ "type": "boolean"
+ },
+ "include_automated_nudges": {
+ "description": "When true, reminder emails are sent automatically.",
+ "type": "boolean"
+ },
+ "include_automated_payment_reminders": {
+ "description": "When true, payment reminder emails are sent automatically.",
+ "type": "boolean"
+ },
+ "include_billing_info": {
+ "description": "When true, `billing_name` and `billing_email` are included.",
+ "type": "boolean"
+ },
+ "include_billing_workflow": {
+ "description": "When true, enables a billing workflow after signing.",
+ "type": "boolean"
+ },
+ "include_cc_users": {
+ "description": "Whether to keep other people informed. Setting this to `false` removes every keep-informed (`cc`) user on the draft, and while it is `false` new `cc` roles are ignored.",
+ "type": "boolean"
+ },
+ "include_expiration_date": {
+ "description": "Expiration date in YYYY-MM-DD format. Use with `include_expiration_type` \"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": "Days until the agreement expires. Use with `include_expiration_type` \"days\".",
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_expiration_type": {
+ "description": "How the agreement expires: \"none\" (default), \"days\" (use `include_expiration_days`), or \"date\" (use `include_expiration_date`).",
+ "enum": [
+ "none",
+ "days",
+ "date"
+ ],
+ "type": "string"
+ },
+ "include_message": {
+ "description": "When true, `message` is sent with the agreement.",
+ "type": "boolean"
+ },
+ "manual_send": {
+ "description": "When true, the agreement is marked as sent outside the platform.",
+ "type": "boolean"
+ },
+ "message": {
+ "description": "The message sent to the recipient.",
+ "type": "string"
+ },
+ "negotiations_allowed": {
+ "description": "When true, the recipient can propose changes.",
+ "type": "boolean"
+ },
+ "payment_link_url": {
+ "description": "A payment URL shown to the recipient after signing. Requires `include_billing_workflow` and `billing_workflow_type` \"link\".",
+ "type": "string"
+ },
+ "purpose": {
+ "description": "The purpose of the agreement (NDA).",
+ "type": "string"
+ },
+ "recipient_city": {
+ "description": "The counterparty's city.",
+ "type": "string"
+ },
+ "recipient_country": {
+ "description": "The counterparty's country.",
+ "type": "string"
+ },
+ "recipient_email": {
+ "description": "The counterparty's email address.",
+ "format": "email",
+ "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "recipient_name": {
+ "description": "The counterparty's full 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-z]{2,}$",
+ "type": "string"
+ },
+ "recipient_organization": {
+ "description": "The counterparty's organization.",
+ "type": "string"
+ },
+ "recipient_state": {
+ "description": "The counterparty's state or region.",
+ "type": "string"
+ },
+ "recipient_street_address": {
+ "description": "The counterparty's street address.",
+ "type": "string"
+ },
+ "recipient_title": {
+ "description": "The counterparty's job title.",
+ "type": "string"
+ },
+ "recipient_zip": {
+ "description": "The counterparty's postal code.",
+ "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 your organization.",
+ "format": "email",
+ "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "subsidiary_id": {
+ "description": "The UUID of the subsidiary sending the agreement. Send `null`, an empty string, or an id that no longer exists to clear it. Omit the key entirely to leave the current subsidiary alone."
+ },
+ "term": {
+ "description": "The length of the agreement term in years (NDA).",
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "term_period_perpetual": {
+ "description": "When true, the term runs perpetually and `term` is ignored (NDA).",
+ "type": "boolean"
+ },
+ "test_agreement": {
+ "description": "When true, marks the agreement as a test. Test agreements do not count against your monthly limit.",
+ "type": "boolean"
+ }
+ },
+ "type": "object"
+ }
+ },
+ "required": [
+ "agreement"
+ ],
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Body for a draft whose `agreement_type` is `PSA`.",
+ "properties": {
+ "agreement": {
+ "additionalProperties": {},
+ "description": "The cover page fields every draft accepts, whatever its agreement type. Omitted fields keep their current values.",
+ "properties": {
+ "additional_changes": {
+ "description": "Free-text changes shown on the cover page.",
+ "type": "string"
+ },
+ "agreement_roles_attributes": {
+ "description": "The keep-informed (`cc`) users on the draft. Requires `include_cc_users` to be `true`. Add a person by sending `role: \"cc\"` with `user_attributes.email` and no `id`. Remove one by sending its existing `id` with a blank `user_attributes.email`. People are identified by email only, so there is no way to cc someone by user id.",
+ "items": {
+ "additionalProperties": false,
+ "properties": {
+ "id": {
+ "description": "The UUID of an existing role. Omit when adding a new person.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "role": {
+ "description": "The role to manage. Only `cc` roles can be changed through this endpoint.",
+ "enum": [
+ "cc"
+ ],
+ "type": "string"
+ },
+ "user_attributes": {
+ "additionalProperties": false,
+ "description": "The person to cc. Send a blank `email` with an `id` to remove that person.",
+ "properties": {
+ "email": {
+ "anyOf": [
+ {},
+ {}
+ ]
+ }
+ },
+ "type": "object"
+ }
+ },
+ "required": [
+ "role"
+ ],
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "attachment_ids": {
+ "description": "The UUIDs of the attachments to include, from `POST /v1/attachments`. Replaces the current list.",
+ "items": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "billing_email": {
+ "description": "Email of the billing contact.",
+ "format": "email",
+ "pattern": "^(?!\\.)(?!.*\\.\\.)([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.",
+ "type": "string"
+ },
+ "billing_workflow_type": {
+ "description": "The type of billing workflow. Use \"link\" with `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"
+ },
+ "confidentiality_period": {
+ "description": "How many years confidentiality obligations last (NDA).",
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "confidentiality_period_perpetual": {
+ "description": "When true, confidentiality obligations are perpetual (NDA).",
+ "type": "boolean"
+ },
+ "default_signer_email": {
+ "description": "The email of the user in your organization who signs the agreement. Must belong to a user in your organization; changing it moves the signer role to that user. A signer outside your organization returns a 400.",
+ "format": "email",
+ "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "district_or_county": {
+ "description": "The district or county for dispute resolution.",
+ "type": "string"
+ },
+ "effective_date": {
+ "description": "The effective date, when set explicitly.",
+ "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_of_confidentiality": {
+ "description": "When confidentiality obligations begin (NDA).",
+ "type": "string"
+ },
+ "effective_date_type": {
+ "description": "How the effective date is determined.",
+ "type": "string"
+ },
+ "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\" with `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_additional_changes": {
+ "description": "When true, `additional_changes` is included on the cover page.",
+ "type": "boolean"
+ },
+ "include_automated_nudges": {
+ "description": "When true, reminder emails are sent automatically.",
+ "type": "boolean"
+ },
+ "include_automated_payment_reminders": {
+ "description": "When true, payment reminder emails are sent automatically.",
+ "type": "boolean"
+ },
+ "include_billing_info": {
+ "description": "When true, `billing_name` and `billing_email` are included.",
+ "type": "boolean"
+ },
+ "include_billing_workflow": {
+ "description": "When true, enables a billing workflow after signing.",
+ "type": "boolean"
+ },
+ "include_cc_users": {
+ "description": "Whether to keep other people informed. Setting this to `false` removes every keep-informed (`cc`) user on the draft, and while it is `false` new `cc` roles are ignored.",
+ "type": "boolean"
+ },
+ "include_expiration_date": {
+ "description": "Expiration date in YYYY-MM-DD format. Use with `include_expiration_type` \"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": "Days until the agreement expires. Use with `include_expiration_type` \"days\".",
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_expiration_type": {
+ "description": "How the agreement expires: \"none\" (default), \"days\" (use `include_expiration_days`), or \"date\" (use `include_expiration_date`).",
+ "enum": [
+ "none",
+ "days",
+ "date"
+ ],
+ "type": "string"
+ },
+ "include_message": {
+ "description": "When true, `message` is sent with the agreement.",
+ "type": "boolean"
+ },
+ "manual_send": {
+ "description": "When true, the agreement is marked as sent outside the platform.",
+ "type": "boolean"
+ },
+ "message": {
+ "description": "The message sent to the recipient.",
+ "type": "string"
+ },
+ "negotiations_allowed": {
+ "description": "When true, the recipient can propose changes.",
+ "type": "boolean"
+ },
+ "payment_link_url": {
+ "description": "A payment URL shown to the recipient after signing. Requires `include_billing_workflow` and `billing_workflow_type` \"link\".",
+ "type": "string"
+ },
+ "purpose": {
+ "description": "The purpose of the agreement (NDA).",
+ "type": "string"
+ },
+ "recipient_city": {
+ "description": "The counterparty's city.",
+ "type": "string"
+ },
+ "recipient_country": {
+ "description": "The counterparty's country.",
+ "type": "string"
+ },
+ "recipient_email": {
+ "description": "The counterparty's email address.",
+ "format": "email",
+ "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "recipient_name": {
+ "description": "The counterparty's full 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-z]{2,}$",
+ "type": "string"
+ },
+ "recipient_organization": {
+ "description": "The counterparty's organization.",
+ "type": "string"
+ },
+ "recipient_state": {
+ "description": "The counterparty's state or region.",
+ "type": "string"
+ },
+ "recipient_street_address": {
+ "description": "The counterparty's street address.",
+ "type": "string"
+ },
+ "recipient_title": {
+ "description": "The counterparty's job title.",
+ "type": "string"
+ },
+ "recipient_zip": {
+ "description": "The counterparty's postal code.",
+ "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 your organization.",
+ "format": "email",
+ "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "subsidiary_id": {
+ "description": "The UUID of the subsidiary sending the agreement. Send `null`, an empty string, or an id that no longer exists to clear it. Omit the key entirely to leave the current subsidiary alone."
+ },
+ "term": {
+ "description": "The length of the agreement term in years (NDA).",
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "term_period_perpetual": {
+ "description": "When true, the term runs perpetually and `term` is ignored (NDA).",
+ "type": "boolean"
+ },
+ "test_agreement": {
+ "description": "When true, marks the agreement as a test. Test agreements do not count against your monthly limit.",
+ "type": "boolean"
+ }
+ },
+ "type": "object"
+ }
+ },
+ "required": [
+ "agreement"
+ ],
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Body for a draft whose `agreement_type` is `Partnership`.",
+ "properties": {
+ "agreement": {
+ "additionalProperties": {},
+ "description": "The cover page fields every draft accepts, whatever its agreement type. Omitted fields keep their current values.",
+ "properties": {
+ "additional_changes": {
+ "description": "Free-text changes shown on the cover page.",
+ "type": "string"
+ },
+ "agreement_roles_attributes": {
+ "description": "The keep-informed (`cc`) users on the draft. Requires `include_cc_users` to be `true`. Add a person by sending `role: \"cc\"` with `user_attributes.email` and no `id`. Remove one by sending its existing `id` with a blank `user_attributes.email`. People are identified by email only, so there is no way to cc someone by user id.",
+ "items": {
+ "additionalProperties": false,
+ "properties": {
+ "id": {
+ "description": "The UUID of an existing role. Omit when adding a new person.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "role": {
+ "description": "The role to manage. Only `cc` roles can be changed through this endpoint.",
+ "enum": [
+ "cc"
+ ],
+ "type": "string"
+ },
+ "user_attributes": {
+ "additionalProperties": false,
+ "description": "The person to cc. Send a blank `email` with an `id` to remove that person.",
+ "properties": {
+ "email": {
+ "anyOf": [
+ {},
+ {}
+ ]
+ }
+ },
+ "type": "object"
+ }
+ },
+ "required": [
+ "role"
+ ],
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "attachment_ids": {
+ "description": "The UUIDs of the attachments to include, from `POST /v1/attachments`. Replaces the current list.",
+ "items": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "billing_email": {
+ "description": "Email of the billing contact.",
+ "format": "email",
+ "pattern": "^(?!\\.)(?!.*\\.\\.)([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.",
+ "type": "string"
+ },
+ "billing_workflow_type": {
+ "description": "The type of billing workflow. Use \"link\" with `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"
+ },
+ "confidentiality_period": {
+ "description": "How many years confidentiality obligations last (NDA).",
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "confidentiality_period_perpetual": {
+ "description": "When true, confidentiality obligations are perpetual (NDA).",
+ "type": "boolean"
+ },
+ "default_signer_email": {
+ "description": "The email of the user in your organization who signs the agreement. Must belong to a user in your organization; changing it moves the signer role to that user. A signer outside your organization returns a 400.",
+ "format": "email",
+ "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "district_or_county": {
+ "description": "The district or county for dispute resolution.",
+ "type": "string"
+ },
+ "effective_date": {
+ "description": "The effective date, when set explicitly.",
+ "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_of_confidentiality": {
+ "description": "When confidentiality obligations begin (NDA).",
+ "type": "string"
+ },
+ "effective_date_type": {
+ "description": "How the effective date is determined.",
+ "type": "string"
+ },
+ "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\" with `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_additional_changes": {
+ "description": "When true, `additional_changes` is included on the cover page.",
+ "type": "boolean"
+ },
+ "include_automated_nudges": {
+ "description": "When true, reminder emails are sent automatically.",
+ "type": "boolean"
+ },
+ "include_automated_payment_reminders": {
+ "description": "When true, payment reminder emails are sent automatically.",
+ "type": "boolean"
+ },
+ "include_billing_info": {
+ "description": "When true, `billing_name` and `billing_email` are included.",
+ "type": "boolean"
+ },
+ "include_billing_workflow": {
+ "description": "When true, enables a billing workflow after signing.",
+ "type": "boolean"
+ },
+ "include_cc_users": {
+ "description": "Whether to keep other people informed. Setting this to `false` removes every keep-informed (`cc`) user on the draft, and while it is `false` new `cc` roles are ignored.",
+ "type": "boolean"
+ },
+ "include_expiration_date": {
+ "description": "Expiration date in YYYY-MM-DD format. Use with `include_expiration_type` \"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": "Days until the agreement expires. Use with `include_expiration_type` \"days\".",
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_expiration_type": {
+ "description": "How the agreement expires: \"none\" (default), \"days\" (use `include_expiration_days`), or \"date\" (use `include_expiration_date`).",
+ "enum": [
+ "none",
+ "days",
+ "date"
+ ],
+ "type": "string"
+ },
+ "include_message": {
+ "description": "When true, `message` is sent with the agreement.",
+ "type": "boolean"
+ },
+ "manual_send": {
+ "description": "When true, the agreement is marked as sent outside the platform.",
+ "type": "boolean"
+ },
+ "message": {
+ "description": "The message sent to the recipient.",
+ "type": "string"
+ },
+ "negotiations_allowed": {
+ "description": "When true, the recipient can propose changes.",
+ "type": "boolean"
+ },
+ "payment_link_url": {
+ "description": "A payment URL shown to the recipient after signing. Requires `include_billing_workflow` and `billing_workflow_type` \"link\".",
+ "type": "string"
+ },
+ "purpose": {
+ "description": "The purpose of the agreement (NDA).",
+ "type": "string"
+ },
+ "recipient_city": {
+ "description": "The counterparty's city.",
+ "type": "string"
+ },
+ "recipient_country": {
+ "description": "The counterparty's country.",
+ "type": "string"
+ },
+ "recipient_email": {
+ "description": "The counterparty's email address.",
+ "format": "email",
+ "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "recipient_name": {
+ "description": "The counterparty's full 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-z]{2,}$",
+ "type": "string"
+ },
+ "recipient_organization": {
+ "description": "The counterparty's organization.",
+ "type": "string"
+ },
+ "recipient_state": {
+ "description": "The counterparty's state or region.",
+ "type": "string"
+ },
+ "recipient_street_address": {
+ "description": "The counterparty's street address.",
+ "type": "string"
+ },
+ "recipient_title": {
+ "description": "The counterparty's job title.",
+ "type": "string"
+ },
+ "recipient_zip": {
+ "description": "The counterparty's postal code.",
+ "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 your organization.",
+ "format": "email",
+ "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "subsidiary_id": {
+ "description": "The UUID of the subsidiary sending the agreement. Send `null`, an empty string, or an id that no longer exists to clear it. Omit the key entirely to leave the current subsidiary alone."
+ },
+ "term": {
+ "description": "The length of the agreement term in years (NDA).",
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "term_period_perpetual": {
+ "description": "When true, the term runs perpetually and `term` is ignored (NDA).",
+ "type": "boolean"
+ },
+ "test_agreement": {
+ "description": "When true, marks the agreement as a test. Test agreements do not count against your monthly limit.",
+ "type": "boolean"
+ }
+ },
+ "type": "object"
+ }
+ },
+ "required": [
+ "agreement"
+ ],
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Body for a draft whose `agreement_type` is `BAA`.",
+ "properties": {
+ "agreement": {
+ "additionalProperties": {},
+ "description": "The cover page fields every draft accepts, whatever its agreement type. Omitted fields keep their current values.",
+ "properties": {
+ "additional_changes": {
+ "description": "Free-text changes shown on the cover page.",
+ "type": "string"
+ },
+ "agreement_roles_attributes": {
+ "description": "The keep-informed (`cc`) users on the draft. Requires `include_cc_users` to be `true`. Add a person by sending `role: \"cc\"` with `user_attributes.email` and no `id`. Remove one by sending its existing `id` with a blank `user_attributes.email`. People are identified by email only, so there is no way to cc someone by user id.",
+ "items": {
+ "additionalProperties": false,
+ "properties": {
+ "id": {
+ "description": "The UUID of an existing role. Omit when adding a new person.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "role": {
+ "description": "The role to manage. Only `cc` roles can be changed through this endpoint.",
+ "enum": [
+ "cc"
+ ],
+ "type": "string"
+ },
+ "user_attributes": {
+ "additionalProperties": false,
+ "description": "The person to cc. Send a blank `email` with an `id` to remove that person.",
+ "properties": {
+ "email": {
+ "anyOf": [
+ {},
+ {}
+ ]
+ }
+ },
+ "type": "object"
+ }
+ },
+ "required": [
+ "role"
+ ],
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "attachment_ids": {
+ "description": "The UUIDs of the attachments to include, from `POST /v1/attachments`. Replaces the current list.",
+ "items": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "billing_email": {
+ "description": "Email of the billing contact.",
+ "format": "email",
+ "pattern": "^(?!\\.)(?!.*\\.\\.)([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.",
+ "type": "string"
+ },
+ "billing_workflow_type": {
+ "description": "The type of billing workflow. Use \"link\" with `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"
+ },
+ "confidentiality_period": {
+ "description": "How many years confidentiality obligations last (NDA).",
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "confidentiality_period_perpetual": {
+ "description": "When true, confidentiality obligations are perpetual (NDA).",
+ "type": "boolean"
+ },
+ "default_signer_email": {
+ "description": "The email of the user in your organization who signs the agreement. Must belong to a user in your organization; changing it moves the signer role to that user. A signer outside your organization returns a 400.",
+ "format": "email",
+ "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "district_or_county": {
+ "description": "The district or county for dispute resolution.",
+ "type": "string"
+ },
+ "effective_date": {
+ "description": "The effective date, when set explicitly.",
+ "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_of_confidentiality": {
+ "description": "When confidentiality obligations begin (NDA).",
+ "type": "string"
+ },
+ "effective_date_type": {
+ "description": "How the effective date is determined.",
+ "type": "string"
+ },
+ "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\" with `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_additional_changes": {
+ "description": "When true, `additional_changes` is included on the cover page.",
+ "type": "boolean"
+ },
+ "include_automated_nudges": {
+ "description": "When true, reminder emails are sent automatically.",
+ "type": "boolean"
+ },
+ "include_automated_payment_reminders": {
+ "description": "When true, payment reminder emails are sent automatically.",
+ "type": "boolean"
+ },
+ "include_billing_info": {
+ "description": "When true, `billing_name` and `billing_email` are included.",
+ "type": "boolean"
+ },
+ "include_billing_workflow": {
+ "description": "When true, enables a billing workflow after signing.",
+ "type": "boolean"
+ },
+ "include_cc_users": {
+ "description": "Whether to keep other people informed. Setting this to `false` removes every keep-informed (`cc`) user on the draft, and while it is `false` new `cc` roles are ignored.",
+ "type": "boolean"
+ },
+ "include_expiration_date": {
+ "description": "Expiration date in YYYY-MM-DD format. Use with `include_expiration_type` \"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": "Days until the agreement expires. Use with `include_expiration_type` \"days\".",
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_expiration_type": {
+ "description": "How the agreement expires: \"none\" (default), \"days\" (use `include_expiration_days`), or \"date\" (use `include_expiration_date`).",
+ "enum": [
+ "none",
+ "days",
+ "date"
+ ],
+ "type": "string"
+ },
+ "include_message": {
+ "description": "When true, `message` is sent with the agreement.",
+ "type": "boolean"
+ },
+ "manual_send": {
+ "description": "When true, the agreement is marked as sent outside the platform.",
+ "type": "boolean"
+ },
+ "message": {
+ "description": "The message sent to the recipient.",
+ "type": "string"
+ },
+ "negotiations_allowed": {
+ "description": "When true, the recipient can propose changes.",
+ "type": "boolean"
+ },
+ "payment_link_url": {
+ "description": "A payment URL shown to the recipient after signing. Requires `include_billing_workflow` and `billing_workflow_type` \"link\".",
+ "type": "string"
+ },
+ "purpose": {
+ "description": "The purpose of the agreement (NDA).",
+ "type": "string"
+ },
+ "recipient_city": {
+ "description": "The counterparty's city.",
+ "type": "string"
+ },
+ "recipient_country": {
+ "description": "The counterparty's country.",
+ "type": "string"
+ },
+ "recipient_email": {
+ "description": "The counterparty's email address.",
+ "format": "email",
+ "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "recipient_name": {
+ "description": "The counterparty's full 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-z]{2,}$",
+ "type": "string"
+ },
+ "recipient_organization": {
+ "description": "The counterparty's organization.",
+ "type": "string"
+ },
+ "recipient_state": {
+ "description": "The counterparty's state or region.",
+ "type": "string"
+ },
+ "recipient_street_address": {
+ "description": "The counterparty's street address.",
+ "type": "string"
+ },
+ "recipient_title": {
+ "description": "The counterparty's job title.",
+ "type": "string"
+ },
+ "recipient_zip": {
+ "description": "The counterparty's postal code.",
+ "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 your organization.",
+ "format": "email",
+ "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "subsidiary_id": {
+ "description": "The UUID of the subsidiary sending the agreement. Send `null`, an empty string, or an id that no longer exists to clear it. Omit the key entirely to leave the current subsidiary alone."
+ },
+ "term": {
+ "description": "The length of the agreement term in years (NDA).",
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "term_period_perpetual": {
+ "description": "When true, the term runs perpetually and `term` is ignored (NDA).",
+ "type": "boolean"
+ },
+ "test_agreement": {
+ "description": "When true, marks the agreement as a test. Test agreements do not count against your monthly limit.",
+ "type": "boolean"
+ }
+ },
+ "type": "object"
+ }
+ },
+ "required": [
+ "agreement"
+ ],
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Body for a draft whose `agreement_type` is `LOI`.",
+ "properties": {
+ "agreement": {
+ "additionalProperties": {},
+ "description": "The cover page fields every draft accepts, whatever its agreement type. Omitted fields keep their current values.",
+ "properties": {
+ "additional_changes": {
+ "description": "Free-text changes shown on the cover page.",
+ "type": "string"
+ },
+ "agreement_roles_attributes": {
+ "description": "The keep-informed (`cc`) users on the draft. Requires `include_cc_users` to be `true`. Add a person by sending `role: \"cc\"` with `user_attributes.email` and no `id`. Remove one by sending its existing `id` with a blank `user_attributes.email`. People are identified by email only, so there is no way to cc someone by user id.",
+ "items": {
+ "additionalProperties": false,
+ "properties": {
+ "id": {
+ "description": "The UUID of an existing role. Omit when adding a new person.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "role": {
+ "description": "The role to manage. Only `cc` roles can be changed through this endpoint.",
+ "enum": [
+ "cc"
+ ],
+ "type": "string"
+ },
+ "user_attributes": {
+ "additionalProperties": false,
+ "description": "The person to cc. Send a blank `email` with an `id` to remove that person.",
+ "properties": {
+ "email": {
+ "anyOf": [
+ {},
+ {}
+ ]
+ }
+ },
+ "type": "object"
+ }
+ },
+ "required": [
+ "role"
+ ],
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "attachment_ids": {
+ "description": "The UUIDs of the attachments to include, from `POST /v1/attachments`. Replaces the current list.",
+ "items": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "billing_email": {
+ "description": "Email of the billing contact.",
+ "format": "email",
+ "pattern": "^(?!\\.)(?!.*\\.\\.)([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.",
+ "type": "string"
+ },
+ "billing_workflow_type": {
+ "description": "The type of billing workflow. Use \"link\" with `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"
+ },
+ "confidentiality_period": {
+ "description": "How many years confidentiality obligations last (NDA).",
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "confidentiality_period_perpetual": {
+ "description": "When true, confidentiality obligations are perpetual (NDA).",
+ "type": "boolean"
+ },
+ "default_signer_email": {
+ "description": "The email of the user in your organization who signs the agreement. Must belong to a user in your organization; changing it moves the signer role to that user. A signer outside your organization returns a 400.",
+ "format": "email",
+ "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "district_or_county": {
+ "description": "The district or county for dispute resolution.",
+ "type": "string"
+ },
+ "effective_date": {
+ "description": "The effective date, when set explicitly.",
+ "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_of_confidentiality": {
+ "description": "When confidentiality obligations begin (NDA).",
+ "type": "string"
+ },
+ "effective_date_type": {
+ "description": "How the effective date is determined.",
+ "type": "string"
+ },
+ "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\" with `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_additional_changes": {
+ "description": "When true, `additional_changes` is included on the cover page.",
+ "type": "boolean"
+ },
+ "include_automated_nudges": {
+ "description": "When true, reminder emails are sent automatically.",
+ "type": "boolean"
+ },
+ "include_automated_payment_reminders": {
+ "description": "When true, payment reminder emails are sent automatically.",
+ "type": "boolean"
+ },
+ "include_billing_info": {
+ "description": "When true, `billing_name` and `billing_email` are included.",
+ "type": "boolean"
+ },
+ "include_billing_workflow": {
+ "description": "When true, enables a billing workflow after signing.",
+ "type": "boolean"
+ },
+ "include_cc_users": {
+ "description": "Whether to keep other people informed. Setting this to `false` removes every keep-informed (`cc`) user on the draft, and while it is `false` new `cc` roles are ignored.",
+ "type": "boolean"
+ },
+ "include_expiration_date": {
+ "description": "Expiration date in YYYY-MM-DD format. Use with `include_expiration_type` \"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": "Days until the agreement expires. Use with `include_expiration_type` \"days\".",
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_expiration_type": {
+ "description": "How the agreement expires: \"none\" (default), \"days\" (use `include_expiration_days`), or \"date\" (use `include_expiration_date`).",
+ "enum": [
+ "none",
+ "days",
+ "date"
+ ],
+ "type": "string"
+ },
+ "include_message": {
+ "description": "When true, `message` is sent with the agreement.",
+ "type": "boolean"
+ },
+ "manual_send": {
+ "description": "When true, the agreement is marked as sent outside the platform.",
+ "type": "boolean"
+ },
+ "message": {
+ "description": "The message sent to the recipient.",
+ "type": "string"
+ },
+ "negotiations_allowed": {
+ "description": "When true, the recipient can propose changes.",
+ "type": "boolean"
+ },
+ "payment_link_url": {
+ "description": "A payment URL shown to the recipient after signing. Requires `include_billing_workflow` and `billing_workflow_type` \"link\".",
+ "type": "string"
+ },
+ "purpose": {
+ "description": "The purpose of the agreement (NDA).",
+ "type": "string"
+ },
+ "recipient_city": {
+ "description": "The counterparty's city.",
+ "type": "string"
+ },
+ "recipient_country": {
+ "description": "The counterparty's country.",
+ "type": "string"
+ },
+ "recipient_email": {
+ "description": "The counterparty's email address.",
+ "format": "email",
+ "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "recipient_name": {
+ "description": "The counterparty's full 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-z]{2,}$",
+ "type": "string"
+ },
+ "recipient_organization": {
+ "description": "The counterparty's organization.",
+ "type": "string"
+ },
+ "recipient_state": {
+ "description": "The counterparty's state or region.",
+ "type": "string"
+ },
+ "recipient_street_address": {
+ "description": "The counterparty's street address.",
+ "type": "string"
+ },
+ "recipient_title": {
+ "description": "The counterparty's job title.",
+ "type": "string"
+ },
+ "recipient_zip": {
+ "description": "The counterparty's postal code.",
+ "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 your organization.",
+ "format": "email",
+ "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "subsidiary_id": {
+ "description": "The UUID of the subsidiary sending the agreement. Send `null`, an empty string, or an id that no longer exists to clear it. Omit the key entirely to leave the current subsidiary alone."
+ },
+ "term": {
+ "description": "The length of the agreement term in years (NDA).",
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "term_period_perpetual": {
+ "description": "When true, the term runs perpetually and `term` is ignored (NDA).",
+ "type": "boolean"
+ },
+ "test_agreement": {
+ "description": "When true, marks the agreement as a test. Test agreements do not count against your monthly limit.",
+ "type": "boolean"
+ }
+ },
+ "type": "object"
+ }
+ },
+ "required": [
+ "agreement"
+ ],
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Body for a draft whose `agreement_type` is `Software License`.",
+ "properties": {
+ "agreement": {
+ "additionalProperties": {},
+ "description": "The cover page fields every draft accepts, whatever its agreement type. Omitted fields keep their current values.",
+ "properties": {
+ "additional_changes": {
+ "description": "Free-text changes shown on the cover page.",
+ "type": "string"
+ },
+ "agreement_roles_attributes": {
+ "description": "The keep-informed (`cc`) users on the draft. Requires `include_cc_users` to be `true`. Add a person by sending `role: \"cc\"` with `user_attributes.email` and no `id`. Remove one by sending its existing `id` with a blank `user_attributes.email`. People are identified by email only, so there is no way to cc someone by user id.",
+ "items": {
+ "additionalProperties": false,
+ "properties": {
+ "id": {
+ "description": "The UUID of an existing role. Omit when adding a new person.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "role": {
+ "description": "The role to manage. Only `cc` roles can be changed through this endpoint.",
+ "enum": [
+ "cc"
+ ],
+ "type": "string"
+ },
+ "user_attributes": {
+ "additionalProperties": false,
+ "description": "The person to cc. Send a blank `email` with an `id` to remove that person.",
+ "properties": {
+ "email": {
+ "anyOf": [
+ {},
+ {}
+ ]
+ }
+ },
+ "type": "object"
+ }
+ },
+ "required": [
+ "role"
+ ],
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "attachment_ids": {
+ "description": "The UUIDs of the attachments to include, from `POST /v1/attachments`. Replaces the current list.",
+ "items": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "billing_email": {
+ "description": "Email of the billing contact.",
+ "format": "email",
+ "pattern": "^(?!\\.)(?!.*\\.\\.)([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.",
+ "type": "string"
+ },
+ "billing_workflow_type": {
+ "description": "The type of billing workflow. Use \"link\" with `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"
+ },
+ "confidentiality_period": {
+ "description": "How many years confidentiality obligations last (NDA).",
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "confidentiality_period_perpetual": {
+ "description": "When true, confidentiality obligations are perpetual (NDA).",
+ "type": "boolean"
+ },
+ "default_signer_email": {
+ "description": "The email of the user in your organization who signs the agreement. Must belong to a user in your organization; changing it moves the signer role to that user. A signer outside your organization returns a 400.",
+ "format": "email",
+ "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "district_or_county": {
+ "description": "The district or county for dispute resolution.",
+ "type": "string"
+ },
+ "effective_date": {
+ "description": "The effective date, when set explicitly.",
+ "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_of_confidentiality": {
+ "description": "When confidentiality obligations begin (NDA).",
+ "type": "string"
+ },
+ "effective_date_type": {
+ "description": "How the effective date is determined.",
+ "type": "string"
+ },
+ "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\" with `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_additional_changes": {
+ "description": "When true, `additional_changes` is included on the cover page.",
+ "type": "boolean"
+ },
+ "include_automated_nudges": {
+ "description": "When true, reminder emails are sent automatically.",
+ "type": "boolean"
+ },
+ "include_automated_payment_reminders": {
+ "description": "When true, payment reminder emails are sent automatically.",
+ "type": "boolean"
+ },
+ "include_billing_info": {
+ "description": "When true, `billing_name` and `billing_email` are included.",
+ "type": "boolean"
+ },
+ "include_billing_workflow": {
+ "description": "When true, enables a billing workflow after signing.",
+ "type": "boolean"
+ },
+ "include_cc_users": {
+ "description": "Whether to keep other people informed. Setting this to `false` removes every keep-informed (`cc`) user on the draft, and while it is `false` new `cc` roles are ignored.",
+ "type": "boolean"
+ },
+ "include_expiration_date": {
+ "description": "Expiration date in YYYY-MM-DD format. Use with `include_expiration_type` \"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": "Days until the agreement expires. Use with `include_expiration_type` \"days\".",
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_expiration_type": {
+ "description": "How the agreement expires: \"none\" (default), \"days\" (use `include_expiration_days`), or \"date\" (use `include_expiration_date`).",
+ "enum": [
+ "none",
+ "days",
+ "date"
+ ],
+ "type": "string"
+ },
+ "include_message": {
+ "description": "When true, `message` is sent with the agreement.",
+ "type": "boolean"
+ },
+ "manual_send": {
+ "description": "When true, the agreement is marked as sent outside the platform.",
+ "type": "boolean"
+ },
+ "message": {
+ "description": "The message sent to the recipient.",
+ "type": "string"
+ },
+ "negotiations_allowed": {
+ "description": "When true, the recipient can propose changes.",
+ "type": "boolean"
+ },
+ "payment_link_url": {
+ "description": "A payment URL shown to the recipient after signing. Requires `include_billing_workflow` and `billing_workflow_type` \"link\".",
+ "type": "string"
+ },
+ "purpose": {
+ "description": "The purpose of the agreement (NDA).",
+ "type": "string"
+ },
+ "recipient_city": {
+ "description": "The counterparty's city.",
+ "type": "string"
+ },
+ "recipient_country": {
+ "description": "The counterparty's country.",
+ "type": "string"
+ },
+ "recipient_email": {
+ "description": "The counterparty's email address.",
+ "format": "email",
+ "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "recipient_name": {
+ "description": "The counterparty's full 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-z]{2,}$",
+ "type": "string"
+ },
+ "recipient_organization": {
+ "description": "The counterparty's organization.",
+ "type": "string"
+ },
+ "recipient_state": {
+ "description": "The counterparty's state or region.",
+ "type": "string"
+ },
+ "recipient_street_address": {
+ "description": "The counterparty's street address.",
+ "type": "string"
+ },
+ "recipient_title": {
+ "description": "The counterparty's job title.",
+ "type": "string"
+ },
+ "recipient_zip": {
+ "description": "The counterparty's postal code.",
+ "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 your organization.",
+ "format": "email",
+ "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "subsidiary_id": {
+ "description": "The UUID of the subsidiary sending the agreement. Send `null`, an empty string, or an id that no longer exists to clear it. Omit the key entirely to leave the current subsidiary alone."
+ },
+ "term": {
+ "description": "The length of the agreement term in years (NDA).",
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "term_period_perpetual": {
+ "description": "When true, the term runs perpetually and `term` is ignored (NDA).",
+ "type": "boolean"
+ },
+ "test_agreement": {
+ "description": "When true, marks the agreement as a test. Test agreements do not count against your monthly limit.",
+ "type": "boolean"
+ }
+ },
+ "type": "object"
+ }
+ },
+ "required": [
+ "agreement"
+ ],
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Body for a draft whose `agreement_type` is `Amendment`.",
+ "properties": {
+ "agreement": {
+ "additionalProperties": {},
+ "description": "The cover page fields every draft accepts, whatever its agreement type. Omitted fields keep their current values.",
+ "properties": {
+ "additional_changes": {
+ "description": "Free-text changes shown on the cover page.",
+ "type": "string"
+ },
+ "agreement_roles_attributes": {
+ "description": "The keep-informed (`cc`) users on the draft. Requires `include_cc_users` to be `true`. Add a person by sending `role: \"cc\"` with `user_attributes.email` and no `id`. Remove one by sending its existing `id` with a blank `user_attributes.email`. People are identified by email only, so there is no way to cc someone by user id.",
+ "items": {
+ "additionalProperties": false,
+ "properties": {
+ "id": {
+ "description": "The UUID of an existing role. Omit when adding a new person.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "role": {
+ "description": "The role to manage. Only `cc` roles can be changed through this endpoint.",
+ "enum": [
+ "cc"
+ ],
+ "type": "string"
+ },
+ "user_attributes": {
+ "additionalProperties": false,
+ "description": "The person to cc. Send a blank `email` with an `id` to remove that person.",
+ "properties": {
+ "email": {
+ "anyOf": [
+ {},
+ {}
+ ]
+ }
+ },
+ "type": "object"
+ }
+ },
+ "required": [
+ "role"
+ ],
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "attachment_ids": {
+ "description": "The UUIDs of the attachments to include, from `POST /v1/attachments`. Replaces the current list.",
+ "items": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "billing_email": {
+ "description": "Email of the billing contact.",
+ "format": "email",
+ "pattern": "^(?!\\.)(?!.*\\.\\.)([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.",
+ "type": "string"
+ },
+ "billing_workflow_type": {
+ "description": "The type of billing workflow. Use \"link\" with `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"
+ },
+ "confidentiality_period": {
+ "description": "How many years confidentiality obligations last (NDA).",
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "confidentiality_period_perpetual": {
+ "description": "When true, confidentiality obligations are perpetual (NDA).",
+ "type": "boolean"
+ },
+ "default_signer_email": {
+ "description": "The email of the user in your organization who signs the agreement. Must belong to a user in your organization; changing it moves the signer role to that user. A signer outside your organization returns a 400.",
+ "format": "email",
+ "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "district_or_county": {
+ "description": "The district or county for dispute resolution.",
+ "type": "string"
+ },
+ "effective_date": {
+ "description": "The effective date, when set explicitly.",
+ "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_of_confidentiality": {
+ "description": "When confidentiality obligations begin (NDA).",
+ "type": "string"
+ },
+ "effective_date_type": {
+ "description": "How the effective date is determined.",
+ "type": "string"
+ },
+ "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\" with `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_additional_changes": {
+ "description": "When true, `additional_changes` is included on the cover page.",
+ "type": "boolean"
+ },
+ "include_automated_nudges": {
+ "description": "When true, reminder emails are sent automatically.",
+ "type": "boolean"
+ },
+ "include_automated_payment_reminders": {
+ "description": "When true, payment reminder emails are sent automatically.",
+ "type": "boolean"
+ },
+ "include_billing_info": {
+ "description": "When true, `billing_name` and `billing_email` are included.",
+ "type": "boolean"
+ },
+ "include_billing_workflow": {
+ "description": "When true, enables a billing workflow after signing.",
+ "type": "boolean"
+ },
+ "include_cc_users": {
+ "description": "Whether to keep other people informed. Setting this to `false` removes every keep-informed (`cc`) user on the draft, and while it is `false` new `cc` roles are ignored.",
+ "type": "boolean"
+ },
+ "include_expiration_date": {
+ "description": "Expiration date in YYYY-MM-DD format. Use with `include_expiration_type` \"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": "Days until the agreement expires. Use with `include_expiration_type` \"days\".",
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_expiration_type": {
+ "description": "How the agreement expires: \"none\" (default), \"days\" (use `include_expiration_days`), or \"date\" (use `include_expiration_date`).",
+ "enum": [
+ "none",
+ "days",
+ "date"
+ ],
+ "type": "string"
+ },
+ "include_message": {
+ "description": "When true, `message` is sent with the agreement.",
+ "type": "boolean"
+ },
+ "manual_send": {
+ "description": "When true, the agreement is marked as sent outside the platform.",
+ "type": "boolean"
+ },
+ "message": {
+ "description": "The message sent to the recipient.",
+ "type": "string"
+ },
+ "negotiations_allowed": {
+ "description": "When true, the recipient can propose changes.",
+ "type": "boolean"
+ },
+ "payment_link_url": {
+ "description": "A payment URL shown to the recipient after signing. Requires `include_billing_workflow` and `billing_workflow_type` \"link\".",
+ "type": "string"
+ },
+ "purpose": {
+ "description": "The purpose of the agreement (NDA).",
+ "type": "string"
+ },
+ "recipient_city": {
+ "description": "The counterparty's city.",
+ "type": "string"
+ },
+ "recipient_country": {
+ "description": "The counterparty's country.",
+ "type": "string"
+ },
+ "recipient_email": {
+ "description": "The counterparty's email address.",
+ "format": "email",
+ "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "recipient_name": {
+ "description": "The counterparty's full 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-z]{2,}$",
+ "type": "string"
+ },
+ "recipient_organization": {
+ "description": "The counterparty's organization.",
+ "type": "string"
+ },
+ "recipient_state": {
+ "description": "The counterparty's state or region.",
+ "type": "string"
+ },
+ "recipient_street_address": {
+ "description": "The counterparty's street address.",
+ "type": "string"
+ },
+ "recipient_title": {
+ "description": "The counterparty's job title.",
+ "type": "string"
+ },
+ "recipient_zip": {
+ "description": "The counterparty's postal code.",
+ "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 your organization.",
+ "format": "email",
+ "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "subsidiary_id": {
+ "description": "The UUID of the subsidiary sending the agreement. Send `null`, an empty string, or an id that no longer exists to clear it. Omit the key entirely to leave the current subsidiary alone."
+ },
+ "term": {
+ "description": "The length of the agreement term in years (NDA).",
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "term_period_perpetual": {
+ "description": "When true, the term runs perpetually and `term` is ignored (NDA).",
+ "type": "boolean"
+ },
+ "test_agreement": {
+ "description": "When true, marks the agreement as a test. Test agreements do not count against your monthly limit.",
+ "type": "boolean"
+ }
+ },
+ "type": "object"
+ }
+ },
+ "required": [
+ "agreement"
+ ],
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Body for a draft created from a custom template. Drafts created from a custom template have no standard term object; their fields live in `custom_field_values`.",
+ "properties": {
+ "agreement": {
+ "additionalProperties": {},
+ "description": "The cover page fields every draft accepts, whatever its agreement type. Omitted fields keep their current values.",
+ "properties": {
+ "additional_changes": {
+ "description": "Free-text changes shown on the cover page.",
+ "type": "string"
+ },
+ "agreement_roles_attributes": {
+ "description": "The keep-informed (`cc`) users on the draft. Requires `include_cc_users` to be `true`. Add a person by sending `role: \"cc\"` with `user_attributes.email` and no `id`. Remove one by sending its existing `id` with a blank `user_attributes.email`. People are identified by email only, so there is no way to cc someone by user id.",
+ "items": {
+ "additionalProperties": false,
+ "properties": {
+ "id": {
+ "description": "The UUID of an existing role. Omit when adding a new person.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "role": {
+ "description": "The role to manage. Only `cc` roles can be changed through this endpoint.",
+ "enum": [
+ "cc"
+ ],
+ "type": "string"
+ },
+ "user_attributes": {
+ "additionalProperties": false,
+ "description": "The person to cc. Send a blank `email` with an `id` to remove that person.",
+ "properties": {
+ "email": {
+ "anyOf": [
+ {},
+ {}
+ ]
+ }
+ },
+ "type": "object"
+ }
+ },
+ "required": [
+ "role"
+ ],
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "attachment_ids": {
+ "description": "The UUIDs of the attachments to include, from `POST /v1/attachments`. Replaces the current list.",
+ "items": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "billing_email": {
+ "description": "Email of the billing contact.",
+ "format": "email",
+ "pattern": "^(?!\\.)(?!.*\\.\\.)([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.",
+ "type": "string"
+ },
+ "billing_workflow_type": {
+ "description": "The type of billing workflow. Use \"link\" with `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"
+ },
+ "confidentiality_period": {
+ "description": "How many years confidentiality obligations last (NDA).",
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "confidentiality_period_perpetual": {
+ "description": "When true, confidentiality obligations are perpetual (NDA).",
+ "type": "boolean"
+ },
+ "default_signer_email": {
+ "description": "The email of the user in your organization who signs the agreement. Must belong to a user in your organization; changing it moves the signer role to that user. A signer outside your organization returns a 400.",
+ "format": "email",
+ "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "district_or_county": {
+ "description": "The district or county for dispute resolution.",
+ "type": "string"
+ },
+ "effective_date": {
+ "description": "The effective date, when set explicitly.",
+ "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_of_confidentiality": {
+ "description": "When confidentiality obligations begin (NDA).",
+ "type": "string"
+ },
+ "effective_date_type": {
+ "description": "How the effective date is determined.",
+ "type": "string"
+ },
+ "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\" with `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_additional_changes": {
+ "description": "When true, `additional_changes` is included on the cover page.",
+ "type": "boolean"
+ },
+ "include_automated_nudges": {
+ "description": "When true, reminder emails are sent automatically.",
+ "type": "boolean"
+ },
+ "include_automated_payment_reminders": {
+ "description": "When true, payment reminder emails are sent automatically.",
+ "type": "boolean"
+ },
+ "include_billing_info": {
+ "description": "When true, `billing_name` and `billing_email` are included.",
+ "type": "boolean"
+ },
+ "include_billing_workflow": {
+ "description": "When true, enables a billing workflow after signing.",
+ "type": "boolean"
+ },
+ "include_cc_users": {
+ "description": "Whether to keep other people informed. Setting this to `false` removes every keep-informed (`cc`) user on the draft, and while it is `false` new `cc` roles are ignored.",
+ "type": "boolean"
+ },
+ "include_expiration_date": {
+ "description": "Expiration date in YYYY-MM-DD format. Use with `include_expiration_type` \"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": "Days until the agreement expires. Use with `include_expiration_type` \"days\".",
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_expiration_type": {
+ "description": "How the agreement expires: \"none\" (default), \"days\" (use `include_expiration_days`), or \"date\" (use `include_expiration_date`).",
+ "enum": [
+ "none",
+ "days",
+ "date"
+ ],
+ "type": "string"
+ },
+ "include_message": {
+ "description": "When true, `message` is sent with the agreement.",
+ "type": "boolean"
+ },
+ "manual_send": {
+ "description": "When true, the agreement is marked as sent outside the platform.",
+ "type": "boolean"
+ },
+ "message": {
+ "description": "The message sent to the recipient.",
+ "type": "string"
+ },
+ "negotiations_allowed": {
+ "description": "When true, the recipient can propose changes.",
+ "type": "boolean"
+ },
+ "payment_link_url": {
+ "description": "A payment URL shown to the recipient after signing. Requires `include_billing_workflow` and `billing_workflow_type` \"link\".",
+ "type": "string"
+ },
+ "purpose": {
+ "description": "The purpose of the agreement (NDA).",
+ "type": "string"
+ },
+ "recipient_city": {
+ "description": "The counterparty's city.",
+ "type": "string"
+ },
+ "recipient_country": {
+ "description": "The counterparty's country.",
+ "type": "string"
+ },
+ "recipient_email": {
+ "description": "The counterparty's email address.",
+ "format": "email",
+ "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "recipient_name": {
+ "description": "The counterparty's full 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-z]{2,}$",
+ "type": "string"
+ },
+ "recipient_organization": {
+ "description": "The counterparty's organization.",
+ "type": "string"
+ },
+ "recipient_state": {
+ "description": "The counterparty's state or region.",
+ "type": "string"
+ },
+ "recipient_street_address": {
+ "description": "The counterparty's street address.",
+ "type": "string"
+ },
+ "recipient_title": {
+ "description": "The counterparty's job title.",
+ "type": "string"
+ },
+ "recipient_zip": {
+ "description": "The counterparty's postal code.",
+ "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 your organization.",
+ "format": "email",
+ "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "subsidiary_id": {
+ "description": "The UUID of the subsidiary sending the agreement. Send `null`, an empty string, or an id that no longer exists to clear it. Omit the key entirely to leave the current subsidiary alone."
+ },
+ "term": {
+ "description": "The length of the agreement term in years (NDA).",
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "term_period_perpetual": {
+ "description": "When true, the term runs perpetually and `term` is ignored (NDA).",
+ "type": "boolean"
+ },
+ "test_agreement": {
+ "description": "When true, marks the agreement as a test. Test agreements do not count against your monthly limit.",
+ "type": "boolean"
+ }
+ },
+ "type": "object"
+ }
+ },
+ "required": [
+ "agreement"
+ ],
+ "type": "object"
+ }
+]get-template6 fields changedOutput schema / properties / data / descriptionAdded value: +"A standard template (type template_nda, template_csa, etc.) or an uploaded PDF template (type uploaded_template). Uploaded templates have no standard_version."Output schema / properties / data / itemsRemoved value: -{
- "properties": {
- "attributes": {
- "properties": {
- "agreement_type": {
- "example": "nda",
- "type": "string"
- },
- "created_at": {
- "format": "date-time",
- "type": "string"
- },
- "name": {
- "example": "Standard NDA",
- "type": "string"
- },
- "updated_at": {
- "format": "date-time",
- "type": "string"
- }
- },
- "type": "object"
- },
- "id": {
- "format": "uuid",
- "type": "string"
- },
- "standard_version": {
- "example": "1.0",
- "type": "string"
- },
- "type": {
- "example": "template_nda",
- "type": "string"
- }
- },
- "type": "object"
-}Output schema / properties / data / propertiesAdded value: +{
+ "attributes": {
+ "properties": {
+ "agreement_type": {
+ "example": "nda",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "created_at": {
+ "format": "date-time",
+ "type": "string"
+ },
+ "name": {
+ "example": "Standard NDA",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "updated_at": {
+ "format": "date-time",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "id": {
+ "format": "uuid",
+ "type": "string"
+ },
+ "standard_version": {
+ "example": "1.0",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "type": {
+ "example": "template_nda",
+ "type": "string"
+ }
+}Output schema / properties / data / requiredAdded value: +[
+ "id",
+ "type",
+ "attributes"
+]Output schema / properties / data / titleAdded value: +"Template"Output schema / properties / data / typePrevious value: -"array"New value: +"object"archive-attachmentarchive-custom-templatearchive-templatecreate-agreementcreate-custom-templatecreate-custom-template-versioncreate-custom-term_application_jsoncreate-custom-term_multipart_form_datacreate-custom-term-version_application_jsoncreate-custom-term-version_multipart_form_datacreate-invitationcreate-templatedownload-agreement-pdfgenerate-api-keygenerate-shareable-linkget-agreementget-agreement-historyget-custom-templateget-custom-termget-invitationget-meget-organizationget-templateget-userlist-agreement-historylist-agreement-statuseslist-agreement-typeslist-agreementslist-attachmentslist-custom-templateslist-custom-termslist-invitationslist-organizationslist-templateslist-usersreassign-agreementresend-agreement-emailsend-agreementupdate-custom-templateupdate-custom-termupdate-draft-agreementupdate-organizationupdate-templateupload-attachment_application_jsonupload-attachment_multipart_form_datavoid-agreementE-signatures for contracts and NDAs. Draft with AI, review, and send for signature.
Send agreements for e-signing, use templates, track signatures, send reminders, get signed documents
Send contracts for e-signature, track signing, get signed PDFs and audit trails, verify any PDF.
E-signature API for AI agents: send contracts, sign PDF documents, track and download signed files.
Add one secure layer between your agents and this server.
