Create, send, negotiate, sign, and track contracts with Common Paper.
Scored across 46 tools
Most resource+action pairs are distinct (agreements vs templates vs custom templates vs custom terms vs attachments), but the surface is polluted by three near-identical pairs whose descriptions are word-for-word duplicates: create-custom-term / create-custom-term-version / upload-attachment each appear as both `_application_json` and `_multipart_form_data` variants. An agent has no semantic basis to choose between them, and template vs custom-template tooling also requires reading descriptions closely to separate.
The dominant pattern is clean kebab-case verb-noun (create-agreement, list-templates, archive-custom-template), which is good. However, several names splice in snake_case suffixes for content types (`create-custom-term_application_json`, `upload-attachment_multipart_form_data`), breaking the convention and producing awkward hybrid identifiers.
46 tools is well past a manageable surface for a single MCP server, and the count is inflated by six tools that are just content-type duplicates of three operations. While the domain (agreements, templates, terms, attachments, users, orgs, invitations) is genuinely broad, several tools should have been collapsed, making the set feel bloated rather than well-scoped.
Agreement lifecycle is well covered (create, get, update draft, send, reassign, resend, void, download PDF, history, statuses/types). Templates, custom templates, and custom terms all have create/get/list/update/archive/version paths. Minor gaps remain: no get-attachment detail, no revoke/delete invitation, and no user removal.
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, idempotentHint=true, and readOnlyHint=false, and the description adds genuinely new context beyond them: the attachment is removed from the active list rather than destroyed. It also reveals an operational quirk — restoration happens in the UI, not via this API — which an agent cannot infer from 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 compact sentences with zero waste. The action is front-loaded and the consequence follows immediately.
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 one-parameter mutation tool whose annotations already cover safety, idempotency, and openness, the description adds the key consequence and reversibility story. It omits error behavior (e.g., already-archived or missing attachment) and any permission requirement, but nothing essential to invoking it 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?
Only one nested parameter (pathParams.id), and the schema's own field description already states it is the UUID of the attachment to archive. The description adds nothing about the identifier beyond what the schema supplies, so it neither compensates for nor detracts from the nominal 0% coverage metric.
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 resource (file attachment), so an agent immediately knows the operation and target. It does not name or contrast itself with siblings such as list-attachments or upload-attachment, but the resource noun makes the distinction reasonably clear.
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: “Removed from active list; restorable in the UI” signals this is a soft-delete rather than permanent removal, which hints at when it is preferred over a hard delete. There is no explicit when-to-use, prerequisite, or alternative-tool guidance.
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, idempotentHint=true and readOnlyHint=false, but the description adds genuinely useful semantics beyond them: what destruction actually means (cannot be used to create agreements) and the blast radius (existing agreements unaffected). It still omits reversibility/restore and permission requirements.
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 the action front-loaded and the consequence immediately after; no filler. Slightly terse on the operational side but 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?
For a destructive, non-read-only mutation with no output schema, the description covers the effect on the template and on existing agreements but omits reversibility, required permissions, and error/not-found behavior. Adequate but with clear gaps.
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 with 0% reported schema coverage, and the description adds nothing about the id (which UUID, where obtained). The parameter is largely self-evident from the nested schema's own format/pattern/description, so 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 (archive) and a specific resource (custom template), which is distinguishable from the sibling archive-template by the 'custom' qualifier. It does not explicitly name the sibling or contrast the two, so it falls 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 description explains the consequence of archiving but never states when to choose this tool over archive-template, update-custom-template, or deletion-style alternatives. The only guidance is implied by the effect statement.
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, idempotentHint=true, and readOnlyHint=false. The description adds genuinely useful behavior beyond that: the template is 'removed from active list' (soft-delete semantics) and is 'restorable in the UI,' which qualifies the alarming destructiveHint and tells the agent the effect is reversible.
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, effect first, reversibility second, with zero filler. Every clause earns its place and nothing an agent must read is 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?
For a one-parameter mutation with no output schema, the description plus annotations cover the essential facts: what it does, that it is destructive but idempotent, and that the deletion is recoverable. Only secondary details (required permissions, response shape) are 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?
Schema description coverage is reported at 0% for the single required id parameter, so the description is expected to compensate, yet it says nothing about the identifier (format, source, or how to obtain it). The inline UUID schema does the actual documentation work, so the description adds no parameter 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?
The description states a specific verb (archive) and resource (agreement template), and the qualifier 'agreement' distinguishes it from the sibling archive-custom-template. However, it never explicitly routes the agent between those two near-identical siblings, so differentiation is implicit rather than stated.
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 when to use archive-custom-template, create-template, or update-template, and no prerequisites or exclusions are given. The description only states the effect of the call, leaving all usage context to inference.
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 | ||
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare destructiveHint=true, idempotentHint=false, non-read-only, so the mutation risk profile is covered. The description adds genuinely new behavioral rules the annotations cannot express: owner and signer must be id or email 'never both', the recipient is the counterparty, and override objects only override fields you include. It does not state what an agent should expect on failure beyond the id/email exclusivity.
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 sentences, zero filler, and the highest-value constraint (id or email, never both) sits early. The draft routing and the override mechanism follow in order of likely need. No repetition of annotation or schema content.
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 tool this complex — four mutually exclusive request shapes and dozens of per-type attribute objects — the description covers the decisions the agent must make before calling. An output schema exists, so return values need not be explained. What is missing is guidance on validating the chosen variant (e.g. which fields each variant requires) and any note about draft-then-update workflow for typed attributes.
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 top level, so the description has to compensate for a single opaque 'body' parameter with four anyOf variants. It does this well by naming the discriminating choices (owner/signer id vs email, draft flag, typed attribute objects, custom_field_values), though it does not spell out the four required combinations or the custom-field key lookup source beyond 'the template's field keys'.
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 plus the three creation sources (standard, uploaded PDF, custom template). It also names the sibling it is not ('use send-agreement to send'), so an agent can distinguish it from send-agreement and update-draft-agreement 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?
Explicit routing: 'draft=true saves without sending; use send-agreement to send' gives both the condition and the alternative. It also tells the agent which override mechanism applies per template type (typed *_attributes vs agreement.custom_field_values).
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
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 readOnlyHint=false, destructiveHint=false and idempotentHint=false, so the safety profile is covered. The description adds real behavioral facts beyond them: the definition is persisted as the template's first version, and attached custom terms propagate into agreements created from the template. It stops short of saying whether the template is immediately usable or how duplicate names are handled.
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 short sentences, front-loaded with the action and input format, followed by the creator requirement and the optional term attachment. Each sentence carries information, though the custom_term_id sentence largely duplicates the schema text.
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, and annotations cover the mutation profile. For a tool with one nested body parameter, the description supplies the essential extras: the YAML definition becomes version one, a creator identity is required, and custom terms can be attached. Nothing critical for a correct call 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 100%, so the schema already explains name, definition, user_id, user_email and custom_term_id in detail. The description restates the creator requirement and the custom_term_id effect, both of which are already in the property descriptions, so it adds little semantic value beyond the schema. 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 ('Create a custom template') and adds the concrete input shape ('from a YAML definition of its title, sections, and fields'), which an agent can distinguish from create-template and create-custom-template-version. It never explicitly names those siblings, so differentiation rests on the name plus the word 'custom' rather than on stated contrast.
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 gives prerequisites ('Requires user_email or user_id to record the creator') and an optional extension ('Optionally pass custom_term_id'), which is useful call-shaping context. It does not say when to pick this over create-template or create-custom-template-version, nor what to do if a template with the same name already exists, so the when-to-use routing is only implied.
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?
The description adds substantial behavior beyond the annotations: new agreements adopt the version immediately, existing agreements remain pinned, identical definitions are a no-op returning the current version, and publisher identity is required. This aligns with the idempotent and destructive hints without contradicting them.
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, each carrying distinct necessary information, with the primary action and immediate effect front-loaded. There is no repetitive or filler language.
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 mutation/versioning behavior, nested schema, and annotations, the description covers the essential semantics an agent needs: what publishing does, how existing agreements are affected, idempotent no-op behavior, and publisher requirements. An output schema exists, so return-value detail is not needed.
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 reinforces that user_email or user_id is required to record the publisher, which is also documented in the schema. With 50% schema description coverage, it does not add much detail about the template id or YAML definition beyond what the schema already provides.
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 uses a specific verb and resource: 'Publish a new YAML version of a custom template.' It clearly distinguishes this from creating a template or updating template metadata by emphasizing version publishing, and the sibling names make the distinction easy to infer.
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 explains the key usage effect: new agreements use the published version while existing agreements keep their pinned version. It does not explicitly name when to use this versus update-custom-template, but the versioning context is clear enough for selection.
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?
Beyond the annotations, the description explains key behavior: the markdown body becomes released version 1, and a creator must be recorded via user_email or user_id. It also clearly states the text-only limitation and points to the REST multipart endpoint for file terms.
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 front-loaded and appropriately sized for a create operation. There is some redundancy around file-term handling, but the extra sentences carry useful routing information rather than noise.
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 nested schema, 100% parameter description coverage, existing output schema, and annotations, the description supplies the remaining critical context: text-only scope, creator requirement, released-version behavior, and the file-term alternative endpoint.
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 input schema has 100% description coverage, so the schema already documents the nested parameters. The description reinforces the creator requirement and the markdown body’s version-1 behavior, but does not add substantial syntax or format details 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?
The description uses a specific verb and resource: 'Create text custom terms.' It also distinguishes this tool from file-term creation by stating that file uploads are not supported over MCP and should use the REST multipart/form-data endpoint 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?
The description makes the primary usage context clear: create text custom terms via JSON, with file terms handled elsewhere. It also names the alternative path for file terms, though it does not explicitly differentiate from sibling version-creation or update tools.
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 declare this is not read-only, not idempotent, and not destructive, so the agent knows it's a write operation. The description adds valuable behavioral detail: "The markdown body becomes released version 1" and "Requires user_email or user_id to record the creator." These go beyond annotations. However, it doesn't cover error behaviors, permission requirements, or what the response contains (though output schema 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?
Four sentences, front-loaded with the core action. Each sentence adds information, though the final two sentences about file uploads are slightly repetitive with 'file terms are managed in the app' and 'create file terms through the REST endpoint.' Overall efficient and well-structured.
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, the description needn't explain return values. It covers the key behavioral traits (versioning, creator recording, text-only limitation, MCP file upload restriction). The main gap is not clarifying the difference from the JSON sibling, but for a one-parameter tool with an output schema, this is fairly complete.
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 there is only one parameter ('body'), whose schema is an opaque anyOf. The description explains that the body is markdown and becomes released version 1, and mentions required user_email/user_id fields not in the schema. This adds meaning, but the body's format is only partially clarified, and the required creator fields aren't in the schema at all, which is confusing.
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: 'Create text custom terms.' This distinguishes it from the sibling 'create-custom-term_application_json' by virtue of the multipart_form_data suffix and the 'text custom terms' phrasing, though it doesn't explicitly compare itself to that sibling. Clear enough for an agent to recognize it creates custom terms.
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 notes 'Text only; file terms are managed in the app' and directs file uploads to the REST endpoint, which provides some when-to-use context. However, it doesn't explicitly state when to prefer this multipart variant over the JSON sibling 'create-custom-term_application_json', leaving the multipart vs. JSON distinction unexplained.
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 flag destructiveHint=true and idempotentHint=false, and the description goes well beyond them by explaining the consequence: the new version immediately becomes the released version used by new agreements while existing versions stay immutable. It also discloses the publisher-recording requirement and a hard capability limit (no file uploads over MCP).
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 release semantics, then the identity requirement and file-upload caveat. No redundancy against the title or schema.
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. The remaining gap is sibling routing: it does not clarify when to create a new custom term versus a new version of an existing one.
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 moderate (~50%), but the description adds meaning: body is markdown text, and the creator identity must be supplied via user_email or user_id. The schema itself already documents the UUID path param and per-field semantics, so little is left ambiguous.
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 ("Publish a new markdown version of text custom terms") and explicitly names the boundary against the file-based variant, directing file publishing to REST. An agent can distinguish this from the multipart sibling 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 conditions: use this for markdown text terms, not for file uploads (use the REST multipart endpoint), and supply user_email or user_id as publisher. It lacks a distinction from create-custom-term_application_json (creating a brand-new term rather than a version), which is the nearest sibling an agent could confuse it with.
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 destructiveHint=true and idempotentHint=false, but the description adds the material consequence: the new version immediately becomes the released version used by new agreements, while existing versions stay immutable. That is real impact disclosure beyond the safety flags, though it omits reversibility details.
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 action, then impact, then constraint. No filler, though the final sentence about file uploads is slightly tangential to the core operation and could be tightened.
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 annotations cover the safety profile. The description supplies the versioning semantics and the MCP-vs-REST boundary, which is what an agent most needs; only the opaque body payload remains under-specified.
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 body's anyOf is fully opaque, so the description carries the burden. It names the identity requirement (user_email or user_id) and implies markdown content, but does not enumerate or structure the body fields an agent must send, leaving a meaningful 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?
States a specific verb and resource with scope: 'Publish a new markdown version of text custom terms.' The 'text custom terms' qualifier distinguishes it from file-based siblings, though the deliberate mismatch with the tool's own name (multipart_form_data) creates friction for selection. Clear enough to route correctly.
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-not guidance: file uploads are unsupported over MCP and should go through the REST multipart endpoint instead. It also states the requirement of user_email or user_id to record the publisher. No guidance on when this tool is preferred over create-custom-term_multipart_form_data other than the text/file distinction.
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 flag this as a non-idempotent, destructive, open-world write; the description adds real value by naming the failure conditions (missing email, invalid inviter, already a member) returning 422. It omits auth requirements and rate limits, keeping it short of 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?
Four dense clauses with the essentials (action, required fields, default, errors) front-loaded, plus a docs link. No filler, though the density sacrifices some readability.
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 shape needn't be described, and the error behavior plus required-field semantics cover what an agent needs to invoke correctly. Missing only permissions/auth context for a destructive write.
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 coverage is 0%, so the description must carry the load, and it does: it names the required nested fields, clarifies inviter_email must be an existing member, and states access defaults to 'standard'. It doesn't explain the admin/standard semantic difference or format constraints beyond what's obvious.
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') that is unambiguously distinct from the read siblings like get-invitation and list-invitations. The required-field callout reinforces exactly what the tool creates.
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 creation verb and the prerequisites, but the description never says when to prefer this over related flows (e.g., resending or listing invitations) or what happens if an invitation already exists rather than a 422 case.
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 | ||
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnly=false, destructive=false, idempotent=false, so the safety profile is known. The description adds one valuable downstream trait ('fields pre-fill agreements created from the template'), but says nothing about what happens on partial input, validation failures, or duplicate templates; the claim 'all fields optional' is also misleading given the schema requires body and most variants require type.
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 short sentences, front-loaded with the action and immediately followed by the most decision-relevant instruction (variant selection). No filler, though the final clause is inaccurate rather than merely terse.
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 needn't be explained, but for a create operation over a very large discriminated union the description omits that type is mandatory for every non-NDA variant and offers no hint about the practical minimum payload — an agent could easily attempt an incomplete call.
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 description coverage is 0%, but the single parameter is a large anyOf of variants whose leaf properties carry their own descriptions. The description supplies the key orienting fact (variant per template type, NDA default) and the pre-fill meaning of the fields, but 'All fields optional' mischaracterizes variants that require type.
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 ('Create an agreement template') that separates it from create-agreement and create-custom-template at the surface level. It does not explicitly say how it differs from the sibling create-custom-template, 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?
Adds one useful routing instruction — pick the schema variant matching your template type, NDA when omitted — but gives no guidance on when to use this versus create-custom-template or create-custom-template-version, nor any prerequisites/authorization context.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
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 that annotations cannot convey: the tool does not return file bytes, it returns a curl_command that must be run verbatim, and the embedded URL is single-use with a 5-minute expiry. This is exactly the operational detail an agent would otherwise get wrong.
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?
Five short sentences, each earning its place, with the counterintuitive behavior (no file bytes, use the curl command) front-loaded right after the purpose statement. Zero 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, so return-value detail is optional, yet the description still explains the unusual JSON/curl_command response shape and its expiry constraint. Nothing needed to invoke and post-process this tool 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?
Only one parameter, and the description reinforces its meaning ("by UUID"). Schema description coverage is reported low, but the sole parameter is a well-constrained UUID whose meaning is already clear from the field itself, so the description neither adds much nor needs to.
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 (download) and resource (agreement PDF) plus the identifier type (UUID). No sibling tool does the same thing, and the description makes clear it is the PDF-retrieval path rather than a metadata read like get-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?
Gives a clear trigger (download an agreement PDF by UUID) and an explicit exclusion ("Do not call any other file-download tool"), which is genuinely useful routing guidance. It stops short of naming a sibling alternative for the metadata-vs-PDF decision, so it is strong but not fully explicit.
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 only tell the agent this is a non-read-only, non-idempotent write. The description adds far beyond that: the key is returned once, must be treated as a secret, must not be echoed, must be persisted and reused, and is consumed as an Authorization: Bearer header. These are operational traits structured fields 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?
Front-loads the purpose, then layers secret-handling, caching, and header-usage guidance. Every sentence is operationally useful, though the single dense paragraph could be broken up for faster scanning.
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 returned value that matters (attributes.key) and its secrecy. Combined with the reuse and 401/403 retry policy, an agent has everything needed to call and correctly handle the result.
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 'optional api_key.description', adding the optionality nuance, but says nothing about user_id, which is fully documented only inside the nested schema. Top-level coverage is low and the description only partially compensates, so a baseline 3 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 and resource ('Generate a Common Paper API key') and scopes it precisely to 'the current OAuth user'. No sibling tool does key generation, so the agent can route to this unambiguously.
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-call and when-not-to-call guidance: cache the key, only re-invoke on 401/403 or a missing stored key. This is exactly the routing/reuse policy an agent needs and leaves nothing to inference.
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, idempotentHint, and non-destructive behavior, so the safety profile is fully covered. The description adds one non-obvious behavioral caveat (fee fields depend on `standard_version`, defer to server instructions), but it says nothing about not-found/error behavior or permissions.
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, purpose front-loaded, with the caveat placed after the core statement. Every clause earns its place and there is 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, so return-shape explanation is unnecessary, and the description covers purpose plus a real interpretive pitfall. Only minor gaps remain, such as what happens for a missing or unauthorized UUID.
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% per the signals, so the description must carry the load; it does confirm the lookup key is a UUID. However, the single parameter is a self-evident resource identifier, so the description adds only marginal meaning beyond the schema's format/pattern constraints.
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 even enumerates the returned aspects (parties, terms, status), which cleanly separates it from list-agreements. It does not explicitly name a sibling like get-agreement-history, so differentiation is implicit rather than stated.
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: fetch a single agreement when you have its UUID. The CSA-fee note is about interpreting results rather than choosing between tools, and there is no statement of when not to use it or which alternative to pick instead.
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, idempotentHint=true, destructiveHint=false, and openWorldHint=false, so the safety profile is fully covered structurally. The description adds only that the result describes actors and timestamps; it says nothing about ordering, pagination, or retention, so it adds limited value beyond 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?
A single tightly written sentence with the resource and the returned information front-loaded and no filler whatsoever.
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 detail is not required, and one required parameter keeps the surface small. Still, the absence of any routing against 'list-agreement-history' and any note about ordering or result size leaves an agent with an incomplete picture of when this tool is the right choice.
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%, and the description never mentions the single required 'id' path parameter or that it must be the agreement UUID. It only weakly implies the parameter by saying the history belongs to 'an agreement', leaving the schema to carry the burden.
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 ('event history for an agreement') plus the payload semantics ('who changed what and when'). However, it does nothing to distinguish itself from the sibling 'list-agreement-history', so an agent cannot tell the two apart from the description 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?
There is no explicit when-to-use guidance, no prerequisites, and no mention of the alternative 'list-agreement-history' or 'get-agreement'. The agent must infer that this retrieves history for a single agreement.
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, idempotentHint=true and destructiveHint=false, so the safety profile is fully covered by structured data. The description adds one genuinely non-redundant behavioral fact – that the response includes the current version's YAML – but says nothing about format, errors, or permissions.
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 resource and the key identifier constraint appear before the return-payload detail.
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 already exists, so return values need not be explained, and annotations carry the safety profile. The remaining gap is guidance on when to choose this tool over list-custom-templates or get-template, which the description leaves unaddressed.
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 low schema coverage; the description compensates by stating the identifier is a UUID, matching the 'id' path param's meaning. It adds no format or validation detail beyond that, but the single-parameter surface keeps the gap small.
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 custom template') plus a scoping detail ('by UUID'), which clearly separates it from get-template and get-custom-term by resource type. It stops short of explicitly naming the sibling it is not.
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. Unlike a stronger sibling-routing definition, it never mentions list-custom-templates or get-template as alternatives, so the agent must infer usage 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 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 this as a read-only, idempotent, non-destructive, non-open-world fetch. The description adds one useful nuance beyond that: the response includes the full terms text of the released version, implying draft content is not returned. It says nothing about scoping or history, so it modestly exceeds the annotation baseline.
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 that conveys the identifier and the notable content of the response. Nothing redundant or 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 structure need not be explained, and the description still flags the meaningful payload detail (full released-version terms text). For a one-parameter read tool this is close to sufficient; only the released-vs-draft distinction could be stated more explicitly.
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, so the baseline is 4. The description confirms the lookup key is a UUID ('by UUID'), and the schema's id field already carries a UUID format, pattern, and description that reinforce this.
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 (custom terms) keyed by UUID, and clarifies that the full terms text of the released version is included. It does not explicitly differentiate itself from list-custom-terms or get-custom-template, but the UUID-based single-record fetch 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 indication of when to use this rather than list-custom-terms or get-custom-template, and no prerequisites or conditions given. Usage must be inferred entirely from the name and schema.
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 cover the safety profile (readOnly, idempotent, non-destructive, closed-world), so the bar is lower. The description adds real value by disclosing the cross-organization boundary behavior ('Returns 404 if it belongs to another organization'), which is not derivable from 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 with no waste: the core purpose is front-loaded and the 404 constraint follows immediately. Every 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?
An output schema exists so return values need not be explained, and annotations cover the safety profile. The cross-org 404 behavior completes the picture for a simple single-fetch tool; only auth prerequisites are left unstated.
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 required parameter, and the description merely says 'by id'. The schema itself documents the field as a UUID, so the description adds little beyond confirming the id identifies the invitation; baseline 3 applies for a single well-formed param.
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 is clearly distinguishable from the sibling list-invitations. It does not explicitly name the list alternative, but the singular 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?
Usage is implied by 'single invitation by id', so an agent can infer this is for fetching one record given a known id. There is no explicit statement of when to prefer this over list-invitations or when the id is valid, leaving routing to inference.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
Returns the signed-in user's profile and the Common Paper organization this connection acts on (organization_id and organization_name). Use it to identify the user and confirm which organization you are working in before reading or changing agreements.
| 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, idempotentHint, and destructiveHint=false, so the safety profile is covered. The description adds valuable behavioral context: that the response is scoped to the connection's acting organization, which is not derivable from 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?
Two sentences, front-loaded with the return content and followed by the usage rationale. Efficient, though it could be marginally tighter.
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?
Complete for a zero-parameter read tool with an output schema: it explains the identity and organization scope an agent needs to proceed with agreement operations.
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 are zero parameters, so the baseline is 4. The description correctly implies no inputs are needed and instead describes what is returned.
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 (returns) and resource (the signed-in user's profile and acting organization), naming the exact fields returned (organization_id, organization_name). This is distinguishable from siblings like get-user (which likely takes a user identifier) and get-organization.
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 for when to call: to identify the user and confirm the working organization before reading or changing agreements. It does not explicitly name get-user as an alternative or state an exclusion, 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.
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, idempotentHint=true, destructiveHint=false and openWorldHint=false, so the safety profile is fully covered. The description adds nothing beyond that – no note on error behavior for unknown UUIDs, permission requirements, or what fields come back.
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 resource with zero filler. Nothing could be trimmed 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?
For a simple read-by-id endpoint whose annotations cover the safety profile and which has an output schema documenting the return shape, the description covers the essentials. Only error/permission behavior is unaddressed, which is acceptable at this complexity.
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 0% schema description coverage, the description partially compensates by stating the identifier is a UUID, which matches the schema's format/pattern. However it adds no detail on where the id comes from or whether the pathParams wrapper is required.
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 (Get) and resource (organization), and 'by UUID' signals single-resource retrieval as distinct from the sibling list-organizations. It is unambiguous, though it never explicitly contrasts itself with list-organizations or update-organization.
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 mention of alternatives such as list-organizations for bulk retrieval. The only implied condition is that the caller already holds a UUID.
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, idempotentHint=true, destructiveHint=false and closed-world, so safety and repeatability are covered. The description adds the scope note that the resource can be either a standard or an uploaded PDF template, but says nothing about missing/archived templates or permission requirements.
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 sentence, action and key identifier front-loaded, no filler. The parenthetical adds distinct information about template kinds without bloating the line.
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-only GET with an output schema already describing the return payload, the description covers what the tool fetches and the two template flavors. The remaining gap is sibling disambiguation against get-custom-template, which is minor given the UUID-keyed lookup.
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 (pathParams.id) exists and schema coverage is 0%, so the description nominally must carry semantics. 'by UUID' essentially restates the schema's format:uuid and 'The UUID of the resource' rather than adding format examples or where to obtain the id.
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 concrete verb and resource ('Get template details') plus the identifier it takes (UUID). It implicitly separates itself from list-templates, but never names the close sibling get-custom-template, so an agent must infer the boundary between the two template types.
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 call this versus get-custom-template or list-templates, no prerequisite (where the UUID comes from), and no error/case guidance. The only usage hint is the parenthetical about standard vs uploaded PDF templates.
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, idempotentHint, and destructiveHint=false, so the safety profile is fully covered by structured data. The description's added content (name, email, role) describes the return payload, which is redundant given an output schema exists, and it adds no new behavioral context. A 3 reflects a description that neither contradicts nor meaningfully enriches 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?
A single front-loaded sentence with the action first and the identifier type immediately after, with zero filler. The trailing field list ('name, email, and role') is marginally redundant against the output schema, but it is compact enough not to hurt readability.
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?
Safety is covered by annotations, the return shape by the output schema, and the sole parameter by 'by UUID', so the essentials are present. The notable omission is a distinction from the sibling get-me, which is exactly the ambiguity an agent is most likely to hit for a 'get user' tool.
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 a single path parameter, so the description must carry the meaning — and 'by UUID' does precisely that, matching the schema's uuid format. With only one parameter, this single phrase is sufficient to convey how to supply it, though it doesn't restate the pattern or error behavior for malformed IDs.
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 ('Get user profile') and adds the identifier type ('by UUID'), which implicitly separates it from list-users. However, it never distinguishes itself from the sibling get-me (presumably the current authenticated user), which an agent must disambiguate when both exist.
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 'by UUID' qualifier implies the precondition (you must already have a user's UUID), which is useful implied guidance. But there is no explicit when-to-use note and no naming of alternatives such as get-me or list-users, so the routing decision is left to inference.
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 readOnly, idempotent, non-destructive, and closed-world, so safety is covered. The only added context is the org-wide scope; nothing is said about pagination defaults, result volume, or what constitutes a 'history event'.
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, front-loaded sentence with no filler. However, the brevity comes from under-specification rather than disciplined editing.
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 needn't be explained, but the description omits what a history event is (status change, version, edit?), how it relates to get-agreement-history, and any hint at the available filtering/paging surface that dominates 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?
The single nested queryParams object has five sub-properties with clear schema descriptions for paging and date/agreement filters, so the schema largely carries this dimension. The description adds nothing about which filters matter or typical usage patterns.
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 history events) plus an org-wide scope. It doesn't name the sibling get-agreement-history, so the boundary between org-wide listing and single-agreement retrieval is only implied.
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 exclusions, and no pointer to get-agreement-history, which is the obvious alternative for a single agreement. The agent must infer routing from the sibling's name 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 readOnlyHint, idempotentHint, non-destructive, and closed-world, so the safety profile is fully covered elsewhere. The description adds no behavioral context of its own — no pagination behavior, no mention that filtering is exact-match vs contains, and an unsupported sorting claim.
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 padding. It is efficiently written; the problem is omission, not verbosity.
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 needn't be described, but the description omits pagination semantics (default 15 per page), the significance of `full` for nested sub-models, and the pointer to list-agreement-types for valid filter values — all things an agent needs. The fabricated sorting capability further undermines completeness.
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% for the required `queryParams` wrapper, so the description must compensate and does not. It merely restates three field names that already carry rich nested descriptions (including the non-obvious `full` flag and the case-sensitive agreement_type lookup via list-agreement-types).
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 ("List agreements") that an agent can immediately understand. It does not distinguish this from siblings such as get-agreement, list-agreement-history, or list-agreement-types, so the agent must infer the boundary 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 second sentence hints at filtering capability but never says when to use this versus get-agreement (single record) or list-agreement-history (audit trail). It also claims you can "sort by created_at, status, agreement_type" while the schema exposes no sort parameter at all, which actively misleads.
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, idempotentHint=true, destructiveHint=false and a closed-world scope, so the safety profile is fully covered. The description adds only that the list is exhaustive ('all possible'), which is modest value beyond the structured data.
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 seven-word sentence with the scope qualifier ('all possible') front-loaded and no filler. Nothing to trim.
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 explain return values, and the annotations carry the behavioral profile. The only shortfall is the lack of routing guidance versus the sibling list-agreement-types, which is a minor gap for a trivial zero-param enumeration tool.
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 baseline of 4 applies; there is no parameter semantics for the description to clarify and no schema gap 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 status values') with scope ('all possible'). It is distinguishable from siblings like list-agreement-types and list-agreements, though it never explicitly contrasts itself with list-agreement-types, which could confuse an agent choosing between the two enumeration 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?
The intent (enumerate valid status values, presumably for filtering or interpretation) is implied by 'all possible agreement status values', but there is no explicit when-to-use, no mention of an alternative like list-agreement-types, and no indication of how to apply the results.
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, idempotentHint=true, destructiveHint=false and openWorldHint=false, so safety and idempotency are covered. The description adds only that custom organization-specific types are included, which is genuinely useful but minimal, and it says nothing about ordering or pagination 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?
A single front-loaded sentence with no filler; the qualifier about custom types is the one detail that 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 need not be described, and no parameters exist to document. For a simple read-only enumeration the description is adequate, missing only minor detail such as whether results are paginated or sorted.
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 baseline is 4; there is no parameter syntax or semantics for the description to explain. The empty schema and description are consistent with each other.
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 clarifies scope by naming custom organization types. It reads clearly against siblings like list-agreement-statuses, though it does not explicitly distinguish itself from that near-neighbor.
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 list-agreement-statuses or list-agreements. The agent must infer from the name alone that this is the enumeration endpoint for categorization.
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, idempotentHint=true, and destructiveHint=false, so the safety profile is fully covered by structured data. The description adds the organization-wide scope, which is useful, but discloses nothing about pagination, result size limits, or return shape. A 3 is appropriate given annotations carry the behavioral burden.
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 or redundancy. It is efficient, though arguably so terse that it omits potentially useful framing about what a returned attachment contains.
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 tool with annotations covering safety, the description is close to sufficient. However, with no output schema, it never indicates whether results are paginated or what fields an attachment record includes, leaving a real gap for an agent deciding how to consume the result.
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 schema-baseline is 4. The description correctly adds no parameter detail because there is nothing to describe, and 'in your organization' implicitly clarifies the query scope.
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 ('List') and resource ('file attachments') with an explicit scope ('in your organization'). It is clear what the tool does, but it does not distinguish itself from the many sibling list-* tools or mention its relationship to upload-attachment/archive-attachment.
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 alternatives (e.g., upload-attachment or archive-attachment as the write counterparts), and no exclusions. The only contextual hint is the 'in your organization' scope, which is minimal routing information.
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, idempotentHint=true, destructiveHint=false, openWorldHint=false, so safety profile is covered. The description adds a minor clarification about YAML-defined templates and current_definition meaning, but does not add behavioral traits beyond structural context. With annotations covering the bar, this is a low adding-value score, but not a contradiction.
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 concise sentences, front-loaded with the action and resource, then a useful clarification about the data model. 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?
The tool has an output schema, so return values need not be explained. However, the description lacks usage guidance, doesn't mention pagination behavior, and doesn't differentiate from siblings. It is minimally adequate but leaves gaps for an agent to know when to invoke it vs alternatives.
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 queryParams' nested page[size] and page[number] properties, but the description does not explain pagination or the parameters. However, the description does clarify the meaning of a returned field (current_definition), which is not a parameter. The schema itself documents page[size] and page[number] with defaults. Since the description doesn't compensate for the 0% coverage on parameters, and only addresses a return field, baseline 3 is generous; but given the nested object is only pagination and defaults are explicit in schema, 3 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 (List) and resource (custom templates), and distinguishes from the sibling list-templates by qualifying 'YAML-defined'. However, it doesn't differentiate from create/get/update/archive variants of custom templates beyond the listing action.
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 mention of alternatives. It does not say when to use this versus get-custom-template or list-templates. Implied usage only by the verb 'List'.
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 readOnlyHint=true, idempotentHint=true, destructiveHint=false and openWorldHint=false, so the safety profile is covered. The description adds genuinely non-obvious return-content behavior: only ids and metadata come back and the terms text is deliberately omitted. It does not discuss pagination defaults, though the schema does.
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 filler, with the payload-scope caveat front-loaded before the alternative-tool pointer. Every clause carries information an agent needs.
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 annotations cover the safety profile. Combined with the explicit note that the terms body is omitted and the pointer to get-custom-term, 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?
The single top-level queryParams object carries no description (0% coverage at that level), and the description says nothing about paging. However, the nested page[size] and page[number] fields are documented in the schema itself with defaults, so the practical gap is small and the baseline of 3 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?
The description names a specific verb and resource ("List custom terms") and immediately scopes the payload ("ids and metadata only; the terms text is omitted"), which cleanly separates it from the sibling get-custom-term and from the create/update term tools. An agent can identify the tool 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?
It explicitly routes the agent to the alternative ("Use get-custom-term for the full body") with the condition that selects it, which is exactly the decision an agent faces here. It stops short of covering other usage context such as pagination strategy or when listing is unnecessary, so it is clear rather than exhaustive.
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, idempotentHint, and destructiveHint=false, so the safety profile is covered. The description adds the org-scoping behavior ('for your organization'), which is genuinely useful, but says nothing about pagination behavior or result volume. Minimal added value over annotations, so a 3.
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 the purpose front-loaded and no filler. Efficient, though it underspecifies rather than being optimally concise.
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 and annotations covering the safety profile, the description only needs to cover behavior and parameters. It is adequate on scope but omits pagination semantics and the required queryParams wrapper, leaving gaps for a list endpoint.
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 coverage is 0% and the required queryParams wrapper is undocumented anywhere, so the description must compensate but does not. It names only filter[status_eq] out of five nested properties and its example ('e.g. pending') merely repeats the schema enum, leaving page[size], page[number], filter[access_eq], and filter[source_email_eq] unaddressed.
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: 'List invitations for your organization'. An agent can distinguish it from get-invitation (single item). It does not explicitly name a sibling alternative, 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 only guidance is a filter example (filter[status_eq] = pending), which is parameter help rather than when-to-use. It never says when to prefer this over get-invitation or how it relates to list-users, and gives no exclusions or prerequisites.
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, idempotentHint=true and destructiveHint=false, so the safety profile is covered without the description. The description does add a real behavioral fact — the result set is scoped to organizations the authenticated user can access — but says nothing about pagination behavior or how large result sets are 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 zero filler; the meaningful constraint (user-scoped access) is stated immediately. It is arguably too terse for the gaps it leaves, 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 values need no explanation, and annotations fully cover safety. For a simple read-only list endpoint the description is close to complete; only the pagination guidance 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%, and the description never mentions that queryParams carries the pagination controls or what defaults apply. The nested page[size]/page[number] fields do have their own descriptions, but the top-level queryParams wrapper is undocumented in both the schema and the description.
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 (organizations) plus a scope qualifier (accessible to the authenticated user), which distinguishes it from get-organization and update-organization. It stops short of naming any sibling explicitly, but the 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?
The description gives no when-to-use guidance, no indication of when to prefer this over get-organization, and says nothing about paging through results despite the schema exposing page[size]/page[number]. Usage is only implied by the verb.
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, idempotentHint, and destructiveHint=false, so the safety profile is covered. The description adds a useful scoping note that uploaded PDF templates are included, but says nothing about pagination behavior or how the optional 'full' flag changes the response, which are real behavioral considerations.
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 wasted words. Efficient, though its brevity contributes to the missing usage and parameter context.
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 nested pagination/full params are documented in the schema. Still, for a tool whose 'full' flag materially changes the shape and volume of results, the description leaves the agent without any high-level cue about pagination or response richness.
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 top-level queryParams parameter has no description and the reported schema description coverage is 0%. The description mentions no parameters at all, so it does not compensate for the gap around pagination and the type-specific 'full' expansion, even though the nested schema properties happen to carry descriptions.
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 templates) and scopes it by noting uploaded PDF templates are included. However, it does not distinguish itself from close siblings such as list-custom-templates or list-agreement-types, so an agent cannot route between them on the description 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?
There is no guidance on when to use this tool versus alternatives like list-custom-templates or get-template, and no stated prerequisites or exclusions. The agent must infer usage purely from the name.
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, idempotentHint, destructiveHint and openWorldHint, so the safety profile is covered. The description adds the useful organizational scoping constraint, but says nothing about pagination, result ordering, or volume limits for a potentially large listing.
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 wasted words. It is efficient, though arguably pared down to the point of under-specification given the tool's filtering capability.
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, the description omits the filtering capability and any routing against get-user, leaving meaningful gaps for a listing tool with nested filter params.
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 queryParams object, and the description says nothing about parameters at all. It even implies an unfiltered "list all" while the schema exposes email_eq and email_cont filters, so the description 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 ("List") and resource ("users") with an added tenancy scope ("in your organization"), which separates it from siblings like list-templates or list-agreements. It does not, however, distinguish the plural listing from the single-resource get-user 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?
No explicit when-to-use or when-not-to-use guidance is given, and no alternative is named. The phrase "all users in your organization" only weakly implies bulk listing as opposed to get-user for a single user.
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 declare destructiveHint=true, readOnlyHint=false, idempotentHint=false, and openWorldHint=true, so the safety profile is covered. The description adds no behavioral context beyond them: it does not say whether the previous recipient loses access, whether a notification is sent, or whether existing signatures are invalidated — significant omissions for a destructive reassignment.
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 the core action front-loaded and no padding. The second sentence is only a docs pointer, which is acceptable but not additive.
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 nested-body, destructive mutation with no output schema and no documented parameter semantics, so the description carries most of the explanatory burden — and it does not. An agent could call it, but would lack the operational context needed to do so confidently.
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%, and the description only mentions name and email. It does not explain the required agreement UUID path parameter, the optional 'comments' field, or the meaningful 'add_recipient_as_cc' flag that changes who retains visibility.
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 ('Reassign an agreement') and the payload it carries ('new name and email'), which distinguishes it from resend-agreement-email and update-draft-agreement. It does not explicitly name those near-siblings, but the operation 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 reassign versus resend-agreement-email, void-agreement, or update-draft-agreement, and no stated prerequisites (e.g. agreement must be in a particular status). The agent must infer usage entirely.
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, idempotentHint=false, destructiveHint=true, so the safety profile is covered. The description adds only that it re-sends the *last* notification rather than composing new content, and says nothing about the non-idempotent consequence (each call sends another email) or failure modes.
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 front-loaded sentence with zero waste. It is appropriately sized for a trivial single-parameter tool, though it is arguably terse enough to leave the gaps noted above.
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 non-idempotent, destructive-hinted mutation with no output schema and an undocumented parameter, the description omits preconditions, side effects, and failure behavior. It is not sufficient to call the tool confidently beyond the happy path.
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 single `id` is generically described as 'the UUID of the resource.' The description never mentions the identifier or clarifies that it is the agreement ID, so it does not 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?
Specific verb+resource: 'resend the last notification email to the agreement recipient.' An agent can distinguish this from send-agreement (initial send) and void-agreement without opening a schema. It never names those siblings explicitly, so it falls 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?
No when-to-use statement, no alternatives named, and no prerequisites. It does not say whether this requires the agreement to already be in a sent/signed state, or when to prefer a fresh send-agreement call over a resend.
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 destructive=true, openWorldHint=true, idempotentHint=true and readOnlyHint=false, so the safety profile is covered. The description adds genuine context beyond them by naming the exact state transition the operation triggers, which tells the agent what the side effect is rather than just that one 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?
Two tight sentences with no filler. The action and its state transition come first, with the precondition second — well 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?
For a mutation tool with annotations covering the safety profile and no output schema, the description supplies the two things that matter most: the precondition and the resulting state. It could go further on failure modes (e.g. what happens if the agreement is not in draft), but it is largely sufficient.
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 UUID path parameter, and the description's 'draft agreement' wording reinforces that the id must reference a draft. The schema already carries a description for the id field, so the description adds only marginal meaning. Baseline 3 for a one-parameter tool whose schema does most of the work.
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 (send) and resource (draft agreement) plus the recipient, and the state transition '(draft → sent_waiting_for_initial_review)' makes it distinguishable from siblings like resend-agreement-email and void-agreement. It stops short of naming any sibling explicitly, so it is clear but not fully self-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?
The precondition 'Agreement must be in draft status' tells the agent when this call is valid, which is useful. However it does not contrast with the obvious alternative 'resend-agreement-email' for agreements already sent, leaving the choice between the two to inference.
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, idempotentHint=true and readOnlyHint=false, so the safety profile is covered. The description adds non-obvious consequences the annotations cannot express: a terms change publishes a NEW template version, and user_id records who published it. It does not mention the 422 failure mode for a foreign user_id, which lives only 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?
Three sentences, zero filler, front-loaded with the two mutating actions before the parameter contract and the alternative tool. 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 values need no explanation, and the description covers both mutation modes plus the sibling hand-off. It stops short of noting that an invalid user_id yields 422 or that the operation is idempotent, both of which matter for a destructive tool.
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 50% schema coverage, the description must carry weight, and it does: it explains that custom_term_id links terms, an empty string unlinks (a non-obvious contract), and that user_id records the publisher. It does not explain the body/pathParams nesting or the full UUID id parameter, leaving some compensation 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 ('Rename a custom template or change its linked custom terms'), and immediately separates itself from the sibling that handles YAML edits ('create-custom-template-version'). An agent can distinguish it from update-custom-term and update-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 an explicit when-not rule with a named alternative: 'YAML changes go through create-custom-template-version instead.' This is the exact routing information an agent needs when several update-* siblings exist.
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 destructive=false-idempotent-and mutable (readOnlyHint=false, destructiveHint=true, idempotentHint=true). The description adds meaningful domain context by explaining the versioning model: versions are immutable and only the name may change here, which clarifies why a rename is the sole mutation available.
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 action and followed by the routing constraint. No filler or repetition of the field 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?
With an output schema present and annotations covering the safety profile, the description needs only to convey scope and the immutability rule, which it does. It stops short of noting permission requirements or what happens to prior names, a minor gap for a simple rename.
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 two parameters beyond the verb 'rename'. The schema itself does document both the id (UUID target) and name fields in detail, so the schema does the heavy lifting for parameter meaning; a baseline 3 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 and resource ('Rename custom terms') and immediately names the sibling that handles the other operation (create-custom-term-version). An agent can distinguish this from update-custom-template and create-custom-term-version 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?
Explicitly states when to use it (renaming) and when not to (content/terms-text changes), and routes to the correct alternative (create-custom-term-version). This is exactly the when/when-not/alternative pattern.
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 already declare destructive=true and idempotent=false, so the safety profile is known. The description adds genuine behavioral context beyond that: partial-update semantics ('only the fields you send change'), the agreement-type-specific term object requirement, the need to carry an existing term id from get-agreement, and that missing it causes rejection. It stops short of saying what a destructive edit can irrecoverably overwrite (e.g. attachment_ids replacing the list), which keeps it from 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?
Four sentences, zero filler, and the constraints (draft-only, partial update, term id requirement, send-agreement alternative) are front-loaded in that order of importance.
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 the key call-time gotchas for a mutation with a deeply nested polymorphic body. It could say more about how the custom-template variant (custom_field_values) differs, but the schema's anyOf branches carry that.
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 two top-level parameters exist and schema description coverage is reported at 0%, so the description has to carry the load for the body shape. It does useful work by explaining the polymorphic pattern — send the term object the agreement type owns (csa_attributes, design_partner_attributes, etc.) with that term's existing id — which is the non-obvious part of constructing the body. It doesn't enumerate the per-type mappings fully, so a 4 rather than 5.
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 opens with a specific verb and resource ('Edit a draft agreement in place') and immediately bounds the scope to drafts. It is distinguishable from sibling tools like send-agreement and create-agreement 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?
It states the hard precondition (only drafts in draft status can be edited) and explicitly routes to the alternative: 'Use send-agreement when the draft is ready.' Both when-to-use and when-to-switch are spelled out.
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 non-read-only, destructive and idempotent, so the safety profile is covered. The description adds genuine behavioral context beyond that: the tenant-scoping rule with its concrete failure mode (404) and the patch-style merge semantics ("only fields you provide are changed"). It stops short of saying what makes this destructive or whether the update is reversible.
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 short, front-loaded sentences: what it does, the hard precondition, then the merge behavior. No filler and no restatement of the name or annotations.
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 the safety and idempotency profile. For a nested, tenant-scoped mutation the description supplies the critical constraint and merge rule; the only gap is the lack of guidance on error recovery or when this tool is the right choice versus sibling update tools.
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% — neither the body wrapper nor pathParams carry a description — so the description must carry weight. It does clarify the id constraint and that omitted organization fields are preserved, but the nested field descriptions in the schema already repeat the merge semantics, and the description adds nothing about the body/pathParams structure 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 and resource ("Update organization settings") that an agent can distinguish from the read-side siblings like get-organization and list-organizations. It does not explicitly name those siblings, but the mutation framing 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 real precondition — the URL id must match the API key's organization or the call returns 404 — which is essential usage guidance for a tenant-scoped tool. However, it never states when to prefer this over update-custom-template/update-template or what to do if the org mismatch error occurs, so alternatives are left to inference.
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 | ||
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare destructiveHint=true, idempotentHint=true and readOnlyHint=false, so the safety profile is covered. The description still adds real value beyond them: partial-update semantics ('Only provided fields change') and an immutability constraint ('template type cannot be changed') that an agent could not infer from structured fields. It says nothing about permissions or downstream effects on agreements already created from the template.
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 short sentences, each front-loaded with a distinct fact: the operation, the schema-matching prerequisite, and the partial-update/immutability rules. No filler at all.
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 an output schema exists and annotations cover mutability, the description is nearly sufficient. The remaining gap is that it does not say how to discover the agreement type values or what happens on a mismatched body variant, which matters for a schema this polymorphic.
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% at the top level, so the description must carry weight, and it does: it explains that 'body' must conform to one of many agreement-type variants, which is the single most important thing to know about this polymorphic anyOf schema. It does not explain the pathParams id or the shape of the individual variant fields, but the variant-selection hint is the highest-value piece of guidance available.
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 ('Update an existing template') in the first sentence, leaving no doubt about the operation. It does not, however, distinguish itself from the sibling 'update-custom-template', which an agent could easily confuse with it.
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 instruction to 'Match request schema to the template's agreement type (from get-template)' gives a concrete prerequisite call and the condition that selects the correct body variant. There is no explicit when-not guidance or naming of alternatives such as update-custom-template, so it falls 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.
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?
Adds substantial behavior beyond the annotations: the call returns a curl_command with a shell-escaped path that must be run verbatim, and the uploader is taken from the OAuth identity so uploaded_by must be omitted. Annotations only give the generic mutation profile (readOnly=false, destructive=false, idempotent=false); the description covers the two-step flow and auth. It does not say what happens on re-upload or whether the returned command can fail independently, which keeps it short of 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?
Front-loaded with the key constraint, then requirements, then pitfalls. Dense and mostly waste-free, though the trailing run of 'do not' instructions (base64, generate-api-key, uploaded_by) partially repeats what earlier sentences already implied.
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 doesn't need to enumerate return fields — yet it still flags the one non-obvious return element, curl_command. For a tool with a three-branch anyOf body and a mandatory post-step, coverage is strong; a sentence on which schema branch an MCP client should target would make it complete.
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 is undocumented), so the description must carry the field semantics, and it does: filename is a required local PDF path with no control characters, name is optional and only for overriding the basename, description is optional, uploaded_by is forbidden. It stops short of explaining how the anyOf body variants map to the three schema branches.
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?
Opens with a specific verb + resource and a scope-defining mechanism: 'Upload a PDF attachment without sending file bytes through this tool.' The last sentence distinguishes it from the base64 path and names the sibling generate-api-key as the wrong tool, so an agent can route correctly 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?
Clear usage context: send metadata only, don't base64-encode, don't use generate-api-key. It implicitly excludes the multipart/base64 variants of the upload but never names upload-attachment_multipart_form_data as the alternative, so the when-to-use-vs-sibling choice is inferred rather than stated.
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 cover safety (readOnly=false, destructive=false, idempotent=false, openWorld=false), so the bar is lower, and the description adds real context beyond them: the tool returns JSON with a pre-shell-escaped curl_command, the OAuth-authenticated user is recorded as uploader, and filename must be free of control characters. It stops short of saying what happens on a repeat upload (no idempotency discussion) despite idempotentHint=false.
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-loads the core mechanic in the first clause, then lists required/optional fields and prohibitions in a compact sequence with no filler. Slightly overlaps the nested schema text, but each sentence carries an operational instruction an agent needs.
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 unnecessary, yet the description still flags the one return field the agent must act on (curl_command) and warns against editing it. Combined with the identity and escaping rules, an agent has everything needed to invoke this correctly via the metadata path.
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?
Adds meaning beyond the schema: filename is a local PDF path (not bytes), name is only needed when it should differ from the file basename, description is free-form, and uploaded_by must be omitted because the server derives it. It does not explain the other two schema branches (base64 and multipart variants), leaving that mode selection undocumented in the description.
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') plus the unusual mechanic ('without sending file bytes through this tool'), which is the key thing an agent must understand. It does not name the sibling upload-attachment_application_json, so the split between the metadata/curl path and the base64 path is left to the schema's anyOf branches.
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 concrete when-not rules: don't send uploaded_by (OAuth identity is used), don't base64-encode the PDF, don't use generate-api-key for uploads, and run the returned curl_command verbatim. These are clear operating conditions, though it never explicitly routes to an alternative tool for the case where a direct byte upload is required.
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, idempotentHint=true, and openWorldHint=true, so the safety profile is largely covered. The description adds the meaningful effect that the agreement becomes invalid/non-executable, but says nothing about reversibility, permissions, or side effects on related records.
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 verb and resource lead and the clarifying clause follows efficiently. Every word 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 destructive mutation with no output schema, the description covers purpose and effect and annotations cover the safety hints, but it omits prerequisites and downstream consequences. It is minimally adequate rather than fully informative.
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% and the description adds no parameter detail. However, there is only a single self-evident identifier parameter, so the missing explanation has limited impact on correct invocation.
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 ("Void") and resource ("agreement") and clarifies the effect ("no longer valid or executable"). It is clearly distinct from siblings like get-agreement, create-agreement, and update-draft-agreement, though it does not explicitly name or route away from any 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?
The description gives no guidance on when to void versus archive or otherwise terminate an agreement, no prerequisites (e.g., required permissions or agreement state), and no exclusions. An agent must infer the usage context entirely.
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": {
- "enum": [
- "signature",
- "date"
- ],
- "type": "string"
- },
- "framework_terms_type": {
- "type": "string"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "parent_agreement_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "underlying_agreement_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "underlying_agreement_type": {
- "type": "string"
- },
- "underlying_agreement_val": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "baa_attributes": {
- "additionalProperties": false,
- "description": "Override baa terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "aggregation_limitations_permitted": {
- "type": "boolean"
- },
- "aggregation_limitations_permitted_val": {
- "type": "string"
- },
- "breach_notification_unit": {
- "enum": [
- "hours",
- "business days",
- "calendar days"
- ],
- "type": "string"
- },
- "breach_notification_val": {
- "type": "number"
- },
- "business_associate_relationship_type": {
- "enum": [
- "provider",
- "company"
- ],
- "type": "string"
- },
- "deidentification_limitations_include_purpose": {
- "type": "boolean"
- },
- "deidentification_limitations_include_requirements": {
- "type": "boolean"
- },
- "deidentification_limitations_permitted": {
- "type": "boolean"
- },
- "deidentification_limitations_purpose_val": {
- "type": "string"
- },
- "deidentification_limitations_requirements_val": {
- "type": "string"
- },
- "designated_record_set_provider_maintains": {
- "type": "boolean"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_aggregation_limitations": {
- "type": "boolean"
- },
- "include_deidentification_limitations": {
- "type": "boolean"
- },
- "include_limitations": {
- "type": "boolean"
- },
- "include_offshore_limitations": {
- "type": "boolean"
- },
- "include_subcontract_limitations": {
- "type": "boolean"
- },
- "offshore_limitations_permitted": {
- "type": "boolean"
- },
- "offshore_limitations_permitted_val": {
- "type": "string"
- },
- "subcontract_limitations_include_notice": {
- "type": "boolean"
- },
- "subcontract_limitations_include_permission": {
- "type": "boolean"
- },
- "subcontract_limitations_notice_val": {
- "type": "string"
- },
- "subcontract_limitations_permission_val": {
- "type": "string"
- },
- "subcontract_limitations_permitted": {
- "type": "boolean"
- },
- "underlying_agreement_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "underlying_agreement_type": {
- "enum": [
- "internal",
- "external",
- "none"
- ],
- "type": "string"
- },
- "underlying_agreement_val": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "billing_email": {
- "description": "Email of the billing contact. Used when include_billing_info is true.",
- "format": "email",
- "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
- "type": "string"
- },
- "billing_name": {
- "description": "Name of the billing contact. Used when include_billing_info is true.",
- "type": "string"
- },
- "billing_workflow_type": {
- "description": "The type of billing workflow. Use \"link\" to provide a payment_link_url, or \"stripe\" for Stripe-managed billing.",
- "enum": [
- "link",
- "stripe"
- ],
- "type": "string"
- },
- "chosen_courts_country": {
- "description": "The country in which disputes will be resolved.",
- "type": "string"
- },
- "chosen_courts_region": {
- "description": "The state or region in which disputes will be resolved.",
- "type": "string"
- },
- "csa_attributes": {
- "additionalProperties": false,
- "description": "Override csa terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "customer_description": {
- "type": "string"
- },
- "effective_date": {
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "effective_date_marketplace": {
- "enum": [
- "AWS",
- "GCP",
- "Azure"
- ],
- "type": "string"
- },
- "effective_date_type": {
- "enum": [
- "signature",
- "date",
- "marketplace_acceptance"
- ],
- "type": "string"
- },
- "general_cap_amount": {
- "type": "number"
- },
- "general_cap_amount_type": {
- "enum": [
- "preceding",
- "base",
- "period"
- ],
- "type": "string"
- },
- "general_cap_period_currency": {
- "type": "number"
- },
- "general_cap_period_qty": {
- "type": "number"
- },
- "general_cap_preceding_amount": {
- "type": "number"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_acceptable_use_policy": {
- "type": "boolean"
- },
- "include_acceptable_use_policy_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_acceptable_use_policy_location": {
- "type": "string"
- },
- "include_acceptable_use_policy_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_additional_warranties": {
- "type": "boolean"
- },
- "include_additional_warranties_by_customer": {
- "type": "string"
- },
- "include_additional_warranties_by_provider": {
- "type": "string"
- },
- "include_additional_warranties_include_by_customer": {
- "type": "boolean"
- },
- "include_additional_warranties_include_by_provider": {
- "type": "boolean"
- },
- "include_ai_addendum": {
- "type": "boolean"
- },
- "include_ai_addendum_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_covered_claims": {
- "type": "boolean"
- },
- "include_covered_claims_customer_claims": {
- "type": "string"
- },
- "include_covered_claims_include_customer_claims": {
- "type": "boolean"
- },
- "include_covered_claims_include_provider_claims": {
- "type": "boolean"
- },
- "include_covered_claims_provider_claims": {
- "type": "string"
- },
- "include_dpa": {
- "type": "boolean"
- },
- "include_dpa_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_dpa_location": {
- "type": "string"
- },
- "include_dpa_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_increased_cap_amount": {
- "type": "boolean"
- },
- "include_increased_claims": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_confidentiality": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_confidentiality_negligence": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_privsec": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_privsec_negligence": {
- "type": "boolean"
- },
- "include_increased_claims_include_other": {
- "type": "boolean"
- },
- "include_increased_claims_indemnification_obligation": {
- "type": "boolean"
- },
- "include_increased_claims_other": {
- "type": "string"
- },
- "include_insurance_minimums": {
- "type": "boolean"
- },
- "include_insurance_minimums_add_customer": {
- "type": "boolean"
- },
- "include_insurance_minimums_add_customer_com_gen_liability": {
- "type": "boolean"
- },
- "include_insurance_minimums_add_customer_cyber_liability": {
- "type": "boolean"
- },
- "include_insurance_minimums_add_customer_errors_omissions": {
- "type": "boolean"
- },
- "include_insurance_minimums_additional_information": {
- "type": "boolean"
- },
- "include_insurance_minimums_additional_information_text": {
- "type": "string"
- },
- "include_insurance_minimums_cyber_liability_aggregate": {
- "type": "number"
- },
- "include_insurance_minimums_cyber_liability_minimum": {
- "type": "number"
- },
- "include_insurance_minimums_employer_liability_aggregate": {
- "type": "number"
- },
- "include_insurance_minimums_employer_liability_minimum": {
- "type": "number"
- },
- "include_insurance_minimums_general_liability_aggregate": {
- "type": "number"
- },
- "include_insurance_minimums_general_liability_minimum": {
- "type": "number"
- },
- "include_insurance_minimums_include_cyber_liability": {
- "type": "boolean"
- },
- "include_insurance_minimums_include_employer_liability": {
- "type": "boolean"
- },
- "include_insurance_minimums_include_general_liability": {
- "type": "boolean"
- },
- "include_insurance_minimums_include_workers_compensation": {
- "type": "boolean"
- },
- "include_publicity_rights": {
- "type": "boolean"
- },
- "include_publicity_rights_type": {
- "enum": [
- "public",
- "non-public"
- ],
- "type": "string"
- },
- "include_security_policy": {
- "type": "boolean"
- },
- "include_security_policy_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_security_policy_fedramp_auth": {
- "type": "boolean"
- },
- "include_security_policy_hipaa": {
- "type": "boolean"
- },
- "include_security_policy_hitrust": {
- "type": "boolean"
- },
- "include_security_policy_include_annual_maintenance": {
- "type": "boolean"
- },
- "include_security_policy_include_location": {
- "type": "boolean"
- },
- "include_security_policy_include_other": {
- "type": "boolean"
- },
- "include_security_policy_include_reasonable_efforts": {
- "type": "boolean"
- },
- "include_security_policy_iso27001": {
- "type": "boolean"
- },
- "include_security_policy_location": {
- "type": "string"
- },
- "include_security_policy_other": {
- "type": "string"
- },
- "include_security_policy_pci1": {
- "type": "boolean"
- },
- "include_security_policy_pci2": {
- "type": "boolean"
- },
- "include_security_policy_penetration_testing": {
- "type": "boolean"
- },
- "include_security_policy_soc2": {
- "type": "boolean"
- },
- "include_security_policy_soc2_type2": {
- "type": "boolean"
- },
- "include_security_policy_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_supercap": {
- "description": "CSA 3.0 renamed `include_increased_cap_amount` to `include_supercap`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_increased_cap_amount`. Sending the other spelling returns a 422.",
- "type": "boolean"
- },
- "include_uncapped_claims": {
- "description": "CSA 3.0 renamed `include_unlimited_claims` to `include_uncapped_claims`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims`. Sending the other spelling returns a 422.",
- "type": "boolean"
- },
- "include_uncapped_claims_breach_of_confidentiality": {
- "description": "CSA 3.0 renamed `include_unlimited_claims_breach_of_confidentiality` to `include_uncapped_claims_breach_of_confidentiality`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_breach_of_confidentiality`. Sending the other spelling returns a 422.",
- "type": "boolean"
- },
- "include_uncapped_claims_breach_of_confidentiality_negligence": {
- "description": "CSA 3.0 renamed `include_unlimited_claims_breach_of_confidentiality_negligence` to `include_uncapped_claims_breach_of_confidentiality_negligence`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_breach_of_confidentiality_negligence`. Sending the other spelling returns a 422.",
- "type": "boolean"
- },
- "include_uncapped_claims_breach_of_privsec": {
- "description": "CSA 3.0 renamed `include_unlimited_claims_breach_of_privsec` to `include_uncapped_claims_breach_of_privsec`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_breach_of_privsec`. Sending the other spelling returns a 422.",
- "type": "boolean"
- },
- "include_uncapped_claims_breach_of_privsec_negligence": {
- "description": "CSA 3.0 renamed `include_unlimited_claims_breach_of_privsec_negligence` to `include_uncapped_claims_breach_of_privsec_negligence`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_breach_of_privsec_negligence`. Sending the other spelling returns a 422.",
- "type": "boolean"
- },
- "include_uncapped_claims_include_other": {
- "description": "CSA 3.0 renamed `include_unlimited_claims_include_other` to `include_uncapped_claims_include_other`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_include_other`. Sending the other spelling returns a 422.",
- "type": "boolean"
- },
- "include_uncapped_claims_indemnification_obligation": {
- "description": "CSA 3.0 renamed `include_unlimited_claims_indemnification_obligation` to `include_uncapped_claims_indemnification_obligation`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_indemnification_obligation`. Sending the other spelling returns a 422.",
- "type": "boolean"
- },
- "include_uncapped_claims_other": {
- "description": "CSA 3.0 renamed `include_unlimited_claims_other` to `include_uncapped_claims_other`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_other`. Sending the other spelling returns a 422.",
- "type": "boolean"
- },
- "include_unlimited_claims": {
- "type": "boolean"
- },
- "include_unlimited_claims_breach_of_confidentiality": {
- "type": "boolean"
- },
- "include_unlimited_claims_breach_of_confidentiality_negligence": {
- "type": "boolean"
- },
- "include_unlimited_claims_breach_of_privsec": {
- "type": "boolean"
- },
- "include_unlimited_claims_breach_of_privsec_negligence": {
- "type": "boolean"
- },
- "include_unlimited_claims_include_other": {
- "type": "boolean"
- },
- "include_unlimited_claims_indemnification_obligation": {
- "type": "boolean"
- },
- "include_unlimited_claims_other": {
- "type": "string"
- },
- "increased_cap_amount_currency": {
- "type": "number"
- },
- "increased_cap_amount_period_currency": {
- "type": "number"
- },
- "increased_cap_amount_period_qty": {
- "type": "number"
- },
- "increased_cap_amount_qty": {
- "type": "number"
- },
- "increased_cap_amount_type": {
- "enum": [
- "qty",
- "currency",
- "period"
- ],
- "type": "string"
- },
- "provider": {
- "type": "string"
- },
- "supercap_currency": {
- "description": "CSA 3.0 renamed `increased_cap_amount_currency` to `supercap_currency`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `increased_cap_amount_currency`. Sending the other spelling returns a 422.",
- "type": "number"
- },
- "supercap_period_currency": {
- "description": "CSA 3.0 renamed `increased_cap_amount_period_currency` to `supercap_period_currency`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `increased_cap_amount_period_currency`. Sending the other spelling returns a 422.",
- "type": "number"
- },
- "supercap_period_qty": {
- "description": "CSA 3.0 renamed `increased_cap_amount_period_qty` to `supercap_period_qty`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `increased_cap_amount_period_qty`. Sending the other spelling returns a 422.",
- "type": "number"
- },
- "supercap_qty": {
- "description": "CSA 3.0 renamed `increased_cap_amount_qty` to `supercap_qty`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `increased_cap_amount_qty`. Sending the other spelling returns a 422.",
- "type": "number"
- },
- "supercap_type": {
- "description": "CSA 3.0 renamed `increased_cap_amount_type` to `supercap_type`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `increased_cap_amount_type`. Sending the other spelling returns a 422.",
- "type": "number"
- }
- },
- "type": "object"
- },
- "csa_order_form_attributes": {
- "additionalProperties": false,
- "description": "Override csa order form terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "additional_changes": {
- "type": "string"
- },
- "additional_parameters_or_limitations": {
- "type": "string"
- },
- "affiliates_as_users": {
- "type": "boolean"
- },
- "cloud_service_description": {
- "type": "string"
- },
- "consumption_units": {
- "type": "string"
- },
- "fee_amount": {
- "type": "number"
- },
- "fee_custom_unit": {
- "type": "string"
- },
- "fee_period": {
- "enum": [
- "Subscription Period",
- "month",
- "year",
- "User",
- "Custom unit"
- ],
- "type": "string"
- },
- "fees_attributes": {
- "additionalProperties": {
- "anyOf": [
- {
- "additionalProperties": false,
- "description": "Fees::Flat (fee_type \"flat\"). A fixed recurring fee, e.g. a platform subscription. Set type to \"Fees::Flat\" or fee_type to \"flat\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "Fixed amount in the order form's fees_currency, charged per fee_period. A plain amount, not cents: 20 means 20.00.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"flat\". Alternative to type.",
- "enum": [
- "flat"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Flat\". Optional when fee_type is set.",
- "enum": [
- "Fees::Flat"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Discount (fee_type \"discount\"). A discount, as a fixed amount or a percentage, applied forever, once, or for a number of months. Set type to \"Fees::Discount\" or fee_type to \"discount\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "Discount size: an amount in fees_currency when discount_type is fixed_amount (a plain amount, not cents: 20 means 20.00), or a percentage (e.g. 10 for 10%) when it is percentage.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "discount_duration_amount": {
- "description": "Number of months the discount applies. Required when discount_duration_type is multiple_months.",
- "type": "number"
- },
- "discount_duration_type": {
- "description": "How long the discount applies. multiple_months also needs discount_duration_amount.",
- "enum": [
- "forever",
- "once",
- "multiple_months"
- ],
- "type": "string"
- },
- "discount_type": {
- "description": "Whether cost is a currency amount or a percentage.",
- "enum": [
- "fixed_amount",
- "percentage"
- ],
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"discount\". Alternative to type.",
- "enum": [
- "discount"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Discount\". Optional when fee_type is set.",
- "enum": [
- "Fees::Discount"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Cost (fee_type \"cost\"). A per-unit fee: price per unit times quantity, e.g. seats. Set type to \"Fees::Cost\" or fee_type to \"cost\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "Price per unit in fees_currency. The row total is quantity x cost. A plain amount, not cents: 20 means 20.00.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"cost\". Alternative to type.",
- "enum": [
- "cost"
- ],
- "type": "string"
- },
- "quantity": {
- "description": "Number of units.",
- "type": "number"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Cost\". Optional when fee_type is set.",
- "enum": [
- "Fees::Cost"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Attachment (fee_type \"attachment\"). A fee described in an uploaded attachment instead of in the table. Set type to \"Fees::Attachment\" or fee_type to \"attachment\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "attachment_id": {
- "description": "ID of an attachment uploaded with upload-attachment.",
- "type": "string"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"attachment\". Alternative to type.",
- "enum": [
- "attachment"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Attachment\". Optional when fee_type is set.",
- "enum": [
- "Fees::Attachment"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Graduated (fee_type \"graduated\"). Tiered pricing, with the price set per tier in graduated_fee_tiers_attributes. Set type to \"Fees::Graduated\" or fee_type to \"graduated\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"graduated\". Alternative to type.",
- "enum": [
- "graduated"
- ],
- "type": "string"
- },
- "graduated_fee_tiers_attributes": {
- "additionalProperties": {
- "additionalProperties": false,
- "properties": {
- "flat_price": {
- "type": "number"
- },
- "price_per_unit": {
- "type": "string"
- },
- "upper_limit": {
- "type": "number"
- }
- },
- "type": "object"
- },
- "description": "Graduated fee tiers. Use string keys such as \"0\", \"1\".",
- "propertyNames": {
- "type": "string"
- },
- "type": "object"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Graduated\". Optional when fee_type is set.",
- "enum": [
- "Fees::Graduated"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Included (fee_type \"included\"). An item included at no charge. Set type to \"Fees::Included\" or fee_type to \"included\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"included\". Alternative to type.",
- "enum": [
- "included"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Included\". Optional when fee_type is set.",
- "enum": [
- "Fees::Included"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Metered (fee_type \"metered\"). Usage-based pricing, billed per unit used. Set type to \"Fees::Metered\" or fee_type to \"metered\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "Price per unit of usage in fees_currency. A plain amount, not cents: 20 means 20.00.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"metered\". Alternative to type.",
- "enum": [
- "metered"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Metered\". Optional when fee_type is set.",
- "enum": [
- "Fees::Metered"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::OneTime (fee_type \"one_time\"). A one-time charge, such as a setup fee. Set type to \"Fees::OneTime\" or fee_type to \"one_time\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "One-time amount in fees_currency, charged once rather than per fee_period. A plain amount, not cents: 20 means 20.00.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"one_time\". Alternative to type.",
- "enum": [
- "one_time"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::OneTime\". Optional when fee_type is set.",
- "enum": [
- "Fees::OneTime"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Text (fee_type \"text\"). A fee term described in free text. Set type to \"Fees::Text\" or fee_type to \"text\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"text\". Alternative to type.",
- "enum": [
- "text"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Text\". Optional when fee_type is set.",
- "enum": [
- "Fees::Text"
- ],
- "type": "string"
- }
- },
- "type": "object"
- }
- ]
- },
- "description": "Fee table rows, keyed by string index (\"0\", \"1\", ...). Replaces the template's fees when provided. Each row sets type or fee_type to pick the fee class. Amounts are in the order form's fees_currency and, for recurring fees, are charged per fee_period.",
- "examples": [
- {
- "0": {
- "cost": 2000,
- "description": "Platform subscription",
- "type": "Fees::Flat"
- }
- },
- {
- "0": {
- "cost": 50,
- "description": "Seats",
- "fee_type": "cost",
- "quantity": 10
- },
- "1": {
- "cost": 10,
- "description": "Launch discount",
- "discount_duration_amount": 3,
- "discount_duration_type": "multiple_months",
- "discount_type": "percentage",
- "fee_type": "discount"
- }
- }
- ],
- "propertyNames": {
- "type": "string"
- },
- "type": "object"
- },
- "fees_currency": {
- "enum": [
- "USD",
- "EUR",
- "GBP",
- "CAD",
- "AUD",
- "SGD",
- "ILS",
- "JPY",
- "CHF",
- "HKD"
- ],
- "type": "string"
- },
- "fees_include_fee_increase_upon_renewal": {
- "type": "boolean"
- },
- "fees_include_fee_increase_upon_renewal_fee": {
- "type": "number"
- },
- "fees_include_fee_increase_upon_renewal_type": {
- "enum": [
- "will",
- "may"
- ],
- "type": "string"
- },
- "fees_inclusive_of_taxes": {
- "type": "boolean"
- },
- "framework_terms_type": {
- "enum": [
- "new",
- "existing",
- "description"
- ],
- "type": "string"
- },
- "free_trial_days": {
- "type": "number"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_additional_changes": {
- "type": "boolean"
- },
- "include_additional_parameters_or_limitations": {
- "type": "boolean"
- },
- "include_consumption": {
- "type": "boolean"
- },
- "include_fees": {
- "type": "boolean"
- },
- "include_fees_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_fees_include_attachment": {
- "type": "boolean"
- },
- "include_fees_other": {
- "type": "boolean"
- },
- "include_fees_other_val": {
- "type": "string"
- },
- "include_fees_table": {
- "type": "boolean"
- },
- "include_fees_table_period": {
- "enum": [
- "Subscription Period",
- "month",
- "year",
- "User"
- ],
- "type": "string"
- },
- "include_free_trial": {
- "type": "boolean"
- },
- "include_max_users": {
- "type": "boolean"
- },
- "include_pilot_period": {
- "type": "boolean"
- },
- "include_pilot_period_duration_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_pilot_period_duration_type": {
- "enum": [
- "day",
- "week",
- "month"
- ],
- "type": "string"
- },
- "include_pilot_period_include_fees": {
- "type": "boolean"
- },
- "include_pilot_period_include_fees_amount": {
- "type": "number"
- },
- "include_pilot_period_include_modifications": {
- "type": "boolean"
- },
- "include_pilot_period_include_modifications_description": {
- "type": "string"
- },
- "include_product_support": {
- "type": "boolean"
- },
- "include_product_support_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_product_support_description": {
- "type": "string"
- },
- "include_product_support_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_professional_services": {
- "type": "boolean"
- },
- "include_professional_services_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_professional_services_custom_name": {
- "type": "string"
- },
- "include_professional_services_description": {
- "type": "string"
- },
- "include_professional_services_end_date": {
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "include_professional_services_fees_description": {
- "type": "string"
- },
- "include_professional_services_include_end_date": {
- "type": "boolean"
- },
- "include_professional_services_include_fees_description": {
- "type": "boolean"
- },
- "include_professional_services_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_sla": {
- "type": "boolean"
- },
- "include_sla_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_sla_description": {
- "type": "string"
- },
- "include_sla_include_response_time": {
- "type": "boolean"
- },
- "include_sla_include_response_time_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_sla_include_response_time_credit": {
- "type": "number"
- },
- "include_sla_include_response_time_duration": {
- "enum": [
- "hour",
- "day",
- "week",
- "month",
- "hours"
- ],
- "type": "string"
- },
- "include_sla_include_response_time_support_channel": {
- "type": "string"
- },
- "include_sla_include_target_uptime": {
- "type": "boolean"
- },
- "include_sla_maintenance_notice": {
- "type": "boolean"
- },
- "include_sla_maintenance_window": {
- "type": "boolean"
- },
- "include_sla_maintenance_window_type": {
- "enum": [
- "standard",
- "none"
- ],
- "type": "string"
- },
- "include_sla_standard_maintenance_notice_qty": {
- "type": "number"
- },
- "include_sla_standard_maintenance_notice_unit": {
- "enum": [
- "hour",
- "day",
- "week",
- "month"
- ],
- "type": "string"
- },
- "include_sla_standard_maintenance_window_end_time": {
- "type": "string"
- },
- "include_sla_standard_maintenance_window_friday": {
- "type": "boolean"
- },
- "include_sla_standard_maintenance_window_monday": {
- "type": "boolean"
- },
- "include_sla_standard_maintenance_window_saturday": {
- "type": "boolean"
- },
- "include_sla_standard_maintenance_window_start_time": {
- "type": "string"
- },
- "include_sla_standard_maintenance_window_sunday": {
- "type": "boolean"
- },
- "include_sla_standard_maintenance_window_thursday": {
- "type": "boolean"
- },
- "include_sla_standard_maintenance_window_time_zone": {
- "type": "string"
- },
- "include_sla_standard_maintenance_window_tuesday": {
- "type": "boolean"
- },
- "include_sla_standard_maintenance_window_wednesday": {
- "type": "boolean"
- },
- "include_sla_standard_target_uptime": {
- "type": "number"
- },
- "include_sla_type": {
- "enum": [
- "description",
- "standard",
- "attachment"
- ],
- "type": "string"
- },
- "include_subscription_start_date": {
- "type": "boolean"
- },
- "include_subscription_start_date_date": {
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "include_usage_review": {
- "type": "boolean"
- },
- "include_usage_review_val": {
- "type": "string"
- },
- "include_use_limitations": {
- "type": "boolean"
- },
- "include_use_limitations_val": {
- "type": "string"
- },
- "invoice_period": {
- "enum": [
- "monthly",
- "quarterly",
- "semiannually",
- "annually",
- "Custom unit",
- "Monthly",
- "Quarterly",
- "Semiannually",
- "Annually"
- ],
- "type": "string"
- },
- "invoice_period_custom_unit": {
- "type": "string"
- },
- "max_consumption": {
- "type": "number"
- },
- "max_users": {
- "type": "number"
- },
- "negotiations_allowed": {
- "description": "When true, the recipient can propose changes to the order form, even when the agreement-level `negotiations_allowed` is false. This only covers the order form.",
- "type": "boolean"
- },
- "order_date_date": {
- "type": "string"
- },
- "order_date_other": {
- "type": "string"
- },
- "order_date_type": {
- "enum": [
- "signature",
- "date",
- "other"
- ],
- "type": "string"
- },
- "payment_period": {
- "type": "number"
- },
- "payment_period_timeframe": {
- "enum": [
- "Customer's receipt of invoice",
- "date of invoice"
- ],
- "type": "string"
- },
- "payment_period_unit": {
- "enum": [
- "day(s)",
- "week(s)",
- "month(s)",
- "marketplace_acceptance"
- ],
- "type": "string"
- },
- "payment_process_automatic_frequency": {
- "enum": [
- "monthly",
- "quarterly",
- "semiannually",
- "annually"
- ],
- "type": "string"
- },
- "payment_process_type": {
- "enum": [
- "automatic",
- "invoice",
- "custom",
- "marketplace_acceptance"
- ],
- "type": "string"
- },
- "payment_process_type_custom_val": {
- "type": "string"
- },
- "payment_process_type_invoice_amount": {
- "type": "number"
- },
- "payment_process_type_invoice_custom_unit": {
- "type": "string"
- },
- "payment_process_type_invoice_duration": {
- "enum": [
- "day",
- "week",
- "month",
- "year",
- "day(s)",
- "week(s)",
- "month(s)",
- "year(s)"
- ],
- "type": "string"
- },
- "payment_process_type_invoice_duration_start": {
- "enum": [
- "Customer's receipt of invoice",
- "date of invoice"
- ],
- "type": "string"
- },
- "payment_process_type_invoice_type": {
- "enum": [
- "monthly",
- "quarterly",
- "semiannually",
- "annually",
- "Custom unit"
- ],
- "type": "string"
- },
- "pilot_period_stripe_product_id": {
- "type": "string"
- },
- "service_credits_attributes": {
- "additionalProperties": {
- "additionalProperties": false,
- "properties": {
- "credit": {
- "type": "number"
- },
- "max": {
- "type": "number"
- },
- "min": {
- "type": "number"
- }
- },
- "type": "object"
- },
- "description": "Service credits. Use string keys such as \"0\", \"1\".",
- "propertyNames": {
- "type": "string"
- },
- "type": "object"
- },
- "subscription_auto_renew": {
- "enum": [
- "days",
- "subscription_end"
- ],
- "type": "string"
- },
- "subscription_period": {
- "type": "number"
- },
- "subscription_period_unit": {
- "type": "string"
- },
- "subscription_renewal_notice_days": {
- "type": "number"
- },
- "subscription_start_date": {
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "subscription_start_date_type": {
- "enum": [
- "effective_date",
- "date"
- ],
- "type": "string"
- },
- "underlying_agreement_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "use_limitations_attributes": {
- "additionalProperties": {
- "additionalProperties": false,
- "properties": {
- "amount": {
- "type": "number"
- },
- "limitation_type": {
- "type": "string"
- },
- "unit": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "description": "Use limitations. Use string keys such as \"0\", \"1\".",
- "propertyNames": {
- "type": "string"
- },
- "type": "object"
- }
- },
- "type": "object"
- },
- "custom_field_values": {
- "description": "Values for a custom template's fields, keyed by the field keys defined in the template's YAML definition. Only used when template_id is a custom template. Template defaults fill any fields you omit; a required field with no default and no submitted value returns a 400 naming the field. Values are validated against the field's input type: select and radio values must be one of the field's options, multiselect values are an array of selections each of which must be one of the field's options, number and currency values must be numeric, date values must be YYYY-MM-DD, and email values must be valid addresses. An invalid value returns a 400 naming the field."
- },
- "design_partner_attributes": {
- "additionalProperties": false,
- "description": "Override design partner terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "customer_description": {
- "type": "string"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_fees": {
- "type": "boolean"
- },
- "include_fees_amount": {
- "type": "number"
- },
- "include_fees_description": {
- "type": "string"
- },
- "include_fees_pay_by_amount": {
- "type": "string"
- },
- "include_fees_type": {
- "enum": [
- "default_language",
- "description"
- ],
- "type": "string"
- },
- "include_fees_unit": {
- "enum": [
- "month",
- "quarter",
- "year",
- "Term"
- ],
- "type": "string"
- },
- "include_program_appear_as_customer_private": {
- "type": "boolean"
- },
- "include_program_appear_as_customer_public": {
- "type": "boolean"
- },
- "include_program_case_study": {
- "type": "boolean"
- },
- "include_program_develop_functionality": {
- "type": "boolean"
- },
- "include_program_develop_functionality_val": {
- "type": "string"
- },
- "include_program_discount": {
- "type": "boolean"
- },
- "include_program_discount_amount": {
- "type": "number"
- },
- "include_program_discount_unit": {
- "enum": [
- "U.S. Dollars",
- "percent"
- ],
- "type": "string"
- },
- "include_program_participation_feedback": {
- "type": "boolean"
- },
- "include_program_participation_feedback_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_program_participation_feedback_unit": {
- "enum": [
- "month",
- "quarter",
- "year",
- "Term"
- ],
- "type": "string"
- },
- "include_program_partner_other": {
- "type": "boolean"
- },
- "include_program_partner_other_val": {
- "type": "string"
- },
- "include_program_provider_other": {
- "type": "boolean"
- },
- "include_program_provider_other_val": {
- "type": "string"
- },
- "include_program_reference": {
- "type": "boolean"
- },
- "product_description": {
- "type": "string"
- },
- "term_amount": {
- "type": "number"
- },
- "term_unit": {
- "enum": [
- "day(s)",
- "week(s)",
- "month(s)",
- "quarter(s)",
- "year(s)"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- "district_or_county": {
- "description": "The district or county for dispute resolution.",
- "type": "string"
- },
- "dpa_attributes": {
- "additionalProperties": false,
- "description": "Override dpa terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "approved_subprocessor_type": {
- "description": "`internal` lists approved subprocessors in the agreement (`subprocessors_attributes`); `external` points to a list published elsewhere.",
- "enum": [
- "internal",
- "external"
- ],
- "type": "string"
- },
- "cloud_service_product_name": {
- "type": "string"
- },
- "competent_supervisory_authority": {
- "type": "string"
- },
- "customer_description": {
- "type": "string"
- },
- "data_exporter_address_city": {
- "type": "string"
- },
- "data_exporter_address_country": {
- "type": "string"
- },
- "data_exporter_address_state": {
- "type": "string"
- },
- "data_exporter_address_street_address": {
- "type": "string"
- },
- "data_exporter_address_zipcode": {
- "type": "string"
- },
- "data_exporter_contact_details": {
- "type": "string"
- },
- "data_exporter_contact_name": {
- "type": "string"
- },
- "data_exporter_contact_position": {
- "type": "string"
- },
- "data_exporter_role": {
- "description": "Role of the data exporter. Overwritten to `Controller` when the agreement is created from a template.",
- "enum": [
- "Controller",
- "Processor"
- ],
- "type": "string"
- },
- "data_importer_address": {
- "type": "string"
- },
- "data_importer_address_city": {
- "type": "string"
- },
- "data_importer_address_country": {
- "type": "string"
- },
- "data_importer_address_state": {
- "type": "string"
- },
- "data_importer_address_street_address": {
- "type": "string"
- },
- "data_importer_address_zipcode": {
- "type": "string"
- },
- "data_importer_contact_details": {
- "type": "string"
- },
- "data_importer_contact_name": {
- "type": "string"
- },
- "data_importer_contact_position": {
- "type": "string"
- },
- "duration_of_processing": {
- "type": "string"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_covered_claim": {
- "type": "boolean"
- },
- "include_covered_claim_external_val": {
- "type": "string"
- },
- "include_covered_claim_internal_val": {
- "type": "string"
- },
- "include_covered_claim_type": {
- "description": "Which covered-claim text applies: `internal` uses `include_covered_claim_internal_val`, `external` uses `include_covered_claim_external_val`. Required when `include_covered_claim` is true.",
- "enum": [
- "internal",
- "external"
- ],
- "type": "string"
- },
- "include_data_subjects_custom": {
- "type": "boolean"
- },
- "include_data_subjects_custom_val": {
- "type": "string"
- },
- "include_data_subjects_employees": {
- "type": "boolean"
- },
- "include_data_subjects_end_users": {
- "type": "boolean"
- },
- "include_external_subprocessor_location": {
- "type": "string"
- },
- "include_frequency_of_transfer_continuous": {
- "type": "boolean"
- },
- "include_frequency_of_transfer_custom": {
- "type": "boolean"
- },
- "include_frequency_of_transfer_custom_val": {
- "type": "string"
- },
- "include_governing_country_eu": {
- "type": "boolean"
- },
- "include_governing_country_eu_val": {
- "type": "string"
- },
- "include_governing_country_uk": {
- "type": "boolean"
- },
- "include_governing_country_uk_val": {
- "type": "string"
- },
- "include_governing_law": {
- "type": "boolean"
- },
- "include_governing_law_country": {
- "type": "string"
- },
- "include_governing_law_state": {
- "type": "string"
- },
- "include_increased_claim_amount": {
- "description": "Legacy field. Stored but not shown on the DPA; use the `include_liability_cap*` fields instead.",
- "type": "boolean"
- },
- "include_increased_claim_amount_currency": {
- "description": "Legacy field. Stored but not shown on the DPA; use the `include_liability_cap*` fields instead."
- },
- "include_increased_claim_amount_qty": {
- "description": "Legacy field. Stored but not shown on the DPA; use the `include_liability_cap*` fields instead."
- },
- "include_increased_claim_amount_type": {
- "description": "Legacy field. Stored but not shown on the DPA; use the `include_liability_cap*` fields instead.",
- "type": "string"
- },
- "include_liability_cap": {
- "type": "boolean"
- },
- "include_liability_cap_amount_constant_external": {
- "type": "string"
- },
- "include_liability_cap_amount_constant_internal": {
- "type": "string"
- },
- "include_liability_cap_amount_currency_external": {
- "description": "Currency amount. Numbers and numeric strings (commas allowed) are both accepted."
- },
- "include_liability_cap_amount_currency_internal": {
- "description": "Currency amount. Numbers and numeric strings (commas allowed) are both accepted."
- },
- "include_liability_cap_csa_type": {
- "description": "Which liability cap values apply: the `_internal` or `_external` amount fields. Required when `include_liability_cap` is true.",
- "enum": [
- "internal",
- "external"
- ],
- "type": "string"
- },
- "include_personal_data_biographic_info": {
- "type": "boolean"
- },
- "include_personal_data_contact_info": {
- "type": "boolean"
- },
- "include_personal_data_custom": {
- "type": "boolean"
- },
- "include_personal_data_custom_val": {
- "type": "string"
- },
- "include_personal_data_employment_info": {
- "type": "boolean"
- },
- "include_personal_data_financial_info": {
- "type": "boolean"
- },
- "include_personal_data_location": {
- "type": "boolean"
- },
- "include_personal_data_name": {
- "type": "boolean"
- },
- "include_personal_data_transactional_info": {
- "type": "boolean"
- },
- "include_personal_data_user_activity_info": {
- "type": "boolean"
- },
- "include_processing_purpose_custom": {
- "type": "boolean"
- },
- "include_processing_purpose_custom_val": {
- "type": "string"
- },
- "include_processing_purpose_erasing": {
- "type": "boolean"
- },
- "include_processing_purpose_holding": {
- "type": "boolean"
- },
- "include_processing_purpose_protecting": {
- "type": "boolean"
- },
- "include_processing_purpose_receiving": {
- "type": "boolean"
- },
- "include_processing_purpose_returning": {
- "type": "boolean"
- },
- "include_processing_purpose_sharing": {
- "type": "boolean"
- },
- "include_processing_purpose_updating": {
- "type": "boolean"
- },
- "include_processing_purpose_using": {
- "type": "boolean"
- },
- "include_provider_security_contact_address": {
- "type": "boolean"
- },
- "include_provider_security_contact_address_city": {
- "type": "string"
- },
- "include_provider_security_contact_address_country": {
- "type": "string"
- },
- "include_provider_security_contact_address_state": {
- "type": "string"
- },
- "include_provider_security_contact_address_street_address": {
- "type": "string"
- },
- "include_provider_security_contact_address_zipcode": {
- "type": "string"
- },
- "include_provider_security_contact_email": {
- "type": "boolean"
- },
- "include_provider_security_contact_email_val": {
- "format": "email",
- "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
- "type": "string"
- },
- "include_security_measures_accountability": {
- "type": "boolean"
- },
- "include_security_measures_accountability_val": {
- "type": "string"
- },
- "include_security_measures_certification_or_assurance": {
- "type": "boolean"
- },
- "include_security_measures_certification_or_assurance_val": {
- "type": "string"
- },
- "include_security_measures_confidentiality_integrity": {
- "type": "boolean"
- },
- "include_security_measures_confidentiality_integrity_val": {
- "type": "string"
- },
- "include_security_measures_data_at_rest": {
- "type": "boolean"
- },
- "include_security_measures_data_at_rest_val": {
- "type": "string"
- },
- "include_security_measures_data_minimization": {
- "type": "boolean"
- },
- "include_security_measures_data_minimization_val": {
- "type": "string"
- },
- "include_security_measures_data_quality": {
- "type": "boolean"
- },
- "include_security_measures_data_quality_val": {
- "type": "string"
- },
- "include_security_measures_data_retention": {
- "type": "boolean"
- },
- "include_security_measures_data_retention_val": {
- "type": "string"
- },
- "include_security_measures_data_transmission": {
- "type": "boolean"
- },
- "include_security_measures_data_transmission_val": {
- "type": "string"
- },
- "include_security_measures_event_logging": {
- "type": "boolean"
- },
- "include_security_measures_event_logging_val": {
- "type": "string"
- },
- "include_security_measures_identity_auth": {
- "type": "boolean"
- },
- "include_security_measures_identity_auth_val": {
- "type": "string"
- },
- "include_security_measures_it_security_governance": {
- "type": "boolean"
- },
- "include_security_measures_it_security_governance_val": {
- "type": "string"
- },
- "include_security_measures_physical_security": {
- "type": "boolean"
- },
- "include_security_measures_physical_security_val": {
- "type": "string"
- },
- "include_security_measures_portability_and_erasure": {
- "type": "boolean"
- },
- "include_security_measures_portability_and_erasure_val": {
- "type": "string"
- },
- "include_security_measures_pseudonym_encryption": {
- "type": "boolean"
- },
- "include_security_measures_pseudonym_encryption_val": {
- "type": "string"
- },
- "include_security_measures_restore_data_access": {
- "type": "boolean"
- },
- "include_security_measures_restore_data_access_val": {
- "type": "string"
- },
- "include_security_measures_security_policy": {
- "type": "boolean"
- },
- "include_security_measures_system_configuration": {
- "type": "boolean"
- },
- "include_security_measures_system_configuration_val": {
- "type": "string"
- },
- "include_security_measures_testing_assessment": {
- "type": "boolean"
- },
- "include_security_measures_testing_assessment_val": {
- "type": "string"
- },
- "include_security_policy": {
- "type": "boolean"
- },
- "include_security_policy_fedramp_auth": {
- "type": "boolean"
- },
- "include_security_policy_hipaa": {
- "type": "boolean"
- },
- "include_security_policy_hitrust": {
- "type": "boolean"
- },
- "include_security_policy_include_other": {
- "type": "boolean"
- },
- "include_security_policy_iso27001": {
- "type": "boolean"
- },
- "include_security_policy_other": {
- "type": "string"
- },
- "include_security_policy_pci1": {
- "type": "boolean"
- },
- "include_security_policy_pci2": {
- "type": "boolean"
- },
- "include_security_policy_penetration_testing": {
- "type": "boolean"
- },
- "include_security_policy_soc2": {
- "type": "boolean"
- },
- "include_security_policy_soc2_type2": {
- "type": "boolean"
- },
- "include_sensitive_data_restrictions_custom": {
- "type": "boolean"
- },
- "include_sensitive_data_restrictions_custom_val": {
- "type": "string"
- },
- "include_sensitive_data_restrictions_security_policy": {
- "type": "boolean"
- },
- "include_service_provider_relationship": {
- "type": "boolean"
- },
- "include_special_category_data": {
- "type": "boolean"
- },
- "provider": {
- "type": "string"
- },
- "security_policy_available_at": {
- "type": "string"
- },
- "security_policy_type": {
- "description": "Where the Security Policy is defined. For `external`, set `security_policy_available_at`.",
- "enum": [
- "defined in agreement",
- "provider service",
- "external"
- ],
- "type": "string"
- },
- "subprocessors_attributes": {
- "additionalProperties": {
- "additionalProperties": false,
- "properties": {
- "_destroy": {
- "description": "Set to true with `id` to remove that subprocessor.",
- "type": "boolean"
- },
- "country": {
- "type": "string"
- },
- "id": {
- "description": "ID of an existing subprocessor to update or remove. Omit to add a new subprocessor.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "name": {
- "type": "string"
- },
- "processing_task": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "description": "Subprocessors, keyed by string index such as \"0\", \"1\". On create these are added to the template's subprocessors. On a draft update, an entry without `id` adds a new subprocessor; pass `id` to change one and `id` with `_destroy: true` to remove one.",
- "propertyNames": {
- "type": "string"
- },
- "type": "object"
- },
- "underlying_agreement_id": {
- "description": "ID of the CSA this DPA supplements when `underlying_agreement_type` is `internal`.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "underlying_agreement_type": {
- "description": "`internal` links a CSA in Common Paper (`underlying_agreement_id`); `external` describes another agreement in `underlying_agreement_val` (required). Omit for none.",
- "enum": [
- "internal",
- "external"
- ],
- "type": "string"
- },
- "underlying_agreement_val": {
- "description": "Description of the agreement this DPA supplements. Required when `underlying_agreement_type` is `external`.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "framework_terms_description": {
- "description": "Custom framework terms description. Only used when framework_terms_type is \"description\".",
- "type": "string"
- },
- "framework_terms_type": {
- "description": "How framework terms are specified. Use \"new\" for standard terms or \"description\" to provide a custom framework_terms_description.",
- "enum": [
- "new",
- "description"
- ],
- "type": "string"
- },
- "governing_law_country": {
- "description": "The country whose laws govern the agreement.",
- "type": "string"
- },
- "governing_law_region": {
- "description": "The state or region whose laws govern the agreement.",
- "type": "string"
- },
- "include_automated_payment_reminders": {
- "description": "When true, automatically sends payment reminder emails.",
- "type": "boolean"
- },
- "include_billing_info": {
- "description": "When true, billing contact information (billing_name, billing_email) is included.",
- "type": "boolean"
- },
- "include_billing_workflow": {
- "description": "When true, enables a billing workflow after signing.",
- "type": "boolean"
- },
- "include_expiration_date": {
- "description": "Expiration date in YYYY-MM-DD format. Use when include_expiration_type is \"date\".",
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "include_expiration_days": {
- "description": "Number of days until the agreement expires. Use when include_expiration_type is \"days\".",
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_expiration_type": {
- "description": "How to set expiration: \"none\" (default), \"days\" (use include_expiration_days), or \"date\" (use include_expiration_date).",
- "enum": [
- "none",
- "days",
- "date"
- ],
- "type": "string"
- },
- "include_terms": {
- "description": "When true, the standard terms are included with the agreement.",
- "type": "boolean"
- },
- "loi_attributes": {
- "additionalProperties": false,
- "description": "Override loi terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "confidentiality_custom": {
- "type": "string"
- },
- "confidentiality_mutual_include_loi": {
- "type": "boolean"
- },
- "confidentiality_nda_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "confidentiality_nda_description": {
- "type": "string"
- },
- "confidentiality_nda_include_loi": {
- "type": "boolean"
- },
- "confidentiality_nda_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "confidentiality_type": {
- "enum": [
- "mutual",
- "nda",
- "provider",
- "custom"
- ],
- "type": "string"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_custom_details": {
- "type": "boolean"
- },
- "include_custom_details_val": {
- "type": "string"
- },
- "include_fees": {
- "type": "boolean"
- },
- "include_fees_amount": {
- "type": "number"
- },
- "include_fees_amount_duration": {
- "enum": [
- "month",
- "year",
- "quarter"
- ],
- "type": "string"
- },
- "include_fees_include_amount": {
- "type": "boolean"
- },
- "include_fees_include_other": {
- "type": "boolean"
- },
- "include_fees_other": {
- "type": "string"
- },
- "include_functionality": {
- "type": "boolean"
- },
- "include_functionality_val": {
- "type": "string"
- },
- "include_launch_date": {
- "type": "boolean"
- },
- "include_launch_date_custom": {
- "type": "string"
- },
- "include_launch_date_date": {
- "format": "date-time",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$",
- "type": "string"
- },
- "include_launch_date_type": {
- "enum": [
- "date",
- "custom"
- ],
- "type": "string"
- },
- "product_name": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "manual_send": {
- "description": "When true, the agreement is marked as manually sent outside the platform.",
- "type": "boolean"
- },
- "message": {
- "type": "string"
- },
- "negotiations_allowed": {
- "description": "When true, the recipient can propose changes to the legal terms. For agreement types without separate business terms, that covers every term. CSA order forms, PSA statements of work, partnership business terms and software license order forms have their own `negotiations_allowed` flag.",
- "type": "boolean"
- },
- "partnership_attributes": {
- "additionalProperties": false,
- "description": "Override partnership terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "effective_date": {
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "effective_date_type": {
- "enum": [
- "signature",
- "date"
- ],
- "type": "string"
- },
- "general_cap_amount_currency_val": {
- "type": "number"
- },
- "general_cap_amount_either_currency": {
- "type": "number"
- },
- "general_cap_amount_either_multiple": {
- "type": "number"
- },
- "general_cap_amount_multiple_val": {
- "type": "number"
- },
- "general_cap_amount_type": {
- "enum": [
- "multiple",
- "currency",
- "either",
- "base"
- ],
- "type": "string"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_additional_warranties": {
- "type": "boolean"
- },
- "include_additional_warranties_include_company": {
- "type": "boolean"
- },
- "include_additional_warranties_include_company_val": {
- "type": "string"
- },
- "include_additional_warranties_include_partner": {
- "type": "boolean"
- },
- "include_additional_warranties_include_partner_val": {
- "type": "string"
- },
- "include_brand_guidelines": {
- "type": "boolean"
- },
- "include_brand_guidelines_include_company": {
- "type": "boolean"
- },
- "include_brand_guidelines_include_company_val": {
- "type": "string"
- },
- "include_brand_guidelines_include_partner": {
- "type": "boolean"
- },
- "include_brand_guidelines_include_partner_val": {
- "type": "string"
- },
- "include_covered_claims": {
- "type": "boolean"
- },
- "include_covered_claims_company_claims": {
- "type": "string"
- },
- "include_covered_claims_include_company_claims": {
- "type": "boolean"
- },
- "include_covered_claims_include_partner_claims": {
- "type": "boolean"
- },
- "include_covered_claims_partner_claims": {
- "type": "string"
- },
- "include_dpa": {
- "type": "boolean"
- },
- "include_dpa_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_dpa_location": {
- "type": "string"
- },
- "include_dpa_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_increased_cap_amount": {
- "type": "boolean"
- },
- "include_increased_cap_amount_currency": {
- "type": "number"
- },
- "include_increased_cap_amount_either_currency": {
- "type": "number"
- },
- "include_increased_cap_amount_either_multiple": {
- "type": "string"
- },
- "include_increased_cap_amount_multiple": {
- "type": "string"
- },
- "include_increased_cap_amount_type": {
- "enum": [
- "multiple",
- "currency",
- "either"
- ],
- "type": "string"
- },
- "include_increased_claims": {
- "type": "boolean"
- },
- "include_increased_claims_include_confidentiality": {
- "type": "boolean"
- },
- "include_increased_claims_include_confidentiality_misconduct": {
- "type": "boolean"
- },
- "include_increased_claims_include_covered_claims": {
- "type": "boolean"
- },
- "include_increased_claims_include_misconduct": {
- "type": "boolean"
- },
- "include_increased_claims_include_other": {
- "type": "boolean"
- },
- "include_increased_claims_include_other_val": {
- "type": "string"
- },
- "include_unlimited_claims": {
- "type": "boolean"
- },
- "include_unlimited_claims_confidentiality": {
- "type": "boolean"
- },
- "include_unlimited_claims_confidentiality_misconduct": {
- "type": "boolean"
- },
- "include_unlimited_claims_covered_claims": {
- "type": "boolean"
- },
- "include_unlimited_claims_misconduct": {
- "type": "boolean"
- },
- "include_unlimited_claims_other": {
- "type": "boolean"
- },
- "include_unlimited_claims_other_val": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "partnership_business_terms_attributes": {
- "additionalProperties": false,
- "description": "Override partnership business terms terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "end_date_after_effective_date_amount": {
- "type": "number"
- },
- "end_date_after_effective_date_unit": {
- "enum": [
- "month(s)",
- "quarter(s)",
- "year(s)"
- ],
- "type": "string"
- },
- "end_date_date": {
- "type": "string"
- },
- "end_date_type": {
- "enum": [
- "date",
- "effective date"
- ],
- "type": "string"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_obligations_company_brand": {
- "type": "boolean"
- },
- "include_obligations_company_promotion": {
- "type": "boolean"
- },
- "include_obligations_company_promotion_include_activities": {
- "type": "boolean"
- },
- "include_obligations_company_promotion_include_activities_val": {
- "type": "string"
- },
- "include_obligations_company_promotion_include_materials": {
- "type": "boolean"
- },
- "include_obligations_company_promotion_include_materials_val": {
- "type": "string"
- },
- "include_obligations_company_referral": {
- "type": "boolean"
- },
- "include_obligations_company_referral_include_criteria": {
- "type": "boolean"
- },
- "include_obligations_company_referral_include_criteria_val": {
- "type": "string"
- },
- "include_obligations_company_referral_include_pay_sch": {
- "type": "boolean"
- },
- "include_obligations_company_referral_include_pay_sch_amount": {
- "type": "number"
- },
- "include_obligations_company_referral_include_pay_sch_custom": {
- "type": "string"
- },
- "include_obligations_company_referral_include_pay_sch_unit": {
- "enum": [
- "U.S. Dollars",
- "percent"
- ],
- "type": "string"
- },
- "include_obligations_company_sponsorship": {
- "type": "boolean"
- },
- "include_obligations_company_sponsorship_include_benefits": {
- "type": "boolean"
- },
- "include_obligations_company_sponsorship_include_benefits_val": {
- "type": "string"
- },
- "include_obligations_company_sponsorship_include_payments": {
- "type": "boolean"
- },
- "include_obligations_company_sponsorship_include_payments_amount": {
- "type": "number"
- },
- "include_obligations_company_sponsorship_include_payments_unit": {
- "enum": [
- "U.S. Dollars",
- "percent"
- ],
- "type": "string"
- },
- "include_obligations_partner_brand": {
- "type": "boolean"
- },
- "include_obligations_partner_promotion": {
- "type": "boolean"
- },
- "include_obligations_partner_promotion_include_activities": {
- "type": "boolean"
- },
- "include_obligations_partner_promotion_include_activities_val": {
- "type": "string"
- },
- "include_obligations_partner_promotion_include_materials": {
- "type": "boolean"
- },
- "include_obligations_partner_promotion_include_materials_val": {
- "type": "string"
- },
- "include_obligations_partner_referral": {
- "type": "boolean"
- },
- "include_obligations_partner_referral_include_criteria": {
- "type": "boolean"
- },
- "include_obligations_partner_referral_include_criteria_val": {
- "type": "string"
- },
- "include_obligations_partner_referral_include_pay_sch": {
- "type": "boolean"
- },
- "include_obligations_partner_referral_include_pay_sch_amount": {
- "type": "number"
- },
- "include_obligations_partner_referral_include_pay_sch_custom": {
- "type": "string"
- },
- "include_obligations_partner_referral_include_pay_sch_unit": {
- "enum": [
- "U.S. Dollars",
- "percent"
- ],
- "type": "string"
- },
- "include_obligations_partner_sponsorship": {
- "type": "boolean"
- },
- "include_obligations_partner_sponsorship_include_benefits": {
- "type": "boolean"
- },
- "include_obligations_partner_sponsorship_include_benefits_val": {
- "type": "string"
- },
- "include_obligations_partner_sponsorship_include_payments": {
- "type": "boolean"
- },
- "include_obligations_partner_sponsorship_include_payments_amount": {
- "type": "number"
- },
- "include_obligations_partner_sponsorship_include_payments_unit": {
- "enum": [
- "U.S. Dollars",
- "percent"
- ],
- "type": "string"
- },
- "include_payment_process": {
- "type": "boolean"
- },
- "include_payment_process_company": {
- "type": "boolean"
- },
- "include_payment_process_company_include_address": {
- "type": "boolean"
- },
- "include_payment_process_company_include_address_city": {
- "type": "string"
- },
- "include_payment_process_company_include_address_country": {
- "type": "string"
- },
- "include_payment_process_company_include_address_state": {
- "type": "string"
- },
- "include_payment_process_company_include_address_street_address": {
- "type": "string"
- },
- "include_payment_process_company_include_address_zipcode": {
- "type": "string"
- },
- "include_payment_process_company_include_email": {
- "type": "boolean"
- },
- "include_payment_process_company_include_email_val": {
- "type": "string"
- },
- "include_payment_process_partner": {
- "type": "boolean"
- },
- "include_payment_process_partner_include_address": {
- "type": "boolean"
- },
- "include_payment_process_partner_include_address_city": {
- "type": "string"
- },
- "include_payment_process_partner_include_address_country": {
- "type": "string"
- },
- "include_payment_process_partner_include_address_state": {
- "type": "string"
- },
- "include_payment_process_partner_include_address_street_address": {
- "type": "string"
- },
- "include_payment_process_partner_include_address_zipcode": {
- "type": "string"
- },
- "include_payment_process_partner_include_email": {
- "type": "boolean"
- },
- "include_payment_process_partner_include_email_val": {
- "type": "string"
- },
- "include_payment_schedule": {
- "type": "boolean"
- },
- "include_payment_schedule_custom": {
- "type": "string"
- },
- "include_payment_schedule_specified_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_payment_schedule_specified_timeframe": {
- "enum": [
- "receipt",
- "date"
- ],
- "type": "string"
- },
- "include_payment_schedule_specified_unit": {
- "enum": [
- "day(s)",
- "week(s)",
- "month(s)",
- "quarter(s)",
- "year(s)"
- ],
- "type": "string"
- },
- "include_payment_schedule_type": {
- "enum": [
- "specified",
- "custom"
- ],
- "type": "string"
- },
- "negotiations_allowed": {
- "description": "When true, the recipient can propose changes to the business terms, even when the agreement-level `negotiations_allowed` is false. This only covers the business terms.",
- "type": "boolean"
- },
- "territory_type": {
- "enum": [
- "worldwide",
- "custom"
- ],
- "type": "string"
- },
- "territory_type_val": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "payment_link_url": {
- "description": "A payment URL shown to the recipient after signing. Requires include_billing_workflow to be true and billing_workflow_type to be \"link\".",
- "type": "string"
- },
- "pilot_attributes": {
- "additionalProperties": false,
- "description": "Override pilot terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "fees_type": {
- "enum": [
- "free",
- "pilot_period_fees"
- ],
- "type": "string"
- },
- "general_cap_amount": {
- "type": "number"
- },
- "general_cap_amount_type": {
- "enum": [
- "preceding",
- "base",
- "period"
- ],
- "type": "string"
- },
- "general_cap_period_currency": {
- "type": "number"
- },
- "general_cap_period_qty": {
- "type": "number"
- },
- "general_cap_preceding_amount": {
- "type": "number"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_dpa": {
- "type": "boolean"
- },
- "include_dpa_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_dpa_location": {
- "type": "string"
- },
- "include_dpa_type": {
- "enum": [
- "description",
- "attachment",
- "standard"
- ],
- "type": "string"
- },
- "include_payment_process": {
- "type": "boolean"
- },
- "include_technical_support": {
- "type": "boolean"
- },
- "payment_process_automatic_frequency": {
- "enum": [
- "monthly",
- "quarterly",
- "annually",
- "once_per_period"
- ],
- "type": "string"
- },
- "payment_process_invoice_days": {
- "type": "number"
- },
- "payment_process_invoice_from": {
- "enum": [
- "receipt",
- "date"
- ],
- "type": "string"
- },
- "payment_process_invoice_timeframe": {
- "enum": [
- "days",
- "weeks",
- "months",
- "quarters",
- "years"
- ],
- "type": "string"
- },
- "payment_process_type": {
- "enum": [
- "automatic",
- "invoice"
- ],
- "type": "string"
- },
- "pilot_period_description": {
- "type": "string"
- },
- "pilot_period_fees_description": {
- "type": "string"
- },
- "product_description": {
- "type": "string"
- },
- "technical_support_description": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "psa_attributes": {
- "additionalProperties": false,
- "description": "Override psa terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "additional_changes": {
- "type": "string"
- },
- "customer_description": {
- "type": "string"
- },
- "effective_date": {
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "effective_date_type": {
- "enum": [
- "signature",
- "date"
- ],
- "type": "string"
- },
- "general_cap_amount": {
- "type": "number"
- },
- "general_cap_amount_type": {
- "enum": [
- "preceding",
- "base",
- "period"
- ],
- "type": "string"
- },
- "general_cap_period_currency": {
- "type": "number"
- },
- "general_cap_period_qty": {
- "type": "number"
- },
- "general_cap_preceding_amount": {
- "type": "number"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_additional_changes": {
- "type": "boolean"
- },
- "include_additional_warranties": {
- "type": "boolean"
- },
- "include_additional_warranties_by_customer": {
- "type": "string"
- },
- "include_additional_warranties_by_provider": {
- "type": "string"
- },
- "include_additional_warranties_include_by_customer": {
- "type": "boolean"
- },
- "include_additional_warranties_include_by_provider": {
- "type": "boolean"
- },
- "include_covered_claims": {
- "type": "boolean"
- },
- "include_covered_claims_customer_claims": {
- "type": "string"
- },
- "include_covered_claims_include_customer_claims": {
- "type": "boolean"
- },
- "include_covered_claims_include_provider_claims": {
- "type": "boolean"
- },
- "include_covered_claims_provider_claims": {
- "type": "string"
- },
- "include_customer_insurance_min": {
- "type": "boolean"
- },
- "include_customer_insurance_min_add_provider_com_gen_liability": {
- "type": "boolean"
- },
- "include_customer_insurance_min_add_provider_cyber_liability": {
- "type": "boolean"
- },
- "include_customer_insurance_min_add_provider_errors_omissions": {
- "type": "boolean"
- },
- "include_customer_insurance_min_auto_liability_aggregate": {
- "type": "number"
- },
- "include_customer_insurance_min_auto_liability_minimum": {
- "type": "number"
- },
- "include_customer_insurance_min_cyber_liability_aggregate": {
- "type": "number"
- },
- "include_customer_insurance_min_cyber_liability_minimum": {
- "type": "number"
- },
- "include_customer_insurance_min_employer_liability_aggregate": {
- "type": "number"
- },
- "include_customer_insurance_min_employer_liability_minimum": {
- "type": "number"
- },
- "include_customer_insurance_min_general_liability_aggregate": {
- "type": "number"
- },
- "include_customer_insurance_min_general_liability_minimum": {
- "type": "number"
- },
- "include_customer_insurance_min_include_add_provider": {
- "type": "boolean"
- },
- "include_customer_insurance_min_include_auto_liability": {
- "type": "boolean"
- },
- "include_customer_insurance_min_include_cyber_liability": {
- "type": "boolean"
- },
- "include_customer_insurance_min_include_employer_liability": {
- "type": "boolean"
- },
- "include_customer_insurance_min_include_general_liability": {
- "type": "boolean"
- },
- "include_customer_insurance_min_include_workers_comp": {
- "type": "boolean"
- },
- "include_customer_policies": {
- "type": "boolean"
- },
- "include_customer_policies_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_customer_policies_location": {
- "type": "string"
- },
- "include_customer_policies_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_dpa": {
- "type": "boolean"
- },
- "include_dpa_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_dpa_location": {
- "type": "string"
- },
- "include_dpa_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_increased_cap_amount": {
- "type": "boolean"
- },
- "include_increased_claims": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_confidentiality": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_confidentiality_negligence": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_privsec": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_privsec_negligence": {
- "type": "boolean"
- },
- "include_increased_claims_include_other": {
- "type": "boolean"
- },
- "include_increased_claims_indemnification_obligation": {
- "type": "boolean"
- },
- "include_increased_claims_negligence": {
- "type": "boolean"
- },
- "include_increased_claims_other": {
- "type": "string"
- },
- "include_provider_insurance_min": {
- "type": "boolean"
- },
- "include_provider_insurance_min_add_customer_com_gen_liability": {
- "type": "boolean"
- },
- "include_provider_insurance_min_add_customer_cyber_liability": {
- "type": "boolean"
- },
- "include_provider_insurance_min_add_customer_errors_omissions": {
- "type": "boolean"
- },
- "include_provider_insurance_min_auto_liability_aggregate": {
- "type": "number"
- },
- "include_provider_insurance_min_auto_liability_minimum": {
- "type": "number"
- },
- "include_provider_insurance_min_cyber_liability_aggregate": {
- "type": "number"
- },
- "include_provider_insurance_min_cyber_liability_minimum": {
- "type": "number"
- },
- "include_provider_insurance_min_employer_liability_aggregate": {
- "type": "number"
- },
- "include_provider_insurance_min_employer_liability_minimum": {
- "type": "number"
- },
- "include_provider_insurance_min_general_liability_aggregate": {
- "type": "number"
- },
- "include_provider_insurance_min_general_liability_minimum": {
- "type": "number"
- },
- "include_provider_insurance_min_include_add_customer": {
- "type": "boolean"
- },
- "include_provider_insurance_min_include_auto_liability": {
- "type": "boolean"
- },
- "include_provider_insurance_min_include_cyber_liability": {
- "type": "boolean"
- },
- "include_provider_insurance_min_include_employer_liability": {
- "type": "boolean"
- },
- "include_provider_insurance_min_include_general_liability": {
- "type": "boolean"
- },
- "include_provider_insurance_min_include_workers_comp": {
- "type": "boolean"
- },
- "include_publicity_rights": {
- "type": "boolean"
- },
- "include_publicity_rights_type": {
- "enum": [
- "public",
- "non-public"
- ],
- "type": "string"
- },
- "include_security_policy": {
- "type": "boolean"
- },
- "include_security_policy_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_security_policy_fedramp_auth": {
- "type": "boolean"
- },
- "include_security_policy_hitrust": {
- "type": "boolean"
- },
- "include_security_policy_include_annual_maintenance": {
- "type": "boolean"
- },
- "include_security_policy_include_other": {
- "type": "boolean"
- },
- "include_security_policy_include_other_val": {
- "type": "string"
- },
- "include_security_policy_iso27001": {
- "type": "boolean"
- },
- "include_security_policy_location": {
- "type": "string"
- },
- "include_security_policy_pci1": {
- "type": "boolean"
- },
- "include_security_policy_pci2": {
- "type": "boolean"
- },
- "include_security_policy_penetration_testing": {
- "type": "boolean"
- },
- "include_security_policy_soc2_type1": {
- "type": "boolean"
- },
- "include_security_policy_soc2_type2": {
- "type": "boolean"
- },
- "include_security_policy_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_unlimited_claims": {
- "type": "boolean"
- },
- "include_unlimited_claims_breach_of_confidentiality": {
- "type": "boolean"
- },
- "include_unlimited_claims_breach_of_confidentiality_negligence": {
- "type": "boolean"
- },
- "include_unlimited_claims_breach_of_privsec": {
- "type": "boolean"
- },
- "include_unlimited_claims_breach_of_privsec_negligence": {
- "type": "boolean"
- },
- "include_unlimited_claims_include_other": {
- "type": "boolean"
- },
- "include_unlimited_claims_indemnification_obligation": {
- "type": "boolean"
- },
- "include_unlimited_claims_negligence": {
- "type": "boolean"
- },
- "include_unlimited_claims_other": {
- "type": "string"
- },
- "increased_cap_amount_currency": {
- "type": "number"
- },
- "increased_cap_amount_period_currency": {
- "type": "number"
- },
- "increased_cap_amount_period_qty": {
- "type": "number"
- },
- "increased_cap_amount_qty": {
- "type": "number"
- },
- "increased_cap_amount_type": {
- "enum": [
- "qty",
- "currency",
- "period"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- "psa_statement_of_work_attributes": {
- "additionalProperties": false,
- "description": "Override psa statement of work terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "additional_changes": {
- "type": "string"
- },
- "cost": {
- "type": "number"
- },
- "description": {
- "type": "string"
- },
- "fee_type": {
- "type": "string"
- },
- "fees_attributes": {
- "additionalProperties": {
- "anyOf": [
- {
- "additionalProperties": false,
- "description": "Fees::Flat (fee_type \"flat\"). A fixed recurring fee, e.g. a platform subscription. Set type to \"Fees::Flat\" or fee_type to \"flat\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "Fixed amount in the order form's fees_currency, charged per fee_period. A plain amount, not cents: 20 means 20.00.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"flat\". Alternative to type.",
- "enum": [
- "flat"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Flat\". Optional when fee_type is set.",
- "enum": [
- "Fees::Flat"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Discount (fee_type \"discount\"). A discount, as a fixed amount or a percentage, applied forever, once, or for a number of months. Set type to \"Fees::Discount\" or fee_type to \"discount\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "Discount size: an amount in fees_currency when discount_type is fixed_amount (a plain amount, not cents: 20 means 20.00), or a percentage (e.g. 10 for 10%) when it is percentage.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "discount_duration_amount": {
- "description": "Number of months the discount applies. Required when discount_duration_type is multiple_months.",
- "type": "number"
- },
- "discount_duration_type": {
- "description": "How long the discount applies. multiple_months also needs discount_duration_amount.",
- "enum": [
- "forever",
- "once",
- "multiple_months"
- ],
- "type": "string"
- },
- "discount_type": {
- "description": "Whether cost is a currency amount or a percentage.",
- "enum": [
- "fixed_amount",
- "percentage"
- ],
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"discount\". Alternative to type.",
- "enum": [
- "discount"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Discount\". Optional when fee_type is set.",
- "enum": [
- "Fees::Discount"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Cost (fee_type \"cost\"). A per-unit fee: price per unit times quantity, e.g. seats. Set type to \"Fees::Cost\" or fee_type to \"cost\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "Price per unit in fees_currency. The row total is quantity x cost. A plain amount, not cents: 20 means 20.00.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"cost\". Alternative to type.",
- "enum": [
- "cost"
- ],
- "type": "string"
- },
- "quantity": {
- "description": "Number of units.",
- "type": "number"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Cost\". Optional when fee_type is set.",
- "enum": [
- "Fees::Cost"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Attachment (fee_type \"attachment\"). A fee described in an uploaded attachment instead of in the table. Set type to \"Fees::Attachment\" or fee_type to \"attachment\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "attachment_id": {
- "description": "ID of an attachment uploaded with upload-attachment.",
- "type": "string"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"attachment\". Alternative to type.",
- "enum": [
- "attachment"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Attachment\". Optional when fee_type is set.",
- "enum": [
- "Fees::Attachment"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Graduated (fee_type \"graduated\"). Tiered pricing, with the price set per tier in graduated_fee_tiers_attributes. Set type to \"Fees::Graduated\" or fee_type to \"graduated\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"graduated\". Alternative to type.",
- "enum": [
- "graduated"
- ],
- "type": "string"
- },
- "graduated_fee_tiers_attributes": {
- "additionalProperties": {
- "additionalProperties": false,
- "properties": {
- "flat_price": {
- "type": "number"
- },
- "price_per_unit": {
- "type": "string"
- },
- "upper_limit": {
- "type": "number"
- }
- },
- "type": "object"
- },
- "description": "Graduated fee tiers. Use string keys such as \"0\", \"1\".",
- "propertyNames": {
- "type": "string"
- },
- "type": "object"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Graduated\". Optional when fee_type is set.",
- "enum": [
- "Fees::Graduated"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Included (fee_type \"included\"). An item included at no charge. Set type to \"Fees::Included\" or fee_type to \"included\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"included\". Alternative to type.",
- "enum": [
- "included"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Included\". Optional when fee_type is set.",
- "enum": [
- "Fees::Included"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Metered (fee_type \"metered\"). Usage-based pricing, billed per unit used. Set type to \"Fees::Metered\" or fee_type to \"metered\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "Price per unit of usage in fees_currency. A plain amount, not cents: 20 means 20.00.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"metered\". Alternative to type.",
- "enum": [
- "metered"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Metered\". Optional when fee_type is set.",
- "enum": [
- "Fees::Metered"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::OneTime (fee_type \"one_time\"). A one-time charge, such as a setup fee. Set type to \"Fees::OneTime\" or fee_type to \"one_time\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "One-time amount in fees_currency, charged once rather than per fee_period. A plain amount, not cents: 20 means 20.00.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"one_time\". Alternative to type.",
- "enum": [
- "one_time"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::OneTime\". Optional when fee_type is set.",
- "enum": [
- "Fees::OneTime"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Text (fee_type \"text\"). A fee term described in free text. Set type to \"Fees::Text\" or fee_type to \"text\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"text\". Alternative to type.",
- "enum": [
- "text"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Text\". Optional when fee_type is set.",
- "enum": [
- "Fees::Text"
- ],
- "type": "string"
- }
- },
- "type": "object"
- }
- ]
- },
- "description": "Fee line items. Use string keys such as \"0\", \"1\". Replaces template fees when provided.",
- "propertyNames": {
- "type": "string"
- },
- "type": "object"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_additional_changes": {
- "type": "boolean"
- },
- "include_customer_obligation": {
- "type": "boolean"
- },
- "include_customer_obligation_val": {
- "type": "string"
- },
- "include_deliverables": {
- "type": "boolean"
- },
- "include_deliverables_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_deliverables_description": {
- "type": "string"
- },
- "include_deliverables_include_acceptance": {
- "type": "boolean"
- },
- "include_deliverables_include_attachment": {
- "type": "boolean"
- },
- "include_deliverables_include_draft_deliverables": {
- "type": "boolean"
- },
- "include_deliverables_rejection_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_deliverables_rejection_unit": {
- "enum": [
- "hours",
- "days",
- "weeks",
- "months"
- ],
- "type": "string"
- },
- "include_deliverables_resubmission_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_deliverables_resubmission_unit": {
- "enum": [
- "hours",
- "days",
- "weeks",
- "months"
- ],
- "type": "string"
- },
- "include_fees_other": {
- "type": "boolean"
- },
- "include_fees_other_val": {
- "type": "string"
- },
- "include_fees_table": {
- "type": "boolean"
- },
- "include_fees_table_total": {
- "type": "boolean"
- },
- "include_fees_travel": {
- "type": "boolean"
- },
- "include_fees_travel_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_fees_travel_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_fees_travel_val": {
- "type": "string"
- },
- "include_third_party_customer": {
- "type": "boolean"
- },
- "include_third_party_include_description": {
- "type": "boolean"
- },
- "include_third_party_include_description_val": {
- "type": "string"
- },
- "include_third_party_materials": {
- "type": "boolean"
- },
- "include_third_party_provider": {
- "type": "boolean"
- },
- "include_time_of_assignment": {
- "type": "boolean"
- },
- "include_time_of_assignment_type": {
- "enum": [
- "created",
- "paid"
- ],
- "type": "string"
- },
- "invoice_period_description": {
- "type": "string"
- },
- "negotiations_allowed": {
- "description": "When true, the recipient can propose changes to the statement of work, even when the agreement-level `negotiations_allowed` is false. This only covers the statement of work.",
- "type": "boolean"
- },
- "payment_period": {
- "type": "number"
- },
- "payment_period_other": {
- "type": "string"
- },
- "payment_period_timeframe": {
- "enum": [
- "receipt",
- "invoice",
- "Customer's receipt of invoice",
- "date of invoice"
- ],
- "type": "string"
- },
- "payment_period_type": {
- "enum": [
- "standard",
- "other"
- ],
- "type": "string"
- },
- "payment_period_unit": {
- "enum": [
- "day(s)",
- "week(s)",
- "month(s)",
- "quarter(s)",
- "year(s)"
- ],
- "type": "string"
- },
- "quantity": {
- "type": "number"
- },
- "services_description": {
- "type": "string"
- },
- "sow_date": {
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "sow_date_type": {
- "enum": [
- "signature",
- "date"
- ],
- "type": "string"
- },
- "sow_term_amount": {
- "type": "number"
- },
- "sow_term_date": {
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "sow_term_type": {
- "enum": [
- "deliverables",
- "period",
- "date"
- ],
- "type": "string"
- },
- "sow_term_unit": {
- "enum": [
- "month(s)",
- "quarter(s)",
- "year(s)"
- ],
- "type": "string"
- },
- "type": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "recipient_email": {
- "format": "email",
- "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
- "type": "string"
- },
- "recipient_name": {
- "type": "string"
- },
- "recipient_notice_email_address": {
- "description": "Email address for legal notices to the recipient.",
- "format": "email",
- "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
- "type": "string"
- },
- "recipient_organization": {
- "type": "string"
- },
- "recipient_role": {
- "description": "PSA only. The recipient's role: `Customer` (the default) or `Provider`. Send it with `sender_role`; the two must be one `Provider` and one `Customer`. Other standard agreement types ignore it.",
- "type": "string"
- },
- "sender_last_to_sign": {
- "description": "When true, your signer signs after the recipient.",
- "type": "boolean"
- },
- "sender_notice_email_address": {
- "description": "Email address for legal notices to the sender.",
- "format": "email",
- "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
- "type": "string"
- },
- "sender_role": {
- "description": "PSA only. Your company's role: `Provider` (the default) or `Customer` when you hire the recipient to provide the services. Send it with `recipient_role`; the two must be one `Provider` and one `Customer`. When reading a PSA, an empty `sender_role` means `Provider`. Other standard agreement types ignore it.",
- "type": "string"
- },
- "software_license_attributes": {
- "additionalProperties": false,
- "description": "Override software license terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "effective_date": {
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "effective_date_type": {
- "enum": [
- "signature",
- "date"
- ],
- "type": "string"
- },
- "general_cap_amount": {
- "type": "number"
- },
- "general_cap_amount_type": {
- "enum": [
- "preceding",
- "base",
- "period"
- ],
- "type": "string"
- },
- "general_cap_period_currency": {
- "type": "number"
- },
- "general_cap_period_qty": {
- "type": "number"
- },
- "general_cap_preceding_amount": {
- "type": "number"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_additional_warranties": {
- "type": "boolean"
- },
- "include_additional_warranties_by_customer": {
- "type": "string"
- },
- "include_additional_warranties_by_provider": {
- "type": "string"
- },
- "include_additional_warranties_include_by_customer": {
- "type": "boolean"
- },
- "include_additional_warranties_include_by_provider": {
- "type": "boolean"
- },
- "include_ai_addendum": {
- "type": "boolean"
- },
- "include_ai_addendum_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_covered_claims": {
- "type": "boolean"
- },
- "include_covered_claims_customer_claims": {
- "type": "string"
- },
- "include_covered_claims_include_customer_claims": {
- "type": "boolean"
- },
- "include_covered_claims_include_provider_claims": {
- "type": "boolean"
- },
- "include_covered_claims_provider_claims": {
- "type": "string"
- },
- "include_dpa": {
- "type": "boolean"
- },
- "include_dpa_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_dpa_location": {
- "type": "string"
- },
- "include_dpa_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_increased_cap_amount": {
- "type": "boolean"
- },
- "include_increased_claims": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_confidentiality": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_confidentiality_negligence": {
- "type": "boolean"
- },
- "include_increased_claims_include_other": {
- "type": "boolean"
- },
- "include_increased_claims_indemnification_obligation": {
- "type": "boolean"
- },
- "include_increased_claims_negligence": {
- "type": "boolean"
- },
- "include_increased_claims_other": {
- "type": "string"
- },
- "include_increased_claims_restrictions": {
- "type": "boolean"
- },
- "include_unlimited_claims": {
- "type": "boolean"
- },
- "include_unlimited_claims_breach_of_confidentiality": {
- "type": "boolean"
- },
- "include_unlimited_claims_breach_of_confidentiality_negligence": {
- "type": "boolean"
- },
- "include_unlimited_claims_include_other": {
- "type": "boolean"
- },
- "include_unlimited_claims_indemnification_obligation": {
- "type": "boolean"
- },
- "include_unlimited_claims_license_or_restrictions": {
- "type": "boolean"
- },
- "include_unlimited_claims_negligence": {
- "type": "boolean"
- },
- "include_unlimited_claims_other": {
- "type": "string"
- },
- "increased_cap_amount_currency": {
- "type": "number"
- },
- "increased_cap_amount_period_currency": {
- "type": "number"
- },
- "increased_cap_amount_period_qty": {
- "type": "number"
- },
- "increased_cap_amount_qty": {
- "type": "number"
- },
- "increased_cap_amount_type": {
- "enum": [
- "qty",
- "currency",
- "period"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- "software_license_order_form_attributes": {
- "additionalProperties": false,
- "description": "Override software license order form terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "additional_changes": {
- "type": "string"
- },
- "deletion_procedure_include_custom": {
- "type": "boolean"
- },
- "deletion_procedure_include_custom_description": {
- "type": "string"
- },
- "deletion_procedure_include_customer_disable": {
- "type": "boolean"
- },
- "deletion_procedure_include_customer_proof": {
- "type": "boolean"
- },
- "deletion_procedure_include_provider_disable": {
- "type": "boolean"
- },
- "fee_custom_unit": {
- "type": "string"
- },
- "fee_period": {
- "enum": [
- "Subscription Period",
- "month",
- "year",
- "Custom unit"
- ],
- "type": "string"
- },
- "fees_attributes": {
- "additionalProperties": {
- "anyOf": [
- {
- "additionalProperties": false,
- "description": "Fees::Flat (fee_type \"flat\"). A fixed recurring fee, e.g. a platform subscription. Set type to \"Fees::Flat\" or fee_type to \"flat\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "Fixed amount in the order form's fees_currency, charged per fee_period. A plain amount, not cents: 20 means 20.00.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"flat\". Alternative to type.",
- "enum": [
- "flat"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Flat\". Optional when fee_type is set.",
- "enum": [
- "Fees::Flat"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Discount (fee_type \"discount\"). A discount, as a fixed amount or a percentage, applied forever, once, or for a number of months. Set type to \"Fees::Discount\" or fee_type to \"discount\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "Discount size: an amount in fees_currency when discount_type is fixed_amount (a plain amount, not cents: 20 means 20.00), or a percentage (e.g. 10 for 10%) when it is percentage.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "discount_duration_amount": {
- "description": "Number of months the discount applies. Required when discount_duration_type is multiple_months.",
- "type": "number"
- },
- "discount_duration_type": {
- "description": "How long the discount applies. multiple_months also needs discount_duration_amount.",
- "enum": [
- "forever",
- "once",
- "multiple_months"
- ],
- "type": "string"
- },
- "discount_type": {
- "description": "Whether cost is a currency amount or a percentage.",
- "enum": [
- "fixed_amount",
- "percentage"
- ],
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"discount\". Alternative to type.",
- "enum": [
- "discount"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Discount\". Optional when fee_type is set.",
- "enum": [
- "Fees::Discount"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Cost (fee_type \"cost\"). A per-unit fee: price per unit times quantity, e.g. seats. Set type to \"Fees::Cost\" or fee_type to \"cost\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "Price per unit in fees_currency. The row total is quantity x cost. A plain amount, not cents: 20 means 20.00.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"cost\". Alternative to type.",
- "enum": [
- "cost"
- ],
- "type": "string"
- },
- "quantity": {
- "description": "Number of units.",
- "type": "number"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Cost\". Optional when fee_type is set.",
- "enum": [
- "Fees::Cost"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Attachment (fee_type \"attachment\"). A fee described in an uploaded attachment instead of in the table. Set type to \"Fees::Attachment\" or fee_type to \"attachment\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "attachment_id": {
- "description": "ID of an attachment uploaded with upload-attachment.",
- "type": "string"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"attachment\". Alternative to type.",
- "enum": [
- "attachment"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Attachment\". Optional when fee_type is set.",
- "enum": [
- "Fees::Attachment"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Graduated (fee_type \"graduated\"). Tiered pricing, with the price set per tier in graduated_fee_tiers_attributes. Set type to \"Fees::Graduated\" or fee_type to \"graduated\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"graduated\". Alternative to type.",
- "enum": [
- "graduated"
- ],
- "type": "string"
- },
- "graduated_fee_tiers_attributes": {
- "additionalProperties": {
- "additionalProperties": false,
- "properties": {
- "flat_price": {
- "type": "number"
- },
- "price_per_unit": {
- "type": "string"
- },
- "upper_limit": {
- "type": "number"
- }
- },
- "type": "object"
- },
- "description": "Graduated fee tiers. Use string keys such as \"0\", \"1\".",
- "propertyNames": {
- "type": "string"
- },
- "type": "object"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Graduated\". Optional when fee_type is set.",
- "enum": [
- "Fees::Graduated"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Included (fee_type \"included\"). An item included at no charge. Set type to \"Fees::Included\" or fee_type to \"included\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"included\". Alternative to type.",
- "enum": [
- "included"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Included\". Optional when fee_type is set.",
- "enum": [
- "Fees::Included"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Metered (fee_type \"metered\"). Usage-based pricing, billed per unit used. Set type to \"Fees::Metered\" or fee_type to \"metered\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "Price per unit of usage in fees_currency. A plain amount, not cents: 20 means 20.00.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"metered\". Alternative to type.",
- "enum": [
- "metered"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Metered\". Optional when fee_type is set.",
- "enum": [
- "Fees::Metered"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::OneTime (fee_type \"one_time\"). A one-time charge, such as a setup fee. Set type to \"Fees::OneTime\" or fee_type to \"one_time\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "One-time amount in fees_currency, charged once rather than per fee_period. A plain amount, not cents: 20 means 20.00.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"one_time\". Alternative to type.",
- "enum": [
- "one_time"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::OneTime\". Optional when fee_type is set.",
- "enum": [
- "Fees::OneTime"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Text (fee_type \"text\"). A fee term described in free text. Set type to \"Fees::Text\" or fee_type to \"text\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"text\". Alternative to type.",
- "enum": [
- "text"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Text\". Optional when fee_type is set.",
- "enum": [
- "Fees::Text"
- ],
- "type": "string"
- }
- },
- "type": "object"
- }
- ]
- },
- "description": "Fee line items. Use string keys such as \"0\", \"1\". Replaces template fees when provided.",
- "propertyNames": {
- "type": "string"
- },
- "type": "object"
- },
- "fees_currency": {
- "enum": [
- "USD",
- "EUR",
- "GBP",
- "CAD",
- "AUD",
- "SGD",
- "ILS",
- "JPY",
- "CHF",
- "HKD"
- ],
- "type": "string"
- },
- "fees_include_fee_increase_upon_renewal": {
- "type": "boolean"
- },
- "fees_include_fee_increase_upon_renewal_fee": {
- "type": "number"
- },
- "fees_include_fee_increase_upon_renewal_type": {
- "enum": [
- "will",
- "may"
- ],
- "type": "string"
- },
- "fees_inclusive_of_taxes": {
- "type": "boolean"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_additional_changes": {
- "type": "boolean"
- },
- "include_license_compliance_verification": {
- "type": "boolean"
- },
- "include_license_compliance_verification_description": {
- "type": "string"
- },
- "include_license_limits": {
- "type": "boolean"
- },
- "include_license_limits_description": {
- "type": "string"
- },
- "include_payment_process_include_billing_email": {
- "type": "boolean"
- },
- "include_pilot_period": {
- "type": "boolean"
- },
- "include_pilot_period_duration_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_pilot_period_duration_type": {
- "enum": [
- "day",
- "week",
- "month"
- ],
- "type": "string"
- },
- "include_pilot_period_include_fees": {
- "type": "boolean"
- },
- "include_pilot_period_include_fees_amount": {
- "type": "number"
- },
- "include_pilot_period_include_modifications": {
- "type": "boolean"
- },
- "include_pilot_period_include_modifications_description": {
- "type": "string"
- },
- "include_services": {
- "type": "boolean"
- },
- "include_services_description": {
- "type": "string"
- },
- "negotiations_allowed": {
- "description": "When true, the recipient can propose changes to the order form, even when the agreement-level `negotiations_allowed` is false. This only covers the order form.",
- "type": "boolean"
- },
- "order_date_date": {
- "type": "string"
- },
- "order_date_type": {
- "enum": [
- "signature",
- "date",
- "other"
- ],
- "type": "string"
- },
- "payment_process_automatic_frequency": {
- "enum": [
- "monthly",
- "quarterly",
- "semiannually",
- "annually"
- ],
- "type": "string"
- },
- "payment_process_type": {
- "enum": [
- "automatic",
- "invoice",
- "custom"
- ],
- "type": "string"
- },
- "payment_process_type_custom_val": {
- "type": "string"
- },
- "payment_process_type_invoice_amount": {
- "type": "number"
- },
- "payment_process_type_invoice_custom_unit": {
- "type": "string"
- },
- "payment_process_type_invoice_duration": {
- "enum": [
- "day",
- "week",
- "month",
- "year",
- "day(s)",
- "week(s)",
- "month(s)",
- "year(s)"
- ],
- "type": "string"
- },
- "payment_process_type_invoice_duration_start": {
- "enum": [
- "Customer's receipt of invoice",
- "date of invoice"
- ],
- "type": "string"
- },
- "payment_process_type_invoice_type": {
- "enum": [
- "monthly",
- "quarterly",
- "semiannually",
- "annually",
- "Custom unit"
- ],
- "type": "string"
- },
- "permitted_uses_include_custom": {
- "type": "boolean"
- },
- "permitted_uses_include_custom_description": {
- "type": "string"
- },
- "permitted_uses_include_customers_affiliates": {
- "type": "boolean"
- },
- "permitted_uses_include_internal_business": {
- "type": "boolean"
- },
- "pilot_period_stripe_product_id": {
- "type": "string"
- },
- "software_description": {
- "type": "string"
- },
- "subscription_auto_renew": {
- "enum": [
- "days",
- "subscription_end"
- ],
- "type": "string"
- },
- "subscription_period": {
- "type": "number"
- },
- "subscription_period_unit": {
- "type": "string"
- },
- "subscription_renewal_notice_days": {
- "type": "number"
- },
- "warranty_period_description_amount": {
- "type": "number"
- },
- "warranty_period_description_duration": {
- "enum": [
- "day",
- "week",
- "month",
- "year"
- ],
- "type": "string"
- },
- "warranty_period_description_duration_start": {
- "enum": [
- "initial delivery of the Software",
- "delivery of the Software and each subsequent Update",
- "the Order Date"
- ],
- "type": "string"
- },
- "warranty_period_type": {
- "enum": [
- "description",
- "none"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- "test_agreement": {
- "description": "When true, marks the agreement as a test. Test agreements do not count against your monthly limit.",
- "type": "boolean"
- }
- },
- "required": [
- "recipient_name",
- "recipient_email"
- ],
- "type": "object"
- },
- "cc_users": {
- "items": {
- "format": "email",
- "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
- "type": "string"
- },
- "type": "array"
- },
- "draft": {
- "description": "When true, the agreement is saved as a draft and not sent to the recipient. Use POST /v1/agreements/{id}/send to send a draft agreement later.",
- "type": "boolean"
- },
- "owner_email": {
- "description": "Email address of the agreement owner (sender).",
- "type": "string"
- },
- "signer_email": {
- "description": "Email address of the signer from the owner's organization.",
- "format": "email",
- "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
- "type": "string"
- },
- "template_id": {
- "description": "UUID of a template from `GET /v1/templates`. Accepts both Common Paper standard templates and uploaded PDF templates (`type` `uploaded_template`).",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- }
- },
- "required": [
- "template_id",
- "owner_email",
- "signer_email",
- "agreement"
- ],
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "agreement": {
- "additionalProperties": {},
- "properties": {
- "amendment_attributes": {
- "additionalProperties": false,
- "description": "Override amendment terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "amended_terms_attributes": {
- "additionalProperties": {
- "additionalProperties": false,
- "properties": {
- "description": {
- "type": "string"
- },
- "term": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "description": "Amended terms. Use string keys such as \"0\", \"1\".",
- "propertyNames": {
- "type": "string"
- },
- "type": "object"
- },
- "amendment_date": {
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "amendment_date_type": {
- "enum": [
- "signature",
- "date"
- ],
- "type": "string"
- },
- "framework_terms_type": {
- "type": "string"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "parent_agreement_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "underlying_agreement_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "underlying_agreement_type": {
- "type": "string"
- },
- "underlying_agreement_val": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "baa_attributes": {
- "additionalProperties": false,
- "description": "Override baa terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "aggregation_limitations_permitted": {
- "type": "boolean"
- },
- "aggregation_limitations_permitted_val": {
- "type": "string"
- },
- "breach_notification_unit": {
- "enum": [
- "hours",
- "business days",
- "calendar days"
- ],
- "type": "string"
- },
- "breach_notification_val": {
- "type": "number"
- },
- "business_associate_relationship_type": {
- "enum": [
- "provider",
- "company"
- ],
- "type": "string"
- },
- "deidentification_limitations_include_purpose": {
- "type": "boolean"
- },
- "deidentification_limitations_include_requirements": {
- "type": "boolean"
- },
- "deidentification_limitations_permitted": {
- "type": "boolean"
- },
- "deidentification_limitations_purpose_val": {
- "type": "string"
- },
- "deidentification_limitations_requirements_val": {
- "type": "string"
- },
- "designated_record_set_provider_maintains": {
- "type": "boolean"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_aggregation_limitations": {
- "type": "boolean"
- },
- "include_deidentification_limitations": {
- "type": "boolean"
- },
- "include_limitations": {
- "type": "boolean"
- },
- "include_offshore_limitations": {
- "type": "boolean"
- },
- "include_subcontract_limitations": {
- "type": "boolean"
- },
- "offshore_limitations_permitted": {
- "type": "boolean"
- },
- "offshore_limitations_permitted_val": {
- "type": "string"
- },
- "subcontract_limitations_include_notice": {
- "type": "boolean"
- },
- "subcontract_limitations_include_permission": {
- "type": "boolean"
- },
- "subcontract_limitations_notice_val": {
- "type": "string"
- },
- "subcontract_limitations_permission_val": {
- "type": "string"
- },
- "subcontract_limitations_permitted": {
- "type": "boolean"
- },
- "underlying_agreement_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "underlying_agreement_type": {
- "enum": [
- "internal",
- "external",
- "none"
- ],
- "type": "string"
- },
- "underlying_agreement_val": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "billing_email": {
- "description": "Email of the billing contact. Used when include_billing_info is true.",
- "format": "email",
- "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
- "type": "string"
- },
- "billing_name": {
- "description": "Name of the billing contact. Used when include_billing_info is true.",
- "type": "string"
- },
- "billing_workflow_type": {
- "description": "The type of billing workflow. Use \"link\" to provide a payment_link_url, or \"stripe\" for Stripe-managed billing.",
- "enum": [
- "link",
- "stripe"
- ],
- "type": "string"
- },
- "chosen_courts_country": {
- "description": "The country in which disputes will be resolved.",
- "type": "string"
- },
- "chosen_courts_region": {
- "description": "The state or region in which disputes will be resolved.",
- "type": "string"
- },
- "csa_attributes": {
- "additionalProperties": false,
- "description": "Override csa terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "customer_description": {
- "type": "string"
- },
- "effective_date": {
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "effective_date_marketplace": {
- "enum": [
- "AWS",
- "GCP",
- "Azure"
- ],
- "type": "string"
- },
- "effective_date_type": {
- "enum": [
- "signature",
- "date",
- "marketplace_acceptance"
- ],
- "type": "string"
- },
- "general_cap_amount": {
- "type": "number"
- },
- "general_cap_amount_type": {
- "enum": [
- "preceding",
- "base",
- "period"
- ],
- "type": "string"
- },
- "general_cap_period_currency": {
- "type": "number"
- },
- "general_cap_period_qty": {
- "type": "number"
- },
- "general_cap_preceding_amount": {
- "type": "number"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_acceptable_use_policy": {
- "type": "boolean"
- },
- "include_acceptable_use_policy_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_acceptable_use_policy_location": {
- "type": "string"
- },
- "include_acceptable_use_policy_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_additional_warranties": {
- "type": "boolean"
- },
- "include_additional_warranties_by_customer": {
- "type": "string"
- },
- "include_additional_warranties_by_provider": {
- "type": "string"
- },
- "include_additional_warranties_include_by_customer": {
- "type": "boolean"
- },
- "include_additional_warranties_include_by_provider": {
- "type": "boolean"
- },
- "include_ai_addendum": {
- "type": "boolean"
- },
- "include_ai_addendum_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_covered_claims": {
- "type": "boolean"
- },
- "include_covered_claims_customer_claims": {
- "type": "string"
- },
- "include_covered_claims_include_customer_claims": {
- "type": "boolean"
- },
- "include_covered_claims_include_provider_claims": {
- "type": "boolean"
- },
- "include_covered_claims_provider_claims": {
- "type": "string"
- },
- "include_dpa": {
- "type": "boolean"
- },
- "include_dpa_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_dpa_location": {
- "type": "string"
- },
- "include_dpa_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_increased_cap_amount": {
- "type": "boolean"
- },
- "include_increased_claims": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_confidentiality": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_confidentiality_negligence": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_privsec": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_privsec_negligence": {
- "type": "boolean"
- },
- "include_increased_claims_include_other": {
- "type": "boolean"
- },
- "include_increased_claims_indemnification_obligation": {
- "type": "boolean"
- },
- "include_increased_claims_other": {
- "type": "string"
- },
- "include_insurance_minimums": {
- "type": "boolean"
- },
- "include_insurance_minimums_add_customer": {
- "type": "boolean"
- },
- "include_insurance_minimums_add_customer_com_gen_liability": {
- "type": "boolean"
- },
- "include_insurance_minimums_add_customer_cyber_liability": {
- "type": "boolean"
- },
- "include_insurance_minimums_add_customer_errors_omissions": {
- "type": "boolean"
- },
- "include_insurance_minimums_additional_information": {
- "type": "boolean"
- },
- "include_insurance_minimums_additional_information_text": {
- "type": "string"
- },
- "include_insurance_minimums_cyber_liability_aggregate": {
- "type": "number"
- },
- "include_insurance_minimums_cyber_liability_minimum": {
- "type": "number"
- },
- "include_insurance_minimums_employer_liability_aggregate": {
- "type": "number"
- },
- "include_insurance_minimums_employer_liability_minimum": {
- "type": "number"
- },
- "include_insurance_minimums_general_liability_aggregate": {
- "type": "number"
- },
- "include_insurance_minimums_general_liability_minimum": {
- "type": "number"
- },
- "include_insurance_minimums_include_cyber_liability": {
- "type": "boolean"
- },
- "include_insurance_minimums_include_employer_liability": {
- "type": "boolean"
- },
- "include_insurance_minimums_include_general_liability": {
- "type": "boolean"
- },
- "include_insurance_minimums_include_workers_compensation": {
- "type": "boolean"
- },
- "include_publicity_rights": {
- "type": "boolean"
- },
- "include_publicity_rights_type": {
- "enum": [
- "public",
- "non-public"
- ],
- "type": "string"
- },
- "include_security_policy": {
- "type": "boolean"
- },
- "include_security_policy_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_security_policy_fedramp_auth": {
- "type": "boolean"
- },
- "include_security_policy_hipaa": {
- "type": "boolean"
- },
- "include_security_policy_hitrust": {
- "type": "boolean"
- },
- "include_security_policy_include_annual_maintenance": {
- "type": "boolean"
- },
- "include_security_policy_include_location": {
- "type": "boolean"
- },
- "include_security_policy_include_other": {
- "type": "boolean"
- },
- "include_security_policy_include_reasonable_efforts": {
- "type": "boolean"
- },
- "include_security_policy_iso27001": {
- "type": "boolean"
- },
- "include_security_policy_location": {
- "type": "string"
- },
- "include_security_policy_other": {
- "type": "string"
- },
- "include_security_policy_pci1": {
- "type": "boolean"
- },
- "include_security_policy_pci2": {
- "type": "boolean"
- },
- "include_security_policy_penetration_testing": {
- "type": "boolean"
- },
- "include_security_policy_soc2": {
- "type": "boolean"
- },
- "include_security_policy_soc2_type2": {
- "type": "boolean"
- },
- "include_security_policy_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_supercap": {
- "description": "CSA 3.0 renamed `include_increased_cap_amount` to `include_supercap`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_increased_cap_amount`. Sending the other spelling returns a 422.",
- "type": "boolean"
- },
- "include_uncapped_claims": {
- "description": "CSA 3.0 renamed `include_unlimited_claims` to `include_uncapped_claims`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims`. Sending the other spelling returns a 422.",
- "type": "boolean"
- },
- "include_uncapped_claims_breach_of_confidentiality": {
- "description": "CSA 3.0 renamed `include_unlimited_claims_breach_of_confidentiality` to `include_uncapped_claims_breach_of_confidentiality`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_breach_of_confidentiality`. Sending the other spelling returns a 422.",
- "type": "boolean"
- },
- "include_uncapped_claims_breach_of_confidentiality_negligence": {
- "description": "CSA 3.0 renamed `include_unlimited_claims_breach_of_confidentiality_negligence` to `include_uncapped_claims_breach_of_confidentiality_negligence`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_breach_of_confidentiality_negligence`. Sending the other spelling returns a 422.",
- "type": "boolean"
- },
- "include_uncapped_claims_breach_of_privsec": {
- "description": "CSA 3.0 renamed `include_unlimited_claims_breach_of_privsec` to `include_uncapped_claims_breach_of_privsec`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_breach_of_privsec`. Sending the other spelling returns a 422.",
- "type": "boolean"
- },
- "include_uncapped_claims_breach_of_privsec_negligence": {
- "description": "CSA 3.0 renamed `include_unlimited_claims_breach_of_privsec_negligence` to `include_uncapped_claims_breach_of_privsec_negligence`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_breach_of_privsec_negligence`. Sending the other spelling returns a 422.",
- "type": "boolean"
- },
- "include_uncapped_claims_include_other": {
- "description": "CSA 3.0 renamed `include_unlimited_claims_include_other` to `include_uncapped_claims_include_other`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_include_other`. Sending the other spelling returns a 422.",
- "type": "boolean"
- },
- "include_uncapped_claims_indemnification_obligation": {
- "description": "CSA 3.0 renamed `include_unlimited_claims_indemnification_obligation` to `include_uncapped_claims_indemnification_obligation`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_indemnification_obligation`. Sending the other spelling returns a 422.",
- "type": "boolean"
- },
- "include_uncapped_claims_other": {
- "description": "CSA 3.0 renamed `include_unlimited_claims_other` to `include_uncapped_claims_other`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_other`. Sending the other spelling returns a 422.",
- "type": "boolean"
- },
- "include_unlimited_claims": {
- "type": "boolean"
- },
- "include_unlimited_claims_breach_of_confidentiality": {
- "type": "boolean"
- },
- "include_unlimited_claims_breach_of_confidentiality_negligence": {
- "type": "boolean"
- },
- "include_unlimited_claims_breach_of_privsec": {
- "type": "boolean"
- },
- "include_unlimited_claims_breach_of_privsec_negligence": {
- "type": "boolean"
- },
- "include_unlimited_claims_include_other": {
- "type": "boolean"
- },
- "include_unlimited_claims_indemnification_obligation": {
- "type": "boolean"
- },
- "include_unlimited_claims_other": {
- "type": "string"
- },
- "increased_cap_amount_currency": {
- "type": "number"
- },
- "increased_cap_amount_period_currency": {
- "type": "number"
- },
- "increased_cap_amount_period_qty": {
- "type": "number"
- },
- "increased_cap_amount_qty": {
- "type": "number"
- },
- "increased_cap_amount_type": {
- "enum": [
- "qty",
- "currency",
- "period"
- ],
- "type": "string"
- },
- "provider": {
- "type": "string"
- },
- "supercap_currency": {
- "description": "CSA 3.0 renamed `increased_cap_amount_currency` to `supercap_currency`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `increased_cap_amount_currency`. Sending the other spelling returns a 422.",
- "type": "number"
- },
- "supercap_period_currency": {
- "description": "CSA 3.0 renamed `increased_cap_amount_period_currency` to `supercap_period_currency`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `increased_cap_amount_period_currency`. Sending the other spelling returns a 422.",
- "type": "number"
- },
- "supercap_period_qty": {
- "description": "CSA 3.0 renamed `increased_cap_amount_period_qty` to `supercap_period_qty`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `increased_cap_amount_period_qty`. Sending the other spelling returns a 422.",
- "type": "number"
- },
- "supercap_qty": {
- "description": "CSA 3.0 renamed `increased_cap_amount_qty` to `supercap_qty`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `increased_cap_amount_qty`. Sending the other spelling returns a 422.",
- "type": "number"
- },
- "supercap_type": {
- "description": "CSA 3.0 renamed `increased_cap_amount_type` to `supercap_type`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `increased_cap_amount_type`. Sending the other spelling returns a 422.",
- "type": "number"
- }
- },
- "type": "object"
- },
- "csa_order_form_attributes": {
- "additionalProperties": false,
- "description": "Override csa order form terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "additional_changes": {
- "type": "string"
- },
- "additional_parameters_or_limitations": {
- "type": "string"
- },
- "affiliates_as_users": {
- "type": "boolean"
- },
- "cloud_service_description": {
- "type": "string"
- },
- "consumption_units": {
- "type": "string"
- },
- "fee_amount": {
- "type": "number"
- },
- "fee_custom_unit": {
- "type": "string"
- },
- "fee_period": {
- "enum": [
- "Subscription Period",
- "month",
- "year",
- "User",
- "Custom unit"
- ],
- "type": "string"
- },
- "fees_attributes": {
- "additionalProperties": {
- "anyOf": [
- {
- "additionalProperties": false,
- "description": "Fees::Flat (fee_type \"flat\"). A fixed recurring fee, e.g. a platform subscription. Set type to \"Fees::Flat\" or fee_type to \"flat\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "Fixed amount in the order form's fees_currency, charged per fee_period. A plain amount, not cents: 20 means 20.00.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"flat\". Alternative to type.",
- "enum": [
- "flat"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Flat\". Optional when fee_type is set.",
- "enum": [
- "Fees::Flat"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Discount (fee_type \"discount\"). A discount, as a fixed amount or a percentage, applied forever, once, or for a number of months. Set type to \"Fees::Discount\" or fee_type to \"discount\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "Discount size: an amount in fees_currency when discount_type is fixed_amount (a plain amount, not cents: 20 means 20.00), or a percentage (e.g. 10 for 10%) when it is percentage.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "discount_duration_amount": {
- "description": "Number of months the discount applies. Required when discount_duration_type is multiple_months.",
- "type": "number"
- },
- "discount_duration_type": {
- "description": "How long the discount applies. multiple_months also needs discount_duration_amount.",
- "enum": [
- "forever",
- "once",
- "multiple_months"
- ],
- "type": "string"
- },
- "discount_type": {
- "description": "Whether cost is a currency amount or a percentage.",
- "enum": [
- "fixed_amount",
- "percentage"
- ],
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"discount\". Alternative to type.",
- "enum": [
- "discount"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Discount\". Optional when fee_type is set.",
- "enum": [
- "Fees::Discount"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Cost (fee_type \"cost\"). A per-unit fee: price per unit times quantity, e.g. seats. Set type to \"Fees::Cost\" or fee_type to \"cost\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "Price per unit in fees_currency. The row total is quantity x cost. A plain amount, not cents: 20 means 20.00.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"cost\". Alternative to type.",
- "enum": [
- "cost"
- ],
- "type": "string"
- },
- "quantity": {
- "description": "Number of units.",
- "type": "number"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Cost\". Optional when fee_type is set.",
- "enum": [
- "Fees::Cost"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Attachment (fee_type \"attachment\"). A fee described in an uploaded attachment instead of in the table. Set type to \"Fees::Attachment\" or fee_type to \"attachment\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "attachment_id": {
- "description": "ID of an attachment uploaded with upload-attachment.",
- "type": "string"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"attachment\". Alternative to type.",
- "enum": [
- "attachment"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Attachment\". Optional when fee_type is set.",
- "enum": [
- "Fees::Attachment"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Graduated (fee_type \"graduated\"). Tiered pricing, with the price set per tier in graduated_fee_tiers_attributes. Set type to \"Fees::Graduated\" or fee_type to \"graduated\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"graduated\". Alternative to type.",
- "enum": [
- "graduated"
- ],
- "type": "string"
- },
- "graduated_fee_tiers_attributes": {
- "additionalProperties": {
- "additionalProperties": false,
- "properties": {
- "flat_price": {
- "type": "number"
- },
- "price_per_unit": {
- "type": "string"
- },
- "upper_limit": {
- "type": "number"
- }
- },
- "type": "object"
- },
- "description": "Graduated fee tiers. Use string keys such as \"0\", \"1\".",
- "propertyNames": {
- "type": "string"
- },
- "type": "object"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Graduated\". Optional when fee_type is set.",
- "enum": [
- "Fees::Graduated"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Included (fee_type \"included\"). An item included at no charge. Set type to \"Fees::Included\" or fee_type to \"included\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"included\". Alternative to type.",
- "enum": [
- "included"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Included\". Optional when fee_type is set.",
- "enum": [
- "Fees::Included"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Metered (fee_type \"metered\"). Usage-based pricing, billed per unit used. Set type to \"Fees::Metered\" or fee_type to \"metered\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "Price per unit of usage in fees_currency. A plain amount, not cents: 20 means 20.00.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"metered\". Alternative to type.",
- "enum": [
- "metered"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Metered\". Optional when fee_type is set.",
- "enum": [
- "Fees::Metered"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::OneTime (fee_type \"one_time\"). A one-time charge, such as a setup fee. Set type to \"Fees::OneTime\" or fee_type to \"one_time\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "One-time amount in fees_currency, charged once rather than per fee_period. A plain amount, not cents: 20 means 20.00.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"one_time\". Alternative to type.",
- "enum": [
- "one_time"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::OneTime\". Optional when fee_type is set.",
- "enum": [
- "Fees::OneTime"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Text (fee_type \"text\"). A fee term described in free text. Set type to \"Fees::Text\" or fee_type to \"text\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"text\". Alternative to type.",
- "enum": [
- "text"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Text\". Optional when fee_type is set.",
- "enum": [
- "Fees::Text"
- ],
- "type": "string"
- }
- },
- "type": "object"
- }
- ]
- },
- "description": "Fee table rows, keyed by string index (\"0\", \"1\", ...). Replaces the template's fees when provided. Each row sets type or fee_type to pick the fee class. Amounts are in the order form's fees_currency and, for recurring fees, are charged per fee_period.",
- "examples": [
- {
- "0": {
- "cost": 2000,
- "description": "Platform subscription",
- "type": "Fees::Flat"
- }
- },
- {
- "0": {
- "cost": 50,
- "description": "Seats",
- "fee_type": "cost",
- "quantity": 10
- },
- "1": {
- "cost": 10,
- "description": "Launch discount",
- "discount_duration_amount": 3,
- "discount_duration_type": "multiple_months",
- "discount_type": "percentage",
- "fee_type": "discount"
- }
- }
- ],
- "propertyNames": {
- "type": "string"
- },
- "type": "object"
- },
- "fees_currency": {
- "enum": [
- "USD",
- "EUR",
- "GBP",
- "CAD",
- "AUD",
- "SGD",
- "ILS",
- "JPY",
- "CHF",
- "HKD"
- ],
- "type": "string"
- },
- "fees_include_fee_increase_upon_renewal": {
- "type": "boolean"
- },
- "fees_include_fee_increase_upon_renewal_fee": {
- "type": "number"
- },
- "fees_include_fee_increase_upon_renewal_type": {
- "enum": [
- "will",
- "may"
- ],
- "type": "string"
- },
- "fees_inclusive_of_taxes": {
- "type": "boolean"
- },
- "framework_terms_type": {
- "enum": [
- "new",
- "existing",
- "description"
- ],
- "type": "string"
- },
- "free_trial_days": {
- "type": "number"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_additional_changes": {
- "type": "boolean"
- },
- "include_additional_parameters_or_limitations": {
- "type": "boolean"
- },
- "include_consumption": {
- "type": "boolean"
- },
- "include_fees": {
- "type": "boolean"
- },
- "include_fees_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_fees_include_attachment": {
- "type": "boolean"
- },
- "include_fees_other": {
- "type": "boolean"
- },
- "include_fees_other_val": {
- "type": "string"
- },
- "include_fees_table": {
- "type": "boolean"
- },
- "include_fees_table_period": {
- "enum": [
- "Subscription Period",
- "month",
- "year",
- "User"
- ],
- "type": "string"
- },
- "include_free_trial": {
- "type": "boolean"
- },
- "include_max_users": {
- "type": "boolean"
- },
- "include_pilot_period": {
- "type": "boolean"
- },
- "include_pilot_period_duration_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_pilot_period_duration_type": {
- "enum": [
- "day",
- "week",
- "month"
- ],
- "type": "string"
- },
- "include_pilot_period_include_fees": {
- "type": "boolean"
- },
- "include_pilot_period_include_fees_amount": {
- "type": "number"
- },
- "include_pilot_period_include_modifications": {
- "type": "boolean"
- },
- "include_pilot_period_include_modifications_description": {
- "type": "string"
- },
- "include_product_support": {
- "type": "boolean"
- },
- "include_product_support_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_product_support_description": {
- "type": "string"
- },
- "include_product_support_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_professional_services": {
- "type": "boolean"
- },
- "include_professional_services_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_professional_services_custom_name": {
- "type": "string"
- },
- "include_professional_services_description": {
- "type": "string"
- },
- "include_professional_services_end_date": {
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "include_professional_services_fees_description": {
- "type": "string"
- },
- "include_professional_services_include_end_date": {
- "type": "boolean"
- },
- "include_professional_services_include_fees_description": {
- "type": "boolean"
- },
- "include_professional_services_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_sla": {
- "type": "boolean"
- },
- "include_sla_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_sla_description": {
- "type": "string"
- },
- "include_sla_include_response_time": {
- "type": "boolean"
- },
- "include_sla_include_response_time_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_sla_include_response_time_credit": {
- "type": "number"
- },
- "include_sla_include_response_time_duration": {
- "enum": [
- "hour",
- "day",
- "week",
- "month",
- "hours"
- ],
- "type": "string"
- },
- "include_sla_include_response_time_support_channel": {
- "type": "string"
- },
- "include_sla_include_target_uptime": {
- "type": "boolean"
- },
- "include_sla_maintenance_notice": {
- "type": "boolean"
- },
- "include_sla_maintenance_window": {
- "type": "boolean"
- },
- "include_sla_maintenance_window_type": {
- "enum": [
- "standard",
- "none"
- ],
- "type": "string"
- },
- "include_sla_standard_maintenance_notice_qty": {
- "type": "number"
- },
- "include_sla_standard_maintenance_notice_unit": {
- "enum": [
- "hour",
- "day",
- "week",
- "month"
- ],
- "type": "string"
- },
- "include_sla_standard_maintenance_window_end_time": {
- "type": "string"
- },
- "include_sla_standard_maintenance_window_friday": {
- "type": "boolean"
- },
- "include_sla_standard_maintenance_window_monday": {
- "type": "boolean"
- },
- "include_sla_standard_maintenance_window_saturday": {
- "type": "boolean"
- },
- "include_sla_standard_maintenance_window_start_time": {
- "type": "string"
- },
- "include_sla_standard_maintenance_window_sunday": {
- "type": "boolean"
- },
- "include_sla_standard_maintenance_window_thursday": {
- "type": "boolean"
- },
- "include_sla_standard_maintenance_window_time_zone": {
- "type": "string"
- },
- "include_sla_standard_maintenance_window_tuesday": {
- "type": "boolean"
- },
- "include_sla_standard_maintenance_window_wednesday": {
- "type": "boolean"
- },
- "include_sla_standard_target_uptime": {
- "type": "number"
- },
- "include_sla_type": {
- "enum": [
- "description",
- "standard",
- "attachment"
- ],
- "type": "string"
- },
- "include_subscription_start_date": {
- "type": "boolean"
- },
- "include_subscription_start_date_date": {
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "include_usage_review": {
- "type": "boolean"
- },
- "include_usage_review_val": {
- "type": "string"
- },
- "include_use_limitations": {
- "type": "boolean"
- },
- "include_use_limitations_val": {
- "type": "string"
- },
- "invoice_period": {
- "enum": [
- "monthly",
- "quarterly",
- "semiannually",
- "annually",
- "Custom unit",
- "Monthly",
- "Quarterly",
- "Semiannually",
- "Annually"
- ],
- "type": "string"
- },
- "invoice_period_custom_unit": {
- "type": "string"
- },
- "max_consumption": {
- "type": "number"
- },
- "max_users": {
- "type": "number"
- },
- "negotiations_allowed": {
- "description": "When true, the recipient can propose changes to the order form, even when the agreement-level `negotiations_allowed` is false. This only covers the order form.",
- "type": "boolean"
- },
- "order_date_date": {
- "type": "string"
- },
- "order_date_other": {
- "type": "string"
- },
- "order_date_type": {
- "enum": [
- "signature",
- "date",
- "other"
- ],
- "type": "string"
- },
- "payment_period": {
- "type": "number"
- },
- "payment_period_timeframe": {
- "enum": [
- "Customer's receipt of invoice",
- "date of invoice"
- ],
- "type": "string"
- },
- "payment_period_unit": {
- "enum": [
- "day(s)",
- "week(s)",
- "month(s)",
- "marketplace_acceptance"
- ],
- "type": "string"
- },
- "payment_process_automatic_frequency": {
- "enum": [
- "monthly",
- "quarterly",
- "semiannually",
- "annually"
- ],
- "type": "string"
- },
- "payment_process_type": {
- "enum": [
- "automatic",
- "invoice",
- "custom",
- "marketplace_acceptance"
- ],
- "type": "string"
- },
- "payment_process_type_custom_val": {
- "type": "string"
- },
- "payment_process_type_invoice_amount": {
- "type": "number"
- },
- "payment_process_type_invoice_custom_unit": {
- "type": "string"
- },
- "payment_process_type_invoice_duration": {
- "enum": [
- "day",
- "week",
- "month",
- "year",
- "day(s)",
- "week(s)",
- "month(s)",
- "year(s)"
- ],
- "type": "string"
- },
- "payment_process_type_invoice_duration_start": {
- "enum": [
- "Customer's receipt of invoice",
- "date of invoice"
- ],
- "type": "string"
- },
- "payment_process_type_invoice_type": {
- "enum": [
- "monthly",
- "quarterly",
- "semiannually",
- "annually",
- "Custom unit"
- ],
- "type": "string"
- },
- "pilot_period_stripe_product_id": {
- "type": "string"
- },
- "service_credits_attributes": {
- "additionalProperties": {
- "additionalProperties": false,
- "properties": {
- "credit": {
- "type": "number"
- },
- "max": {
- "type": "number"
- },
- "min": {
- "type": "number"
- }
- },
- "type": "object"
- },
- "description": "Service credits. Use string keys such as \"0\", \"1\".",
- "propertyNames": {
- "type": "string"
- },
- "type": "object"
- },
- "subscription_auto_renew": {
- "enum": [
- "days",
- "subscription_end"
- ],
- "type": "string"
- },
- "subscription_period": {
- "type": "number"
- },
- "subscription_period_unit": {
- "type": "string"
- },
- "subscription_renewal_notice_days": {
- "type": "number"
- },
- "subscription_start_date": {
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "subscription_start_date_type": {
- "enum": [
- "effective_date",
- "date"
- ],
- "type": "string"
- },
- "underlying_agreement_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "use_limitations_attributes": {
- "additionalProperties": {
- "additionalProperties": false,
- "properties": {
- "amount": {
- "type": "number"
- },
- "limitation_type": {
- "type": "string"
- },
- "unit": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "description": "Use limitations. Use string keys such as \"0\", \"1\".",
- "propertyNames": {
- "type": "string"
- },
- "type": "object"
- }
- },
- "type": "object"
- },
- "custom_field_values": {
- "description": "Values for a custom template's fields, keyed by the field keys defined in the template's YAML definition. Only used when template_id is a custom template. Template defaults fill any fields you omit; a required field with no default and no submitted value returns a 400 naming the field. Values are validated against the field's input type: select and radio values must be one of the field's options, multiselect values are an array of selections each of which must be one of the field's options, number and currency values must be numeric, date values must be YYYY-MM-DD, and email values must be valid addresses. An invalid value returns a 400 naming the field."
- },
- "design_partner_attributes": {
- "additionalProperties": false,
- "description": "Override design partner terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "customer_description": {
- "type": "string"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_fees": {
- "type": "boolean"
- },
- "include_fees_amount": {
- "type": "number"
- },
- "include_fees_description": {
- "type": "string"
- },
- "include_fees_pay_by_amount": {
- "type": "string"
- },
- "include_fees_type": {
- "enum": [
- "default_language",
- "description"
- ],
- "type": "string"
- },
- "include_fees_unit": {
- "enum": [
- "month",
- "quarter",
- "year",
- "Term"
- ],
- "type": "string"
- },
- "include_program_appear_as_customer_private": {
- "type": "boolean"
- },
- "include_program_appear_as_customer_public": {
- "type": "boolean"
- },
- "include_program_case_study": {
- "type": "boolean"
- },
- "include_program_develop_functionality": {
- "type": "boolean"
- },
- "include_program_develop_functionality_val": {
- "type": "string"
- },
- "include_program_discount": {
- "type": "boolean"
- },
- "include_program_discount_amount": {
- "type": "number"
- },
- "include_program_discount_unit": {
- "enum": [
- "U.S. Dollars",
- "percent"
- ],
- "type": "string"
- },
- "include_program_participation_feedback": {
- "type": "boolean"
- },
- "include_program_participation_feedback_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_program_participation_feedback_unit": {
- "enum": [
- "month",
- "quarter",
- "year",
- "Term"
- ],
- "type": "string"
- },
- "include_program_partner_other": {
- "type": "boolean"
- },
- "include_program_partner_other_val": {
- "type": "string"
- },
- "include_program_provider_other": {
- "type": "boolean"
- },
- "include_program_provider_other_val": {
- "type": "string"
- },
- "include_program_reference": {
- "type": "boolean"
- },
- "product_description": {
- "type": "string"
- },
- "term_amount": {
- "type": "number"
- },
- "term_unit": {
- "enum": [
- "day(s)",
- "week(s)",
- "month(s)",
- "quarter(s)",
- "year(s)"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- "district_or_county": {
- "description": "The district or county for dispute resolution.",
- "type": "string"
- },
- "dpa_attributes": {
- "additionalProperties": false,
- "description": "Override dpa terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "approved_subprocessor_type": {
- "description": "`internal` lists approved subprocessors in the agreement (`subprocessors_attributes`); `external` points to a list published elsewhere.",
- "enum": [
- "internal",
- "external"
- ],
- "type": "string"
- },
- "cloud_service_product_name": {
- "type": "string"
- },
- "competent_supervisory_authority": {
- "type": "string"
- },
- "customer_description": {
- "type": "string"
- },
- "data_exporter_address_city": {
- "type": "string"
- },
- "data_exporter_address_country": {
- "type": "string"
- },
- "data_exporter_address_state": {
- "type": "string"
- },
- "data_exporter_address_street_address": {
- "type": "string"
- },
- "data_exporter_address_zipcode": {
- "type": "string"
- },
- "data_exporter_contact_details": {
- "type": "string"
- },
- "data_exporter_contact_name": {
- "type": "string"
- },
- "data_exporter_contact_position": {
- "type": "string"
- },
- "data_exporter_role": {
- "description": "Role of the data exporter. Overwritten to `Controller` when the agreement is created from a template.",
- "enum": [
- "Controller",
- "Processor"
- ],
- "type": "string"
- },
- "data_importer_address": {
- "type": "string"
- },
- "data_importer_address_city": {
- "type": "string"
- },
- "data_importer_address_country": {
- "type": "string"
- },
- "data_importer_address_state": {
- "type": "string"
- },
- "data_importer_address_street_address": {
- "type": "string"
- },
- "data_importer_address_zipcode": {
- "type": "string"
- },
- "data_importer_contact_details": {
- "type": "string"
- },
- "data_importer_contact_name": {
- "type": "string"
- },
- "data_importer_contact_position": {
- "type": "string"
- },
- "duration_of_processing": {
- "type": "string"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_covered_claim": {
- "type": "boolean"
- },
- "include_covered_claim_external_val": {
- "type": "string"
- },
- "include_covered_claim_internal_val": {
- "type": "string"
- },
- "include_covered_claim_type": {
- "description": "Which covered-claim text applies: `internal` uses `include_covered_claim_internal_val`, `external` uses `include_covered_claim_external_val`. Required when `include_covered_claim` is true.",
- "enum": [
- "internal",
- "external"
- ],
- "type": "string"
- },
- "include_data_subjects_custom": {
- "type": "boolean"
- },
- "include_data_subjects_custom_val": {
- "type": "string"
- },
- "include_data_subjects_employees": {
- "type": "boolean"
- },
- "include_data_subjects_end_users": {
- "type": "boolean"
- },
- "include_external_subprocessor_location": {
- "type": "string"
- },
- "include_frequency_of_transfer_continuous": {
- "type": "boolean"
- },
- "include_frequency_of_transfer_custom": {
- "type": "boolean"
- },
- "include_frequency_of_transfer_custom_val": {
- "type": "string"
- },
- "include_governing_country_eu": {
- "type": "boolean"
- },
- "include_governing_country_eu_val": {
- "type": "string"
- },
- "include_governing_country_uk": {
- "type": "boolean"
- },
- "include_governing_country_uk_val": {
- "type": "string"
- },
- "include_governing_law": {
- "type": "boolean"
- },
- "include_governing_law_country": {
- "type": "string"
- },
- "include_governing_law_state": {
- "type": "string"
- },
- "include_increased_claim_amount": {
- "description": "Legacy field. Stored but not shown on the DPA; use the `include_liability_cap*` fields instead.",
- "type": "boolean"
- },
- "include_increased_claim_amount_currency": {
- "description": "Legacy field. Stored but not shown on the DPA; use the `include_liability_cap*` fields instead."
- },
- "include_increased_claim_amount_qty": {
- "description": "Legacy field. Stored but not shown on the DPA; use the `include_liability_cap*` fields instead."
- },
- "include_increased_claim_amount_type": {
- "description": "Legacy field. Stored but not shown on the DPA; use the `include_liability_cap*` fields instead.",
- "type": "string"
- },
- "include_liability_cap": {
- "type": "boolean"
- },
- "include_liability_cap_amount_constant_external": {
- "type": "string"
- },
- "include_liability_cap_amount_constant_internal": {
- "type": "string"
- },
- "include_liability_cap_amount_currency_external": {
- "description": "Currency amount. Numbers and numeric strings (commas allowed) are both accepted."
- },
- "include_liability_cap_amount_currency_internal": {
- "description": "Currency amount. Numbers and numeric strings (commas allowed) are both accepted."
- },
- "include_liability_cap_csa_type": {
- "description": "Which liability cap values apply: the `_internal` or `_external` amount fields. Required when `include_liability_cap` is true.",
- "enum": [
- "internal",
- "external"
- ],
- "type": "string"
- },
- "include_personal_data_biographic_info": {
- "type": "boolean"
- },
- "include_personal_data_contact_info": {
- "type": "boolean"
- },
- "include_personal_data_custom": {
- "type": "boolean"
- },
- "include_personal_data_custom_val": {
- "type": "string"
- },
- "include_personal_data_employment_info": {
- "type": "boolean"
- },
- "include_personal_data_financial_info": {
- "type": "boolean"
- },
- "include_personal_data_location": {
- "type": "boolean"
- },
- "include_personal_data_name": {
- "type": "boolean"
- },
- "include_personal_data_transactional_info": {
- "type": "boolean"
- },
- "include_personal_data_user_activity_info": {
- "type": "boolean"
- },
- "include_processing_purpose_custom": {
- "type": "boolean"
- },
- "include_processing_purpose_custom_val": {
- "type": "string"
- },
- "include_processing_purpose_erasing": {
- "type": "boolean"
- },
- "include_processing_purpose_holding": {
- "type": "boolean"
- },
- "include_processing_purpose_protecting": {
- "type": "boolean"
- },
- "include_processing_purpose_receiving": {
- "type": "boolean"
- },
- "include_processing_purpose_returning": {
- "type": "boolean"
- },
- "include_processing_purpose_sharing": {
- "type": "boolean"
- },
- "include_processing_purpose_updating": {
- "type": "boolean"
- },
- "include_processing_purpose_using": {
- "type": "boolean"
- },
- "include_provider_security_contact_address": {
- "type": "boolean"
- },
- "include_provider_security_contact_address_city": {
- "type": "string"
- },
- "include_provider_security_contact_address_country": {
- "type": "string"
- },
- "include_provider_security_contact_address_state": {
- "type": "string"
- },
- "include_provider_security_contact_address_street_address": {
- "type": "string"
- },
- "include_provider_security_contact_address_zipcode": {
- "type": "string"
- },
- "include_provider_security_contact_email": {
- "type": "boolean"
- },
- "include_provider_security_contact_email_val": {
- "format": "email",
- "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
- "type": "string"
- },
- "include_security_measures_accountability": {
- "type": "boolean"
- },
- "include_security_measures_accountability_val": {
- "type": "string"
- },
- "include_security_measures_certification_or_assurance": {
- "type": "boolean"
- },
- "include_security_measures_certification_or_assurance_val": {
- "type": "string"
- },
- "include_security_measures_confidentiality_integrity": {
- "type": "boolean"
- },
- "include_security_measures_confidentiality_integrity_val": {
- "type": "string"
- },
- "include_security_measures_data_at_rest": {
- "type": "boolean"
- },
- "include_security_measures_data_at_rest_val": {
- "type": "string"
- },
- "include_security_measures_data_minimization": {
- "type": "boolean"
- },
- "include_security_measures_data_minimization_val": {
- "type": "string"
- },
- "include_security_measures_data_quality": {
- "type": "boolean"
- },
- "include_security_measures_data_quality_val": {
- "type": "string"
- },
- "include_security_measures_data_retention": {
- "type": "boolean"
- },
- "include_security_measures_data_retention_val": {
- "type": "string"
- },
- "include_security_measures_data_transmission": {
- "type": "boolean"
- },
- "include_security_measures_data_transmission_val": {
- "type": "string"
- },
- "include_security_measures_event_logging": {
- "type": "boolean"
- },
- "include_security_measures_event_logging_val": {
- "type": "string"
- },
- "include_security_measures_identity_auth": {
- "type": "boolean"
- },
- "include_security_measures_identity_auth_val": {
- "type": "string"
- },
- "include_security_measures_it_security_governance": {
- "type": "boolean"
- },
- "include_security_measures_it_security_governance_val": {
- "type": "string"
- },
- "include_security_measures_physical_security": {
- "type": "boolean"
- },
- "include_security_measures_physical_security_val": {
- "type": "string"
- },
- "include_security_measures_portability_and_erasure": {
- "type": "boolean"
- },
- "include_security_measures_portability_and_erasure_val": {
- "type": "string"
- },
- "include_security_measures_pseudonym_encryption": {
- "type": "boolean"
- },
- "include_security_measures_pseudonym_encryption_val": {
- "type": "string"
- },
- "include_security_measures_restore_data_access": {
- "type": "boolean"
- },
- "include_security_measures_restore_data_access_val": {
- "type": "string"
- },
- "include_security_measures_security_policy": {
- "type": "boolean"
- },
- "include_security_measures_system_configuration": {
- "type": "boolean"
- },
- "include_security_measures_system_configuration_val": {
- "type": "string"
- },
- "include_security_measures_testing_assessment": {
- "type": "boolean"
- },
- "include_security_measures_testing_assessment_val": {
- "type": "string"
- },
- "include_security_policy": {
- "type": "boolean"
- },
- "include_security_policy_fedramp_auth": {
- "type": "boolean"
- },
- "include_security_policy_hipaa": {
- "type": "boolean"
- },
- "include_security_policy_hitrust": {
- "type": "boolean"
- },
- "include_security_policy_include_other": {
- "type": "boolean"
- },
- "include_security_policy_iso27001": {
- "type": "boolean"
- },
- "include_security_policy_other": {
- "type": "string"
- },
- "include_security_policy_pci1": {
- "type": "boolean"
- },
- "include_security_policy_pci2": {
- "type": "boolean"
- },
- "include_security_policy_penetration_testing": {
- "type": "boolean"
- },
- "include_security_policy_soc2": {
- "type": "boolean"
- },
- "include_security_policy_soc2_type2": {
- "type": "boolean"
- },
- "include_sensitive_data_restrictions_custom": {
- "type": "boolean"
- },
- "include_sensitive_data_restrictions_custom_val": {
- "type": "string"
- },
- "include_sensitive_data_restrictions_security_policy": {
- "type": "boolean"
- },
- "include_service_provider_relationship": {
- "type": "boolean"
- },
- "include_special_category_data": {
- "type": "boolean"
- },
- "provider": {
- "type": "string"
- },
- "security_policy_available_at": {
- "type": "string"
- },
- "security_policy_type": {
- "description": "Where the Security Policy is defined. For `external`, set `security_policy_available_at`.",
- "enum": [
- "defined in agreement",
- "provider service",
- "external"
- ],
- "type": "string"
- },
- "subprocessors_attributes": {
- "additionalProperties": {
- "additionalProperties": false,
- "properties": {
- "_destroy": {
- "description": "Set to true with `id` to remove that subprocessor.",
- "type": "boolean"
- },
- "country": {
- "type": "string"
- },
- "id": {
- "description": "ID of an existing subprocessor to update or remove. Omit to add a new subprocessor.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "name": {
- "type": "string"
- },
- "processing_task": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "description": "Subprocessors, keyed by string index such as \"0\", \"1\". On create these are added to the template's subprocessors. On a draft update, an entry without `id` adds a new subprocessor; pass `id` to change one and `id` with `_destroy: true` to remove one.",
- "propertyNames": {
- "type": "string"
- },
- "type": "object"
- },
- "underlying_agreement_id": {
- "description": "ID of the CSA this DPA supplements when `underlying_agreement_type` is `internal`.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "underlying_agreement_type": {
- "description": "`internal` links a CSA in Common Paper (`underlying_agreement_id`); `external` describes another agreement in `underlying_agreement_val` (required). Omit for none.",
- "enum": [
- "internal",
- "external"
- ],
- "type": "string"
- },
- "underlying_agreement_val": {
- "description": "Description of the agreement this DPA supplements. Required when `underlying_agreement_type` is `external`.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "framework_terms_description": {
- "description": "Custom framework terms description. Only used when framework_terms_type is \"description\".",
- "type": "string"
- },
- "framework_terms_type": {
- "description": "How framework terms are specified. Use \"new\" for standard terms or \"description\" to provide a custom framework_terms_description.",
- "enum": [
- "new",
- "description"
- ],
- "type": "string"
- },
- "governing_law_country": {
- "description": "The country whose laws govern the agreement.",
- "type": "string"
- },
- "governing_law_region": {
- "description": "The state or region whose laws govern the agreement.",
- "type": "string"
- },
- "include_automated_payment_reminders": {
- "description": "When true, automatically sends payment reminder emails.",
- "type": "boolean"
- },
- "include_billing_info": {
- "description": "When true, billing contact information (billing_name, billing_email) is included.",
- "type": "boolean"
- },
- "include_billing_workflow": {
- "description": "When true, enables a billing workflow after signing.",
- "type": "boolean"
- },
- "include_expiration_date": {
- "description": "Expiration date in YYYY-MM-DD format. Use when include_expiration_type is \"date\".",
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "include_expiration_days": {
- "description": "Number of days until the agreement expires. Use when include_expiration_type is \"days\".",
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_expiration_type": {
- "description": "How to set expiration: \"none\" (default), \"days\" (use include_expiration_days), or \"date\" (use include_expiration_date).",
- "enum": [
- "none",
- "days",
- "date"
- ],
- "type": "string"
- },
- "include_terms": {
- "description": "When true, the standard terms are included with the agreement.",
- "type": "boolean"
- },
- "loi_attributes": {
- "additionalProperties": false,
- "description": "Override loi terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "confidentiality_custom": {
- "type": "string"
- },
- "confidentiality_mutual_include_loi": {
- "type": "boolean"
- },
- "confidentiality_nda_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "confidentiality_nda_description": {
- "type": "string"
- },
- "confidentiality_nda_include_loi": {
- "type": "boolean"
- },
- "confidentiality_nda_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "confidentiality_type": {
- "enum": [
- "mutual",
- "nda",
- "provider",
- "custom"
- ],
- "type": "string"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_custom_details": {
- "type": "boolean"
- },
- "include_custom_details_val": {
- "type": "string"
- },
- "include_fees": {
- "type": "boolean"
- },
- "include_fees_amount": {
- "type": "number"
- },
- "include_fees_amount_duration": {
- "enum": [
- "month",
- "year",
- "quarter"
- ],
- "type": "string"
- },
- "include_fees_include_amount": {
- "type": "boolean"
- },
- "include_fees_include_other": {
- "type": "boolean"
- },
- "include_fees_other": {
- "type": "string"
- },
- "include_functionality": {
- "type": "boolean"
- },
- "include_functionality_val": {
- "type": "string"
- },
- "include_launch_date": {
- "type": "boolean"
- },
- "include_launch_date_custom": {
- "type": "string"
- },
- "include_launch_date_date": {
- "format": "date-time",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$",
- "type": "string"
- },
- "include_launch_date_type": {
- "enum": [
- "date",
- "custom"
- ],
- "type": "string"
- },
- "product_name": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "manual_send": {
- "description": "When true, the agreement is marked as manually sent outside the platform.",
- "type": "boolean"
- },
- "message": {
- "type": "string"
- },
- "negotiations_allowed": {
- "description": "When true, the recipient can propose changes to the legal terms. For agreement types without separate business terms, that covers every term. CSA order forms, PSA statements of work, partnership business terms and software license order forms have their own `negotiations_allowed` flag.",
- "type": "boolean"
- },
- "partnership_attributes": {
- "additionalProperties": false,
- "description": "Override partnership terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "effective_date": {
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "effective_date_type": {
- "enum": [
- "signature",
- "date"
- ],
- "type": "string"
- },
- "general_cap_amount_currency_val": {
- "type": "number"
- },
- "general_cap_amount_either_currency": {
- "type": "number"
- },
- "general_cap_amount_either_multiple": {
- "type": "number"
- },
- "general_cap_amount_multiple_val": {
- "type": "number"
- },
- "general_cap_amount_type": {
- "enum": [
- "multiple",
- "currency",
- "either",
- "base"
- ],
- "type": "string"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_additional_warranties": {
- "type": "boolean"
- },
- "include_additional_warranties_include_company": {
- "type": "boolean"
- },
- "include_additional_warranties_include_company_val": {
- "type": "string"
- },
- "include_additional_warranties_include_partner": {
- "type": "boolean"
- },
- "include_additional_warranties_include_partner_val": {
- "type": "string"
- },
- "include_brand_guidelines": {
- "type": "boolean"
- },
- "include_brand_guidelines_include_company": {
- "type": "boolean"
- },
- "include_brand_guidelines_include_company_val": {
- "type": "string"
- },
- "include_brand_guidelines_include_partner": {
- "type": "boolean"
- },
- "include_brand_guidelines_include_partner_val": {
- "type": "string"
- },
- "include_covered_claims": {
- "type": "boolean"
- },
- "include_covered_claims_company_claims": {
- "type": "string"
- },
- "include_covered_claims_include_company_claims": {
- "type": "boolean"
- },
- "include_covered_claims_include_partner_claims": {
- "type": "boolean"
- },
- "include_covered_claims_partner_claims": {
- "type": "string"
- },
- "include_dpa": {
- "type": "boolean"
- },
- "include_dpa_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_dpa_location": {
- "type": "string"
- },
- "include_dpa_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_increased_cap_amount": {
- "type": "boolean"
- },
- "include_increased_cap_amount_currency": {
- "type": "number"
- },
- "include_increased_cap_amount_either_currency": {
- "type": "number"
- },
- "include_increased_cap_amount_either_multiple": {
- "type": "string"
- },
- "include_increased_cap_amount_multiple": {
- "type": "string"
- },
- "include_increased_cap_amount_type": {
- "enum": [
- "multiple",
- "currency",
- "either"
- ],
- "type": "string"
- },
- "include_increased_claims": {
- "type": "boolean"
- },
- "include_increased_claims_include_confidentiality": {
- "type": "boolean"
- },
- "include_increased_claims_include_confidentiality_misconduct": {
- "type": "boolean"
- },
- "include_increased_claims_include_covered_claims": {
- "type": "boolean"
- },
- "include_increased_claims_include_misconduct": {
- "type": "boolean"
- },
- "include_increased_claims_include_other": {
- "type": "boolean"
- },
- "include_increased_claims_include_other_val": {
- "type": "string"
- },
- "include_unlimited_claims": {
- "type": "boolean"
- },
- "include_unlimited_claims_confidentiality": {
- "type": "boolean"
- },
- "include_unlimited_claims_confidentiality_misconduct": {
- "type": "boolean"
- },
- "include_unlimited_claims_covered_claims": {
- "type": "boolean"
- },
- "include_unlimited_claims_misconduct": {
- "type": "boolean"
- },
- "include_unlimited_claims_other": {
- "type": "boolean"
- },
- "include_unlimited_claims_other_val": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "partnership_business_terms_attributes": {
- "additionalProperties": false,
- "description": "Override partnership business terms terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "end_date_after_effective_date_amount": {
- "type": "number"
- },
- "end_date_after_effective_date_unit": {
- "enum": [
- "month(s)",
- "quarter(s)",
- "year(s)"
- ],
- "type": "string"
- },
- "end_date_date": {
- "type": "string"
- },
- "end_date_type": {
- "enum": [
- "date",
- "effective date"
- ],
- "type": "string"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_obligations_company_brand": {
- "type": "boolean"
- },
- "include_obligations_company_promotion": {
- "type": "boolean"
- },
- "include_obligations_company_promotion_include_activities": {
- "type": "boolean"
- },
- "include_obligations_company_promotion_include_activities_val": {
- "type": "string"
- },
- "include_obligations_company_promotion_include_materials": {
- "type": "boolean"
- },
- "include_obligations_company_promotion_include_materials_val": {
- "type": "string"
- },
- "include_obligations_company_referral": {
- "type": "boolean"
- },
- "include_obligations_company_referral_include_criteria": {
- "type": "boolean"
- },
- "include_obligations_company_referral_include_criteria_val": {
- "type": "string"
- },
- "include_obligations_company_referral_include_pay_sch": {
- "type": "boolean"
- },
- "include_obligations_company_referral_include_pay_sch_amount": {
- "type": "number"
- },
- "include_obligations_company_referral_include_pay_sch_custom": {
- "type": "string"
- },
- "include_obligations_company_referral_include_pay_sch_unit": {
- "enum": [
- "U.S. Dollars",
- "percent"
- ],
- "type": "string"
- },
- "include_obligations_company_sponsorship": {
- "type": "boolean"
- },
- "include_obligations_company_sponsorship_include_benefits": {
- "type": "boolean"
- },
- "include_obligations_company_sponsorship_include_benefits_val": {
- "type": "string"
- },
- "include_obligations_company_sponsorship_include_payments": {
- "type": "boolean"
- },
- "include_obligations_company_sponsorship_include_payments_amount": {
- "type": "number"
- },
- "include_obligations_company_sponsorship_include_payments_unit": {
- "enum": [
- "U.S. Dollars",
- "percent"
- ],
- "type": "string"
- },
- "include_obligations_partner_brand": {
- "type": "boolean"
- },
- "include_obligations_partner_promotion": {
- "type": "boolean"
- },
- "include_obligations_partner_promotion_include_activities": {
- "type": "boolean"
- },
- "include_obligations_partner_promotion_include_activities_val": {
- "type": "string"
- },
- "include_obligations_partner_promotion_include_materials": {
- "type": "boolean"
- },
- "include_obligations_partner_promotion_include_materials_val": {
- "type": "string"
- },
- "include_obligations_partner_referral": {
- "type": "boolean"
- },
- "include_obligations_partner_referral_include_criteria": {
- "type": "boolean"
- },
- "include_obligations_partner_referral_include_criteria_val": {
- "type": "string"
- },
- "include_obligations_partner_referral_include_pay_sch": {
- "type": "boolean"
- },
- "include_obligations_partner_referral_include_pay_sch_amount": {
- "type": "number"
- },
- "include_obligations_partner_referral_include_pay_sch_custom": {
- "type": "string"
- },
- "include_obligations_partner_referral_include_pay_sch_unit": {
- "enum": [
- "U.S. Dollars",
- "percent"
- ],
- "type": "string"
- },
- "include_obligations_partner_sponsorship": {
- "type": "boolean"
- },
- "include_obligations_partner_sponsorship_include_benefits": {
- "type": "boolean"
- },
- "include_obligations_partner_sponsorship_include_benefits_val": {
- "type": "string"
- },
- "include_obligations_partner_sponsorship_include_payments": {
- "type": "boolean"
- },
- "include_obligations_partner_sponsorship_include_payments_amount": {
- "type": "number"
- },
- "include_obligations_partner_sponsorship_include_payments_unit": {
- "enum": [
- "U.S. Dollars",
- "percent"
- ],
- "type": "string"
- },
- "include_payment_process": {
- "type": "boolean"
- },
- "include_payment_process_company": {
- "type": "boolean"
- },
- "include_payment_process_company_include_address": {
- "type": "boolean"
- },
- "include_payment_process_company_include_address_city": {
- "type": "string"
- },
- "include_payment_process_company_include_address_country": {
- "type": "string"
- },
- "include_payment_process_company_include_address_state": {
- "type": "string"
- },
- "include_payment_process_company_include_address_street_address": {
- "type": "string"
- },
- "include_payment_process_company_include_address_zipcode": {
- "type": "string"
- },
- "include_payment_process_company_include_email": {
- "type": "boolean"
- },
- "include_payment_process_company_include_email_val": {
- "type": "string"
- },
- "include_payment_process_partner": {
- "type": "boolean"
- },
- "include_payment_process_partner_include_address": {
- "type": "boolean"
- },
- "include_payment_process_partner_include_address_city": {
- "type": "string"
- },
- "include_payment_process_partner_include_address_country": {
- "type": "string"
- },
- "include_payment_process_partner_include_address_state": {
- "type": "string"
- },
- "include_payment_process_partner_include_address_street_address": {
- "type": "string"
- },
- "include_payment_process_partner_include_address_zipcode": {
- "type": "string"
- },
- "include_payment_process_partner_include_email": {
- "type": "boolean"
- },
- "include_payment_process_partner_include_email_val": {
- "type": "string"
- },
- "include_payment_schedule": {
- "type": "boolean"
- },
- "include_payment_schedule_custom": {
- "type": "string"
- },
- "include_payment_schedule_specified_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_payment_schedule_specified_timeframe": {
- "enum": [
- "receipt",
- "date"
- ],
- "type": "string"
- },
- "include_payment_schedule_specified_unit": {
- "enum": [
- "day(s)",
- "week(s)",
- "month(s)",
- "quarter(s)",
- "year(s)"
- ],
- "type": "string"
- },
- "include_payment_schedule_type": {
- "enum": [
- "specified",
- "custom"
- ],
- "type": "string"
- },
- "negotiations_allowed": {
- "description": "When true, the recipient can propose changes to the business terms, even when the agreement-level `negotiations_allowed` is false. This only covers the business terms.",
- "type": "boolean"
- },
- "territory_type": {
- "enum": [
- "worldwide",
- "custom"
- ],
- "type": "string"
- },
- "territory_type_val": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "payment_link_url": {
- "description": "A payment URL shown to the recipient after signing. Requires include_billing_workflow to be true and billing_workflow_type to be \"link\".",
- "type": "string"
- },
- "pilot_attributes": {
- "additionalProperties": false,
- "description": "Override pilot terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "fees_type": {
- "enum": [
- "free",
- "pilot_period_fees"
- ],
- "type": "string"
- },
- "general_cap_amount": {
- "type": "number"
- },
- "general_cap_amount_type": {
- "enum": [
- "preceding",
- "base",
- "period"
- ],
- "type": "string"
- },
- "general_cap_period_currency": {
- "type": "number"
- },
- "general_cap_period_qty": {
- "type": "number"
- },
- "general_cap_preceding_amount": {
- "type": "number"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_dpa": {
- "type": "boolean"
- },
- "include_dpa_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_dpa_location": {
- "type": "string"
- },
- "include_dpa_type": {
- "enum": [
- "description",
- "attachment",
- "standard"
- ],
- "type": "string"
- },
- "include_payment_process": {
- "type": "boolean"
- },
- "include_technical_support": {
- "type": "boolean"
- },
- "payment_process_automatic_frequency": {
- "enum": [
- "monthly",
- "quarterly",
- "annually",
- "once_per_period"
- ],
- "type": "string"
- },
- "payment_process_invoice_days": {
- "type": "number"
- },
- "payment_process_invoice_from": {
- "enum": [
- "receipt",
- "date"
- ],
- "type": "string"
- },
- "payment_process_invoice_timeframe": {
- "enum": [
- "days",
- "weeks",
- "months",
- "quarters",
- "years"
- ],
- "type": "string"
- },
- "payment_process_type": {
- "enum": [
- "automatic",
- "invoice"
- ],
- "type": "string"
- },
- "pilot_period_description": {
- "type": "string"
- },
- "pilot_period_fees_description": {
- "type": "string"
- },
- "product_description": {
- "type": "string"
- },
- "technical_support_description": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "psa_attributes": {
- "additionalProperties": false,
- "description": "Override psa terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "additional_changes": {
- "type": "string"
- },
- "customer_description": {
- "type": "string"
- },
- "effective_date": {
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "effective_date_type": {
- "enum": [
- "signature",
- "date"
- ],
- "type": "string"
- },
- "general_cap_amount": {
- "type": "number"
- },
- "general_cap_amount_type": {
- "enum": [
- "preceding",
- "base",
- "period"
- ],
- "type": "string"
- },
- "general_cap_period_currency": {
- "type": "number"
- },
- "general_cap_period_qty": {
- "type": "number"
- },
- "general_cap_preceding_amount": {
- "type": "number"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_additional_changes": {
- "type": "boolean"
- },
- "include_additional_warranties": {
- "type": "boolean"
- },
- "include_additional_warranties_by_customer": {
- "type": "string"
- },
- "include_additional_warranties_by_provider": {
- "type": "string"
- },
- "include_additional_warranties_include_by_customer": {
- "type": "boolean"
- },
- "include_additional_warranties_include_by_provider": {
- "type": "boolean"
- },
- "include_covered_claims": {
- "type": "boolean"
- },
- "include_covered_claims_customer_claims": {
- "type": "string"
- },
- "include_covered_claims_include_customer_claims": {
- "type": "boolean"
- },
- "include_covered_claims_include_provider_claims": {
- "type": "boolean"
- },
- "include_covered_claims_provider_claims": {
- "type": "string"
- },
- "include_customer_insurance_min": {
- "type": "boolean"
- },
- "include_customer_insurance_min_add_provider_com_gen_liability": {
- "type": "boolean"
- },
- "include_customer_insurance_min_add_provider_cyber_liability": {
- "type": "boolean"
- },
- "include_customer_insurance_min_add_provider_errors_omissions": {
- "type": "boolean"
- },
- "include_customer_insurance_min_auto_liability_aggregate": {
- "type": "number"
- },
- "include_customer_insurance_min_auto_liability_minimum": {
- "type": "number"
- },
- "include_customer_insurance_min_cyber_liability_aggregate": {
- "type": "number"
- },
- "include_customer_insurance_min_cyber_liability_minimum": {
- "type": "number"
- },
- "include_customer_insurance_min_employer_liability_aggregate": {
- "type": "number"
- },
- "include_customer_insurance_min_employer_liability_minimum": {
- "type": "number"
- },
- "include_customer_insurance_min_general_liability_aggregate": {
- "type": "number"
- },
- "include_customer_insurance_min_general_liability_minimum": {
- "type": "number"
- },
- "include_customer_insurance_min_include_add_provider": {
- "type": "boolean"
- },
- "include_customer_insurance_min_include_auto_liability": {
- "type": "boolean"
- },
- "include_customer_insurance_min_include_cyber_liability": {
- "type": "boolean"
- },
- "include_customer_insurance_min_include_employer_liability": {
- "type": "boolean"
- },
- "include_customer_insurance_min_include_general_liability": {
- "type": "boolean"
- },
- "include_customer_insurance_min_include_workers_comp": {
- "type": "boolean"
- },
- "include_customer_policies": {
- "type": "boolean"
- },
- "include_customer_policies_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_customer_policies_location": {
- "type": "string"
- },
- "include_customer_policies_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_dpa": {
- "type": "boolean"
- },
- "include_dpa_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_dpa_location": {
- "type": "string"
- },
- "include_dpa_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_increased_cap_amount": {
- "type": "boolean"
- },
- "include_increased_claims": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_confidentiality": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_confidentiality_negligence": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_privsec": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_privsec_negligence": {
- "type": "boolean"
- },
- "include_increased_claims_include_other": {
- "type": "boolean"
- },
- "include_increased_claims_indemnification_obligation": {
- "type": "boolean"
- },
- "include_increased_claims_negligence": {
- "type": "boolean"
- },
- "include_increased_claims_other": {
- "type": "string"
- },
- "include_provider_insurance_min": {
- "type": "boolean"
- },
- "include_provider_insurance_min_add_customer_com_gen_liability": {
- "type": "boolean"
- },
- "include_provider_insurance_min_add_customer_cyber_liability": {
- "type": "boolean"
- },
- "include_provider_insurance_min_add_customer_errors_omissions": {
- "type": "boolean"
- },
- "include_provider_insurance_min_auto_liability_aggregate": {
- "type": "number"
- },
- "include_provider_insurance_min_auto_liability_minimum": {
- "type": "number"
- },
- "include_provider_insurance_min_cyber_liability_aggregate": {
- "type": "number"
- },
- "include_provider_insurance_min_cyber_liability_minimum": {
- "type": "number"
- },
- "include_provider_insurance_min_employer_liability_aggregate": {
- "type": "number"
- },
- "include_provider_insurance_min_employer_liability_minimum": {
- "type": "number"
- },
- "include_provider_insurance_min_general_liability_aggregate": {
- "type": "number"
- },
- "include_provider_insurance_min_general_liability_minimum": {
- "type": "number"
- },
- "include_provider_insurance_min_include_add_customer": {
- "type": "boolean"
- },
- "include_provider_insurance_min_include_auto_liability": {
- "type": "boolean"
- },
- "include_provider_insurance_min_include_cyber_liability": {
- "type": "boolean"
- },
- "include_provider_insurance_min_include_employer_liability": {
- "type": "boolean"
- },
- "include_provider_insurance_min_include_general_liability": {
- "type": "boolean"
- },
- "include_provider_insurance_min_include_workers_comp": {
- "type": "boolean"
- },
- "include_publicity_rights": {
- "type": "boolean"
- },
- "include_publicity_rights_type": {
- "enum": [
- "public",
- "non-public"
- ],
- "type": "string"
- },
- "include_security_policy": {
- "type": "boolean"
- },
- "include_security_policy_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_security_policy_fedramp_auth": {
- "type": "boolean"
- },
- "include_security_policy_hitrust": {
- "type": "boolean"
- },
- "include_security_policy_include_annual_maintenance": {
- "type": "boolean"
- },
- "include_security_policy_include_other": {
- "type": "boolean"
- },
- "include_security_policy_include_other_val": {
- "type": "string"
- },
- "include_security_policy_iso27001": {
- "type": "boolean"
- },
- "include_security_policy_location": {
- "type": "string"
- },
- "include_security_policy_pci1": {
- "type": "boolean"
- },
- "include_security_policy_pci2": {
- "type": "boolean"
- },
- "include_security_policy_penetration_testing": {
- "type": "boolean"
- },
- "include_security_policy_soc2_type1": {
- "type": "boolean"
- },
- "include_security_policy_soc2_type2": {
- "type": "boolean"
- },
- "include_security_policy_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_unlimited_claims": {
- "type": "boolean"
- },
- "include_unlimited_claims_breach_of_confidentiality": {
- "type": "boolean"
- },
- "include_unlimited_claims_breach_of_confidentiality_negligence": {
- "type": "boolean"
- },
- "include_unlimited_claims_breach_of_privsec": {
- "type": "boolean"
- },
- "include_unlimited_claims_breach_of_privsec_negligence": {
- "type": "boolean"
- },
- "include_unlimited_claims_include_other": {
- "type": "boolean"
- },
- "include_unlimited_claims_indemnification_obligation": {
- "type": "boolean"
- },
- "include_unlimited_claims_negligence": {
- "type": "boolean"
- },
- "include_unlimited_claims_other": {
- "type": "string"
- },
- "increased_cap_amount_currency": {
- "type": "number"
- },
- "increased_cap_amount_period_currency": {
- "type": "number"
- },
- "increased_cap_amount_period_qty": {
- "type": "number"
- },
- "increased_cap_amount_qty": {
- "type": "number"
- },
- "increased_cap_amount_type": {
- "enum": [
- "qty",
- "currency",
- "period"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- "psa_statement_of_work_attributes": {
- "additionalProperties": false,
- "description": "Override psa statement of work terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "additional_changes": {
- "type": "string"
- },
- "cost": {
- "type": "number"
- },
- "description": {
- "type": "string"
- },
- "fee_type": {
- "type": "string"
- },
- "fees_attributes": {
- "additionalProperties": {
- "anyOf": [
- {
- "additionalProperties": false,
- "description": "Fees::Flat (fee_type \"flat\"). A fixed recurring fee, e.g. a platform subscription. Set type to \"Fees::Flat\" or fee_type to \"flat\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "Fixed amount in the order form's fees_currency, charged per fee_period. A plain amount, not cents: 20 means 20.00.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"flat\". Alternative to type.",
- "enum": [
- "flat"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Flat\". Optional when fee_type is set.",
- "enum": [
- "Fees::Flat"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Discount (fee_type \"discount\"). A discount, as a fixed amount or a percentage, applied forever, once, or for a number of months. Set type to \"Fees::Discount\" or fee_type to \"discount\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "Discount size: an amount in fees_currency when discount_type is fixed_amount (a plain amount, not cents: 20 means 20.00), or a percentage (e.g. 10 for 10%) when it is percentage.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "discount_duration_amount": {
- "description": "Number of months the discount applies. Required when discount_duration_type is multiple_months.",
- "type": "number"
- },
- "discount_duration_type": {
- "description": "How long the discount applies. multiple_months also needs discount_duration_amount.",
- "enum": [
- "forever",
- "once",
- "multiple_months"
- ],
- "type": "string"
- },
- "discount_type": {
- "description": "Whether cost is a currency amount or a percentage.",
- "enum": [
- "fixed_amount",
- "percentage"
- ],
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"discount\". Alternative to type.",
- "enum": [
- "discount"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Discount\". Optional when fee_type is set.",
- "enum": [
- "Fees::Discount"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Cost (fee_type \"cost\"). A per-unit fee: price per unit times quantity, e.g. seats. Set type to \"Fees::Cost\" or fee_type to \"cost\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "Price per unit in fees_currency. The row total is quantity x cost. A plain amount, not cents: 20 means 20.00.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"cost\". Alternative to type.",
- "enum": [
- "cost"
- ],
- "type": "string"
- },
- "quantity": {
- "description": "Number of units.",
- "type": "number"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Cost\". Optional when fee_type is set.",
- "enum": [
- "Fees::Cost"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Attachment (fee_type \"attachment\"). A fee described in an uploaded attachment instead of in the table. Set type to \"Fees::Attachment\" or fee_type to \"attachment\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "attachment_id": {
- "description": "ID of an attachment uploaded with upload-attachment.",
- "type": "string"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"attachment\". Alternative to type.",
- "enum": [
- "attachment"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Attachment\". Optional when fee_type is set.",
- "enum": [
- "Fees::Attachment"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Graduated (fee_type \"graduated\"). Tiered pricing, with the price set per tier in graduated_fee_tiers_attributes. Set type to \"Fees::Graduated\" or fee_type to \"graduated\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"graduated\". Alternative to type.",
- "enum": [
- "graduated"
- ],
- "type": "string"
- },
- "graduated_fee_tiers_attributes": {
- "additionalProperties": {
- "additionalProperties": false,
- "properties": {
- "flat_price": {
- "type": "number"
- },
- "price_per_unit": {
- "type": "string"
- },
- "upper_limit": {
- "type": "number"
- }
- },
- "type": "object"
- },
- "description": "Graduated fee tiers. Use string keys such as \"0\", \"1\".",
- "propertyNames": {
- "type": "string"
- },
- "type": "object"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Graduated\". Optional when fee_type is set.",
- "enum": [
- "Fees::Graduated"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Included (fee_type \"included\"). An item included at no charge. Set type to \"Fees::Included\" or fee_type to \"included\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"included\". Alternative to type.",
- "enum": [
- "included"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Included\". Optional when fee_type is set.",
- "enum": [
- "Fees::Included"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Metered (fee_type \"metered\"). Usage-based pricing, billed per unit used. Set type to \"Fees::Metered\" or fee_type to \"metered\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "Price per unit of usage in fees_currency. A plain amount, not cents: 20 means 20.00.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"metered\". Alternative to type.",
- "enum": [
- "metered"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Metered\". Optional when fee_type is set.",
- "enum": [
- "Fees::Metered"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::OneTime (fee_type \"one_time\"). A one-time charge, such as a setup fee. Set type to \"Fees::OneTime\" or fee_type to \"one_time\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "One-time amount in fees_currency, charged once rather than per fee_period. A plain amount, not cents: 20 means 20.00.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"one_time\". Alternative to type.",
- "enum": [
- "one_time"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::OneTime\". Optional when fee_type is set.",
- "enum": [
- "Fees::OneTime"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Text (fee_type \"text\"). A fee term described in free text. Set type to \"Fees::Text\" or fee_type to \"text\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"text\". Alternative to type.",
- "enum": [
- "text"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Text\". Optional when fee_type is set.",
- "enum": [
- "Fees::Text"
- ],
- "type": "string"
- }
- },
- "type": "object"
- }
- ]
- },
- "description": "Fee line items. Use string keys such as \"0\", \"1\". Replaces template fees when provided.",
- "propertyNames": {
- "type": "string"
- },
- "type": "object"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_additional_changes": {
- "type": "boolean"
- },
- "include_customer_obligation": {
- "type": "boolean"
- },
- "include_customer_obligation_val": {
- "type": "string"
- },
- "include_deliverables": {
- "type": "boolean"
- },
- "include_deliverables_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_deliverables_description": {
- "type": "string"
- },
- "include_deliverables_include_acceptance": {
- "type": "boolean"
- },
- "include_deliverables_include_attachment": {
- "type": "boolean"
- },
- "include_deliverables_include_draft_deliverables": {
- "type": "boolean"
- },
- "include_deliverables_rejection_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_deliverables_rejection_unit": {
- "enum": [
- "hours",
- "days",
- "weeks",
- "months"
- ],
- "type": "string"
- },
- "include_deliverables_resubmission_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_deliverables_resubmission_unit": {
- "enum": [
- "hours",
- "days",
- "weeks",
- "months"
- ],
- "type": "string"
- },
- "include_fees_other": {
- "type": "boolean"
- },
- "include_fees_other_val": {
- "type": "string"
- },
- "include_fees_table": {
- "type": "boolean"
- },
- "include_fees_table_total": {
- "type": "boolean"
- },
- "include_fees_travel": {
- "type": "boolean"
- },
- "include_fees_travel_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_fees_travel_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_fees_travel_val": {
- "type": "string"
- },
- "include_third_party_customer": {
- "type": "boolean"
- },
- "include_third_party_include_description": {
- "type": "boolean"
- },
- "include_third_party_include_description_val": {
- "type": "string"
- },
- "include_third_party_materials": {
- "type": "boolean"
- },
- "include_third_party_provider": {
- "type": "boolean"
- },
- "include_time_of_assignment": {
- "type": "boolean"
- },
- "include_time_of_assignment_type": {
- "enum": [
- "created",
- "paid"
- ],
- "type": "string"
- },
- "invoice_period_description": {
- "type": "string"
- },
- "negotiations_allowed": {
- "description": "When true, the recipient can propose changes to the statement of work, even when the agreement-level `negotiations_allowed` is false. This only covers the statement of work.",
- "type": "boolean"
- },
- "payment_period": {
- "type": "number"
- },
- "payment_period_other": {
- "type": "string"
- },
- "payment_period_timeframe": {
- "enum": [
- "receipt",
- "invoice",
- "Customer's receipt of invoice",
- "date of invoice"
- ],
- "type": "string"
- },
- "payment_period_type": {
- "enum": [
- "standard",
- "other"
- ],
- "type": "string"
- },
- "payment_period_unit": {
- "enum": [
- "day(s)",
- "week(s)",
- "month(s)",
- "quarter(s)",
- "year(s)"
- ],
- "type": "string"
- },
- "quantity": {
- "type": "number"
- },
- "services_description": {
- "type": "string"
- },
- "sow_date": {
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "sow_date_type": {
- "enum": [
- "signature",
- "date"
- ],
- "type": "string"
- },
- "sow_term_amount": {
- "type": "number"
- },
- "sow_term_date": {
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "sow_term_type": {
- "enum": [
- "deliverables",
- "period",
- "date"
- ],
- "type": "string"
- },
- "sow_term_unit": {
- "enum": [
- "month(s)",
- "quarter(s)",
- "year(s)"
- ],
- "type": "string"
- },
- "type": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "recipient_email": {
- "format": "email",
- "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
- "type": "string"
- },
- "recipient_name": {
- "type": "string"
- },
- "recipient_notice_email_address": {
- "description": "Email address for legal notices to the recipient.",
- "format": "email",
- "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
- "type": "string"
- },
- "recipient_organization": {
- "type": "string"
- },
- "recipient_role": {
- "description": "PSA only. The recipient's role: `Customer` (the default) or `Provider`. Send it with `sender_role`; the two must be one `Provider` and one `Customer`. Other standard agreement types ignore it.",
- "type": "string"
- },
- "sender_last_to_sign": {
- "description": "When true, your signer signs after the recipient.",
- "type": "boolean"
- },
- "sender_notice_email_address": {
- "description": "Email address for legal notices to the sender.",
- "format": "email",
- "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
- "type": "string"
- },
- "sender_role": {
- "description": "PSA only. Your company's role: `Provider` (the default) or `Customer` when you hire the recipient to provide the services. Send it with `recipient_role`; the two must be one `Provider` and one `Customer`. When reading a PSA, an empty `sender_role` means `Provider`. Other standard agreement types ignore it.",
- "type": "string"
- },
- "software_license_attributes": {
- "additionalProperties": false,
- "description": "Override software license terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "effective_date": {
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "effective_date_type": {
- "enum": [
- "signature",
- "date"
- ],
- "type": "string"
- },
- "general_cap_amount": {
- "type": "number"
- },
- "general_cap_amount_type": {
- "enum": [
- "preceding",
- "base",
- "period"
- ],
- "type": "string"
- },
- "general_cap_period_currency": {
- "type": "number"
- },
- "general_cap_period_qty": {
- "type": "number"
- },
- "general_cap_preceding_amount": {
- "type": "number"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_additional_warranties": {
- "type": "boolean"
- },
- "include_additional_warranties_by_customer": {
- "type": "string"
- },
- "include_additional_warranties_by_provider": {
- "type": "string"
- },
- "include_additional_warranties_include_by_customer": {
- "type": "boolean"
- },
- "include_additional_warranties_include_by_provider": {
- "type": "boolean"
- },
- "include_ai_addendum": {
- "type": "boolean"
- },
- "include_ai_addendum_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_covered_claims": {
- "type": "boolean"
- },
- "include_covered_claims_customer_claims": {
- "type": "string"
- },
- "include_covered_claims_include_customer_claims": {
- "type": "boolean"
- },
- "include_covered_claims_include_provider_claims": {
- "type": "boolean"
- },
- "include_covered_claims_provider_claims": {
- "type": "string"
- },
- "include_dpa": {
- "type": "boolean"
- },
- "include_dpa_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_dpa_location": {
- "type": "string"
- },
- "include_dpa_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_increased_cap_amount": {
- "type": "boolean"
- },
- "include_increased_claims": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_confidentiality": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_confidentiality_negligence": {
- "type": "boolean"
- },
- "include_increased_claims_include_other": {
- "type": "boolean"
- },
- "include_increased_claims_indemnification_obligation": {
- "type": "boolean"
- },
- "include_increased_claims_negligence": {
- "type": "boolean"
- },
- "include_increased_claims_other": {
- "type": "string"
- },
- "include_increased_claims_restrictions": {
- "type": "boolean"
- },
- "include_unlimited_claims": {
- "type": "boolean"
- },
- "include_unlimited_claims_breach_of_confidentiality": {
- "type": "boolean"
- },
- "include_unlimited_claims_breach_of_confidentiality_negligence": {
- "type": "boolean"
- },
- "include_unlimited_claims_include_other": {
- "type": "boolean"
- },
- "include_unlimited_claims_indemnification_obligation": {
- "type": "boolean"
- },
- "include_unlimited_claims_license_or_restrictions": {
- "type": "boolean"
- },
- "include_unlimited_claims_negligence": {
- "type": "boolean"
- },
- "include_unlimited_claims_other": {
- "type": "string"
- },
- "increased_cap_amount_currency": {
- "type": "number"
- },
- "increased_cap_amount_period_currency": {
- "type": "number"
- },
- "increased_cap_amount_period_qty": {
- "type": "number"
- },
- "increased_cap_amount_qty": {
- "type": "number"
- },
- "increased_cap_amount_type": {
- "enum": [
- "qty",
- "currency",
- "period"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- "software_license_order_form_attributes": {
- "additionalProperties": false,
- "description": "Override software license order form terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "additional_changes": {
- "type": "string"
- },
- "deletion_procedure_include_custom": {
- "type": "boolean"
- },
- "deletion_procedure_include_custom_description": {
- "type": "string"
- },
- "deletion_procedure_include_customer_disable": {
- "type": "boolean"
- },
- "deletion_procedure_include_customer_proof": {
- "type": "boolean"
- },
- "deletion_procedure_include_provider_disable": {
- "type": "boolean"
- },
- "fee_custom_unit": {
- "type": "string"
- },
- "fee_period": {
- "enum": [
- "Subscription Period",
- "month",
- "year",
- "Custom unit"
- ],
- "type": "string"
- },
- "fees_attributes": {
- "additionalProperties": {
- "anyOf": [
- {
- "additionalProperties": false,
- "description": "Fees::Flat (fee_type \"flat\"). A fixed recurring fee, e.g. a platform subscription. Set type to \"Fees::Flat\" or fee_type to \"flat\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "Fixed amount in the order form's fees_currency, charged per fee_period. A plain amount, not cents: 20 means 20.00.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"flat\". Alternative to type.",
- "enum": [
- "flat"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Flat\". Optional when fee_type is set.",
- "enum": [
- "Fees::Flat"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Discount (fee_type \"discount\"). A discount, as a fixed amount or a percentage, applied forever, once, or for a number of months. Set type to \"Fees::Discount\" or fee_type to \"discount\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "Discount size: an amount in fees_currency when discount_type is fixed_amount (a plain amount, not cents: 20 means 20.00), or a percentage (e.g. 10 for 10%) when it is percentage.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "discount_duration_amount": {
- "description": "Number of months the discount applies. Required when discount_duration_type is multiple_months.",
- "type": "number"
- },
- "discount_duration_type": {
- "description": "How long the discount applies. multiple_months also needs discount_duration_amount.",
- "enum": [
- "forever",
- "once",
- "multiple_months"
- ],
- "type": "string"
- },
- "discount_type": {
- "description": "Whether cost is a currency amount or a percentage.",
- "enum": [
- "fixed_amount",
- "percentage"
- ],
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"discount\". Alternative to type.",
- "enum": [
- "discount"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Discount\". Optional when fee_type is set.",
- "enum": [
- "Fees::Discount"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Cost (fee_type \"cost\"). A per-unit fee: price per unit times quantity, e.g. seats. Set type to \"Fees::Cost\" or fee_type to \"cost\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "Price per unit in fees_currency. The row total is quantity x cost. A plain amount, not cents: 20 means 20.00.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"cost\". Alternative to type.",
- "enum": [
- "cost"
- ],
- "type": "string"
- },
- "quantity": {
- "description": "Number of units.",
- "type": "number"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Cost\". Optional when fee_type is set.",
- "enum": [
- "Fees::Cost"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Attachment (fee_type \"attachment\"). A fee described in an uploaded attachment instead of in the table. Set type to \"Fees::Attachment\" or fee_type to \"attachment\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "attachment_id": {
- "description": "ID of an attachment uploaded with upload-attachment.",
- "type": "string"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"attachment\". Alternative to type.",
- "enum": [
- "attachment"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Attachment\". Optional when fee_type is set.",
- "enum": [
- "Fees::Attachment"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Graduated (fee_type \"graduated\"). Tiered pricing, with the price set per tier in graduated_fee_tiers_attributes. Set type to \"Fees::Graduated\" or fee_type to \"graduated\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"graduated\". Alternative to type.",
- "enum": [
- "graduated"
- ],
- "type": "string"
- },
- "graduated_fee_tiers_attributes": {
- "additionalProperties": {
- "additionalProperties": false,
- "properties": {
- "flat_price": {
- "type": "number"
- },
- "price_per_unit": {
- "type": "string"
- },
- "upper_limit": {
- "type": "number"
- }
- },
- "type": "object"
- },
- "description": "Graduated fee tiers. Use string keys such as \"0\", \"1\".",
- "propertyNames": {
- "type": "string"
- },
- "type": "object"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Graduated\". Optional when fee_type is set.",
- "enum": [
- "Fees::Graduated"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Included (fee_type \"included\"). An item included at no charge. Set type to \"Fees::Included\" or fee_type to \"included\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"included\". Alternative to type.",
- "enum": [
- "included"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Included\". Optional when fee_type is set.",
- "enum": [
- "Fees::Included"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Metered (fee_type \"metered\"). Usage-based pricing, billed per unit used. Set type to \"Fees::Metered\" or fee_type to \"metered\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "Price per unit of usage in fees_currency. A plain amount, not cents: 20 means 20.00.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"metered\". Alternative to type.",
- "enum": [
- "metered"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Metered\". Optional when fee_type is set.",
- "enum": [
- "Fees::Metered"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::OneTime (fee_type \"one_time\"). A one-time charge, such as a setup fee. Set type to \"Fees::OneTime\" or fee_type to \"one_time\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "One-time amount in fees_currency, charged once rather than per fee_period. A plain amount, not cents: 20 means 20.00.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"one_time\". Alternative to type.",
- "enum": [
- "one_time"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::OneTime\". Optional when fee_type is set.",
- "enum": [
- "Fees::OneTime"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Text (fee_type \"text\"). A fee term described in free text. Set type to \"Fees::Text\" or fee_type to \"text\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"text\". Alternative to type.",
- "enum": [
- "text"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Text\". Optional when fee_type is set.",
- "enum": [
- "Fees::Text"
- ],
- "type": "string"
- }
- },
- "type": "object"
- }
- ]
- },
- "description": "Fee line items. Use string keys such as \"0\", \"1\". Replaces template fees when provided.",
- "propertyNames": {
- "type": "string"
- },
- "type": "object"
- },
- "fees_currency": {
- "enum": [
- "USD",
- "EUR",
- "GBP",
- "CAD",
- "AUD",
- "SGD",
- "ILS",
- "JPY",
- "CHF",
- "HKD"
- ],
- "type": "string"
- },
- "fees_include_fee_increase_upon_renewal": {
- "type": "boolean"
- },
- "fees_include_fee_increase_upon_renewal_fee": {
- "type": "number"
- },
- "fees_include_fee_increase_upon_renewal_type": {
- "enum": [
- "will",
- "may"
- ],
- "type": "string"
- },
- "fees_inclusive_of_taxes": {
- "type": "boolean"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_additional_changes": {
- "type": "boolean"
- },
- "include_license_compliance_verification": {
- "type": "boolean"
- },
- "include_license_compliance_verification_description": {
- "type": "string"
- },
- "include_license_limits": {
- "type": "boolean"
- },
- "include_license_limits_description": {
- "type": "string"
- },
- "include_payment_process_include_billing_email": {
- "type": "boolean"
- },
- "include_pilot_period": {
- "type": "boolean"
- },
- "include_pilot_period_duration_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_pilot_period_duration_type": {
- "enum": [
- "day",
- "week",
- "month"
- ],
- "type": "string"
- },
- "include_pilot_period_include_fees": {
- "type": "boolean"
- },
- "include_pilot_period_include_fees_amount": {
- "type": "number"
- },
- "include_pilot_period_include_modifications": {
- "type": "boolean"
- },
- "include_pilot_period_include_modifications_description": {
- "type": "string"
- },
- "include_services": {
- "type": "boolean"
- },
- "include_services_description": {
- "type": "string"
- },
- "negotiations_allowed": {
- "description": "When true, the recipient can propose changes to the order form, even when the agreement-level `negotiations_allowed` is false. This only covers the order form.",
- "type": "boolean"
- },
- "order_date_date": {
- "type": "string"
- },
- "order_date_type": {
- "enum": [
- "signature",
- "date",
- "other"
- ],
- "type": "string"
- },
- "payment_process_automatic_frequency": {
- "enum": [
- "monthly",
- "quarterly",
- "semiannually",
- "annually"
- ],
- "type": "string"
- },
- "payment_process_type": {
- "enum": [
- "automatic",
- "invoice",
- "custom"
- ],
- "type": "string"
- },
- "payment_process_type_custom_val": {
- "type": "string"
- },
- "payment_process_type_invoice_amount": {
- "type": "number"
- },
- "payment_process_type_invoice_custom_unit": {
- "type": "string"
- },
- "payment_process_type_invoice_duration": {
- "enum": [
- "day",
- "week",
- "month",
- "year",
- "day(s)",
- "week(s)",
- "month(s)",
- "year(s)"
- ],
- "type": "string"
- },
- "payment_process_type_invoice_duration_start": {
- "enum": [
- "Customer's receipt of invoice",
- "date of invoice"
- ],
- "type": "string"
- },
- "payment_process_type_invoice_type": {
- "enum": [
- "monthly",
- "quarterly",
- "semiannually",
- "annually",
- "Custom unit"
- ],
- "type": "string"
- },
- "permitted_uses_include_custom": {
- "type": "boolean"
- },
- "permitted_uses_include_custom_description": {
- "type": "string"
- },
- "permitted_uses_include_customers_affiliates": {
- "type": "boolean"
- },
- "permitted_uses_include_internal_business": {
- "type": "boolean"
- },
- "pilot_period_stripe_product_id": {
- "type": "string"
- },
- "software_description": {
- "type": "string"
- },
- "subscription_auto_renew": {
- "enum": [
- "days",
- "subscription_end"
- ],
- "type": "string"
- },
- "subscription_period": {
- "type": "number"
- },
- "subscription_period_unit": {
- "type": "string"
- },
- "subscription_renewal_notice_days": {
- "type": "number"
- },
- "warranty_period_description_amount": {
- "type": "number"
- },
- "warranty_period_description_duration": {
- "enum": [
- "day",
- "week",
- "month",
- "year"
- ],
- "type": "string"
- },
- "warranty_period_description_duration_start": {
- "enum": [
- "initial delivery of the Software",
- "delivery of the Software and each subsequent Update",
- "the Order Date"
- ],
- "type": "string"
- },
- "warranty_period_type": {
- "enum": [
- "description",
- "none"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- "test_agreement": {
- "description": "When true, marks the agreement as a test. Test agreements do not count against your monthly limit.",
- "type": "boolean"
- }
- },
- "required": [
- "recipient_name",
- "recipient_email"
- ],
- "type": "object"
- },
- "cc_users": {
- "items": {
- "format": "email",
- "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
- "type": "string"
- },
- "type": "array"
- },
- "draft": {
- "description": "When true, the agreement is saved as a draft and not sent to the recipient. Use POST /v1/agreements/{id}/send to send a draft agreement later.",
- "type": "boolean"
- },
- "owner_email": {
- "description": "Email address of the agreement owner (sender).",
- "type": "string"
- },
- "signer_id": {
- "description": "User id of the signer from the owner's organization.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "template_id": {
- "description": "UUID of a template from `GET /v1/templates`. Accepts both Common Paper standard templates and uploaded PDF templates (`type` `uploaded_template`).",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- }
- },
- "required": [
- "template_id",
- "owner_email",
- "signer_id",
- "agreement"
- ],
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "agreement": {
- "additionalProperties": {},
- "properties": {
- "amendment_attributes": {
- "additionalProperties": false,
- "description": "Override amendment terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "amended_terms_attributes": {
- "additionalProperties": {
- "additionalProperties": false,
- "properties": {
- "description": {
- "type": "string"
- },
- "term": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "description": "Amended terms. Use string keys such as \"0\", \"1\".",
- "propertyNames": {
- "type": "string"
- },
- "type": "object"
- },
- "amendment_date": {
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "amendment_date_type": {
- "enum": [
- "signature",
- "date"
- ],
- "type": "string"
- },
- "framework_terms_type": {
- "type": "string"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "parent_agreement_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "underlying_agreement_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "underlying_agreement_type": {
- "type": "string"
- },
- "underlying_agreement_val": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "baa_attributes": {
- "additionalProperties": false,
- "description": "Override baa terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "aggregation_limitations_permitted": {
- "type": "boolean"
- },
- "aggregation_limitations_permitted_val": {
- "type": "string"
- },
- "breach_notification_unit": {
- "enum": [
- "hours",
- "business days",
- "calendar days"
- ],
- "type": "string"
- },
- "breach_notification_val": {
- "type": "number"
- },
- "business_associate_relationship_type": {
- "enum": [
- "provider",
- "company"
- ],
- "type": "string"
- },
- "deidentification_limitations_include_purpose": {
- "type": "boolean"
- },
- "deidentification_limitations_include_requirements": {
- "type": "boolean"
- },
- "deidentification_limitations_permitted": {
- "type": "boolean"
- },
- "deidentification_limitations_purpose_val": {
- "type": "string"
- },
- "deidentification_limitations_requirements_val": {
- "type": "string"
- },
- "designated_record_set_provider_maintains": {
- "type": "boolean"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_aggregation_limitations": {
- "type": "boolean"
- },
- "include_deidentification_limitations": {
- "type": "boolean"
- },
- "include_limitations": {
- "type": "boolean"
- },
- "include_offshore_limitations": {
- "type": "boolean"
- },
- "include_subcontract_limitations": {
- "type": "boolean"
- },
- "offshore_limitations_permitted": {
- "type": "boolean"
- },
- "offshore_limitations_permitted_val": {
- "type": "string"
- },
- "subcontract_limitations_include_notice": {
- "type": "boolean"
- },
- "subcontract_limitations_include_permission": {
- "type": "boolean"
- },
- "subcontract_limitations_notice_val": {
- "type": "string"
- },
- "subcontract_limitations_permission_val": {
- "type": "string"
- },
- "subcontract_limitations_permitted": {
- "type": "boolean"
- },
- "underlying_agreement_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "underlying_agreement_type": {
- "enum": [
- "internal",
- "external",
- "none"
- ],
- "type": "string"
- },
- "underlying_agreement_val": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "billing_email": {
- "description": "Email of the billing contact. Used when include_billing_info is true.",
- "format": "email",
- "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
- "type": "string"
- },
- "billing_name": {
- "description": "Name of the billing contact. Used when include_billing_info is true.",
- "type": "string"
- },
- "billing_workflow_type": {
- "description": "The type of billing workflow. Use \"link\" to provide a payment_link_url, or \"stripe\" for Stripe-managed billing.",
- "enum": [
- "link",
- "stripe"
- ],
- "type": "string"
- },
- "chosen_courts_country": {
- "description": "The country in which disputes will be resolved.",
- "type": "string"
- },
- "chosen_courts_region": {
- "description": "The state or region in which disputes will be resolved.",
- "type": "string"
- },
- "csa_attributes": {
- "additionalProperties": false,
- "description": "Override csa terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "customer_description": {
- "type": "string"
- },
- "effective_date": {
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "effective_date_marketplace": {
- "enum": [
- "AWS",
- "GCP",
- "Azure"
- ],
- "type": "string"
- },
- "effective_date_type": {
- "enum": [
- "signature",
- "date",
- "marketplace_acceptance"
- ],
- "type": "string"
- },
- "general_cap_amount": {
- "type": "number"
- },
- "general_cap_amount_type": {
- "enum": [
- "preceding",
- "base",
- "period"
- ],
- "type": "string"
- },
- "general_cap_period_currency": {
- "type": "number"
- },
- "general_cap_period_qty": {
- "type": "number"
- },
- "general_cap_preceding_amount": {
- "type": "number"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_acceptable_use_policy": {
- "type": "boolean"
- },
- "include_acceptable_use_policy_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_acceptable_use_policy_location": {
- "type": "string"
- },
- "include_acceptable_use_policy_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_additional_warranties": {
- "type": "boolean"
- },
- "include_additional_warranties_by_customer": {
- "type": "string"
- },
- "include_additional_warranties_by_provider": {
- "type": "string"
- },
- "include_additional_warranties_include_by_customer": {
- "type": "boolean"
- },
- "include_additional_warranties_include_by_provider": {
- "type": "boolean"
- },
- "include_ai_addendum": {
- "type": "boolean"
- },
- "include_ai_addendum_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_covered_claims": {
- "type": "boolean"
- },
- "include_covered_claims_customer_claims": {
- "type": "string"
- },
- "include_covered_claims_include_customer_claims": {
- "type": "boolean"
- },
- "include_covered_claims_include_provider_claims": {
- "type": "boolean"
- },
- "include_covered_claims_provider_claims": {
- "type": "string"
- },
- "include_dpa": {
- "type": "boolean"
- },
- "include_dpa_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_dpa_location": {
- "type": "string"
- },
- "include_dpa_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_increased_cap_amount": {
- "type": "boolean"
- },
- "include_increased_claims": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_confidentiality": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_confidentiality_negligence": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_privsec": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_privsec_negligence": {
- "type": "boolean"
- },
- "include_increased_claims_include_other": {
- "type": "boolean"
- },
- "include_increased_claims_indemnification_obligation": {
- "type": "boolean"
- },
- "include_increased_claims_other": {
- "type": "string"
- },
- "include_insurance_minimums": {
- "type": "boolean"
- },
- "include_insurance_minimums_add_customer": {
- "type": "boolean"
- },
- "include_insurance_minimums_add_customer_com_gen_liability": {
- "type": "boolean"
- },
- "include_insurance_minimums_add_customer_cyber_liability": {
- "type": "boolean"
- },
- "include_insurance_minimums_add_customer_errors_omissions": {
- "type": "boolean"
- },
- "include_insurance_minimums_additional_information": {
- "type": "boolean"
- },
- "include_insurance_minimums_additional_information_text": {
- "type": "string"
- },
- "include_insurance_minimums_cyber_liability_aggregate": {
- "type": "number"
- },
- "include_insurance_minimums_cyber_liability_minimum": {
- "type": "number"
- },
- "include_insurance_minimums_employer_liability_aggregate": {
- "type": "number"
- },
- "include_insurance_minimums_employer_liability_minimum": {
- "type": "number"
- },
- "include_insurance_minimums_general_liability_aggregate": {
- "type": "number"
- },
- "include_insurance_minimums_general_liability_minimum": {
- "type": "number"
- },
- "include_insurance_minimums_include_cyber_liability": {
- "type": "boolean"
- },
- "include_insurance_minimums_include_employer_liability": {
- "type": "boolean"
- },
- "include_insurance_minimums_include_general_liability": {
- "type": "boolean"
- },
- "include_insurance_minimums_include_workers_compensation": {
- "type": "boolean"
- },
- "include_publicity_rights": {
- "type": "boolean"
- },
- "include_publicity_rights_type": {
- "enum": [
- "public",
- "non-public"
- ],
- "type": "string"
- },
- "include_security_policy": {
- "type": "boolean"
- },
- "include_security_policy_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_security_policy_fedramp_auth": {
- "type": "boolean"
- },
- "include_security_policy_hipaa": {
- "type": "boolean"
- },
- "include_security_policy_hitrust": {
- "type": "boolean"
- },
- "include_security_policy_include_annual_maintenance": {
- "type": "boolean"
- },
- "include_security_policy_include_location": {
- "type": "boolean"
- },
- "include_security_policy_include_other": {
- "type": "boolean"
- },
- "include_security_policy_include_reasonable_efforts": {
- "type": "boolean"
- },
- "include_security_policy_iso27001": {
- "type": "boolean"
- },
- "include_security_policy_location": {
- "type": "string"
- },
- "include_security_policy_other": {
- "type": "string"
- },
- "include_security_policy_pci1": {
- "type": "boolean"
- },
- "include_security_policy_pci2": {
- "type": "boolean"
- },
- "include_security_policy_penetration_testing": {
- "type": "boolean"
- },
- "include_security_policy_soc2": {
- "type": "boolean"
- },
- "include_security_policy_soc2_type2": {
- "type": "boolean"
- },
- "include_security_policy_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_supercap": {
- "description": "CSA 3.0 renamed `include_increased_cap_amount` to `include_supercap`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_increased_cap_amount`. Sending the other spelling returns a 422.",
- "type": "boolean"
- },
- "include_uncapped_claims": {
- "description": "CSA 3.0 renamed `include_unlimited_claims` to `include_uncapped_claims`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims`. Sending the other spelling returns a 422.",
- "type": "boolean"
- },
- "include_uncapped_claims_breach_of_confidentiality": {
- "description": "CSA 3.0 renamed `include_unlimited_claims_breach_of_confidentiality` to `include_uncapped_claims_breach_of_confidentiality`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_breach_of_confidentiality`. Sending the other spelling returns a 422.",
- "type": "boolean"
- },
- "include_uncapped_claims_breach_of_confidentiality_negligence": {
- "description": "CSA 3.0 renamed `include_unlimited_claims_breach_of_confidentiality_negligence` to `include_uncapped_claims_breach_of_confidentiality_negligence`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_breach_of_confidentiality_negligence`. Sending the other spelling returns a 422.",
- "type": "boolean"
- },
- "include_uncapped_claims_breach_of_privsec": {
- "description": "CSA 3.0 renamed `include_unlimited_claims_breach_of_privsec` to `include_uncapped_claims_breach_of_privsec`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_breach_of_privsec`. Sending the other spelling returns a 422.",
- "type": "boolean"
- },
- "include_uncapped_claims_breach_of_privsec_negligence": {
- "description": "CSA 3.0 renamed `include_unlimited_claims_breach_of_privsec_negligence` to `include_uncapped_claims_breach_of_privsec_negligence`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_breach_of_privsec_negligence`. Sending the other spelling returns a 422.",
- "type": "boolean"
- },
- "include_uncapped_claims_include_other": {
- "description": "CSA 3.0 renamed `include_unlimited_claims_include_other` to `include_uncapped_claims_include_other`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_include_other`. Sending the other spelling returns a 422.",
- "type": "boolean"
- },
- "include_uncapped_claims_indemnification_obligation": {
- "description": "CSA 3.0 renamed `include_unlimited_claims_indemnification_obligation` to `include_uncapped_claims_indemnification_obligation`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_indemnification_obligation`. Sending the other spelling returns a 422.",
- "type": "boolean"
- },
- "include_uncapped_claims_other": {
- "description": "CSA 3.0 renamed `include_unlimited_claims_other` to `include_uncapped_claims_other`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_other`. Sending the other spelling returns a 422.",
- "type": "boolean"
- },
- "include_unlimited_claims": {
- "type": "boolean"
- },
- "include_unlimited_claims_breach_of_confidentiality": {
- "type": "boolean"
- },
- "include_unlimited_claims_breach_of_confidentiality_negligence": {
- "type": "boolean"
- },
- "include_unlimited_claims_breach_of_privsec": {
- "type": "boolean"
- },
- "include_unlimited_claims_breach_of_privsec_negligence": {
- "type": "boolean"
- },
- "include_unlimited_claims_include_other": {
- "type": "boolean"
- },
- "include_unlimited_claims_indemnification_obligation": {
- "type": "boolean"
- },
- "include_unlimited_claims_other": {
- "type": "string"
- },
- "increased_cap_amount_currency": {
- "type": "number"
- },
- "increased_cap_amount_period_currency": {
- "type": "number"
- },
- "increased_cap_amount_period_qty": {
- "type": "number"
- },
- "increased_cap_amount_qty": {
- "type": "number"
- },
- "increased_cap_amount_type": {
- "enum": [
- "qty",
- "currency",
- "period"
- ],
- "type": "string"
- },
- "provider": {
- "type": "string"
- },
- "supercap_currency": {
- "description": "CSA 3.0 renamed `increased_cap_amount_currency` to `supercap_currency`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `increased_cap_amount_currency`. Sending the other spelling returns a 422.",
- "type": "number"
- },
- "supercap_period_currency": {
- "description": "CSA 3.0 renamed `increased_cap_amount_period_currency` to `supercap_period_currency`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `increased_cap_amount_period_currency`. Sending the other spelling returns a 422.",
- "type": "number"
- },
- "supercap_period_qty": {
- "description": "CSA 3.0 renamed `increased_cap_amount_period_qty` to `supercap_period_qty`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `increased_cap_amount_period_qty`. Sending the other spelling returns a 422.",
- "type": "number"
- },
- "supercap_qty": {
- "description": "CSA 3.0 renamed `increased_cap_amount_qty` to `supercap_qty`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `increased_cap_amount_qty`. Sending the other spelling returns a 422.",
- "type": "number"
- },
- "supercap_type": {
- "description": "CSA 3.0 renamed `increased_cap_amount_type` to `supercap_type`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `increased_cap_amount_type`. Sending the other spelling returns a 422.",
- "type": "number"
- }
- },
- "type": "object"
- },
- "csa_order_form_attributes": {
- "additionalProperties": false,
- "description": "Override csa order form terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "additional_changes": {
- "type": "string"
- },
- "additional_parameters_or_limitations": {
- "type": "string"
- },
- "affiliates_as_users": {
- "type": "boolean"
- },
- "cloud_service_description": {
- "type": "string"
- },
- "consumption_units": {
- "type": "string"
- },
- "fee_amount": {
- "type": "number"
- },
- "fee_custom_unit": {
- "type": "string"
- },
- "fee_period": {
- "enum": [
- "Subscription Period",
- "month",
- "year",
- "User",
- "Custom unit"
- ],
- "type": "string"
- },
- "fees_attributes": {
- "additionalProperties": {
- "anyOf": [
- {
- "additionalProperties": false,
- "description": "Fees::Flat (fee_type \"flat\"). A fixed recurring fee, e.g. a platform subscription. Set type to \"Fees::Flat\" or fee_type to \"flat\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "Fixed amount in the order form's fees_currency, charged per fee_period. A plain amount, not cents: 20 means 20.00.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"flat\". Alternative to type.",
- "enum": [
- "flat"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Flat\". Optional when fee_type is set.",
- "enum": [
- "Fees::Flat"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Discount (fee_type \"discount\"). A discount, as a fixed amount or a percentage, applied forever, once, or for a number of months. Set type to \"Fees::Discount\" or fee_type to \"discount\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "Discount size: an amount in fees_currency when discount_type is fixed_amount (a plain amount, not cents: 20 means 20.00), or a percentage (e.g. 10 for 10%) when it is percentage.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "discount_duration_amount": {
- "description": "Number of months the discount applies. Required when discount_duration_type is multiple_months.",
- "type": "number"
- },
- "discount_duration_type": {
- "description": "How long the discount applies. multiple_months also needs discount_duration_amount.",
- "enum": [
- "forever",
- "once",
- "multiple_months"
- ],
- "type": "string"
- },
- "discount_type": {
- "description": "Whether cost is a currency amount or a percentage.",
- "enum": [
- "fixed_amount",
- "percentage"
- ],
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"discount\". Alternative to type.",
- "enum": [
- "discount"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Discount\". Optional when fee_type is set.",
- "enum": [
- "Fees::Discount"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Cost (fee_type \"cost\"). A per-unit fee: price per unit times quantity, e.g. seats. Set type to \"Fees::Cost\" or fee_type to \"cost\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "Price per unit in fees_currency. The row total is quantity x cost. A plain amount, not cents: 20 means 20.00.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"cost\". Alternative to type.",
- "enum": [
- "cost"
- ],
- "type": "string"
- },
- "quantity": {
- "description": "Number of units.",
- "type": "number"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Cost\". Optional when fee_type is set.",
- "enum": [
- "Fees::Cost"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Attachment (fee_type \"attachment\"). A fee described in an uploaded attachment instead of in the table. Set type to \"Fees::Attachment\" or fee_type to \"attachment\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "attachment_id": {
- "description": "ID of an attachment uploaded with upload-attachment.",
- "type": "string"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"attachment\". Alternative to type.",
- "enum": [
- "attachment"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Attachment\". Optional when fee_type is set.",
- "enum": [
- "Fees::Attachment"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Graduated (fee_type \"graduated\"). Tiered pricing, with the price set per tier in graduated_fee_tiers_attributes. Set type to \"Fees::Graduated\" or fee_type to \"graduated\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"graduated\". Alternative to type.",
- "enum": [
- "graduated"
- ],
- "type": "string"
- },
- "graduated_fee_tiers_attributes": {
- "additionalProperties": {
- "additionalProperties": false,
- "properties": {
- "flat_price": {
- "type": "number"
- },
- "price_per_unit": {
- "type": "string"
- },
- "upper_limit": {
- "type": "number"
- }
- },
- "type": "object"
- },
- "description": "Graduated fee tiers. Use string keys such as \"0\", \"1\".",
- "propertyNames": {
- "type": "string"
- },
- "type": "object"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Graduated\". Optional when fee_type is set.",
- "enum": [
- "Fees::Graduated"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Included (fee_type \"included\"). An item included at no charge. Set type to \"Fees::Included\" or fee_type to \"included\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"included\". Alternative to type.",
- "enum": [
- "included"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Included\". Optional when fee_type is set.",
- "enum": [
- "Fees::Included"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Metered (fee_type \"metered\"). Usage-based pricing, billed per unit used. Set type to \"Fees::Metered\" or fee_type to \"metered\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "Price per unit of usage in fees_currency. A plain amount, not cents: 20 means 20.00.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"metered\". Alternative to type.",
- "enum": [
- "metered"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Metered\". Optional when fee_type is set.",
- "enum": [
- "Fees::Metered"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::OneTime (fee_type \"one_time\"). A one-time charge, such as a setup fee. Set type to \"Fees::OneTime\" or fee_type to \"one_time\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "One-time amount in fees_currency, charged once rather than per fee_period. A plain amount, not cents: 20 means 20.00.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"one_time\". Alternative to type.",
- "enum": [
- "one_time"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::OneTime\". Optional when fee_type is set.",
- "enum": [
- "Fees::OneTime"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Text (fee_type \"text\"). A fee term described in free text. Set type to \"Fees::Text\" or fee_type to \"text\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"text\". Alternative to type.",
- "enum": [
- "text"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Text\". Optional when fee_type is set.",
- "enum": [
- "Fees::Text"
- ],
- "type": "string"
- }
- },
- "type": "object"
- }
- ]
- },
- "description": "Fee table rows, keyed by string index (\"0\", \"1\", ...). Replaces the template's fees when provided. Each row sets type or fee_type to pick the fee class. Amounts are in the order form's fees_currency and, for recurring fees, are charged per fee_period.",
- "examples": [
- {
- "0": {
- "cost": 2000,
- "description": "Platform subscription",
- "type": "Fees::Flat"
- }
- },
- {
- "0": {
- "cost": 50,
- "description": "Seats",
- "fee_type": "cost",
- "quantity": 10
- },
- "1": {
- "cost": 10,
- "description": "Launch discount",
- "discount_duration_amount": 3,
- "discount_duration_type": "multiple_months",
- "discount_type": "percentage",
- "fee_type": "discount"
- }
- }
- ],
- "propertyNames": {
- "type": "string"
- },
- "type": "object"
- },
- "fees_currency": {
- "enum": [
- "USD",
- "EUR",
- "GBP",
- "CAD",
- "AUD",
- "SGD",
- "ILS",
- "JPY",
- "CHF",
- "HKD"
- ],
- "type": "string"
- },
- "fees_include_fee_increase_upon_renewal": {
- "type": "boolean"
- },
- "fees_include_fee_increase_upon_renewal_fee": {
- "type": "number"
- },
- "fees_include_fee_increase_upon_renewal_type": {
- "enum": [
- "will",
- "may"
- ],
- "type": "string"
- },
- "fees_inclusive_of_taxes": {
- "type": "boolean"
- },
- "framework_terms_type": {
- "enum": [
- "new",
- "existing",
- "description"
- ],
- "type": "string"
- },
- "free_trial_days": {
- "type": "number"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_additional_changes": {
- "type": "boolean"
- },
- "include_additional_parameters_or_limitations": {
- "type": "boolean"
- },
- "include_consumption": {
- "type": "boolean"
- },
- "include_fees": {
- "type": "boolean"
- },
- "include_fees_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_fees_include_attachment": {
- "type": "boolean"
- },
- "include_fees_other": {
- "type": "boolean"
- },
- "include_fees_other_val": {
- "type": "string"
- },
- "include_fees_table": {
- "type": "boolean"
- },
- "include_fees_table_period": {
- "enum": [
- "Subscription Period",
- "month",
- "year",
- "User"
- ],
- "type": "string"
- },
- "include_free_trial": {
- "type": "boolean"
- },
- "include_max_users": {
- "type": "boolean"
- },
- "include_pilot_period": {
- "type": "boolean"
- },
- "include_pilot_period_duration_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_pilot_period_duration_type": {
- "enum": [
- "day",
- "week",
- "month"
- ],
- "type": "string"
- },
- "include_pilot_period_include_fees": {
- "type": "boolean"
- },
- "include_pilot_period_include_fees_amount": {
- "type": "number"
- },
- "include_pilot_period_include_modifications": {
- "type": "boolean"
- },
- "include_pilot_period_include_modifications_description": {
- "type": "string"
- },
- "include_product_support": {
- "type": "boolean"
- },
- "include_product_support_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_product_support_description": {
- "type": "string"
- },
- "include_product_support_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_professional_services": {
- "type": "boolean"
- },
- "include_professional_services_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_professional_services_custom_name": {
- "type": "string"
- },
- "include_professional_services_description": {
- "type": "string"
- },
- "include_professional_services_end_date": {
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "include_professional_services_fees_description": {
- "type": "string"
- },
- "include_professional_services_include_end_date": {
- "type": "boolean"
- },
- "include_professional_services_include_fees_description": {
- "type": "boolean"
- },
- "include_professional_services_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_sla": {
- "type": "boolean"
- },
- "include_sla_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_sla_description": {
- "type": "string"
- },
- "include_sla_include_response_time": {
- "type": "boolean"
- },
- "include_sla_include_response_time_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_sla_include_response_time_credit": {
- "type": "number"
- },
- "include_sla_include_response_time_duration": {
- "enum": [
- "hour",
- "day",
- "week",
- "month",
- "hours"
- ],
- "type": "string"
- },
- "include_sla_include_response_time_support_channel": {
- "type": "string"
- },
- "include_sla_include_target_uptime": {
- "type": "boolean"
- },
- "include_sla_maintenance_notice": {
- "type": "boolean"
- },
- "include_sla_maintenance_window": {
- "type": "boolean"
- },
- "include_sla_maintenance_window_type": {
- "enum": [
- "standard",
- "none"
- ],
- "type": "string"
- },
- "include_sla_standard_maintenance_notice_qty": {
- "type": "number"
- },
- "include_sla_standard_maintenance_notice_unit": {
- "enum": [
- "hour",
- "day",
- "week",
- "month"
- ],
- "type": "string"
- },
- "include_sla_standard_maintenance_window_end_time": {
- "type": "string"
- },
- "include_sla_standard_maintenance_window_friday": {
- "type": "boolean"
- },
- "include_sla_standard_maintenance_window_monday": {
- "type": "boolean"
- },
- "include_sla_standard_maintenance_window_saturday": {
- "type": "boolean"
- },
- "include_sla_standard_maintenance_window_start_time": {
- "type": "string"
- },
- "include_sla_standard_maintenance_window_sunday": {
- "type": "boolean"
- },
- "include_sla_standard_maintenance_window_thursday": {
- "type": "boolean"
- },
- "include_sla_standard_maintenance_window_time_zone": {
- "type": "string"
- },
- "include_sla_standard_maintenance_window_tuesday": {
- "type": "boolean"
- },
- "include_sla_standard_maintenance_window_wednesday": {
- "type": "boolean"
- },
- "include_sla_standard_target_uptime": {
- "type": "number"
- },
- "include_sla_type": {
- "enum": [
- "description",
- "standard",
- "attachment"
- ],
- "type": "string"
- },
- "include_subscription_start_date": {
- "type": "boolean"
- },
- "include_subscription_start_date_date": {
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "include_usage_review": {
- "type": "boolean"
- },
- "include_usage_review_val": {
- "type": "string"
- },
- "include_use_limitations": {
- "type": "boolean"
- },
- "include_use_limitations_val": {
- "type": "string"
- },
- "invoice_period": {
- "enum": [
- "monthly",
- "quarterly",
- "semiannually",
- "annually",
- "Custom unit",
- "Monthly",
- "Quarterly",
- "Semiannually",
- "Annually"
- ],
- "type": "string"
- },
- "invoice_period_custom_unit": {
- "type": "string"
- },
- "max_consumption": {
- "type": "number"
- },
- "max_users": {
- "type": "number"
- },
- "negotiations_allowed": {
- "description": "When true, the recipient can propose changes to the order form, even when the agreement-level `negotiations_allowed` is false. This only covers the order form.",
- "type": "boolean"
- },
- "order_date_date": {
- "type": "string"
- },
- "order_date_other": {
- "type": "string"
- },
- "order_date_type": {
- "enum": [
- "signature",
- "date",
- "other"
- ],
- "type": "string"
- },
- "payment_period": {
- "type": "number"
- },
- "payment_period_timeframe": {
- "enum": [
- "Customer's receipt of invoice",
- "date of invoice"
- ],
- "type": "string"
- },
- "payment_period_unit": {
- "enum": [
- "day(s)",
- "week(s)",
- "month(s)",
- "marketplace_acceptance"
- ],
- "type": "string"
- },
- "payment_process_automatic_frequency": {
- "enum": [
- "monthly",
- "quarterly",
- "semiannually",
- "annually"
- ],
- "type": "string"
- },
- "payment_process_type": {
- "enum": [
- "automatic",
- "invoice",
- "custom",
- "marketplace_acceptance"
- ],
- "type": "string"
- },
- "payment_process_type_custom_val": {
- "type": "string"
- },
- "payment_process_type_invoice_amount": {
- "type": "number"
- },
- "payment_process_type_invoice_custom_unit": {
- "type": "string"
- },
- "payment_process_type_invoice_duration": {
- "enum": [
- "day",
- "week",
- "month",
- "year",
- "day(s)",
- "week(s)",
- "month(s)",
- "year(s)"
- ],
- "type": "string"
- },
- "payment_process_type_invoice_duration_start": {
- "enum": [
- "Customer's receipt of invoice",
- "date of invoice"
- ],
- "type": "string"
- },
- "payment_process_type_invoice_type": {
- "enum": [
- "monthly",
- "quarterly",
- "semiannually",
- "annually",
- "Custom unit"
- ],
- "type": "string"
- },
- "pilot_period_stripe_product_id": {
- "type": "string"
- },
- "service_credits_attributes": {
- "additionalProperties": {
- "additionalProperties": false,
- "properties": {
- "credit": {
- "type": "number"
- },
- "max": {
- "type": "number"
- },
- "min": {
- "type": "number"
- }
- },
- "type": "object"
- },
- "description": "Service credits. Use string keys such as \"0\", \"1\".",
- "propertyNames": {
- "type": "string"
- },
- "type": "object"
- },
- "subscription_auto_renew": {
- "enum": [
- "days",
- "subscription_end"
- ],
- "type": "string"
- },
- "subscription_period": {
- "type": "number"
- },
- "subscription_period_unit": {
- "type": "string"
- },
- "subscription_renewal_notice_days": {
- "type": "number"
- },
- "subscription_start_date": {
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "subscription_start_date_type": {
- "enum": [
- "effective_date",
- "date"
- ],
- "type": "string"
- },
- "underlying_agreement_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "use_limitations_attributes": {
- "additionalProperties": {
- "additionalProperties": false,
- "properties": {
- "amount": {
- "type": "number"
- },
- "limitation_type": {
- "type": "string"
- },
- "unit": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "description": "Use limitations. Use string keys such as \"0\", \"1\".",
- "propertyNames": {
- "type": "string"
- },
- "type": "object"
- }
- },
- "type": "object"
- },
- "custom_field_values": {
- "description": "Values for a custom template's fields, keyed by the field keys defined in the template's YAML definition. Only used when template_id is a custom template. Template defaults fill any fields you omit; a required field with no default and no submitted value returns a 400 naming the field. Values are validated against the field's input type: select and radio values must be one of the field's options, multiselect values are an array of selections each of which must be one of the field's options, number and currency values must be numeric, date values must be YYYY-MM-DD, and email values must be valid addresses. An invalid value returns a 400 naming the field."
- },
- "design_partner_attributes": {
- "additionalProperties": false,
- "description": "Override design partner terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "customer_description": {
- "type": "string"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_fees": {
- "type": "boolean"
- },
- "include_fees_amount": {
- "type": "number"
- },
- "include_fees_description": {
- "type": "string"
- },
- "include_fees_pay_by_amount": {
- "type": "string"
- },
- "include_fees_type": {
- "enum": [
- "default_language",
- "description"
- ],
- "type": "string"
- },
- "include_fees_unit": {
- "enum": [
- "month",
- "quarter",
- "year",
- "Term"
- ],
- "type": "string"
- },
- "include_program_appear_as_customer_private": {
- "type": "boolean"
- },
- "include_program_appear_as_customer_public": {
- "type": "boolean"
- },
- "include_program_case_study": {
- "type": "boolean"
- },
- "include_program_develop_functionality": {
- "type": "boolean"
- },
- "include_program_develop_functionality_val": {
- "type": "string"
- },
- "include_program_discount": {
- "type": "boolean"
- },
- "include_program_discount_amount": {
- "type": "number"
- },
- "include_program_discount_unit": {
- "enum": [
- "U.S. Dollars",
- "percent"
- ],
- "type": "string"
- },
- "include_program_participation_feedback": {
- "type": "boolean"
- },
- "include_program_participation_feedback_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_program_participation_feedback_unit": {
- "enum": [
- "month",
- "quarter",
- "year",
- "Term"
- ],
- "type": "string"
- },
- "include_program_partner_other": {
- "type": "boolean"
- },
- "include_program_partner_other_val": {
- "type": "string"
- },
- "include_program_provider_other": {
- "type": "boolean"
- },
- "include_program_provider_other_val": {
- "type": "string"
- },
- "include_program_reference": {
- "type": "boolean"
- },
- "product_description": {
- "type": "string"
- },
- "term_amount": {
- "type": "number"
- },
- "term_unit": {
- "enum": [
- "day(s)",
- "week(s)",
- "month(s)",
- "quarter(s)",
- "year(s)"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- "district_or_county": {
- "description": "The district or county for dispute resolution.",
- "type": "string"
- },
- "dpa_attributes": {
- "additionalProperties": false,
- "description": "Override dpa terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "approved_subprocessor_type": {
- "description": "`internal` lists approved subprocessors in the agreement (`subprocessors_attributes`); `external` points to a list published elsewhere.",
- "enum": [
- "internal",
- "external"
- ],
- "type": "string"
- },
- "cloud_service_product_name": {
- "type": "string"
- },
- "competent_supervisory_authority": {
- "type": "string"
- },
- "customer_description": {
- "type": "string"
- },
- "data_exporter_address_city": {
- "type": "string"
- },
- "data_exporter_address_country": {
- "type": "string"
- },
- "data_exporter_address_state": {
- "type": "string"
- },
- "data_exporter_address_street_address": {
- "type": "string"
- },
- "data_exporter_address_zipcode": {
- "type": "string"
- },
- "data_exporter_contact_details": {
- "type": "string"
- },
- "data_exporter_contact_name": {
- "type": "string"
- },
- "data_exporter_contact_position": {
- "type": "string"
- },
- "data_exporter_role": {
- "description": "Role of the data exporter. Overwritten to `Controller` when the agreement is created from a template.",
- "enum": [
- "Controller",
- "Processor"
- ],
- "type": "string"
- },
- "data_importer_address": {
- "type": "string"
- },
- "data_importer_address_city": {
- "type": "string"
- },
- "data_importer_address_country": {
- "type": "string"
- },
- "data_importer_address_state": {
- "type": "string"
- },
- "data_importer_address_street_address": {
- "type": "string"
- },
- "data_importer_address_zipcode": {
- "type": "string"
- },
- "data_importer_contact_details": {
- "type": "string"
- },
- "data_importer_contact_name": {
- "type": "string"
- },
- "data_importer_contact_position": {
- "type": "string"
- },
- "duration_of_processing": {
- "type": "string"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_covered_claim": {
- "type": "boolean"
- },
- "include_covered_claim_external_val": {
- "type": "string"
- },
- "include_covered_claim_internal_val": {
- "type": "string"
- },
- "include_covered_claim_type": {
- "description": "Which covered-claim text applies: `internal` uses `include_covered_claim_internal_val`, `external` uses `include_covered_claim_external_val`. Required when `include_covered_claim` is true.",
- "enum": [
- "internal",
- "external"
- ],
- "type": "string"
- },
- "include_data_subjects_custom": {
- "type": "boolean"
- },
- "include_data_subjects_custom_val": {
- "type": "string"
- },
- "include_data_subjects_employees": {
- "type": "boolean"
- },
- "include_data_subjects_end_users": {
- "type": "boolean"
- },
- "include_external_subprocessor_location": {
- "type": "string"
- },
- "include_frequency_of_transfer_continuous": {
- "type": "boolean"
- },
- "include_frequency_of_transfer_custom": {
- "type": "boolean"
- },
- "include_frequency_of_transfer_custom_val": {
- "type": "string"
- },
- "include_governing_country_eu": {
- "type": "boolean"
- },
- "include_governing_country_eu_val": {
- "type": "string"
- },
- "include_governing_country_uk": {
- "type": "boolean"
- },
- "include_governing_country_uk_val": {
- "type": "string"
- },
- "include_governing_law": {
- "type": "boolean"
- },
- "include_governing_law_country": {
- "type": "string"
- },
- "include_governing_law_state": {
- "type": "string"
- },
- "include_increased_claim_amount": {
- "description": "Legacy field. Stored but not shown on the DPA; use the `include_liability_cap*` fields instead.",
- "type": "boolean"
- },
- "include_increased_claim_amount_currency": {
- "description": "Legacy field. Stored but not shown on the DPA; use the `include_liability_cap*` fields instead."
- },
- "include_increased_claim_amount_qty": {
- "description": "Legacy field. Stored but not shown on the DPA; use the `include_liability_cap*` fields instead."
- },
- "include_increased_claim_amount_type": {
- "description": "Legacy field. Stored but not shown on the DPA; use the `include_liability_cap*` fields instead.",
- "type": "string"
- },
- "include_liability_cap": {
- "type": "boolean"
- },
- "include_liability_cap_amount_constant_external": {
- "type": "string"
- },
- "include_liability_cap_amount_constant_internal": {
- "type": "string"
- },
- "include_liability_cap_amount_currency_external": {
- "description": "Currency amount. Numbers and numeric strings (commas allowed) are both accepted."
- },
- "include_liability_cap_amount_currency_internal": {
- "description": "Currency amount. Numbers and numeric strings (commas allowed) are both accepted."
- },
- "include_liability_cap_csa_type": {
- "description": "Which liability cap values apply: the `_internal` or `_external` amount fields. Required when `include_liability_cap` is true.",
- "enum": [
- "internal",
- "external"
- ],
- "type": "string"
- },
- "include_personal_data_biographic_info": {
- "type": "boolean"
- },
- "include_personal_data_contact_info": {
- "type": "boolean"
- },
- "include_personal_data_custom": {
- "type": "boolean"
- },
- "include_personal_data_custom_val": {
- "type": "string"
- },
- "include_personal_data_employment_info": {
- "type": "boolean"
- },
- "include_personal_data_financial_info": {
- "type": "boolean"
- },
- "include_personal_data_location": {
- "type": "boolean"
- },
- "include_personal_data_name": {
- "type": "boolean"
- },
- "include_personal_data_transactional_info": {
- "type": "boolean"
- },
- "include_personal_data_user_activity_info": {
- "type": "boolean"
- },
- "include_processing_purpose_custom": {
- "type": "boolean"
- },
- "include_processing_purpose_custom_val": {
- "type": "string"
- },
- "include_processing_purpose_erasing": {
- "type": "boolean"
- },
- "include_processing_purpose_holding": {
- "type": "boolean"
- },
- "include_processing_purpose_protecting": {
- "type": "boolean"
- },
- "include_processing_purpose_receiving": {
- "type": "boolean"
- },
- "include_processing_purpose_returning": {
- "type": "boolean"
- },
- "include_processing_purpose_sharing": {
- "type": "boolean"
- },
- "include_processing_purpose_updating": {
- "type": "boolean"
- },
- "include_processing_purpose_using": {
- "type": "boolean"
- },
- "include_provider_security_contact_address": {
- "type": "boolean"
- },
- "include_provider_security_contact_address_city": {
- "type": "string"
- },
- "include_provider_security_contact_address_country": {
- "type": "string"
- },
- "include_provider_security_contact_address_state": {
- "type": "string"
- },
- "include_provider_security_contact_address_street_address": {
- "type": "string"
- },
- "include_provider_security_contact_address_zipcode": {
- "type": "string"
- },
- "include_provider_security_contact_email": {
- "type": "boolean"
- },
- "include_provider_security_contact_email_val": {
- "format": "email",
- "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
- "type": "string"
- },
- "include_security_measures_accountability": {
- "type": "boolean"
- },
- "include_security_measures_accountability_val": {
- "type": "string"
- },
- "include_security_measures_certification_or_assurance": {
- "type": "boolean"
- },
- "include_security_measures_certification_or_assurance_val": {
- "type": "string"
- },
- "include_security_measures_confidentiality_integrity": {
- "type": "boolean"
- },
- "include_security_measures_confidentiality_integrity_val": {
- "type": "string"
- },
- "include_security_measures_data_at_rest": {
- "type": "boolean"
- },
- "include_security_measures_data_at_rest_val": {
- "type": "string"
- },
- "include_security_measures_data_minimization": {
- "type": "boolean"
- },
- "include_security_measures_data_minimization_val": {
- "type": "string"
- },
- "include_security_measures_data_quality": {
- "type": "boolean"
- },
- "include_security_measures_data_quality_val": {
- "type": "string"
- },
- "include_security_measures_data_retention": {
- "type": "boolean"
- },
- "include_security_measures_data_retention_val": {
- "type": "string"
- },
- "include_security_measures_data_transmission": {
- "type": "boolean"
- },
- "include_security_measures_data_transmission_val": {
- "type": "string"
- },
- "include_security_measures_event_logging": {
- "type": "boolean"
- },
- "include_security_measures_event_logging_val": {
- "type": "string"
- },
- "include_security_measures_identity_auth": {
- "type": "boolean"
- },
- "include_security_measures_identity_auth_val": {
- "type": "string"
- },
- "include_security_measures_it_security_governance": {
- "type": "boolean"
- },
- "include_security_measures_it_security_governance_val": {
- "type": "string"
- },
- "include_security_measures_physical_security": {
- "type": "boolean"
- },
- "include_security_measures_physical_security_val": {
- "type": "string"
- },
- "include_security_measures_portability_and_erasure": {
- "type": "boolean"
- },
- "include_security_measures_portability_and_erasure_val": {
- "type": "string"
- },
- "include_security_measures_pseudonym_encryption": {
- "type": "boolean"
- },
- "include_security_measures_pseudonym_encryption_val": {
- "type": "string"
- },
- "include_security_measures_restore_data_access": {
- "type": "boolean"
- },
- "include_security_measures_restore_data_access_val": {
- "type": "string"
- },
- "include_security_measures_security_policy": {
- "type": "boolean"
- },
- "include_security_measures_system_configuration": {
- "type": "boolean"
- },
- "include_security_measures_system_configuration_val": {
- "type": "string"
- },
- "include_security_measures_testing_assessment": {
- "type": "boolean"
- },
- "include_security_measures_testing_assessment_val": {
- "type": "string"
- },
- "include_security_policy": {
- "type": "boolean"
- },
- "include_security_policy_fedramp_auth": {
- "type": "boolean"
- },
- "include_security_policy_hipaa": {
- "type": "boolean"
- },
- "include_security_policy_hitrust": {
- "type": "boolean"
- },
- "include_security_policy_include_other": {
- "type": "boolean"
- },
- "include_security_policy_iso27001": {
- "type": "boolean"
- },
- "include_security_policy_other": {
- "type": "string"
- },
- "include_security_policy_pci1": {
- "type": "boolean"
- },
- "include_security_policy_pci2": {
- "type": "boolean"
- },
- "include_security_policy_penetration_testing": {
- "type": "boolean"
- },
- "include_security_policy_soc2": {
- "type": "boolean"
- },
- "include_security_policy_soc2_type2": {
- "type": "boolean"
- },
- "include_sensitive_data_restrictions_custom": {
- "type": "boolean"
- },
- "include_sensitive_data_restrictions_custom_val": {
- "type": "string"
- },
- "include_sensitive_data_restrictions_security_policy": {
- "type": "boolean"
- },
- "include_service_provider_relationship": {
- "type": "boolean"
- },
- "include_special_category_data": {
- "type": "boolean"
- },
- "provider": {
- "type": "string"
- },
- "security_policy_available_at": {
- "type": "string"
- },
- "security_policy_type": {
- "description": "Where the Security Policy is defined. For `external`, set `security_policy_available_at`.",
- "enum": [
- "defined in agreement",
- "provider service",
- "external"
- ],
- "type": "string"
- },
- "subprocessors_attributes": {
- "additionalProperties": {
- "additionalProperties": false,
- "properties": {
- "_destroy": {
- "description": "Set to true with `id` to remove that subprocessor.",
- "type": "boolean"
- },
- "country": {
- "type": "string"
- },
- "id": {
- "description": "ID of an existing subprocessor to update or remove. Omit to add a new subprocessor.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "name": {
- "type": "string"
- },
- "processing_task": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "description": "Subprocessors, keyed by string index such as \"0\", \"1\". On create these are added to the template's subprocessors. On a draft update, an entry without `id` adds a new subprocessor; pass `id` to change one and `id` with `_destroy: true` to remove one.",
- "propertyNames": {
- "type": "string"
- },
- "type": "object"
- },
- "underlying_agreement_id": {
- "description": "ID of the CSA this DPA supplements when `underlying_agreement_type` is `internal`.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "underlying_agreement_type": {
- "description": "`internal` links a CSA in Common Paper (`underlying_agreement_id`); `external` describes another agreement in `underlying_agreement_val` (required). Omit for none.",
- "enum": [
- "internal",
- "external"
- ],
- "type": "string"
- },
- "underlying_agreement_val": {
- "description": "Description of the agreement this DPA supplements. Required when `underlying_agreement_type` is `external`.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "framework_terms_description": {
- "description": "Custom framework terms description. Only used when framework_terms_type is \"description\".",
- "type": "string"
- },
- "framework_terms_type": {
- "description": "How framework terms are specified. Use \"new\" for standard terms or \"description\" to provide a custom framework_terms_description.",
- "enum": [
- "new",
- "description"
- ],
- "type": "string"
- },
- "governing_law_country": {
- "description": "The country whose laws govern the agreement.",
- "type": "string"
- },
- "governing_law_region": {
- "description": "The state or region whose laws govern the agreement.",
- "type": "string"
- },
- "include_automated_payment_reminders": {
- "description": "When true, automatically sends payment reminder emails.",
- "type": "boolean"
- },
- "include_billing_info": {
- "description": "When true, billing contact information (billing_name, billing_email) is included.",
- "type": "boolean"
- },
- "include_billing_workflow": {
- "description": "When true, enables a billing workflow after signing.",
- "type": "boolean"
- },
- "include_expiration_date": {
- "description": "Expiration date in YYYY-MM-DD format. Use when include_expiration_type is \"date\".",
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "include_expiration_days": {
- "description": "Number of days until the agreement expires. Use when include_expiration_type is \"days\".",
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_expiration_type": {
- "description": "How to set expiration: \"none\" (default), \"days\" (use include_expiration_days), or \"date\" (use include_expiration_date).",
- "enum": [
- "none",
- "days",
- "date"
- ],
- "type": "string"
- },
- "include_terms": {
- "description": "When true, the standard terms are included with the agreement.",
- "type": "boolean"
- },
- "loi_attributes": {
- "additionalProperties": false,
- "description": "Override loi terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "confidentiality_custom": {
- "type": "string"
- },
- "confidentiality_mutual_include_loi": {
- "type": "boolean"
- },
- "confidentiality_nda_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "confidentiality_nda_description": {
- "type": "string"
- },
- "confidentiality_nda_include_loi": {
- "type": "boolean"
- },
- "confidentiality_nda_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "confidentiality_type": {
- "enum": [
- "mutual",
- "nda",
- "provider",
- "custom"
- ],
- "type": "string"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_custom_details": {
- "type": "boolean"
- },
- "include_custom_details_val": {
- "type": "string"
- },
- "include_fees": {
- "type": "boolean"
- },
- "include_fees_amount": {
- "type": "number"
- },
- "include_fees_amount_duration": {
- "enum": [
- "month",
- "year",
- "quarter"
- ],
- "type": "string"
- },
- "include_fees_include_amount": {
- "type": "boolean"
- },
- "include_fees_include_other": {
- "type": "boolean"
- },
- "include_fees_other": {
- "type": "string"
- },
- "include_functionality": {
- "type": "boolean"
- },
- "include_functionality_val": {
- "type": "string"
- },
- "include_launch_date": {
- "type": "boolean"
- },
- "include_launch_date_custom": {
- "type": "string"
- },
- "include_launch_date_date": {
- "format": "date-time",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$",
- "type": "string"
- },
- "include_launch_date_type": {
- "enum": [
- "date",
- "custom"
- ],
- "type": "string"
- },
- "product_name": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "manual_send": {
- "description": "When true, the agreement is marked as manually sent outside the platform.",
- "type": "boolean"
- },
- "message": {
- "type": "string"
- },
- "negotiations_allowed": {
- "description": "When true, the recipient can propose changes to the legal terms. For agreement types without separate business terms, that covers every term. CSA order forms, PSA statements of work, partnership business terms and software license order forms have their own `negotiations_allowed` flag.",
- "type": "boolean"
- },
- "partnership_attributes": {
- "additionalProperties": false,
- "description": "Override partnership terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "effective_date": {
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "effective_date_type": {
- "enum": [
- "signature",
- "date"
- ],
- "type": "string"
- },
- "general_cap_amount_currency_val": {
- "type": "number"
- },
- "general_cap_amount_either_currency": {
- "type": "number"
- },
- "general_cap_amount_either_multiple": {
- "type": "number"
- },
- "general_cap_amount_multiple_val": {
- "type": "number"
- },
- "general_cap_amount_type": {
- "enum": [
- "multiple",
- "currency",
- "either",
- "base"
- ],
- "type": "string"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_additional_warranties": {
- "type": "boolean"
- },
- "include_additional_warranties_include_company": {
- "type": "boolean"
- },
- "include_additional_warranties_include_company_val": {
- "type": "string"
- },
- "include_additional_warranties_include_partner": {
- "type": "boolean"
- },
- "include_additional_warranties_include_partner_val": {
- "type": "string"
- },
- "include_brand_guidelines": {
- "type": "boolean"
- },
- "include_brand_guidelines_include_company": {
- "type": "boolean"
- },
- "include_brand_guidelines_include_company_val": {
- "type": "string"
- },
- "include_brand_guidelines_include_partner": {
- "type": "boolean"
- },
- "include_brand_guidelines_include_partner_val": {
- "type": "string"
- },
- "include_covered_claims": {
- "type": "boolean"
- },
- "include_covered_claims_company_claims": {
- "type": "string"
- },
- "include_covered_claims_include_company_claims": {
- "type": "boolean"
- },
- "include_covered_claims_include_partner_claims": {
- "type": "boolean"
- },
- "include_covered_claims_partner_claims": {
- "type": "string"
- },
- "include_dpa": {
- "type": "boolean"
- },
- "include_dpa_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_dpa_location": {
- "type": "string"
- },
- "include_dpa_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_increased_cap_amount": {
- "type": "boolean"
- },
- "include_increased_cap_amount_currency": {
- "type": "number"
- },
- "include_increased_cap_amount_either_currency": {
- "type": "number"
- },
- "include_increased_cap_amount_either_multiple": {
- "type": "string"
- },
- "include_increased_cap_amount_multiple": {
- "type": "string"
- },
- "include_increased_cap_amount_type": {
- "enum": [
- "multiple",
- "currency",
- "either"
- ],
- "type": "string"
- },
- "include_increased_claims": {
- "type": "boolean"
- },
- "include_increased_claims_include_confidentiality": {
- "type": "boolean"
- },
- "include_increased_claims_include_confidentiality_misconduct": {
- "type": "boolean"
- },
- "include_increased_claims_include_covered_claims": {
- "type": "boolean"
- },
- "include_increased_claims_include_misconduct": {
- "type": "boolean"
- },
- "include_increased_claims_include_other": {
- "type": "boolean"
- },
- "include_increased_claims_include_other_val": {
- "type": "string"
- },
- "include_unlimited_claims": {
- "type": "boolean"
- },
- "include_unlimited_claims_confidentiality": {
- "type": "boolean"
- },
- "include_unlimited_claims_confidentiality_misconduct": {
- "type": "boolean"
- },
- "include_unlimited_claims_covered_claims": {
- "type": "boolean"
- },
- "include_unlimited_claims_misconduct": {
- "type": "boolean"
- },
- "include_unlimited_claims_other": {
- "type": "boolean"
- },
- "include_unlimited_claims_other_val": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "partnership_business_terms_attributes": {
- "additionalProperties": false,
- "description": "Override partnership business terms terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "end_date_after_effective_date_amount": {
- "type": "number"
- },
- "end_date_after_effective_date_unit": {
- "enum": [
- "month(s)",
- "quarter(s)",
- "year(s)"
- ],
- "type": "string"
- },
- "end_date_date": {
- "type": "string"
- },
- "end_date_type": {
- "enum": [
- "date",
- "effective date"
- ],
- "type": "string"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_obligations_company_brand": {
- "type": "boolean"
- },
- "include_obligations_company_promotion": {
- "type": "boolean"
- },
- "include_obligations_company_promotion_include_activities": {
- "type": "boolean"
- },
- "include_obligations_company_promotion_include_activities_val": {
- "type": "string"
- },
- "include_obligations_company_promotion_include_materials": {
- "type": "boolean"
- },
- "include_obligations_company_promotion_include_materials_val": {
- "type": "string"
- },
- "include_obligations_company_referral": {
- "type": "boolean"
- },
- "include_obligations_company_referral_include_criteria": {
- "type": "boolean"
- },
- "include_obligations_company_referral_include_criteria_val": {
- "type": "string"
- },
- "include_obligations_company_referral_include_pay_sch": {
- "type": "boolean"
- },
- "include_obligations_company_referral_include_pay_sch_amount": {
- "type": "number"
- },
- "include_obligations_company_referral_include_pay_sch_custom": {
- "type": "string"
- },
- "include_obligations_company_referral_include_pay_sch_unit": {
- "enum": [
- "U.S. Dollars",
- "percent"
- ],
- "type": "string"
- },
- "include_obligations_company_sponsorship": {
- "type": "boolean"
- },
- "include_obligations_company_sponsorship_include_benefits": {
- "type": "boolean"
- },
- "include_obligations_company_sponsorship_include_benefits_val": {
- "type": "string"
- },
- "include_obligations_company_sponsorship_include_payments": {
- "type": "boolean"
- },
- "include_obligations_company_sponsorship_include_payments_amount": {
- "type": "number"
- },
- "include_obligations_company_sponsorship_include_payments_unit": {
- "enum": [
- "U.S. Dollars",
- "percent"
- ],
- "type": "string"
- },
- "include_obligations_partner_brand": {
- "type": "boolean"
- },
- "include_obligations_partner_promotion": {
- "type": "boolean"
- },
- "include_obligations_partner_promotion_include_activities": {
- "type": "boolean"
- },
- "include_obligations_partner_promotion_include_activities_val": {
- "type": "string"
- },
- "include_obligations_partner_promotion_include_materials": {
- "type": "boolean"
- },
- "include_obligations_partner_promotion_include_materials_val": {
- "type": "string"
- },
- "include_obligations_partner_referral": {
- "type": "boolean"
- },
- "include_obligations_partner_referral_include_criteria": {
- "type": "boolean"
- },
- "include_obligations_partner_referral_include_criteria_val": {
- "type": "string"
- },
- "include_obligations_partner_referral_include_pay_sch": {
- "type": "boolean"
- },
- "include_obligations_partner_referral_include_pay_sch_amount": {
- "type": "number"
- },
- "include_obligations_partner_referral_include_pay_sch_custom": {
- "type": "string"
- },
- "include_obligations_partner_referral_include_pay_sch_unit": {
- "enum": [
- "U.S. Dollars",
- "percent"
- ],
- "type": "string"
- },
- "include_obligations_partner_sponsorship": {
- "type": "boolean"
- },
- "include_obligations_partner_sponsorship_include_benefits": {
- "type": "boolean"
- },
- "include_obligations_partner_sponsorship_include_benefits_val": {
- "type": "string"
- },
- "include_obligations_partner_sponsorship_include_payments": {
- "type": "boolean"
- },
- "include_obligations_partner_sponsorship_include_payments_amount": {
- "type": "number"
- },
- "include_obligations_partner_sponsorship_include_payments_unit": {
- "enum": [
- "U.S. Dollars",
- "percent"
- ],
- "type": "string"
- },
- "include_payment_process": {
- "type": "boolean"
- },
- "include_payment_process_company": {
- "type": "boolean"
- },
- "include_payment_process_company_include_address": {
- "type": "boolean"
- },
- "include_payment_process_company_include_address_city": {
- "type": "string"
- },
- "include_payment_process_company_include_address_country": {
- "type": "string"
- },
- "include_payment_process_company_include_address_state": {
- "type": "string"
- },
- "include_payment_process_company_include_address_street_address": {
- "type": "string"
- },
- "include_payment_process_company_include_address_zipcode": {
- "type": "string"
- },
- "include_payment_process_company_include_email": {
- "type": "boolean"
- },
- "include_payment_process_company_include_email_val": {
- "type": "string"
- },
- "include_payment_process_partner": {
- "type": "boolean"
- },
- "include_payment_process_partner_include_address": {
- "type": "boolean"
- },
- "include_payment_process_partner_include_address_city": {
- "type": "string"
- },
- "include_payment_process_partner_include_address_country": {
- "type": "string"
- },
- "include_payment_process_partner_include_address_state": {
- "type": "string"
- },
- "include_payment_process_partner_include_address_street_address": {
- "type": "string"
- },
- "include_payment_process_partner_include_address_zipcode": {
- "type": "string"
- },
- "include_payment_process_partner_include_email": {
- "type": "boolean"
- },
- "include_payment_process_partner_include_email_val": {
- "type": "string"
- },
- "include_payment_schedule": {
- "type": "boolean"
- },
- "include_payment_schedule_custom": {
- "type": "string"
- },
- "include_payment_schedule_specified_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_payment_schedule_specified_timeframe": {
- "enum": [
- "receipt",
- "date"
- ],
- "type": "string"
- },
- "include_payment_schedule_specified_unit": {
- "enum": [
- "day(s)",
- "week(s)",
- "month(s)",
- "quarter(s)",
- "year(s)"
- ],
- "type": "string"
- },
- "include_payment_schedule_type": {
- "enum": [
- "specified",
- "custom"
- ],
- "type": "string"
- },
- "negotiations_allowed": {
- "description": "When true, the recipient can propose changes to the business terms, even when the agreement-level `negotiations_allowed` is false. This only covers the business terms.",
- "type": "boolean"
- },
- "territory_type": {
- "enum": [
- "worldwide",
- "custom"
- ],
- "type": "string"
- },
- "territory_type_val": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "payment_link_url": {
- "description": "A payment URL shown to the recipient after signing. Requires include_billing_workflow to be true and billing_workflow_type to be \"link\".",
- "type": "string"
- },
- "pilot_attributes": {
- "additionalProperties": false,
- "description": "Override pilot terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "fees_type": {
- "enum": [
- "free",
- "pilot_period_fees"
- ],
- "type": "string"
- },
- "general_cap_amount": {
- "type": "number"
- },
- "general_cap_amount_type": {
- "enum": [
- "preceding",
- "base",
- "period"
- ],
- "type": "string"
- },
- "general_cap_period_currency": {
- "type": "number"
- },
- "general_cap_period_qty": {
- "type": "number"
- },
- "general_cap_preceding_amount": {
- "type": "number"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_dpa": {
- "type": "boolean"
- },
- "include_dpa_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_dpa_location": {
- "type": "string"
- },
- "include_dpa_type": {
- "enum": [
- "description",
- "attachment",
- "standard"
- ],
- "type": "string"
- },
- "include_payment_process": {
- "type": "boolean"
- },
- "include_technical_support": {
- "type": "boolean"
- },
- "payment_process_automatic_frequency": {
- "enum": [
- "monthly",
- "quarterly",
- "annually",
- "once_per_period"
- ],
- "type": "string"
- },
- "payment_process_invoice_days": {
- "type": "number"
- },
- "payment_process_invoice_from": {
- "enum": [
- "receipt",
- "date"
- ],
- "type": "string"
- },
- "payment_process_invoice_timeframe": {
- "enum": [
- "days",
- "weeks",
- "months",
- "quarters",
- "years"
- ],
- "type": "string"
- },
- "payment_process_type": {
- "enum": [
- "automatic",
- "invoice"
- ],
- "type": "string"
- },
- "pilot_period_description": {
- "type": "string"
- },
- "pilot_period_fees_description": {
- "type": "string"
- },
- "product_description": {
- "type": "string"
- },
- "technical_support_description": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "psa_attributes": {
- "additionalProperties": false,
- "description": "Override psa terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "additional_changes": {
- "type": "string"
- },
- "customer_description": {
- "type": "string"
- },
- "effective_date": {
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "effective_date_type": {
- "enum": [
- "signature",
- "date"
- ],
- "type": "string"
- },
- "general_cap_amount": {
- "type": "number"
- },
- "general_cap_amount_type": {
- "enum": [
- "preceding",
- "base",
- "period"
- ],
- "type": "string"
- },
- "general_cap_period_currency": {
- "type": "number"
- },
- "general_cap_period_qty": {
- "type": "number"
- },
- "general_cap_preceding_amount": {
- "type": "number"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_additional_changes": {
- "type": "boolean"
- },
- "include_additional_warranties": {
- "type": "boolean"
- },
- "include_additional_warranties_by_customer": {
- "type": "string"
- },
- "include_additional_warranties_by_provider": {
- "type": "string"
- },
- "include_additional_warranties_include_by_customer": {
- "type": "boolean"
- },
- "include_additional_warranties_include_by_provider": {
- "type": "boolean"
- },
- "include_covered_claims": {
- "type": "boolean"
- },
- "include_covered_claims_customer_claims": {
- "type": "string"
- },
- "include_covered_claims_include_customer_claims": {
- "type": "boolean"
- },
- "include_covered_claims_include_provider_claims": {
- "type": "boolean"
- },
- "include_covered_claims_provider_claims": {
- "type": "string"
- },
- "include_customer_insurance_min": {
- "type": "boolean"
- },
- "include_customer_insurance_min_add_provider_com_gen_liability": {
- "type": "boolean"
- },
- "include_customer_insurance_min_add_provider_cyber_liability": {
- "type": "boolean"
- },
- "include_customer_insurance_min_add_provider_errors_omissions": {
- "type": "boolean"
- },
- "include_customer_insurance_min_auto_liability_aggregate": {
- "type": "number"
- },
- "include_customer_insurance_min_auto_liability_minimum": {
- "type": "number"
- },
- "include_customer_insurance_min_cyber_liability_aggregate": {
- "type": "number"
- },
- "include_customer_insurance_min_cyber_liability_minimum": {
- "type": "number"
- },
- "include_customer_insurance_min_employer_liability_aggregate": {
- "type": "number"
- },
- "include_customer_insurance_min_employer_liability_minimum": {
- "type": "number"
- },
- "include_customer_insurance_min_general_liability_aggregate": {
- "type": "number"
- },
- "include_customer_insurance_min_general_liability_minimum": {
- "type": "number"
- },
- "include_customer_insurance_min_include_add_provider": {
- "type": "boolean"
- },
- "include_customer_insurance_min_include_auto_liability": {
- "type": "boolean"
- },
- "include_customer_insurance_min_include_cyber_liability": {
- "type": "boolean"
- },
- "include_customer_insurance_min_include_employer_liability": {
- "type": "boolean"
- },
- "include_customer_insurance_min_include_general_liability": {
- "type": "boolean"
- },
- "include_customer_insurance_min_include_workers_comp": {
- "type": "boolean"
- },
- "include_customer_policies": {
- "type": "boolean"
- },
- "include_customer_policies_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_customer_policies_location": {
- "type": "string"
- },
- "include_customer_policies_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_dpa": {
- "type": "boolean"
- },
- "include_dpa_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_dpa_location": {
- "type": "string"
- },
- "include_dpa_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_increased_cap_amount": {
- "type": "boolean"
- },
- "include_increased_claims": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_confidentiality": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_confidentiality_negligence": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_privsec": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_privsec_negligence": {
- "type": "boolean"
- },
- "include_increased_claims_include_other": {
- "type": "boolean"
- },
- "include_increased_claims_indemnification_obligation": {
- "type": "boolean"
- },
- "include_increased_claims_negligence": {
- "type": "boolean"
- },
- "include_increased_claims_other": {
- "type": "string"
- },
- "include_provider_insurance_min": {
- "type": "boolean"
- },
- "include_provider_insurance_min_add_customer_com_gen_liability": {
- "type": "boolean"
- },
- "include_provider_insurance_min_add_customer_cyber_liability": {
- "type": "boolean"
- },
- "include_provider_insurance_min_add_customer_errors_omissions": {
- "type": "boolean"
- },
- "include_provider_insurance_min_auto_liability_aggregate": {
- "type": "number"
- },
- "include_provider_insurance_min_auto_liability_minimum": {
- "type": "number"
- },
- "include_provider_insurance_min_cyber_liability_aggregate": {
- "type": "number"
- },
- "include_provider_insurance_min_cyber_liability_minimum": {
- "type": "number"
- },
- "include_provider_insurance_min_employer_liability_aggregate": {
- "type": "number"
- },
- "include_provider_insurance_min_employer_liability_minimum": {
- "type": "number"
- },
- "include_provider_insurance_min_general_liability_aggregate": {
- "type": "number"
- },
- "include_provider_insurance_min_general_liability_minimum": {
- "type": "number"
- },
- "include_provider_insurance_min_include_add_customer": {
- "type": "boolean"
- },
- "include_provider_insurance_min_include_auto_liability": {
- "type": "boolean"
- },
- "include_provider_insurance_min_include_cyber_liability": {
- "type": "boolean"
- },
- "include_provider_insurance_min_include_employer_liability": {
- "type": "boolean"
- },
- "include_provider_insurance_min_include_general_liability": {
- "type": "boolean"
- },
- "include_provider_insurance_min_include_workers_comp": {
- "type": "boolean"
- },
- "include_publicity_rights": {
- "type": "boolean"
- },
- "include_publicity_rights_type": {
- "enum": [
- "public",
- "non-public"
- ],
- "type": "string"
- },
- "include_security_policy": {
- "type": "boolean"
- },
- "include_security_policy_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_security_policy_fedramp_auth": {
- "type": "boolean"
- },
- "include_security_policy_hitrust": {
- "type": "boolean"
- },
- "include_security_policy_include_annual_maintenance": {
- "type": "boolean"
- },
- "include_security_policy_include_other": {
- "type": "boolean"
- },
- "include_security_policy_include_other_val": {
- "type": "string"
- },
- "include_security_policy_iso27001": {
- "type": "boolean"
- },
- "include_security_policy_location": {
- "type": "string"
- },
- "include_security_policy_pci1": {
- "type": "boolean"
- },
- "include_security_policy_pci2": {
- "type": "boolean"
- },
- "include_security_policy_penetration_testing": {
- "type": "boolean"
- },
- "include_security_policy_soc2_type1": {
- "type": "boolean"
- },
- "include_security_policy_soc2_type2": {
- "type": "boolean"
- },
- "include_security_policy_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_unlimited_claims": {
- "type": "boolean"
- },
- "include_unlimited_claims_breach_of_confidentiality": {
- "type": "boolean"
- },
- "include_unlimited_claims_breach_of_confidentiality_negligence": {
- "type": "boolean"
- },
- "include_unlimited_claims_breach_of_privsec": {
- "type": "boolean"
- },
- "include_unlimited_claims_breach_of_privsec_negligence": {
- "type": "boolean"
- },
- "include_unlimited_claims_include_other": {
- "type": "boolean"
- },
- "include_unlimited_claims_indemnification_obligation": {
- "type": "boolean"
- },
- "include_unlimited_claims_negligence": {
- "type": "boolean"
- },
- "include_unlimited_claims_other": {
- "type": "string"
- },
- "increased_cap_amount_currency": {
- "type": "number"
- },
- "increased_cap_amount_period_currency": {
- "type": "number"
- },
- "increased_cap_amount_period_qty": {
- "type": "number"
- },
- "increased_cap_amount_qty": {
- "type": "number"
- },
- "increased_cap_amount_type": {
- "enum": [
- "qty",
- "currency",
- "period"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- "psa_statement_of_work_attributes": {
- "additionalProperties": false,
- "description": "Override psa statement of work terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "additional_changes": {
- "type": "string"
- },
- "cost": {
- "type": "number"
- },
- "description": {
- "type": "string"
- },
- "fee_type": {
- "type": "string"
- },
- "fees_attributes": {
- "additionalProperties": {
- "anyOf": [
- {
- "additionalProperties": false,
- "description": "Fees::Flat (fee_type \"flat\"). A fixed recurring fee, e.g. a platform subscription. Set type to \"Fees::Flat\" or fee_type to \"flat\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "Fixed amount in the order form's fees_currency, charged per fee_period. A plain amount, not cents: 20 means 20.00.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"flat\". Alternative to type.",
- "enum": [
- "flat"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Flat\". Optional when fee_type is set.",
- "enum": [
- "Fees::Flat"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Discount (fee_type \"discount\"). A discount, as a fixed amount or a percentage, applied forever, once, or for a number of months. Set type to \"Fees::Discount\" or fee_type to \"discount\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "Discount size: an amount in fees_currency when discount_type is fixed_amount (a plain amount, not cents: 20 means 20.00), or a percentage (e.g. 10 for 10%) when it is percentage.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "discount_duration_amount": {
- "description": "Number of months the discount applies. Required when discount_duration_type is multiple_months.",
- "type": "number"
- },
- "discount_duration_type": {
- "description": "How long the discount applies. multiple_months also needs discount_duration_amount.",
- "enum": [
- "forever",
- "once",
- "multiple_months"
- ],
- "type": "string"
- },
- "discount_type": {
- "description": "Whether cost is a currency amount or a percentage.",
- "enum": [
- "fixed_amount",
- "percentage"
- ],
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"discount\". Alternative to type.",
- "enum": [
- "discount"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Discount\". Optional when fee_type is set.",
- "enum": [
- "Fees::Discount"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Cost (fee_type \"cost\"). A per-unit fee: price per unit times quantity, e.g. seats. Set type to \"Fees::Cost\" or fee_type to \"cost\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "Price per unit in fees_currency. The row total is quantity x cost. A plain amount, not cents: 20 means 20.00.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"cost\". Alternative to type.",
- "enum": [
- "cost"
- ],
- "type": "string"
- },
- "quantity": {
- "description": "Number of units.",
- "type": "number"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Cost\". Optional when fee_type is set.",
- "enum": [
- "Fees::Cost"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Attachment (fee_type \"attachment\"). A fee described in an uploaded attachment instead of in the table. Set type to \"Fees::Attachment\" or fee_type to \"attachment\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "attachment_id": {
- "description": "ID of an attachment uploaded with upload-attachment.",
- "type": "string"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"attachment\". Alternative to type.",
- "enum": [
- "attachment"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Attachment\". Optional when fee_type is set.",
- "enum": [
- "Fees::Attachment"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Graduated (fee_type \"graduated\"). Tiered pricing, with the price set per tier in graduated_fee_tiers_attributes. Set type to \"Fees::Graduated\" or fee_type to \"graduated\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"graduated\". Alternative to type.",
- "enum": [
- "graduated"
- ],
- "type": "string"
- },
- "graduated_fee_tiers_attributes": {
- "additionalProperties": {
- "additionalProperties": false,
- "properties": {
- "flat_price": {
- "type": "number"
- },
- "price_per_unit": {
- "type": "string"
- },
- "upper_limit": {
- "type": "number"
- }
- },
- "type": "object"
- },
- "description": "Graduated fee tiers. Use string keys such as \"0\", \"1\".",
- "propertyNames": {
- "type": "string"
- },
- "type": "object"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Graduated\". Optional when fee_type is set.",
- "enum": [
- "Fees::Graduated"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Included (fee_type \"included\"). An item included at no charge. Set type to \"Fees::Included\" or fee_type to \"included\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"included\". Alternative to type.",
- "enum": [
- "included"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Included\". Optional when fee_type is set.",
- "enum": [
- "Fees::Included"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Metered (fee_type \"metered\"). Usage-based pricing, billed per unit used. Set type to \"Fees::Metered\" or fee_type to \"metered\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "Price per unit of usage in fees_currency. A plain amount, not cents: 20 means 20.00.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"metered\". Alternative to type.",
- "enum": [
- "metered"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Metered\". Optional when fee_type is set.",
- "enum": [
- "Fees::Metered"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::OneTime (fee_type \"one_time\"). A one-time charge, such as a setup fee. Set type to \"Fees::OneTime\" or fee_type to \"one_time\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "One-time amount in fees_currency, charged once rather than per fee_period. A plain amount, not cents: 20 means 20.00.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"one_time\". Alternative to type.",
- "enum": [
- "one_time"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::OneTime\". Optional when fee_type is set.",
- "enum": [
- "Fees::OneTime"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Text (fee_type \"text\"). A fee term described in free text. Set type to \"Fees::Text\" or fee_type to \"text\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"text\". Alternative to type.",
- "enum": [
- "text"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Text\". Optional when fee_type is set.",
- "enum": [
- "Fees::Text"
- ],
- "type": "string"
- }
- },
- "type": "object"
- }
- ]
- },
- "description": "Fee line items. Use string keys such as \"0\", \"1\". Replaces template fees when provided.",
- "propertyNames": {
- "type": "string"
- },
- "type": "object"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_additional_changes": {
- "type": "boolean"
- },
- "include_customer_obligation": {
- "type": "boolean"
- },
- "include_customer_obligation_val": {
- "type": "string"
- },
- "include_deliverables": {
- "type": "boolean"
- },
- "include_deliverables_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_deliverables_description": {
- "type": "string"
- },
- "include_deliverables_include_acceptance": {
- "type": "boolean"
- },
- "include_deliverables_include_attachment": {
- "type": "boolean"
- },
- "include_deliverables_include_draft_deliverables": {
- "type": "boolean"
- },
- "include_deliverables_rejection_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_deliverables_rejection_unit": {
- "enum": [
- "hours",
- "days",
- "weeks",
- "months"
- ],
- "type": "string"
- },
- "include_deliverables_resubmission_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_deliverables_resubmission_unit": {
- "enum": [
- "hours",
- "days",
- "weeks",
- "months"
- ],
- "type": "string"
- },
- "include_fees_other": {
- "type": "boolean"
- },
- "include_fees_other_val": {
- "type": "string"
- },
- "include_fees_table": {
- "type": "boolean"
- },
- "include_fees_table_total": {
- "type": "boolean"
- },
- "include_fees_travel": {
- "type": "boolean"
- },
- "include_fees_travel_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_fees_travel_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_fees_travel_val": {
- "type": "string"
- },
- "include_third_party_customer": {
- "type": "boolean"
- },
- "include_third_party_include_description": {
- "type": "boolean"
- },
- "include_third_party_include_description_val": {
- "type": "string"
- },
- "include_third_party_materials": {
- "type": "boolean"
- },
- "include_third_party_provider": {
- "type": "boolean"
- },
- "include_time_of_assignment": {
- "type": "boolean"
- },
- "include_time_of_assignment_type": {
- "enum": [
- "created",
- "paid"
- ],
- "type": "string"
- },
- "invoice_period_description": {
- "type": "string"
- },
- "negotiations_allowed": {
- "description": "When true, the recipient can propose changes to the statement of work, even when the agreement-level `negotiations_allowed` is false. This only covers the statement of work.",
- "type": "boolean"
- },
- "payment_period": {
- "type": "number"
- },
- "payment_period_other": {
- "type": "string"
- },
- "payment_period_timeframe": {
- "enum": [
- "receipt",
- "invoice",
- "Customer's receipt of invoice",
- "date of invoice"
- ],
- "type": "string"
- },
- "payment_period_type": {
- "enum": [
- "standard",
- "other"
- ],
- "type": "string"
- },
- "payment_period_unit": {
- "enum": [
- "day(s)",
- "week(s)",
- "month(s)",
- "quarter(s)",
- "year(s)"
- ],
- "type": "string"
- },
- "quantity": {
- "type": "number"
- },
- "services_description": {
- "type": "string"
- },
- "sow_date": {
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "sow_date_type": {
- "enum": [
- "signature",
- "date"
- ],
- "type": "string"
- },
- "sow_term_amount": {
- "type": "number"
- },
- "sow_term_date": {
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "sow_term_type": {
- "enum": [
- "deliverables",
- "period",
- "date"
- ],
- "type": "string"
- },
- "sow_term_unit": {
- "enum": [
- "month(s)",
- "quarter(s)",
- "year(s)"
- ],
- "type": "string"
- },
- "type": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "recipient_email": {
- "format": "email",
- "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
- "type": "string"
- },
- "recipient_name": {
- "type": "string"
- },
- "recipient_notice_email_address": {
- "description": "Email address for legal notices to the recipient.",
- "format": "email",
- "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
- "type": "string"
- },
- "recipient_organization": {
- "type": "string"
- },
- "recipient_role": {
- "description": "PSA only. The recipient's role: `Customer` (the default) or `Provider`. Send it with `sender_role`; the two must be one `Provider` and one `Customer`. Other standard agreement types ignore it.",
- "type": "string"
- },
- "sender_last_to_sign": {
- "description": "When true, your signer signs after the recipient.",
- "type": "boolean"
- },
- "sender_notice_email_address": {
- "description": "Email address for legal notices to the sender.",
- "format": "email",
- "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
- "type": "string"
- },
- "sender_role": {
- "description": "PSA only. Your company's role: `Provider` (the default) or `Customer` when you hire the recipient to provide the services. Send it with `recipient_role`; the two must be one `Provider` and one `Customer`. When reading a PSA, an empty `sender_role` means `Provider`. Other standard agreement types ignore it.",
- "type": "string"
- },
- "software_license_attributes": {
- "additionalProperties": false,
- "description": "Override software license terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "effective_date": {
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "effective_date_type": {
- "enum": [
- "signature",
- "date"
- ],
- "type": "string"
- },
- "general_cap_amount": {
- "type": "number"
- },
- "general_cap_amount_type": {
- "enum": [
- "preceding",
- "base",
- "period"
- ],
- "type": "string"
- },
- "general_cap_period_currency": {
- "type": "number"
- },
- "general_cap_period_qty": {
- "type": "number"
- },
- "general_cap_preceding_amount": {
- "type": "number"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_additional_warranties": {
- "type": "boolean"
- },
- "include_additional_warranties_by_customer": {
- "type": "string"
- },
- "include_additional_warranties_by_provider": {
- "type": "string"
- },
- "include_additional_warranties_include_by_customer": {
- "type": "boolean"
- },
- "include_additional_warranties_include_by_provider": {
- "type": "boolean"
- },
- "include_ai_addendum": {
- "type": "boolean"
- },
- "include_ai_addendum_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_covered_claims": {
- "type": "boolean"
- },
- "include_covered_claims_customer_claims": {
- "type": "string"
- },
- "include_covered_claims_include_customer_claims": {
- "type": "boolean"
- },
- "include_covered_claims_include_provider_claims": {
- "type": "boolean"
- },
- "include_covered_claims_provider_claims": {
- "type": "string"
- },
- "include_dpa": {
- "type": "boolean"
- },
- "include_dpa_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_dpa_location": {
- "type": "string"
- },
- "include_dpa_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_increased_cap_amount": {
- "type": "boolean"
- },
- "include_increased_claims": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_confidentiality": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_confidentiality_negligence": {
- "type": "boolean"
- },
- "include_increased_claims_include_other": {
- "type": "boolean"
- },
- "include_increased_claims_indemnification_obligation": {
- "type": "boolean"
- },
- "include_increased_claims_negligence": {
- "type": "boolean"
- },
- "include_increased_claims_other": {
- "type": "string"
- },
- "include_increased_claims_restrictions": {
- "type": "boolean"
- },
- "include_unlimited_claims": {
- "type": "boolean"
- },
- "include_unlimited_claims_breach_of_confidentiality": {
- "type": "boolean"
- },
- "include_unlimited_claims_breach_of_confidentiality_negligence": {
- "type": "boolean"
- },
- "include_unlimited_claims_include_other": {
- "type": "boolean"
- },
- "include_unlimited_claims_indemnification_obligation": {
- "type": "boolean"
- },
- "include_unlimited_claims_license_or_restrictions": {
- "type": "boolean"
- },
- "include_unlimited_claims_negligence": {
- "type": "boolean"
- },
- "include_unlimited_claims_other": {
- "type": "string"
- },
- "increased_cap_amount_currency": {
- "type": "number"
- },
- "increased_cap_amount_period_currency": {
- "type": "number"
- },
- "increased_cap_amount_period_qty": {
- "type": "number"
- },
- "increased_cap_amount_qty": {
- "type": "number"
- },
- "increased_cap_amount_type": {
- "enum": [
- "qty",
- "currency",
- "period"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- "software_license_order_form_attributes": {
- "additionalProperties": false,
- "description": "Override software license order form terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "additional_changes": {
- "type": "string"
- },
- "deletion_procedure_include_custom": {
- "type": "boolean"
- },
- "deletion_procedure_include_custom_description": {
- "type": "string"
- },
- "deletion_procedure_include_customer_disable": {
- "type": "boolean"
- },
- "deletion_procedure_include_customer_proof": {
- "type": "boolean"
- },
- "deletion_procedure_include_provider_disable": {
- "type": "boolean"
- },
- "fee_custom_unit": {
- "type": "string"
- },
- "fee_period": {
- "enum": [
- "Subscription Period",
- "month",
- "year",
- "Custom unit"
- ],
- "type": "string"
- },
- "fees_attributes": {
- "additionalProperties": {
- "anyOf": [
- {
- "additionalProperties": false,
- "description": "Fees::Flat (fee_type \"flat\"). A fixed recurring fee, e.g. a platform subscription. Set type to \"Fees::Flat\" or fee_type to \"flat\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "Fixed amount in the order form's fees_currency, charged per fee_period. A plain amount, not cents: 20 means 20.00.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"flat\". Alternative to type.",
- "enum": [
- "flat"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Flat\". Optional when fee_type is set.",
- "enum": [
- "Fees::Flat"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Discount (fee_type \"discount\"). A discount, as a fixed amount or a percentage, applied forever, once, or for a number of months. Set type to \"Fees::Discount\" or fee_type to \"discount\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "Discount size: an amount in fees_currency when discount_type is fixed_amount (a plain amount, not cents: 20 means 20.00), or a percentage (e.g. 10 for 10%) when it is percentage.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "discount_duration_amount": {
- "description": "Number of months the discount applies. Required when discount_duration_type is multiple_months.",
- "type": "number"
- },
- "discount_duration_type": {
- "description": "How long the discount applies. multiple_months also needs discount_duration_amount.",
- "enum": [
- "forever",
- "once",
- "multiple_months"
- ],
- "type": "string"
- },
- "discount_type": {
- "description": "Whether cost is a currency amount or a percentage.",
- "enum": [
- "fixed_amount",
- "percentage"
- ],
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"discount\". Alternative to type.",
- "enum": [
- "discount"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Discount\". Optional when fee_type is set.",
- "enum": [
- "Fees::Discount"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Cost (fee_type \"cost\"). A per-unit fee: price per unit times quantity, e.g. seats. Set type to \"Fees::Cost\" or fee_type to \"cost\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "Price per unit in fees_currency. The row total is quantity x cost. A plain amount, not cents: 20 means 20.00.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"cost\". Alternative to type.",
- "enum": [
- "cost"
- ],
- "type": "string"
- },
- "quantity": {
- "description": "Number of units.",
- "type": "number"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Cost\". Optional when fee_type is set.",
- "enum": [
- "Fees::Cost"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Attachment (fee_type \"attachment\"). A fee described in an uploaded attachment instead of in the table. Set type to \"Fees::Attachment\" or fee_type to \"attachment\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "attachment_id": {
- "description": "ID of an attachment uploaded with upload-attachment.",
- "type": "string"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"attachment\". Alternative to type.",
- "enum": [
- "attachment"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Attachment\". Optional when fee_type is set.",
- "enum": [
- "Fees::Attachment"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Graduated (fee_type \"graduated\"). Tiered pricing, with the price set per tier in graduated_fee_tiers_attributes. Set type to \"Fees::Graduated\" or fee_type to \"graduated\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"graduated\". Alternative to type.",
- "enum": [
- "graduated"
- ],
- "type": "string"
- },
- "graduated_fee_tiers_attributes": {
- "additionalProperties": {
- "additionalProperties": false,
- "properties": {
- "flat_price": {
- "type": "number"
- },
- "price_per_unit": {
- "type": "string"
- },
- "upper_limit": {
- "type": "number"
- }
- },
- "type": "object"
- },
- "description": "Graduated fee tiers. Use string keys such as \"0\", \"1\".",
- "propertyNames": {
- "type": "string"
- },
- "type": "object"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Graduated\". Optional when fee_type is set.",
- "enum": [
- "Fees::Graduated"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Included (fee_type \"included\"). An item included at no charge. Set type to \"Fees::Included\" or fee_type to \"included\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"included\". Alternative to type.",
- "enum": [
- "included"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Included\". Optional when fee_type is set.",
- "enum": [
- "Fees::Included"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Metered (fee_type \"metered\"). Usage-based pricing, billed per unit used. Set type to \"Fees::Metered\" or fee_type to \"metered\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "Price per unit of usage in fees_currency. A plain amount, not cents: 20 means 20.00.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"metered\". Alternative to type.",
- "enum": [
- "metered"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Metered\". Optional when fee_type is set.",
- "enum": [
- "Fees::Metered"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::OneTime (fee_type \"one_time\"). A one-time charge, such as a setup fee. Set type to \"Fees::OneTime\" or fee_type to \"one_time\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "One-time amount in fees_currency, charged once rather than per fee_period. A plain amount, not cents: 20 means 20.00.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"one_time\". Alternative to type.",
- "enum": [
- "one_time"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::OneTime\". Optional when fee_type is set.",
- "enum": [
- "Fees::OneTime"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Text (fee_type \"text\"). A fee term described in free text. Set type to \"Fees::Text\" or fee_type to \"text\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"text\". Alternative to type.",
- "enum": [
- "text"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Text\". Optional when fee_type is set.",
- "enum": [
- "Fees::Text"
- ],
- "type": "string"
- }
- },
- "type": "object"
- }
- ]
- },
- "description": "Fee line items. Use string keys such as \"0\", \"1\". Replaces template fees when provided.",
- "propertyNames": {
- "type": "string"
- },
- "type": "object"
- },
- "fees_currency": {
- "enum": [
- "USD",
- "EUR",
- "GBP",
- "CAD",
- "AUD",
- "SGD",
- "ILS",
- "JPY",
- "CHF",
- "HKD"
- ],
- "type": "string"
- },
- "fees_include_fee_increase_upon_renewal": {
- "type": "boolean"
- },
- "fees_include_fee_increase_upon_renewal_fee": {
- "type": "number"
- },
- "fees_include_fee_increase_upon_renewal_type": {
- "enum": [
- "will",
- "may"
- ],
- "type": "string"
- },
- "fees_inclusive_of_taxes": {
- "type": "boolean"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_additional_changes": {
- "type": "boolean"
- },
- "include_license_compliance_verification": {
- "type": "boolean"
- },
- "include_license_compliance_verification_description": {
- "type": "string"
- },
- "include_license_limits": {
- "type": "boolean"
- },
- "include_license_limits_description": {
- "type": "string"
- },
- "include_payment_process_include_billing_email": {
- "type": "boolean"
- },
- "include_pilot_period": {
- "type": "boolean"
- },
- "include_pilot_period_duration_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_pilot_period_duration_type": {
- "enum": [
- "day",
- "week",
- "month"
- ],
- "type": "string"
- },
- "include_pilot_period_include_fees": {
- "type": "boolean"
- },
- "include_pilot_period_include_fees_amount": {
- "type": "number"
- },
- "include_pilot_period_include_modifications": {
- "type": "boolean"
- },
- "include_pilot_period_include_modifications_description": {
- "type": "string"
- },
- "include_services": {
- "type": "boolean"
- },
- "include_services_description": {
- "type": "string"
- },
- "negotiations_allowed": {
- "description": "When true, the recipient can propose changes to the order form, even when the agreement-level `negotiations_allowed` is false. This only covers the order form.",
- "type": "boolean"
- },
- "order_date_date": {
- "type": "string"
- },
- "order_date_type": {
- "enum": [
- "signature",
- "date",
- "other"
- ],
- "type": "string"
- },
- "payment_process_automatic_frequency": {
- "enum": [
- "monthly",
- "quarterly",
- "semiannually",
- "annually"
- ],
- "type": "string"
- },
- "payment_process_type": {
- "enum": [
- "automatic",
- "invoice",
- "custom"
- ],
- "type": "string"
- },
- "payment_process_type_custom_val": {
- "type": "string"
- },
- "payment_process_type_invoice_amount": {
- "type": "number"
- },
- "payment_process_type_invoice_custom_unit": {
- "type": "string"
- },
- "payment_process_type_invoice_duration": {
- "enum": [
- "day",
- "week",
- "month",
- "year",
- "day(s)",
- "week(s)",
- "month(s)",
- "year(s)"
- ],
- "type": "string"
- },
- "payment_process_type_invoice_duration_start": {
- "enum": [
- "Customer's receipt of invoice",
- "date of invoice"
- ],
- "type": "string"
- },
- "payment_process_type_invoice_type": {
- "enum": [
- "monthly",
- "quarterly",
- "semiannually",
- "annually",
- "Custom unit"
- ],
- "type": "string"
- },
- "permitted_uses_include_custom": {
- "type": "boolean"
- },
- "permitted_uses_include_custom_description": {
- "type": "string"
- },
- "permitted_uses_include_customers_affiliates": {
- "type": "boolean"
- },
- "permitted_uses_include_internal_business": {
- "type": "boolean"
- },
- "pilot_period_stripe_product_id": {
- "type": "string"
- },
- "software_description": {
- "type": "string"
- },
- "subscription_auto_renew": {
- "enum": [
- "days",
- "subscription_end"
- ],
- "type": "string"
- },
- "subscription_period": {
- "type": "number"
- },
- "subscription_period_unit": {
- "type": "string"
- },
- "subscription_renewal_notice_days": {
- "type": "number"
- },
- "warranty_period_description_amount": {
- "type": "number"
- },
- "warranty_period_description_duration": {
- "enum": [
- "day",
- "week",
- "month",
- "year"
- ],
- "type": "string"
- },
- "warranty_period_description_duration_start": {
- "enum": [
- "initial delivery of the Software",
- "delivery of the Software and each subsequent Update",
- "the Order Date"
- ],
- "type": "string"
- },
- "warranty_period_type": {
- "enum": [
- "description",
- "none"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- "test_agreement": {
- "description": "When true, marks the agreement as a test. Test agreements do not count against your monthly limit.",
- "type": "boolean"
- }
- },
- "required": [
- "recipient_name",
- "recipient_email"
- ],
- "type": "object"
- },
- "cc_users": {
- "items": {
- "format": "email",
- "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
- "type": "string"
- },
- "type": "array"
- },
- "draft": {
- "description": "When true, the agreement is saved as a draft and not sent to the recipient. Use POST /v1/agreements/{id}/send to send a draft agreement later.",
- "type": "boolean"
- },
- "owner_id": {
- "description": "User id of the agreement owner (sender).",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "signer_email": {
- "description": "Email address of the signer from the owner's organization.",
- "format": "email",
- "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
- "type": "string"
- },
- "template_id": {
- "description": "UUID of a template from `GET /v1/templates`. Accepts both Common Paper standard templates and uploaded PDF templates (`type` `uploaded_template`).",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- }
- },
- "required": [
- "template_id",
- "owner_id",
- "signer_email",
- "agreement"
- ],
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "agreement": {
- "additionalProperties": {},
- "properties": {
- "amendment_attributes": {
- "additionalProperties": false,
- "description": "Override amendment terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "amended_terms_attributes": {
- "additionalProperties": {
- "additionalProperties": false,
- "properties": {
- "description": {
- "type": "string"
- },
- "term": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "description": "Amended terms. Use string keys such as \"0\", \"1\".",
- "propertyNames": {
- "type": "string"
- },
- "type": "object"
- },
- "amendment_date": {
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "amendment_date_type": {
- "enum": [
- "signature",
- "date"
- ],
- "type": "string"
- },
- "framework_terms_type": {
- "type": "string"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "parent_agreement_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "underlying_agreement_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "underlying_agreement_type": {
- "type": "string"
- },
- "underlying_agreement_val": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "baa_attributes": {
- "additionalProperties": false,
- "description": "Override baa terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "aggregation_limitations_permitted": {
- "type": "boolean"
- },
- "aggregation_limitations_permitted_val": {
- "type": "string"
- },
- "breach_notification_unit": {
- "enum": [
- "hours",
- "business days",
- "calendar days"
- ],
- "type": "string"
- },
- "breach_notification_val": {
- "type": "number"
- },
- "business_associate_relationship_type": {
- "enum": [
- "provider",
- "company"
- ],
- "type": "string"
- },
- "deidentification_limitations_include_purpose": {
- "type": "boolean"
- },
- "deidentification_limitations_include_requirements": {
- "type": "boolean"
- },
- "deidentification_limitations_permitted": {
- "type": "boolean"
- },
- "deidentification_limitations_purpose_val": {
- "type": "string"
- },
- "deidentification_limitations_requirements_val": {
- "type": "string"
- },
- "designated_record_set_provider_maintains": {
- "type": "boolean"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_aggregation_limitations": {
- "type": "boolean"
- },
- "include_deidentification_limitations": {
- "type": "boolean"
- },
- "include_limitations": {
- "type": "boolean"
- },
- "include_offshore_limitations": {
- "type": "boolean"
- },
- "include_subcontract_limitations": {
- "type": "boolean"
- },
- "offshore_limitations_permitted": {
- "type": "boolean"
- },
- "offshore_limitations_permitted_val": {
- "type": "string"
- },
- "subcontract_limitations_include_notice": {
- "type": "boolean"
- },
- "subcontract_limitations_include_permission": {
- "type": "boolean"
- },
- "subcontract_limitations_notice_val": {
- "type": "string"
- },
- "subcontract_limitations_permission_val": {
- "type": "string"
- },
- "subcontract_limitations_permitted": {
- "type": "boolean"
- },
- "underlying_agreement_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "underlying_agreement_type": {
- "enum": [
- "internal",
- "external",
- "none"
- ],
- "type": "string"
- },
- "underlying_agreement_val": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "billing_email": {
- "description": "Email of the billing contact. Used when include_billing_info is true.",
- "format": "email",
- "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
- "type": "string"
- },
- "billing_name": {
- "description": "Name of the billing contact. Used when include_billing_info is true.",
- "type": "string"
- },
- "billing_workflow_type": {
- "description": "The type of billing workflow. Use \"link\" to provide a payment_link_url, or \"stripe\" for Stripe-managed billing.",
- "enum": [
- "link",
- "stripe"
- ],
- "type": "string"
- },
- "chosen_courts_country": {
- "description": "The country in which disputes will be resolved.",
- "type": "string"
- },
- "chosen_courts_region": {
- "description": "The state or region in which disputes will be resolved.",
- "type": "string"
- },
- "csa_attributes": {
- "additionalProperties": false,
- "description": "Override csa terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "customer_description": {
- "type": "string"
- },
- "effective_date": {
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "effective_date_marketplace": {
- "enum": [
- "AWS",
- "GCP",
- "Azure"
- ],
- "type": "string"
- },
- "effective_date_type": {
- "enum": [
- "signature",
- "date",
- "marketplace_acceptance"
- ],
- "type": "string"
- },
- "general_cap_amount": {
- "type": "number"
- },
- "general_cap_amount_type": {
- "enum": [
- "preceding",
- "base",
- "period"
- ],
- "type": "string"
- },
- "general_cap_period_currency": {
- "type": "number"
- },
- "general_cap_period_qty": {
- "type": "number"
- },
- "general_cap_preceding_amount": {
- "type": "number"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_acceptable_use_policy": {
- "type": "boolean"
- },
- "include_acceptable_use_policy_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_acceptable_use_policy_location": {
- "type": "string"
- },
- "include_acceptable_use_policy_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_additional_warranties": {
- "type": "boolean"
- },
- "include_additional_warranties_by_customer": {
- "type": "string"
- },
- "include_additional_warranties_by_provider": {
- "type": "string"
- },
- "include_additional_warranties_include_by_customer": {
- "type": "boolean"
- },
- "include_additional_warranties_include_by_provider": {
- "type": "boolean"
- },
- "include_ai_addendum": {
- "type": "boolean"
- },
- "include_ai_addendum_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_covered_claims": {
- "type": "boolean"
- },
- "include_covered_claims_customer_claims": {
- "type": "string"
- },
- "include_covered_claims_include_customer_claims": {
- "type": "boolean"
- },
- "include_covered_claims_include_provider_claims": {
- "type": "boolean"
- },
- "include_covered_claims_provider_claims": {
- "type": "string"
- },
- "include_dpa": {
- "type": "boolean"
- },
- "include_dpa_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_dpa_location": {
- "type": "string"
- },
- "include_dpa_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_increased_cap_amount": {
- "type": "boolean"
- },
- "include_increased_claims": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_confidentiality": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_confidentiality_negligence": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_privsec": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_privsec_negligence": {
- "type": "boolean"
- },
- "include_increased_claims_include_other": {
- "type": "boolean"
- },
- "include_increased_claims_indemnification_obligation": {
- "type": "boolean"
- },
- "include_increased_claims_other": {
- "type": "string"
- },
- "include_insurance_minimums": {
- "type": "boolean"
- },
- "include_insurance_minimums_add_customer": {
- "type": "boolean"
- },
- "include_insurance_minimums_add_customer_com_gen_liability": {
- "type": "boolean"
- },
- "include_insurance_minimums_add_customer_cyber_liability": {
- "type": "boolean"
- },
- "include_insurance_minimums_add_customer_errors_omissions": {
- "type": "boolean"
- },
- "include_insurance_minimums_additional_information": {
- "type": "boolean"
- },
- "include_insurance_minimums_additional_information_text": {
- "type": "string"
- },
- "include_insurance_minimums_cyber_liability_aggregate": {
- "type": "number"
- },
- "include_insurance_minimums_cyber_liability_minimum": {
- "type": "number"
- },
- "include_insurance_minimums_employer_liability_aggregate": {
- "type": "number"
- },
- "include_insurance_minimums_employer_liability_minimum": {
- "type": "number"
- },
- "include_insurance_minimums_general_liability_aggregate": {
- "type": "number"
- },
- "include_insurance_minimums_general_liability_minimum": {
- "type": "number"
- },
- "include_insurance_minimums_include_cyber_liability": {
- "type": "boolean"
- },
- "include_insurance_minimums_include_employer_liability": {
- "type": "boolean"
- },
- "include_insurance_minimums_include_general_liability": {
- "type": "boolean"
- },
- "include_insurance_minimums_include_workers_compensation": {
- "type": "boolean"
- },
- "include_publicity_rights": {
- "type": "boolean"
- },
- "include_publicity_rights_type": {
- "enum": [
- "public",
- "non-public"
- ],
- "type": "string"
- },
- "include_security_policy": {
- "type": "boolean"
- },
- "include_security_policy_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_security_policy_fedramp_auth": {
- "type": "boolean"
- },
- "include_security_policy_hipaa": {
- "type": "boolean"
- },
- "include_security_policy_hitrust": {
- "type": "boolean"
- },
- "include_security_policy_include_annual_maintenance": {
- "type": "boolean"
- },
- "include_security_policy_include_location": {
- "type": "boolean"
- },
- "include_security_policy_include_other": {
- "type": "boolean"
- },
- "include_security_policy_include_reasonable_efforts": {
- "type": "boolean"
- },
- "include_security_policy_iso27001": {
- "type": "boolean"
- },
- "include_security_policy_location": {
- "type": "string"
- },
- "include_security_policy_other": {
- "type": "string"
- },
- "include_security_policy_pci1": {
- "type": "boolean"
- },
- "include_security_policy_pci2": {
- "type": "boolean"
- },
- "include_security_policy_penetration_testing": {
- "type": "boolean"
- },
- "include_security_policy_soc2": {
- "type": "boolean"
- },
- "include_security_policy_soc2_type2": {
- "type": "boolean"
- },
- "include_security_policy_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_supercap": {
- "description": "CSA 3.0 renamed `include_increased_cap_amount` to `include_supercap`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_increased_cap_amount`. Sending the other spelling returns a 422.",
- "type": "boolean"
- },
- "include_uncapped_claims": {
- "description": "CSA 3.0 renamed `include_unlimited_claims` to `include_uncapped_claims`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims`. Sending the other spelling returns a 422.",
- "type": "boolean"
- },
- "include_uncapped_claims_breach_of_confidentiality": {
- "description": "CSA 3.0 renamed `include_unlimited_claims_breach_of_confidentiality` to `include_uncapped_claims_breach_of_confidentiality`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_breach_of_confidentiality`. Sending the other spelling returns a 422.",
- "type": "boolean"
- },
- "include_uncapped_claims_breach_of_confidentiality_negligence": {
- "description": "CSA 3.0 renamed `include_unlimited_claims_breach_of_confidentiality_negligence` to `include_uncapped_claims_breach_of_confidentiality_negligence`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_breach_of_confidentiality_negligence`. Sending the other spelling returns a 422.",
- "type": "boolean"
- },
- "include_uncapped_claims_breach_of_privsec": {
- "description": "CSA 3.0 renamed `include_unlimited_claims_breach_of_privsec` to `include_uncapped_claims_breach_of_privsec`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_breach_of_privsec`. Sending the other spelling returns a 422.",
- "type": "boolean"
- },
- "include_uncapped_claims_breach_of_privsec_negligence": {
- "description": "CSA 3.0 renamed `include_unlimited_claims_breach_of_privsec_negligence` to `include_uncapped_claims_breach_of_privsec_negligence`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_breach_of_privsec_negligence`. Sending the other spelling returns a 422.",
- "type": "boolean"
- },
- "include_uncapped_claims_include_other": {
- "description": "CSA 3.0 renamed `include_unlimited_claims_include_other` to `include_uncapped_claims_include_other`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_include_other`. Sending the other spelling returns a 422.",
- "type": "boolean"
- },
- "include_uncapped_claims_indemnification_obligation": {
- "description": "CSA 3.0 renamed `include_unlimited_claims_indemnification_obligation` to `include_uncapped_claims_indemnification_obligation`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_indemnification_obligation`. Sending the other spelling returns a 422.",
- "type": "boolean"
- },
- "include_uncapped_claims_other": {
- "description": "CSA 3.0 renamed `include_unlimited_claims_other` to `include_uncapped_claims_other`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_other`. Sending the other spelling returns a 422.",
- "type": "boolean"
- },
- "include_unlimited_claims": {
- "type": "boolean"
- },
- "include_unlimited_claims_breach_of_confidentiality": {
- "type": "boolean"
- },
- "include_unlimited_claims_breach_of_confidentiality_negligence": {
- "type": "boolean"
- },
- "include_unlimited_claims_breach_of_privsec": {
- "type": "boolean"
- },
- "include_unlimited_claims_breach_of_privsec_negligence": {
- "type": "boolean"
- },
- "include_unlimited_claims_include_other": {
- "type": "boolean"
- },
- "include_unlimited_claims_indemnification_obligation": {
- "type": "boolean"
- },
- "include_unlimited_claims_other": {
- "type": "string"
- },
- "increased_cap_amount_currency": {
- "type": "number"
- },
- "increased_cap_amount_period_currency": {
- "type": "number"
- },
- "increased_cap_amount_period_qty": {
- "type": "number"
- },
- "increased_cap_amount_qty": {
- "type": "number"
- },
- "increased_cap_amount_type": {
- "enum": [
- "qty",
- "currency",
- "period"
- ],
- "type": "string"
- },
- "provider": {
- "type": "string"
- },
- "supercap_currency": {
- "description": "CSA 3.0 renamed `increased_cap_amount_currency` to `supercap_currency`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `increased_cap_amount_currency`. Sending the other spelling returns a 422.",
- "type": "number"
- },
- "supercap_period_currency": {
- "description": "CSA 3.0 renamed `increased_cap_amount_period_currency` to `supercap_period_currency`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `increased_cap_amount_period_currency`. Sending the other spelling returns a 422.",
- "type": "number"
- },
- "supercap_period_qty": {
- "description": "CSA 3.0 renamed `increased_cap_amount_period_qty` to `supercap_period_qty`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `increased_cap_amount_period_qty`. Sending the other spelling returns a 422.",
- "type": "number"
- },
- "supercap_qty": {
- "description": "CSA 3.0 renamed `increased_cap_amount_qty` to `supercap_qty`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `increased_cap_amount_qty`. Sending the other spelling returns a 422.",
- "type": "number"
- },
- "supercap_type": {
- "description": "CSA 3.0 renamed `increased_cap_amount_type` to `supercap_type`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `increased_cap_amount_type`. Sending the other spelling returns a 422.",
- "type": "number"
- }
- },
- "type": "object"
- },
- "csa_order_form_attributes": {
- "additionalProperties": false,
- "description": "Override csa order form terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "additional_changes": {
- "type": "string"
- },
- "additional_parameters_or_limitations": {
- "type": "string"
- },
- "affiliates_as_users": {
- "type": "boolean"
- },
- "cloud_service_description": {
- "type": "string"
- },
- "consumption_units": {
- "type": "string"
- },
- "fee_amount": {
- "type": "number"
- },
- "fee_custom_unit": {
- "type": "string"
- },
- "fee_period": {
- "enum": [
- "Subscription Period",
- "month",
- "year",
- "User",
- "Custom unit"
- ],
- "type": "string"
- },
- "fees_attributes": {
- "additionalProperties": {
- "anyOf": [
- {
- "additionalProperties": false,
- "description": "Fees::Flat (fee_type \"flat\"). A fixed recurring fee, e.g. a platform subscription. Set type to \"Fees::Flat\" or fee_type to \"flat\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "Fixed amount in the order form's fees_currency, charged per fee_period. A plain amount, not cents: 20 means 20.00.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"flat\". Alternative to type.",
- "enum": [
- "flat"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Flat\". Optional when fee_type is set.",
- "enum": [
- "Fees::Flat"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Discount (fee_type \"discount\"). A discount, as a fixed amount or a percentage, applied forever, once, or for a number of months. Set type to \"Fees::Discount\" or fee_type to \"discount\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "Discount size: an amount in fees_currency when discount_type is fixed_amount (a plain amount, not cents: 20 means 20.00), or a percentage (e.g. 10 for 10%) when it is percentage.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "discount_duration_amount": {
- "description": "Number of months the discount applies. Required when discount_duration_type is multiple_months.",
- "type": "number"
- },
- "discount_duration_type": {
- "description": "How long the discount applies. multiple_months also needs discount_duration_amount.",
- "enum": [
- "forever",
- "once",
- "multiple_months"
- ],
- "type": "string"
- },
- "discount_type": {
- "description": "Whether cost is a currency amount or a percentage.",
- "enum": [
- "fixed_amount",
- "percentage"
- ],
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"discount\". Alternative to type.",
- "enum": [
- "discount"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Discount\". Optional when fee_type is set.",
- "enum": [
- "Fees::Discount"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Cost (fee_type \"cost\"). A per-unit fee: price per unit times quantity, e.g. seats. Set type to \"Fees::Cost\" or fee_type to \"cost\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "Price per unit in fees_currency. The row total is quantity x cost. A plain amount, not cents: 20 means 20.00.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"cost\". Alternative to type.",
- "enum": [
- "cost"
- ],
- "type": "string"
- },
- "quantity": {
- "description": "Number of units.",
- "type": "number"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Cost\". Optional when fee_type is set.",
- "enum": [
- "Fees::Cost"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Attachment (fee_type \"attachment\"). A fee described in an uploaded attachment instead of in the table. Set type to \"Fees::Attachment\" or fee_type to \"attachment\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "attachment_id": {
- "description": "ID of an attachment uploaded with upload-attachment.",
- "type": "string"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"attachment\". Alternative to type.",
- "enum": [
- "attachment"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Attachment\". Optional when fee_type is set.",
- "enum": [
- "Fees::Attachment"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Graduated (fee_type \"graduated\"). Tiered pricing, with the price set per tier in graduated_fee_tiers_attributes. Set type to \"Fees::Graduated\" or fee_type to \"graduated\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"graduated\". Alternative to type.",
- "enum": [
- "graduated"
- ],
- "type": "string"
- },
- "graduated_fee_tiers_attributes": {
- "additionalProperties": {
- "additionalProperties": false,
- "properties": {
- "flat_price": {
- "type": "number"
- },
- "price_per_unit": {
- "type": "string"
- },
- "upper_limit": {
- "type": "number"
- }
- },
- "type": "object"
- },
- "description": "Graduated fee tiers. Use string keys such as \"0\", \"1\".",
- "propertyNames": {
- "type": "string"
- },
- "type": "object"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Graduated\". Optional when fee_type is set.",
- "enum": [
- "Fees::Graduated"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Included (fee_type \"included\"). An item included at no charge. Set type to \"Fees::Included\" or fee_type to \"included\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"included\". Alternative to type.",
- "enum": [
- "included"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Included\". Optional when fee_type is set.",
- "enum": [
- "Fees::Included"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Metered (fee_type \"metered\"). Usage-based pricing, billed per unit used. Set type to \"Fees::Metered\" or fee_type to \"metered\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "Price per unit of usage in fees_currency. A plain amount, not cents: 20 means 20.00.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"metered\". Alternative to type.",
- "enum": [
- "metered"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Metered\". Optional when fee_type is set.",
- "enum": [
- "Fees::Metered"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::OneTime (fee_type \"one_time\"). A one-time charge, such as a setup fee. Set type to \"Fees::OneTime\" or fee_type to \"one_time\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "One-time amount in fees_currency, charged once rather than per fee_period. A plain amount, not cents: 20 means 20.00.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"one_time\". Alternative to type.",
- "enum": [
- "one_time"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::OneTime\". Optional when fee_type is set.",
- "enum": [
- "Fees::OneTime"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Text (fee_type \"text\"). A fee term described in free text. Set type to \"Fees::Text\" or fee_type to \"text\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"text\". Alternative to type.",
- "enum": [
- "text"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Text\". Optional when fee_type is set.",
- "enum": [
- "Fees::Text"
- ],
- "type": "string"
- }
- },
- "type": "object"
- }
- ]
- },
- "description": "Fee table rows, keyed by string index (\"0\", \"1\", ...). Replaces the template's fees when provided. Each row sets type or fee_type to pick the fee class. Amounts are in the order form's fees_currency and, for recurring fees, are charged per fee_period.",
- "examples": [
- {
- "0": {
- "cost": 2000,
- "description": "Platform subscription",
- "type": "Fees::Flat"
- }
- },
- {
- "0": {
- "cost": 50,
- "description": "Seats",
- "fee_type": "cost",
- "quantity": 10
- },
- "1": {
- "cost": 10,
- "description": "Launch discount",
- "discount_duration_amount": 3,
- "discount_duration_type": "multiple_months",
- "discount_type": "percentage",
- "fee_type": "discount"
- }
- }
- ],
- "propertyNames": {
- "type": "string"
- },
- "type": "object"
- },
- "fees_currency": {
- "enum": [
- "USD",
- "EUR",
- "GBP",
- "CAD",
- "AUD",
- "SGD",
- "ILS",
- "JPY",
- "CHF",
- "HKD"
- ],
- "type": "string"
- },
- "fees_include_fee_increase_upon_renewal": {
- "type": "boolean"
- },
- "fees_include_fee_increase_upon_renewal_fee": {
- "type": "number"
- },
- "fees_include_fee_increase_upon_renewal_type": {
- "enum": [
- "will",
- "may"
- ],
- "type": "string"
- },
- "fees_inclusive_of_taxes": {
- "type": "boolean"
- },
- "framework_terms_type": {
- "enum": [
- "new",
- "existing",
- "description"
- ],
- "type": "string"
- },
- "free_trial_days": {
- "type": "number"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_additional_changes": {
- "type": "boolean"
- },
- "include_additional_parameters_or_limitations": {
- "type": "boolean"
- },
- "include_consumption": {
- "type": "boolean"
- },
- "include_fees": {
- "type": "boolean"
- },
- "include_fees_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_fees_include_attachment": {
- "type": "boolean"
- },
- "include_fees_other": {
- "type": "boolean"
- },
- "include_fees_other_val": {
- "type": "string"
- },
- "include_fees_table": {
- "type": "boolean"
- },
- "include_fees_table_period": {
- "enum": [
- "Subscription Period",
- "month",
- "year",
- "User"
- ],
- "type": "string"
- },
- "include_free_trial": {
- "type": "boolean"
- },
- "include_max_users": {
- "type": "boolean"
- },
- "include_pilot_period": {
- "type": "boolean"
- },
- "include_pilot_period_duration_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_pilot_period_duration_type": {
- "enum": [
- "day",
- "week",
- "month"
- ],
- "type": "string"
- },
- "include_pilot_period_include_fees": {
- "type": "boolean"
- },
- "include_pilot_period_include_fees_amount": {
- "type": "number"
- },
- "include_pilot_period_include_modifications": {
- "type": "boolean"
- },
- "include_pilot_period_include_modifications_description": {
- "type": "string"
- },
- "include_product_support": {
- "type": "boolean"
- },
- "include_product_support_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_product_support_description": {
- "type": "string"
- },
- "include_product_support_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_professional_services": {
- "type": "boolean"
- },
- "include_professional_services_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_professional_services_custom_name": {
- "type": "string"
- },
- "include_professional_services_description": {
- "type": "string"
- },
- "include_professional_services_end_date": {
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "include_professional_services_fees_description": {
- "type": "string"
- },
- "include_professional_services_include_end_date": {
- "type": "boolean"
- },
- "include_professional_services_include_fees_description": {
- "type": "boolean"
- },
- "include_professional_services_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_sla": {
- "type": "boolean"
- },
- "include_sla_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_sla_description": {
- "type": "string"
- },
- "include_sla_include_response_time": {
- "type": "boolean"
- },
- "include_sla_include_response_time_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_sla_include_response_time_credit": {
- "type": "number"
- },
- "include_sla_include_response_time_duration": {
- "enum": [
- "hour",
- "day",
- "week",
- "month",
- "hours"
- ],
- "type": "string"
- },
- "include_sla_include_response_time_support_channel": {
- "type": "string"
- },
- "include_sla_include_target_uptime": {
- "type": "boolean"
- },
- "include_sla_maintenance_notice": {
- "type": "boolean"
- },
- "include_sla_maintenance_window": {
- "type": "boolean"
- },
- "include_sla_maintenance_window_type": {
- "enum": [
- "standard",
- "none"
- ],
- "type": "string"
- },
- "include_sla_standard_maintenance_notice_qty": {
- "type": "number"
- },
- "include_sla_standard_maintenance_notice_unit": {
- "enum": [
- "hour",
- "day",
- "week",
- "month"
- ],
- "type": "string"
- },
- "include_sla_standard_maintenance_window_end_time": {
- "type": "string"
- },
- "include_sla_standard_maintenance_window_friday": {
- "type": "boolean"
- },
- "include_sla_standard_maintenance_window_monday": {
- "type": "boolean"
- },
- "include_sla_standard_maintenance_window_saturday": {
- "type": "boolean"
- },
- "include_sla_standard_maintenance_window_start_time": {
- "type": "string"
- },
- "include_sla_standard_maintenance_window_sunday": {
- "type": "boolean"
- },
- "include_sla_standard_maintenance_window_thursday": {
- "type": "boolean"
- },
- "include_sla_standard_maintenance_window_time_zone": {
- "type": "string"
- },
- "include_sla_standard_maintenance_window_tuesday": {
- "type": "boolean"
- },
- "include_sla_standard_maintenance_window_wednesday": {
- "type": "boolean"
- },
- "include_sla_standard_target_uptime": {
- "type": "number"
- },
- "include_sla_type": {
- "enum": [
- "description",
- "standard",
- "attachment"
- ],
- "type": "string"
- },
- "include_subscription_start_date": {
- "type": "boolean"
- },
- "include_subscription_start_date_date": {
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "include_usage_review": {
- "type": "boolean"
- },
- "include_usage_review_val": {
- "type": "string"
- },
- "include_use_limitations": {
- "type": "boolean"
- },
- "include_use_limitations_val": {
- "type": "string"
- },
- "invoice_period": {
- "enum": [
- "monthly",
- "quarterly",
- "semiannually",
- "annually",
- "Custom unit",
- "Monthly",
- "Quarterly",
- "Semiannually",
- "Annually"
- ],
- "type": "string"
- },
- "invoice_period_custom_unit": {
- "type": "string"
- },
- "max_consumption": {
- "type": "number"
- },
- "max_users": {
- "type": "number"
- },
- "negotiations_allowed": {
- "description": "When true, the recipient can propose changes to the order form, even when the agreement-level `negotiations_allowed` is false. This only covers the order form.",
- "type": "boolean"
- },
- "order_date_date": {
- "type": "string"
- },
- "order_date_other": {
- "type": "string"
- },
- "order_date_type": {
- "enum": [
- "signature",
- "date",
- "other"
- ],
- "type": "string"
- },
- "payment_period": {
- "type": "number"
- },
- "payment_period_timeframe": {
- "enum": [
- "Customer's receipt of invoice",
- "date of invoice"
- ],
- "type": "string"
- },
- "payment_period_unit": {
- "enum": [
- "day(s)",
- "week(s)",
- "month(s)",
- "marketplace_acceptance"
- ],
- "type": "string"
- },
- "payment_process_automatic_frequency": {
- "enum": [
- "monthly",
- "quarterly",
- "semiannually",
- "annually"
- ],
- "type": "string"
- },
- "payment_process_type": {
- "enum": [
- "automatic",
- "invoice",
- "custom",
- "marketplace_acceptance"
- ],
- "type": "string"
- },
- "payment_process_type_custom_val": {
- "type": "string"
- },
- "payment_process_type_invoice_amount": {
- "type": "number"
- },
- "payment_process_type_invoice_custom_unit": {
- "type": "string"
- },
- "payment_process_type_invoice_duration": {
- "enum": [
- "day",
- "week",
- "month",
- "year",
- "day(s)",
- "week(s)",
- "month(s)",
- "year(s)"
- ],
- "type": "string"
- },
- "payment_process_type_invoice_duration_start": {
- "enum": [
- "Customer's receipt of invoice",
- "date of invoice"
- ],
- "type": "string"
- },
- "payment_process_type_invoice_type": {
- "enum": [
- "monthly",
- "quarterly",
- "semiannually",
- "annually",
- "Custom unit"
- ],
- "type": "string"
- },
- "pilot_period_stripe_product_id": {
- "type": "string"
- },
- "service_credits_attributes": {
- "additionalProperties": {
- "additionalProperties": false,
- "properties": {
- "credit": {
- "type": "number"
- },
- "max": {
- "type": "number"
- },
- "min": {
- "type": "number"
- }
- },
- "type": "object"
- },
- "description": "Service credits. Use string keys such as \"0\", \"1\".",
- "propertyNames": {
- "type": "string"
- },
- "type": "object"
- },
- "subscription_auto_renew": {
- "enum": [
- "days",
- "subscription_end"
- ],
- "type": "string"
- },
- "subscription_period": {
- "type": "number"
- },
- "subscription_period_unit": {
- "type": "string"
- },
- "subscription_renewal_notice_days": {
- "type": "number"
- },
- "subscription_start_date": {
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "subscription_start_date_type": {
- "enum": [
- "effective_date",
- "date"
- ],
- "type": "string"
- },
- "underlying_agreement_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "use_limitations_attributes": {
- "additionalProperties": {
- "additionalProperties": false,
- "properties": {
- "amount": {
- "type": "number"
- },
- "limitation_type": {
- "type": "string"
- },
- "unit": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "description": "Use limitations. Use string keys such as \"0\", \"1\".",
- "propertyNames": {
- "type": "string"
- },
- "type": "object"
- }
- },
- "type": "object"
- },
- "custom_field_values": {
- "description": "Values for a custom template's fields, keyed by the field keys defined in the template's YAML definition. Only used when template_id is a custom template. Template defaults fill any fields you omit; a required field with no default and no submitted value returns a 400 naming the field. Values are validated against the field's input type: select and radio values must be one of the field's options, multiselect values are an array of selections each of which must be one of the field's options, number and currency values must be numeric, date values must be YYYY-MM-DD, and email values must be valid addresses. An invalid value returns a 400 naming the field."
- },
- "design_partner_attributes": {
- "additionalProperties": false,
- "description": "Override design partner terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "customer_description": {
- "type": "string"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_fees": {
- "type": "boolean"
- },
- "include_fees_amount": {
- "type": "number"
- },
- "include_fees_description": {
- "type": "string"
- },
- "include_fees_pay_by_amount": {
- "type": "string"
- },
- "include_fees_type": {
- "enum": [
- "default_language",
- "description"
- ],
- "type": "string"
- },
- "include_fees_unit": {
- "enum": [
- "month",
- "quarter",
- "year",
- "Term"
- ],
- "type": "string"
- },
- "include_program_appear_as_customer_private": {
- "type": "boolean"
- },
- "include_program_appear_as_customer_public": {
- "type": "boolean"
- },
- "include_program_case_study": {
- "type": "boolean"
- },
- "include_program_develop_functionality": {
- "type": "boolean"
- },
- "include_program_develop_functionality_val": {
- "type": "string"
- },
- "include_program_discount": {
- "type": "boolean"
- },
- "include_program_discount_amount": {
- "type": "number"
- },
- "include_program_discount_unit": {
- "enum": [
- "U.S. Dollars",
- "percent"
- ],
- "type": "string"
- },
- "include_program_participation_feedback": {
- "type": "boolean"
- },
- "include_program_participation_feedback_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_program_participation_feedback_unit": {
- "enum": [
- "month",
- "quarter",
- "year",
- "Term"
- ],
- "type": "string"
- },
- "include_program_partner_other": {
- "type": "boolean"
- },
- "include_program_partner_other_val": {
- "type": "string"
- },
- "include_program_provider_other": {
- "type": "boolean"
- },
- "include_program_provider_other_val": {
- "type": "string"
- },
- "include_program_reference": {
- "type": "boolean"
- },
- "product_description": {
- "type": "string"
- },
- "term_amount": {
- "type": "number"
- },
- "term_unit": {
- "enum": [
- "day(s)",
- "week(s)",
- "month(s)",
- "quarter(s)",
- "year(s)"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- "district_or_county": {
- "description": "The district or county for dispute resolution.",
- "type": "string"
- },
- "dpa_attributes": {
- "additionalProperties": false,
- "description": "Override dpa terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "approved_subprocessor_type": {
- "description": "`internal` lists approved subprocessors in the agreement (`subprocessors_attributes`); `external` points to a list published elsewhere.",
- "enum": [
- "internal",
- "external"
- ],
- "type": "string"
- },
- "cloud_service_product_name": {
- "type": "string"
- },
- "competent_supervisory_authority": {
- "type": "string"
- },
- "customer_description": {
- "type": "string"
- },
- "data_exporter_address_city": {
- "type": "string"
- },
- "data_exporter_address_country": {
- "type": "string"
- },
- "data_exporter_address_state": {
- "type": "string"
- },
- "data_exporter_address_street_address": {
- "type": "string"
- },
- "data_exporter_address_zipcode": {
- "type": "string"
- },
- "data_exporter_contact_details": {
- "type": "string"
- },
- "data_exporter_contact_name": {
- "type": "string"
- },
- "data_exporter_contact_position": {
- "type": "string"
- },
- "data_exporter_role": {
- "description": "Role of the data exporter. Overwritten to `Controller` when the agreement is created from a template.",
- "enum": [
- "Controller",
- "Processor"
- ],
- "type": "string"
- },
- "data_importer_address": {
- "type": "string"
- },
- "data_importer_address_city": {
- "type": "string"
- },
- "data_importer_address_country": {
- "type": "string"
- },
- "data_importer_address_state": {
- "type": "string"
- },
- "data_importer_address_street_address": {
- "type": "string"
- },
- "data_importer_address_zipcode": {
- "type": "string"
- },
- "data_importer_contact_details": {
- "type": "string"
- },
- "data_importer_contact_name": {
- "type": "string"
- },
- "data_importer_contact_position": {
- "type": "string"
- },
- "duration_of_processing": {
- "type": "string"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_covered_claim": {
- "type": "boolean"
- },
- "include_covered_claim_external_val": {
- "type": "string"
- },
- "include_covered_claim_internal_val": {
- "type": "string"
- },
- "include_covered_claim_type": {
- "description": "Which covered-claim text applies: `internal` uses `include_covered_claim_internal_val`, `external` uses `include_covered_claim_external_val`. Required when `include_covered_claim` is true.",
- "enum": [
- "internal",
- "external"
- ],
- "type": "string"
- },
- "include_data_subjects_custom": {
- "type": "boolean"
- },
- "include_data_subjects_custom_val": {
- "type": "string"
- },
- "include_data_subjects_employees": {
- "type": "boolean"
- },
- "include_data_subjects_end_users": {
- "type": "boolean"
- },
- "include_external_subprocessor_location": {
- "type": "string"
- },
- "include_frequency_of_transfer_continuous": {
- "type": "boolean"
- },
- "include_frequency_of_transfer_custom": {
- "type": "boolean"
- },
- "include_frequency_of_transfer_custom_val": {
- "type": "string"
- },
- "include_governing_country_eu": {
- "type": "boolean"
- },
- "include_governing_country_eu_val": {
- "type": "string"
- },
- "include_governing_country_uk": {
- "type": "boolean"
- },
- "include_governing_country_uk_val": {
- "type": "string"
- },
- "include_governing_law": {
- "type": "boolean"
- },
- "include_governing_law_country": {
- "type": "string"
- },
- "include_governing_law_state": {
- "type": "string"
- },
- "include_increased_claim_amount": {
- "description": "Legacy field. Stored but not shown on the DPA; use the `include_liability_cap*` fields instead.",
- "type": "boolean"
- },
- "include_increased_claim_amount_currency": {
- "description": "Legacy field. Stored but not shown on the DPA; use the `include_liability_cap*` fields instead."
- },
- "include_increased_claim_amount_qty": {
- "description": "Legacy field. Stored but not shown on the DPA; use the `include_liability_cap*` fields instead."
- },
- "include_increased_claim_amount_type": {
- "description": "Legacy field. Stored but not shown on the DPA; use the `include_liability_cap*` fields instead.",
- "type": "string"
- },
- "include_liability_cap": {
- "type": "boolean"
- },
- "include_liability_cap_amount_constant_external": {
- "type": "string"
- },
- "include_liability_cap_amount_constant_internal": {
- "type": "string"
- },
- "include_liability_cap_amount_currency_external": {
- "description": "Currency amount. Numbers and numeric strings (commas allowed) are both accepted."
- },
- "include_liability_cap_amount_currency_internal": {
- "description": "Currency amount. Numbers and numeric strings (commas allowed) are both accepted."
- },
- "include_liability_cap_csa_type": {
- "description": "Which liability cap values apply: the `_internal` or `_external` amount fields. Required when `include_liability_cap` is true.",
- "enum": [
- "internal",
- "external"
- ],
- "type": "string"
- },
- "include_personal_data_biographic_info": {
- "type": "boolean"
- },
- "include_personal_data_contact_info": {
- "type": "boolean"
- },
- "include_personal_data_custom": {
- "type": "boolean"
- },
- "include_personal_data_custom_val": {
- "type": "string"
- },
- "include_personal_data_employment_info": {
- "type": "boolean"
- },
- "include_personal_data_financial_info": {
- "type": "boolean"
- },
- "include_personal_data_location": {
- "type": "boolean"
- },
- "include_personal_data_name": {
- "type": "boolean"
- },
- "include_personal_data_transactional_info": {
- "type": "boolean"
- },
- "include_personal_data_user_activity_info": {
- "type": "boolean"
- },
- "include_processing_purpose_custom": {
- "type": "boolean"
- },
- "include_processing_purpose_custom_val": {
- "type": "string"
- },
- "include_processing_purpose_erasing": {
- "type": "boolean"
- },
- "include_processing_purpose_holding": {
- "type": "boolean"
- },
- "include_processing_purpose_protecting": {
- "type": "boolean"
- },
- "include_processing_purpose_receiving": {
- "type": "boolean"
- },
- "include_processing_purpose_returning": {
- "type": "boolean"
- },
- "include_processing_purpose_sharing": {
- "type": "boolean"
- },
- "include_processing_purpose_updating": {
- "type": "boolean"
- },
- "include_processing_purpose_using": {
- "type": "boolean"
- },
- "include_provider_security_contact_address": {
- "type": "boolean"
- },
- "include_provider_security_contact_address_city": {
- "type": "string"
- },
- "include_provider_security_contact_address_country": {
- "type": "string"
- },
- "include_provider_security_contact_address_state": {
- "type": "string"
- },
- "include_provider_security_contact_address_street_address": {
- "type": "string"
- },
- "include_provider_security_contact_address_zipcode": {
- "type": "string"
- },
- "include_provider_security_contact_email": {
- "type": "boolean"
- },
- "include_provider_security_contact_email_val": {
- "format": "email",
- "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
- "type": "string"
- },
- "include_security_measures_accountability": {
- "type": "boolean"
- },
- "include_security_measures_accountability_val": {
- "type": "string"
- },
- "include_security_measures_certification_or_assurance": {
- "type": "boolean"
- },
- "include_security_measures_certification_or_assurance_val": {
- "type": "string"
- },
- "include_security_measures_confidentiality_integrity": {
- "type": "boolean"
- },
- "include_security_measures_confidentiality_integrity_val": {
- "type": "string"
- },
- "include_security_measures_data_at_rest": {
- "type": "boolean"
- },
- "include_security_measures_data_at_rest_val": {
- "type": "string"
- },
- "include_security_measures_data_minimization": {
- "type": "boolean"
- },
- "include_security_measures_data_minimization_val": {
- "type": "string"
- },
- "include_security_measures_data_quality": {
- "type": "boolean"
- },
- "include_security_measures_data_quality_val": {
- "type": "string"
- },
- "include_security_measures_data_retention": {
- "type": "boolean"
- },
- "include_security_measures_data_retention_val": {
- "type": "string"
- },
- "include_security_measures_data_transmission": {
- "type": "boolean"
- },
- "include_security_measures_data_transmission_val": {
- "type": "string"
- },
- "include_security_measures_event_logging": {
- "type": "boolean"
- },
- "include_security_measures_event_logging_val": {
- "type": "string"
- },
- "include_security_measures_identity_auth": {
- "type": "boolean"
- },
- "include_security_measures_identity_auth_val": {
- "type": "string"
- },
- "include_security_measures_it_security_governance": {
- "type": "boolean"
- },
- "include_security_measures_it_security_governance_val": {
- "type": "string"
- },
- "include_security_measures_physical_security": {
- "type": "boolean"
- },
- "include_security_measures_physical_security_val": {
- "type": "string"
- },
- "include_security_measures_portability_and_erasure": {
- "type": "boolean"
- },
- "include_security_measures_portability_and_erasure_val": {
- "type": "string"
- },
- "include_security_measures_pseudonym_encryption": {
- "type": "boolean"
- },
- "include_security_measures_pseudonym_encryption_val": {
- "type": "string"
- },
- "include_security_measures_restore_data_access": {
- "type": "boolean"
- },
- "include_security_measures_restore_data_access_val": {
- "type": "string"
- },
- "include_security_measures_security_policy": {
- "type": "boolean"
- },
- "include_security_measures_system_configuration": {
- "type": "boolean"
- },
- "include_security_measures_system_configuration_val": {
- "type": "string"
- },
- "include_security_measures_testing_assessment": {
- "type": "boolean"
- },
- "include_security_measures_testing_assessment_val": {
- "type": "string"
- },
- "include_security_policy": {
- "type": "boolean"
- },
- "include_security_policy_fedramp_auth": {
- "type": "boolean"
- },
- "include_security_policy_hipaa": {
- "type": "boolean"
- },
- "include_security_policy_hitrust": {
- "type": "boolean"
- },
- "include_security_policy_include_other": {
- "type": "boolean"
- },
- "include_security_policy_iso27001": {
- "type": "boolean"
- },
- "include_security_policy_other": {
- "type": "string"
- },
- "include_security_policy_pci1": {
- "type": "boolean"
- },
- "include_security_policy_pci2": {
- "type": "boolean"
- },
- "include_security_policy_penetration_testing": {
- "type": "boolean"
- },
- "include_security_policy_soc2": {
- "type": "boolean"
- },
- "include_security_policy_soc2_type2": {
- "type": "boolean"
- },
- "include_sensitive_data_restrictions_custom": {
- "type": "boolean"
- },
- "include_sensitive_data_restrictions_custom_val": {
- "type": "string"
- },
- "include_sensitive_data_restrictions_security_policy": {
- "type": "boolean"
- },
- "include_service_provider_relationship": {
- "type": "boolean"
- },
- "include_special_category_data": {
- "type": "boolean"
- },
- "provider": {
- "type": "string"
- },
- "security_policy_available_at": {
- "type": "string"
- },
- "security_policy_type": {
- "description": "Where the Security Policy is defined. For `external`, set `security_policy_available_at`.",
- "enum": [
- "defined in agreement",
- "provider service",
- "external"
- ],
- "type": "string"
- },
- "subprocessors_attributes": {
- "additionalProperties": {
- "additionalProperties": false,
- "properties": {
- "_destroy": {
- "description": "Set to true with `id` to remove that subprocessor.",
- "type": "boolean"
- },
- "country": {
- "type": "string"
- },
- "id": {
- "description": "ID of an existing subprocessor to update or remove. Omit to add a new subprocessor.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "name": {
- "type": "string"
- },
- "processing_task": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "description": "Subprocessors, keyed by string index such as \"0\", \"1\". On create these are added to the template's subprocessors. On a draft update, an entry without `id` adds a new subprocessor; pass `id` to change one and `id` with `_destroy: true` to remove one.",
- "propertyNames": {
- "type": "string"
- },
- "type": "object"
- },
- "underlying_agreement_id": {
- "description": "ID of the CSA this DPA supplements when `underlying_agreement_type` is `internal`.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "underlying_agreement_type": {
- "description": "`internal` links a CSA in Common Paper (`underlying_agreement_id`); `external` describes another agreement in `underlying_agreement_val` (required). Omit for none.",
- "enum": [
- "internal",
- "external"
- ],
- "type": "string"
- },
- "underlying_agreement_val": {
- "description": "Description of the agreement this DPA supplements. Required when `underlying_agreement_type` is `external`.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "framework_terms_description": {
- "description": "Custom framework terms description. Only used when framework_terms_type is \"description\".",
- "type": "string"
- },
- "framework_terms_type": {
- "description": "How framework terms are specified. Use \"new\" for standard terms or \"description\" to provide a custom framework_terms_description.",
- "enum": [
- "new",
- "description"
- ],
- "type": "string"
- },
- "governing_law_country": {
- "description": "The country whose laws govern the agreement.",
- "type": "string"
- },
- "governing_law_region": {
- "description": "The state or region whose laws govern the agreement.",
- "type": "string"
- },
- "include_automated_payment_reminders": {
- "description": "When true, automatically sends payment reminder emails.",
- "type": "boolean"
- },
- "include_billing_info": {
- "description": "When true, billing contact information (billing_name, billing_email) is included.",
- "type": "boolean"
- },
- "include_billing_workflow": {
- "description": "When true, enables a billing workflow after signing.",
- "type": "boolean"
- },
- "include_expiration_date": {
- "description": "Expiration date in YYYY-MM-DD format. Use when include_expiration_type is \"date\".",
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "include_expiration_days": {
- "description": "Number of days until the agreement expires. Use when include_expiration_type is \"days\".",
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_expiration_type": {
- "description": "How to set expiration: \"none\" (default), \"days\" (use include_expiration_days), or \"date\" (use include_expiration_date).",
- "enum": [
- "none",
- "days",
- "date"
- ],
- "type": "string"
- },
- "include_terms": {
- "description": "When true, the standard terms are included with the agreement.",
- "type": "boolean"
- },
- "loi_attributes": {
- "additionalProperties": false,
- "description": "Override loi terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "confidentiality_custom": {
- "type": "string"
- },
- "confidentiality_mutual_include_loi": {
- "type": "boolean"
- },
- "confidentiality_nda_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "confidentiality_nda_description": {
- "type": "string"
- },
- "confidentiality_nda_include_loi": {
- "type": "boolean"
- },
- "confidentiality_nda_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "confidentiality_type": {
- "enum": [
- "mutual",
- "nda",
- "provider",
- "custom"
- ],
- "type": "string"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_custom_details": {
- "type": "boolean"
- },
- "include_custom_details_val": {
- "type": "string"
- },
- "include_fees": {
- "type": "boolean"
- },
- "include_fees_amount": {
- "type": "number"
- },
- "include_fees_amount_duration": {
- "enum": [
- "month",
- "year",
- "quarter"
- ],
- "type": "string"
- },
- "include_fees_include_amount": {
- "type": "boolean"
- },
- "include_fees_include_other": {
- "type": "boolean"
- },
- "include_fees_other": {
- "type": "string"
- },
- "include_functionality": {
- "type": "boolean"
- },
- "include_functionality_val": {
- "type": "string"
- },
- "include_launch_date": {
- "type": "boolean"
- },
- "include_launch_date_custom": {
- "type": "string"
- },
- "include_launch_date_date": {
- "format": "date-time",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$",
- "type": "string"
- },
- "include_launch_date_type": {
- "enum": [
- "date",
- "custom"
- ],
- "type": "string"
- },
- "product_name": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "manual_send": {
- "description": "When true, the agreement is marked as manually sent outside the platform.",
- "type": "boolean"
- },
- "message": {
- "type": "string"
- },
- "negotiations_allowed": {
- "description": "When true, the recipient can propose changes to the legal terms. For agreement types without separate business terms, that covers every term. CSA order forms, PSA statements of work, partnership business terms and software license order forms have their own `negotiations_allowed` flag.",
- "type": "boolean"
- },
- "partnership_attributes": {
- "additionalProperties": false,
- "description": "Override partnership terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "effective_date": {
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "effective_date_type": {
- "enum": [
- "signature",
- "date"
- ],
- "type": "string"
- },
- "general_cap_amount_currency_val": {
- "type": "number"
- },
- "general_cap_amount_either_currency": {
- "type": "number"
- },
- "general_cap_amount_either_multiple": {
- "type": "number"
- },
- "general_cap_amount_multiple_val": {
- "type": "number"
- },
- "general_cap_amount_type": {
- "enum": [
- "multiple",
- "currency",
- "either",
- "base"
- ],
- "type": "string"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_additional_warranties": {
- "type": "boolean"
- },
- "include_additional_warranties_include_company": {
- "type": "boolean"
- },
- "include_additional_warranties_include_company_val": {
- "type": "string"
- },
- "include_additional_warranties_include_partner": {
- "type": "boolean"
- },
- "include_additional_warranties_include_partner_val": {
- "type": "string"
- },
- "include_brand_guidelines": {
- "type": "boolean"
- },
- "include_brand_guidelines_include_company": {
- "type": "boolean"
- },
- "include_brand_guidelines_include_company_val": {
- "type": "string"
- },
- "include_brand_guidelines_include_partner": {
- "type": "boolean"
- },
- "include_brand_guidelines_include_partner_val": {
- "type": "string"
- },
- "include_covered_claims": {
- "type": "boolean"
- },
- "include_covered_claims_company_claims": {
- "type": "string"
- },
- "include_covered_claims_include_company_claims": {
- "type": "boolean"
- },
- "include_covered_claims_include_partner_claims": {
- "type": "boolean"
- },
- "include_covered_claims_partner_claims": {
- "type": "string"
- },
- "include_dpa": {
- "type": "boolean"
- },
- "include_dpa_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_dpa_location": {
- "type": "string"
- },
- "include_dpa_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_increased_cap_amount": {
- "type": "boolean"
- },
- "include_increased_cap_amount_currency": {
- "type": "number"
- },
- "include_increased_cap_amount_either_currency": {
- "type": "number"
- },
- "include_increased_cap_amount_either_multiple": {
- "type": "string"
- },
- "include_increased_cap_amount_multiple": {
- "type": "string"
- },
- "include_increased_cap_amount_type": {
- "enum": [
- "multiple",
- "currency",
- "either"
- ],
- "type": "string"
- },
- "include_increased_claims": {
- "type": "boolean"
- },
- "include_increased_claims_include_confidentiality": {
- "type": "boolean"
- },
- "include_increased_claims_include_confidentiality_misconduct": {
- "type": "boolean"
- },
- "include_increased_claims_include_covered_claims": {
- "type": "boolean"
- },
- "include_increased_claims_include_misconduct": {
- "type": "boolean"
- },
- "include_increased_claims_include_other": {
- "type": "boolean"
- },
- "include_increased_claims_include_other_val": {
- "type": "string"
- },
- "include_unlimited_claims": {
- "type": "boolean"
- },
- "include_unlimited_claims_confidentiality": {
- "type": "boolean"
- },
- "include_unlimited_claims_confidentiality_misconduct": {
- "type": "boolean"
- },
- "include_unlimited_claims_covered_claims": {
- "type": "boolean"
- },
- "include_unlimited_claims_misconduct": {
- "type": "boolean"
- },
- "include_unlimited_claims_other": {
- "type": "boolean"
- },
- "include_unlimited_claims_other_val": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "partnership_business_terms_attributes": {
- "additionalProperties": false,
- "description": "Override partnership business terms terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "end_date_after_effective_date_amount": {
- "type": "number"
- },
- "end_date_after_effective_date_unit": {
- "enum": [
- "month(s)",
- "quarter(s)",
- "year(s)"
- ],
- "type": "string"
- },
- "end_date_date": {
- "type": "string"
- },
- "end_date_type": {
- "enum": [
- "date",
- "effective date"
- ],
- "type": "string"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_obligations_company_brand": {
- "type": "boolean"
- },
- "include_obligations_company_promotion": {
- "type": "boolean"
- },
- "include_obligations_company_promotion_include_activities": {
- "type": "boolean"
- },
- "include_obligations_company_promotion_include_activities_val": {
- "type": "string"
- },
- "include_obligations_company_promotion_include_materials": {
- "type": "boolean"
- },
- "include_obligations_company_promotion_include_materials_val": {
- "type": "string"
- },
- "include_obligations_company_referral": {
- "type": "boolean"
- },
- "include_obligations_company_referral_include_criteria": {
- "type": "boolean"
- },
- "include_obligations_company_referral_include_criteria_val": {
- "type": "string"
- },
- "include_obligations_company_referral_include_pay_sch": {
- "type": "boolean"
- },
- "include_obligations_company_referral_include_pay_sch_amount": {
- "type": "number"
- },
- "include_obligations_company_referral_include_pay_sch_custom": {
- "type": "string"
- },
- "include_obligations_company_referral_include_pay_sch_unit": {
- "enum": [
- "U.S. Dollars",
- "percent"
- ],
- "type": "string"
- },
- "include_obligations_company_sponsorship": {
- "type": "boolean"
- },
- "include_obligations_company_sponsorship_include_benefits": {
- "type": "boolean"
- },
- "include_obligations_company_sponsorship_include_benefits_val": {
- "type": "string"
- },
- "include_obligations_company_sponsorship_include_payments": {
- "type": "boolean"
- },
- "include_obligations_company_sponsorship_include_payments_amount": {
- "type": "number"
- },
- "include_obligations_company_sponsorship_include_payments_unit": {
- "enum": [
- "U.S. Dollars",
- "percent"
- ],
- "type": "string"
- },
- "include_obligations_partner_brand": {
- "type": "boolean"
- },
- "include_obligations_partner_promotion": {
- "type": "boolean"
- },
- "include_obligations_partner_promotion_include_activities": {
- "type": "boolean"
- },
- "include_obligations_partner_promotion_include_activities_val": {
- "type": "string"
- },
- "include_obligations_partner_promotion_include_materials": {
- "type": "boolean"
- },
- "include_obligations_partner_promotion_include_materials_val": {
- "type": "string"
- },
- "include_obligations_partner_referral": {
- "type": "boolean"
- },
- "include_obligations_partner_referral_include_criteria": {
- "type": "boolean"
- },
- "include_obligations_partner_referral_include_criteria_val": {
- "type": "string"
- },
- "include_obligations_partner_referral_include_pay_sch": {
- "type": "boolean"
- },
- "include_obligations_partner_referral_include_pay_sch_amount": {
- "type": "number"
- },
- "include_obligations_partner_referral_include_pay_sch_custom": {
- "type": "string"
- },
- "include_obligations_partner_referral_include_pay_sch_unit": {
- "enum": [
- "U.S. Dollars",
- "percent"
- ],
- "type": "string"
- },
- "include_obligations_partner_sponsorship": {
- "type": "boolean"
- },
- "include_obligations_partner_sponsorship_include_benefits": {
- "type": "boolean"
- },
- "include_obligations_partner_sponsorship_include_benefits_val": {
- "type": "string"
- },
- "include_obligations_partner_sponsorship_include_payments": {
- "type": "boolean"
- },
- "include_obligations_partner_sponsorship_include_payments_amount": {
- "type": "number"
- },
- "include_obligations_partner_sponsorship_include_payments_unit": {
- "enum": [
- "U.S. Dollars",
- "percent"
- ],
- "type": "string"
- },
- "include_payment_process": {
- "type": "boolean"
- },
- "include_payment_process_company": {
- "type": "boolean"
- },
- "include_payment_process_company_include_address": {
- "type": "boolean"
- },
- "include_payment_process_company_include_address_city": {
- "type": "string"
- },
- "include_payment_process_company_include_address_country": {
- "type": "string"
- },
- "include_payment_process_company_include_address_state": {
- "type": "string"
- },
- "include_payment_process_company_include_address_street_address": {
- "type": "string"
- },
- "include_payment_process_company_include_address_zipcode": {
- "type": "string"
- },
- "include_payment_process_company_include_email": {
- "type": "boolean"
- },
- "include_payment_process_company_include_email_val": {
- "type": "string"
- },
- "include_payment_process_partner": {
- "type": "boolean"
- },
- "include_payment_process_partner_include_address": {
- "type": "boolean"
- },
- "include_payment_process_partner_include_address_city": {
- "type": "string"
- },
- "include_payment_process_partner_include_address_country": {
- "type": "string"
- },
- "include_payment_process_partner_include_address_state": {
- "type": "string"
- },
- "include_payment_process_partner_include_address_street_address": {
- "type": "string"
- },
- "include_payment_process_partner_include_address_zipcode": {
- "type": "string"
- },
- "include_payment_process_partner_include_email": {
- "type": "boolean"
- },
- "include_payment_process_partner_include_email_val": {
- "type": "string"
- },
- "include_payment_schedule": {
- "type": "boolean"
- },
- "include_payment_schedule_custom": {
- "type": "string"
- },
- "include_payment_schedule_specified_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_payment_schedule_specified_timeframe": {
- "enum": [
- "receipt",
- "date"
- ],
- "type": "string"
- },
- "include_payment_schedule_specified_unit": {
- "enum": [
- "day(s)",
- "week(s)",
- "month(s)",
- "quarter(s)",
- "year(s)"
- ],
- "type": "string"
- },
- "include_payment_schedule_type": {
- "enum": [
- "specified",
- "custom"
- ],
- "type": "string"
- },
- "negotiations_allowed": {
- "description": "When true, the recipient can propose changes to the business terms, even when the agreement-level `negotiations_allowed` is false. This only covers the business terms.",
- "type": "boolean"
- },
- "territory_type": {
- "enum": [
- "worldwide",
- "custom"
- ],
- "type": "string"
- },
- "territory_type_val": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "payment_link_url": {
- "description": "A payment URL shown to the recipient after signing. Requires include_billing_workflow to be true and billing_workflow_type to be \"link\".",
- "type": "string"
- },
- "pilot_attributes": {
- "additionalProperties": false,
- "description": "Override pilot terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "fees_type": {
- "enum": [
- "free",
- "pilot_period_fees"
- ],
- "type": "string"
- },
- "general_cap_amount": {
- "type": "number"
- },
- "general_cap_amount_type": {
- "enum": [
- "preceding",
- "base",
- "period"
- ],
- "type": "string"
- },
- "general_cap_period_currency": {
- "type": "number"
- },
- "general_cap_period_qty": {
- "type": "number"
- },
- "general_cap_preceding_amount": {
- "type": "number"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_dpa": {
- "type": "boolean"
- },
- "include_dpa_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_dpa_location": {
- "type": "string"
- },
- "include_dpa_type": {
- "enum": [
- "description",
- "attachment",
- "standard"
- ],
- "type": "string"
- },
- "include_payment_process": {
- "type": "boolean"
- },
- "include_technical_support": {
- "type": "boolean"
- },
- "payment_process_automatic_frequency": {
- "enum": [
- "monthly",
- "quarterly",
- "annually",
- "once_per_period"
- ],
- "type": "string"
- },
- "payment_process_invoice_days": {
- "type": "number"
- },
- "payment_process_invoice_from": {
- "enum": [
- "receipt",
- "date"
- ],
- "type": "string"
- },
- "payment_process_invoice_timeframe": {
- "enum": [
- "days",
- "weeks",
- "months",
- "quarters",
- "years"
- ],
- "type": "string"
- },
- "payment_process_type": {
- "enum": [
- "automatic",
- "invoice"
- ],
- "type": "string"
- },
- "pilot_period_description": {
- "type": "string"
- },
- "pilot_period_fees_description": {
- "type": "string"
- },
- "product_description": {
- "type": "string"
- },
- "technical_support_description": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "psa_attributes": {
- "additionalProperties": false,
- "description": "Override psa terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "additional_changes": {
- "type": "string"
- },
- "customer_description": {
- "type": "string"
- },
- "effective_date": {
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "effective_date_type": {
- "enum": [
- "signature",
- "date"
- ],
- "type": "string"
- },
- "general_cap_amount": {
- "type": "number"
- },
- "general_cap_amount_type": {
- "enum": [
- "preceding",
- "base",
- "period"
- ],
- "type": "string"
- },
- "general_cap_period_currency": {
- "type": "number"
- },
- "general_cap_period_qty": {
- "type": "number"
- },
- "general_cap_preceding_amount": {
- "type": "number"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_additional_changes": {
- "type": "boolean"
- },
- "include_additional_warranties": {
- "type": "boolean"
- },
- "include_additional_warranties_by_customer": {
- "type": "string"
- },
- "include_additional_warranties_by_provider": {
- "type": "string"
- },
- "include_additional_warranties_include_by_customer": {
- "type": "boolean"
- },
- "include_additional_warranties_include_by_provider": {
- "type": "boolean"
- },
- "include_covered_claims": {
- "type": "boolean"
- },
- "include_covered_claims_customer_claims": {
- "type": "string"
- },
- "include_covered_claims_include_customer_claims": {
- "type": "boolean"
- },
- "include_covered_claims_include_provider_claims": {
- "type": "boolean"
- },
- "include_covered_claims_provider_claims": {
- "type": "string"
- },
- "include_customer_insurance_min": {
- "type": "boolean"
- },
- "include_customer_insurance_min_add_provider_com_gen_liability": {
- "type": "boolean"
- },
- "include_customer_insurance_min_add_provider_cyber_liability": {
- "type": "boolean"
- },
- "include_customer_insurance_min_add_provider_errors_omissions": {
- "type": "boolean"
- },
- "include_customer_insurance_min_auto_liability_aggregate": {
- "type": "number"
- },
- "include_customer_insurance_min_auto_liability_minimum": {
- "type": "number"
- },
- "include_customer_insurance_min_cyber_liability_aggregate": {
- "type": "number"
- },
- "include_customer_insurance_min_cyber_liability_minimum": {
- "type": "number"
- },
- "include_customer_insurance_min_employer_liability_aggregate": {
- "type": "number"
- },
- "include_customer_insurance_min_employer_liability_minimum": {
- "type": "number"
- },
- "include_customer_insurance_min_general_liability_aggregate": {
- "type": "number"
- },
- "include_customer_insurance_min_general_liability_minimum": {
- "type": "number"
- },
- "include_customer_insurance_min_include_add_provider": {
- "type": "boolean"
- },
- "include_customer_insurance_min_include_auto_liability": {
- "type": "boolean"
- },
- "include_customer_insurance_min_include_cyber_liability": {
- "type": "boolean"
- },
- "include_customer_insurance_min_include_employer_liability": {
- "type": "boolean"
- },
- "include_customer_insurance_min_include_general_liability": {
- "type": "boolean"
- },
- "include_customer_insurance_min_include_workers_comp": {
- "type": "boolean"
- },
- "include_customer_policies": {
- "type": "boolean"
- },
- "include_customer_policies_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_customer_policies_location": {
- "type": "string"
- },
- "include_customer_policies_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_dpa": {
- "type": "boolean"
- },
- "include_dpa_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_dpa_location": {
- "type": "string"
- },
- "include_dpa_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_increased_cap_amount": {
- "type": "boolean"
- },
- "include_increased_claims": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_confidentiality": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_confidentiality_negligence": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_privsec": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_privsec_negligence": {
- "type": "boolean"
- },
- "include_increased_claims_include_other": {
- "type": "boolean"
- },
- "include_increased_claims_indemnification_obligation": {
- "type": "boolean"
- },
- "include_increased_claims_negligence": {
- "type": "boolean"
- },
- "include_increased_claims_other": {
- "type": "string"
- },
- "include_provider_insurance_min": {
- "type": "boolean"
- },
- "include_provider_insurance_min_add_customer_com_gen_liability": {
- "type": "boolean"
- },
- "include_provider_insurance_min_add_customer_cyber_liability": {
- "type": "boolean"
- },
- "include_provider_insurance_min_add_customer_errors_omissions": {
- "type": "boolean"
- },
- "include_provider_insurance_min_auto_liability_aggregate": {
- "type": "number"
- },
- "include_provider_insurance_min_auto_liability_minimum": {
- "type": "number"
- },
- "include_provider_insurance_min_cyber_liability_aggregate": {
- "type": "number"
- },
- "include_provider_insurance_min_cyber_liability_minimum": {
- "type": "number"
- },
- "include_provider_insurance_min_employer_liability_aggregate": {
- "type": "number"
- },
- "include_provider_insurance_min_employer_liability_minimum": {
- "type": "number"
- },
- "include_provider_insurance_min_general_liability_aggregate": {
- "type": "number"
- },
- "include_provider_insurance_min_general_liability_minimum": {
- "type": "number"
- },
- "include_provider_insurance_min_include_add_customer": {
- "type": "boolean"
- },
- "include_provider_insurance_min_include_auto_liability": {
- "type": "boolean"
- },
- "include_provider_insurance_min_include_cyber_liability": {
- "type": "boolean"
- },
- "include_provider_insurance_min_include_employer_liability": {
- "type": "boolean"
- },
- "include_provider_insurance_min_include_general_liability": {
- "type": "boolean"
- },
- "include_provider_insurance_min_include_workers_comp": {
- "type": "boolean"
- },
- "include_publicity_rights": {
- "type": "boolean"
- },
- "include_publicity_rights_type": {
- "enum": [
- "public",
- "non-public"
- ],
- "type": "string"
- },
- "include_security_policy": {
- "type": "boolean"
- },
- "include_security_policy_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_security_policy_fedramp_auth": {
- "type": "boolean"
- },
- "include_security_policy_hitrust": {
- "type": "boolean"
- },
- "include_security_policy_include_annual_maintenance": {
- "type": "boolean"
- },
- "include_security_policy_include_other": {
- "type": "boolean"
- },
- "include_security_policy_include_other_val": {
- "type": "string"
- },
- "include_security_policy_iso27001": {
- "type": "boolean"
- },
- "include_security_policy_location": {
- "type": "string"
- },
- "include_security_policy_pci1": {
- "type": "boolean"
- },
- "include_security_policy_pci2": {
- "type": "boolean"
- },
- "include_security_policy_penetration_testing": {
- "type": "boolean"
- },
- "include_security_policy_soc2_type1": {
- "type": "boolean"
- },
- "include_security_policy_soc2_type2": {
- "type": "boolean"
- },
- "include_security_policy_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_unlimited_claims": {
- "type": "boolean"
- },
- "include_unlimited_claims_breach_of_confidentiality": {
- "type": "boolean"
- },
- "include_unlimited_claims_breach_of_confidentiality_negligence": {
- "type": "boolean"
- },
- "include_unlimited_claims_breach_of_privsec": {
- "type": "boolean"
- },
- "include_unlimited_claims_breach_of_privsec_negligence": {
- "type": "boolean"
- },
- "include_unlimited_claims_include_other": {
- "type": "boolean"
- },
- "include_unlimited_claims_indemnification_obligation": {
- "type": "boolean"
- },
- "include_unlimited_claims_negligence": {
- "type": "boolean"
- },
- "include_unlimited_claims_other": {
- "type": "string"
- },
- "increased_cap_amount_currency": {
- "type": "number"
- },
- "increased_cap_amount_period_currency": {
- "type": "number"
- },
- "increased_cap_amount_period_qty": {
- "type": "number"
- },
- "increased_cap_amount_qty": {
- "type": "number"
- },
- "increased_cap_amount_type": {
- "enum": [
- "qty",
- "currency",
- "period"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- "psa_statement_of_work_attributes": {
- "additionalProperties": false,
- "description": "Override psa statement of work terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "additional_changes": {
- "type": "string"
- },
- "cost": {
- "type": "number"
- },
- "description": {
- "type": "string"
- },
- "fee_type": {
- "type": "string"
- },
- "fees_attributes": {
- "additionalProperties": {
- "anyOf": [
- {
- "additionalProperties": false,
- "description": "Fees::Flat (fee_type \"flat\"). A fixed recurring fee, e.g. a platform subscription. Set type to \"Fees::Flat\" or fee_type to \"flat\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "Fixed amount in the order form's fees_currency, charged per fee_period. A plain amount, not cents: 20 means 20.00.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"flat\". Alternative to type.",
- "enum": [
- "flat"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Flat\". Optional when fee_type is set.",
- "enum": [
- "Fees::Flat"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Discount (fee_type \"discount\"). A discount, as a fixed amount or a percentage, applied forever, once, or for a number of months. Set type to \"Fees::Discount\" or fee_type to \"discount\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "Discount size: an amount in fees_currency when discount_type is fixed_amount (a plain amount, not cents: 20 means 20.00), or a percentage (e.g. 10 for 10%) when it is percentage.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "discount_duration_amount": {
- "description": "Number of months the discount applies. Required when discount_duration_type is multiple_months.",
- "type": "number"
- },
- "discount_duration_type": {
- "description": "How long the discount applies. multiple_months also needs discount_duration_amount.",
- "enum": [
- "forever",
- "once",
- "multiple_months"
- ],
- "type": "string"
- },
- "discount_type": {
- "description": "Whether cost is a currency amount or a percentage.",
- "enum": [
- "fixed_amount",
- "percentage"
- ],
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"discount\". Alternative to type.",
- "enum": [
- "discount"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Discount\". Optional when fee_type is set.",
- "enum": [
- "Fees::Discount"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Cost (fee_type \"cost\"). A per-unit fee: price per unit times quantity, e.g. seats. Set type to \"Fees::Cost\" or fee_type to \"cost\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "Price per unit in fees_currency. The row total is quantity x cost. A plain amount, not cents: 20 means 20.00.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"cost\". Alternative to type.",
- "enum": [
- "cost"
- ],
- "type": "string"
- },
- "quantity": {
- "description": "Number of units.",
- "type": "number"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Cost\". Optional when fee_type is set.",
- "enum": [
- "Fees::Cost"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Attachment (fee_type \"attachment\"). A fee described in an uploaded attachment instead of in the table. Set type to \"Fees::Attachment\" or fee_type to \"attachment\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "attachment_id": {
- "description": "ID of an attachment uploaded with upload-attachment.",
- "type": "string"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"attachment\". Alternative to type.",
- "enum": [
- "attachment"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Attachment\". Optional when fee_type is set.",
- "enum": [
- "Fees::Attachment"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Graduated (fee_type \"graduated\"). Tiered pricing, with the price set per tier in graduated_fee_tiers_attributes. Set type to \"Fees::Graduated\" or fee_type to \"graduated\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"graduated\". Alternative to type.",
- "enum": [
- "graduated"
- ],
- "type": "string"
- },
- "graduated_fee_tiers_attributes": {
- "additionalProperties": {
- "additionalProperties": false,
- "properties": {
- "flat_price": {
- "type": "number"
- },
- "price_per_unit": {
- "type": "string"
- },
- "upper_limit": {
- "type": "number"
- }
- },
- "type": "object"
- },
- "description": "Graduated fee tiers. Use string keys such as \"0\", \"1\".",
- "propertyNames": {
- "type": "string"
- },
- "type": "object"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Graduated\". Optional when fee_type is set.",
- "enum": [
- "Fees::Graduated"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Included (fee_type \"included\"). An item included at no charge. Set type to \"Fees::Included\" or fee_type to \"included\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"included\". Alternative to type.",
- "enum": [
- "included"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Included\". Optional when fee_type is set.",
- "enum": [
- "Fees::Included"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Metered (fee_type \"metered\"). Usage-based pricing, billed per unit used. Set type to \"Fees::Metered\" or fee_type to \"metered\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "Price per unit of usage in fees_currency. A plain amount, not cents: 20 means 20.00.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"metered\". Alternative to type.",
- "enum": [
- "metered"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Metered\". Optional when fee_type is set.",
- "enum": [
- "Fees::Metered"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::OneTime (fee_type \"one_time\"). A one-time charge, such as a setup fee. Set type to \"Fees::OneTime\" or fee_type to \"one_time\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "One-time amount in fees_currency, charged once rather than per fee_period. A plain amount, not cents: 20 means 20.00.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"one_time\". Alternative to type.",
- "enum": [
- "one_time"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::OneTime\". Optional when fee_type is set.",
- "enum": [
- "Fees::OneTime"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Text (fee_type \"text\"). A fee term described in free text. Set type to \"Fees::Text\" or fee_type to \"text\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"text\". Alternative to type.",
- "enum": [
- "text"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Text\". Optional when fee_type is set.",
- "enum": [
- "Fees::Text"
- ],
- "type": "string"
- }
- },
- "type": "object"
- }
- ]
- },
- "description": "Fee line items. Use string keys such as \"0\", \"1\". Replaces template fees when provided.",
- "propertyNames": {
- "type": "string"
- },
- "type": "object"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_additional_changes": {
- "type": "boolean"
- },
- "include_customer_obligation": {
- "type": "boolean"
- },
- "include_customer_obligation_val": {
- "type": "string"
- },
- "include_deliverables": {
- "type": "boolean"
- },
- "include_deliverables_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_deliverables_description": {
- "type": "string"
- },
- "include_deliverables_include_acceptance": {
- "type": "boolean"
- },
- "include_deliverables_include_attachment": {
- "type": "boolean"
- },
- "include_deliverables_include_draft_deliverables": {
- "type": "boolean"
- },
- "include_deliverables_rejection_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_deliverables_rejection_unit": {
- "enum": [
- "hours",
- "days",
- "weeks",
- "months"
- ],
- "type": "string"
- },
- "include_deliverables_resubmission_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_deliverables_resubmission_unit": {
- "enum": [
- "hours",
- "days",
- "weeks",
- "months"
- ],
- "type": "string"
- },
- "include_fees_other": {
- "type": "boolean"
- },
- "include_fees_other_val": {
- "type": "string"
- },
- "include_fees_table": {
- "type": "boolean"
- },
- "include_fees_table_total": {
- "type": "boolean"
- },
- "include_fees_travel": {
- "type": "boolean"
- },
- "include_fees_travel_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_fees_travel_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_fees_travel_val": {
- "type": "string"
- },
- "include_third_party_customer": {
- "type": "boolean"
- },
- "include_third_party_include_description": {
- "type": "boolean"
- },
- "include_third_party_include_description_val": {
- "type": "string"
- },
- "include_third_party_materials": {
- "type": "boolean"
- },
- "include_third_party_provider": {
- "type": "boolean"
- },
- "include_time_of_assignment": {
- "type": "boolean"
- },
- "include_time_of_assignment_type": {
- "enum": [
- "created",
- "paid"
- ],
- "type": "string"
- },
- "invoice_period_description": {
- "type": "string"
- },
- "negotiations_allowed": {
- "description": "When true, the recipient can propose changes to the statement of work, even when the agreement-level `negotiations_allowed` is false. This only covers the statement of work.",
- "type": "boolean"
- },
- "payment_period": {
- "type": "number"
- },
- "payment_period_other": {
- "type": "string"
- },
- "payment_period_timeframe": {
- "enum": [
- "receipt",
- "invoice",
- "Customer's receipt of invoice",
- "date of invoice"
- ],
- "type": "string"
- },
- "payment_period_type": {
- "enum": [
- "standard",
- "other"
- ],
- "type": "string"
- },
- "payment_period_unit": {
- "enum": [
- "day(s)",
- "week(s)",
- "month(s)",
- "quarter(s)",
- "year(s)"
- ],
- "type": "string"
- },
- "quantity": {
- "type": "number"
- },
- "services_description": {
- "type": "string"
- },
- "sow_date": {
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "sow_date_type": {
- "enum": [
- "signature",
- "date"
- ],
- "type": "string"
- },
- "sow_term_amount": {
- "type": "number"
- },
- "sow_term_date": {
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "sow_term_type": {
- "enum": [
- "deliverables",
- "period",
- "date"
- ],
- "type": "string"
- },
- "sow_term_unit": {
- "enum": [
- "month(s)",
- "quarter(s)",
- "year(s)"
- ],
- "type": "string"
- },
- "type": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "recipient_email": {
- "format": "email",
- "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
- "type": "string"
- },
- "recipient_name": {
- "type": "string"
- },
- "recipient_notice_email_address": {
- "description": "Email address for legal notices to the recipient.",
- "format": "email",
- "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
- "type": "string"
- },
- "recipient_organization": {
- "type": "string"
- },
- "recipient_role": {
- "description": "PSA only. The recipient's role: `Customer` (the default) or `Provider`. Send it with `sender_role`; the two must be one `Provider` and one `Customer`. Other standard agreement types ignore it.",
- "type": "string"
- },
- "sender_last_to_sign": {
- "description": "When true, your signer signs after the recipient.",
- "type": "boolean"
- },
- "sender_notice_email_address": {
- "description": "Email address for legal notices to the sender.",
- "format": "email",
- "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
- "type": "string"
- },
- "sender_role": {
- "description": "PSA only. Your company's role: `Provider` (the default) or `Customer` when you hire the recipient to provide the services. Send it with `recipient_role`; the two must be one `Provider` and one `Customer`. When reading a PSA, an empty `sender_role` means `Provider`. Other standard agreement types ignore it.",
- "type": "string"
- },
- "software_license_attributes": {
- "additionalProperties": false,
- "description": "Override software license terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "effective_date": {
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "effective_date_type": {
- "enum": [
- "signature",
- "date"
- ],
- "type": "string"
- },
- "general_cap_amount": {
- "type": "number"
- },
- "general_cap_amount_type": {
- "enum": [
- "preceding",
- "base",
- "period"
- ],
- "type": "string"
- },
- "general_cap_period_currency": {
- "type": "number"
- },
- "general_cap_period_qty": {
- "type": "number"
- },
- "general_cap_preceding_amount": {
- "type": "number"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_additional_warranties": {
- "type": "boolean"
- },
- "include_additional_warranties_by_customer": {
- "type": "string"
- },
- "include_additional_warranties_by_provider": {
- "type": "string"
- },
- "include_additional_warranties_include_by_customer": {
- "type": "boolean"
- },
- "include_additional_warranties_include_by_provider": {
- "type": "boolean"
- },
- "include_ai_addendum": {
- "type": "boolean"
- },
- "include_ai_addendum_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_covered_claims": {
- "type": "boolean"
- },
- "include_covered_claims_customer_claims": {
- "type": "string"
- },
- "include_covered_claims_include_customer_claims": {
- "type": "boolean"
- },
- "include_covered_claims_include_provider_claims": {
- "type": "boolean"
- },
- "include_covered_claims_provider_claims": {
- "type": "string"
- },
- "include_dpa": {
- "type": "boolean"
- },
- "include_dpa_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_dpa_location": {
- "type": "string"
- },
- "include_dpa_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_increased_cap_amount": {
- "type": "boolean"
- },
- "include_increased_claims": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_confidentiality": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_confidentiality_negligence": {
- "type": "boolean"
- },
- "include_increased_claims_include_other": {
- "type": "boolean"
- },
- "include_increased_claims_indemnification_obligation": {
- "type": "boolean"
- },
- "include_increased_claims_negligence": {
- "type": "boolean"
- },
- "include_increased_claims_other": {
- "type": "string"
- },
- "include_increased_claims_restrictions": {
- "type": "boolean"
- },
- "include_unlimited_claims": {
- "type": "boolean"
- },
- "include_unlimited_claims_breach_of_confidentiality": {
- "type": "boolean"
- },
- "include_unlimited_claims_breach_of_confidentiality_negligence": {
- "type": "boolean"
- },
- "include_unlimited_claims_include_other": {
- "type": "boolean"
- },
- "include_unlimited_claims_indemnification_obligation": {
- "type": "boolean"
- },
- "include_unlimited_claims_license_or_restrictions": {
- "type": "boolean"
- },
- "include_unlimited_claims_negligence": {
- "type": "boolean"
- },
- "include_unlimited_claims_other": {
- "type": "string"
- },
- "increased_cap_amount_currency": {
- "type": "number"
- },
- "increased_cap_amount_period_currency": {
- "type": "number"
- },
- "increased_cap_amount_period_qty": {
- "type": "number"
- },
- "increased_cap_amount_qty": {
- "type": "number"
- },
- "increased_cap_amount_type": {
- "enum": [
- "qty",
- "currency",
- "period"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- "software_license_order_form_attributes": {
- "additionalProperties": false,
- "description": "Override software license order form terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "additional_changes": {
- "type": "string"
- },
- "deletion_procedure_include_custom": {
- "type": "boolean"
- },
- "deletion_procedure_include_custom_description": {
- "type": "string"
- },
- "deletion_procedure_include_customer_disable": {
- "type": "boolean"
- },
- "deletion_procedure_include_customer_proof": {
- "type": "boolean"
- },
- "deletion_procedure_include_provider_disable": {
- "type": "boolean"
- },
- "fee_custom_unit": {
- "type": "string"
- },
- "fee_period": {
- "enum": [
- "Subscription Period",
- "month",
- "year",
- "Custom unit"
- ],
- "type": "string"
- },
- "fees_attributes": {
- "additionalProperties": {
- "anyOf": [
- {
- "additionalProperties": false,
- "description": "Fees::Flat (fee_type \"flat\"). A fixed recurring fee, e.g. a platform subscription. Set type to \"Fees::Flat\" or fee_type to \"flat\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "Fixed amount in the order form's fees_currency, charged per fee_period. A plain amount, not cents: 20 means 20.00.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"flat\". Alternative to type.",
- "enum": [
- "flat"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Flat\". Optional when fee_type is set.",
- "enum": [
- "Fees::Flat"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Discount (fee_type \"discount\"). A discount, as a fixed amount or a percentage, applied forever, once, or for a number of months. Set type to \"Fees::Discount\" or fee_type to \"discount\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "Discount size: an amount in fees_currency when discount_type is fixed_amount (a plain amount, not cents: 20 means 20.00), or a percentage (e.g. 10 for 10%) when it is percentage.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "discount_duration_amount": {
- "description": "Number of months the discount applies. Required when discount_duration_type is multiple_months.",
- "type": "number"
- },
- "discount_duration_type": {
- "description": "How long the discount applies. multiple_months also needs discount_duration_amount.",
- "enum": [
- "forever",
- "once",
- "multiple_months"
- ],
- "type": "string"
- },
- "discount_type": {
- "description": "Whether cost is a currency amount or a percentage.",
- "enum": [
- "fixed_amount",
- "percentage"
- ],
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"discount\". Alternative to type.",
- "enum": [
- "discount"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Discount\". Optional when fee_type is set.",
- "enum": [
- "Fees::Discount"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Cost (fee_type \"cost\"). A per-unit fee: price per unit times quantity, e.g. seats. Set type to \"Fees::Cost\" or fee_type to \"cost\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "Price per unit in fees_currency. The row total is quantity x cost. A plain amount, not cents: 20 means 20.00.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"cost\". Alternative to type.",
- "enum": [
- "cost"
- ],
- "type": "string"
- },
- "quantity": {
- "description": "Number of units.",
- "type": "number"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Cost\". Optional when fee_type is set.",
- "enum": [
- "Fees::Cost"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Attachment (fee_type \"attachment\"). A fee described in an uploaded attachment instead of in the table. Set type to \"Fees::Attachment\" or fee_type to \"attachment\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "attachment_id": {
- "description": "ID of an attachment uploaded with upload-attachment.",
- "type": "string"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"attachment\". Alternative to type.",
- "enum": [
- "attachment"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Attachment\". Optional when fee_type is set.",
- "enum": [
- "Fees::Attachment"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Graduated (fee_type \"graduated\"). Tiered pricing, with the price set per tier in graduated_fee_tiers_attributes. Set type to \"Fees::Graduated\" or fee_type to \"graduated\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"graduated\". Alternative to type.",
- "enum": [
- "graduated"
- ],
- "type": "string"
- },
- "graduated_fee_tiers_attributes": {
- "additionalProperties": {
- "additionalProperties": false,
- "properties": {
- "flat_price": {
- "type": "number"
- },
- "price_per_unit": {
- "type": "string"
- },
- "upper_limit": {
- "type": "number"
- }
- },
- "type": "object"
- },
- "description": "Graduated fee tiers. Use string keys such as \"0\", \"1\".",
- "propertyNames": {
- "type": "string"
- },
- "type": "object"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Graduated\". Optional when fee_type is set.",
- "enum": [
- "Fees::Graduated"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Included (fee_type \"included\"). An item included at no charge. Set type to \"Fees::Included\" or fee_type to \"included\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"included\". Alternative to type.",
- "enum": [
- "included"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Included\". Optional when fee_type is set.",
- "enum": [
- "Fees::Included"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Metered (fee_type \"metered\"). Usage-based pricing, billed per unit used. Set type to \"Fees::Metered\" or fee_type to \"metered\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "Price per unit of usage in fees_currency. A plain amount, not cents: 20 means 20.00.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"metered\". Alternative to type.",
- "enum": [
- "metered"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Metered\". Optional when fee_type is set.",
- "enum": [
- "Fees::Metered"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::OneTime (fee_type \"one_time\"). A one-time charge, such as a setup fee. Set type to \"Fees::OneTime\" or fee_type to \"one_time\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "One-time amount in fees_currency, charged once rather than per fee_period. A plain amount, not cents: 20 means 20.00.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"one_time\". Alternative to type.",
- "enum": [
- "one_time"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::OneTime\". Optional when fee_type is set.",
- "enum": [
- "Fees::OneTime"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Text (fee_type \"text\"). A fee term described in free text. Set type to \"Fees::Text\" or fee_type to \"text\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"text\". Alternative to type.",
- "enum": [
- "text"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Text\". Optional when fee_type is set.",
- "enum": [
- "Fees::Text"
- ],
- "type": "string"
- }
- },
- "type": "object"
- }
- ]
- },
- "description": "Fee line items. Use string keys such as \"0\", \"1\". Replaces template fees when provided.",
- "propertyNames": {
- "type": "string"
- },
- "type": "object"
- },
- "fees_currency": {
- "enum": [
- "USD",
- "EUR",
- "GBP",
- "CAD",
- "AUD",
- "SGD",
- "ILS",
- "JPY",
- "CHF",
- "HKD"
- ],
- "type": "string"
- },
- "fees_include_fee_increase_upon_renewal": {
- "type": "boolean"
- },
- "fees_include_fee_increase_upon_renewal_fee": {
- "type": "number"
- },
- "fees_include_fee_increase_upon_renewal_type": {
- "enum": [
- "will",
- "may"
- ],
- "type": "string"
- },
- "fees_inclusive_of_taxes": {
- "type": "boolean"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_additional_changes": {
- "type": "boolean"
- },
- "include_license_compliance_verification": {
- "type": "boolean"
- },
- "include_license_compliance_verification_description": {
- "type": "string"
- },
- "include_license_limits": {
- "type": "boolean"
- },
- "include_license_limits_description": {
- "type": "string"
- },
- "include_payment_process_include_billing_email": {
- "type": "boolean"
- },
- "include_pilot_period": {
- "type": "boolean"
- },
- "include_pilot_period_duration_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_pilot_period_duration_type": {
- "enum": [
- "day",
- "week",
- "month"
- ],
- "type": "string"
- },
- "include_pilot_period_include_fees": {
- "type": "boolean"
- },
- "include_pilot_period_include_fees_amount": {
- "type": "number"
- },
- "include_pilot_period_include_modifications": {
- "type": "boolean"
- },
- "include_pilot_period_include_modifications_description": {
- "type": "string"
- },
- "include_services": {
- "type": "boolean"
- },
- "include_services_description": {
- "type": "string"
- },
- "negotiations_allowed": {
- "description": "When true, the recipient can propose changes to the order form, even when the agreement-level `negotiations_allowed` is false. This only covers the order form.",
- "type": "boolean"
- },
- "order_date_date": {
- "type": "string"
- },
- "order_date_type": {
- "enum": [
- "signature",
- "date",
- "other"
- ],
- "type": "string"
- },
- "payment_process_automatic_frequency": {
- "enum": [
- "monthly",
- "quarterly",
- "semiannually",
- "annually"
- ],
- "type": "string"
- },
- "payment_process_type": {
- "enum": [
- "automatic",
- "invoice",
- "custom"
- ],
- "type": "string"
- },
- "payment_process_type_custom_val": {
- "type": "string"
- },
- "payment_process_type_invoice_amount": {
- "type": "number"
- },
- "payment_process_type_invoice_custom_unit": {
- "type": "string"
- },
- "payment_process_type_invoice_duration": {
- "enum": [
- "day",
- "week",
- "month",
- "year",
- "day(s)",
- "week(s)",
- "month(s)",
- "year(s)"
- ],
- "type": "string"
- },
- "payment_process_type_invoice_duration_start": {
- "enum": [
- "Customer's receipt of invoice",
- "date of invoice"
- ],
- "type": "string"
- },
- "payment_process_type_invoice_type": {
- "enum": [
- "monthly",
- "quarterly",
- "semiannually",
- "annually",
- "Custom unit"
- ],
- "type": "string"
- },
- "permitted_uses_include_custom": {
- "type": "boolean"
- },
- "permitted_uses_include_custom_description": {
- "type": "string"
- },
- "permitted_uses_include_customers_affiliates": {
- "type": "boolean"
- },
- "permitted_uses_include_internal_business": {
- "type": "boolean"
- },
- "pilot_period_stripe_product_id": {
- "type": "string"
- },
- "software_description": {
- "type": "string"
- },
- "subscription_auto_renew": {
- "enum": [
- "days",
- "subscription_end"
- ],
- "type": "string"
- },
- "subscription_period": {
- "type": "number"
- },
- "subscription_period_unit": {
- "type": "string"
- },
- "subscription_renewal_notice_days": {
- "type": "number"
- },
- "warranty_period_description_amount": {
- "type": "number"
- },
- "warranty_period_description_duration": {
- "enum": [
- "day",
- "week",
- "month",
- "year"
- ],
- "type": "string"
- },
- "warranty_period_description_duration_start": {
- "enum": [
- "initial delivery of the Software",
- "delivery of the Software and each subsequent Update",
- "the Order Date"
- ],
- "type": "string"
- },
- "warranty_period_type": {
- "enum": [
- "description",
- "none"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- "test_agreement": {
- "description": "When true, marks the agreement as a test. Test agreements do not count against your monthly limit.",
- "type": "boolean"
- }
- },
- "required": [
- "recipient_name",
- "recipient_email"
- ],
- "type": "object"
- },
- "cc_users": {
- "items": {
- "format": "email",
- "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
- "type": "string"
- },
- "type": "array"
- },
- "draft": {
- "description": "When true, the agreement is saved as a draft and not sent to the recipient. Use POST /v1/agreements/{id}/send to send a draft agreement later.",
- "type": "boolean"
- },
- "owner_id": {
- "description": "User id of the agreement owner (sender).",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "signer_id": {
- "description": "User id of the signer from the owner's organization.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "template_id": {
- "description": "UUID of a template from `GET /v1/templates`. Accepts both Common Paper standard templates and uploaded PDF templates (`type` `uploaded_template`).",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- }
- },
- "required": [
- "template_id",
- "owner_id",
- "signer_id",
- "agreement"
- ],
- "type": "object"
- }
-]New value: +[
+ {
+ "additionalProperties": false,
+ "properties": {
+ "agreement": {
+ "additionalProperties": {},
+ "properties": {
+ "amendment_attributes": {
+ "additionalProperties": false,
+ "description": "Override amendment terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "amended_terms_attributes": {
+ "additionalProperties": {
+ "additionalProperties": false,
+ "properties": {
+ "description": {
+ "type": "string"
+ },
+ "term": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "description": "Amended terms. Use string keys such as \"0\", \"1\".",
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+ },
+ "amendment_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "amendment_date_type": {
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "type": "string"
+ },
+ "framework_terms_type": {
+ "type": "string"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "parent_agreement_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "underlying_agreement_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "underlying_agreement_type": {
+ "type": "string"
+ },
+ "underlying_agreement_val": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "baa_attributes": {
+ "additionalProperties": false,
+ "description": "Override baa terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "aggregation_limitations_permitted": {
+ "type": "boolean"
+ },
+ "aggregation_limitations_permitted_val": {
+ "type": "string"
+ },
+ "breach_notification_unit": {
+ "enum": [
+ "hours",
+ "business days",
+ "calendar days"
+ ],
+ "type": "string"
+ },
+ "breach_notification_val": {
+ "type": "number"
+ },
+ "business_associate_relationship_type": {
+ "enum": [
+ "provider",
+ "company"
+ ],
+ "type": "string"
+ },
+ "deidentification_limitations_include_purpose": {
+ "type": "boolean"
+ },
+ "deidentification_limitations_include_requirements": {
+ "type": "boolean"
+ },
+ "deidentification_limitations_permitted": {
+ "type": "boolean"
+ },
+ "deidentification_limitations_purpose_val": {
+ "type": "string"
+ },
+ "deidentification_limitations_requirements_val": {
+ "type": "string"
+ },
+ "designated_record_set_provider_maintains": {
+ "type": "boolean"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_aggregation_limitations": {
+ "type": "boolean"
+ },
+ "include_deidentification_limitations": {
+ "type": "boolean"
+ },
+ "include_limitations": {
+ "type": "boolean"
+ },
+ "include_offshore_limitations": {
+ "type": "boolean"
+ },
+ "include_subcontract_limitations": {
+ "type": "boolean"
+ },
+ "offshore_limitations_permitted": {
+ "type": "boolean"
+ },
+ "offshore_limitations_permitted_val": {
+ "type": "string"
+ },
+ "subcontract_limitations_include_notice": {
+ "type": "boolean"
+ },
+ "subcontract_limitations_include_permission": {
+ "type": "boolean"
+ },
+ "subcontract_limitations_notice_val": {
+ "type": "string"
+ },
+ "subcontract_limitations_permission_val": {
+ "type": "string"
+ },
+ "subcontract_limitations_permitted": {
+ "type": "boolean"
+ },
+ "underlying_agreement_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "underlying_agreement_type": {
+ "enum": [
+ "internal",
+ "external",
+ "none"
+ ],
+ "type": "string"
+ },
+ "underlying_agreement_val": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "billing_email": {
+ "description": "Email of the billing contact. Used when include_billing_info is true.",
+ "format": "email",
+ "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "billing_name": {
+ "description": "Name of the billing contact. Used when include_billing_info is true.",
+ "type": "string"
+ },
+ "billing_workflow_type": {
+ "description": "The type of billing workflow. Use \"link\" to provide a payment_link_url, or \"stripe\" for Stripe-managed billing.",
+ "enum": [
+ "link",
+ "stripe"
+ ],
+ "type": "string"
+ },
+ "chosen_courts_country": {
+ "description": "The country in which disputes will be resolved.",
+ "type": "string"
+ },
+ "chosen_courts_region": {
+ "description": "The state or region in which disputes will be resolved.",
+ "type": "string"
+ },
+ "csa_attributes": {
+ "additionalProperties": false,
+ "description": "Override csa terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "customer_description": {
+ "type": "string"
+ },
+ "effective_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "effective_date_marketplace": {
+ "enum": [
+ "AWS",
+ "GCP",
+ "Azure"
+ ],
+ "type": "string"
+ },
+ "effective_date_type": {
+ "enum": [
+ "signature",
+ "date",
+ "marketplace_acceptance"
+ ],
+ "type": "string"
+ },
+ "general_cap_amount": {
+ "type": "number"
+ },
+ "general_cap_amount_type": {
+ "enum": [
+ "preceding",
+ "base",
+ "period"
+ ],
+ "type": "string"
+ },
+ "general_cap_period_currency": {
+ "type": "number"
+ },
+ "general_cap_period_qty": {
+ "type": "number"
+ },
+ "general_cap_preceding_amount": {
+ "type": "number"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_acceptable_use_policy": {
+ "type": "boolean"
+ },
+ "include_acceptable_use_policy_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_acceptable_use_policy_location": {
+ "type": "string"
+ },
+ "include_acceptable_use_policy_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_additional_warranties": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_by_customer": {
+ "type": "string"
+ },
+ "include_additional_warranties_by_provider": {
+ "type": "string"
+ },
+ "include_additional_warranties_include_by_customer": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_include_by_provider": {
+ "type": "boolean"
+ },
+ "include_ai_addendum": {
+ "type": "boolean"
+ },
+ "include_ai_addendum_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_covered_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_customer_claims": {
+ "type": "string"
+ },
+ "include_covered_claims_include_customer_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_include_provider_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_provider_claims": {
+ "type": "string"
+ },
+ "include_dpa": {
+ "type": "boolean"
+ },
+ "include_dpa_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_dpa_location": {
+ "type": "string"
+ },
+ "include_dpa_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_increased_cap_amount": {
+ "type": "boolean"
+ },
+ "include_increased_claims": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_confidentiality": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_confidentiality_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_privsec": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_privsec_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_other": {
+ "type": "boolean"
+ },
+ "include_increased_claims_indemnification_obligation": {
+ "type": "boolean"
+ },
+ "include_increased_claims_other": {
+ "type": "string"
+ },
+ "include_insurance_minimums": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_add_customer": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_add_customer_com_gen_liability": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_add_customer_cyber_liability": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_add_customer_errors_omissions": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_additional_information": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_additional_information_text": {
+ "type": "string"
+ },
+ "include_insurance_minimums_cyber_liability_aggregate": {
+ "type": "number"
+ },
+ "include_insurance_minimums_cyber_liability_minimum": {
+ "type": "number"
+ },
+ "include_insurance_minimums_employer_liability_aggregate": {
+ "type": "number"
+ },
+ "include_insurance_minimums_employer_liability_minimum": {
+ "type": "number"
+ },
+ "include_insurance_minimums_general_liability_aggregate": {
+ "type": "number"
+ },
+ "include_insurance_minimums_general_liability_minimum": {
+ "type": "number"
+ },
+ "include_insurance_minimums_include_cyber_liability": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_include_employer_liability": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_include_general_liability": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_include_workers_compensation": {
+ "type": "boolean"
+ },
+ "include_publicity_rights": {
+ "type": "boolean"
+ },
+ "include_publicity_rights_type": {
+ "enum": [
+ "public",
+ "non-public"
+ ],
+ "type": "string"
+ },
+ "include_security_policy": {
+ "type": "boolean"
+ },
+ "include_security_policy_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_security_policy_fedramp_auth": {
+ "type": "boolean"
+ },
+ "include_security_policy_hipaa": {
+ "type": "boolean"
+ },
+ "include_security_policy_hitrust": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_annual_maintenance": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_location": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_other": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_reasonable_efforts": {
+ "type": "boolean"
+ },
+ "include_security_policy_iso27001": {
+ "type": "boolean"
+ },
+ "include_security_policy_location": {
+ "type": "string"
+ },
+ "include_security_policy_other": {
+ "type": "string"
+ },
+ "include_security_policy_pci1": {
+ "type": "boolean"
+ },
+ "include_security_policy_pci2": {
+ "type": "boolean"
+ },
+ "include_security_policy_penetration_testing": {
+ "type": "boolean"
+ },
+ "include_security_policy_soc2": {
+ "type": "boolean"
+ },
+ "include_security_policy_soc2_type2": {
+ "type": "boolean"
+ },
+ "include_security_policy_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_supercap": {
+ "description": "CSA 3.0 renamed `include_increased_cap_amount` to `include_supercap`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_increased_cap_amount`. Sending the other spelling returns a 422.",
+ "type": "boolean"
+ },
+ "include_uncapped_claims": {
+ "description": "CSA 3.0 renamed `include_unlimited_claims` to `include_uncapped_claims`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims`. Sending the other spelling returns a 422.",
+ "type": "boolean"
+ },
+ "include_uncapped_claims_breach_of_confidentiality": {
+ "description": "CSA 3.0 renamed `include_unlimited_claims_breach_of_confidentiality` to `include_uncapped_claims_breach_of_confidentiality`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_breach_of_confidentiality`. Sending the other spelling returns a 422.",
+ "type": "boolean"
+ },
+ "include_uncapped_claims_breach_of_confidentiality_negligence": {
+ "description": "CSA 3.0 renamed `include_unlimited_claims_breach_of_confidentiality_negligence` to `include_uncapped_claims_breach_of_confidentiality_negligence`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_breach_of_confidentiality_negligence`. Sending the other spelling returns a 422.",
+ "type": "boolean"
+ },
+ "include_uncapped_claims_breach_of_privsec": {
+ "description": "CSA 3.0 renamed `include_unlimited_claims_breach_of_privsec` to `include_uncapped_claims_breach_of_privsec`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_breach_of_privsec`. Sending the other spelling returns a 422.",
+ "type": "boolean"
+ },
+ "include_uncapped_claims_breach_of_privsec_negligence": {
+ "description": "CSA 3.0 renamed `include_unlimited_claims_breach_of_privsec_negligence` to `include_uncapped_claims_breach_of_privsec_negligence`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_breach_of_privsec_negligence`. Sending the other spelling returns a 422.",
+ "type": "boolean"
+ },
+ "include_uncapped_claims_include_other": {
+ "description": "CSA 3.0 renamed `include_unlimited_claims_include_other` to `include_uncapped_claims_include_other`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_include_other`. Sending the other spelling returns a 422.",
+ "type": "boolean"
+ },
+ "include_uncapped_claims_indemnification_obligation": {
+ "description": "CSA 3.0 renamed `include_unlimited_claims_indemnification_obligation` to `include_uncapped_claims_indemnification_obligation`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_indemnification_obligation`. Sending the other spelling returns a 422.",
+ "type": "boolean"
+ },
+ "include_uncapped_claims_other": {
+ "description": "CSA 3.0 renamed `include_unlimited_claims_other` to `include_uncapped_claims_other`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_other`. Sending the other spelling returns a 422.",
+ "type": "boolean"
+ },
+ "include_unlimited_claims": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_confidentiality": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_confidentiality_negligence": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_privsec": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_privsec_negligence": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_include_other": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_indemnification_obligation": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_other": {
+ "type": "string"
+ },
+ "increased_cap_amount_currency": {
+ "type": "number"
+ },
+ "increased_cap_amount_period_currency": {
+ "type": "number"
+ },
+ "increased_cap_amount_period_qty": {
+ "type": "number"
+ },
+ "increased_cap_amount_qty": {
+ "type": "number"
+ },
+ "increased_cap_amount_type": {
+ "enum": [
+ "qty",
+ "currency",
+ "period"
+ ],
+ "type": "string"
+ },
+ "provider": {
+ "type": "string"
+ },
+ "supercap_currency": {
+ "description": "CSA 3.0 renamed `increased_cap_amount_currency` to `supercap_currency`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `increased_cap_amount_currency`. Sending the other spelling returns a 422.",
+ "type": "number"
+ },
+ "supercap_period_currency": {
+ "description": "CSA 3.0 renamed `increased_cap_amount_period_currency` to `supercap_period_currency`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `increased_cap_amount_period_currency`. Sending the other spelling returns a 422.",
+ "type": "number"
+ },
+ "supercap_period_qty": {
+ "description": "CSA 3.0 renamed `increased_cap_amount_period_qty` to `supercap_period_qty`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `increased_cap_amount_period_qty`. Sending the other spelling returns a 422.",
+ "type": "number"
+ },
+ "supercap_qty": {
+ "description": "CSA 3.0 renamed `increased_cap_amount_qty` to `supercap_qty`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `increased_cap_amount_qty`. Sending the other spelling returns a 422.",
+ "type": "number"
+ },
+ "supercap_type": {
+ "description": "CSA 3.0 renamed `increased_cap_amount_type` to `supercap_type`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `increased_cap_amount_type`. Sending the other spelling returns a 422.",
+ "type": "number"
+ }
+ },
+ "type": "object"
+ },
+ "csa_order_form_attributes": {
+ "additionalProperties": false,
+ "description": "Override csa order form terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "additional_changes": {
+ "type": "string"
+ },
+ "additional_parameters_or_limitations": {
+ "type": "string"
+ },
+ "affiliates_as_users": {
+ "type": "boolean"
+ },
+ "cloud_service_description": {
+ "type": "string"
+ },
+ "consumption_units": {
+ "type": "string"
+ },
+ "fee_amount": {
+ "type": "number"
+ },
+ "fee_custom_unit": {
+ "type": "string"
+ },
+ "fee_period": {
+ "enum": [
+ "Subscription Period",
+ "month",
+ "year",
+ "User",
+ "Custom unit"
+ ],
+ "type": "string"
+ },
+ "fees_attributes": {
+ "additionalProperties": {
+ "anyOf": [
+ {
+ "additionalProperties": false,
+ "description": "Fees::Flat (fee_type \"flat\"). A fixed recurring fee, e.g. a platform subscription. Set type to \"Fees::Flat\" or fee_type to \"flat\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Fixed amount in the order form's fees_currency, charged per fee_period. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"flat\". Alternative to type.",
+ "enum": [
+ "flat"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Flat\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Flat"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Discount (fee_type \"discount\"). A discount, as a fixed amount or a percentage, applied forever, once, or for a number of months. Set type to \"Fees::Discount\" or fee_type to \"discount\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Discount size: an amount in fees_currency when discount_type is fixed_amount (a plain amount, not cents: 20 means 20.00), or a percentage (e.g. 10 for 10%) when it is percentage.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "discount_duration_amount": {
+ "description": "Number of months the discount applies. Required when discount_duration_type is multiple_months.",
+ "type": "number"
+ },
+ "discount_duration_type": {
+ "description": "How long the discount applies. multiple_months also needs discount_duration_amount.",
+ "enum": [
+ "forever",
+ "once",
+ "multiple_months"
+ ],
+ "type": "string"
+ },
+ "discount_type": {
+ "description": "Whether cost is a currency amount or a percentage.",
+ "enum": [
+ "fixed_amount",
+ "percentage"
+ ],
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"discount\". Alternative to type.",
+ "enum": [
+ "discount"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Discount\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Discount"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Cost (fee_type \"cost\"). A per-unit fee: price per unit times quantity, e.g. seats. Set type to \"Fees::Cost\" or fee_type to \"cost\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Price per unit in fees_currency. The row total is quantity x cost. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"cost\". Alternative to type.",
+ "enum": [
+ "cost"
+ ],
+ "type": "string"
+ },
+ "quantity": {
+ "description": "Number of units.",
+ "type": "number"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Cost\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Cost"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Attachment (fee_type \"attachment\"). A fee described in an uploaded attachment instead of in the table. Set type to \"Fees::Attachment\" or fee_type to \"attachment\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "attachment_id": {
+ "description": "ID of an attachment uploaded with upload-attachment.",
+ "type": "string"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"attachment\". Alternative to type.",
+ "enum": [
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Attachment\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Attachment"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Graduated (fee_type \"graduated\"). Tiered pricing, with the price set per tier in graduated_fee_tiers_attributes. Set type to \"Fees::Graduated\" or fee_type to \"graduated\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"graduated\". Alternative to type.",
+ "enum": [
+ "graduated"
+ ],
+ "type": "string"
+ },
+ "graduated_fee_tiers_attributes": {
+ "additionalProperties": {
+ "additionalProperties": false,
+ "properties": {
+ "flat_price": {
+ "type": "number"
+ },
+ "price_per_unit": {
+ "type": "string"
+ },
+ "upper_limit": {
+ "type": "number"
+ }
+ },
+ "type": "object"
+ },
+ "description": "Graduated fee tiers. Use string keys such as \"0\", \"1\".",
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Graduated\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Graduated"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Included (fee_type \"included\"). An item included at no charge. Set type to \"Fees::Included\" or fee_type to \"included\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"included\". Alternative to type.",
+ "enum": [
+ "included"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Included\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Included"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Metered (fee_type \"metered\"). Usage-based pricing, billed per unit used. Set type to \"Fees::Metered\" or fee_type to \"metered\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Price per unit of usage in fees_currency. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"metered\". Alternative to type.",
+ "enum": [
+ "metered"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Metered\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Metered"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::OneTime (fee_type \"one_time\"). A one-time charge, such as a setup fee. Set type to \"Fees::OneTime\" or fee_type to \"one_time\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "One-time amount in fees_currency, charged once rather than per fee_period. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"one_time\". Alternative to type.",
+ "enum": [
+ "one_time"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::OneTime\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::OneTime"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Text (fee_type \"text\"). A fee term described in free text. Set type to \"Fees::Text\" or fee_type to \"text\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"text\". Alternative to type.",
+ "enum": [
+ "text"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Text\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Text"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ }
+ ]
+ },
+ "description": "Fee table rows, keyed by string index (\"0\", \"1\", ...). Replaces the template's fees when provided. Each row sets type or fee_type to pick the fee class. Amounts are in the order form's fees_currency and, for recurring fees, are charged per fee_period.",
+ "examples": [
+ {
+ "0": {
+ "cost": 2000,
+ "description": "Platform subscription",
+ "type": "Fees::Flat"
+ }
+ },
+ {
+ "0": {
+ "cost": 50,
+ "description": "Seats",
+ "fee_type": "cost",
+ "quantity": 10
+ },
+ "1": {
+ "cost": 10,
+ "description": "Launch discount",
+ "discount_duration_amount": 3,
+ "discount_duration_type": "multiple_months",
+ "discount_type": "percentage",
+ "fee_type": "discount"
+ }
+ }
+ ],
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+ },
+ "fees_currency": {
+ "enum": [
+ "USD",
+ "EUR",
+ "GBP",
+ "CAD",
+ "AUD",
+ "SGD",
+ "ILS",
+ "JPY",
+ "CHF",
+ "HKD"
+ ],
+ "type": "string"
+ },
+ "fees_include_fee_increase_upon_renewal": {
+ "type": "boolean"
+ },
+ "fees_include_fee_increase_upon_renewal_fee": {
+ "type": "number"
+ },
+ "fees_include_fee_increase_upon_renewal_type": {
+ "enum": [
+ "will",
+ "may"
+ ],
+ "type": "string"
+ },
+ "fees_inclusive_of_taxes": {
+ "type": "boolean"
+ },
+ "framework_terms_type": {
+ "enum": [
+ "new",
+ "existing",
+ "description"
+ ],
+ "type": "string"
+ },
+ "free_trial_days": {
+ "type": "number"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_additional_changes": {
+ "type": "boolean"
+ },
+ "include_additional_parameters_or_limitations": {
+ "type": "boolean"
+ },
+ "include_consumption": {
+ "type": "boolean"
+ },
+ "include_fees": {
+ "type": "boolean"
+ },
+ "include_fees_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_fees_include_attachment": {
+ "type": "boolean"
+ },
+ "include_fees_other": {
+ "type": "boolean"
+ },
+ "include_fees_other_val": {
+ "type": "string"
+ },
+ "include_fees_table": {
+ "type": "boolean"
+ },
+ "include_fees_table_period": {
+ "enum": [
+ "Subscription Period",
+ "month",
+ "year",
+ "User"
+ ],
+ "type": "string"
+ },
+ "include_free_trial": {
+ "type": "boolean"
+ },
+ "include_max_users": {
+ "type": "boolean"
+ },
+ "include_pilot_period": {
+ "type": "boolean"
+ },
+ "include_pilot_period_duration_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_pilot_period_duration_type": {
+ "enum": [
+ "day",
+ "week",
+ "month"
+ ],
+ "type": "string"
+ },
+ "include_pilot_period_include_fees": {
+ "type": "boolean"
+ },
+ "include_pilot_period_include_fees_amount": {
+ "type": "number"
+ },
+ "include_pilot_period_include_modifications": {
+ "type": "boolean"
+ },
+ "include_pilot_period_include_modifications_description": {
+ "type": "string"
+ },
+ "include_product_support": {
+ "type": "boolean"
+ },
+ "include_product_support_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_product_support_description": {
+ "type": "string"
+ },
+ "include_product_support_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_professional_services": {
+ "type": "boolean"
+ },
+ "include_professional_services_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_professional_services_custom_name": {
+ "type": "string"
+ },
+ "include_professional_services_description": {
+ "type": "string"
+ },
+ "include_professional_services_end_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "include_professional_services_fees_description": {
+ "type": "string"
+ },
+ "include_professional_services_include_end_date": {
+ "type": "boolean"
+ },
+ "include_professional_services_include_fees_description": {
+ "type": "boolean"
+ },
+ "include_professional_services_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_sla": {
+ "type": "boolean"
+ },
+ "include_sla_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_sla_description": {
+ "type": "string"
+ },
+ "include_sla_include_response_time": {
+ "type": "boolean"
+ },
+ "include_sla_include_response_time_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_sla_include_response_time_credit": {
+ "type": "number"
+ },
+ "include_sla_include_response_time_duration": {
+ "enum": [
+ "hour",
+ "day",
+ "week",
+ "month",
+ "hours"
+ ],
+ "type": "string"
+ },
+ "include_sla_include_response_time_support_channel": {
+ "type": "string"
+ },
+ "include_sla_include_target_uptime": {
+ "type": "boolean"
+ },
+ "include_sla_maintenance_notice": {
+ "type": "boolean"
+ },
+ "include_sla_maintenance_window": {
+ "type": "boolean"
+ },
+ "include_sla_maintenance_window_type": {
+ "enum": [
+ "standard",
+ "none"
+ ],
+ "type": "string"
+ },
+ "include_sla_standard_maintenance_notice_qty": {
+ "type": "number"
+ },
+ "include_sla_standard_maintenance_notice_unit": {
+ "enum": [
+ "hour",
+ "day",
+ "week",
+ "month"
+ ],
+ "type": "string"
+ },
+ "include_sla_standard_maintenance_window_end_time": {
+ "type": "string"
+ },
+ "include_sla_standard_maintenance_window_friday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_monday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_saturday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_start_time": {
+ "type": "string"
+ },
+ "include_sla_standard_maintenance_window_sunday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_thursday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_time_zone": {
+ "type": "string"
+ },
+ "include_sla_standard_maintenance_window_tuesday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_wednesday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_target_uptime": {
+ "type": "number"
+ },
+ "include_sla_type": {
+ "enum": [
+ "description",
+ "standard",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_subscription_start_date": {
+ "type": "boolean"
+ },
+ "include_subscription_start_date_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "include_usage_review": {
+ "type": "boolean"
+ },
+ "include_usage_review_val": {
+ "type": "string"
+ },
+ "include_use_limitations": {
+ "type": "boolean"
+ },
+ "include_use_limitations_val": {
+ "type": "string"
+ },
+ "invoice_period": {
+ "enum": [
+ "monthly",
+ "quarterly",
+ "semiannually",
+ "annually",
+ "Custom unit",
+ "Monthly",
+ "Quarterly",
+ "Semiannually",
+ "Annually"
+ ],
+ "type": "string"
+ },
+ "invoice_period_custom_unit": {
+ "type": "string"
+ },
+ "max_consumption": {
+ "type": "number"
+ },
+ "max_users": {
+ "type": "number"
+ },
+ "negotiations_allowed": {
+ "description": "When true, the recipient can propose changes to the order form, even when the agreement-level `negotiations_allowed` is false. This only covers the order form.",
+ "type": "boolean"
+ },
+ "order_date_date": {
+ "type": "string"
+ },
+ "order_date_other": {
+ "type": "string"
+ },
+ "order_date_type": {
+ "enum": [
+ "signature",
+ "date",
+ "other"
+ ],
+ "type": "string"
+ },
+ "payment_period": {
+ "type": "number"
+ },
+ "payment_period_timeframe": {
+ "enum": [
+ "Customer's receipt of invoice",
+ "date of invoice"
+ ],
+ "type": "string"
+ },
+ "payment_period_unit": {
+ "enum": [
+ "day(s)",
+ "week(s)",
+ "month(s)",
+ "marketplace_acceptance"
+ ],
+ "type": "string"
+ },
+ "payment_process_automatic_frequency": {
+ "enum": [
+ "monthly",
+ "quarterly",
+ "semiannually",
+ "annually"
+ ],
+ "type": "string"
+ },
+ "payment_process_type": {
+ "enum": [
+ "automatic",
+ "invoice",
+ "custom",
+ "marketplace_acceptance"
+ ],
+ "type": "string"
+ },
+ "payment_process_type_custom_val": {
+ "type": "string"
+ },
+ "payment_process_type_invoice_amount": {
+ "type": "number"
+ },
+ "payment_process_type_invoice_custom_unit": {
+ "type": "string"
+ },
+ "payment_process_type_invoice_duration": {
+ "enum": [
+ "day",
+ "week",
+ "month",
+ "year",
+ "day(s)",
+ "week(s)",
+ "month(s)",
+ "year(s)"
+ ],
+ "type": "string"
+ },
+ "payment_process_type_invoice_duration_start": {
+ "enum": [
+ "Customer's receipt of invoice",
+ "date of invoice"
+ ],
+ "type": "string"
+ },
+ "payment_process_type_invoice_type": {
+ "enum": [
+ "monthly",
+ "quarterly",
+ "semiannually",
+ "annually",
+ "Custom unit"
+ ],
+ "type": "string"
+ },
+ "pilot_period_stripe_product_id": {
+ "type": "string"
+ },
+ "service_credits_attributes": {
+ "additionalProperties": {
+ "additionalProperties": false,
+ "properties": {
+ "credit": {
+ "type": "number"
+ },
+ "max": {
+ "type": "number"
+ },
+ "min": {
+ "type": "number"
+ }
+ },
+ "type": "object"
+ },
+ "description": "Service credits. Use string keys such as \"0\", \"1\".",
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+ },
+ "subscription_auto_renew": {
+ "enum": [
+ "days",
+ "subscription_end"
+ ],
+ "type": "string"
+ },
+ "subscription_period": {
+ "type": "number"
+ },
+ "subscription_period_unit": {
+ "type": "string"
+ },
+ "subscription_renewal_notice_days": {
+ "type": "number"
+ },
+ "subscription_start_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "subscription_start_date_type": {
+ "enum": [
+ "effective_date",
+ "date"
+ ],
+ "type": "string"
+ },
+ "underlying_agreement_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "use_limitations_attributes": {
+ "additionalProperties": {
+ "additionalProperties": false,
+ "properties": {
+ "amount": {
+ "type": "number"
+ },
+ "limitation_type": {
+ "type": "string"
+ },
+ "unit": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "description": "Use limitations. Use string keys such as \"0\", \"1\".",
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+ }
+ },
+ "type": "object"
+ },
+ "custom_field_values": {
+ "description": "Values for a custom template's fields, keyed by the field keys defined in the template's YAML definition. Only used when template_id is a custom template. Template defaults fill any fields you omit; a required field with no default and no submitted value returns a 400 naming the field. Values are validated against the field's input type: select and radio values must be one of the field's options, multiselect values are an array of selections each of which must be one of the field's options, number and currency values must be numeric, date values must be YYYY-MM-DD, and email values must be valid addresses. An invalid value returns a 400 naming the field."
+ },
+ "design_partner_attributes": {
+ "additionalProperties": false,
+ "description": "Override design partner terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "customer_description": {
+ "type": "string"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_fees": {
+ "type": "boolean"
+ },
+ "include_fees_amount": {
+ "type": "number"
+ },
+ "include_fees_description": {
+ "type": "string"
+ },
+ "include_fees_pay_by_amount": {
+ "type": "string"
+ },
+ "include_fees_type": {
+ "enum": [
+ "default_language",
+ "description"
+ ],
+ "type": "string"
+ },
+ "include_fees_unit": {
+ "enum": [
+ "month",
+ "quarter",
+ "year",
+ "Term"
+ ],
+ "type": "string"
+ },
+ "include_program_appear_as_customer_private": {
+ "type": "boolean"
+ },
+ "include_program_appear_as_customer_public": {
+ "type": "boolean"
+ },
+ "include_program_case_study": {
+ "type": "boolean"
+ },
+ "include_program_develop_functionality": {
+ "type": "boolean"
+ },
+ "include_program_develop_functionality_val": {
+ "type": "string"
+ },
+ "include_program_discount": {
+ "type": "boolean"
+ },
+ "include_program_discount_amount": {
+ "type": "number"
+ },
+ "include_program_discount_unit": {
+ "enum": [
+ "U.S. Dollars",
+ "percent"
+ ],
+ "type": "string"
+ },
+ "include_program_participation_feedback": {
+ "type": "boolean"
+ },
+ "include_program_participation_feedback_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_program_participation_feedback_unit": {
+ "enum": [
+ "month",
+ "quarter",
+ "year",
+ "Term"
+ ],
+ "type": "string"
+ },
+ "include_program_partner_other": {
+ "type": "boolean"
+ },
+ "include_program_partner_other_val": {
+ "type": "string"
+ },
+ "include_program_provider_other": {
+ "type": "boolean"
+ },
+ "include_program_provider_other_val": {
+ "type": "string"
+ },
+ "include_program_reference": {
+ "type": "boolean"
+ },
+ "product_description": {
+ "type": "string"
+ },
+ "term_amount": {
+ "type": "number"
+ },
+ "term_unit": {
+ "enum": [
+ "day(s)",
+ "week(s)",
+ "month(s)",
+ "quarter(s)",
+ "year(s)"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "district_or_county": {
+ "description": "The district or county for dispute resolution.",
+ "type": "string"
+ },
+ "dpa_attributes": {
+ "additionalProperties": false,
+ "description": "Override dpa terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "approved_subprocessor_type": {
+ "description": "`internal` lists approved subprocessors in the agreement (`subprocessors_attributes`); `external` points to a list published elsewhere.",
+ "enum": [
+ "internal",
+ "external"
+ ],
+ "type": "string"
+ },
+ "cloud_service_product_name": {
+ "type": "string"
+ },
+ "competent_supervisory_authority": {
+ "type": "string"
+ },
+ "customer_description": {
+ "type": "string"
+ },
+ "data_exporter_address_city": {
+ "type": "string"
+ },
+ "data_exporter_address_country": {
+ "type": "string"
+ },
+ "data_exporter_address_state": {
+ "type": "string"
+ },
+ "data_exporter_address_street_address": {
+ "type": "string"
+ },
+ "data_exporter_address_zipcode": {
+ "type": "string"
+ },
+ "data_exporter_contact_details": {
+ "type": "string"
+ },
+ "data_exporter_contact_name": {
+ "type": "string"
+ },
+ "data_exporter_contact_position": {
+ "type": "string"
+ },
+ "data_exporter_role": {
+ "description": "Role of the data exporter. Overwritten to `Controller` when the agreement is created from a template.",
+ "enum": [
+ "Controller",
+ "Processor"
+ ],
+ "type": "string"
+ },
+ "data_importer_address": {
+ "type": "string"
+ },
+ "data_importer_address_city": {
+ "type": "string"
+ },
+ "data_importer_address_country": {
+ "type": "string"
+ },
+ "data_importer_address_state": {
+ "type": "string"
+ },
+ "data_importer_address_street_address": {
+ "type": "string"
+ },
+ "data_importer_address_zipcode": {
+ "type": "string"
+ },
+ "data_importer_contact_details": {
+ "type": "string"
+ },
+ "data_importer_contact_name": {
+ "type": "string"
+ },
+ "data_importer_contact_position": {
+ "type": "string"
+ },
+ "duration_of_processing": {
+ "type": "string"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_covered_claim": {
+ "type": "boolean"
+ },
+ "include_covered_claim_external_val": {
+ "type": "string"
+ },
+ "include_covered_claim_internal_val": {
+ "type": "string"
+ },
+ "include_covered_claim_type": {
+ "description": "Which covered-claim text applies: `internal` uses `include_covered_claim_internal_val`, `external` uses `include_covered_claim_external_val`. Required when `include_covered_claim` is true.",
+ "enum": [
+ "internal",
+ "external"
+ ],
+ "type": "string"
+ },
+ "include_data_subjects_custom": {
+ "type": "boolean"
+ },
+ "include_data_subjects_custom_val": {
+ "type": "string"
+ },
+ "include_data_subjects_employees": {
+ "type": "boolean"
+ },
+ "include_data_subjects_end_users": {
+ "type": "boolean"
+ },
+ "include_external_subprocessor_location": {
+ "type": "string"
+ },
+ "include_frequency_of_transfer_continuous": {
+ "type": "boolean"
+ },
+ "include_frequency_of_transfer_custom": {
+ "type": "boolean"
+ },
+ "include_frequency_of_transfer_custom_val": {
+ "type": "string"
+ },
+ "include_governing_country_eu": {
+ "type": "boolean"
+ },
+ "include_governing_country_eu_val": {
+ "type": "string"
+ },
+ "include_governing_country_uk": {
+ "type": "boolean"
+ },
+ "include_governing_country_uk_val": {
+ "type": "string"
+ },
+ "include_governing_law": {
+ "type": "boolean"
+ },
+ "include_governing_law_country": {
+ "type": "string"
+ },
+ "include_governing_law_state": {
+ "type": "string"
+ },
+ "include_increased_claim_amount": {
+ "description": "Legacy field. Stored but not shown on the DPA; use the `include_liability_cap*` fields instead.",
+ "type": "boolean"
+ },
+ "include_increased_claim_amount_currency": {
+ "description": "Legacy field. Stored but not shown on the DPA; use the `include_liability_cap*` fields instead."
+ },
+ "include_increased_claim_amount_qty": {
+ "description": "Legacy field. Stored but not shown on the DPA; use the `include_liability_cap*` fields instead."
+ },
+ "include_increased_claim_amount_type": {
+ "description": "Legacy field. Stored but not shown on the DPA; use the `include_liability_cap*` fields instead.",
+ "type": "string"
+ },
+ "include_liability_cap": {
+ "type": "boolean"
+ },
+ "include_liability_cap_amount_constant_external": {
+ "type": "string"
+ },
+ "include_liability_cap_amount_constant_internal": {
+ "type": "string"
+ },
+ "include_liability_cap_amount_currency_external": {
+ "description": "Currency amount. Numbers and numeric strings (commas allowed) are both accepted."
+ },
+ "include_liability_cap_amount_currency_internal": {
+ "description": "Currency amount. Numbers and numeric strings (commas allowed) are both accepted."
+ },
+ "include_liability_cap_csa_type": {
+ "description": "Which liability cap values apply: the `_internal` or `_external` amount fields. Required when `include_liability_cap` is true.",
+ "enum": [
+ "internal",
+ "external"
+ ],
+ "type": "string"
+ },
+ "include_personal_data_biographic_info": {
+ "type": "boolean"
+ },
+ "include_personal_data_contact_info": {
+ "type": "boolean"
+ },
+ "include_personal_data_custom": {
+ "type": "boolean"
+ },
+ "include_personal_data_custom_val": {
+ "type": "string"
+ },
+ "include_personal_data_employment_info": {
+ "type": "boolean"
+ },
+ "include_personal_data_financial_info": {
+ "type": "boolean"
+ },
+ "include_personal_data_location": {
+ "type": "boolean"
+ },
+ "include_personal_data_name": {
+ "type": "boolean"
+ },
+ "include_personal_data_transactional_info": {
+ "type": "boolean"
+ },
+ "include_personal_data_user_activity_info": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_custom": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_custom_val": {
+ "type": "string"
+ },
+ "include_processing_purpose_erasing": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_holding": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_protecting": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_receiving": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_returning": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_sharing": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_updating": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_using": {
+ "type": "boolean"
+ },
+ "include_provider_security_contact_address": {
+ "type": "boolean"
+ },
+ "include_provider_security_contact_address_city": {
+ "type": "string"
+ },
+ "include_provider_security_contact_address_country": {
+ "type": "string"
+ },
+ "include_provider_security_contact_address_state": {
+ "type": "string"
+ },
+ "include_provider_security_contact_address_street_address": {
+ "type": "string"
+ },
+ "include_provider_security_contact_address_zipcode": {
+ "type": "string"
+ },
+ "include_provider_security_contact_email": {
+ "type": "boolean"
+ },
+ "include_provider_security_contact_email_val": {
+ "format": "email",
+ "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "include_security_measures_accountability": {
+ "type": "boolean"
+ },
+ "include_security_measures_accountability_val": {
+ "type": "string"
+ },
+ "include_security_measures_certification_or_assurance": {
+ "type": "boolean"
+ },
+ "include_security_measures_certification_or_assurance_val": {
+ "type": "string"
+ },
+ "include_security_measures_confidentiality_integrity": {
+ "type": "boolean"
+ },
+ "include_security_measures_confidentiality_integrity_val": {
+ "type": "string"
+ },
+ "include_security_measures_data_at_rest": {
+ "type": "boolean"
+ },
+ "include_security_measures_data_at_rest_val": {
+ "type": "string"
+ },
+ "include_security_measures_data_minimization": {
+ "type": "boolean"
+ },
+ "include_security_measures_data_minimization_val": {
+ "type": "string"
+ },
+ "include_security_measures_data_quality": {
+ "type": "boolean"
+ },
+ "include_security_measures_data_quality_val": {
+ "type": "string"
+ },
+ "include_security_measures_data_retention": {
+ "type": "boolean"
+ },
+ "include_security_measures_data_retention_val": {
+ "type": "string"
+ },
+ "include_security_measures_data_transmission": {
+ "type": "boolean"
+ },
+ "include_security_measures_data_transmission_val": {
+ "type": "string"
+ },
+ "include_security_measures_event_logging": {
+ "type": "boolean"
+ },
+ "include_security_measures_event_logging_val": {
+ "type": "string"
+ },
+ "include_security_measures_identity_auth": {
+ "type": "boolean"
+ },
+ "include_security_measures_identity_auth_val": {
+ "type": "string"
+ },
+ "include_security_measures_it_security_governance": {
+ "type": "boolean"
+ },
+ "include_security_measures_it_security_governance_val": {
+ "type": "string"
+ },
+ "include_security_measures_physical_security": {
+ "type": "boolean"
+ },
+ "include_security_measures_physical_security_val": {
+ "type": "string"
+ },
+ "include_security_measures_portability_and_erasure": {
+ "type": "boolean"
+ },
+ "include_security_measures_portability_and_erasure_val": {
+ "type": "string"
+ },
+ "include_security_measures_pseudonym_encryption": {
+ "type": "boolean"
+ },
+ "include_security_measures_pseudonym_encryption_val": {
+ "type": "string"
+ },
+ "include_security_measures_restore_data_access": {
+ "type": "boolean"
+ },
+ "include_security_measures_restore_data_access_val": {
+ "type": "string"
+ },
+ "include_security_measures_security_policy": {
+ "type": "boolean"
+ },
+ "include_security_measures_system_configuration": {
+ "type": "boolean"
+ },
+ "include_security_measures_system_configuration_val": {
+ "type": "string"
+ },
+ "include_security_measures_testing_assessment": {
+ "type": "boolean"
+ },
+ "include_security_measures_testing_assessment_val": {
+ "type": "string"
+ },
+ "include_security_policy": {
+ "type": "boolean"
+ },
+ "include_security_policy_fedramp_auth": {
+ "type": "boolean"
+ },
+ "include_security_policy_hipaa": {
+ "type": "boolean"
+ },
+ "include_security_policy_hitrust": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_other": {
+ "type": "boolean"
+ },
+ "include_security_policy_iso27001": {
+ "type": "boolean"
+ },
+ "include_security_policy_other": {
+ "type": "string"
+ },
+ "include_security_policy_pci1": {
+ "type": "boolean"
+ },
+ "include_security_policy_pci2": {
+ "type": "boolean"
+ },
+ "include_security_policy_penetration_testing": {
+ "type": "boolean"
+ },
+ "include_security_policy_soc2": {
+ "type": "boolean"
+ },
+ "include_security_policy_soc2_type2": {
+ "type": "boolean"
+ },
+ "include_sensitive_data_restrictions_custom": {
+ "type": "boolean"
+ },
+ "include_sensitive_data_restrictions_custom_val": {
+ "type": "string"
+ },
+ "include_sensitive_data_restrictions_security_policy": {
+ "type": "boolean"
+ },
+ "include_service_provider_relationship": {
+ "type": "boolean"
+ },
+ "include_special_category_data": {
+ "type": "boolean"
+ },
+ "provider": {
+ "type": "string"
+ },
+ "security_policy_available_at": {
+ "type": "string"
+ },
+ "security_policy_type": {
+ "description": "Where the Security Policy is defined. For `external`, set `security_policy_available_at`.",
+ "enum": [
+ "defined in agreement",
+ "provider service",
+ "external"
+ ],
+ "type": "string"
+ },
+ "subprocessors_attributes": {
+ "additionalProperties": {
+ "additionalProperties": false,
+ "properties": {
+ "_destroy": {
+ "description": "Set to true with `id` to remove that subprocessor.",
+ "type": "boolean"
+ },
+ "country": {
+ "type": "string"
+ },
+ "id": {
+ "description": "ID of an existing subprocessor to update or remove. Omit to add a new subprocessor.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "processing_task": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "description": "Subprocessors, keyed by string index such as \"0\", \"1\". On create these are added to the template's subprocessors. On a draft update, an entry without `id` adds a new subprocessor; pass `id` to change one and `id` with `_destroy: true` to remove one.",
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+ },
+ "underlying_agreement_id": {
+ "description": "ID of the CSA this DPA supplements when `underlying_agreement_type` is `internal`.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "underlying_agreement_type": {
+ "description": "`internal` links a CSA in Common Paper (`underlying_agreement_id`, required); `external` describes another agreement in `underlying_agreement_val` (required). Defaults to `internal` when omitted on create.",
+ "enum": [
+ "internal",
+ "external"
+ ],
+ "type": "string"
+ },
+ "underlying_agreement_val": {
+ "description": "Description of the agreement this DPA supplements. Required when `underlying_agreement_type` is `external`.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "framework_terms_description": {
+ "description": "Custom framework terms description. Only used when framework_terms_type is \"description\".",
+ "type": "string"
+ },
+ "framework_terms_type": {
+ "description": "How framework terms are specified. Use \"new\" for standard terms or \"description\" to provide a custom framework_terms_description.",
+ "enum": [
+ "new",
+ "description"
+ ],
+ "type": "string"
+ },
+ "governing_law_country": {
+ "description": "The country whose laws govern the agreement.",
+ "type": "string"
+ },
+ "governing_law_region": {
+ "description": "The state or region whose laws govern the agreement.",
+ "type": "string"
+ },
+ "include_automated_payment_reminders": {
+ "description": "When true, automatically sends payment reminder emails.",
+ "type": "boolean"
+ },
+ "include_billing_info": {
+ "description": "When true, billing contact information (billing_name, billing_email) is included.",
+ "type": "boolean"
+ },
+ "include_billing_workflow": {
+ "description": "When true, enables a billing workflow after signing.",
+ "type": "boolean"
+ },
+ "include_expiration_date": {
+ "description": "Expiration date in YYYY-MM-DD format. Use when include_expiration_type is \"date\".",
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "include_expiration_days": {
+ "description": "Number of days until the agreement expires. Use when include_expiration_type is \"days\".",
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_expiration_type": {
+ "description": "How to set expiration: \"none\" (default), \"days\" (use include_expiration_days), or \"date\" (use include_expiration_date).",
+ "enum": [
+ "none",
+ "days",
+ "date"
+ ],
+ "type": "string"
+ },
+ "include_terms": {
+ "description": "When true, the standard terms are included with the agreement.",
+ "type": "boolean"
+ },
+ "loi_attributes": {
+ "additionalProperties": false,
+ "description": "Override loi terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "confidentiality_custom": {
+ "type": "string"
+ },
+ "confidentiality_mutual_include_loi": {
+ "type": "boolean"
+ },
+ "confidentiality_nda_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "confidentiality_nda_description": {
+ "type": "string"
+ },
+ "confidentiality_nda_include_loi": {
+ "type": "boolean"
+ },
+ "confidentiality_nda_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "confidentiality_type": {
+ "enum": [
+ "mutual",
+ "nda",
+ "provider",
+ "custom"
+ ],
+ "type": "string"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_custom_details": {
+ "type": "boolean"
+ },
+ "include_custom_details_val": {
+ "type": "string"
+ },
+ "include_fees": {
+ "type": "boolean"
+ },
+ "include_fees_amount": {
+ "type": "number"
+ },
+ "include_fees_amount_duration": {
+ "enum": [
+ "month",
+ "year",
+ "quarter"
+ ],
+ "type": "string"
+ },
+ "include_fees_include_amount": {
+ "type": "boolean"
+ },
+ "include_fees_include_other": {
+ "type": "boolean"
+ },
+ "include_fees_other": {
+ "type": "string"
+ },
+ "include_functionality": {
+ "type": "boolean"
+ },
+ "include_functionality_val": {
+ "type": "string"
+ },
+ "include_launch_date": {
+ "type": "boolean"
+ },
+ "include_launch_date_custom": {
+ "type": "string"
+ },
+ "include_launch_date_date": {
+ "format": "date-time",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$",
+ "type": "string"
+ },
+ "include_launch_date_type": {
+ "enum": [
+ "date",
+ "custom"
+ ],
+ "type": "string"
+ },
+ "product_name": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "manual_send": {
+ "description": "When true, the agreement is marked as manually sent outside the platform.",
+ "type": "boolean"
+ },
+ "message": {
+ "type": "string"
+ },
+ "negotiations_allowed": {
+ "description": "When true, the recipient can propose changes to the legal terms. For agreement types without separate business terms, that covers every term. CSA order forms, PSA statements of work, partnership business terms and software license order forms have their own `negotiations_allowed` flag.",
+ "type": "boolean"
+ },
+ "partnership_attributes": {
+ "additionalProperties": false,
+ "description": "Override partnership terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "effective_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "effective_date_type": {
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "type": "string"
+ },
+ "general_cap_amount_currency_val": {
+ "type": "number"
+ },
+ "general_cap_amount_either_currency": {
+ "type": "number"
+ },
+ "general_cap_amount_either_multiple": {
+ "type": "number"
+ },
+ "general_cap_amount_multiple_val": {
+ "type": "number"
+ },
+ "general_cap_amount_type": {
+ "enum": [
+ "multiple",
+ "currency",
+ "either",
+ "base"
+ ],
+ "type": "string"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_additional_warranties": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_include_company": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_include_company_val": {
+ "type": "string"
+ },
+ "include_additional_warranties_include_partner": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_include_partner_val": {
+ "type": "string"
+ },
+ "include_brand_guidelines": {
+ "type": "boolean"
+ },
+ "include_brand_guidelines_include_company": {
+ "type": "boolean"
+ },
+ "include_brand_guidelines_include_company_val": {
+ "type": "string"
+ },
+ "include_brand_guidelines_include_partner": {
+ "type": "boolean"
+ },
+ "include_brand_guidelines_include_partner_val": {
+ "type": "string"
+ },
+ "include_covered_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_company_claims": {
+ "type": "string"
+ },
+ "include_covered_claims_include_company_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_include_partner_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_partner_claims": {
+ "type": "string"
+ },
+ "include_dpa": {
+ "type": "boolean"
+ },
+ "include_dpa_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_dpa_location": {
+ "type": "string"
+ },
+ "include_dpa_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_increased_cap_amount": {
+ "type": "boolean"
+ },
+ "include_increased_cap_amount_currency": {
+ "type": "number"
+ },
+ "include_increased_cap_amount_either_currency": {
+ "type": "number"
+ },
+ "include_increased_cap_amount_either_multiple": {
+ "type": "string"
+ },
+ "include_increased_cap_amount_multiple": {
+ "type": "string"
+ },
+ "include_increased_cap_amount_type": {
+ "enum": [
+ "multiple",
+ "currency",
+ "either"
+ ],
+ "type": "string"
+ },
+ "include_increased_claims": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_confidentiality": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_confidentiality_misconduct": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_covered_claims": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_misconduct": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_other": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_other_val": {
+ "type": "string"
+ },
+ "include_unlimited_claims": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_confidentiality": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_confidentiality_misconduct": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_covered_claims": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_misconduct": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_other": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_other_val": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "partnership_business_terms_attributes": {
+ "additionalProperties": false,
+ "description": "Override partnership business terms terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "end_date_after_effective_date_amount": {
+ "type": "number"
+ },
+ "end_date_after_effective_date_unit": {
+ "enum": [
+ "month(s)",
+ "quarter(s)",
+ "year(s)"
+ ],
+ "type": "string"
+ },
+ "end_date_date": {
+ "type": "string"
+ },
+ "end_date_type": {
+ "enum": [
+ "date",
+ "effective date"
+ ],
+ "type": "string"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_obligations_company_brand": {
+ "type": "boolean"
+ },
+ "include_obligations_company_promotion": {
+ "type": "boolean"
+ },
+ "include_obligations_company_promotion_include_activities": {
+ "type": "boolean"
+ },
+ "include_obligations_company_promotion_include_activities_val": {
+ "type": "string"
+ },
+ "include_obligations_company_promotion_include_materials": {
+ "type": "boolean"
+ },
+ "include_obligations_company_promotion_include_materials_val": {
+ "type": "string"
+ },
+ "include_obligations_company_referral": {
+ "type": "boolean"
+ },
+ "include_obligations_company_referral_include_criteria": {
+ "type": "boolean"
+ },
+ "include_obligations_company_referral_include_criteria_val": {
+ "type": "string"
+ },
+ "include_obligations_company_referral_include_pay_sch": {
+ "type": "boolean"
+ },
+ "include_obligations_company_referral_include_pay_sch_amount": {
+ "type": "number"
+ },
+ "include_obligations_company_referral_include_pay_sch_custom": {
+ "type": "string"
+ },
+ "include_obligations_company_referral_include_pay_sch_unit": {
+ "enum": [
+ "U.S. Dollars",
+ "percent"
+ ],
+ "type": "string"
+ },
+ "include_obligations_company_sponsorship": {
+ "type": "boolean"
+ },
+ "include_obligations_company_sponsorship_include_benefits": {
+ "type": "boolean"
+ },
+ "include_obligations_company_sponsorship_include_benefits_val": {
+ "type": "string"
+ },
+ "include_obligations_company_sponsorship_include_payments": {
+ "type": "boolean"
+ },
+ "include_obligations_company_sponsorship_include_payments_amount": {
+ "type": "number"
+ },
+ "include_obligations_company_sponsorship_include_payments_unit": {
+ "enum": [
+ "U.S. Dollars",
+ "percent"
+ ],
+ "type": "string"
+ },
+ "include_obligations_partner_brand": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_promotion": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_promotion_include_activities": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_promotion_include_activities_val": {
+ "type": "string"
+ },
+ "include_obligations_partner_promotion_include_materials": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_promotion_include_materials_val": {
+ "type": "string"
+ },
+ "include_obligations_partner_referral": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_referral_include_criteria": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_referral_include_criteria_val": {
+ "type": "string"
+ },
+ "include_obligations_partner_referral_include_pay_sch": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_referral_include_pay_sch_amount": {
+ "type": "number"
+ },
+ "include_obligations_partner_referral_include_pay_sch_custom": {
+ "type": "string"
+ },
+ "include_obligations_partner_referral_include_pay_sch_unit": {
+ "enum": [
+ "U.S. Dollars",
+ "percent"
+ ],
+ "type": "string"
+ },
+ "include_obligations_partner_sponsorship": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_sponsorship_include_benefits": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_sponsorship_include_benefits_val": {
+ "type": "string"
+ },
+ "include_obligations_partner_sponsorship_include_payments": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_sponsorship_include_payments_amount": {
+ "type": "number"
+ },
+ "include_obligations_partner_sponsorship_include_payments_unit": {
+ "enum": [
+ "U.S. Dollars",
+ "percent"
+ ],
+ "type": "string"
+ },
+ "include_payment_process": {
+ "type": "boolean"
+ },
+ "include_payment_process_company": {
+ "type": "boolean"
+ },
+ "include_payment_process_company_include_address": {
+ "type": "boolean"
+ },
+ "include_payment_process_company_include_address_city": {
+ "type": "string"
+ },
+ "include_payment_process_company_include_address_country": {
+ "type": "string"
+ },
+ "include_payment_process_company_include_address_state": {
+ "type": "string"
+ },
+ "include_payment_process_company_include_address_street_address": {
+ "type": "string"
+ },
+ "include_payment_process_company_include_address_zipcode": {
+ "type": "string"
+ },
+ "include_payment_process_company_include_email": {
+ "type": "boolean"
+ },
+ "include_payment_process_company_include_email_val": {
+ "type": "string"
+ },
+ "include_payment_process_partner": {
+ "type": "boolean"
+ },
+ "include_payment_process_partner_include_address": {
+ "type": "boolean"
+ },
+ "include_payment_process_partner_include_address_city": {
+ "type": "string"
+ },
+ "include_payment_process_partner_include_address_country": {
+ "type": "string"
+ },
+ "include_payment_process_partner_include_address_state": {
+ "type": "string"
+ },
+ "include_payment_process_partner_include_address_street_address": {
+ "type": "string"
+ },
+ "include_payment_process_partner_include_address_zipcode": {
+ "type": "string"
+ },
+ "include_payment_process_partner_include_email": {
+ "type": "boolean"
+ },
+ "include_payment_process_partner_include_email_val": {
+ "type": "string"
+ },
+ "include_payment_schedule": {
+ "type": "boolean"
+ },
+ "include_payment_schedule_custom": {
+ "type": "string"
+ },
+ "include_payment_schedule_specified_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_payment_schedule_specified_timeframe": {
+ "enum": [
+ "receipt",
+ "date"
+ ],
+ "type": "string"
+ },
+ "include_payment_schedule_specified_unit": {
+ "enum": [
+ "day(s)",
+ "week(s)",
+ "month(s)",
+ "quarter(s)",
+ "year(s)"
+ ],
+ "type": "string"
+ },
+ "include_payment_schedule_type": {
+ "enum": [
+ "specified",
+ "custom"
+ ],
+ "type": "string"
+ },
+ "negotiations_allowed": {
+ "description": "When true, the recipient can propose changes to the business terms, even when the agreement-level `negotiations_allowed` is false. This only covers the business terms.",
+ "type": "boolean"
+ },
+ "territory_type": {
+ "enum": [
+ "worldwide",
+ "custom"
+ ],
+ "type": "string"
+ },
+ "territory_type_val": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "payment_link_url": {
+ "description": "A payment URL shown to the recipient after signing. Requires include_billing_workflow to be true and billing_workflow_type to be \"link\".",
+ "type": "string"
+ },
+ "pilot_attributes": {
+ "additionalProperties": false,
+ "description": "Override pilot terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "fees_type": {
+ "enum": [
+ "free",
+ "pilot_period_fees"
+ ],
+ "type": "string"
+ },
+ "general_cap_amount": {
+ "type": "number"
+ },
+ "general_cap_amount_type": {
+ "enum": [
+ "preceding",
+ "base",
+ "period"
+ ],
+ "type": "string"
+ },
+ "general_cap_period_currency": {
+ "type": "number"
+ },
+ "general_cap_period_qty": {
+ "type": "number"
+ },
+ "general_cap_preceding_amount": {
+ "type": "number"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_dpa": {
+ "type": "boolean"
+ },
+ "include_dpa_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_dpa_location": {
+ "type": "string"
+ },
+ "include_dpa_type": {
+ "enum": [
+ "description",
+ "attachment",
+ "standard"
+ ],
+ "type": "string"
+ },
+ "include_payment_process": {
+ "type": "boolean"
+ },
+ "include_technical_support": {
+ "type": "boolean"
+ },
+ "payment_process_automatic_frequency": {
+ "enum": [
+ "monthly",
+ "quarterly",
+ "annually",
+ "once_per_period"
+ ],
+ "type": "string"
+ },
+ "payment_process_invoice_days": {
+ "type": "number"
+ },
+ "payment_process_invoice_from": {
+ "enum": [
+ "receipt",
+ "date"
+ ],
+ "type": "string"
+ },
+ "payment_process_invoice_timeframe": {
+ "enum": [
+ "days",
+ "weeks",
+ "months",
+ "quarters",
+ "years"
+ ],
+ "type": "string"
+ },
+ "payment_process_type": {
+ "enum": [
+ "automatic",
+ "invoice"
+ ],
+ "type": "string"
+ },
+ "pilot_period_description": {
+ "type": "string"
+ },
+ "pilot_period_fees_description": {
+ "type": "string"
+ },
+ "product_description": {
+ "type": "string"
+ },
+ "technical_support_description": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "psa_attributes": {
+ "additionalProperties": false,
+ "description": "Override psa terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "additional_changes": {
+ "type": "string"
+ },
+ "customer_description": {
+ "type": "string"
+ },
+ "effective_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "effective_date_type": {
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "type": "string"
+ },
+ "general_cap_amount": {
+ "type": "number"
+ },
+ "general_cap_amount_type": {
+ "enum": [
+ "preceding",
+ "base",
+ "period"
+ ],
+ "type": "string"
+ },
+ "general_cap_period_currency": {
+ "type": "number"
+ },
+ "general_cap_period_qty": {
+ "type": "number"
+ },
+ "general_cap_preceding_amount": {
+ "type": "number"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_additional_changes": {
+ "type": "boolean"
+ },
+ "include_additional_warranties": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_by_customer": {
+ "type": "string"
+ },
+ "include_additional_warranties_by_provider": {
+ "type": "string"
+ },
+ "include_additional_warranties_include_by_customer": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_include_by_provider": {
+ "type": "boolean"
+ },
+ "include_covered_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_customer_claims": {
+ "type": "string"
+ },
+ "include_covered_claims_include_customer_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_include_provider_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_provider_claims": {
+ "type": "string"
+ },
+ "include_customer_insurance_min": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_add_provider_com_gen_liability": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_add_provider_cyber_liability": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_add_provider_errors_omissions": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_auto_liability_aggregate": {
+ "type": "number"
+ },
+ "include_customer_insurance_min_auto_liability_minimum": {
+ "type": "number"
+ },
+ "include_customer_insurance_min_cyber_liability_aggregate": {
+ "type": "number"
+ },
+ "include_customer_insurance_min_cyber_liability_minimum": {
+ "type": "number"
+ },
+ "include_customer_insurance_min_employer_liability_aggregate": {
+ "type": "number"
+ },
+ "include_customer_insurance_min_employer_liability_minimum": {
+ "type": "number"
+ },
+ "include_customer_insurance_min_general_liability_aggregate": {
+ "type": "number"
+ },
+ "include_customer_insurance_min_general_liability_minimum": {
+ "type": "number"
+ },
+ "include_customer_insurance_min_include_add_provider": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_include_auto_liability": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_include_cyber_liability": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_include_employer_liability": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_include_general_liability": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_include_workers_comp": {
+ "type": "boolean"
+ },
+ "include_customer_policies": {
+ "type": "boolean"
+ },
+ "include_customer_policies_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_customer_policies_location": {
+ "type": "string"
+ },
+ "include_customer_policies_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_dpa": {
+ "type": "boolean"
+ },
+ "include_dpa_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_dpa_location": {
+ "type": "string"
+ },
+ "include_dpa_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_increased_cap_amount": {
+ "type": "boolean"
+ },
+ "include_increased_claims": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_confidentiality": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_confidentiality_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_privsec": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_privsec_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_other": {
+ "type": "boolean"
+ },
+ "include_increased_claims_indemnification_obligation": {
+ "type": "boolean"
+ },
+ "include_increased_claims_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_other": {
+ "type": "string"
+ },
+ "include_provider_insurance_min": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_add_customer_com_gen_liability": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_add_customer_cyber_liability": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_add_customer_errors_omissions": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_auto_liability_aggregate": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_auto_liability_minimum": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_cyber_liability_aggregate": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_cyber_liability_minimum": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_employer_liability_aggregate": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_employer_liability_minimum": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_general_liability_aggregate": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_general_liability_minimum": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_include_add_customer": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_include_auto_liability": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_include_cyber_liability": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_include_employer_liability": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_include_general_liability": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_include_workers_comp": {
+ "type": "boolean"
+ },
+ "include_publicity_rights": {
+ "type": "boolean"
+ },
+ "include_publicity_rights_type": {
+ "enum": [
+ "public",
+ "non-public"
+ ],
+ "type": "string"
+ },
+ "include_security_policy": {
+ "type": "boolean"
+ },
+ "include_security_policy_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_security_policy_fedramp_auth": {
+ "type": "boolean"
+ },
+ "include_security_policy_hitrust": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_annual_maintenance": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_other": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_other_val": {
+ "type": "string"
+ },
+ "include_security_policy_iso27001": {
+ "type": "boolean"
+ },
+ "include_security_policy_location": {
+ "type": "string"
+ },
+ "include_security_policy_pci1": {
+ "type": "boolean"
+ },
+ "include_security_policy_pci2": {
+ "type": "boolean"
+ },
+ "include_security_policy_penetration_testing": {
+ "type": "boolean"
+ },
+ "include_security_policy_soc2_type1": {
+ "type": "boolean"
+ },
+ "include_security_policy_soc2_type2": {
+ "type": "boolean"
+ },
+ "include_security_policy_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_unlimited_claims": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_confidentiality": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_confidentiality_negligence": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_privsec": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_privsec_negligence": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_include_other": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_indemnification_obligation": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_negligence": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_other": {
+ "type": "string"
+ },
+ "increased_cap_amount_currency": {
+ "type": "number"
+ },
+ "increased_cap_amount_period_currency": {
+ "type": "number"
+ },
+ "increased_cap_amount_period_qty": {
+ "type": "number"
+ },
+ "increased_cap_amount_qty": {
+ "type": "number"
+ },
+ "increased_cap_amount_type": {
+ "enum": [
+ "qty",
+ "currency",
+ "period"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "psa_statement_of_work_attributes": {
+ "additionalProperties": false,
+ "description": "Override psa statement of work terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "additional_changes": {
+ "type": "string"
+ },
+ "cost": {
+ "type": "number"
+ },
+ "description": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "fees_attributes": {
+ "additionalProperties": {
+ "anyOf": [
+ {
+ "additionalProperties": false,
+ "description": "Fees::Flat (fee_type \"flat\"). A fixed recurring fee, e.g. a platform subscription. Set type to \"Fees::Flat\" or fee_type to \"flat\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Fixed amount in the order form's fees_currency, charged per fee_period. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"flat\". Alternative to type.",
+ "enum": [
+ "flat"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Flat\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Flat"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Discount (fee_type \"discount\"). A discount, as a fixed amount or a percentage, applied forever, once, or for a number of months. Set type to \"Fees::Discount\" or fee_type to \"discount\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Discount size: an amount in fees_currency when discount_type is fixed_amount (a plain amount, not cents: 20 means 20.00), or a percentage (e.g. 10 for 10%) when it is percentage.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "discount_duration_amount": {
+ "description": "Number of months the discount applies. Required when discount_duration_type is multiple_months.",
+ "type": "number"
+ },
+ "discount_duration_type": {
+ "description": "How long the discount applies. multiple_months also needs discount_duration_amount.",
+ "enum": [
+ "forever",
+ "once",
+ "multiple_months"
+ ],
+ "type": "string"
+ },
+ "discount_type": {
+ "description": "Whether cost is a currency amount or a percentage.",
+ "enum": [
+ "fixed_amount",
+ "percentage"
+ ],
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"discount\". Alternative to type.",
+ "enum": [
+ "discount"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Discount\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Discount"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Cost (fee_type \"cost\"). A per-unit fee: price per unit times quantity, e.g. seats. Set type to \"Fees::Cost\" or fee_type to \"cost\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Price per unit in fees_currency. The row total is quantity x cost. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"cost\". Alternative to type.",
+ "enum": [
+ "cost"
+ ],
+ "type": "string"
+ },
+ "quantity": {
+ "description": "Number of units.",
+ "type": "number"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Cost\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Cost"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Attachment (fee_type \"attachment\"). A fee described in an uploaded attachment instead of in the table. Set type to \"Fees::Attachment\" or fee_type to \"attachment\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "attachment_id": {
+ "description": "ID of an attachment uploaded with upload-attachment.",
+ "type": "string"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"attachment\". Alternative to type.",
+ "enum": [
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Attachment\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Attachment"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Graduated (fee_type \"graduated\"). Tiered pricing, with the price set per tier in graduated_fee_tiers_attributes. Set type to \"Fees::Graduated\" or fee_type to \"graduated\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"graduated\". Alternative to type.",
+ "enum": [
+ "graduated"
+ ],
+ "type": "string"
+ },
+ "graduated_fee_tiers_attributes": {
+ "additionalProperties": {
+ "additionalProperties": false,
+ "properties": {
+ "flat_price": {
+ "type": "number"
+ },
+ "price_per_unit": {
+ "type": "string"
+ },
+ "upper_limit": {
+ "type": "number"
+ }
+ },
+ "type": "object"
+ },
+ "description": "Graduated fee tiers. Use string keys such as \"0\", \"1\".",
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Graduated\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Graduated"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Included (fee_type \"included\"). An item included at no charge. Set type to \"Fees::Included\" or fee_type to \"included\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"included\". Alternative to type.",
+ "enum": [
+ "included"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Included\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Included"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Metered (fee_type \"metered\"). Usage-based pricing, billed per unit used. Set type to \"Fees::Metered\" or fee_type to \"metered\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Price per unit of usage in fees_currency. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"metered\". Alternative to type.",
+ "enum": [
+ "metered"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Metered\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Metered"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::OneTime (fee_type \"one_time\"). A one-time charge, such as a setup fee. Set type to \"Fees::OneTime\" or fee_type to \"one_time\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "One-time amount in fees_currency, charged once rather than per fee_period. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"one_time\". Alternative to type.",
+ "enum": [
+ "one_time"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::OneTime\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::OneTime"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Text (fee_type \"text\"). A fee term described in free text. Set type to \"Fees::Text\" or fee_type to \"text\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"text\". Alternative to type.",
+ "enum": [
+ "text"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Text\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Text"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ }
+ ]
+ },
+ "description": "Fee line items. Use string keys such as \"0\", \"1\". Replaces template fees when provided.",
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_additional_changes": {
+ "type": "boolean"
+ },
+ "include_customer_obligation": {
+ "type": "boolean"
+ },
+ "include_customer_obligation_val": {
+ "type": "string"
+ },
+ "include_deliverables": {
+ "type": "boolean"
+ },
+ "include_deliverables_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_deliverables_description": {
+ "type": "string"
+ },
+ "include_deliverables_include_acceptance": {
+ "type": "boolean"
+ },
+ "include_deliverables_include_attachment": {
+ "type": "boolean"
+ },
+ "include_deliverables_include_draft_deliverables": {
+ "type": "boolean"
+ },
+ "include_deliverables_rejection_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_deliverables_rejection_unit": {
+ "enum": [
+ "hours",
+ "days",
+ "weeks",
+ "months"
+ ],
+ "type": "string"
+ },
+ "include_deliverables_resubmission_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_deliverables_resubmission_unit": {
+ "enum": [
+ "hours",
+ "days",
+ "weeks",
+ "months"
+ ],
+ "type": "string"
+ },
+ "include_fees_other": {
+ "type": "boolean"
+ },
+ "include_fees_other_val": {
+ "type": "string"
+ },
+ "include_fees_table": {
+ "type": "boolean"
+ },
+ "include_fees_table_total": {
+ "type": "boolean"
+ },
+ "include_fees_travel": {
+ "type": "boolean"
+ },
+ "include_fees_travel_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_fees_travel_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_fees_travel_val": {
+ "type": "string"
+ },
+ "include_third_party_customer": {
+ "type": "boolean"
+ },
+ "include_third_party_include_description": {
+ "type": "boolean"
+ },
+ "include_third_party_include_description_val": {
+ "type": "string"
+ },
+ "include_third_party_materials": {
+ "type": "boolean"
+ },
+ "include_third_party_provider": {
+ "type": "boolean"
+ },
+ "include_time_of_assignment": {
+ "type": "boolean"
+ },
+ "include_time_of_assignment_type": {
+ "enum": [
+ "created",
+ "paid"
+ ],
+ "type": "string"
+ },
+ "invoice_period_description": {
+ "type": "string"
+ },
+ "negotiations_allowed": {
+ "description": "When true, the recipient can propose changes to the statement of work, even when the agreement-level `negotiations_allowed` is false. This only covers the statement of work.",
+ "type": "boolean"
+ },
+ "payment_period": {
+ "type": "number"
+ },
+ "payment_period_other": {
+ "type": "string"
+ },
+ "payment_period_timeframe": {
+ "enum": [
+ "receipt",
+ "invoice",
+ "Customer's receipt of invoice",
+ "date of invoice"
+ ],
+ "type": "string"
+ },
+ "payment_period_type": {
+ "enum": [
+ "standard",
+ "other"
+ ],
+ "type": "string"
+ },
+ "payment_period_unit": {
+ "enum": [
+ "day(s)",
+ "week(s)",
+ "month(s)",
+ "quarter(s)",
+ "year(s)"
+ ],
+ "type": "string"
+ },
+ "quantity": {
+ "type": "number"
+ },
+ "services_description": {
+ "type": "string"
+ },
+ "sow_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "sow_date_type": {
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "type": "string"
+ },
+ "sow_term_amount": {
+ "type": "number"
+ },
+ "sow_term_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "sow_term_type": {
+ "enum": [
+ "deliverables",
+ "period",
+ "date"
+ ],
+ "type": "string"
+ },
+ "sow_term_unit": {
+ "enum": [
+ "month(s)",
+ "quarter(s)",
+ "year(s)"
+ ],
+ "type": "string"
+ },
+ "type": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "recipient_email": {
+ "format": "email",
+ "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "recipient_name": {
+ "type": "string"
+ },
+ "recipient_notice_email_address": {
+ "description": "Email address for legal notices to the recipient.",
+ "format": "email",
+ "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "recipient_organization": {
+ "type": "string"
+ },
+ "recipient_role": {
+ "description": "PSA only. The recipient's role: `Customer` (the default) or `Provider`. Send it with `sender_role`; the two must be one `Provider` and one `Customer`. Other standard agreement types ignore it.",
+ "type": "string"
+ },
+ "sender_last_to_sign": {
+ "description": "When true, your signer signs after the recipient.",
+ "type": "boolean"
+ },
+ "sender_notice_email_address": {
+ "description": "Email address for legal notices to the sender.",
+ "format": "email",
+ "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "sender_role": {
+ "description": "PSA only. Your company's role: `Provider` (the default) or `Customer` when you hire the recipient to provide the services. Send it with `recipient_role`; the two must be one `Provider` and one `Customer`. When reading a PSA, an empty `sender_role` means `Provider`. Other standard agreement types ignore it.",
+ "type": "string"
+ },
+ "software_license_attributes": {
+ "additionalProperties": false,
+ "description": "Override software license terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "effective_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "effective_date_type": {
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "type": "string"
+ },
+ "general_cap_amount": {
+ "type": "number"
+ },
+ "general_cap_amount_type": {
+ "enum": [
+ "preceding",
+ "base",
+ "period"
+ ],
+ "type": "string"
+ },
+ "general_cap_period_currency": {
+ "type": "number"
+ },
+ "general_cap_period_qty": {
+ "type": "number"
+ },
+ "general_cap_preceding_amount": {
+ "type": "number"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_additional_warranties": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_by_customer": {
+ "type": "string"
+ },
+ "include_additional_warranties_by_provider": {
+ "type": "string"
+ },
+ "include_additional_warranties_include_by_customer": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_include_by_provider": {
+ "type": "boolean"
+ },
+ "include_ai_addendum": {
+ "type": "boolean"
+ },
+ "include_ai_addendum_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_covered_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_customer_claims": {
+ "type": "string"
+ },
+ "include_covered_claims_include_customer_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_include_provider_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_provider_claims": {
+ "type": "string"
+ },
+ "include_dpa": {
+ "type": "boolean"
+ },
+ "include_dpa_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_dpa_location": {
+ "type": "string"
+ },
+ "include_dpa_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_increased_cap_amount": {
+ "type": "boolean"
+ },
+ "include_increased_claims": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_confidentiality": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_confidentiality_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_other": {
+ "type": "boolean"
+ },
+ "include_increased_claims_indemnification_obligation": {
+ "type": "boolean"
+ },
+ "include_increased_claims_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_other": {
+ "type": "string"
+ },
+ "include_increased_claims_restrictions": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_confidentiality": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_confidentiality_negligence": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_include_other": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_indemnification_obligation": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_license_or_restrictions": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_negligence": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_other": {
+ "type": "string"
+ },
+ "increased_cap_amount_currency": {
+ "type": "number"
+ },
+ "increased_cap_amount_period_currency": {
+ "type": "number"
+ },
+ "increased_cap_amount_period_qty": {
+ "type": "number"
+ },
+ "increased_cap_amount_qty": {
+ "type": "number"
+ },
+ "increased_cap_amount_type": {
+ "enum": [
+ "qty",
+ "currency",
+ "period"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "software_license_order_form_attributes": {
+ "additionalProperties": false,
+ "description": "Override software license order form terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "additional_changes": {
+ "type": "string"
+ },
+ "deletion_procedure_include_custom": {
+ "type": "boolean"
+ },
+ "deletion_procedure_include_custom_description": {
+ "type": "string"
+ },
+ "deletion_procedure_include_customer_disable": {
+ "type": "boolean"
+ },
+ "deletion_procedure_include_customer_proof": {
+ "type": "boolean"
+ },
+ "deletion_procedure_include_provider_disable": {
+ "type": "boolean"
+ },
+ "fee_custom_unit": {
+ "type": "string"
+ },
+ "fee_period": {
+ "enum": [
+ "Subscription Period",
+ "month",
+ "year",
+ "Custom unit"
+ ],
+ "type": "string"
+ },
+ "fees_attributes": {
+ "additionalProperties": {
+ "anyOf": [
+ {
+ "additionalProperties": false,
+ "description": "Fees::Flat (fee_type \"flat\"). A fixed recurring fee, e.g. a platform subscription. Set type to \"Fees::Flat\" or fee_type to \"flat\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Fixed amount in the order form's fees_currency, charged per fee_period. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"flat\". Alternative to type.",
+ "enum": [
+ "flat"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Flat\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Flat"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Discount (fee_type \"discount\"). A discount, as a fixed amount or a percentage, applied forever, once, or for a number of months. Set type to \"Fees::Discount\" or fee_type to \"discount\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Discount size: an amount in fees_currency when discount_type is fixed_amount (a plain amount, not cents: 20 means 20.00), or a percentage (e.g. 10 for 10%) when it is percentage.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "discount_duration_amount": {
+ "description": "Number of months the discount applies. Required when discount_duration_type is multiple_months.",
+ "type": "number"
+ },
+ "discount_duration_type": {
+ "description": "How long the discount applies. multiple_months also needs discount_duration_amount.",
+ "enum": [
+ "forever",
+ "once",
+ "multiple_months"
+ ],
+ "type": "string"
+ },
+ "discount_type": {
+ "description": "Whether cost is a currency amount or a percentage.",
+ "enum": [
+ "fixed_amount",
+ "percentage"
+ ],
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"discount\". Alternative to type.",
+ "enum": [
+ "discount"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Discount\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Discount"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Cost (fee_type \"cost\"). A per-unit fee: price per unit times quantity, e.g. seats. Set type to \"Fees::Cost\" or fee_type to \"cost\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Price per unit in fees_currency. The row total is quantity x cost. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"cost\". Alternative to type.",
+ "enum": [
+ "cost"
+ ],
+ "type": "string"
+ },
+ "quantity": {
+ "description": "Number of units.",
+ "type": "number"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Cost\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Cost"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Attachment (fee_type \"attachment\"). A fee described in an uploaded attachment instead of in the table. Set type to \"Fees::Attachment\" or fee_type to \"attachment\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "attachment_id": {
+ "description": "ID of an attachment uploaded with upload-attachment.",
+ "type": "string"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"attachment\". Alternative to type.",
+ "enum": [
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Attachment\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Attachment"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Graduated (fee_type \"graduated\"). Tiered pricing, with the price set per tier in graduated_fee_tiers_attributes. Set type to \"Fees::Graduated\" or fee_type to \"graduated\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"graduated\". Alternative to type.",
+ "enum": [
+ "graduated"
+ ],
+ "type": "string"
+ },
+ "graduated_fee_tiers_attributes": {
+ "additionalProperties": {
+ "additionalProperties": false,
+ "properties": {
+ "flat_price": {
+ "type": "number"
+ },
+ "price_per_unit": {
+ "type": "string"
+ },
+ "upper_limit": {
+ "type": "number"
+ }
+ },
+ "type": "object"
+ },
+ "description": "Graduated fee tiers. Use string keys such as \"0\", \"1\".",
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Graduated\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Graduated"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Included (fee_type \"included\"). An item included at no charge. Set type to \"Fees::Included\" or fee_type to \"included\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"included\". Alternative to type.",
+ "enum": [
+ "included"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Included\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Included"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Metered (fee_type \"metered\"). Usage-based pricing, billed per unit used. Set type to \"Fees::Metered\" or fee_type to \"metered\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Price per unit of usage in fees_currency. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"metered\". Alternative to type.",
+ "enum": [
+ "metered"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Metered\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Metered"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::OneTime (fee_type \"one_time\"). A one-time charge, such as a setup fee. Set type to \"Fees::OneTime\" or fee_type to \"one_time\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "One-time amount in fees_currency, charged once rather than per fee_period. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"one_time\". Alternative to type.",
+ "enum": [
+ "one_time"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::OneTime\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::OneTime"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Text (fee_type \"text\"). A fee term described in free text. Set type to \"Fees::Text\" or fee_type to \"text\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"text\". Alternative to type.",
+ "enum": [
+ "text"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Text\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Text"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ }
+ ]
+ },
+ "description": "Fee line items. Use string keys such as \"0\", \"1\". Replaces template fees when provided.",
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+ },
+ "fees_currency": {
+ "enum": [
+ "USD",
+ "EUR",
+ "GBP",
+ "CAD",
+ "AUD",
+ "SGD",
+ "ILS",
+ "JPY",
+ "CHF",
+ "HKD"
+ ],
+ "type": "string"
+ },
+ "fees_include_fee_increase_upon_renewal": {
+ "type": "boolean"
+ },
+ "fees_include_fee_increase_upon_renewal_fee": {
+ "type": "number"
+ },
+ "fees_include_fee_increase_upon_renewal_type": {
+ "enum": [
+ "will",
+ "may"
+ ],
+ "type": "string"
+ },
+ "fees_inclusive_of_taxes": {
+ "type": "boolean"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_additional_changes": {
+ "type": "boolean"
+ },
+ "include_license_compliance_verification": {
+ "type": "boolean"
+ },
+ "include_license_compliance_verification_description": {
+ "type": "string"
+ },
+ "include_license_limits": {
+ "type": "boolean"
+ },
+ "include_license_limits_description": {
+ "type": "string"
+ },
+ "include_payment_process_include_billing_email": {
+ "type": "boolean"
+ },
+ "include_pilot_period": {
+ "type": "boolean"
+ },
+ "include_pilot_period_duration_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_pilot_period_duration_type": {
+ "enum": [
+ "day",
+ "week",
+ "month"
+ ],
+ "type": "string"
+ },
+ "include_pilot_period_include_fees": {
+ "type": "boolean"
+ },
+ "include_pilot_period_include_fees_amount": {
+ "type": "number"
+ },
+ "include_pilot_period_include_modifications": {
+ "type": "boolean"
+ },
+ "include_pilot_period_include_modifications_description": {
+ "type": "string"
+ },
+ "include_services": {
+ "type": "boolean"
+ },
+ "include_services_description": {
+ "type": "string"
+ },
+ "negotiations_allowed": {
+ "description": "When true, the recipient can propose changes to the order form, even when the agreement-level `negotiations_allowed` is false. This only covers the order form.",
+ "type": "boolean"
+ },
+ "order_date_date": {
+ "type": "string"
+ },
+ "order_date_type": {
+ "enum": [
+ "signature",
+ "date",
+ "other"
+ ],
+ "type": "string"
+ },
+ "payment_process_automatic_frequency": {
+ "enum": [
+ "monthly",
+ "quarterly",
+ "semiannually",
+ "annually"
+ ],
+ "type": "string"
+ },
+ "payment_process_type": {
+ "enum": [
+ "automatic",
+ "invoice",
+ "custom"
+ ],
+ "type": "string"
+ },
+ "payment_process_type_custom_val": {
+ "type": "string"
+ },
+ "payment_process_type_invoice_amount": {
+ "type": "number"
+ },
+ "payment_process_type_invoice_custom_unit": {
+ "type": "string"
+ },
+ "payment_process_type_invoice_duration": {
+ "enum": [
+ "day",
+ "week",
+ "month",
+ "year",
+ "day(s)",
+ "week(s)",
+ "month(s)",
+ "year(s)"
+ ],
+ "type": "string"
+ },
+ "payment_process_type_invoice_duration_start": {
+ "enum": [
+ "Customer's receipt of invoice",
+ "date of invoice"
+ ],
+ "type": "string"
+ },
+ "payment_process_type_invoice_type": {
+ "enum": [
+ "monthly",
+ "quarterly",
+ "semiannually",
+ "annually",
+ "Custom unit"
+ ],
+ "type": "string"
+ },
+ "permitted_uses_include_custom": {
+ "type": "boolean"
+ },
+ "permitted_uses_include_custom_description": {
+ "type": "string"
+ },
+ "permitted_uses_include_customers_affiliates": {
+ "type": "boolean"
+ },
+ "permitted_uses_include_internal_business": {
+ "type": "boolean"
+ },
+ "pilot_period_stripe_product_id": {
+ "type": "string"
+ },
+ "software_description": {
+ "type": "string"
+ },
+ "subscription_auto_renew": {
+ "enum": [
+ "days",
+ "subscription_end"
+ ],
+ "type": "string"
+ },
+ "subscription_period": {
+ "type": "number"
+ },
+ "subscription_period_unit": {
+ "type": "string"
+ },
+ "subscription_renewal_notice_days": {
+ "type": "number"
+ },
+ "warranty_period_description_amount": {
+ "type": "number"
+ },
+ "warranty_period_description_duration": {
+ "enum": [
+ "day",
+ "week",
+ "month",
+ "year"
+ ],
+ "type": "string"
+ },
+ "warranty_period_description_duration_start": {
+ "enum": [
+ "initial delivery of the Software",
+ "delivery of the Software and each subsequent Update",
+ "the Order Date"
+ ],
+ "type": "string"
+ },
+ "warranty_period_type": {
+ "enum": [
+ "description",
+ "none"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "test_agreement": {
+ "description": "When true, marks the agreement as a test. Test agreements do not count against your monthly limit.",
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "recipient_name",
+ "recipient_email"
+ ],
+ "type": "object"
+ },
+ "cc_users": {
+ "items": {
+ "format": "email",
+ "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "draft": {
+ "description": "When true, the agreement is saved as a draft and not sent to the recipient. Use POST /v1/agreements/{id}/send to send a draft agreement later.",
+ "type": "boolean"
+ },
+ "owner_email": {
+ "description": "Email address of the agreement owner (sender).",
+ "type": "string"
+ },
+ "signer_email": {
+ "description": "Email address of the signer from the owner's organization.",
+ "format": "email",
+ "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "template_id": {
+ "description": "UUID of a template from `GET /v1/templates`. Accepts both Common Paper standard templates and uploaded PDF templates (`type` `uploaded_template`).",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ }
+ },
+ "required": [
+ "template_id",
+ "owner_email",
+ "signer_email",
+ "agreement"
+ ],
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "agreement": {
+ "additionalProperties": {},
+ "properties": {
+ "amendment_attributes": {
+ "additionalProperties": false,
+ "description": "Override amendment terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "amended_terms_attributes": {
+ "additionalProperties": {
+ "additionalProperties": false,
+ "properties": {
+ "description": {
+ "type": "string"
+ },
+ "term": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "description": "Amended terms. Use string keys such as \"0\", \"1\".",
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+ },
+ "amendment_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "amendment_date_type": {
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "type": "string"
+ },
+ "framework_terms_type": {
+ "type": "string"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "parent_agreement_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "underlying_agreement_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "underlying_agreement_type": {
+ "type": "string"
+ },
+ "underlying_agreement_val": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "baa_attributes": {
+ "additionalProperties": false,
+ "description": "Override baa terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "aggregation_limitations_permitted": {
+ "type": "boolean"
+ },
+ "aggregation_limitations_permitted_val": {
+ "type": "string"
+ },
+ "breach_notification_unit": {
+ "enum": [
+ "hours",
+ "business days",
+ "calendar days"
+ ],
+ "type": "string"
+ },
+ "breach_notification_val": {
+ "type": "number"
+ },
+ "business_associate_relationship_type": {
+ "enum": [
+ "provider",
+ "company"
+ ],
+ "type": "string"
+ },
+ "deidentification_limitations_include_purpose": {
+ "type": "boolean"
+ },
+ "deidentification_limitations_include_requirements": {
+ "type": "boolean"
+ },
+ "deidentification_limitations_permitted": {
+ "type": "boolean"
+ },
+ "deidentification_limitations_purpose_val": {
+ "type": "string"
+ },
+ "deidentification_limitations_requirements_val": {
+ "type": "string"
+ },
+ "designated_record_set_provider_maintains": {
+ "type": "boolean"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_aggregation_limitations": {
+ "type": "boolean"
+ },
+ "include_deidentification_limitations": {
+ "type": "boolean"
+ },
+ "include_limitations": {
+ "type": "boolean"
+ },
+ "include_offshore_limitations": {
+ "type": "boolean"
+ },
+ "include_subcontract_limitations": {
+ "type": "boolean"
+ },
+ "offshore_limitations_permitted": {
+ "type": "boolean"
+ },
+ "offshore_limitations_permitted_val": {
+ "type": "string"
+ },
+ "subcontract_limitations_include_notice": {
+ "type": "boolean"
+ },
+ "subcontract_limitations_include_permission": {
+ "type": "boolean"
+ },
+ "subcontract_limitations_notice_val": {
+ "type": "string"
+ },
+ "subcontract_limitations_permission_val": {
+ "type": "string"
+ },
+ "subcontract_limitations_permitted": {
+ "type": "boolean"
+ },
+ "underlying_agreement_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "underlying_agreement_type": {
+ "enum": [
+ "internal",
+ "external",
+ "none"
+ ],
+ "type": "string"
+ },
+ "underlying_agreement_val": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "billing_email": {
+ "description": "Email of the billing contact. Used when include_billing_info is true.",
+ "format": "email",
+ "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "billing_name": {
+ "description": "Name of the billing contact. Used when include_billing_info is true.",
+ "type": "string"
+ },
+ "billing_workflow_type": {
+ "description": "The type of billing workflow. Use \"link\" to provide a payment_link_url, or \"stripe\" for Stripe-managed billing.",
+ "enum": [
+ "link",
+ "stripe"
+ ],
+ "type": "string"
+ },
+ "chosen_courts_country": {
+ "description": "The country in which disputes will be resolved.",
+ "type": "string"
+ },
+ "chosen_courts_region": {
+ "description": "The state or region in which disputes will be resolved.",
+ "type": "string"
+ },
+ "csa_attributes": {
+ "additionalProperties": false,
+ "description": "Override csa terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "customer_description": {
+ "type": "string"
+ },
+ "effective_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "effective_date_marketplace": {
+ "enum": [
+ "AWS",
+ "GCP",
+ "Azure"
+ ],
+ "type": "string"
+ },
+ "effective_date_type": {
+ "enum": [
+ "signature",
+ "date",
+ "marketplace_acceptance"
+ ],
+ "type": "string"
+ },
+ "general_cap_amount": {
+ "type": "number"
+ },
+ "general_cap_amount_type": {
+ "enum": [
+ "preceding",
+ "base",
+ "period"
+ ],
+ "type": "string"
+ },
+ "general_cap_period_currency": {
+ "type": "number"
+ },
+ "general_cap_period_qty": {
+ "type": "number"
+ },
+ "general_cap_preceding_amount": {
+ "type": "number"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_acceptable_use_policy": {
+ "type": "boolean"
+ },
+ "include_acceptable_use_policy_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_acceptable_use_policy_location": {
+ "type": "string"
+ },
+ "include_acceptable_use_policy_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_additional_warranties": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_by_customer": {
+ "type": "string"
+ },
+ "include_additional_warranties_by_provider": {
+ "type": "string"
+ },
+ "include_additional_warranties_include_by_customer": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_include_by_provider": {
+ "type": "boolean"
+ },
+ "include_ai_addendum": {
+ "type": "boolean"
+ },
+ "include_ai_addendum_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_covered_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_customer_claims": {
+ "type": "string"
+ },
+ "include_covered_claims_include_customer_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_include_provider_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_provider_claims": {
+ "type": "string"
+ },
+ "include_dpa": {
+ "type": "boolean"
+ },
+ "include_dpa_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_dpa_location": {
+ "type": "string"
+ },
+ "include_dpa_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_increased_cap_amount": {
+ "type": "boolean"
+ },
+ "include_increased_claims": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_confidentiality": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_confidentiality_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_privsec": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_privsec_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_other": {
+ "type": "boolean"
+ },
+ "include_increased_claims_indemnification_obligation": {
+ "type": "boolean"
+ },
+ "include_increased_claims_other": {
+ "type": "string"
+ },
+ "include_insurance_minimums": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_add_customer": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_add_customer_com_gen_liability": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_add_customer_cyber_liability": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_add_customer_errors_omissions": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_additional_information": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_additional_information_text": {
+ "type": "string"
+ },
+ "include_insurance_minimums_cyber_liability_aggregate": {
+ "type": "number"
+ },
+ "include_insurance_minimums_cyber_liability_minimum": {
+ "type": "number"
+ },
+ "include_insurance_minimums_employer_liability_aggregate": {
+ "type": "number"
+ },
+ "include_insurance_minimums_employer_liability_minimum": {
+ "type": "number"
+ },
+ "include_insurance_minimums_general_liability_aggregate": {
+ "type": "number"
+ },
+ "include_insurance_minimums_general_liability_minimum": {
+ "type": "number"
+ },
+ "include_insurance_minimums_include_cyber_liability": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_include_employer_liability": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_include_general_liability": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_include_workers_compensation": {
+ "type": "boolean"
+ },
+ "include_publicity_rights": {
+ "type": "boolean"
+ },
+ "include_publicity_rights_type": {
+ "enum": [
+ "public",
+ "non-public"
+ ],
+ "type": "string"
+ },
+ "include_security_policy": {
+ "type": "boolean"
+ },
+ "include_security_policy_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_security_policy_fedramp_auth": {
+ "type": "boolean"
+ },
+ "include_security_policy_hipaa": {
+ "type": "boolean"
+ },
+ "include_security_policy_hitrust": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_annual_maintenance": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_location": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_other": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_reasonable_efforts": {
+ "type": "boolean"
+ },
+ "include_security_policy_iso27001": {
+ "type": "boolean"
+ },
+ "include_security_policy_location": {
+ "type": "string"
+ },
+ "include_security_policy_other": {
+ "type": "string"
+ },
+ "include_security_policy_pci1": {
+ "type": "boolean"
+ },
+ "include_security_policy_pci2": {
+ "type": "boolean"
+ },
+ "include_security_policy_penetration_testing": {
+ "type": "boolean"
+ },
+ "include_security_policy_soc2": {
+ "type": "boolean"
+ },
+ "include_security_policy_soc2_type2": {
+ "type": "boolean"
+ },
+ "include_security_policy_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_supercap": {
+ "description": "CSA 3.0 renamed `include_increased_cap_amount` to `include_supercap`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_increased_cap_amount`. Sending the other spelling returns a 422.",
+ "type": "boolean"
+ },
+ "include_uncapped_claims": {
+ "description": "CSA 3.0 renamed `include_unlimited_claims` to `include_uncapped_claims`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims`. Sending the other spelling returns a 422.",
+ "type": "boolean"
+ },
+ "include_uncapped_claims_breach_of_confidentiality": {
+ "description": "CSA 3.0 renamed `include_unlimited_claims_breach_of_confidentiality` to `include_uncapped_claims_breach_of_confidentiality`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_breach_of_confidentiality`. Sending the other spelling returns a 422.",
+ "type": "boolean"
+ },
+ "include_uncapped_claims_breach_of_confidentiality_negligence": {
+ "description": "CSA 3.0 renamed `include_unlimited_claims_breach_of_confidentiality_negligence` to `include_uncapped_claims_breach_of_confidentiality_negligence`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_breach_of_confidentiality_negligence`. Sending the other spelling returns a 422.",
+ "type": "boolean"
+ },
+ "include_uncapped_claims_breach_of_privsec": {
+ "description": "CSA 3.0 renamed `include_unlimited_claims_breach_of_privsec` to `include_uncapped_claims_breach_of_privsec`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_breach_of_privsec`. Sending the other spelling returns a 422.",
+ "type": "boolean"
+ },
+ "include_uncapped_claims_breach_of_privsec_negligence": {
+ "description": "CSA 3.0 renamed `include_unlimited_claims_breach_of_privsec_negligence` to `include_uncapped_claims_breach_of_privsec_negligence`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_breach_of_privsec_negligence`. Sending the other spelling returns a 422.",
+ "type": "boolean"
+ },
+ "include_uncapped_claims_include_other": {
+ "description": "CSA 3.0 renamed `include_unlimited_claims_include_other` to `include_uncapped_claims_include_other`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_include_other`. Sending the other spelling returns a 422.",
+ "type": "boolean"
+ },
+ "include_uncapped_claims_indemnification_obligation": {
+ "description": "CSA 3.0 renamed `include_unlimited_claims_indemnification_obligation` to `include_uncapped_claims_indemnification_obligation`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_indemnification_obligation`. Sending the other spelling returns a 422.",
+ "type": "boolean"
+ },
+ "include_uncapped_claims_other": {
+ "description": "CSA 3.0 renamed `include_unlimited_claims_other` to `include_uncapped_claims_other`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_other`. Sending the other spelling returns a 422.",
+ "type": "boolean"
+ },
+ "include_unlimited_claims": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_confidentiality": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_confidentiality_negligence": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_privsec": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_privsec_negligence": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_include_other": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_indemnification_obligation": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_other": {
+ "type": "string"
+ },
+ "increased_cap_amount_currency": {
+ "type": "number"
+ },
+ "increased_cap_amount_period_currency": {
+ "type": "number"
+ },
+ "increased_cap_amount_period_qty": {
+ "type": "number"
+ },
+ "increased_cap_amount_qty": {
+ "type": "number"
+ },
+ "increased_cap_amount_type": {
+ "enum": [
+ "qty",
+ "currency",
+ "period"
+ ],
+ "type": "string"
+ },
+ "provider": {
+ "type": "string"
+ },
+ "supercap_currency": {
+ "description": "CSA 3.0 renamed `increased_cap_amount_currency` to `supercap_currency`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `increased_cap_amount_currency`. Sending the other spelling returns a 422.",
+ "type": "number"
+ },
+ "supercap_period_currency": {
+ "description": "CSA 3.0 renamed `increased_cap_amount_period_currency` to `supercap_period_currency`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `increased_cap_amount_period_currency`. Sending the other spelling returns a 422.",
+ "type": "number"
+ },
+ "supercap_period_qty": {
+ "description": "CSA 3.0 renamed `increased_cap_amount_period_qty` to `supercap_period_qty`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `increased_cap_amount_period_qty`. Sending the other spelling returns a 422.",
+ "type": "number"
+ },
+ "supercap_qty": {
+ "description": "CSA 3.0 renamed `increased_cap_amount_qty` to `supercap_qty`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `increased_cap_amount_qty`. Sending the other spelling returns a 422.",
+ "type": "number"
+ },
+ "supercap_type": {
+ "description": "CSA 3.0 renamed `increased_cap_amount_type` to `supercap_type`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `increased_cap_amount_type`. Sending the other spelling returns a 422.",
+ "type": "number"
+ }
+ },
+ "type": "object"
+ },
+ "csa_order_form_attributes": {
+ "additionalProperties": false,
+ "description": "Override csa order form terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "additional_changes": {
+ "type": "string"
+ },
+ "additional_parameters_or_limitations": {
+ "type": "string"
+ },
+ "affiliates_as_users": {
+ "type": "boolean"
+ },
+ "cloud_service_description": {
+ "type": "string"
+ },
+ "consumption_units": {
+ "type": "string"
+ },
+ "fee_amount": {
+ "type": "number"
+ },
+ "fee_custom_unit": {
+ "type": "string"
+ },
+ "fee_period": {
+ "enum": [
+ "Subscription Period",
+ "month",
+ "year",
+ "User",
+ "Custom unit"
+ ],
+ "type": "string"
+ },
+ "fees_attributes": {
+ "additionalProperties": {
+ "anyOf": [
+ {
+ "additionalProperties": false,
+ "description": "Fees::Flat (fee_type \"flat\"). A fixed recurring fee, e.g. a platform subscription. Set type to \"Fees::Flat\" or fee_type to \"flat\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Fixed amount in the order form's fees_currency, charged per fee_period. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"flat\". Alternative to type.",
+ "enum": [
+ "flat"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Flat\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Flat"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Discount (fee_type \"discount\"). A discount, as a fixed amount or a percentage, applied forever, once, or for a number of months. Set type to \"Fees::Discount\" or fee_type to \"discount\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Discount size: an amount in fees_currency when discount_type is fixed_amount (a plain amount, not cents: 20 means 20.00), or a percentage (e.g. 10 for 10%) when it is percentage.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "discount_duration_amount": {
+ "description": "Number of months the discount applies. Required when discount_duration_type is multiple_months.",
+ "type": "number"
+ },
+ "discount_duration_type": {
+ "description": "How long the discount applies. multiple_months also needs discount_duration_amount.",
+ "enum": [
+ "forever",
+ "once",
+ "multiple_months"
+ ],
+ "type": "string"
+ },
+ "discount_type": {
+ "description": "Whether cost is a currency amount or a percentage.",
+ "enum": [
+ "fixed_amount",
+ "percentage"
+ ],
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"discount\". Alternative to type.",
+ "enum": [
+ "discount"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Discount\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Discount"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Cost (fee_type \"cost\"). A per-unit fee: price per unit times quantity, e.g. seats. Set type to \"Fees::Cost\" or fee_type to \"cost\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Price per unit in fees_currency. The row total is quantity x cost. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"cost\". Alternative to type.",
+ "enum": [
+ "cost"
+ ],
+ "type": "string"
+ },
+ "quantity": {
+ "description": "Number of units.",
+ "type": "number"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Cost\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Cost"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Attachment (fee_type \"attachment\"). A fee described in an uploaded attachment instead of in the table. Set type to \"Fees::Attachment\" or fee_type to \"attachment\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "attachment_id": {
+ "description": "ID of an attachment uploaded with upload-attachment.",
+ "type": "string"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"attachment\". Alternative to type.",
+ "enum": [
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Attachment\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Attachment"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Graduated (fee_type \"graduated\"). Tiered pricing, with the price set per tier in graduated_fee_tiers_attributes. Set type to \"Fees::Graduated\" or fee_type to \"graduated\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"graduated\". Alternative to type.",
+ "enum": [
+ "graduated"
+ ],
+ "type": "string"
+ },
+ "graduated_fee_tiers_attributes": {
+ "additionalProperties": {
+ "additionalProperties": false,
+ "properties": {
+ "flat_price": {
+ "type": "number"
+ },
+ "price_per_unit": {
+ "type": "string"
+ },
+ "upper_limit": {
+ "type": "number"
+ }
+ },
+ "type": "object"
+ },
+ "description": "Graduated fee tiers. Use string keys such as \"0\", \"1\".",
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Graduated\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Graduated"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Included (fee_type \"included\"). An item included at no charge. Set type to \"Fees::Included\" or fee_type to \"included\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"included\". Alternative to type.",
+ "enum": [
+ "included"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Included\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Included"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Metered (fee_type \"metered\"). Usage-based pricing, billed per unit used. Set type to \"Fees::Metered\" or fee_type to \"metered\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Price per unit of usage in fees_currency. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"metered\". Alternative to type.",
+ "enum": [
+ "metered"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Metered\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Metered"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::OneTime (fee_type \"one_time\"). A one-time charge, such as a setup fee. Set type to \"Fees::OneTime\" or fee_type to \"one_time\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "One-time amount in fees_currency, charged once rather than per fee_period. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"one_time\". Alternative to type.",
+ "enum": [
+ "one_time"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::OneTime\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::OneTime"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Text (fee_type \"text\"). A fee term described in free text. Set type to \"Fees::Text\" or fee_type to \"text\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"text\". Alternative to type.",
+ "enum": [
+ "text"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Text\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Text"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ }
+ ]
+ },
+ "description": "Fee table rows, keyed by string index (\"0\", \"1\", ...). Replaces the template's fees when provided. Each row sets type or fee_type to pick the fee class. Amounts are in the order form's fees_currency and, for recurring fees, are charged per fee_period.",
+ "examples": [
+ {
+ "0": {
+ "cost": 2000,
+ "description": "Platform subscription",
+ "type": "Fees::Flat"
+ }
+ },
+ {
+ "0": {
+ "cost": 50,
+ "description": "Seats",
+ "fee_type": "cost",
+ "quantity": 10
+ },
+ "1": {
+ "cost": 10,
+ "description": "Launch discount",
+ "discount_duration_amount": 3,
+ "discount_duration_type": "multiple_months",
+ "discount_type": "percentage",
+ "fee_type": "discount"
+ }
+ }
+ ],
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+ },
+ "fees_currency": {
+ "enum": [
+ "USD",
+ "EUR",
+ "GBP",
+ "CAD",
+ "AUD",
+ "SGD",
+ "ILS",
+ "JPY",
+ "CHF",
+ "HKD"
+ ],
+ "type": "string"
+ },
+ "fees_include_fee_increase_upon_renewal": {
+ "type": "boolean"
+ },
+ "fees_include_fee_increase_upon_renewal_fee": {
+ "type": "number"
+ },
+ "fees_include_fee_increase_upon_renewal_type": {
+ "enum": [
+ "will",
+ "may"
+ ],
+ "type": "string"
+ },
+ "fees_inclusive_of_taxes": {
+ "type": "boolean"
+ },
+ "framework_terms_type": {
+ "enum": [
+ "new",
+ "existing",
+ "description"
+ ],
+ "type": "string"
+ },
+ "free_trial_days": {
+ "type": "number"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_additional_changes": {
+ "type": "boolean"
+ },
+ "include_additional_parameters_or_limitations": {
+ "type": "boolean"
+ },
+ "include_consumption": {
+ "type": "boolean"
+ },
+ "include_fees": {
+ "type": "boolean"
+ },
+ "include_fees_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_fees_include_attachment": {
+ "type": "boolean"
+ },
+ "include_fees_other": {
+ "type": "boolean"
+ },
+ "include_fees_other_val": {
+ "type": "string"
+ },
+ "include_fees_table": {
+ "type": "boolean"
+ },
+ "include_fees_table_period": {
+ "enum": [
+ "Subscription Period",
+ "month",
+ "year",
+ "User"
+ ],
+ "type": "string"
+ },
+ "include_free_trial": {
+ "type": "boolean"
+ },
+ "include_max_users": {
+ "type": "boolean"
+ },
+ "include_pilot_period": {
+ "type": "boolean"
+ },
+ "include_pilot_period_duration_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_pilot_period_duration_type": {
+ "enum": [
+ "day",
+ "week",
+ "month"
+ ],
+ "type": "string"
+ },
+ "include_pilot_period_include_fees": {
+ "type": "boolean"
+ },
+ "include_pilot_period_include_fees_amount": {
+ "type": "number"
+ },
+ "include_pilot_period_include_modifications": {
+ "type": "boolean"
+ },
+ "include_pilot_period_include_modifications_description": {
+ "type": "string"
+ },
+ "include_product_support": {
+ "type": "boolean"
+ },
+ "include_product_support_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_product_support_description": {
+ "type": "string"
+ },
+ "include_product_support_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_professional_services": {
+ "type": "boolean"
+ },
+ "include_professional_services_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_professional_services_custom_name": {
+ "type": "string"
+ },
+ "include_professional_services_description": {
+ "type": "string"
+ },
+ "include_professional_services_end_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "include_professional_services_fees_description": {
+ "type": "string"
+ },
+ "include_professional_services_include_end_date": {
+ "type": "boolean"
+ },
+ "include_professional_services_include_fees_description": {
+ "type": "boolean"
+ },
+ "include_professional_services_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_sla": {
+ "type": "boolean"
+ },
+ "include_sla_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_sla_description": {
+ "type": "string"
+ },
+ "include_sla_include_response_time": {
+ "type": "boolean"
+ },
+ "include_sla_include_response_time_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_sla_include_response_time_credit": {
+ "type": "number"
+ },
+ "include_sla_include_response_time_duration": {
+ "enum": [
+ "hour",
+ "day",
+ "week",
+ "month",
+ "hours"
+ ],
+ "type": "string"
+ },
+ "include_sla_include_response_time_support_channel": {
+ "type": "string"
+ },
+ "include_sla_include_target_uptime": {
+ "type": "boolean"
+ },
+ "include_sla_maintenance_notice": {
+ "type": "boolean"
+ },
+ "include_sla_maintenance_window": {
+ "type": "boolean"
+ },
+ "include_sla_maintenance_window_type": {
+ "enum": [
+ "standard",
+ "none"
+ ],
+ "type": "string"
+ },
+ "include_sla_standard_maintenance_notice_qty": {
+ "type": "number"
+ },
+ "include_sla_standard_maintenance_notice_unit": {
+ "enum": [
+ "hour",
+ "day",
+ "week",
+ "month"
+ ],
+ "type": "string"
+ },
+ "include_sla_standard_maintenance_window_end_time": {
+ "type": "string"
+ },
+ "include_sla_standard_maintenance_window_friday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_monday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_saturday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_start_time": {
+ "type": "string"
+ },
+ "include_sla_standard_maintenance_window_sunday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_thursday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_time_zone": {
+ "type": "string"
+ },
+ "include_sla_standard_maintenance_window_tuesday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_wednesday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_target_uptime": {
+ "type": "number"
+ },
+ "include_sla_type": {
+ "enum": [
+ "description",
+ "standard",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_subscription_start_date": {
+ "type": "boolean"
+ },
+ "include_subscription_start_date_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "include_usage_review": {
+ "type": "boolean"
+ },
+ "include_usage_review_val": {
+ "type": "string"
+ },
+ "include_use_limitations": {
+ "type": "boolean"
+ },
+ "include_use_limitations_val": {
+ "type": "string"
+ },
+ "invoice_period": {
+ "enum": [
+ "monthly",
+ "quarterly",
+ "semiannually",
+ "annually",
+ "Custom unit",
+ "Monthly",
+ "Quarterly",
+ "Semiannually",
+ "Annually"
+ ],
+ "type": "string"
+ },
+ "invoice_period_custom_unit": {
+ "type": "string"
+ },
+ "max_consumption": {
+ "type": "number"
+ },
+ "max_users": {
+ "type": "number"
+ },
+ "negotiations_allowed": {
+ "description": "When true, the recipient can propose changes to the order form, even when the agreement-level `negotiations_allowed` is false. This only covers the order form.",
+ "type": "boolean"
+ },
+ "order_date_date": {
+ "type": "string"
+ },
+ "order_date_other": {
+ "type": "string"
+ },
+ "order_date_type": {
+ "enum": [
+ "signature",
+ "date",
+ "other"
+ ],
+ "type": "string"
+ },
+ "payment_period": {
+ "type": "number"
+ },
+ "payment_period_timeframe": {
+ "enum": [
+ "Customer's receipt of invoice",
+ "date of invoice"
+ ],
+ "type": "string"
+ },
+ "payment_period_unit": {
+ "enum": [
+ "day(s)",
+ "week(s)",
+ "month(s)",
+ "marketplace_acceptance"
+ ],
+ "type": "string"
+ },
+ "payment_process_automatic_frequency": {
+ "enum": [
+ "monthly",
+ "quarterly",
+ "semiannually",
+ "annually"
+ ],
+ "type": "string"
+ },
+ "payment_process_type": {
+ "enum": [
+ "automatic",
+ "invoice",
+ "custom",
+ "marketplace_acceptance"
+ ],
+ "type": "string"
+ },
+ "payment_process_type_custom_val": {
+ "type": "string"
+ },
+ "payment_process_type_invoice_amount": {
+ "type": "number"
+ },
+ "payment_process_type_invoice_custom_unit": {
+ "type": "string"
+ },
+ "payment_process_type_invoice_duration": {
+ "enum": [
+ "day",
+ "week",
+ "month",
+ "year",
+ "day(s)",
+ "week(s)",
+ "month(s)",
+ "year(s)"
+ ],
+ "type": "string"
+ },
+ "payment_process_type_invoice_duration_start": {
+ "enum": [
+ "Customer's receipt of invoice",
+ "date of invoice"
+ ],
+ "type": "string"
+ },
+ "payment_process_type_invoice_type": {
+ "enum": [
+ "monthly",
+ "quarterly",
+ "semiannually",
+ "annually",
+ "Custom unit"
+ ],
+ "type": "string"
+ },
+ "pilot_period_stripe_product_id": {
+ "type": "string"
+ },
+ "service_credits_attributes": {
+ "additionalProperties": {
+ "additionalProperties": false,
+ "properties": {
+ "credit": {
+ "type": "number"
+ },
+ "max": {
+ "type": "number"
+ },
+ "min": {
+ "type": "number"
+ }
+ },
+ "type": "object"
+ },
+ "description": "Service credits. Use string keys such as \"0\", \"1\".",
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+ },
+ "subscription_auto_renew": {
+ "enum": [
+ "days",
+ "subscription_end"
+ ],
+ "type": "string"
+ },
+ "subscription_period": {
+ "type": "number"
+ },
+ "subscription_period_unit": {
+ "type": "string"
+ },
+ "subscription_renewal_notice_days": {
+ "type": "number"
+ },
+ "subscription_start_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "subscription_start_date_type": {
+ "enum": [
+ "effective_date",
+ "date"
+ ],
+ "type": "string"
+ },
+ "underlying_agreement_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "use_limitations_attributes": {
+ "additionalProperties": {
+ "additionalProperties": false,
+ "properties": {
+ "amount": {
+ "type": "number"
+ },
+ "limitation_type": {
+ "type": "string"
+ },
+ "unit": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "description": "Use limitations. Use string keys such as \"0\", \"1\".",
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+ }
+ },
+ "type": "object"
+ },
+ "custom_field_values": {
+ "description": "Values for a custom template's fields, keyed by the field keys defined in the template's YAML definition. Only used when template_id is a custom template. Template defaults fill any fields you omit; a required field with no default and no submitted value returns a 400 naming the field. Values are validated against the field's input type: select and radio values must be one of the field's options, multiselect values are an array of selections each of which must be one of the field's options, number and currency values must be numeric, date values must be YYYY-MM-DD, and email values must be valid addresses. An invalid value returns a 400 naming the field."
+ },
+ "design_partner_attributes": {
+ "additionalProperties": false,
+ "description": "Override design partner terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "customer_description": {
+ "type": "string"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_fees": {
+ "type": "boolean"
+ },
+ "include_fees_amount": {
+ "type": "number"
+ },
+ "include_fees_description": {
+ "type": "string"
+ },
+ "include_fees_pay_by_amount": {
+ "type": "string"
+ },
+ "include_fees_type": {
+ "enum": [
+ "default_language",
+ "description"
+ ],
+ "type": "string"
+ },
+ "include_fees_unit": {
+ "enum": [
+ "month",
+ "quarter",
+ "year",
+ "Term"
+ ],
+ "type": "string"
+ },
+ "include_program_appear_as_customer_private": {
+ "type": "boolean"
+ },
+ "include_program_appear_as_customer_public": {
+ "type": "boolean"
+ },
+ "include_program_case_study": {
+ "type": "boolean"
+ },
+ "include_program_develop_functionality": {
+ "type": "boolean"
+ },
+ "include_program_develop_functionality_val": {
+ "type": "string"
+ },
+ "include_program_discount": {
+ "type": "boolean"
+ },
+ "include_program_discount_amount": {
+ "type": "number"
+ },
+ "include_program_discount_unit": {
+ "enum": [
+ "U.S. Dollars",
+ "percent"
+ ],
+ "type": "string"
+ },
+ "include_program_participation_feedback": {
+ "type": "boolean"
+ },
+ "include_program_participation_feedback_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_program_participation_feedback_unit": {
+ "enum": [
+ "month",
+ "quarter",
+ "year",
+ "Term"
+ ],
+ "type": "string"
+ },
+ "include_program_partner_other": {
+ "type": "boolean"
+ },
+ "include_program_partner_other_val": {
+ "type": "string"
+ },
+ "include_program_provider_other": {
+ "type": "boolean"
+ },
+ "include_program_provider_other_val": {
+ "type": "string"
+ },
+ "include_program_reference": {
+ "type": "boolean"
+ },
+ "product_description": {
+ "type": "string"
+ },
+ "term_amount": {
+ "type": "number"
+ },
+ "term_unit": {
+ "enum": [
+ "day(s)",
+ "week(s)",
+ "month(s)",
+ "quarter(s)",
+ "year(s)"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "district_or_county": {
+ "description": "The district or county for dispute resolution.",
+ "type": "string"
+ },
+ "dpa_attributes": {
+ "additionalProperties": false,
+ "description": "Override dpa terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "approved_subprocessor_type": {
+ "description": "`internal` lists approved subprocessors in the agreement (`subprocessors_attributes`); `external` points to a list published elsewhere.",
+ "enum": [
+ "internal",
+ "external"
+ ],
+ "type": "string"
+ },
+ "cloud_service_product_name": {
+ "type": "string"
+ },
+ "competent_supervisory_authority": {
+ "type": "string"
+ },
+ "customer_description": {
+ "type": "string"
+ },
+ "data_exporter_address_city": {
+ "type": "string"
+ },
+ "data_exporter_address_country": {
+ "type": "string"
+ },
+ "data_exporter_address_state": {
+ "type": "string"
+ },
+ "data_exporter_address_street_address": {
+ "type": "string"
+ },
+ "data_exporter_address_zipcode": {
+ "type": "string"
+ },
+ "data_exporter_contact_details": {
+ "type": "string"
+ },
+ "data_exporter_contact_name": {
+ "type": "string"
+ },
+ "data_exporter_contact_position": {
+ "type": "string"
+ },
+ "data_exporter_role": {
+ "description": "Role of the data exporter. Overwritten to `Controller` when the agreement is created from a template.",
+ "enum": [
+ "Controller",
+ "Processor"
+ ],
+ "type": "string"
+ },
+ "data_importer_address": {
+ "type": "string"
+ },
+ "data_importer_address_city": {
+ "type": "string"
+ },
+ "data_importer_address_country": {
+ "type": "string"
+ },
+ "data_importer_address_state": {
+ "type": "string"
+ },
+ "data_importer_address_street_address": {
+ "type": "string"
+ },
+ "data_importer_address_zipcode": {
+ "type": "string"
+ },
+ "data_importer_contact_details": {
+ "type": "string"
+ },
+ "data_importer_contact_name": {
+ "type": "string"
+ },
+ "data_importer_contact_position": {
+ "type": "string"
+ },
+ "duration_of_processing": {
+ "type": "string"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_covered_claim": {
+ "type": "boolean"
+ },
+ "include_covered_claim_external_val": {
+ "type": "string"
+ },
+ "include_covered_claim_internal_val": {
+ "type": "string"
+ },
+ "include_covered_claim_type": {
+ "description": "Which covered-claim text applies: `internal` uses `include_covered_claim_internal_val`, `external` uses `include_covered_claim_external_val`. Required when `include_covered_claim` is true.",
+ "enum": [
+ "internal",
+ "external"
+ ],
+ "type": "string"
+ },
+ "include_data_subjects_custom": {
+ "type": "boolean"
+ },
+ "include_data_subjects_custom_val": {
+ "type": "string"
+ },
+ "include_data_subjects_employees": {
+ "type": "boolean"
+ },
+ "include_data_subjects_end_users": {
+ "type": "boolean"
+ },
+ "include_external_subprocessor_location": {
+ "type": "string"
+ },
+ "include_frequency_of_transfer_continuous": {
+ "type": "boolean"
+ },
+ "include_frequency_of_transfer_custom": {
+ "type": "boolean"
+ },
+ "include_frequency_of_transfer_custom_val": {
+ "type": "string"
+ },
+ "include_governing_country_eu": {
+ "type": "boolean"
+ },
+ "include_governing_country_eu_val": {
+ "type": "string"
+ },
+ "include_governing_country_uk": {
+ "type": "boolean"
+ },
+ "include_governing_country_uk_val": {
+ "type": "string"
+ },
+ "include_governing_law": {
+ "type": "boolean"
+ },
+ "include_governing_law_country": {
+ "type": "string"
+ },
+ "include_governing_law_state": {
+ "type": "string"
+ },
+ "include_increased_claim_amount": {
+ "description": "Legacy field. Stored but not shown on the DPA; use the `include_liability_cap*` fields instead.",
+ "type": "boolean"
+ },
+ "include_increased_claim_amount_currency": {
+ "description": "Legacy field. Stored but not shown on the DPA; use the `include_liability_cap*` fields instead."
+ },
+ "include_increased_claim_amount_qty": {
+ "description": "Legacy field. Stored but not shown on the DPA; use the `include_liability_cap*` fields instead."
+ },
+ "include_increased_claim_amount_type": {
+ "description": "Legacy field. Stored but not shown on the DPA; use the `include_liability_cap*` fields instead.",
+ "type": "string"
+ },
+ "include_liability_cap": {
+ "type": "boolean"
+ },
+ "include_liability_cap_amount_constant_external": {
+ "type": "string"
+ },
+ "include_liability_cap_amount_constant_internal": {
+ "type": "string"
+ },
+ "include_liability_cap_amount_currency_external": {
+ "description": "Currency amount. Numbers and numeric strings (commas allowed) are both accepted."
+ },
+ "include_liability_cap_amount_currency_internal": {
+ "description": "Currency amount. Numbers and numeric strings (commas allowed) are both accepted."
+ },
+ "include_liability_cap_csa_type": {
+ "description": "Which liability cap values apply: the `_internal` or `_external` amount fields. Required when `include_liability_cap` is true.",
+ "enum": [
+ "internal",
+ "external"
+ ],
+ "type": "string"
+ },
+ "include_personal_data_biographic_info": {
+ "type": "boolean"
+ },
+ "include_personal_data_contact_info": {
+ "type": "boolean"
+ },
+ "include_personal_data_custom": {
+ "type": "boolean"
+ },
+ "include_personal_data_custom_val": {
+ "type": "string"
+ },
+ "include_personal_data_employment_info": {
+ "type": "boolean"
+ },
+ "include_personal_data_financial_info": {
+ "type": "boolean"
+ },
+ "include_personal_data_location": {
+ "type": "boolean"
+ },
+ "include_personal_data_name": {
+ "type": "boolean"
+ },
+ "include_personal_data_transactional_info": {
+ "type": "boolean"
+ },
+ "include_personal_data_user_activity_info": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_custom": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_custom_val": {
+ "type": "string"
+ },
+ "include_processing_purpose_erasing": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_holding": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_protecting": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_receiving": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_returning": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_sharing": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_updating": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_using": {
+ "type": "boolean"
+ },
+ "include_provider_security_contact_address": {
+ "type": "boolean"
+ },
+ "include_provider_security_contact_address_city": {
+ "type": "string"
+ },
+ "include_provider_security_contact_address_country": {
+ "type": "string"
+ },
+ "include_provider_security_contact_address_state": {
+ "type": "string"
+ },
+ "include_provider_security_contact_address_street_address": {
+ "type": "string"
+ },
+ "include_provider_security_contact_address_zipcode": {
+ "type": "string"
+ },
+ "include_provider_security_contact_email": {
+ "type": "boolean"
+ },
+ "include_provider_security_contact_email_val": {
+ "format": "email",
+ "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "include_security_measures_accountability": {
+ "type": "boolean"
+ },
+ "include_security_measures_accountability_val": {
+ "type": "string"
+ },
+ "include_security_measures_certification_or_assurance": {
+ "type": "boolean"
+ },
+ "include_security_measures_certification_or_assurance_val": {
+ "type": "string"
+ },
+ "include_security_measures_confidentiality_integrity": {
+ "type": "boolean"
+ },
+ "include_security_measures_confidentiality_integrity_val": {
+ "type": "string"
+ },
+ "include_security_measures_data_at_rest": {
+ "type": "boolean"
+ },
+ "include_security_measures_data_at_rest_val": {
+ "type": "string"
+ },
+ "include_security_measures_data_minimization": {
+ "type": "boolean"
+ },
+ "include_security_measures_data_minimization_val": {
+ "type": "string"
+ },
+ "include_security_measures_data_quality": {
+ "type": "boolean"
+ },
+ "include_security_measures_data_quality_val": {
+ "type": "string"
+ },
+ "include_security_measures_data_retention": {
+ "type": "boolean"
+ },
+ "include_security_measures_data_retention_val": {
+ "type": "string"
+ },
+ "include_security_measures_data_transmission": {
+ "type": "boolean"
+ },
+ "include_security_measures_data_transmission_val": {
+ "type": "string"
+ },
+ "include_security_measures_event_logging": {
+ "type": "boolean"
+ },
+ "include_security_measures_event_logging_val": {
+ "type": "string"
+ },
+ "include_security_measures_identity_auth": {
+ "type": "boolean"
+ },
+ "include_security_measures_identity_auth_val": {
+ "type": "string"
+ },
+ "include_security_measures_it_security_governance": {
+ "type": "boolean"
+ },
+ "include_security_measures_it_security_governance_val": {
+ "type": "string"
+ },
+ "include_security_measures_physical_security": {
+ "type": "boolean"
+ },
+ "include_security_measures_physical_security_val": {
+ "type": "string"
+ },
+ "include_security_measures_portability_and_erasure": {
+ "type": "boolean"
+ },
+ "include_security_measures_portability_and_erasure_val": {
+ "type": "string"
+ },
+ "include_security_measures_pseudonym_encryption": {
+ "type": "boolean"
+ },
+ "include_security_measures_pseudonym_encryption_val": {
+ "type": "string"
+ },
+ "include_security_measures_restore_data_access": {
+ "type": "boolean"
+ },
+ "include_security_measures_restore_data_access_val": {
+ "type": "string"
+ },
+ "include_security_measures_security_policy": {
+ "type": "boolean"
+ },
+ "include_security_measures_system_configuration": {
+ "type": "boolean"
+ },
+ "include_security_measures_system_configuration_val": {
+ "type": "string"
+ },
+ "include_security_measures_testing_assessment": {
+ "type": "boolean"
+ },
+ "include_security_measures_testing_assessment_val": {
+ "type": "string"
+ },
+ "include_security_policy": {
+ "type": "boolean"
+ },
+ "include_security_policy_fedramp_auth": {
+ "type": "boolean"
+ },
+ "include_security_policy_hipaa": {
+ "type": "boolean"
+ },
+ "include_security_policy_hitrust": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_other": {
+ "type": "boolean"
+ },
+ "include_security_policy_iso27001": {
+ "type": "boolean"
+ },
+ "include_security_policy_other": {
+ "type": "string"
+ },
+ "include_security_policy_pci1": {
+ "type": "boolean"
+ },
+ "include_security_policy_pci2": {
+ "type": "boolean"
+ },
+ "include_security_policy_penetration_testing": {
+ "type": "boolean"
+ },
+ "include_security_policy_soc2": {
+ "type": "boolean"
+ },
+ "include_security_policy_soc2_type2": {
+ "type": "boolean"
+ },
+ "include_sensitive_data_restrictions_custom": {
+ "type": "boolean"
+ },
+ "include_sensitive_data_restrictions_custom_val": {
+ "type": "string"
+ },
+ "include_sensitive_data_restrictions_security_policy": {
+ "type": "boolean"
+ },
+ "include_service_provider_relationship": {
+ "type": "boolean"
+ },
+ "include_special_category_data": {
+ "type": "boolean"
+ },
+ "provider": {
+ "type": "string"
+ },
+ "security_policy_available_at": {
+ "type": "string"
+ },
+ "security_policy_type": {
+ "description": "Where the Security Policy is defined. For `external`, set `security_policy_available_at`.",
+ "enum": [
+ "defined in agreement",
+ "provider service",
+ "external"
+ ],
+ "type": "string"
+ },
+ "subprocessors_attributes": {
+ "additionalProperties": {
+ "additionalProperties": false,
+ "properties": {
+ "_destroy": {
+ "description": "Set to true with `id` to remove that subprocessor.",
+ "type": "boolean"
+ },
+ "country": {
+ "type": "string"
+ },
+ "id": {
+ "description": "ID of an existing subprocessor to update or remove. Omit to add a new subprocessor.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "processing_task": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "description": "Subprocessors, keyed by string index such as \"0\", \"1\". On create these are added to the template's subprocessors. On a draft update, an entry without `id` adds a new subprocessor; pass `id` to change one and `id` with `_destroy: true` to remove one.",
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+ },
+ "underlying_agreement_id": {
+ "description": "ID of the CSA this DPA supplements when `underlying_agreement_type` is `internal`.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "underlying_agreement_type": {
+ "description": "`internal` links a CSA in Common Paper (`underlying_agreement_id`, required); `external` describes another agreement in `underlying_agreement_val` (required). Defaults to `internal` when omitted on create.",
+ "enum": [
+ "internal",
+ "external"
+ ],
+ "type": "string"
+ },
+ "underlying_agreement_val": {
+ "description": "Description of the agreement this DPA supplements. Required when `underlying_agreement_type` is `external`.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "framework_terms_description": {
+ "description": "Custom framework terms description. Only used when framework_terms_type is \"description\".",
+ "type": "string"
+ },
+ "framework_terms_type": {
+ "description": "How framework terms are specified. Use \"new\" for standard terms or \"description\" to provide a custom framework_terms_description.",
+ "enum": [
+ "new",
+ "description"
+ ],
+ "type": "string"
+ },
+ "governing_law_country": {
+ "description": "The country whose laws govern the agreement.",
+ "type": "string"
+ },
+ "governing_law_region": {
+ "description": "The state or region whose laws govern the agreement.",
+ "type": "string"
+ },
+ "include_automated_payment_reminders": {
+ "description": "When true, automatically sends payment reminder emails.",
+ "type": "boolean"
+ },
+ "include_billing_info": {
+ "description": "When true, billing contact information (billing_name, billing_email) is included.",
+ "type": "boolean"
+ },
+ "include_billing_workflow": {
+ "description": "When true, enables a billing workflow after signing.",
+ "type": "boolean"
+ },
+ "include_expiration_date": {
+ "description": "Expiration date in YYYY-MM-DD format. Use when include_expiration_type is \"date\".",
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "include_expiration_days": {
+ "description": "Number of days until the agreement expires. Use when include_expiration_type is \"days\".",
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_expiration_type": {
+ "description": "How to set expiration: \"none\" (default), \"days\" (use include_expiration_days), or \"date\" (use include_expiration_date).",
+ "enum": [
+ "none",
+ "days",
+ "date"
+ ],
+ "type": "string"
+ },
+ "include_terms": {
+ "description": "When true, the standard terms are included with the agreement.",
+ "type": "boolean"
+ },
+ "loi_attributes": {
+ "additionalProperties": false,
+ "description": "Override loi terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "confidentiality_custom": {
+ "type": "string"
+ },
+ "confidentiality_mutual_include_loi": {
+ "type": "boolean"
+ },
+ "confidentiality_nda_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "confidentiality_nda_description": {
+ "type": "string"
+ },
+ "confidentiality_nda_include_loi": {
+ "type": "boolean"
+ },
+ "confidentiality_nda_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "confidentiality_type": {
+ "enum": [
+ "mutual",
+ "nda",
+ "provider",
+ "custom"
+ ],
+ "type": "string"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_custom_details": {
+ "type": "boolean"
+ },
+ "include_custom_details_val": {
+ "type": "string"
+ },
+ "include_fees": {
+ "type": "boolean"
+ },
+ "include_fees_amount": {
+ "type": "number"
+ },
+ "include_fees_amount_duration": {
+ "enum": [
+ "month",
+ "year",
+ "quarter"
+ ],
+ "type": "string"
+ },
+ "include_fees_include_amount": {
+ "type": "boolean"
+ },
+ "include_fees_include_other": {
+ "type": "boolean"
+ },
+ "include_fees_other": {
+ "type": "string"
+ },
+ "include_functionality": {
+ "type": "boolean"
+ },
+ "include_functionality_val": {
+ "type": "string"
+ },
+ "include_launch_date": {
+ "type": "boolean"
+ },
+ "include_launch_date_custom": {
+ "type": "string"
+ },
+ "include_launch_date_date": {
+ "format": "date-time",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$",
+ "type": "string"
+ },
+ "include_launch_date_type": {
+ "enum": [
+ "date",
+ "custom"
+ ],
+ "type": "string"
+ },
+ "product_name": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "manual_send": {
+ "description": "When true, the agreement is marked as manually sent outside the platform.",
+ "type": "boolean"
+ },
+ "message": {
+ "type": "string"
+ },
+ "negotiations_allowed": {
+ "description": "When true, the recipient can propose changes to the legal terms. For agreement types without separate business terms, that covers every term. CSA order forms, PSA statements of work, partnership business terms and software license order forms have their own `negotiations_allowed` flag.",
+ "type": "boolean"
+ },
+ "partnership_attributes": {
+ "additionalProperties": false,
+ "description": "Override partnership terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "effective_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "effective_date_type": {
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "type": "string"
+ },
+ "general_cap_amount_currency_val": {
+ "type": "number"
+ },
+ "general_cap_amount_either_currency": {
+ "type": "number"
+ },
+ "general_cap_amount_either_multiple": {
+ "type": "number"
+ },
+ "general_cap_amount_multiple_val": {
+ "type": "number"
+ },
+ "general_cap_amount_type": {
+ "enum": [
+ "multiple",
+ "currency",
+ "either",
+ "base"
+ ],
+ "type": "string"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_additional_warranties": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_include_company": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_include_company_val": {
+ "type": "string"
+ },
+ "include_additional_warranties_include_partner": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_include_partner_val": {
+ "type": "string"
+ },
+ "include_brand_guidelines": {
+ "type": "boolean"
+ },
+ "include_brand_guidelines_include_company": {
+ "type": "boolean"
+ },
+ "include_brand_guidelines_include_company_val": {
+ "type": "string"
+ },
+ "include_brand_guidelines_include_partner": {
+ "type": "boolean"
+ },
+ "include_brand_guidelines_include_partner_val": {
+ "type": "string"
+ },
+ "include_covered_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_company_claims": {
+ "type": "string"
+ },
+ "include_covered_claims_include_company_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_include_partner_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_partner_claims": {
+ "type": "string"
+ },
+ "include_dpa": {
+ "type": "boolean"
+ },
+ "include_dpa_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_dpa_location": {
+ "type": "string"
+ },
+ "include_dpa_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_increased_cap_amount": {
+ "type": "boolean"
+ },
+ "include_increased_cap_amount_currency": {
+ "type": "number"
+ },
+ "include_increased_cap_amount_either_currency": {
+ "type": "number"
+ },
+ "include_increased_cap_amount_either_multiple": {
+ "type": "string"
+ },
+ "include_increased_cap_amount_multiple": {
+ "type": "string"
+ },
+ "include_increased_cap_amount_type": {
+ "enum": [
+ "multiple",
+ "currency",
+ "either"
+ ],
+ "type": "string"
+ },
+ "include_increased_claims": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_confidentiality": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_confidentiality_misconduct": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_covered_claims": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_misconduct": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_other": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_other_val": {
+ "type": "string"
+ },
+ "include_unlimited_claims": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_confidentiality": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_confidentiality_misconduct": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_covered_claims": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_misconduct": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_other": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_other_val": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "partnership_business_terms_attributes": {
+ "additionalProperties": false,
+ "description": "Override partnership business terms terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "end_date_after_effective_date_amount": {
+ "type": "number"
+ },
+ "end_date_after_effective_date_unit": {
+ "enum": [
+ "month(s)",
+ "quarter(s)",
+ "year(s)"
+ ],
+ "type": "string"
+ },
+ "end_date_date": {
+ "type": "string"
+ },
+ "end_date_type": {
+ "enum": [
+ "date",
+ "effective date"
+ ],
+ "type": "string"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_obligations_company_brand": {
+ "type": "boolean"
+ },
+ "include_obligations_company_promotion": {
+ "type": "boolean"
+ },
+ "include_obligations_company_promotion_include_activities": {
+ "type": "boolean"
+ },
+ "include_obligations_company_promotion_include_activities_val": {
+ "type": "string"
+ },
+ "include_obligations_company_promotion_include_materials": {
+ "type": "boolean"
+ },
+ "include_obligations_company_promotion_include_materials_val": {
+ "type": "string"
+ },
+ "include_obligations_company_referral": {
+ "type": "boolean"
+ },
+ "include_obligations_company_referral_include_criteria": {
+ "type": "boolean"
+ },
+ "include_obligations_company_referral_include_criteria_val": {
+ "type": "string"
+ },
+ "include_obligations_company_referral_include_pay_sch": {
+ "type": "boolean"
+ },
+ "include_obligations_company_referral_include_pay_sch_amount": {
+ "type": "number"
+ },
+ "include_obligations_company_referral_include_pay_sch_custom": {
+ "type": "string"
+ },
+ "include_obligations_company_referral_include_pay_sch_unit": {
+ "enum": [
+ "U.S. Dollars",
+ "percent"
+ ],
+ "type": "string"
+ },
+ "include_obligations_company_sponsorship": {
+ "type": "boolean"
+ },
+ "include_obligations_company_sponsorship_include_benefits": {
+ "type": "boolean"
+ },
+ "include_obligations_company_sponsorship_include_benefits_val": {
+ "type": "string"
+ },
+ "include_obligations_company_sponsorship_include_payments": {
+ "type": "boolean"
+ },
+ "include_obligations_company_sponsorship_include_payments_amount": {
+ "type": "number"
+ },
+ "include_obligations_company_sponsorship_include_payments_unit": {
+ "enum": [
+ "U.S. Dollars",
+ "percent"
+ ],
+ "type": "string"
+ },
+ "include_obligations_partner_brand": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_promotion": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_promotion_include_activities": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_promotion_include_activities_val": {
+ "type": "string"
+ },
+ "include_obligations_partner_promotion_include_materials": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_promotion_include_materials_val": {
+ "type": "string"
+ },
+ "include_obligations_partner_referral": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_referral_include_criteria": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_referral_include_criteria_val": {
+ "type": "string"
+ },
+ "include_obligations_partner_referral_include_pay_sch": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_referral_include_pay_sch_amount": {
+ "type": "number"
+ },
+ "include_obligations_partner_referral_include_pay_sch_custom": {
+ "type": "string"
+ },
+ "include_obligations_partner_referral_include_pay_sch_unit": {
+ "enum": [
+ "U.S. Dollars",
+ "percent"
+ ],
+ "type": "string"
+ },
+ "include_obligations_partner_sponsorship": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_sponsorship_include_benefits": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_sponsorship_include_benefits_val": {
+ "type": "string"
+ },
+ "include_obligations_partner_sponsorship_include_payments": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_sponsorship_include_payments_amount": {
+ "type": "number"
+ },
+ "include_obligations_partner_sponsorship_include_payments_unit": {
+ "enum": [
+ "U.S. Dollars",
+ "percent"
+ ],
+ "type": "string"
+ },
+ "include_payment_process": {
+ "type": "boolean"
+ },
+ "include_payment_process_company": {
+ "type": "boolean"
+ },
+ "include_payment_process_company_include_address": {
+ "type": "boolean"
+ },
+ "include_payment_process_company_include_address_city": {
+ "type": "string"
+ },
+ "include_payment_process_company_include_address_country": {
+ "type": "string"
+ },
+ "include_payment_process_company_include_address_state": {
+ "type": "string"
+ },
+ "include_payment_process_company_include_address_street_address": {
+ "type": "string"
+ },
+ "include_payment_process_company_include_address_zipcode": {
+ "type": "string"
+ },
+ "include_payment_process_company_include_email": {
+ "type": "boolean"
+ },
+ "include_payment_process_company_include_email_val": {
+ "type": "string"
+ },
+ "include_payment_process_partner": {
+ "type": "boolean"
+ },
+ "include_payment_process_partner_include_address": {
+ "type": "boolean"
+ },
+ "include_payment_process_partner_include_address_city": {
+ "type": "string"
+ },
+ "include_payment_process_partner_include_address_country": {
+ "type": "string"
+ },
+ "include_payment_process_partner_include_address_state": {
+ "type": "string"
+ },
+ "include_payment_process_partner_include_address_street_address": {
+ "type": "string"
+ },
+ "include_payment_process_partner_include_address_zipcode": {
+ "type": "string"
+ },
+ "include_payment_process_partner_include_email": {
+ "type": "boolean"
+ },
+ "include_payment_process_partner_include_email_val": {
+ "type": "string"
+ },
+ "include_payment_schedule": {
+ "type": "boolean"
+ },
+ "include_payment_schedule_custom": {
+ "type": "string"
+ },
+ "include_payment_schedule_specified_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_payment_schedule_specified_timeframe": {
+ "enum": [
+ "receipt",
+ "date"
+ ],
+ "type": "string"
+ },
+ "include_payment_schedule_specified_unit": {
+ "enum": [
+ "day(s)",
+ "week(s)",
+ "month(s)",
+ "quarter(s)",
+ "year(s)"
+ ],
+ "type": "string"
+ },
+ "include_payment_schedule_type": {
+ "enum": [
+ "specified",
+ "custom"
+ ],
+ "type": "string"
+ },
+ "negotiations_allowed": {
+ "description": "When true, the recipient can propose changes to the business terms, even when the agreement-level `negotiations_allowed` is false. This only covers the business terms.",
+ "type": "boolean"
+ },
+ "territory_type": {
+ "enum": [
+ "worldwide",
+ "custom"
+ ],
+ "type": "string"
+ },
+ "territory_type_val": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "payment_link_url": {
+ "description": "A payment URL shown to the recipient after signing. Requires include_billing_workflow to be true and billing_workflow_type to be \"link\".",
+ "type": "string"
+ },
+ "pilot_attributes": {
+ "additionalProperties": false,
+ "description": "Override pilot terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "fees_type": {
+ "enum": [
+ "free",
+ "pilot_period_fees"
+ ],
+ "type": "string"
+ },
+ "general_cap_amount": {
+ "type": "number"
+ },
+ "general_cap_amount_type": {
+ "enum": [
+ "preceding",
+ "base",
+ "period"
+ ],
+ "type": "string"
+ },
+ "general_cap_period_currency": {
+ "type": "number"
+ },
+ "general_cap_period_qty": {
+ "type": "number"
+ },
+ "general_cap_preceding_amount": {
+ "type": "number"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_dpa": {
+ "type": "boolean"
+ },
+ "include_dpa_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_dpa_location": {
+ "type": "string"
+ },
+ "include_dpa_type": {
+ "enum": [
+ "description",
+ "attachment",
+ "standard"
+ ],
+ "type": "string"
+ },
+ "include_payment_process": {
+ "type": "boolean"
+ },
+ "include_technical_support": {
+ "type": "boolean"
+ },
+ "payment_process_automatic_frequency": {
+ "enum": [
+ "monthly",
+ "quarterly",
+ "annually",
+ "once_per_period"
+ ],
+ "type": "string"
+ },
+ "payment_process_invoice_days": {
+ "type": "number"
+ },
+ "payment_process_invoice_from": {
+ "enum": [
+ "receipt",
+ "date"
+ ],
+ "type": "string"
+ },
+ "payment_process_invoice_timeframe": {
+ "enum": [
+ "days",
+ "weeks",
+ "months",
+ "quarters",
+ "years"
+ ],
+ "type": "string"
+ },
+ "payment_process_type": {
+ "enum": [
+ "automatic",
+ "invoice"
+ ],
+ "type": "string"
+ },
+ "pilot_period_description": {
+ "type": "string"
+ },
+ "pilot_period_fees_description": {
+ "type": "string"
+ },
+ "product_description": {
+ "type": "string"
+ },
+ "technical_support_description": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "psa_attributes": {
+ "additionalProperties": false,
+ "description": "Override psa terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "additional_changes": {
+ "type": "string"
+ },
+ "customer_description": {
+ "type": "string"
+ },
+ "effective_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "effective_date_type": {
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "type": "string"
+ },
+ "general_cap_amount": {
+ "type": "number"
+ },
+ "general_cap_amount_type": {
+ "enum": [
+ "preceding",
+ "base",
+ "period"
+ ],
+ "type": "string"
+ },
+ "general_cap_period_currency": {
+ "type": "number"
+ },
+ "general_cap_period_qty": {
+ "type": "number"
+ },
+ "general_cap_preceding_amount": {
+ "type": "number"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_additional_changes": {
+ "type": "boolean"
+ },
+ "include_additional_warranties": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_by_customer": {
+ "type": "string"
+ },
+ "include_additional_warranties_by_provider": {
+ "type": "string"
+ },
+ "include_additional_warranties_include_by_customer": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_include_by_provider": {
+ "type": "boolean"
+ },
+ "include_covered_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_customer_claims": {
+ "type": "string"
+ },
+ "include_covered_claims_include_customer_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_include_provider_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_provider_claims": {
+ "type": "string"
+ },
+ "include_customer_insurance_min": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_add_provider_com_gen_liability": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_add_provider_cyber_liability": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_add_provider_errors_omissions": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_auto_liability_aggregate": {
+ "type": "number"
+ },
+ "include_customer_insurance_min_auto_liability_minimum": {
+ "type": "number"
+ },
+ "include_customer_insurance_min_cyber_liability_aggregate": {
+ "type": "number"
+ },
+ "include_customer_insurance_min_cyber_liability_minimum": {
+ "type": "number"
+ },
+ "include_customer_insurance_min_employer_liability_aggregate": {
+ "type": "number"
+ },
+ "include_customer_insurance_min_employer_liability_minimum": {
+ "type": "number"
+ },
+ "include_customer_insurance_min_general_liability_aggregate": {
+ "type": "number"
+ },
+ "include_customer_insurance_min_general_liability_minimum": {
+ "type": "number"
+ },
+ "include_customer_insurance_min_include_add_provider": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_include_auto_liability": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_include_cyber_liability": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_include_employer_liability": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_include_general_liability": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_include_workers_comp": {
+ "type": "boolean"
+ },
+ "include_customer_policies": {
+ "type": "boolean"
+ },
+ "include_customer_policies_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_customer_policies_location": {
+ "type": "string"
+ },
+ "include_customer_policies_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_dpa": {
+ "type": "boolean"
+ },
+ "include_dpa_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_dpa_location": {
+ "type": "string"
+ },
+ "include_dpa_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_increased_cap_amount": {
+ "type": "boolean"
+ },
+ "include_increased_claims": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_confidentiality": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_confidentiality_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_privsec": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_privsec_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_other": {
+ "type": "boolean"
+ },
+ "include_increased_claims_indemnification_obligation": {
+ "type": "boolean"
+ },
+ "include_increased_claims_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_other": {
+ "type": "string"
+ },
+ "include_provider_insurance_min": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_add_customer_com_gen_liability": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_add_customer_cyber_liability": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_add_customer_errors_omissions": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_auto_liability_aggregate": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_auto_liability_minimum": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_cyber_liability_aggregate": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_cyber_liability_minimum": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_employer_liability_aggregate": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_employer_liability_minimum": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_general_liability_aggregate": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_general_liability_minimum": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_include_add_customer": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_include_auto_liability": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_include_cyber_liability": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_include_employer_liability": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_include_general_liability": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_include_workers_comp": {
+ "type": "boolean"
+ },
+ "include_publicity_rights": {
+ "type": "boolean"
+ },
+ "include_publicity_rights_type": {
+ "enum": [
+ "public",
+ "non-public"
+ ],
+ "type": "string"
+ },
+ "include_security_policy": {
+ "type": "boolean"
+ },
+ "include_security_policy_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_security_policy_fedramp_auth": {
+ "type": "boolean"
+ },
+ "include_security_policy_hitrust": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_annual_maintenance": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_other": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_other_val": {
+ "type": "string"
+ },
+ "include_security_policy_iso27001": {
+ "type": "boolean"
+ },
+ "include_security_policy_location": {
+ "type": "string"
+ },
+ "include_security_policy_pci1": {
+ "type": "boolean"
+ },
+ "include_security_policy_pci2": {
+ "type": "boolean"
+ },
+ "include_security_policy_penetration_testing": {
+ "type": "boolean"
+ },
+ "include_security_policy_soc2_type1": {
+ "type": "boolean"
+ },
+ "include_security_policy_soc2_type2": {
+ "type": "boolean"
+ },
+ "include_security_policy_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_unlimited_claims": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_confidentiality": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_confidentiality_negligence": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_privsec": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_privsec_negligence": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_include_other": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_indemnification_obligation": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_negligence": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_other": {
+ "type": "string"
+ },
+ "increased_cap_amount_currency": {
+ "type": "number"
+ },
+ "increased_cap_amount_period_currency": {
+ "type": "number"
+ },
+ "increased_cap_amount_period_qty": {
+ "type": "number"
+ },
+ "increased_cap_amount_qty": {
+ "type": "number"
+ },
+ "increased_cap_amount_type": {
+ "enum": [
+ "qty",
+ "currency",
+ "period"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "psa_statement_of_work_attributes": {
+ "additionalProperties": false,
+ "description": "Override psa statement of work terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "additional_changes": {
+ "type": "string"
+ },
+ "cost": {
+ "type": "number"
+ },
+ "description": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "fees_attributes": {
+ "additionalProperties": {
+ "anyOf": [
+ {
+ "additionalProperties": false,
+ "description": "Fees::Flat (fee_type \"flat\"). A fixed recurring fee, e.g. a platform subscription. Set type to \"Fees::Flat\" or fee_type to \"flat\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Fixed amount in the order form's fees_currency, charged per fee_period. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"flat\". Alternative to type.",
+ "enum": [
+ "flat"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Flat\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Flat"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Discount (fee_type \"discount\"). A discount, as a fixed amount or a percentage, applied forever, once, or for a number of months. Set type to \"Fees::Discount\" or fee_type to \"discount\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Discount size: an amount in fees_currency when discount_type is fixed_amount (a plain amount, not cents: 20 means 20.00), or a percentage (e.g. 10 for 10%) when it is percentage.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "discount_duration_amount": {
+ "description": "Number of months the discount applies. Required when discount_duration_type is multiple_months.",
+ "type": "number"
+ },
+ "discount_duration_type": {
+ "description": "How long the discount applies. multiple_months also needs discount_duration_amount.",
+ "enum": [
+ "forever",
+ "once",
+ "multiple_months"
+ ],
+ "type": "string"
+ },
+ "discount_type": {
+ "description": "Whether cost is a currency amount or a percentage.",
+ "enum": [
+ "fixed_amount",
+ "percentage"
+ ],
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"discount\". Alternative to type.",
+ "enum": [
+ "discount"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Discount\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Discount"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Cost (fee_type \"cost\"). A per-unit fee: price per unit times quantity, e.g. seats. Set type to \"Fees::Cost\" or fee_type to \"cost\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Price per unit in fees_currency. The row total is quantity x cost. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"cost\". Alternative to type.",
+ "enum": [
+ "cost"
+ ],
+ "type": "string"
+ },
+ "quantity": {
+ "description": "Number of units.",
+ "type": "number"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Cost\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Cost"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Attachment (fee_type \"attachment\"). A fee described in an uploaded attachment instead of in the table. Set type to \"Fees::Attachment\" or fee_type to \"attachment\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "attachment_id": {
+ "description": "ID of an attachment uploaded with upload-attachment.",
+ "type": "string"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"attachment\". Alternative to type.",
+ "enum": [
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Attachment\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Attachment"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Graduated (fee_type \"graduated\"). Tiered pricing, with the price set per tier in graduated_fee_tiers_attributes. Set type to \"Fees::Graduated\" or fee_type to \"graduated\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"graduated\". Alternative to type.",
+ "enum": [
+ "graduated"
+ ],
+ "type": "string"
+ },
+ "graduated_fee_tiers_attributes": {
+ "additionalProperties": {
+ "additionalProperties": false,
+ "properties": {
+ "flat_price": {
+ "type": "number"
+ },
+ "price_per_unit": {
+ "type": "string"
+ },
+ "upper_limit": {
+ "type": "number"
+ }
+ },
+ "type": "object"
+ },
+ "description": "Graduated fee tiers. Use string keys such as \"0\", \"1\".",
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Graduated\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Graduated"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Included (fee_type \"included\"). An item included at no charge. Set type to \"Fees::Included\" or fee_type to \"included\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"included\". Alternative to type.",
+ "enum": [
+ "included"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Included\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Included"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Metered (fee_type \"metered\"). Usage-based pricing, billed per unit used. Set type to \"Fees::Metered\" or fee_type to \"metered\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Price per unit of usage in fees_currency. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"metered\". Alternative to type.",
+ "enum": [
+ "metered"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Metered\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Metered"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::OneTime (fee_type \"one_time\"). A one-time charge, such as a setup fee. Set type to \"Fees::OneTime\" or fee_type to \"one_time\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "One-time amount in fees_currency, charged once rather than per fee_period. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"one_time\". Alternative to type.",
+ "enum": [
+ "one_time"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::OneTime\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::OneTime"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Text (fee_type \"text\"). A fee term described in free text. Set type to \"Fees::Text\" or fee_type to \"text\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"text\". Alternative to type.",
+ "enum": [
+ "text"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Text\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Text"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ }
+ ]
+ },
+ "description": "Fee line items. Use string keys such as \"0\", \"1\". Replaces template fees when provided.",
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_additional_changes": {
+ "type": "boolean"
+ },
+ "include_customer_obligation": {
+ "type": "boolean"
+ },
+ "include_customer_obligation_val": {
+ "type": "string"
+ },
+ "include_deliverables": {
+ "type": "boolean"
+ },
+ "include_deliverables_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_deliverables_description": {
+ "type": "string"
+ },
+ "include_deliverables_include_acceptance": {
+ "type": "boolean"
+ },
+ "include_deliverables_include_attachment": {
+ "type": "boolean"
+ },
+ "include_deliverables_include_draft_deliverables": {
+ "type": "boolean"
+ },
+ "include_deliverables_rejection_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_deliverables_rejection_unit": {
+ "enum": [
+ "hours",
+ "days",
+ "weeks",
+ "months"
+ ],
+ "type": "string"
+ },
+ "include_deliverables_resubmission_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_deliverables_resubmission_unit": {
+ "enum": [
+ "hours",
+ "days",
+ "weeks",
+ "months"
+ ],
+ "type": "string"
+ },
+ "include_fees_other": {
+ "type": "boolean"
+ },
+ "include_fees_other_val": {
+ "type": "string"
+ },
+ "include_fees_table": {
+ "type": "boolean"
+ },
+ "include_fees_table_total": {
+ "type": "boolean"
+ },
+ "include_fees_travel": {
+ "type": "boolean"
+ },
+ "include_fees_travel_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_fees_travel_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_fees_travel_val": {
+ "type": "string"
+ },
+ "include_third_party_customer": {
+ "type": "boolean"
+ },
+ "include_third_party_include_description": {
+ "type": "boolean"
+ },
+ "include_third_party_include_description_val": {
+ "type": "string"
+ },
+ "include_third_party_materials": {
+ "type": "boolean"
+ },
+ "include_third_party_provider": {
+ "type": "boolean"
+ },
+ "include_time_of_assignment": {
+ "type": "boolean"
+ },
+ "include_time_of_assignment_type": {
+ "enum": [
+ "created",
+ "paid"
+ ],
+ "type": "string"
+ },
+ "invoice_period_description": {
+ "type": "string"
+ },
+ "negotiations_allowed": {
+ "description": "When true, the recipient can propose changes to the statement of work, even when the agreement-level `negotiations_allowed` is false. This only covers the statement of work.",
+ "type": "boolean"
+ },
+ "payment_period": {
+ "type": "number"
+ },
+ "payment_period_other": {
+ "type": "string"
+ },
+ "payment_period_timeframe": {
+ "enum": [
+ "receipt",
+ "invoice",
+ "Customer's receipt of invoice",
+ "date of invoice"
+ ],
+ "type": "string"
+ },
+ "payment_period_type": {
+ "enum": [
+ "standard",
+ "other"
+ ],
+ "type": "string"
+ },
+ "payment_period_unit": {
+ "enum": [
+ "day(s)",
+ "week(s)",
+ "month(s)",
+ "quarter(s)",
+ "year(s)"
+ ],
+ "type": "string"
+ },
+ "quantity": {
+ "type": "number"
+ },
+ "services_description": {
+ "type": "string"
+ },
+ "sow_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "sow_date_type": {
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "type": "string"
+ },
+ "sow_term_amount": {
+ "type": "number"
+ },
+ "sow_term_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "sow_term_type": {
+ "enum": [
+ "deliverables",
+ "period",
+ "date"
+ ],
+ "type": "string"
+ },
+ "sow_term_unit": {
+ "enum": [
+ "month(s)",
+ "quarter(s)",
+ "year(s)"
+ ],
+ "type": "string"
+ },
+ "type": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "recipient_email": {
+ "format": "email",
+ "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "recipient_name": {
+ "type": "string"
+ },
+ "recipient_notice_email_address": {
+ "description": "Email address for legal notices to the recipient.",
+ "format": "email",
+ "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "recipient_organization": {
+ "type": "string"
+ },
+ "recipient_role": {
+ "description": "PSA only. The recipient's role: `Customer` (the default) or `Provider`. Send it with `sender_role`; the two must be one `Provider` and one `Customer`. Other standard agreement types ignore it.",
+ "type": "string"
+ },
+ "sender_last_to_sign": {
+ "description": "When true, your signer signs after the recipient.",
+ "type": "boolean"
+ },
+ "sender_notice_email_address": {
+ "description": "Email address for legal notices to the sender.",
+ "format": "email",
+ "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "sender_role": {
+ "description": "PSA only. Your company's role: `Provider` (the default) or `Customer` when you hire the recipient to provide the services. Send it with `recipient_role`; the two must be one `Provider` and one `Customer`. When reading a PSA, an empty `sender_role` means `Provider`. Other standard agreement types ignore it.",
+ "type": "string"
+ },
+ "software_license_attributes": {
+ "additionalProperties": false,
+ "description": "Override software license terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "effective_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "effective_date_type": {
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "type": "string"
+ },
+ "general_cap_amount": {
+ "type": "number"
+ },
+ "general_cap_amount_type": {
+ "enum": [
+ "preceding",
+ "base",
+ "period"
+ ],
+ "type": "string"
+ },
+ "general_cap_period_currency": {
+ "type": "number"
+ },
+ "general_cap_period_qty": {
+ "type": "number"
+ },
+ "general_cap_preceding_amount": {
+ "type": "number"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_additional_warranties": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_by_customer": {
+ "type": "string"
+ },
+ "include_additional_warranties_by_provider": {
+ "type": "string"
+ },
+ "include_additional_warranties_include_by_customer": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_include_by_provider": {
+ "type": "boolean"
+ },
+ "include_ai_addendum": {
+ "type": "boolean"
+ },
+ "include_ai_addendum_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_covered_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_customer_claims": {
+ "type": "string"
+ },
+ "include_covered_claims_include_customer_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_include_provider_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_provider_claims": {
+ "type": "string"
+ },
+ "include_dpa": {
+ "type": "boolean"
+ },
+ "include_dpa_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_dpa_location": {
+ "type": "string"
+ },
+ "include_dpa_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_increased_cap_amount": {
+ "type": "boolean"
+ },
+ "include_increased_claims": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_confidentiality": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_confidentiality_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_other": {
+ "type": "boolean"
+ },
+ "include_increased_claims_indemnification_obligation": {
+ "type": "boolean"
+ },
+ "include_increased_claims_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_other": {
+ "type": "string"
+ },
+ "include_increased_claims_restrictions": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_confidentiality": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_confidentiality_negligence": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_include_other": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_indemnification_obligation": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_license_or_restrictions": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_negligence": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_other": {
+ "type": "string"
+ },
+ "increased_cap_amount_currency": {
+ "type": "number"
+ },
+ "increased_cap_amount_period_currency": {
+ "type": "number"
+ },
+ "increased_cap_amount_period_qty": {
+ "type": "number"
+ },
+ "increased_cap_amount_qty": {
+ "type": "number"
+ },
+ "increased_cap_amount_type": {
+ "enum": [
+ "qty",
+ "currency",
+ "period"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "software_license_order_form_attributes": {
+ "additionalProperties": false,
+ "description": "Override software license order form terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "additional_changes": {
+ "type": "string"
+ },
+ "deletion_procedure_include_custom": {
+ "type": "boolean"
+ },
+ "deletion_procedure_include_custom_description": {
+ "type": "string"
+ },
+ "deletion_procedure_include_customer_disable": {
+ "type": "boolean"
+ },
+ "deletion_procedure_include_customer_proof": {
+ "type": "boolean"
+ },
+ "deletion_procedure_include_provider_disable": {
+ "type": "boolean"
+ },
+ "fee_custom_unit": {
+ "type": "string"
+ },
+ "fee_period": {
+ "enum": [
+ "Subscription Period",
+ "month",
+ "year",
+ "Custom unit"
+ ],
+ "type": "string"
+ },
+ "fees_attributes": {
+ "additionalProperties": {
+ "anyOf": [
+ {
+ "additionalProperties": false,
+ "description": "Fees::Flat (fee_type \"flat\"). A fixed recurring fee, e.g. a platform subscription. Set type to \"Fees::Flat\" or fee_type to \"flat\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Fixed amount in the order form's fees_currency, charged per fee_period. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"flat\". Alternative to type.",
+ "enum": [
+ "flat"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Flat\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Flat"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Discount (fee_type \"discount\"). A discount, as a fixed amount or a percentage, applied forever, once, or for a number of months. Set type to \"Fees::Discount\" or fee_type to \"discount\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Discount size: an amount in fees_currency when discount_type is fixed_amount (a plain amount, not cents: 20 means 20.00), or a percentage (e.g. 10 for 10%) when it is percentage.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "discount_duration_amount": {
+ "description": "Number of months the discount applies. Required when discount_duration_type is multiple_months.",
+ "type": "number"
+ },
+ "discount_duration_type": {
+ "description": "How long the discount applies. multiple_months also needs discount_duration_amount.",
+ "enum": [
+ "forever",
+ "once",
+ "multiple_months"
+ ],
+ "type": "string"
+ },
+ "discount_type": {
+ "description": "Whether cost is a currency amount or a percentage.",
+ "enum": [
+ "fixed_amount",
+ "percentage"
+ ],
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"discount\". Alternative to type.",
+ "enum": [
+ "discount"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Discount\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Discount"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Cost (fee_type \"cost\"). A per-unit fee: price per unit times quantity, e.g. seats. Set type to \"Fees::Cost\" or fee_type to \"cost\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Price per unit in fees_currency. The row total is quantity x cost. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"cost\". Alternative to type.",
+ "enum": [
+ "cost"
+ ],
+ "type": "string"
+ },
+ "quantity": {
+ "description": "Number of units.",
+ "type": "number"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Cost\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Cost"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Attachment (fee_type \"attachment\"). A fee described in an uploaded attachment instead of in the table. Set type to \"Fees::Attachment\" or fee_type to \"attachment\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "attachment_id": {
+ "description": "ID of an attachment uploaded with upload-attachment.",
+ "type": "string"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"attachment\". Alternative to type.",
+ "enum": [
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Attachment\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Attachment"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Graduated (fee_type \"graduated\"). Tiered pricing, with the price set per tier in graduated_fee_tiers_attributes. Set type to \"Fees::Graduated\" or fee_type to \"graduated\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"graduated\". Alternative to type.",
+ "enum": [
+ "graduated"
+ ],
+ "type": "string"
+ },
+ "graduated_fee_tiers_attributes": {
+ "additionalProperties": {
+ "additionalProperties": false,
+ "properties": {
+ "flat_price": {
+ "type": "number"
+ },
+ "price_per_unit": {
+ "type": "string"
+ },
+ "upper_limit": {
+ "type": "number"
+ }
+ },
+ "type": "object"
+ },
+ "description": "Graduated fee tiers. Use string keys such as \"0\", \"1\".",
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Graduated\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Graduated"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Included (fee_type \"included\"). An item included at no charge. Set type to \"Fees::Included\" or fee_type to \"included\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"included\". Alternative to type.",
+ "enum": [
+ "included"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Included\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Included"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Metered (fee_type \"metered\"). Usage-based pricing, billed per unit used. Set type to \"Fees::Metered\" or fee_type to \"metered\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Price per unit of usage in fees_currency. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"metered\". Alternative to type.",
+ "enum": [
+ "metered"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Metered\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Metered"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::OneTime (fee_type \"one_time\"). A one-time charge, such as a setup fee. Set type to \"Fees::OneTime\" or fee_type to \"one_time\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "One-time amount in fees_currency, charged once rather than per fee_period. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"one_time\". Alternative to type.",
+ "enum": [
+ "one_time"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::OneTime\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::OneTime"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Text (fee_type \"text\"). A fee term described in free text. Set type to \"Fees::Text\" or fee_type to \"text\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"text\". Alternative to type.",
+ "enum": [
+ "text"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Text\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Text"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ }
+ ]
+ },
+ "description": "Fee line items. Use string keys such as \"0\", \"1\". Replaces template fees when provided.",
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+ },
+ "fees_currency": {
+ "enum": [
+ "USD",
+ "EUR",
+ "GBP",
+ "CAD",
+ "AUD",
+ "SGD",
+ "ILS",
+ "JPY",
+ "CHF",
+ "HKD"
+ ],
+ "type": "string"
+ },
+ "fees_include_fee_increase_upon_renewal": {
+ "type": "boolean"
+ },
+ "fees_include_fee_increase_upon_renewal_fee": {
+ "type": "number"
+ },
+ "fees_include_fee_increase_upon_renewal_type": {
+ "enum": [
+ "will",
+ "may"
+ ],
+ "type": "string"
+ },
+ "fees_inclusive_of_taxes": {
+ "type": "boolean"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_additional_changes": {
+ "type": "boolean"
+ },
+ "include_license_compliance_verification": {
+ "type": "boolean"
+ },
+ "include_license_compliance_verification_description": {
+ "type": "string"
+ },
+ "include_license_limits": {
+ "type": "boolean"
+ },
+ "include_license_limits_description": {
+ "type": "string"
+ },
+ "include_payment_process_include_billing_email": {
+ "type": "boolean"
+ },
+ "include_pilot_period": {
+ "type": "boolean"
+ },
+ "include_pilot_period_duration_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_pilot_period_duration_type": {
+ "enum": [
+ "day",
+ "week",
+ "month"
+ ],
+ "type": "string"
+ },
+ "include_pilot_period_include_fees": {
+ "type": "boolean"
+ },
+ "include_pilot_period_include_fees_amount": {
+ "type": "number"
+ },
+ "include_pilot_period_include_modifications": {
+ "type": "boolean"
+ },
+ "include_pilot_period_include_modifications_description": {
+ "type": "string"
+ },
+ "include_services": {
+ "type": "boolean"
+ },
+ "include_services_description": {
+ "type": "string"
+ },
+ "negotiations_allowed": {
+ "description": "When true, the recipient can propose changes to the order form, even when the agreement-level `negotiations_allowed` is false. This only covers the order form.",
+ "type": "boolean"
+ },
+ "order_date_date": {
+ "type": "string"
+ },
+ "order_date_type": {
+ "enum": [
+ "signature",
+ "date",
+ "other"
+ ],
+ "type": "string"
+ },
+ "payment_process_automatic_frequency": {
+ "enum": [
+ "monthly",
+ "quarterly",
+ "semiannually",
+ "annually"
+ ],
+ "type": "string"
+ },
+ "payment_process_type": {
+ "enum": [
+ "automatic",
+ "invoice",
+ "custom"
+ ],
+ "type": "string"
+ },
+ "payment_process_type_custom_val": {
+ "type": "string"
+ },
+ "payment_process_type_invoice_amount": {
+ "type": "number"
+ },
+ "payment_process_type_invoice_custom_unit": {
+ "type": "string"
+ },
+ "payment_process_type_invoice_duration": {
+ "enum": [
+ "day",
+ "week",
+ "month",
+ "year",
+ "day(s)",
+ "week(s)",
+ "month(s)",
+ "year(s)"
+ ],
+ "type": "string"
+ },
+ "payment_process_type_invoice_duration_start": {
+ "enum": [
+ "Customer's receipt of invoice",
+ "date of invoice"
+ ],
+ "type": "string"
+ },
+ "payment_process_type_invoice_type": {
+ "enum": [
+ "monthly",
+ "quarterly",
+ "semiannually",
+ "annually",
+ "Custom unit"
+ ],
+ "type": "string"
+ },
+ "permitted_uses_include_custom": {
+ "type": "boolean"
+ },
+ "permitted_uses_include_custom_description": {
+ "type": "string"
+ },
+ "permitted_uses_include_customers_affiliates": {
+ "type": "boolean"
+ },
+ "permitted_uses_include_internal_business": {
+ "type": "boolean"
+ },
+ "pilot_period_stripe_product_id": {
+ "type": "string"
+ },
+ "software_description": {
+ "type": "string"
+ },
+ "subscription_auto_renew": {
+ "enum": [
+ "days",
+ "subscription_end"
+ ],
+ "type": "string"
+ },
+ "subscription_period": {
+ "type": "number"
+ },
+ "subscription_period_unit": {
+ "type": "string"
+ },
+ "subscription_renewal_notice_days": {
+ "type": "number"
+ },
+ "warranty_period_description_amount": {
+ "type": "number"
+ },
+ "warranty_period_description_duration": {
+ "enum": [
+ "day",
+ "week",
+ "month",
+ "year"
+ ],
+ "type": "string"
+ },
+ "warranty_period_description_duration_start": {
+ "enum": [
+ "initial delivery of the Software",
+ "delivery of the Software and each subsequent Update",
+ "the Order Date"
+ ],
+ "type": "string"
+ },
+ "warranty_period_type": {
+ "enum": [
+ "description",
+ "none"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "test_agreement": {
+ "description": "When true, marks the agreement as a test. Test agreements do not count against your monthly limit.",
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "recipient_name",
+ "recipient_email"
+ ],
+ "type": "object"
+ },
+ "cc_users": {
+ "items": {
+ "format": "email",
+ "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "draft": {
+ "description": "When true, the agreement is saved as a draft and not sent to the recipient. Use POST /v1/agreements/{id}/send to send a draft agreement later.",
+ "type": "boolean"
+ },
+ "owner_email": {
+ "description": "Email address of the agreement owner (sender).",
+ "type": "string"
+ },
+ "signer_id": {
+ "description": "User id of the signer from the owner's organization.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "template_id": {
+ "description": "UUID of a template from `GET /v1/templates`. Accepts both Common Paper standard templates and uploaded PDF templates (`type` `uploaded_template`).",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ }
+ },
+ "required": [
+ "template_id",
+ "owner_email",
+ "signer_id",
+ "agreement"
+ ],
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "agreement": {
+ "additionalProperties": {},
+ "properties": {
+ "amendment_attributes": {
+ "additionalProperties": false,
+ "description": "Override amendment terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "amended_terms_attributes": {
+ "additionalProperties": {
+ "additionalProperties": false,
+ "properties": {
+ "description": {
+ "type": "string"
+ },
+ "term": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "description": "Amended terms. Use string keys such as \"0\", \"1\".",
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+ },
+ "amendment_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "amendment_date_type": {
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "type": "string"
+ },
+ "framework_terms_type": {
+ "type": "string"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "parent_agreement_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "underlying_agreement_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "underlying_agreement_type": {
+ "type": "string"
+ },
+ "underlying_agreement_val": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "baa_attributes": {
+ "additionalProperties": false,
+ "description": "Override baa terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "aggregation_limitations_permitted": {
+ "type": "boolean"
+ },
+ "aggregation_limitations_permitted_val": {
+ "type": "string"
+ },
+ "breach_notification_unit": {
+ "enum": [
+ "hours",
+ "business days",
+ "calendar days"
+ ],
+ "type": "string"
+ },
+ "breach_notification_val": {
+ "type": "number"
+ },
+ "business_associate_relationship_type": {
+ "enum": [
+ "provider",
+ "company"
+ ],
+ "type": "string"
+ },
+ "deidentification_limitations_include_purpose": {
+ "type": "boolean"
+ },
+ "deidentification_limitations_include_requirements": {
+ "type": "boolean"
+ },
+ "deidentification_limitations_permitted": {
+ "type": "boolean"
+ },
+ "deidentification_limitations_purpose_val": {
+ "type": "string"
+ },
+ "deidentification_limitations_requirements_val": {
+ "type": "string"
+ },
+ "designated_record_set_provider_maintains": {
+ "type": "boolean"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_aggregation_limitations": {
+ "type": "boolean"
+ },
+ "include_deidentification_limitations": {
+ "type": "boolean"
+ },
+ "include_limitations": {
+ "type": "boolean"
+ },
+ "include_offshore_limitations": {
+ "type": "boolean"
+ },
+ "include_subcontract_limitations": {
+ "type": "boolean"
+ },
+ "offshore_limitations_permitted": {
+ "type": "boolean"
+ },
+ "offshore_limitations_permitted_val": {
+ "type": "string"
+ },
+ "subcontract_limitations_include_notice": {
+ "type": "boolean"
+ },
+ "subcontract_limitations_include_permission": {
+ "type": "boolean"
+ },
+ "subcontract_limitations_notice_val": {
+ "type": "string"
+ },
+ "subcontract_limitations_permission_val": {
+ "type": "string"
+ },
+ "subcontract_limitations_permitted": {
+ "type": "boolean"
+ },
+ "underlying_agreement_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "underlying_agreement_type": {
+ "enum": [
+ "internal",
+ "external",
+ "none"
+ ],
+ "type": "string"
+ },
+ "underlying_agreement_val": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "billing_email": {
+ "description": "Email of the billing contact. Used when include_billing_info is true.",
+ "format": "email",
+ "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "billing_name": {
+ "description": "Name of the billing contact. Used when include_billing_info is true.",
+ "type": "string"
+ },
+ "billing_workflow_type": {
+ "description": "The type of billing workflow. Use \"link\" to provide a payment_link_url, or \"stripe\" for Stripe-managed billing.",
+ "enum": [
+ "link",
+ "stripe"
+ ],
+ "type": "string"
+ },
+ "chosen_courts_country": {
+ "description": "The country in which disputes will be resolved.",
+ "type": "string"
+ },
+ "chosen_courts_region": {
+ "description": "The state or region in which disputes will be resolved.",
+ "type": "string"
+ },
+ "csa_attributes": {
+ "additionalProperties": false,
+ "description": "Override csa terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "customer_description": {
+ "type": "string"
+ },
+ "effective_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "effective_date_marketplace": {
+ "enum": [
+ "AWS",
+ "GCP",
+ "Azure"
+ ],
+ "type": "string"
+ },
+ "effective_date_type": {
+ "enum": [
+ "signature",
+ "date",
+ "marketplace_acceptance"
+ ],
+ "type": "string"
+ },
+ "general_cap_amount": {
+ "type": "number"
+ },
+ "general_cap_amount_type": {
+ "enum": [
+ "preceding",
+ "base",
+ "period"
+ ],
+ "type": "string"
+ },
+ "general_cap_period_currency": {
+ "type": "number"
+ },
+ "general_cap_period_qty": {
+ "type": "number"
+ },
+ "general_cap_preceding_amount": {
+ "type": "number"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_acceptable_use_policy": {
+ "type": "boolean"
+ },
+ "include_acceptable_use_policy_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_acceptable_use_policy_location": {
+ "type": "string"
+ },
+ "include_acceptable_use_policy_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_additional_warranties": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_by_customer": {
+ "type": "string"
+ },
+ "include_additional_warranties_by_provider": {
+ "type": "string"
+ },
+ "include_additional_warranties_include_by_customer": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_include_by_provider": {
+ "type": "boolean"
+ },
+ "include_ai_addendum": {
+ "type": "boolean"
+ },
+ "include_ai_addendum_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_covered_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_customer_claims": {
+ "type": "string"
+ },
+ "include_covered_claims_include_customer_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_include_provider_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_provider_claims": {
+ "type": "string"
+ },
+ "include_dpa": {
+ "type": "boolean"
+ },
+ "include_dpa_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_dpa_location": {
+ "type": "string"
+ },
+ "include_dpa_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_increased_cap_amount": {
+ "type": "boolean"
+ },
+ "include_increased_claims": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_confidentiality": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_confidentiality_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_privsec": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_privsec_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_other": {
+ "type": "boolean"
+ },
+ "include_increased_claims_indemnification_obligation": {
+ "type": "boolean"
+ },
+ "include_increased_claims_other": {
+ "type": "string"
+ },
+ "include_insurance_minimums": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_add_customer": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_add_customer_com_gen_liability": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_add_customer_cyber_liability": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_add_customer_errors_omissions": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_additional_information": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_additional_information_text": {
+ "type": "string"
+ },
+ "include_insurance_minimums_cyber_liability_aggregate": {
+ "type": "number"
+ },
+ "include_insurance_minimums_cyber_liability_minimum": {
+ "type": "number"
+ },
+ "include_insurance_minimums_employer_liability_aggregate": {
+ "type": "number"
+ },
+ "include_insurance_minimums_employer_liability_minimum": {
+ "type": "number"
+ },
+ "include_insurance_minimums_general_liability_aggregate": {
+ "type": "number"
+ },
+ "include_insurance_minimums_general_liability_minimum": {
+ "type": "number"
+ },
+ "include_insurance_minimums_include_cyber_liability": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_include_employer_liability": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_include_general_liability": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_include_workers_compensation": {
+ "type": "boolean"
+ },
+ "include_publicity_rights": {
+ "type": "boolean"
+ },
+ "include_publicity_rights_type": {
+ "enum": [
+ "public",
+ "non-public"
+ ],
+ "type": "string"
+ },
+ "include_security_policy": {
+ "type": "boolean"
+ },
+ "include_security_policy_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_security_policy_fedramp_auth": {
+ "type": "boolean"
+ },
+ "include_security_policy_hipaa": {
+ "type": "boolean"
+ },
+ "include_security_policy_hitrust": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_annual_maintenance": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_location": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_other": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_reasonable_efforts": {
+ "type": "boolean"
+ },
+ "include_security_policy_iso27001": {
+ "type": "boolean"
+ },
+ "include_security_policy_location": {
+ "type": "string"
+ },
+ "include_security_policy_other": {
+ "type": "string"
+ },
+ "include_security_policy_pci1": {
+ "type": "boolean"
+ },
+ "include_security_policy_pci2": {
+ "type": "boolean"
+ },
+ "include_security_policy_penetration_testing": {
+ "type": "boolean"
+ },
+ "include_security_policy_soc2": {
+ "type": "boolean"
+ },
+ "include_security_policy_soc2_type2": {
+ "type": "boolean"
+ },
+ "include_security_policy_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_supercap": {
+ "description": "CSA 3.0 renamed `include_increased_cap_amount` to `include_supercap`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_increased_cap_amount`. Sending the other spelling returns a 422.",
+ "type": "boolean"
+ },
+ "include_uncapped_claims": {
+ "description": "CSA 3.0 renamed `include_unlimited_claims` to `include_uncapped_claims`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims`. Sending the other spelling returns a 422.",
+ "type": "boolean"
+ },
+ "include_uncapped_claims_breach_of_confidentiality": {
+ "description": "CSA 3.0 renamed `include_unlimited_claims_breach_of_confidentiality` to `include_uncapped_claims_breach_of_confidentiality`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_breach_of_confidentiality`. Sending the other spelling returns a 422.",
+ "type": "boolean"
+ },
+ "include_uncapped_claims_breach_of_confidentiality_negligence": {
+ "description": "CSA 3.0 renamed `include_unlimited_claims_breach_of_confidentiality_negligence` to `include_uncapped_claims_breach_of_confidentiality_negligence`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_breach_of_confidentiality_negligence`. Sending the other spelling returns a 422.",
+ "type": "boolean"
+ },
+ "include_uncapped_claims_breach_of_privsec": {
+ "description": "CSA 3.0 renamed `include_unlimited_claims_breach_of_privsec` to `include_uncapped_claims_breach_of_privsec`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_breach_of_privsec`. Sending the other spelling returns a 422.",
+ "type": "boolean"
+ },
+ "include_uncapped_claims_breach_of_privsec_negligence": {
+ "description": "CSA 3.0 renamed `include_unlimited_claims_breach_of_privsec_negligence` to `include_uncapped_claims_breach_of_privsec_negligence`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_breach_of_privsec_negligence`. Sending the other spelling returns a 422.",
+ "type": "boolean"
+ },
+ "include_uncapped_claims_include_other": {
+ "description": "CSA 3.0 renamed `include_unlimited_claims_include_other` to `include_uncapped_claims_include_other`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_include_other`. Sending the other spelling returns a 422.",
+ "type": "boolean"
+ },
+ "include_uncapped_claims_indemnification_obligation": {
+ "description": "CSA 3.0 renamed `include_unlimited_claims_indemnification_obligation` to `include_uncapped_claims_indemnification_obligation`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_indemnification_obligation`. Sending the other spelling returns a 422.",
+ "type": "boolean"
+ },
+ "include_uncapped_claims_other": {
+ "description": "CSA 3.0 renamed `include_unlimited_claims_other` to `include_uncapped_claims_other`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_other`. Sending the other spelling returns a 422.",
+ "type": "boolean"
+ },
+ "include_unlimited_claims": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_confidentiality": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_confidentiality_negligence": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_privsec": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_privsec_negligence": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_include_other": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_indemnification_obligation": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_other": {
+ "type": "string"
+ },
+ "increased_cap_amount_currency": {
+ "type": "number"
+ },
+ "increased_cap_amount_period_currency": {
+ "type": "number"
+ },
+ "increased_cap_amount_period_qty": {
+ "type": "number"
+ },
+ "increased_cap_amount_qty": {
+ "type": "number"
+ },
+ "increased_cap_amount_type": {
+ "enum": [
+ "qty",
+ "currency",
+ "period"
+ ],
+ "type": "string"
+ },
+ "provider": {
+ "type": "string"
+ },
+ "supercap_currency": {
+ "description": "CSA 3.0 renamed `increased_cap_amount_currency` to `supercap_currency`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `increased_cap_amount_currency`. Sending the other spelling returns a 422.",
+ "type": "number"
+ },
+ "supercap_period_currency": {
+ "description": "CSA 3.0 renamed `increased_cap_amount_period_currency` to `supercap_period_currency`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `increased_cap_amount_period_currency`. Sending the other spelling returns a 422.",
+ "type": "number"
+ },
+ "supercap_period_qty": {
+ "description": "CSA 3.0 renamed `increased_cap_amount_period_qty` to `supercap_period_qty`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `increased_cap_amount_period_qty`. Sending the other spelling returns a 422.",
+ "type": "number"
+ },
+ "supercap_qty": {
+ "description": "CSA 3.0 renamed `increased_cap_amount_qty` to `supercap_qty`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `increased_cap_amount_qty`. Sending the other spelling returns a 422.",
+ "type": "number"
+ },
+ "supercap_type": {
+ "description": "CSA 3.0 renamed `increased_cap_amount_type` to `supercap_type`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `increased_cap_amount_type`. Sending the other spelling returns a 422.",
+ "type": "number"
+ }
+ },
+ "type": "object"
+ },
+ "csa_order_form_attributes": {
+ "additionalProperties": false,
+ "description": "Override csa order form terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "additional_changes": {
+ "type": "string"
+ },
+ "additional_parameters_or_limitations": {
+ "type": "string"
+ },
+ "affiliates_as_users": {
+ "type": "boolean"
+ },
+ "cloud_service_description": {
+ "type": "string"
+ },
+ "consumption_units": {
+ "type": "string"
+ },
+ "fee_amount": {
+ "type": "number"
+ },
+ "fee_custom_unit": {
+ "type": "string"
+ },
+ "fee_period": {
+ "enum": [
+ "Subscription Period",
+ "month",
+ "year",
+ "User",
+ "Custom unit"
+ ],
+ "type": "string"
+ },
+ "fees_attributes": {
+ "additionalProperties": {
+ "anyOf": [
+ {
+ "additionalProperties": false,
+ "description": "Fees::Flat (fee_type \"flat\"). A fixed recurring fee, e.g. a platform subscription. Set type to \"Fees::Flat\" or fee_type to \"flat\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Fixed amount in the order form's fees_currency, charged per fee_period. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"flat\". Alternative to type.",
+ "enum": [
+ "flat"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Flat\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Flat"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Discount (fee_type \"discount\"). A discount, as a fixed amount or a percentage, applied forever, once, or for a number of months. Set type to \"Fees::Discount\" or fee_type to \"discount\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Discount size: an amount in fees_currency when discount_type is fixed_amount (a plain amount, not cents: 20 means 20.00), or a percentage (e.g. 10 for 10%) when it is percentage.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "discount_duration_amount": {
+ "description": "Number of months the discount applies. Required when discount_duration_type is multiple_months.",
+ "type": "number"
+ },
+ "discount_duration_type": {
+ "description": "How long the discount applies. multiple_months also needs discount_duration_amount.",
+ "enum": [
+ "forever",
+ "once",
+ "multiple_months"
+ ],
+ "type": "string"
+ },
+ "discount_type": {
+ "description": "Whether cost is a currency amount or a percentage.",
+ "enum": [
+ "fixed_amount",
+ "percentage"
+ ],
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"discount\". Alternative to type.",
+ "enum": [
+ "discount"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Discount\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Discount"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Cost (fee_type \"cost\"). A per-unit fee: price per unit times quantity, e.g. seats. Set type to \"Fees::Cost\" or fee_type to \"cost\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Price per unit in fees_currency. The row total is quantity x cost. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"cost\". Alternative to type.",
+ "enum": [
+ "cost"
+ ],
+ "type": "string"
+ },
+ "quantity": {
+ "description": "Number of units.",
+ "type": "number"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Cost\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Cost"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Attachment (fee_type \"attachment\"). A fee described in an uploaded attachment instead of in the table. Set type to \"Fees::Attachment\" or fee_type to \"attachment\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "attachment_id": {
+ "description": "ID of an attachment uploaded with upload-attachment.",
+ "type": "string"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"attachment\". Alternative to type.",
+ "enum": [
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Attachment\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Attachment"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Graduated (fee_type \"graduated\"). Tiered pricing, with the price set per tier in graduated_fee_tiers_attributes. Set type to \"Fees::Graduated\" or fee_type to \"graduated\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"graduated\". Alternative to type.",
+ "enum": [
+ "graduated"
+ ],
+ "type": "string"
+ },
+ "graduated_fee_tiers_attributes": {
+ "additionalProperties": {
+ "additionalProperties": false,
+ "properties": {
+ "flat_price": {
+ "type": "number"
+ },
+ "price_per_unit": {
+ "type": "string"
+ },
+ "upper_limit": {
+ "type": "number"
+ }
+ },
+ "type": "object"
+ },
+ "description": "Graduated fee tiers. Use string keys such as \"0\", \"1\".",
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Graduated\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Graduated"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Included (fee_type \"included\"). An item included at no charge. Set type to \"Fees::Included\" or fee_type to \"included\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"included\". Alternative to type.",
+ "enum": [
+ "included"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Included\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Included"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Metered (fee_type \"metered\"). Usage-based pricing, billed per unit used. Set type to \"Fees::Metered\" or fee_type to \"metered\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Price per unit of usage in fees_currency. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"metered\". Alternative to type.",
+ "enum": [
+ "metered"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Metered\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Metered"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::OneTime (fee_type \"one_time\"). A one-time charge, such as a setup fee. Set type to \"Fees::OneTime\" or fee_type to \"one_time\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "One-time amount in fees_currency, charged once rather than per fee_period. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"one_time\". Alternative to type.",
+ "enum": [
+ "one_time"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::OneTime\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::OneTime"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Text (fee_type \"text\"). A fee term described in free text. Set type to \"Fees::Text\" or fee_type to \"text\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"text\". Alternative to type.",
+ "enum": [
+ "text"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Text\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Text"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ }
+ ]
+ },
+ "description": "Fee table rows, keyed by string index (\"0\", \"1\", ...). Replaces the template's fees when provided. Each row sets type or fee_type to pick the fee class. Amounts are in the order form's fees_currency and, for recurring fees, are charged per fee_period.",
+ "examples": [
+ {
+ "0": {
+ "cost": 2000,
+ "description": "Platform subscription",
+ "type": "Fees::Flat"
+ }
+ },
+ {
+ "0": {
+ "cost": 50,
+ "description": "Seats",
+ "fee_type": "cost",
+ "quantity": 10
+ },
+ "1": {
+ "cost": 10,
+ "description": "Launch discount",
+ "discount_duration_amount": 3,
+ "discount_duration_type": "multiple_months",
+ "discount_type": "percentage",
+ "fee_type": "discount"
+ }
+ }
+ ],
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+ },
+ "fees_currency": {
+ "enum": [
+ "USD",
+ "EUR",
+ "GBP",
+ "CAD",
+ "AUD",
+ "SGD",
+ "ILS",
+ "JPY",
+ "CHF",
+ "HKD"
+ ],
+ "type": "string"
+ },
+ "fees_include_fee_increase_upon_renewal": {
+ "type": "boolean"
+ },
+ "fees_include_fee_increase_upon_renewal_fee": {
+ "type": "number"
+ },
+ "fees_include_fee_increase_upon_renewal_type": {
+ "enum": [
+ "will",
+ "may"
+ ],
+ "type": "string"
+ },
+ "fees_inclusive_of_taxes": {
+ "type": "boolean"
+ },
+ "framework_terms_type": {
+ "enum": [
+ "new",
+ "existing",
+ "description"
+ ],
+ "type": "string"
+ },
+ "free_trial_days": {
+ "type": "number"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_additional_changes": {
+ "type": "boolean"
+ },
+ "include_additional_parameters_or_limitations": {
+ "type": "boolean"
+ },
+ "include_consumption": {
+ "type": "boolean"
+ },
+ "include_fees": {
+ "type": "boolean"
+ },
+ "include_fees_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_fees_include_attachment": {
+ "type": "boolean"
+ },
+ "include_fees_other": {
+ "type": "boolean"
+ },
+ "include_fees_other_val": {
+ "type": "string"
+ },
+ "include_fees_table": {
+ "type": "boolean"
+ },
+ "include_fees_table_period": {
+ "enum": [
+ "Subscription Period",
+ "month",
+ "year",
+ "User"
+ ],
+ "type": "string"
+ },
+ "include_free_trial": {
+ "type": "boolean"
+ },
+ "include_max_users": {
+ "type": "boolean"
+ },
+ "include_pilot_period": {
+ "type": "boolean"
+ },
+ "include_pilot_period_duration_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_pilot_period_duration_type": {
+ "enum": [
+ "day",
+ "week",
+ "month"
+ ],
+ "type": "string"
+ },
+ "include_pilot_period_include_fees": {
+ "type": "boolean"
+ },
+ "include_pilot_period_include_fees_amount": {
+ "type": "number"
+ },
+ "include_pilot_period_include_modifications": {
+ "type": "boolean"
+ },
+ "include_pilot_period_include_modifications_description": {
+ "type": "string"
+ },
+ "include_product_support": {
+ "type": "boolean"
+ },
+ "include_product_support_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_product_support_description": {
+ "type": "string"
+ },
+ "include_product_support_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_professional_services": {
+ "type": "boolean"
+ },
+ "include_professional_services_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_professional_services_custom_name": {
+ "type": "string"
+ },
+ "include_professional_services_description": {
+ "type": "string"
+ },
+ "include_professional_services_end_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "include_professional_services_fees_description": {
+ "type": "string"
+ },
+ "include_professional_services_include_end_date": {
+ "type": "boolean"
+ },
+ "include_professional_services_include_fees_description": {
+ "type": "boolean"
+ },
+ "include_professional_services_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_sla": {
+ "type": "boolean"
+ },
+ "include_sla_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_sla_description": {
+ "type": "string"
+ },
+ "include_sla_include_response_time": {
+ "type": "boolean"
+ },
+ "include_sla_include_response_time_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_sla_include_response_time_credit": {
+ "type": "number"
+ },
+ "include_sla_include_response_time_duration": {
+ "enum": [
+ "hour",
+ "day",
+ "week",
+ "month",
+ "hours"
+ ],
+ "type": "string"
+ },
+ "include_sla_include_response_time_support_channel": {
+ "type": "string"
+ },
+ "include_sla_include_target_uptime": {
+ "type": "boolean"
+ },
+ "include_sla_maintenance_notice": {
+ "type": "boolean"
+ },
+ "include_sla_maintenance_window": {
+ "type": "boolean"
+ },
+ "include_sla_maintenance_window_type": {
+ "enum": [
+ "standard",
+ "none"
+ ],
+ "type": "string"
+ },
+ "include_sla_standard_maintenance_notice_qty": {
+ "type": "number"
+ },
+ "include_sla_standard_maintenance_notice_unit": {
+ "enum": [
+ "hour",
+ "day",
+ "week",
+ "month"
+ ],
+ "type": "string"
+ },
+ "include_sla_standard_maintenance_window_end_time": {
+ "type": "string"
+ },
+ "include_sla_standard_maintenance_window_friday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_monday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_saturday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_start_time": {
+ "type": "string"
+ },
+ "include_sla_standard_maintenance_window_sunday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_thursday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_time_zone": {
+ "type": "string"
+ },
+ "include_sla_standard_maintenance_window_tuesday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_wednesday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_target_uptime": {
+ "type": "number"
+ },
+ "include_sla_type": {
+ "enum": [
+ "description",
+ "standard",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_subscription_start_date": {
+ "type": "boolean"
+ },
+ "include_subscription_start_date_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "include_usage_review": {
+ "type": "boolean"
+ },
+ "include_usage_review_val": {
+ "type": "string"
+ },
+ "include_use_limitations": {
+ "type": "boolean"
+ },
+ "include_use_limitations_val": {
+ "type": "string"
+ },
+ "invoice_period": {
+ "enum": [
+ "monthly",
+ "quarterly",
+ "semiannually",
+ "annually",
+ "Custom unit",
+ "Monthly",
+ "Quarterly",
+ "Semiannually",
+ "Annually"
+ ],
+ "type": "string"
+ },
+ "invoice_period_custom_unit": {
+ "type": "string"
+ },
+ "max_consumption": {
+ "type": "number"
+ },
+ "max_users": {
+ "type": "number"
+ },
+ "negotiations_allowed": {
+ "description": "When true, the recipient can propose changes to the order form, even when the agreement-level `negotiations_allowed` is false. This only covers the order form.",
+ "type": "boolean"
+ },
+ "order_date_date": {
+ "type": "string"
+ },
+ "order_date_other": {
+ "type": "string"
+ },
+ "order_date_type": {
+ "enum": [
+ "signature",
+ "date",
+ "other"
+ ],
+ "type": "string"
+ },
+ "payment_period": {
+ "type": "number"
+ },
+ "payment_period_timeframe": {
+ "enum": [
+ "Customer's receipt of invoice",
+ "date of invoice"
+ ],
+ "type": "string"
+ },
+ "payment_period_unit": {
+ "enum": [
+ "day(s)",
+ "week(s)",
+ "month(s)",
+ "marketplace_acceptance"
+ ],
+ "type": "string"
+ },
+ "payment_process_automatic_frequency": {
+ "enum": [
+ "monthly",
+ "quarterly",
+ "semiannually",
+ "annually"
+ ],
+ "type": "string"
+ },
+ "payment_process_type": {
+ "enum": [
+ "automatic",
+ "invoice",
+ "custom",
+ "marketplace_acceptance"
+ ],
+ "type": "string"
+ },
+ "payment_process_type_custom_val": {
+ "type": "string"
+ },
+ "payment_process_type_invoice_amount": {
+ "type": "number"
+ },
+ "payment_process_type_invoice_custom_unit": {
+ "type": "string"
+ },
+ "payment_process_type_invoice_duration": {
+ "enum": [
+ "day",
+ "week",
+ "month",
+ "year",
+ "day(s)",
+ "week(s)",
+ "month(s)",
+ "year(s)"
+ ],
+ "type": "string"
+ },
+ "payment_process_type_invoice_duration_start": {
+ "enum": [
+ "Customer's receipt of invoice",
+ "date of invoice"
+ ],
+ "type": "string"
+ },
+ "payment_process_type_invoice_type": {
+ "enum": [
+ "monthly",
+ "quarterly",
+ "semiannually",
+ "annually",
+ "Custom unit"
+ ],
+ "type": "string"
+ },
+ "pilot_period_stripe_product_id": {
+ "type": "string"
+ },
+ "service_credits_attributes": {
+ "additionalProperties": {
+ "additionalProperties": false,
+ "properties": {
+ "credit": {
+ "type": "number"
+ },
+ "max": {
+ "type": "number"
+ },
+ "min": {
+ "type": "number"
+ }
+ },
+ "type": "object"
+ },
+ "description": "Service credits. Use string keys such as \"0\", \"1\".",
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+ },
+ "subscription_auto_renew": {
+ "enum": [
+ "days",
+ "subscription_end"
+ ],
+ "type": "string"
+ },
+ "subscription_period": {
+ "type": "number"
+ },
+ "subscription_period_unit": {
+ "type": "string"
+ },
+ "subscription_renewal_notice_days": {
+ "type": "number"
+ },
+ "subscription_start_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "subscription_start_date_type": {
+ "enum": [
+ "effective_date",
+ "date"
+ ],
+ "type": "string"
+ },
+ "underlying_agreement_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "use_limitations_attributes": {
+ "additionalProperties": {
+ "additionalProperties": false,
+ "properties": {
+ "amount": {
+ "type": "number"
+ },
+ "limitation_type": {
+ "type": "string"
+ },
+ "unit": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "description": "Use limitations. Use string keys such as \"0\", \"1\".",
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+ }
+ },
+ "type": "object"
+ },
+ "custom_field_values": {
+ "description": "Values for a custom template's fields, keyed by the field keys defined in the template's YAML definition. Only used when template_id is a custom template. Template defaults fill any fields you omit; a required field with no default and no submitted value returns a 400 naming the field. Values are validated against the field's input type: select and radio values must be one of the field's options, multiselect values are an array of selections each of which must be one of the field's options, number and currency values must be numeric, date values must be YYYY-MM-DD, and email values must be valid addresses. An invalid value returns a 400 naming the field."
+ },
+ "design_partner_attributes": {
+ "additionalProperties": false,
+ "description": "Override design partner terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "customer_description": {
+ "type": "string"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_fees": {
+ "type": "boolean"
+ },
+ "include_fees_amount": {
+ "type": "number"
+ },
+ "include_fees_description": {
+ "type": "string"
+ },
+ "include_fees_pay_by_amount": {
+ "type": "string"
+ },
+ "include_fees_type": {
+ "enum": [
+ "default_language",
+ "description"
+ ],
+ "type": "string"
+ },
+ "include_fees_unit": {
+ "enum": [
+ "month",
+ "quarter",
+ "year",
+ "Term"
+ ],
+ "type": "string"
+ },
+ "include_program_appear_as_customer_private": {
+ "type": "boolean"
+ },
+ "include_program_appear_as_customer_public": {
+ "type": "boolean"
+ },
+ "include_program_case_study": {
+ "type": "boolean"
+ },
+ "include_program_develop_functionality": {
+ "type": "boolean"
+ },
+ "include_program_develop_functionality_val": {
+ "type": "string"
+ },
+ "include_program_discount": {
+ "type": "boolean"
+ },
+ "include_program_discount_amount": {
+ "type": "number"
+ },
+ "include_program_discount_unit": {
+ "enum": [
+ "U.S. Dollars",
+ "percent"
+ ],
+ "type": "string"
+ },
+ "include_program_participation_feedback": {
+ "type": "boolean"
+ },
+ "include_program_participation_feedback_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_program_participation_feedback_unit": {
+ "enum": [
+ "month",
+ "quarter",
+ "year",
+ "Term"
+ ],
+ "type": "string"
+ },
+ "include_program_partner_other": {
+ "type": "boolean"
+ },
+ "include_program_partner_other_val": {
+ "type": "string"
+ },
+ "include_program_provider_other": {
+ "type": "boolean"
+ },
+ "include_program_provider_other_val": {
+ "type": "string"
+ },
+ "include_program_reference": {
+ "type": "boolean"
+ },
+ "product_description": {
+ "type": "string"
+ },
+ "term_amount": {
+ "type": "number"
+ },
+ "term_unit": {
+ "enum": [
+ "day(s)",
+ "week(s)",
+ "month(s)",
+ "quarter(s)",
+ "year(s)"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "district_or_county": {
+ "description": "The district or county for dispute resolution.",
+ "type": "string"
+ },
+ "dpa_attributes": {
+ "additionalProperties": false,
+ "description": "Override dpa terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "approved_subprocessor_type": {
+ "description": "`internal` lists approved subprocessors in the agreement (`subprocessors_attributes`); `external` points to a list published elsewhere.",
+ "enum": [
+ "internal",
+ "external"
+ ],
+ "type": "string"
+ },
+ "cloud_service_product_name": {
+ "type": "string"
+ },
+ "competent_supervisory_authority": {
+ "type": "string"
+ },
+ "customer_description": {
+ "type": "string"
+ },
+ "data_exporter_address_city": {
+ "type": "string"
+ },
+ "data_exporter_address_country": {
+ "type": "string"
+ },
+ "data_exporter_address_state": {
+ "type": "string"
+ },
+ "data_exporter_address_street_address": {
+ "type": "string"
+ },
+ "data_exporter_address_zipcode": {
+ "type": "string"
+ },
+ "data_exporter_contact_details": {
+ "type": "string"
+ },
+ "data_exporter_contact_name": {
+ "type": "string"
+ },
+ "data_exporter_contact_position": {
+ "type": "string"
+ },
+ "data_exporter_role": {
+ "description": "Role of the data exporter. Overwritten to `Controller` when the agreement is created from a template.",
+ "enum": [
+ "Controller",
+ "Processor"
+ ],
+ "type": "string"
+ },
+ "data_importer_address": {
+ "type": "string"
+ },
+ "data_importer_address_city": {
+ "type": "string"
+ },
+ "data_importer_address_country": {
+ "type": "string"
+ },
+ "data_importer_address_state": {
+ "type": "string"
+ },
+ "data_importer_address_street_address": {
+ "type": "string"
+ },
+ "data_importer_address_zipcode": {
+ "type": "string"
+ },
+ "data_importer_contact_details": {
+ "type": "string"
+ },
+ "data_importer_contact_name": {
+ "type": "string"
+ },
+ "data_importer_contact_position": {
+ "type": "string"
+ },
+ "duration_of_processing": {
+ "type": "string"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_covered_claim": {
+ "type": "boolean"
+ },
+ "include_covered_claim_external_val": {
+ "type": "string"
+ },
+ "include_covered_claim_internal_val": {
+ "type": "string"
+ },
+ "include_covered_claim_type": {
+ "description": "Which covered-claim text applies: `internal` uses `include_covered_claim_internal_val`, `external` uses `include_covered_claim_external_val`. Required when `include_covered_claim` is true.",
+ "enum": [
+ "internal",
+ "external"
+ ],
+ "type": "string"
+ },
+ "include_data_subjects_custom": {
+ "type": "boolean"
+ },
+ "include_data_subjects_custom_val": {
+ "type": "string"
+ },
+ "include_data_subjects_employees": {
+ "type": "boolean"
+ },
+ "include_data_subjects_end_users": {
+ "type": "boolean"
+ },
+ "include_external_subprocessor_location": {
+ "type": "string"
+ },
+ "include_frequency_of_transfer_continuous": {
+ "type": "boolean"
+ },
+ "include_frequency_of_transfer_custom": {
+ "type": "boolean"
+ },
+ "include_frequency_of_transfer_custom_val": {
+ "type": "string"
+ },
+ "include_governing_country_eu": {
+ "type": "boolean"
+ },
+ "include_governing_country_eu_val": {
+ "type": "string"
+ },
+ "include_governing_country_uk": {
+ "type": "boolean"
+ },
+ "include_governing_country_uk_val": {
+ "type": "string"
+ },
+ "include_governing_law": {
+ "type": "boolean"
+ },
+ "include_governing_law_country": {
+ "type": "string"
+ },
+ "include_governing_law_state": {
+ "type": "string"
+ },
+ "include_increased_claim_amount": {
+ "description": "Legacy field. Stored but not shown on the DPA; use the `include_liability_cap*` fields instead.",
+ "type": "boolean"
+ },
+ "include_increased_claim_amount_currency": {
+ "description": "Legacy field. Stored but not shown on the DPA; use the `include_liability_cap*` fields instead."
+ },
+ "include_increased_claim_amount_qty": {
+ "description": "Legacy field. Stored but not shown on the DPA; use the `include_liability_cap*` fields instead."
+ },
+ "include_increased_claim_amount_type": {
+ "description": "Legacy field. Stored but not shown on the DPA; use the `include_liability_cap*` fields instead.",
+ "type": "string"
+ },
+ "include_liability_cap": {
+ "type": "boolean"
+ },
+ "include_liability_cap_amount_constant_external": {
+ "type": "string"
+ },
+ "include_liability_cap_amount_constant_internal": {
+ "type": "string"
+ },
+ "include_liability_cap_amount_currency_external": {
+ "description": "Currency amount. Numbers and numeric strings (commas allowed) are both accepted."
+ },
+ "include_liability_cap_amount_currency_internal": {
+ "description": "Currency amount. Numbers and numeric strings (commas allowed) are both accepted."
+ },
+ "include_liability_cap_csa_type": {
+ "description": "Which liability cap values apply: the `_internal` or `_external` amount fields. Required when `include_liability_cap` is true.",
+ "enum": [
+ "internal",
+ "external"
+ ],
+ "type": "string"
+ },
+ "include_personal_data_biographic_info": {
+ "type": "boolean"
+ },
+ "include_personal_data_contact_info": {
+ "type": "boolean"
+ },
+ "include_personal_data_custom": {
+ "type": "boolean"
+ },
+ "include_personal_data_custom_val": {
+ "type": "string"
+ },
+ "include_personal_data_employment_info": {
+ "type": "boolean"
+ },
+ "include_personal_data_financial_info": {
+ "type": "boolean"
+ },
+ "include_personal_data_location": {
+ "type": "boolean"
+ },
+ "include_personal_data_name": {
+ "type": "boolean"
+ },
+ "include_personal_data_transactional_info": {
+ "type": "boolean"
+ },
+ "include_personal_data_user_activity_info": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_custom": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_custom_val": {
+ "type": "string"
+ },
+ "include_processing_purpose_erasing": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_holding": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_protecting": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_receiving": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_returning": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_sharing": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_updating": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_using": {
+ "type": "boolean"
+ },
+ "include_provider_security_contact_address": {
+ "type": "boolean"
+ },
+ "include_provider_security_contact_address_city": {
+ "type": "string"
+ },
+ "include_provider_security_contact_address_country": {
+ "type": "string"
+ },
+ "include_provider_security_contact_address_state": {
+ "type": "string"
+ },
+ "include_provider_security_contact_address_street_address": {
+ "type": "string"
+ },
+ "include_provider_security_contact_address_zipcode": {
+ "type": "string"
+ },
+ "include_provider_security_contact_email": {
+ "type": "boolean"
+ },
+ "include_provider_security_contact_email_val": {
+ "format": "email",
+ "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "include_security_measures_accountability": {
+ "type": "boolean"
+ },
+ "include_security_measures_accountability_val": {
+ "type": "string"
+ },
+ "include_security_measures_certification_or_assurance": {
+ "type": "boolean"
+ },
+ "include_security_measures_certification_or_assurance_val": {
+ "type": "string"
+ },
+ "include_security_measures_confidentiality_integrity": {
+ "type": "boolean"
+ },
+ "include_security_measures_confidentiality_integrity_val": {
+ "type": "string"
+ },
+ "include_security_measures_data_at_rest": {
+ "type": "boolean"
+ },
+ "include_security_measures_data_at_rest_val": {
+ "type": "string"
+ },
+ "include_security_measures_data_minimization": {
+ "type": "boolean"
+ },
+ "include_security_measures_data_minimization_val": {
+ "type": "string"
+ },
+ "include_security_measures_data_quality": {
+ "type": "boolean"
+ },
+ "include_security_measures_data_quality_val": {
+ "type": "string"
+ },
+ "include_security_measures_data_retention": {
+ "type": "boolean"
+ },
+ "include_security_measures_data_retention_val": {
+ "type": "string"
+ },
+ "include_security_measures_data_transmission": {
+ "type": "boolean"
+ },
+ "include_security_measures_data_transmission_val": {
+ "type": "string"
+ },
+ "include_security_measures_event_logging": {
+ "type": "boolean"
+ },
+ "include_security_measures_event_logging_val": {
+ "type": "string"
+ },
+ "include_security_measures_identity_auth": {
+ "type": "boolean"
+ },
+ "include_security_measures_identity_auth_val": {
+ "type": "string"
+ },
+ "include_security_measures_it_security_governance": {
+ "type": "boolean"
+ },
+ "include_security_measures_it_security_governance_val": {
+ "type": "string"
+ },
+ "include_security_measures_physical_security": {
+ "type": "boolean"
+ },
+ "include_security_measures_physical_security_val": {
+ "type": "string"
+ },
+ "include_security_measures_portability_and_erasure": {
+ "type": "boolean"
+ },
+ "include_security_measures_portability_and_erasure_val": {
+ "type": "string"
+ },
+ "include_security_measures_pseudonym_encryption": {
+ "type": "boolean"
+ },
+ "include_security_measures_pseudonym_encryption_val": {
+ "type": "string"
+ },
+ "include_security_measures_restore_data_access": {
+ "type": "boolean"
+ },
+ "include_security_measures_restore_data_access_val": {
+ "type": "string"
+ },
+ "include_security_measures_security_policy": {
+ "type": "boolean"
+ },
+ "include_security_measures_system_configuration": {
+ "type": "boolean"
+ },
+ "include_security_measures_system_configuration_val": {
+ "type": "string"
+ },
+ "include_security_measures_testing_assessment": {
+ "type": "boolean"
+ },
+ "include_security_measures_testing_assessment_val": {
+ "type": "string"
+ },
+ "include_security_policy": {
+ "type": "boolean"
+ },
+ "include_security_policy_fedramp_auth": {
+ "type": "boolean"
+ },
+ "include_security_policy_hipaa": {
+ "type": "boolean"
+ },
+ "include_security_policy_hitrust": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_other": {
+ "type": "boolean"
+ },
+ "include_security_policy_iso27001": {
+ "type": "boolean"
+ },
+ "include_security_policy_other": {
+ "type": "string"
+ },
+ "include_security_policy_pci1": {
+ "type": "boolean"
+ },
+ "include_security_policy_pci2": {
+ "type": "boolean"
+ },
+ "include_security_policy_penetration_testing": {
+ "type": "boolean"
+ },
+ "include_security_policy_soc2": {
+ "type": "boolean"
+ },
+ "include_security_policy_soc2_type2": {
+ "type": "boolean"
+ },
+ "include_sensitive_data_restrictions_custom": {
+ "type": "boolean"
+ },
+ "include_sensitive_data_restrictions_custom_val": {
+ "type": "string"
+ },
+ "include_sensitive_data_restrictions_security_policy": {
+ "type": "boolean"
+ },
+ "include_service_provider_relationship": {
+ "type": "boolean"
+ },
+ "include_special_category_data": {
+ "type": "boolean"
+ },
+ "provider": {
+ "type": "string"
+ },
+ "security_policy_available_at": {
+ "type": "string"
+ },
+ "security_policy_type": {
+ "description": "Where the Security Policy is defined. For `external`, set `security_policy_available_at`.",
+ "enum": [
+ "defined in agreement",
+ "provider service",
+ "external"
+ ],
+ "type": "string"
+ },
+ "subprocessors_attributes": {
+ "additionalProperties": {
+ "additionalProperties": false,
+ "properties": {
+ "_destroy": {
+ "description": "Set to true with `id` to remove that subprocessor.",
+ "type": "boolean"
+ },
+ "country": {
+ "type": "string"
+ },
+ "id": {
+ "description": "ID of an existing subprocessor to update or remove. Omit to add a new subprocessor.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "processing_task": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "description": "Subprocessors, keyed by string index such as \"0\", \"1\". On create these are added to the template's subprocessors. On a draft update, an entry without `id` adds a new subprocessor; pass `id` to change one and `id` with `_destroy: true` to remove one.",
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+ },
+ "underlying_agreement_id": {
+ "description": "ID of the CSA this DPA supplements when `underlying_agreement_type` is `internal`.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "underlying_agreement_type": {
+ "description": "`internal` links a CSA in Common Paper (`underlying_agreement_id`, required); `external` describes another agreement in `underlying_agreement_val` (required). Defaults to `internal` when omitted on create.",
+ "enum": [
+ "internal",
+ "external"
+ ],
+ "type": "string"
+ },
+ "underlying_agreement_val": {
+ "description": "Description of the agreement this DPA supplements. Required when `underlying_agreement_type` is `external`.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "framework_terms_description": {
+ "description": "Custom framework terms description. Only used when framework_terms_type is \"description\".",
+ "type": "string"
+ },
+ "framework_terms_type": {
+ "description": "How framework terms are specified. Use \"new\" for standard terms or \"description\" to provide a custom framework_terms_description.",
+ "enum": [
+ "new",
+ "description"
+ ],
+ "type": "string"
+ },
+ "governing_law_country": {
+ "description": "The country whose laws govern the agreement.",
+ "type": "string"
+ },
+ "governing_law_region": {
+ "description": "The state or region whose laws govern the agreement.",
+ "type": "string"
+ },
+ "include_automated_payment_reminders": {
+ "description": "When true, automatically sends payment reminder emails.",
+ "type": "boolean"
+ },
+ "include_billing_info": {
+ "description": "When true, billing contact information (billing_name, billing_email) is included.",
+ "type": "boolean"
+ },
+ "include_billing_workflow": {
+ "description": "When true, enables a billing workflow after signing.",
+ "type": "boolean"
+ },
+ "include_expiration_date": {
+ "description": "Expiration date in YYYY-MM-DD format. Use when include_expiration_type is \"date\".",
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "include_expiration_days": {
+ "description": "Number of days until the agreement expires. Use when include_expiration_type is \"days\".",
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_expiration_type": {
+ "description": "How to set expiration: \"none\" (default), \"days\" (use include_expiration_days), or \"date\" (use include_expiration_date).",
+ "enum": [
+ "none",
+ "days",
+ "date"
+ ],
+ "type": "string"
+ },
+ "include_terms": {
+ "description": "When true, the standard terms are included with the agreement.",
+ "type": "boolean"
+ },
+ "loi_attributes": {
+ "additionalProperties": false,
+ "description": "Override loi terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "confidentiality_custom": {
+ "type": "string"
+ },
+ "confidentiality_mutual_include_loi": {
+ "type": "boolean"
+ },
+ "confidentiality_nda_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "confidentiality_nda_description": {
+ "type": "string"
+ },
+ "confidentiality_nda_include_loi": {
+ "type": "boolean"
+ },
+ "confidentiality_nda_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "confidentiality_type": {
+ "enum": [
+ "mutual",
+ "nda",
+ "provider",
+ "custom"
+ ],
+ "type": "string"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_custom_details": {
+ "type": "boolean"
+ },
+ "include_custom_details_val": {
+ "type": "string"
+ },
+ "include_fees": {
+ "type": "boolean"
+ },
+ "include_fees_amount": {
+ "type": "number"
+ },
+ "include_fees_amount_duration": {
+ "enum": [
+ "month",
+ "year",
+ "quarter"
+ ],
+ "type": "string"
+ },
+ "include_fees_include_amount": {
+ "type": "boolean"
+ },
+ "include_fees_include_other": {
+ "type": "boolean"
+ },
+ "include_fees_other": {
+ "type": "string"
+ },
+ "include_functionality": {
+ "type": "boolean"
+ },
+ "include_functionality_val": {
+ "type": "string"
+ },
+ "include_launch_date": {
+ "type": "boolean"
+ },
+ "include_launch_date_custom": {
+ "type": "string"
+ },
+ "include_launch_date_date": {
+ "format": "date-time",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$",
+ "type": "string"
+ },
+ "include_launch_date_type": {
+ "enum": [
+ "date",
+ "custom"
+ ],
+ "type": "string"
+ },
+ "product_name": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "manual_send": {
+ "description": "When true, the agreement is marked as manually sent outside the platform.",
+ "type": "boolean"
+ },
+ "message": {
+ "type": "string"
+ },
+ "negotiations_allowed": {
+ "description": "When true, the recipient can propose changes to the legal terms. For agreement types without separate business terms, that covers every term. CSA order forms, PSA statements of work, partnership business terms and software license order forms have their own `negotiations_allowed` flag.",
+ "type": "boolean"
+ },
+ "partnership_attributes": {
+ "additionalProperties": false,
+ "description": "Override partnership terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "effective_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "effective_date_type": {
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "type": "string"
+ },
+ "general_cap_amount_currency_val": {
+ "type": "number"
+ },
+ "general_cap_amount_either_currency": {
+ "type": "number"
+ },
+ "general_cap_amount_either_multiple": {
+ "type": "number"
+ },
+ "general_cap_amount_multiple_val": {
+ "type": "number"
+ },
+ "general_cap_amount_type": {
+ "enum": [
+ "multiple",
+ "currency",
+ "either",
+ "base"
+ ],
+ "type": "string"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_additional_warranties": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_include_company": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_include_company_val": {
+ "type": "string"
+ },
+ "include_additional_warranties_include_partner": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_include_partner_val": {
+ "type": "string"
+ },
+ "include_brand_guidelines": {
+ "type": "boolean"
+ },
+ "include_brand_guidelines_include_company": {
+ "type": "boolean"
+ },
+ "include_brand_guidelines_include_company_val": {
+ "type": "string"
+ },
+ "include_brand_guidelines_include_partner": {
+ "type": "boolean"
+ },
+ "include_brand_guidelines_include_partner_val": {
+ "type": "string"
+ },
+ "include_covered_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_company_claims": {
+ "type": "string"
+ },
+ "include_covered_claims_include_company_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_include_partner_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_partner_claims": {
+ "type": "string"
+ },
+ "include_dpa": {
+ "type": "boolean"
+ },
+ "include_dpa_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_dpa_location": {
+ "type": "string"
+ },
+ "include_dpa_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_increased_cap_amount": {
+ "type": "boolean"
+ },
+ "include_increased_cap_amount_currency": {
+ "type": "number"
+ },
+ "include_increased_cap_amount_either_currency": {
+ "type": "number"
+ },
+ "include_increased_cap_amount_either_multiple": {
+ "type": "string"
+ },
+ "include_increased_cap_amount_multiple": {
+ "type": "string"
+ },
+ "include_increased_cap_amount_type": {
+ "enum": [
+ "multiple",
+ "currency",
+ "either"
+ ],
+ "type": "string"
+ },
+ "include_increased_claims": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_confidentiality": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_confidentiality_misconduct": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_covered_claims": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_misconduct": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_other": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_other_val": {
+ "type": "string"
+ },
+ "include_unlimited_claims": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_confidentiality": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_confidentiality_misconduct": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_covered_claims": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_misconduct": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_other": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_other_val": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "partnership_business_terms_attributes": {
+ "additionalProperties": false,
+ "description": "Override partnership business terms terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "end_date_after_effective_date_amount": {
+ "type": "number"
+ },
+ "end_date_after_effective_date_unit": {
+ "enum": [
+ "month(s)",
+ "quarter(s)",
+ "year(s)"
+ ],
+ "type": "string"
+ },
+ "end_date_date": {
+ "type": "string"
+ },
+ "end_date_type": {
+ "enum": [
+ "date",
+ "effective date"
+ ],
+ "type": "string"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_obligations_company_brand": {
+ "type": "boolean"
+ },
+ "include_obligations_company_promotion": {
+ "type": "boolean"
+ },
+ "include_obligations_company_promotion_include_activities": {
+ "type": "boolean"
+ },
+ "include_obligations_company_promotion_include_activities_val": {
+ "type": "string"
+ },
+ "include_obligations_company_promotion_include_materials": {
+ "type": "boolean"
+ },
+ "include_obligations_company_promotion_include_materials_val": {
+ "type": "string"
+ },
+ "include_obligations_company_referral": {
+ "type": "boolean"
+ },
+ "include_obligations_company_referral_include_criteria": {
+ "type": "boolean"
+ },
+ "include_obligations_company_referral_include_criteria_val": {
+ "type": "string"
+ },
+ "include_obligations_company_referral_include_pay_sch": {
+ "type": "boolean"
+ },
+ "include_obligations_company_referral_include_pay_sch_amount": {
+ "type": "number"
+ },
+ "include_obligations_company_referral_include_pay_sch_custom": {
+ "type": "string"
+ },
+ "include_obligations_company_referral_include_pay_sch_unit": {
+ "enum": [
+ "U.S. Dollars",
+ "percent"
+ ],
+ "type": "string"
+ },
+ "include_obligations_company_sponsorship": {
+ "type": "boolean"
+ },
+ "include_obligations_company_sponsorship_include_benefits": {
+ "type": "boolean"
+ },
+ "include_obligations_company_sponsorship_include_benefits_val": {
+ "type": "string"
+ },
+ "include_obligations_company_sponsorship_include_payments": {
+ "type": "boolean"
+ },
+ "include_obligations_company_sponsorship_include_payments_amount": {
+ "type": "number"
+ },
+ "include_obligations_company_sponsorship_include_payments_unit": {
+ "enum": [
+ "U.S. Dollars",
+ "percent"
+ ],
+ "type": "string"
+ },
+ "include_obligations_partner_brand": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_promotion": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_promotion_include_activities": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_promotion_include_activities_val": {
+ "type": "string"
+ },
+ "include_obligations_partner_promotion_include_materials": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_promotion_include_materials_val": {
+ "type": "string"
+ },
+ "include_obligations_partner_referral": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_referral_include_criteria": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_referral_include_criteria_val": {
+ "type": "string"
+ },
+ "include_obligations_partner_referral_include_pay_sch": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_referral_include_pay_sch_amount": {
+ "type": "number"
+ },
+ "include_obligations_partner_referral_include_pay_sch_custom": {
+ "type": "string"
+ },
+ "include_obligations_partner_referral_include_pay_sch_unit": {
+ "enum": [
+ "U.S. Dollars",
+ "percent"
+ ],
+ "type": "string"
+ },
+ "include_obligations_partner_sponsorship": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_sponsorship_include_benefits": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_sponsorship_include_benefits_val": {
+ "type": "string"
+ },
+ "include_obligations_partner_sponsorship_include_payments": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_sponsorship_include_payments_amount": {
+ "type": "number"
+ },
+ "include_obligations_partner_sponsorship_include_payments_unit": {
+ "enum": [
+ "U.S. Dollars",
+ "percent"
+ ],
+ "type": "string"
+ },
+ "include_payment_process": {
+ "type": "boolean"
+ },
+ "include_payment_process_company": {
+ "type": "boolean"
+ },
+ "include_payment_process_company_include_address": {
+ "type": "boolean"
+ },
+ "include_payment_process_company_include_address_city": {
+ "type": "string"
+ },
+ "include_payment_process_company_include_address_country": {
+ "type": "string"
+ },
+ "include_payment_process_company_include_address_state": {
+ "type": "string"
+ },
+ "include_payment_process_company_include_address_street_address": {
+ "type": "string"
+ },
+ "include_payment_process_company_include_address_zipcode": {
+ "type": "string"
+ },
+ "include_payment_process_company_include_email": {
+ "type": "boolean"
+ },
+ "include_payment_process_company_include_email_val": {
+ "type": "string"
+ },
+ "include_payment_process_partner": {
+ "type": "boolean"
+ },
+ "include_payment_process_partner_include_address": {
+ "type": "boolean"
+ },
+ "include_payment_process_partner_include_address_city": {
+ "type": "string"
+ },
+ "include_payment_process_partner_include_address_country": {
+ "type": "string"
+ },
+ "include_payment_process_partner_include_address_state": {
+ "type": "string"
+ },
+ "include_payment_process_partner_include_address_street_address": {
+ "type": "string"
+ },
+ "include_payment_process_partner_include_address_zipcode": {
+ "type": "string"
+ },
+ "include_payment_process_partner_include_email": {
+ "type": "boolean"
+ },
+ "include_payment_process_partner_include_email_val": {
+ "type": "string"
+ },
+ "include_payment_schedule": {
+ "type": "boolean"
+ },
+ "include_payment_schedule_custom": {
+ "type": "string"
+ },
+ "include_payment_schedule_specified_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_payment_schedule_specified_timeframe": {
+ "enum": [
+ "receipt",
+ "date"
+ ],
+ "type": "string"
+ },
+ "include_payment_schedule_specified_unit": {
+ "enum": [
+ "day(s)",
+ "week(s)",
+ "month(s)",
+ "quarter(s)",
+ "year(s)"
+ ],
+ "type": "string"
+ },
+ "include_payment_schedule_type": {
+ "enum": [
+ "specified",
+ "custom"
+ ],
+ "type": "string"
+ },
+ "negotiations_allowed": {
+ "description": "When true, the recipient can propose changes to the business terms, even when the agreement-level `negotiations_allowed` is false. This only covers the business terms.",
+ "type": "boolean"
+ },
+ "territory_type": {
+ "enum": [
+ "worldwide",
+ "custom"
+ ],
+ "type": "string"
+ },
+ "territory_type_val": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "payment_link_url": {
+ "description": "A payment URL shown to the recipient after signing. Requires include_billing_workflow to be true and billing_workflow_type to be \"link\".",
+ "type": "string"
+ },
+ "pilot_attributes": {
+ "additionalProperties": false,
+ "description": "Override pilot terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "fees_type": {
+ "enum": [
+ "free",
+ "pilot_period_fees"
+ ],
+ "type": "string"
+ },
+ "general_cap_amount": {
+ "type": "number"
+ },
+ "general_cap_amount_type": {
+ "enum": [
+ "preceding",
+ "base",
+ "period"
+ ],
+ "type": "string"
+ },
+ "general_cap_period_currency": {
+ "type": "number"
+ },
+ "general_cap_period_qty": {
+ "type": "number"
+ },
+ "general_cap_preceding_amount": {
+ "type": "number"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_dpa": {
+ "type": "boolean"
+ },
+ "include_dpa_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_dpa_location": {
+ "type": "string"
+ },
+ "include_dpa_type": {
+ "enum": [
+ "description",
+ "attachment",
+ "standard"
+ ],
+ "type": "string"
+ },
+ "include_payment_process": {
+ "type": "boolean"
+ },
+ "include_technical_support": {
+ "type": "boolean"
+ },
+ "payment_process_automatic_frequency": {
+ "enum": [
+ "monthly",
+ "quarterly",
+ "annually",
+ "once_per_period"
+ ],
+ "type": "string"
+ },
+ "payment_process_invoice_days": {
+ "type": "number"
+ },
+ "payment_process_invoice_from": {
+ "enum": [
+ "receipt",
+ "date"
+ ],
+ "type": "string"
+ },
+ "payment_process_invoice_timeframe": {
+ "enum": [
+ "days",
+ "weeks",
+ "months",
+ "quarters",
+ "years"
+ ],
+ "type": "string"
+ },
+ "payment_process_type": {
+ "enum": [
+ "automatic",
+ "invoice"
+ ],
+ "type": "string"
+ },
+ "pilot_period_description": {
+ "type": "string"
+ },
+ "pilot_period_fees_description": {
+ "type": "string"
+ },
+ "product_description": {
+ "type": "string"
+ },
+ "technical_support_description": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "psa_attributes": {
+ "additionalProperties": false,
+ "description": "Override psa terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "additional_changes": {
+ "type": "string"
+ },
+ "customer_description": {
+ "type": "string"
+ },
+ "effective_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "effective_date_type": {
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "type": "string"
+ },
+ "general_cap_amount": {
+ "type": "number"
+ },
+ "general_cap_amount_type": {
+ "enum": [
+ "preceding",
+ "base",
+ "period"
+ ],
+ "type": "string"
+ },
+ "general_cap_period_currency": {
+ "type": "number"
+ },
+ "general_cap_period_qty": {
+ "type": "number"
+ },
+ "general_cap_preceding_amount": {
+ "type": "number"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_additional_changes": {
+ "type": "boolean"
+ },
+ "include_additional_warranties": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_by_customer": {
+ "type": "string"
+ },
+ "include_additional_warranties_by_provider": {
+ "type": "string"
+ },
+ "include_additional_warranties_include_by_customer": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_include_by_provider": {
+ "type": "boolean"
+ },
+ "include_covered_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_customer_claims": {
+ "type": "string"
+ },
+ "include_covered_claims_include_customer_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_include_provider_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_provider_claims": {
+ "type": "string"
+ },
+ "include_customer_insurance_min": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_add_provider_com_gen_liability": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_add_provider_cyber_liability": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_add_provider_errors_omissions": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_auto_liability_aggregate": {
+ "type": "number"
+ },
+ "include_customer_insurance_min_auto_liability_minimum": {
+ "type": "number"
+ },
+ "include_customer_insurance_min_cyber_liability_aggregate": {
+ "type": "number"
+ },
+ "include_customer_insurance_min_cyber_liability_minimum": {
+ "type": "number"
+ },
+ "include_customer_insurance_min_employer_liability_aggregate": {
+ "type": "number"
+ },
+ "include_customer_insurance_min_employer_liability_minimum": {
+ "type": "number"
+ },
+ "include_customer_insurance_min_general_liability_aggregate": {
+ "type": "number"
+ },
+ "include_customer_insurance_min_general_liability_minimum": {
+ "type": "number"
+ },
+ "include_customer_insurance_min_include_add_provider": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_include_auto_liability": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_include_cyber_liability": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_include_employer_liability": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_include_general_liability": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_include_workers_comp": {
+ "type": "boolean"
+ },
+ "include_customer_policies": {
+ "type": "boolean"
+ },
+ "include_customer_policies_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_customer_policies_location": {
+ "type": "string"
+ },
+ "include_customer_policies_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_dpa": {
+ "type": "boolean"
+ },
+ "include_dpa_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_dpa_location": {
+ "type": "string"
+ },
+ "include_dpa_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_increased_cap_amount": {
+ "type": "boolean"
+ },
+ "include_increased_claims": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_confidentiality": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_confidentiality_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_privsec": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_privsec_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_other": {
+ "type": "boolean"
+ },
+ "include_increased_claims_indemnification_obligation": {
+ "type": "boolean"
+ },
+ "include_increased_claims_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_other": {
+ "type": "string"
+ },
+ "include_provider_insurance_min": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_add_customer_com_gen_liability": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_add_customer_cyber_liability": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_add_customer_errors_omissions": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_auto_liability_aggregate": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_auto_liability_minimum": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_cyber_liability_aggregate": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_cyber_liability_minimum": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_employer_liability_aggregate": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_employer_liability_minimum": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_general_liability_aggregate": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_general_liability_minimum": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_include_add_customer": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_include_auto_liability": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_include_cyber_liability": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_include_employer_liability": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_include_general_liability": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_include_workers_comp": {
+ "type": "boolean"
+ },
+ "include_publicity_rights": {
+ "type": "boolean"
+ },
+ "include_publicity_rights_type": {
+ "enum": [
+ "public",
+ "non-public"
+ ],
+ "type": "string"
+ },
+ "include_security_policy": {
+ "type": "boolean"
+ },
+ "include_security_policy_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_security_policy_fedramp_auth": {
+ "type": "boolean"
+ },
+ "include_security_policy_hitrust": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_annual_maintenance": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_other": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_other_val": {
+ "type": "string"
+ },
+ "include_security_policy_iso27001": {
+ "type": "boolean"
+ },
+ "include_security_policy_location": {
+ "type": "string"
+ },
+ "include_security_policy_pci1": {
+ "type": "boolean"
+ },
+ "include_security_policy_pci2": {
+ "type": "boolean"
+ },
+ "include_security_policy_penetration_testing": {
+ "type": "boolean"
+ },
+ "include_security_policy_soc2_type1": {
+ "type": "boolean"
+ },
+ "include_security_policy_soc2_type2": {
+ "type": "boolean"
+ },
+ "include_security_policy_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_unlimited_claims": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_confidentiality": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_confidentiality_negligence": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_privsec": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_privsec_negligence": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_include_other": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_indemnification_obligation": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_negligence": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_other": {
+ "type": "string"
+ },
+ "increased_cap_amount_currency": {
+ "type": "number"
+ },
+ "increased_cap_amount_period_currency": {
+ "type": "number"
+ },
+ "increased_cap_amount_period_qty": {
+ "type": "number"
+ },
+ "increased_cap_amount_qty": {
+ "type": "number"
+ },
+ "increased_cap_amount_type": {
+ "enum": [
+ "qty",
+ "currency",
+ "period"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "psa_statement_of_work_attributes": {
+ "additionalProperties": false,
+ "description": "Override psa statement of work terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "additional_changes": {
+ "type": "string"
+ },
+ "cost": {
+ "type": "number"
+ },
+ "description": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "fees_attributes": {
+ "additionalProperties": {
+ "anyOf": [
+ {
+ "additionalProperties": false,
+ "description": "Fees::Flat (fee_type \"flat\"). A fixed recurring fee, e.g. a platform subscription. Set type to \"Fees::Flat\" or fee_type to \"flat\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Fixed amount in the order form's fees_currency, charged per fee_period. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"flat\". Alternative to type.",
+ "enum": [
+ "flat"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Flat\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Flat"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Discount (fee_type \"discount\"). A discount, as a fixed amount or a percentage, applied forever, once, or for a number of months. Set type to \"Fees::Discount\" or fee_type to \"discount\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Discount size: an amount in fees_currency when discount_type is fixed_amount (a plain amount, not cents: 20 means 20.00), or a percentage (e.g. 10 for 10%) when it is percentage.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "discount_duration_amount": {
+ "description": "Number of months the discount applies. Required when discount_duration_type is multiple_months.",
+ "type": "number"
+ },
+ "discount_duration_type": {
+ "description": "How long the discount applies. multiple_months also needs discount_duration_amount.",
+ "enum": [
+ "forever",
+ "once",
+ "multiple_months"
+ ],
+ "type": "string"
+ },
+ "discount_type": {
+ "description": "Whether cost is a currency amount or a percentage.",
+ "enum": [
+ "fixed_amount",
+ "percentage"
+ ],
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"discount\". Alternative to type.",
+ "enum": [
+ "discount"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Discount\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Discount"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Cost (fee_type \"cost\"). A per-unit fee: price per unit times quantity, e.g. seats. Set type to \"Fees::Cost\" or fee_type to \"cost\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Price per unit in fees_currency. The row total is quantity x cost. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"cost\". Alternative to type.",
+ "enum": [
+ "cost"
+ ],
+ "type": "string"
+ },
+ "quantity": {
+ "description": "Number of units.",
+ "type": "number"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Cost\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Cost"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Attachment (fee_type \"attachment\"). A fee described in an uploaded attachment instead of in the table. Set type to \"Fees::Attachment\" or fee_type to \"attachment\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "attachment_id": {
+ "description": "ID of an attachment uploaded with upload-attachment.",
+ "type": "string"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"attachment\". Alternative to type.",
+ "enum": [
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Attachment\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Attachment"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Graduated (fee_type \"graduated\"). Tiered pricing, with the price set per tier in graduated_fee_tiers_attributes. Set type to \"Fees::Graduated\" or fee_type to \"graduated\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"graduated\". Alternative to type.",
+ "enum": [
+ "graduated"
+ ],
+ "type": "string"
+ },
+ "graduated_fee_tiers_attributes": {
+ "additionalProperties": {
+ "additionalProperties": false,
+ "properties": {
+ "flat_price": {
+ "type": "number"
+ },
+ "price_per_unit": {
+ "type": "string"
+ },
+ "upper_limit": {
+ "type": "number"
+ }
+ },
+ "type": "object"
+ },
+ "description": "Graduated fee tiers. Use string keys such as \"0\", \"1\".",
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Graduated\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Graduated"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Included (fee_type \"included\"). An item included at no charge. Set type to \"Fees::Included\" or fee_type to \"included\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"included\". Alternative to type.",
+ "enum": [
+ "included"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Included\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Included"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Metered (fee_type \"metered\"). Usage-based pricing, billed per unit used. Set type to \"Fees::Metered\" or fee_type to \"metered\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Price per unit of usage in fees_currency. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"metered\". Alternative to type.",
+ "enum": [
+ "metered"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Metered\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Metered"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::OneTime (fee_type \"one_time\"). A one-time charge, such as a setup fee. Set type to \"Fees::OneTime\" or fee_type to \"one_time\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "One-time amount in fees_currency, charged once rather than per fee_period. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"one_time\". Alternative to type.",
+ "enum": [
+ "one_time"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::OneTime\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::OneTime"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Text (fee_type \"text\"). A fee term described in free text. Set type to \"Fees::Text\" or fee_type to \"text\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"text\". Alternative to type.",
+ "enum": [
+ "text"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Text\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Text"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ }
+ ]
+ },
+ "description": "Fee line items. Use string keys such as \"0\", \"1\". Replaces template fees when provided.",
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_additional_changes": {
+ "type": "boolean"
+ },
+ "include_customer_obligation": {
+ "type": "boolean"
+ },
+ "include_customer_obligation_val": {
+ "type": "string"
+ },
+ "include_deliverables": {
+ "type": "boolean"
+ },
+ "include_deliverables_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_deliverables_description": {
+ "type": "string"
+ },
+ "include_deliverables_include_acceptance": {
+ "type": "boolean"
+ },
+ "include_deliverables_include_attachment": {
+ "type": "boolean"
+ },
+ "include_deliverables_include_draft_deliverables": {
+ "type": "boolean"
+ },
+ "include_deliverables_rejection_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_deliverables_rejection_unit": {
+ "enum": [
+ "hours",
+ "days",
+ "weeks",
+ "months"
+ ],
+ "type": "string"
+ },
+ "include_deliverables_resubmission_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_deliverables_resubmission_unit": {
+ "enum": [
+ "hours",
+ "days",
+ "weeks",
+ "months"
+ ],
+ "type": "string"
+ },
+ "include_fees_other": {
+ "type": "boolean"
+ },
+ "include_fees_other_val": {
+ "type": "string"
+ },
+ "include_fees_table": {
+ "type": "boolean"
+ },
+ "include_fees_table_total": {
+ "type": "boolean"
+ },
+ "include_fees_travel": {
+ "type": "boolean"
+ },
+ "include_fees_travel_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_fees_travel_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_fees_travel_val": {
+ "type": "string"
+ },
+ "include_third_party_customer": {
+ "type": "boolean"
+ },
+ "include_third_party_include_description": {
+ "type": "boolean"
+ },
+ "include_third_party_include_description_val": {
+ "type": "string"
+ },
+ "include_third_party_materials": {
+ "type": "boolean"
+ },
+ "include_third_party_provider": {
+ "type": "boolean"
+ },
+ "include_time_of_assignment": {
+ "type": "boolean"
+ },
+ "include_time_of_assignment_type": {
+ "enum": [
+ "created",
+ "paid"
+ ],
+ "type": "string"
+ },
+ "invoice_period_description": {
+ "type": "string"
+ },
+ "negotiations_allowed": {
+ "description": "When true, the recipient can propose changes to the statement of work, even when the agreement-level `negotiations_allowed` is false. This only covers the statement of work.",
+ "type": "boolean"
+ },
+ "payment_period": {
+ "type": "number"
+ },
+ "payment_period_other": {
+ "type": "string"
+ },
+ "payment_period_timeframe": {
+ "enum": [
+ "receipt",
+ "invoice",
+ "Customer's receipt of invoice",
+ "date of invoice"
+ ],
+ "type": "string"
+ },
+ "payment_period_type": {
+ "enum": [
+ "standard",
+ "other"
+ ],
+ "type": "string"
+ },
+ "payment_period_unit": {
+ "enum": [
+ "day(s)",
+ "week(s)",
+ "month(s)",
+ "quarter(s)",
+ "year(s)"
+ ],
+ "type": "string"
+ },
+ "quantity": {
+ "type": "number"
+ },
+ "services_description": {
+ "type": "string"
+ },
+ "sow_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "sow_date_type": {
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "type": "string"
+ },
+ "sow_term_amount": {
+ "type": "number"
+ },
+ "sow_term_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "sow_term_type": {
+ "enum": [
+ "deliverables",
+ "period",
+ "date"
+ ],
+ "type": "string"
+ },
+ "sow_term_unit": {
+ "enum": [
+ "month(s)",
+ "quarter(s)",
+ "year(s)"
+ ],
+ "type": "string"
+ },
+ "type": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "recipient_email": {
+ "format": "email",
+ "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "recipient_name": {
+ "type": "string"
+ },
+ "recipient_notice_email_address": {
+ "description": "Email address for legal notices to the recipient.",
+ "format": "email",
+ "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "recipient_organization": {
+ "type": "string"
+ },
+ "recipient_role": {
+ "description": "PSA only. The recipient's role: `Customer` (the default) or `Provider`. Send it with `sender_role`; the two must be one `Provider` and one `Customer`. Other standard agreement types ignore it.",
+ "type": "string"
+ },
+ "sender_last_to_sign": {
+ "description": "When true, your signer signs after the recipient.",
+ "type": "boolean"
+ },
+ "sender_notice_email_address": {
+ "description": "Email address for legal notices to the sender.",
+ "format": "email",
+ "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "sender_role": {
+ "description": "PSA only. Your company's role: `Provider` (the default) or `Customer` when you hire the recipient to provide the services. Send it with `recipient_role`; the two must be one `Provider` and one `Customer`. When reading a PSA, an empty `sender_role` means `Provider`. Other standard agreement types ignore it.",
+ "type": "string"
+ },
+ "software_license_attributes": {
+ "additionalProperties": false,
+ "description": "Override software license terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "effective_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "effective_date_type": {
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "type": "string"
+ },
+ "general_cap_amount": {
+ "type": "number"
+ },
+ "general_cap_amount_type": {
+ "enum": [
+ "preceding",
+ "base",
+ "period"
+ ],
+ "type": "string"
+ },
+ "general_cap_period_currency": {
+ "type": "number"
+ },
+ "general_cap_period_qty": {
+ "type": "number"
+ },
+ "general_cap_preceding_amount": {
+ "type": "number"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_additional_warranties": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_by_customer": {
+ "type": "string"
+ },
+ "include_additional_warranties_by_provider": {
+ "type": "string"
+ },
+ "include_additional_warranties_include_by_customer": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_include_by_provider": {
+ "type": "boolean"
+ },
+ "include_ai_addendum": {
+ "type": "boolean"
+ },
+ "include_ai_addendum_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_covered_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_customer_claims": {
+ "type": "string"
+ },
+ "include_covered_claims_include_customer_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_include_provider_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_provider_claims": {
+ "type": "string"
+ },
+ "include_dpa": {
+ "type": "boolean"
+ },
+ "include_dpa_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_dpa_location": {
+ "type": "string"
+ },
+ "include_dpa_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_increased_cap_amount": {
+ "type": "boolean"
+ },
+ "include_increased_claims": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_confidentiality": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_confidentiality_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_other": {
+ "type": "boolean"
+ },
+ "include_increased_claims_indemnification_obligation": {
+ "type": "boolean"
+ },
+ "include_increased_claims_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_other": {
+ "type": "string"
+ },
+ "include_increased_claims_restrictions": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_confidentiality": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_confidentiality_negligence": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_include_other": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_indemnification_obligation": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_license_or_restrictions": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_negligence": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_other": {
+ "type": "string"
+ },
+ "increased_cap_amount_currency": {
+ "type": "number"
+ },
+ "increased_cap_amount_period_currency": {
+ "type": "number"
+ },
+ "increased_cap_amount_period_qty": {
+ "type": "number"
+ },
+ "increased_cap_amount_qty": {
+ "type": "number"
+ },
+ "increased_cap_amount_type": {
+ "enum": [
+ "qty",
+ "currency",
+ "period"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "software_license_order_form_attributes": {
+ "additionalProperties": false,
+ "description": "Override software license order form terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "additional_changes": {
+ "type": "string"
+ },
+ "deletion_procedure_include_custom": {
+ "type": "boolean"
+ },
+ "deletion_procedure_include_custom_description": {
+ "type": "string"
+ },
+ "deletion_procedure_include_customer_disable": {
+ "type": "boolean"
+ },
+ "deletion_procedure_include_customer_proof": {
+ "type": "boolean"
+ },
+ "deletion_procedure_include_provider_disable": {
+ "type": "boolean"
+ },
+ "fee_custom_unit": {
+ "type": "string"
+ },
+ "fee_period": {
+ "enum": [
+ "Subscription Period",
+ "month",
+ "year",
+ "Custom unit"
+ ],
+ "type": "string"
+ },
+ "fees_attributes": {
+ "additionalProperties": {
+ "anyOf": [
+ {
+ "additionalProperties": false,
+ "description": "Fees::Flat (fee_type \"flat\"). A fixed recurring fee, e.g. a platform subscription. Set type to \"Fees::Flat\" or fee_type to \"flat\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Fixed amount in the order form's fees_currency, charged per fee_period. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"flat\". Alternative to type.",
+ "enum": [
+ "flat"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Flat\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Flat"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Discount (fee_type \"discount\"). A discount, as a fixed amount or a percentage, applied forever, once, or for a number of months. Set type to \"Fees::Discount\" or fee_type to \"discount\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Discount size: an amount in fees_currency when discount_type is fixed_amount (a plain amount, not cents: 20 means 20.00), or a percentage (e.g. 10 for 10%) when it is percentage.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "discount_duration_amount": {
+ "description": "Number of months the discount applies. Required when discount_duration_type is multiple_months.",
+ "type": "number"
+ },
+ "discount_duration_type": {
+ "description": "How long the discount applies. multiple_months also needs discount_duration_amount.",
+ "enum": [
+ "forever",
+ "once",
+ "multiple_months"
+ ],
+ "type": "string"
+ },
+ "discount_type": {
+ "description": "Whether cost is a currency amount or a percentage.",
+ "enum": [
+ "fixed_amount",
+ "percentage"
+ ],
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"discount\". Alternative to type.",
+ "enum": [
+ "discount"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Discount\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Discount"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Cost (fee_type \"cost\"). A per-unit fee: price per unit times quantity, e.g. seats. Set type to \"Fees::Cost\" or fee_type to \"cost\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Price per unit in fees_currency. The row total is quantity x cost. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"cost\". Alternative to type.",
+ "enum": [
+ "cost"
+ ],
+ "type": "string"
+ },
+ "quantity": {
+ "description": "Number of units.",
+ "type": "number"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Cost\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Cost"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Attachment (fee_type \"attachment\"). A fee described in an uploaded attachment instead of in the table. Set type to \"Fees::Attachment\" or fee_type to \"attachment\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "attachment_id": {
+ "description": "ID of an attachment uploaded with upload-attachment.",
+ "type": "string"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"attachment\". Alternative to type.",
+ "enum": [
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Attachment\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Attachment"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Graduated (fee_type \"graduated\"). Tiered pricing, with the price set per tier in graduated_fee_tiers_attributes. Set type to \"Fees::Graduated\" or fee_type to \"graduated\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"graduated\". Alternative to type.",
+ "enum": [
+ "graduated"
+ ],
+ "type": "string"
+ },
+ "graduated_fee_tiers_attributes": {
+ "additionalProperties": {
+ "additionalProperties": false,
+ "properties": {
+ "flat_price": {
+ "type": "number"
+ },
+ "price_per_unit": {
+ "type": "string"
+ },
+ "upper_limit": {
+ "type": "number"
+ }
+ },
+ "type": "object"
+ },
+ "description": "Graduated fee tiers. Use string keys such as \"0\", \"1\".",
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Graduated\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Graduated"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Included (fee_type \"included\"). An item included at no charge. Set type to \"Fees::Included\" or fee_type to \"included\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"included\". Alternative to type.",
+ "enum": [
+ "included"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Included\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Included"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Metered (fee_type \"metered\"). Usage-based pricing, billed per unit used. Set type to \"Fees::Metered\" or fee_type to \"metered\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Price per unit of usage in fees_currency. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"metered\". Alternative to type.",
+ "enum": [
+ "metered"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Metered\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Metered"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::OneTime (fee_type \"one_time\"). A one-time charge, such as a setup fee. Set type to \"Fees::OneTime\" or fee_type to \"one_time\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "One-time amount in fees_currency, charged once rather than per fee_period. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"one_time\". Alternative to type.",
+ "enum": [
+ "one_time"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::OneTime\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::OneTime"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Text (fee_type \"text\"). A fee term described in free text. Set type to \"Fees::Text\" or fee_type to \"text\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"text\". Alternative to type.",
+ "enum": [
+ "text"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Text\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Text"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ }
+ ]
+ },
+ "description": "Fee line items. Use string keys such as \"0\", \"1\". Replaces template fees when provided.",
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+ },
+ "fees_currency": {
+ "enum": [
+ "USD",
+ "EUR",
+ "GBP",
+ "CAD",
+ "AUD",
+ "SGD",
+ "ILS",
+ "JPY",
+ "CHF",
+ "HKD"
+ ],
+ "type": "string"
+ },
+ "fees_include_fee_increase_upon_renewal": {
+ "type": "boolean"
+ },
+ "fees_include_fee_increase_upon_renewal_fee": {
+ "type": "number"
+ },
+ "fees_include_fee_increase_upon_renewal_type": {
+ "enum": [
+ "will",
+ "may"
+ ],
+ "type": "string"
+ },
+ "fees_inclusive_of_taxes": {
+ "type": "boolean"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_additional_changes": {
+ "type": "boolean"
+ },
+ "include_license_compliance_verification": {
+ "type": "boolean"
+ },
+ "include_license_compliance_verification_description": {
+ "type": "string"
+ },
+ "include_license_limits": {
+ "type": "boolean"
+ },
+ "include_license_limits_description": {
+ "type": "string"
+ },
+ "include_payment_process_include_billing_email": {
+ "type": "boolean"
+ },
+ "include_pilot_period": {
+ "type": "boolean"
+ },
+ "include_pilot_period_duration_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_pilot_period_duration_type": {
+ "enum": [
+ "day",
+ "week",
+ "month"
+ ],
+ "type": "string"
+ },
+ "include_pilot_period_include_fees": {
+ "type": "boolean"
+ },
+ "include_pilot_period_include_fees_amount": {
+ "type": "number"
+ },
+ "include_pilot_period_include_modifications": {
+ "type": "boolean"
+ },
+ "include_pilot_period_include_modifications_description": {
+ "type": "string"
+ },
+ "include_services": {
+ "type": "boolean"
+ },
+ "include_services_description": {
+ "type": "string"
+ },
+ "negotiations_allowed": {
+ "description": "When true, the recipient can propose changes to the order form, even when the agreement-level `negotiations_allowed` is false. This only covers the order form.",
+ "type": "boolean"
+ },
+ "order_date_date": {
+ "type": "string"
+ },
+ "order_date_type": {
+ "enum": [
+ "signature",
+ "date",
+ "other"
+ ],
+ "type": "string"
+ },
+ "payment_process_automatic_frequency": {
+ "enum": [
+ "monthly",
+ "quarterly",
+ "semiannually",
+ "annually"
+ ],
+ "type": "string"
+ },
+ "payment_process_type": {
+ "enum": [
+ "automatic",
+ "invoice",
+ "custom"
+ ],
+ "type": "string"
+ },
+ "payment_process_type_custom_val": {
+ "type": "string"
+ },
+ "payment_process_type_invoice_amount": {
+ "type": "number"
+ },
+ "payment_process_type_invoice_custom_unit": {
+ "type": "string"
+ },
+ "payment_process_type_invoice_duration": {
+ "enum": [
+ "day",
+ "week",
+ "month",
+ "year",
+ "day(s)",
+ "week(s)",
+ "month(s)",
+ "year(s)"
+ ],
+ "type": "string"
+ },
+ "payment_process_type_invoice_duration_start": {
+ "enum": [
+ "Customer's receipt of invoice",
+ "date of invoice"
+ ],
+ "type": "string"
+ },
+ "payment_process_type_invoice_type": {
+ "enum": [
+ "monthly",
+ "quarterly",
+ "semiannually",
+ "annually",
+ "Custom unit"
+ ],
+ "type": "string"
+ },
+ "permitted_uses_include_custom": {
+ "type": "boolean"
+ },
+ "permitted_uses_include_custom_description": {
+ "type": "string"
+ },
+ "permitted_uses_include_customers_affiliates": {
+ "type": "boolean"
+ },
+ "permitted_uses_include_internal_business": {
+ "type": "boolean"
+ },
+ "pilot_period_stripe_product_id": {
+ "type": "string"
+ },
+ "software_description": {
+ "type": "string"
+ },
+ "subscription_auto_renew": {
+ "enum": [
+ "days",
+ "subscription_end"
+ ],
+ "type": "string"
+ },
+ "subscription_period": {
+ "type": "number"
+ },
+ "subscription_period_unit": {
+ "type": "string"
+ },
+ "subscription_renewal_notice_days": {
+ "type": "number"
+ },
+ "warranty_period_description_amount": {
+ "type": "number"
+ },
+ "warranty_period_description_duration": {
+ "enum": [
+ "day",
+ "week",
+ "month",
+ "year"
+ ],
+ "type": "string"
+ },
+ "warranty_period_description_duration_start": {
+ "enum": [
+ "initial delivery of the Software",
+ "delivery of the Software and each subsequent Update",
+ "the Order Date"
+ ],
+ "type": "string"
+ },
+ "warranty_period_type": {
+ "enum": [
+ "description",
+ "none"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "test_agreement": {
+ "description": "When true, marks the agreement as a test. Test agreements do not count against your monthly limit.",
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "recipient_name",
+ "recipient_email"
+ ],
+ "type": "object"
+ },
+ "cc_users": {
+ "items": {
+ "format": "email",
+ "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "draft": {
+ "description": "When true, the agreement is saved as a draft and not sent to the recipient. Use POST /v1/agreements/{id}/send to send a draft agreement later.",
+ "type": "boolean"
+ },
+ "owner_id": {
+ "description": "User id of the agreement owner (sender).",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "signer_email": {
+ "description": "Email address of the signer from the owner's organization.",
+ "format": "email",
+ "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "template_id": {
+ "description": "UUID of a template from `GET /v1/templates`. Accepts both Common Paper standard templates and uploaded PDF templates (`type` `uploaded_template`).",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ }
+ },
+ "required": [
+ "template_id",
+ "owner_id",
+ "signer_email",
+ "agreement"
+ ],
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "agreement": {
+ "additionalProperties": {},
+ "properties": {
+ "amendment_attributes": {
+ "additionalProperties": false,
+ "description": "Override amendment terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "amended_terms_attributes": {
+ "additionalProperties": {
+ "additionalProperties": false,
+ "properties": {
+ "description": {
+ "type": "string"
+ },
+ "term": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "description": "Amended terms. Use string keys such as \"0\", \"1\".",
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+ },
+ "amendment_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "amendment_date_type": {
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "type": "string"
+ },
+ "framework_terms_type": {
+ "type": "string"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "parent_agreement_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "underlying_agreement_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "underlying_agreement_type": {
+ "type": "string"
+ },
+ "underlying_agreement_val": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "baa_attributes": {
+ "additionalProperties": false,
+ "description": "Override baa terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "aggregation_limitations_permitted": {
+ "type": "boolean"
+ },
+ "aggregation_limitations_permitted_val": {
+ "type": "string"
+ },
+ "breach_notification_unit": {
+ "enum": [
+ "hours",
+ "business days",
+ "calendar days"
+ ],
+ "type": "string"
+ },
+ "breach_notification_val": {
+ "type": "number"
+ },
+ "business_associate_relationship_type": {
+ "enum": [
+ "provider",
+ "company"
+ ],
+ "type": "string"
+ },
+ "deidentification_limitations_include_purpose": {
+ "type": "boolean"
+ },
+ "deidentification_limitations_include_requirements": {
+ "type": "boolean"
+ },
+ "deidentification_limitations_permitted": {
+ "type": "boolean"
+ },
+ "deidentification_limitations_purpose_val": {
+ "type": "string"
+ },
+ "deidentification_limitations_requirements_val": {
+ "type": "string"
+ },
+ "designated_record_set_provider_maintains": {
+ "type": "boolean"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_aggregation_limitations": {
+ "type": "boolean"
+ },
+ "include_deidentification_limitations": {
+ "type": "boolean"
+ },
+ "include_limitations": {
+ "type": "boolean"
+ },
+ "include_offshore_limitations": {
+ "type": "boolean"
+ },
+ "include_subcontract_limitations": {
+ "type": "boolean"
+ },
+ "offshore_limitations_permitted": {
+ "type": "boolean"
+ },
+ "offshore_limitations_permitted_val": {
+ "type": "string"
+ },
+ "subcontract_limitations_include_notice": {
+ "type": "boolean"
+ },
+ "subcontract_limitations_include_permission": {
+ "type": "boolean"
+ },
+ "subcontract_limitations_notice_val": {
+ "type": "string"
+ },
+ "subcontract_limitations_permission_val": {
+ "type": "string"
+ },
+ "subcontract_limitations_permitted": {
+ "type": "boolean"
+ },
+ "underlying_agreement_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "underlying_agreement_type": {
+ "enum": [
+ "internal",
+ "external",
+ "none"
+ ],
+ "type": "string"
+ },
+ "underlying_agreement_val": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "billing_email": {
+ "description": "Email of the billing contact. Used when include_billing_info is true.",
+ "format": "email",
+ "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "billing_name": {
+ "description": "Name of the billing contact. Used when include_billing_info is true.",
+ "type": "string"
+ },
+ "billing_workflow_type": {
+ "description": "The type of billing workflow. Use \"link\" to provide a payment_link_url, or \"stripe\" for Stripe-managed billing.",
+ "enum": [
+ "link",
+ "stripe"
+ ],
+ "type": "string"
+ },
+ "chosen_courts_country": {
+ "description": "The country in which disputes will be resolved.",
+ "type": "string"
+ },
+ "chosen_courts_region": {
+ "description": "The state or region in which disputes will be resolved.",
+ "type": "string"
+ },
+ "csa_attributes": {
+ "additionalProperties": false,
+ "description": "Override csa terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "customer_description": {
+ "type": "string"
+ },
+ "effective_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "effective_date_marketplace": {
+ "enum": [
+ "AWS",
+ "GCP",
+ "Azure"
+ ],
+ "type": "string"
+ },
+ "effective_date_type": {
+ "enum": [
+ "signature",
+ "date",
+ "marketplace_acceptance"
+ ],
+ "type": "string"
+ },
+ "general_cap_amount": {
+ "type": "number"
+ },
+ "general_cap_amount_type": {
+ "enum": [
+ "preceding",
+ "base",
+ "period"
+ ],
+ "type": "string"
+ },
+ "general_cap_period_currency": {
+ "type": "number"
+ },
+ "general_cap_period_qty": {
+ "type": "number"
+ },
+ "general_cap_preceding_amount": {
+ "type": "number"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_acceptable_use_policy": {
+ "type": "boolean"
+ },
+ "include_acceptable_use_policy_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_acceptable_use_policy_location": {
+ "type": "string"
+ },
+ "include_acceptable_use_policy_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_additional_warranties": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_by_customer": {
+ "type": "string"
+ },
+ "include_additional_warranties_by_provider": {
+ "type": "string"
+ },
+ "include_additional_warranties_include_by_customer": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_include_by_provider": {
+ "type": "boolean"
+ },
+ "include_ai_addendum": {
+ "type": "boolean"
+ },
+ "include_ai_addendum_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_covered_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_customer_claims": {
+ "type": "string"
+ },
+ "include_covered_claims_include_customer_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_include_provider_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_provider_claims": {
+ "type": "string"
+ },
+ "include_dpa": {
+ "type": "boolean"
+ },
+ "include_dpa_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_dpa_location": {
+ "type": "string"
+ },
+ "include_dpa_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_increased_cap_amount": {
+ "type": "boolean"
+ },
+ "include_increased_claims": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_confidentiality": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_confidentiality_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_privsec": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_privsec_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_other": {
+ "type": "boolean"
+ },
+ "include_increased_claims_indemnification_obligation": {
+ "type": "boolean"
+ },
+ "include_increased_claims_other": {
+ "type": "string"
+ },
+ "include_insurance_minimums": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_add_customer": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_add_customer_com_gen_liability": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_add_customer_cyber_liability": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_add_customer_errors_omissions": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_additional_information": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_additional_information_text": {
+ "type": "string"
+ },
+ "include_insurance_minimums_cyber_liability_aggregate": {
+ "type": "number"
+ },
+ "include_insurance_minimums_cyber_liability_minimum": {
+ "type": "number"
+ },
+ "include_insurance_minimums_employer_liability_aggregate": {
+ "type": "number"
+ },
+ "include_insurance_minimums_employer_liability_minimum": {
+ "type": "number"
+ },
+ "include_insurance_minimums_general_liability_aggregate": {
+ "type": "number"
+ },
+ "include_insurance_minimums_general_liability_minimum": {
+ "type": "number"
+ },
+ "include_insurance_minimums_include_cyber_liability": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_include_employer_liability": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_include_general_liability": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_include_workers_compensation": {
+ "type": "boolean"
+ },
+ "include_publicity_rights": {
+ "type": "boolean"
+ },
+ "include_publicity_rights_type": {
+ "enum": [
+ "public",
+ "non-public"
+ ],
+ "type": "string"
+ },
+ "include_security_policy": {
+ "type": "boolean"
+ },
+ "include_security_policy_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_security_policy_fedramp_auth": {
+ "type": "boolean"
+ },
+ "include_security_policy_hipaa": {
+ "type": "boolean"
+ },
+ "include_security_policy_hitrust": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_annual_maintenance": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_location": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_other": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_reasonable_efforts": {
+ "type": "boolean"
+ },
+ "include_security_policy_iso27001": {
+ "type": "boolean"
+ },
+ "include_security_policy_location": {
+ "type": "string"
+ },
+ "include_security_policy_other": {
+ "type": "string"
+ },
+ "include_security_policy_pci1": {
+ "type": "boolean"
+ },
+ "include_security_policy_pci2": {
+ "type": "boolean"
+ },
+ "include_security_policy_penetration_testing": {
+ "type": "boolean"
+ },
+ "include_security_policy_soc2": {
+ "type": "boolean"
+ },
+ "include_security_policy_soc2_type2": {
+ "type": "boolean"
+ },
+ "include_security_policy_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_supercap": {
+ "description": "CSA 3.0 renamed `include_increased_cap_amount` to `include_supercap`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_increased_cap_amount`. Sending the other spelling returns a 422.",
+ "type": "boolean"
+ },
+ "include_uncapped_claims": {
+ "description": "CSA 3.0 renamed `include_unlimited_claims` to `include_uncapped_claims`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims`. Sending the other spelling returns a 422.",
+ "type": "boolean"
+ },
+ "include_uncapped_claims_breach_of_confidentiality": {
+ "description": "CSA 3.0 renamed `include_unlimited_claims_breach_of_confidentiality` to `include_uncapped_claims_breach_of_confidentiality`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_breach_of_confidentiality`. Sending the other spelling returns a 422.",
+ "type": "boolean"
+ },
+ "include_uncapped_claims_breach_of_confidentiality_negligence": {
+ "description": "CSA 3.0 renamed `include_unlimited_claims_breach_of_confidentiality_negligence` to `include_uncapped_claims_breach_of_confidentiality_negligence`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_breach_of_confidentiality_negligence`. Sending the other spelling returns a 422.",
+ "type": "boolean"
+ },
+ "include_uncapped_claims_breach_of_privsec": {
+ "description": "CSA 3.0 renamed `include_unlimited_claims_breach_of_privsec` to `include_uncapped_claims_breach_of_privsec`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_breach_of_privsec`. Sending the other spelling returns a 422.",
+ "type": "boolean"
+ },
+ "include_uncapped_claims_breach_of_privsec_negligence": {
+ "description": "CSA 3.0 renamed `include_unlimited_claims_breach_of_privsec_negligence` to `include_uncapped_claims_breach_of_privsec_negligence`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_breach_of_privsec_negligence`. Sending the other spelling returns a 422.",
+ "type": "boolean"
+ },
+ "include_uncapped_claims_include_other": {
+ "description": "CSA 3.0 renamed `include_unlimited_claims_include_other` to `include_uncapped_claims_include_other`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_include_other`. Sending the other spelling returns a 422.",
+ "type": "boolean"
+ },
+ "include_uncapped_claims_indemnification_obligation": {
+ "description": "CSA 3.0 renamed `include_unlimited_claims_indemnification_obligation` to `include_uncapped_claims_indemnification_obligation`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_indemnification_obligation`. Sending the other spelling returns a 422.",
+ "type": "boolean"
+ },
+ "include_uncapped_claims_other": {
+ "description": "CSA 3.0 renamed `include_unlimited_claims_other` to `include_uncapped_claims_other`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_other`. Sending the other spelling returns a 422.",
+ "type": "boolean"
+ },
+ "include_unlimited_claims": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_confidentiality": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_confidentiality_negligence": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_privsec": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_privsec_negligence": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_include_other": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_indemnification_obligation": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_other": {
+ "type": "string"
+ },
+ "increased_cap_amount_currency": {
+ "type": "number"
+ },
+ "increased_cap_amount_period_currency": {
+ "type": "number"
+ },
+ "increased_cap_amount_period_qty": {
+ "type": "number"
+ },
+ "increased_cap_amount_qty": {
+ "type": "number"
+ },
+ "increased_cap_amount_type": {
+ "enum": [
+ "qty",
+ "currency",
+ "period"
+ ],
+ "type": "string"
+ },
+ "provider": {
+ "type": "string"
+ },
+ "supercap_currency": {
+ "description": "CSA 3.0 renamed `increased_cap_amount_currency` to `supercap_currency`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `increased_cap_amount_currency`. Sending the other spelling returns a 422.",
+ "type": "number"
+ },
+ "supercap_period_currency": {
+ "description": "CSA 3.0 renamed `increased_cap_amount_period_currency` to `supercap_period_currency`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `increased_cap_amount_period_currency`. Sending the other spelling returns a 422.",
+ "type": "number"
+ },
+ "supercap_period_qty": {
+ "description": "CSA 3.0 renamed `increased_cap_amount_period_qty` to `supercap_period_qty`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `increased_cap_amount_period_qty`. Sending the other spelling returns a 422.",
+ "type": "number"
+ },
+ "supercap_qty": {
+ "description": "CSA 3.0 renamed `increased_cap_amount_qty` to `supercap_qty`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `increased_cap_amount_qty`. Sending the other spelling returns a 422.",
+ "type": "number"
+ },
+ "supercap_type": {
+ "description": "CSA 3.0 renamed `increased_cap_amount_type` to `supercap_type`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `increased_cap_amount_type`. Sending the other spelling returns a 422.",
+ "type": "number"
+ }
+ },
+ "type": "object"
+ },
+ "csa_order_form_attributes": {
+ "additionalProperties": false,
+ "description": "Override csa order form terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "additional_changes": {
+ "type": "string"
+ },
+ "additional_parameters_or_limitations": {
+ "type": "string"
+ },
+ "affiliates_as_users": {
+ "type": "boolean"
+ },
+ "cloud_service_description": {
+ "type": "string"
+ },
+ "consumption_units": {
+ "type": "string"
+ },
+ "fee_amount": {
+ "type": "number"
+ },
+ "fee_custom_unit": {
+ "type": "string"
+ },
+ "fee_period": {
+ "enum": [
+ "Subscription Period",
+ "month",
+ "year",
+ "User",
+ "Custom unit"
+ ],
+ "type": "string"
+ },
+ "fees_attributes": {
+ "additionalProperties": {
+ "anyOf": [
+ {
+ "additionalProperties": false,
+ "description": "Fees::Flat (fee_type \"flat\"). A fixed recurring fee, e.g. a platform subscription. Set type to \"Fees::Flat\" or fee_type to \"flat\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Fixed amount in the order form's fees_currency, charged per fee_period. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"flat\". Alternative to type.",
+ "enum": [
+ "flat"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Flat\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Flat"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Discount (fee_type \"discount\"). A discount, as a fixed amount or a percentage, applied forever, once, or for a number of months. Set type to \"Fees::Discount\" or fee_type to \"discount\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Discount size: an amount in fees_currency when discount_type is fixed_amount (a plain amount, not cents: 20 means 20.00), or a percentage (e.g. 10 for 10%) when it is percentage.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "discount_duration_amount": {
+ "description": "Number of months the discount applies. Required when discount_duration_type is multiple_months.",
+ "type": "number"
+ },
+ "discount_duration_type": {
+ "description": "How long the discount applies. multiple_months also needs discount_duration_amount.",
+ "enum": [
+ "forever",
+ "once",
+ "multiple_months"
+ ],
+ "type": "string"
+ },
+ "discount_type": {
+ "description": "Whether cost is a currency amount or a percentage.",
+ "enum": [
+ "fixed_amount",
+ "percentage"
+ ],
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"discount\". Alternative to type.",
+ "enum": [
+ "discount"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Discount\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Discount"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Cost (fee_type \"cost\"). A per-unit fee: price per unit times quantity, e.g. seats. Set type to \"Fees::Cost\" or fee_type to \"cost\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Price per unit in fees_currency. The row total is quantity x cost. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"cost\". Alternative to type.",
+ "enum": [
+ "cost"
+ ],
+ "type": "string"
+ },
+ "quantity": {
+ "description": "Number of units.",
+ "type": "number"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Cost\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Cost"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Attachment (fee_type \"attachment\"). A fee described in an uploaded attachment instead of in the table. Set type to \"Fees::Attachment\" or fee_type to \"attachment\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "attachment_id": {
+ "description": "ID of an attachment uploaded with upload-attachment.",
+ "type": "string"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"attachment\". Alternative to type.",
+ "enum": [
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Attachment\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Attachment"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Graduated (fee_type \"graduated\"). Tiered pricing, with the price set per tier in graduated_fee_tiers_attributes. Set type to \"Fees::Graduated\" or fee_type to \"graduated\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"graduated\". Alternative to type.",
+ "enum": [
+ "graduated"
+ ],
+ "type": "string"
+ },
+ "graduated_fee_tiers_attributes": {
+ "additionalProperties": {
+ "additionalProperties": false,
+ "properties": {
+ "flat_price": {
+ "type": "number"
+ },
+ "price_per_unit": {
+ "type": "string"
+ },
+ "upper_limit": {
+ "type": "number"
+ }
+ },
+ "type": "object"
+ },
+ "description": "Graduated fee tiers. Use string keys such as \"0\", \"1\".",
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Graduated\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Graduated"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Included (fee_type \"included\"). An item included at no charge. Set type to \"Fees::Included\" or fee_type to \"included\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"included\". Alternative to type.",
+ "enum": [
+ "included"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Included\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Included"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Metered (fee_type \"metered\"). Usage-based pricing, billed per unit used. Set type to \"Fees::Metered\" or fee_type to \"metered\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Price per unit of usage in fees_currency. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"metered\". Alternative to type.",
+ "enum": [
+ "metered"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Metered\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Metered"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::OneTime (fee_type \"one_time\"). A one-time charge, such as a setup fee. Set type to \"Fees::OneTime\" or fee_type to \"one_time\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "One-time amount in fees_currency, charged once rather than per fee_period. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"one_time\". Alternative to type.",
+ "enum": [
+ "one_time"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::OneTime\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::OneTime"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Text (fee_type \"text\"). A fee term described in free text. Set type to \"Fees::Text\" or fee_type to \"text\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"text\". Alternative to type.",
+ "enum": [
+ "text"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Text\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Text"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ }
+ ]
+ },
+ "description": "Fee table rows, keyed by string index (\"0\", \"1\", ...). Replaces the template's fees when provided. Each row sets type or fee_type to pick the fee class. Amounts are in the order form's fees_currency and, for recurring fees, are charged per fee_period.",
+ "examples": [
+ {
+ "0": {
+ "cost": 2000,
+ "description": "Platform subscription",
+ "type": "Fees::Flat"
+ }
+ },
+ {
+ "0": {
+ "cost": 50,
+ "description": "Seats",
+ "fee_type": "cost",
+ "quantity": 10
+ },
+ "1": {
+ "cost": 10,
+ "description": "Launch discount",
+ "discount_duration_amount": 3,
+ "discount_duration_type": "multiple_months",
+ "discount_type": "percentage",
+ "fee_type": "discount"
+ }
+ }
+ ],
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+ },
+ "fees_currency": {
+ "enum": [
+ "USD",
+ "EUR",
+ "GBP",
+ "CAD",
+ "AUD",
+ "SGD",
+ "ILS",
+ "JPY",
+ "CHF",
+ "HKD"
+ ],
+ "type": "string"
+ },
+ "fees_include_fee_increase_upon_renewal": {
+ "type": "boolean"
+ },
+ "fees_include_fee_increase_upon_renewal_fee": {
+ "type": "number"
+ },
+ "fees_include_fee_increase_upon_renewal_type": {
+ "enum": [
+ "will",
+ "may"
+ ],
+ "type": "string"
+ },
+ "fees_inclusive_of_taxes": {
+ "type": "boolean"
+ },
+ "framework_terms_type": {
+ "enum": [
+ "new",
+ "existing",
+ "description"
+ ],
+ "type": "string"
+ },
+ "free_trial_days": {
+ "type": "number"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_additional_changes": {
+ "type": "boolean"
+ },
+ "include_additional_parameters_or_limitations": {
+ "type": "boolean"
+ },
+ "include_consumption": {
+ "type": "boolean"
+ },
+ "include_fees": {
+ "type": "boolean"
+ },
+ "include_fees_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_fees_include_attachment": {
+ "type": "boolean"
+ },
+ "include_fees_other": {
+ "type": "boolean"
+ },
+ "include_fees_other_val": {
+ "type": "string"
+ },
+ "include_fees_table": {
+ "type": "boolean"
+ },
+ "include_fees_table_period": {
+ "enum": [
+ "Subscription Period",
+ "month",
+ "year",
+ "User"
+ ],
+ "type": "string"
+ },
+ "include_free_trial": {
+ "type": "boolean"
+ },
+ "include_max_users": {
+ "type": "boolean"
+ },
+ "include_pilot_period": {
+ "type": "boolean"
+ },
+ "include_pilot_period_duration_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_pilot_period_duration_type": {
+ "enum": [
+ "day",
+ "week",
+ "month"
+ ],
+ "type": "string"
+ },
+ "include_pilot_period_include_fees": {
+ "type": "boolean"
+ },
+ "include_pilot_period_include_fees_amount": {
+ "type": "number"
+ },
+ "include_pilot_period_include_modifications": {
+ "type": "boolean"
+ },
+ "include_pilot_period_include_modifications_description": {
+ "type": "string"
+ },
+ "include_product_support": {
+ "type": "boolean"
+ },
+ "include_product_support_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_product_support_description": {
+ "type": "string"
+ },
+ "include_product_support_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_professional_services": {
+ "type": "boolean"
+ },
+ "include_professional_services_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_professional_services_custom_name": {
+ "type": "string"
+ },
+ "include_professional_services_description": {
+ "type": "string"
+ },
+ "include_professional_services_end_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "include_professional_services_fees_description": {
+ "type": "string"
+ },
+ "include_professional_services_include_end_date": {
+ "type": "boolean"
+ },
+ "include_professional_services_include_fees_description": {
+ "type": "boolean"
+ },
+ "include_professional_services_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_sla": {
+ "type": "boolean"
+ },
+ "include_sla_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_sla_description": {
+ "type": "string"
+ },
+ "include_sla_include_response_time": {
+ "type": "boolean"
+ },
+ "include_sla_include_response_time_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_sla_include_response_time_credit": {
+ "type": "number"
+ },
+ "include_sla_include_response_time_duration": {
+ "enum": [
+ "hour",
+ "day",
+ "week",
+ "month",
+ "hours"
+ ],
+ "type": "string"
+ },
+ "include_sla_include_response_time_support_channel": {
+ "type": "string"
+ },
+ "include_sla_include_target_uptime": {
+ "type": "boolean"
+ },
+ "include_sla_maintenance_notice": {
+ "type": "boolean"
+ },
+ "include_sla_maintenance_window": {
+ "type": "boolean"
+ },
+ "include_sla_maintenance_window_type": {
+ "enum": [
+ "standard",
+ "none"
+ ],
+ "type": "string"
+ },
+ "include_sla_standard_maintenance_notice_qty": {
+ "type": "number"
+ },
+ "include_sla_standard_maintenance_notice_unit": {
+ "enum": [
+ "hour",
+ "day",
+ "week",
+ "month"
+ ],
+ "type": "string"
+ },
+ "include_sla_standard_maintenance_window_end_time": {
+ "type": "string"
+ },
+ "include_sla_standard_maintenance_window_friday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_monday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_saturday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_start_time": {
+ "type": "string"
+ },
+ "include_sla_standard_maintenance_window_sunday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_thursday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_time_zone": {
+ "type": "string"
+ },
+ "include_sla_standard_maintenance_window_tuesday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_wednesday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_target_uptime": {
+ "type": "number"
+ },
+ "include_sla_type": {
+ "enum": [
+ "description",
+ "standard",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_subscription_start_date": {
+ "type": "boolean"
+ },
+ "include_subscription_start_date_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "include_usage_review": {
+ "type": "boolean"
+ },
+ "include_usage_review_val": {
+ "type": "string"
+ },
+ "include_use_limitations": {
+ "type": "boolean"
+ },
+ "include_use_limitations_val": {
+ "type": "string"
+ },
+ "invoice_period": {
+ "enum": [
+ "monthly",
+ "quarterly",
+ "semiannually",
+ "annually",
+ "Custom unit",
+ "Monthly",
+ "Quarterly",
+ "Semiannually",
+ "Annually"
+ ],
+ "type": "string"
+ },
+ "invoice_period_custom_unit": {
+ "type": "string"
+ },
+ "max_consumption": {
+ "type": "number"
+ },
+ "max_users": {
+ "type": "number"
+ },
+ "negotiations_allowed": {
+ "description": "When true, the recipient can propose changes to the order form, even when the agreement-level `negotiations_allowed` is false. This only covers the order form.",
+ "type": "boolean"
+ },
+ "order_date_date": {
+ "type": "string"
+ },
+ "order_date_other": {
+ "type": "string"
+ },
+ "order_date_type": {
+ "enum": [
+ "signature",
+ "date",
+ "other"
+ ],
+ "type": "string"
+ },
+ "payment_period": {
+ "type": "number"
+ },
+ "payment_period_timeframe": {
+ "enum": [
+ "Customer's receipt of invoice",
+ "date of invoice"
+ ],
+ "type": "string"
+ },
+ "payment_period_unit": {
+ "enum": [
+ "day(s)",
+ "week(s)",
+ "month(s)",
+ "marketplace_acceptance"
+ ],
+ "type": "string"
+ },
+ "payment_process_automatic_frequency": {
+ "enum": [
+ "monthly",
+ "quarterly",
+ "semiannually",
+ "annually"
+ ],
+ "type": "string"
+ },
+ "payment_process_type": {
+ "enum": [
+ "automatic",
+ "invoice",
+ "custom",
+ "marketplace_acceptance"
+ ],
+ "type": "string"
+ },
+ "payment_process_type_custom_val": {
+ "type": "string"
+ },
+ "payment_process_type_invoice_amount": {
+ "type": "number"
+ },
+ "payment_process_type_invoice_custom_unit": {
+ "type": "string"
+ },
+ "payment_process_type_invoice_duration": {
+ "enum": [
+ "day",
+ "week",
+ "month",
+ "year",
+ "day(s)",
+ "week(s)",
+ "month(s)",
+ "year(s)"
+ ],
+ "type": "string"
+ },
+ "payment_process_type_invoice_duration_start": {
+ "enum": [
+ "Customer's receipt of invoice",
+ "date of invoice"
+ ],
+ "type": "string"
+ },
+ "payment_process_type_invoice_type": {
+ "enum": [
+ "monthly",
+ "quarterly",
+ "semiannually",
+ "annually",
+ "Custom unit"
+ ],
+ "type": "string"
+ },
+ "pilot_period_stripe_product_id": {
+ "type": "string"
+ },
+ "service_credits_attributes": {
+ "additionalProperties": {
+ "additionalProperties": false,
+ "properties": {
+ "credit": {
+ "type": "number"
+ },
+ "max": {
+ "type": "number"
+ },
+ "min": {
+ "type": "number"
+ }
+ },
+ "type": "object"
+ },
+ "description": "Service credits. Use string keys such as \"0\", \"1\".",
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+ },
+ "subscription_auto_renew": {
+ "enum": [
+ "days",
+ "subscription_end"
+ ],
+ "type": "string"
+ },
+ "subscription_period": {
+ "type": "number"
+ },
+ "subscription_period_unit": {
+ "type": "string"
+ },
+ "subscription_renewal_notice_days": {
+ "type": "number"
+ },
+ "subscription_start_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "subscription_start_date_type": {
+ "enum": [
+ "effective_date",
+ "date"
+ ],
+ "type": "string"
+ },
+ "underlying_agreement_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "use_limitations_attributes": {
+ "additionalProperties": {
+ "additionalProperties": false,
+ "properties": {
+ "amount": {
+ "type": "number"
+ },
+ "limitation_type": {
+ "type": "string"
+ },
+ "unit": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "description": "Use limitations. Use string keys such as \"0\", \"1\".",
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+ }
+ },
+ "type": "object"
+ },
+ "custom_field_values": {
+ "description": "Values for a custom template's fields, keyed by the field keys defined in the template's YAML definition. Only used when template_id is a custom template. Template defaults fill any fields you omit; a required field with no default and no submitted value returns a 400 naming the field. Values are validated against the field's input type: select and radio values must be one of the field's options, multiselect values are an array of selections each of which must be one of the field's options, number and currency values must be numeric, date values must be YYYY-MM-DD, and email values must be valid addresses. An invalid value returns a 400 naming the field."
+ },
+ "design_partner_attributes": {
+ "additionalProperties": false,
+ "description": "Override design partner terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "customer_description": {
+ "type": "string"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_fees": {
+ "type": "boolean"
+ },
+ "include_fees_amount": {
+ "type": "number"
+ },
+ "include_fees_description": {
+ "type": "string"
+ },
+ "include_fees_pay_by_amount": {
+ "type": "string"
+ },
+ "include_fees_type": {
+ "enum": [
+ "default_language",
+ "description"
+ ],
+ "type": "string"
+ },
+ "include_fees_unit": {
+ "enum": [
+ "month",
+ "quarter",
+ "year",
+ "Term"
+ ],
+ "type": "string"
+ },
+ "include_program_appear_as_customer_private": {
+ "type": "boolean"
+ },
+ "include_program_appear_as_customer_public": {
+ "type": "boolean"
+ },
+ "include_program_case_study": {
+ "type": "boolean"
+ },
+ "include_program_develop_functionality": {
+ "type": "boolean"
+ },
+ "include_program_develop_functionality_val": {
+ "type": "string"
+ },
+ "include_program_discount": {
+ "type": "boolean"
+ },
+ "include_program_discount_amount": {
+ "type": "number"
+ },
+ "include_program_discount_unit": {
+ "enum": [
+ "U.S. Dollars",
+ "percent"
+ ],
+ "type": "string"
+ },
+ "include_program_participation_feedback": {
+ "type": "boolean"
+ },
+ "include_program_participation_feedback_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_program_participation_feedback_unit": {
+ "enum": [
+ "month",
+ "quarter",
+ "year",
+ "Term"
+ ],
+ "type": "string"
+ },
+ "include_program_partner_other": {
+ "type": "boolean"
+ },
+ "include_program_partner_other_val": {
+ "type": "string"
+ },
+ "include_program_provider_other": {
+ "type": "boolean"
+ },
+ "include_program_provider_other_val": {
+ "type": "string"
+ },
+ "include_program_reference": {
+ "type": "boolean"
+ },
+ "product_description": {
+ "type": "string"
+ },
+ "term_amount": {
+ "type": "number"
+ },
+ "term_unit": {
+ "enum": [
+ "day(s)",
+ "week(s)",
+ "month(s)",
+ "quarter(s)",
+ "year(s)"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "district_or_county": {
+ "description": "The district or county for dispute resolution.",
+ "type": "string"
+ },
+ "dpa_attributes": {
+ "additionalProperties": false,
+ "description": "Override dpa terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "approved_subprocessor_type": {
+ "description": "`internal` lists approved subprocessors in the agreement (`subprocessors_attributes`); `external` points to a list published elsewhere.",
+ "enum": [
+ "internal",
+ "external"
+ ],
+ "type": "string"
+ },
+ "cloud_service_product_name": {
+ "type": "string"
+ },
+ "competent_supervisory_authority": {
+ "type": "string"
+ },
+ "customer_description": {
+ "type": "string"
+ },
+ "data_exporter_address_city": {
+ "type": "string"
+ },
+ "data_exporter_address_country": {
+ "type": "string"
+ },
+ "data_exporter_address_state": {
+ "type": "string"
+ },
+ "data_exporter_address_street_address": {
+ "type": "string"
+ },
+ "data_exporter_address_zipcode": {
+ "type": "string"
+ },
+ "data_exporter_contact_details": {
+ "type": "string"
+ },
+ "data_exporter_contact_name": {
+ "type": "string"
+ },
+ "data_exporter_contact_position": {
+ "type": "string"
+ },
+ "data_exporter_role": {
+ "description": "Role of the data exporter. Overwritten to `Controller` when the agreement is created from a template.",
+ "enum": [
+ "Controller",
+ "Processor"
+ ],
+ "type": "string"
+ },
+ "data_importer_address": {
+ "type": "string"
+ },
+ "data_importer_address_city": {
+ "type": "string"
+ },
+ "data_importer_address_country": {
+ "type": "string"
+ },
+ "data_importer_address_state": {
+ "type": "string"
+ },
+ "data_importer_address_street_address": {
+ "type": "string"
+ },
+ "data_importer_address_zipcode": {
+ "type": "string"
+ },
+ "data_importer_contact_details": {
+ "type": "string"
+ },
+ "data_importer_contact_name": {
+ "type": "string"
+ },
+ "data_importer_contact_position": {
+ "type": "string"
+ },
+ "duration_of_processing": {
+ "type": "string"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_covered_claim": {
+ "type": "boolean"
+ },
+ "include_covered_claim_external_val": {
+ "type": "string"
+ },
+ "include_covered_claim_internal_val": {
+ "type": "string"
+ },
+ "include_covered_claim_type": {
+ "description": "Which covered-claim text applies: `internal` uses `include_covered_claim_internal_val`, `external` uses `include_covered_claim_external_val`. Required when `include_covered_claim` is true.",
+ "enum": [
+ "internal",
+ "external"
+ ],
+ "type": "string"
+ },
+ "include_data_subjects_custom": {
+ "type": "boolean"
+ },
+ "include_data_subjects_custom_val": {
+ "type": "string"
+ },
+ "include_data_subjects_employees": {
+ "type": "boolean"
+ },
+ "include_data_subjects_end_users": {
+ "type": "boolean"
+ },
+ "include_external_subprocessor_location": {
+ "type": "string"
+ },
+ "include_frequency_of_transfer_continuous": {
+ "type": "boolean"
+ },
+ "include_frequency_of_transfer_custom": {
+ "type": "boolean"
+ },
+ "include_frequency_of_transfer_custom_val": {
+ "type": "string"
+ },
+ "include_governing_country_eu": {
+ "type": "boolean"
+ },
+ "include_governing_country_eu_val": {
+ "type": "string"
+ },
+ "include_governing_country_uk": {
+ "type": "boolean"
+ },
+ "include_governing_country_uk_val": {
+ "type": "string"
+ },
+ "include_governing_law": {
+ "type": "boolean"
+ },
+ "include_governing_law_country": {
+ "type": "string"
+ },
+ "include_governing_law_state": {
+ "type": "string"
+ },
+ "include_increased_claim_amount": {
+ "description": "Legacy field. Stored but not shown on the DPA; use the `include_liability_cap*` fields instead.",
+ "type": "boolean"
+ },
+ "include_increased_claim_amount_currency": {
+ "description": "Legacy field. Stored but not shown on the DPA; use the `include_liability_cap*` fields instead."
+ },
+ "include_increased_claim_amount_qty": {
+ "description": "Legacy field. Stored but not shown on the DPA; use the `include_liability_cap*` fields instead."
+ },
+ "include_increased_claim_amount_type": {
+ "description": "Legacy field. Stored but not shown on the DPA; use the `include_liability_cap*` fields instead.",
+ "type": "string"
+ },
+ "include_liability_cap": {
+ "type": "boolean"
+ },
+ "include_liability_cap_amount_constant_external": {
+ "type": "string"
+ },
+ "include_liability_cap_amount_constant_internal": {
+ "type": "string"
+ },
+ "include_liability_cap_amount_currency_external": {
+ "description": "Currency amount. Numbers and numeric strings (commas allowed) are both accepted."
+ },
+ "include_liability_cap_amount_currency_internal": {
+ "description": "Currency amount. Numbers and numeric strings (commas allowed) are both accepted."
+ },
+ "include_liability_cap_csa_type": {
+ "description": "Which liability cap values apply: the `_internal` or `_external` amount fields. Required when `include_liability_cap` is true.",
+ "enum": [
+ "internal",
+ "external"
+ ],
+ "type": "string"
+ },
+ "include_personal_data_biographic_info": {
+ "type": "boolean"
+ },
+ "include_personal_data_contact_info": {
+ "type": "boolean"
+ },
+ "include_personal_data_custom": {
+ "type": "boolean"
+ },
+ "include_personal_data_custom_val": {
+ "type": "string"
+ },
+ "include_personal_data_employment_info": {
+ "type": "boolean"
+ },
+ "include_personal_data_financial_info": {
+ "type": "boolean"
+ },
+ "include_personal_data_location": {
+ "type": "boolean"
+ },
+ "include_personal_data_name": {
+ "type": "boolean"
+ },
+ "include_personal_data_transactional_info": {
+ "type": "boolean"
+ },
+ "include_personal_data_user_activity_info": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_custom": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_custom_val": {
+ "type": "string"
+ },
+ "include_processing_purpose_erasing": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_holding": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_protecting": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_receiving": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_returning": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_sharing": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_updating": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_using": {
+ "type": "boolean"
+ },
+ "include_provider_security_contact_address": {
+ "type": "boolean"
+ },
+ "include_provider_security_contact_address_city": {
+ "type": "string"
+ },
+ "include_provider_security_contact_address_country": {
+ "type": "string"
+ },
+ "include_provider_security_contact_address_state": {
+ "type": "string"
+ },
+ "include_provider_security_contact_address_street_address": {
+ "type": "string"
+ },
+ "include_provider_security_contact_address_zipcode": {
+ "type": "string"
+ },
+ "include_provider_security_contact_email": {
+ "type": "boolean"
+ },
+ "include_provider_security_contact_email_val": {
+ "format": "email",
+ "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "include_security_measures_accountability": {
+ "type": "boolean"
+ },
+ "include_security_measures_accountability_val": {
+ "type": "string"
+ },
+ "include_security_measures_certification_or_assurance": {
+ "type": "boolean"
+ },
+ "include_security_measures_certification_or_assurance_val": {
+ "type": "string"
+ },
+ "include_security_measures_confidentiality_integrity": {
+ "type": "boolean"
+ },
+ "include_security_measures_confidentiality_integrity_val": {
+ "type": "string"
+ },
+ "include_security_measures_data_at_rest": {
+ "type": "boolean"
+ },
+ "include_security_measures_data_at_rest_val": {
+ "type": "string"
+ },
+ "include_security_measures_data_minimization": {
+ "type": "boolean"
+ },
+ "include_security_measures_data_minimization_val": {
+ "type": "string"
+ },
+ "include_security_measures_data_quality": {
+ "type": "boolean"
+ },
+ "include_security_measures_data_quality_val": {
+ "type": "string"
+ },
+ "include_security_measures_data_retention": {
+ "type": "boolean"
+ },
+ "include_security_measures_data_retention_val": {
+ "type": "string"
+ },
+ "include_security_measures_data_transmission": {
+ "type": "boolean"
+ },
+ "include_security_measures_data_transmission_val": {
+ "type": "string"
+ },
+ "include_security_measures_event_logging": {
+ "type": "boolean"
+ },
+ "include_security_measures_event_logging_val": {
+ "type": "string"
+ },
+ "include_security_measures_identity_auth": {
+ "type": "boolean"
+ },
+ "include_security_measures_identity_auth_val": {
+ "type": "string"
+ },
+ "include_security_measures_it_security_governance": {
+ "type": "boolean"
+ },
+ "include_security_measures_it_security_governance_val": {
+ "type": "string"
+ },
+ "include_security_measures_physical_security": {
+ "type": "boolean"
+ },
+ "include_security_measures_physical_security_val": {
+ "type": "string"
+ },
+ "include_security_measures_portability_and_erasure": {
+ "type": "boolean"
+ },
+ "include_security_measures_portability_and_erasure_val": {
+ "type": "string"
+ },
+ "include_security_measures_pseudonym_encryption": {
+ "type": "boolean"
+ },
+ "include_security_measures_pseudonym_encryption_val": {
+ "type": "string"
+ },
+ "include_security_measures_restore_data_access": {
+ "type": "boolean"
+ },
+ "include_security_measures_restore_data_access_val": {
+ "type": "string"
+ },
+ "include_security_measures_security_policy": {
+ "type": "boolean"
+ },
+ "include_security_measures_system_configuration": {
+ "type": "boolean"
+ },
+ "include_security_measures_system_configuration_val": {
+ "type": "string"
+ },
+ "include_security_measures_testing_assessment": {
+ "type": "boolean"
+ },
+ "include_security_measures_testing_assessment_val": {
+ "type": "string"
+ },
+ "include_security_policy": {
+ "type": "boolean"
+ },
+ "include_security_policy_fedramp_auth": {
+ "type": "boolean"
+ },
+ "include_security_policy_hipaa": {
+ "type": "boolean"
+ },
+ "include_security_policy_hitrust": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_other": {
+ "type": "boolean"
+ },
+ "include_security_policy_iso27001": {
+ "type": "boolean"
+ },
+ "include_security_policy_other": {
+ "type": "string"
+ },
+ "include_security_policy_pci1": {
+ "type": "boolean"
+ },
+ "include_security_policy_pci2": {
+ "type": "boolean"
+ },
+ "include_security_policy_penetration_testing": {
+ "type": "boolean"
+ },
+ "include_security_policy_soc2": {
+ "type": "boolean"
+ },
+ "include_security_policy_soc2_type2": {
+ "type": "boolean"
+ },
+ "include_sensitive_data_restrictions_custom": {
+ "type": "boolean"
+ },
+ "include_sensitive_data_restrictions_custom_val": {
+ "type": "string"
+ },
+ "include_sensitive_data_restrictions_security_policy": {
+ "type": "boolean"
+ },
+ "include_service_provider_relationship": {
+ "type": "boolean"
+ },
+ "include_special_category_data": {
+ "type": "boolean"
+ },
+ "provider": {
+ "type": "string"
+ },
+ "security_policy_available_at": {
+ "type": "string"
+ },
+ "security_policy_type": {
+ "description": "Where the Security Policy is defined. For `external`, set `security_policy_available_at`.",
+ "enum": [
+ "defined in agreement",
+ "provider service",
+ "external"
+ ],
+ "type": "string"
+ },
+ "subprocessors_attributes": {
+ "additionalProperties": {
+ "additionalProperties": false,
+ "properties": {
+ "_destroy": {
+ "description": "Set to true with `id` to remove that subprocessor.",
+ "type": "boolean"
+ },
+ "country": {
+ "type": "string"
+ },
+ "id": {
+ "description": "ID of an existing subprocessor to update or remove. Omit to add a new subprocessor.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "processing_task": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "description": "Subprocessors, keyed by string index such as \"0\", \"1\". On create these are added to the template's subprocessors. On a draft update, an entry without `id` adds a new subprocessor; pass `id` to change one and `id` with `_destroy: true` to remove one.",
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+ },
+ "underlying_agreement_id": {
+ "description": "ID of the CSA this DPA supplements when `underlying_agreement_type` is `internal`.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "underlying_agreement_type": {
+ "description": "`internal` links a CSA in Common Paper (`underlying_agreement_id`, required); `external` describes another agreement in `underlying_agreement_val` (required). Defaults to `internal` when omitted on create.",
+ "enum": [
+ "internal",
+ "external"
+ ],
+ "type": "string"
+ },
+ "underlying_agreement_val": {
+ "description": "Description of the agreement this DPA supplements. Required when `underlying_agreement_type` is `external`.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "framework_terms_description": {
+ "description": "Custom framework terms description. Only used when framework_terms_type is \"description\".",
+ "type": "string"
+ },
+ "framework_terms_type": {
+ "description": "How framework terms are specified. Use \"new\" for standard terms or \"description\" to provide a custom framework_terms_description.",
+ "enum": [
+ "new",
+ "description"
+ ],
+ "type": "string"
+ },
+ "governing_law_country": {
+ "description": "The country whose laws govern the agreement.",
+ "type": "string"
+ },
+ "governing_law_region": {
+ "description": "The state or region whose laws govern the agreement.",
+ "type": "string"
+ },
+ "include_automated_payment_reminders": {
+ "description": "When true, automatically sends payment reminder emails.",
+ "type": "boolean"
+ },
+ "include_billing_info": {
+ "description": "When true, billing contact information (billing_name, billing_email) is included.",
+ "type": "boolean"
+ },
+ "include_billing_workflow": {
+ "description": "When true, enables a billing workflow after signing.",
+ "type": "boolean"
+ },
+ "include_expiration_date": {
+ "description": "Expiration date in YYYY-MM-DD format. Use when include_expiration_type is \"date\".",
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "include_expiration_days": {
+ "description": "Number of days until the agreement expires. Use when include_expiration_type is \"days\".",
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_expiration_type": {
+ "description": "How to set expiration: \"none\" (default), \"days\" (use include_expiration_days), or \"date\" (use include_expiration_date).",
+ "enum": [
+ "none",
+ "days",
+ "date"
+ ],
+ "type": "string"
+ },
+ "include_terms": {
+ "description": "When true, the standard terms are included with the agreement.",
+ "type": "boolean"
+ },
+ "loi_attributes": {
+ "additionalProperties": false,
+ "description": "Override loi terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "confidentiality_custom": {
+ "type": "string"
+ },
+ "confidentiality_mutual_include_loi": {
+ "type": "boolean"
+ },
+ "confidentiality_nda_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "confidentiality_nda_description": {
+ "type": "string"
+ },
+ "confidentiality_nda_include_loi": {
+ "type": "boolean"
+ },
+ "confidentiality_nda_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "confidentiality_type": {
+ "enum": [
+ "mutual",
+ "nda",
+ "provider",
+ "custom"
+ ],
+ "type": "string"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_custom_details": {
+ "type": "boolean"
+ },
+ "include_custom_details_val": {
+ "type": "string"
+ },
+ "include_fees": {
+ "type": "boolean"
+ },
+ "include_fees_amount": {
+ "type": "number"
+ },
+ "include_fees_amount_duration": {
+ "enum": [
+ "month",
+ "year",
+ "quarter"
+ ],
+ "type": "string"
+ },
+ "include_fees_include_amount": {
+ "type": "boolean"
+ },
+ "include_fees_include_other": {
+ "type": "boolean"
+ },
+ "include_fees_other": {
+ "type": "string"
+ },
+ "include_functionality": {
+ "type": "boolean"
+ },
+ "include_functionality_val": {
+ "type": "string"
+ },
+ "include_launch_date": {
+ "type": "boolean"
+ },
+ "include_launch_date_custom": {
+ "type": "string"
+ },
+ "include_launch_date_date": {
+ "format": "date-time",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$",
+ "type": "string"
+ },
+ "include_launch_date_type": {
+ "enum": [
+ "date",
+ "custom"
+ ],
+ "type": "string"
+ },
+ "product_name": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "manual_send": {
+ "description": "When true, the agreement is marked as manually sent outside the platform.",
+ "type": "boolean"
+ },
+ "message": {
+ "type": "string"
+ },
+ "negotiations_allowed": {
+ "description": "When true, the recipient can propose changes to the legal terms. For agreement types without separate business terms, that covers every term. CSA order forms, PSA statements of work, partnership business terms and software license order forms have their own `negotiations_allowed` flag.",
+ "type": "boolean"
+ },
+ "partnership_attributes": {
+ "additionalProperties": false,
+ "description": "Override partnership terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "effective_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "effective_date_type": {
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "type": "string"
+ },
+ "general_cap_amount_currency_val": {
+ "type": "number"
+ },
+ "general_cap_amount_either_currency": {
+ "type": "number"
+ },
+ "general_cap_amount_either_multiple": {
+ "type": "number"
+ },
+ "general_cap_amount_multiple_val": {
+ "type": "number"
+ },
+ "general_cap_amount_type": {
+ "enum": [
+ "multiple",
+ "currency",
+ "either",
+ "base"
+ ],
+ "type": "string"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_additional_warranties": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_include_company": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_include_company_val": {
+ "type": "string"
+ },
+ "include_additional_warranties_include_partner": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_include_partner_val": {
+ "type": "string"
+ },
+ "include_brand_guidelines": {
+ "type": "boolean"
+ },
+ "include_brand_guidelines_include_company": {
+ "type": "boolean"
+ },
+ "include_brand_guidelines_include_company_val": {
+ "type": "string"
+ },
+ "include_brand_guidelines_include_partner": {
+ "type": "boolean"
+ },
+ "include_brand_guidelines_include_partner_val": {
+ "type": "string"
+ },
+ "include_covered_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_company_claims": {
+ "type": "string"
+ },
+ "include_covered_claims_include_company_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_include_partner_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_partner_claims": {
+ "type": "string"
+ },
+ "include_dpa": {
+ "type": "boolean"
+ },
+ "include_dpa_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_dpa_location": {
+ "type": "string"
+ },
+ "include_dpa_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_increased_cap_amount": {
+ "type": "boolean"
+ },
+ "include_increased_cap_amount_currency": {
+ "type": "number"
+ },
+ "include_increased_cap_amount_either_currency": {
+ "type": "number"
+ },
+ "include_increased_cap_amount_either_multiple": {
+ "type": "string"
+ },
+ "include_increased_cap_amount_multiple": {
+ "type": "string"
+ },
+ "include_increased_cap_amount_type": {
+ "enum": [
+ "multiple",
+ "currency",
+ "either"
+ ],
+ "type": "string"
+ },
+ "include_increased_claims": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_confidentiality": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_confidentiality_misconduct": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_covered_claims": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_misconduct": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_other": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_other_val": {
+ "type": "string"
+ },
+ "include_unlimited_claims": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_confidentiality": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_confidentiality_misconduct": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_covered_claims": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_misconduct": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_other": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_other_val": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "partnership_business_terms_attributes": {
+ "additionalProperties": false,
+ "description": "Override partnership business terms terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "end_date_after_effective_date_amount": {
+ "type": "number"
+ },
+ "end_date_after_effective_date_unit": {
+ "enum": [
+ "month(s)",
+ "quarter(s)",
+ "year(s)"
+ ],
+ "type": "string"
+ },
+ "end_date_date": {
+ "type": "string"
+ },
+ "end_date_type": {
+ "enum": [
+ "date",
+ "effective date"
+ ],
+ "type": "string"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_obligations_company_brand": {
+ "type": "boolean"
+ },
+ "include_obligations_company_promotion": {
+ "type": "boolean"
+ },
+ "include_obligations_company_promotion_include_activities": {
+ "type": "boolean"
+ },
+ "include_obligations_company_promotion_include_activities_val": {
+ "type": "string"
+ },
+ "include_obligations_company_promotion_include_materials": {
+ "type": "boolean"
+ },
+ "include_obligations_company_promotion_include_materials_val": {
+ "type": "string"
+ },
+ "include_obligations_company_referral": {
+ "type": "boolean"
+ },
+ "include_obligations_company_referral_include_criteria": {
+ "type": "boolean"
+ },
+ "include_obligations_company_referral_include_criteria_val": {
+ "type": "string"
+ },
+ "include_obligations_company_referral_include_pay_sch": {
+ "type": "boolean"
+ },
+ "include_obligations_company_referral_include_pay_sch_amount": {
+ "type": "number"
+ },
+ "include_obligations_company_referral_include_pay_sch_custom": {
+ "type": "string"
+ },
+ "include_obligations_company_referral_include_pay_sch_unit": {
+ "enum": [
+ "U.S. Dollars",
+ "percent"
+ ],
+ "type": "string"
+ },
+ "include_obligations_company_sponsorship": {
+ "type": "boolean"
+ },
+ "include_obligations_company_sponsorship_include_benefits": {
+ "type": "boolean"
+ },
+ "include_obligations_company_sponsorship_include_benefits_val": {
+ "type": "string"
+ },
+ "include_obligations_company_sponsorship_include_payments": {
+ "type": "boolean"
+ },
+ "include_obligations_company_sponsorship_include_payments_amount": {
+ "type": "number"
+ },
+ "include_obligations_company_sponsorship_include_payments_unit": {
+ "enum": [
+ "U.S. Dollars",
+ "percent"
+ ],
+ "type": "string"
+ },
+ "include_obligations_partner_brand": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_promotion": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_promotion_include_activities": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_promotion_include_activities_val": {
+ "type": "string"
+ },
+ "include_obligations_partner_promotion_include_materials": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_promotion_include_materials_val": {
+ "type": "string"
+ },
+ "include_obligations_partner_referral": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_referral_include_criteria": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_referral_include_criteria_val": {
+ "type": "string"
+ },
+ "include_obligations_partner_referral_include_pay_sch": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_referral_include_pay_sch_amount": {
+ "type": "number"
+ },
+ "include_obligations_partner_referral_include_pay_sch_custom": {
+ "type": "string"
+ },
+ "include_obligations_partner_referral_include_pay_sch_unit": {
+ "enum": [
+ "U.S. Dollars",
+ "percent"
+ ],
+ "type": "string"
+ },
+ "include_obligations_partner_sponsorship": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_sponsorship_include_benefits": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_sponsorship_include_benefits_val": {
+ "type": "string"
+ },
+ "include_obligations_partner_sponsorship_include_payments": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_sponsorship_include_payments_amount": {
+ "type": "number"
+ },
+ "include_obligations_partner_sponsorship_include_payments_unit": {
+ "enum": [
+ "U.S. Dollars",
+ "percent"
+ ],
+ "type": "string"
+ },
+ "include_payment_process": {
+ "type": "boolean"
+ },
+ "include_payment_process_company": {
+ "type": "boolean"
+ },
+ "include_payment_process_company_include_address": {
+ "type": "boolean"
+ },
+ "include_payment_process_company_include_address_city": {
+ "type": "string"
+ },
+ "include_payment_process_company_include_address_country": {
+ "type": "string"
+ },
+ "include_payment_process_company_include_address_state": {
+ "type": "string"
+ },
+ "include_payment_process_company_include_address_street_address": {
+ "type": "string"
+ },
+ "include_payment_process_company_include_address_zipcode": {
+ "type": "string"
+ },
+ "include_payment_process_company_include_email": {
+ "type": "boolean"
+ },
+ "include_payment_process_company_include_email_val": {
+ "type": "string"
+ },
+ "include_payment_process_partner": {
+ "type": "boolean"
+ },
+ "include_payment_process_partner_include_address": {
+ "type": "boolean"
+ },
+ "include_payment_process_partner_include_address_city": {
+ "type": "string"
+ },
+ "include_payment_process_partner_include_address_country": {
+ "type": "string"
+ },
+ "include_payment_process_partner_include_address_state": {
+ "type": "string"
+ },
+ "include_payment_process_partner_include_address_street_address": {
+ "type": "string"
+ },
+ "include_payment_process_partner_include_address_zipcode": {
+ "type": "string"
+ },
+ "include_payment_process_partner_include_email": {
+ "type": "boolean"
+ },
+ "include_payment_process_partner_include_email_val": {
+ "type": "string"
+ },
+ "include_payment_schedule": {
+ "type": "boolean"
+ },
+ "include_payment_schedule_custom": {
+ "type": "string"
+ },
+ "include_payment_schedule_specified_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_payment_schedule_specified_timeframe": {
+ "enum": [
+ "receipt",
+ "date"
+ ],
+ "type": "string"
+ },
+ "include_payment_schedule_specified_unit": {
+ "enum": [
+ "day(s)",
+ "week(s)",
+ "month(s)",
+ "quarter(s)",
+ "year(s)"
+ ],
+ "type": "string"
+ },
+ "include_payment_schedule_type": {
+ "enum": [
+ "specified",
+ "custom"
+ ],
+ "type": "string"
+ },
+ "negotiations_allowed": {
+ "description": "When true, the recipient can propose changes to the business terms, even when the agreement-level `negotiations_allowed` is false. This only covers the business terms.",
+ "type": "boolean"
+ },
+ "territory_type": {
+ "enum": [
+ "worldwide",
+ "custom"
+ ],
+ "type": "string"
+ },
+ "territory_type_val": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "payment_link_url": {
+ "description": "A payment URL shown to the recipient after signing. Requires include_billing_workflow to be true and billing_workflow_type to be \"link\".",
+ "type": "string"
+ },
+ "pilot_attributes": {
+ "additionalProperties": false,
+ "description": "Override pilot terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "fees_type": {
+ "enum": [
+ "free",
+ "pilot_period_fees"
+ ],
+ "type": "string"
+ },
+ "general_cap_amount": {
+ "type": "number"
+ },
+ "general_cap_amount_type": {
+ "enum": [
+ "preceding",
+ "base",
+ "period"
+ ],
+ "type": "string"
+ },
+ "general_cap_period_currency": {
+ "type": "number"
+ },
+ "general_cap_period_qty": {
+ "type": "number"
+ },
+ "general_cap_preceding_amount": {
+ "type": "number"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_dpa": {
+ "type": "boolean"
+ },
+ "include_dpa_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_dpa_location": {
+ "type": "string"
+ },
+ "include_dpa_type": {
+ "enum": [
+ "description",
+ "attachment",
+ "standard"
+ ],
+ "type": "string"
+ },
+ "include_payment_process": {
+ "type": "boolean"
+ },
+ "include_technical_support": {
+ "type": "boolean"
+ },
+ "payment_process_automatic_frequency": {
+ "enum": [
+ "monthly",
+ "quarterly",
+ "annually",
+ "once_per_period"
+ ],
+ "type": "string"
+ },
+ "payment_process_invoice_days": {
+ "type": "number"
+ },
+ "payment_process_invoice_from": {
+ "enum": [
+ "receipt",
+ "date"
+ ],
+ "type": "string"
+ },
+ "payment_process_invoice_timeframe": {
+ "enum": [
+ "days",
+ "weeks",
+ "months",
+ "quarters",
+ "years"
+ ],
+ "type": "string"
+ },
+ "payment_process_type": {
+ "enum": [
+ "automatic",
+ "invoice"
+ ],
+ "type": "string"
+ },
+ "pilot_period_description": {
+ "type": "string"
+ },
+ "pilot_period_fees_description": {
+ "type": "string"
+ },
+ "product_description": {
+ "type": "string"
+ },
+ "technical_support_description": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "psa_attributes": {
+ "additionalProperties": false,
+ "description": "Override psa terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "additional_changes": {
+ "type": "string"
+ },
+ "customer_description": {
+ "type": "string"
+ },
+ "effective_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "effective_date_type": {
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "type": "string"
+ },
+ "general_cap_amount": {
+ "type": "number"
+ },
+ "general_cap_amount_type": {
+ "enum": [
+ "preceding",
+ "base",
+ "period"
+ ],
+ "type": "string"
+ },
+ "general_cap_period_currency": {
+ "type": "number"
+ },
+ "general_cap_period_qty": {
+ "type": "number"
+ },
+ "general_cap_preceding_amount": {
+ "type": "number"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_additional_changes": {
+ "type": "boolean"
+ },
+ "include_additional_warranties": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_by_customer": {
+ "type": "string"
+ },
+ "include_additional_warranties_by_provider": {
+ "type": "string"
+ },
+ "include_additional_warranties_include_by_customer": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_include_by_provider": {
+ "type": "boolean"
+ },
+ "include_covered_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_customer_claims": {
+ "type": "string"
+ },
+ "include_covered_claims_include_customer_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_include_provider_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_provider_claims": {
+ "type": "string"
+ },
+ "include_customer_insurance_min": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_add_provider_com_gen_liability": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_add_provider_cyber_liability": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_add_provider_errors_omissions": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_auto_liability_aggregate": {
+ "type": "number"
+ },
+ "include_customer_insurance_min_auto_liability_minimum": {
+ "type": "number"
+ },
+ "include_customer_insurance_min_cyber_liability_aggregate": {
+ "type": "number"
+ },
+ "include_customer_insurance_min_cyber_liability_minimum": {
+ "type": "number"
+ },
+ "include_customer_insurance_min_employer_liability_aggregate": {
+ "type": "number"
+ },
+ "include_customer_insurance_min_employer_liability_minimum": {
+ "type": "number"
+ },
+ "include_customer_insurance_min_general_liability_aggregate": {
+ "type": "number"
+ },
+ "include_customer_insurance_min_general_liability_minimum": {
+ "type": "number"
+ },
+ "include_customer_insurance_min_include_add_provider": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_include_auto_liability": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_include_cyber_liability": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_include_employer_liability": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_include_general_liability": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_include_workers_comp": {
+ "type": "boolean"
+ },
+ "include_customer_policies": {
+ "type": "boolean"
+ },
+ "include_customer_policies_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_customer_policies_location": {
+ "type": "string"
+ },
+ "include_customer_policies_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_dpa": {
+ "type": "boolean"
+ },
+ "include_dpa_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_dpa_location": {
+ "type": "string"
+ },
+ "include_dpa_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_increased_cap_amount": {
+ "type": "boolean"
+ },
+ "include_increased_claims": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_confidentiality": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_confidentiality_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_privsec": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_privsec_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_other": {
+ "type": "boolean"
+ },
+ "include_increased_claims_indemnification_obligation": {
+ "type": "boolean"
+ },
+ "include_increased_claims_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_other": {
+ "type": "string"
+ },
+ "include_provider_insurance_min": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_add_customer_com_gen_liability": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_add_customer_cyber_liability": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_add_customer_errors_omissions": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_auto_liability_aggregate": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_auto_liability_minimum": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_cyber_liability_aggregate": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_cyber_liability_minimum": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_employer_liability_aggregate": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_employer_liability_minimum": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_general_liability_aggregate": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_general_liability_minimum": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_include_add_customer": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_include_auto_liability": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_include_cyber_liability": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_include_employer_liability": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_include_general_liability": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_include_workers_comp": {
+ "type": "boolean"
+ },
+ "include_publicity_rights": {
+ "type": "boolean"
+ },
+ "include_publicity_rights_type": {
+ "enum": [
+ "public",
+ "non-public"
+ ],
+ "type": "string"
+ },
+ "include_security_policy": {
+ "type": "boolean"
+ },
+ "include_security_policy_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_security_policy_fedramp_auth": {
+ "type": "boolean"
+ },
+ "include_security_policy_hitrust": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_annual_maintenance": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_other": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_other_val": {
+ "type": "string"
+ },
+ "include_security_policy_iso27001": {
+ "type": "boolean"
+ },
+ "include_security_policy_location": {
+ "type": "string"
+ },
+ "include_security_policy_pci1": {
+ "type": "boolean"
+ },
+ "include_security_policy_pci2": {
+ "type": "boolean"
+ },
+ "include_security_policy_penetration_testing": {
+ "type": "boolean"
+ },
+ "include_security_policy_soc2_type1": {
+ "type": "boolean"
+ },
+ "include_security_policy_soc2_type2": {
+ "type": "boolean"
+ },
+ "include_security_policy_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_unlimited_claims": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_confidentiality": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_confidentiality_negligence": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_privsec": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_privsec_negligence": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_include_other": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_indemnification_obligation": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_negligence": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_other": {
+ "type": "string"
+ },
+ "increased_cap_amount_currency": {
+ "type": "number"
+ },
+ "increased_cap_amount_period_currency": {
+ "type": "number"
+ },
+ "increased_cap_amount_period_qty": {
+ "type": "number"
+ },
+ "increased_cap_amount_qty": {
+ "type": "number"
+ },
+ "increased_cap_amount_type": {
+ "enum": [
+ "qty",
+ "currency",
+ "period"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "psa_statement_of_work_attributes": {
+ "additionalProperties": false,
+ "description": "Override psa statement of work terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "additional_changes": {
+ "type": "string"
+ },
+ "cost": {
+ "type": "number"
+ },
+ "description": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "fees_attributes": {
+ "additionalProperties": {
+ "anyOf": [
+ {
+ "additionalProperties": false,
+ "description": "Fees::Flat (fee_type \"flat\"). A fixed recurring fee, e.g. a platform subscription. Set type to \"Fees::Flat\" or fee_type to \"flat\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Fixed amount in the order form's fees_currency, charged per fee_period. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"flat\". Alternative to type.",
+ "enum": [
+ "flat"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Flat\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Flat"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Discount (fee_type \"discount\"). A discount, as a fixed amount or a percentage, applied forever, once, or for a number of months. Set type to \"Fees::Discount\" or fee_type to \"discount\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Discount size: an amount in fees_currency when discount_type is fixed_amount (a plain amount, not cents: 20 means 20.00), or a percentage (e.g. 10 for 10%) when it is percentage.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "discount_duration_amount": {
+ "description": "Number of months the discount applies. Required when discount_duration_type is multiple_months.",
+ "type": "number"
+ },
+ "discount_duration_type": {
+ "description": "How long the discount applies. multiple_months also needs discount_duration_amount.",
+ "enum": [
+ "forever",
+ "once",
+ "multiple_months"
+ ],
+ "type": "string"
+ },
+ "discount_type": {
+ "description": "Whether cost is a currency amount or a percentage.",
+ "enum": [
+ "fixed_amount",
+ "percentage"
+ ],
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"discount\". Alternative to type.",
+ "enum": [
+ "discount"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Discount\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Discount"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Cost (fee_type \"cost\"). A per-unit fee: price per unit times quantity, e.g. seats. Set type to \"Fees::Cost\" or fee_type to \"cost\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Price per unit in fees_currency. The row total is quantity x cost. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"cost\". Alternative to type.",
+ "enum": [
+ "cost"
+ ],
+ "type": "string"
+ },
+ "quantity": {
+ "description": "Number of units.",
+ "type": "number"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Cost\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Cost"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Attachment (fee_type \"attachment\"). A fee described in an uploaded attachment instead of in the table. Set type to \"Fees::Attachment\" or fee_type to \"attachment\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "attachment_id": {
+ "description": "ID of an attachment uploaded with upload-attachment.",
+ "type": "string"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"attachment\". Alternative to type.",
+ "enum": [
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Attachment\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Attachment"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Graduated (fee_type \"graduated\"). Tiered pricing, with the price set per tier in graduated_fee_tiers_attributes. Set type to \"Fees::Graduated\" or fee_type to \"graduated\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"graduated\". Alternative to type.",
+ "enum": [
+ "graduated"
+ ],
+ "type": "string"
+ },
+ "graduated_fee_tiers_attributes": {
+ "additionalProperties": {
+ "additionalProperties": false,
+ "properties": {
+ "flat_price": {
+ "type": "number"
+ },
+ "price_per_unit": {
+ "type": "string"
+ },
+ "upper_limit": {
+ "type": "number"
+ }
+ },
+ "type": "object"
+ },
+ "description": "Graduated fee tiers. Use string keys such as \"0\", \"1\".",
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Graduated\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Graduated"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Included (fee_type \"included\"). An item included at no charge. Set type to \"Fees::Included\" or fee_type to \"included\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"included\". Alternative to type.",
+ "enum": [
+ "included"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Included\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Included"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Metered (fee_type \"metered\"). Usage-based pricing, billed per unit used. Set type to \"Fees::Metered\" or fee_type to \"metered\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Price per unit of usage in fees_currency. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"metered\". Alternative to type.",
+ "enum": [
+ "metered"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Metered\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Metered"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::OneTime (fee_type \"one_time\"). A one-time charge, such as a setup fee. Set type to \"Fees::OneTime\" or fee_type to \"one_time\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "One-time amount in fees_currency, charged once rather than per fee_period. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"one_time\". Alternative to type.",
+ "enum": [
+ "one_time"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::OneTime\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::OneTime"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Text (fee_type \"text\"). A fee term described in free text. Set type to \"Fees::Text\" or fee_type to \"text\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"text\". Alternative to type.",
+ "enum": [
+ "text"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Text\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Text"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ }
+ ]
+ },
+ "description": "Fee line items. Use string keys such as \"0\", \"1\". Replaces template fees when provided.",
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_additional_changes": {
+ "type": "boolean"
+ },
+ "include_customer_obligation": {
+ "type": "boolean"
+ },
+ "include_customer_obligation_val": {
+ "type": "string"
+ },
+ "include_deliverables": {
+ "type": "boolean"
+ },
+ "include_deliverables_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_deliverables_description": {
+ "type": "string"
+ },
+ "include_deliverables_include_acceptance": {
+ "type": "boolean"
+ },
+ "include_deliverables_include_attachment": {
+ "type": "boolean"
+ },
+ "include_deliverables_include_draft_deliverables": {
+ "type": "boolean"
+ },
+ "include_deliverables_rejection_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_deliverables_rejection_unit": {
+ "enum": [
+ "hours",
+ "days",
+ "weeks",
+ "months"
+ ],
+ "type": "string"
+ },
+ "include_deliverables_resubmission_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_deliverables_resubmission_unit": {
+ "enum": [
+ "hours",
+ "days",
+ "weeks",
+ "months"
+ ],
+ "type": "string"
+ },
+ "include_fees_other": {
+ "type": "boolean"
+ },
+ "include_fees_other_val": {
+ "type": "string"
+ },
+ "include_fees_table": {
+ "type": "boolean"
+ },
+ "include_fees_table_total": {
+ "type": "boolean"
+ },
+ "include_fees_travel": {
+ "type": "boolean"
+ },
+ "include_fees_travel_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_fees_travel_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_fees_travel_val": {
+ "type": "string"
+ },
+ "include_third_party_customer": {
+ "type": "boolean"
+ },
+ "include_third_party_include_description": {
+ "type": "boolean"
+ },
+ "include_third_party_include_description_val": {
+ "type": "string"
+ },
+ "include_third_party_materials": {
+ "type": "boolean"
+ },
+ "include_third_party_provider": {
+ "type": "boolean"
+ },
+ "include_time_of_assignment": {
+ "type": "boolean"
+ },
+ "include_time_of_assignment_type": {
+ "enum": [
+ "created",
+ "paid"
+ ],
+ "type": "string"
+ },
+ "invoice_period_description": {
+ "type": "string"
+ },
+ "negotiations_allowed": {
+ "description": "When true, the recipient can propose changes to the statement of work, even when the agreement-level `negotiations_allowed` is false. This only covers the statement of work.",
+ "type": "boolean"
+ },
+ "payment_period": {
+ "type": "number"
+ },
+ "payment_period_other": {
+ "type": "string"
+ },
+ "payment_period_timeframe": {
+ "enum": [
+ "receipt",
+ "invoice",
+ "Customer's receipt of invoice",
+ "date of invoice"
+ ],
+ "type": "string"
+ },
+ "payment_period_type": {
+ "enum": [
+ "standard",
+ "other"
+ ],
+ "type": "string"
+ },
+ "payment_period_unit": {
+ "enum": [
+ "day(s)",
+ "week(s)",
+ "month(s)",
+ "quarter(s)",
+ "year(s)"
+ ],
+ "type": "string"
+ },
+ "quantity": {
+ "type": "number"
+ },
+ "services_description": {
+ "type": "string"
+ },
+ "sow_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "sow_date_type": {
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "type": "string"
+ },
+ "sow_term_amount": {
+ "type": "number"
+ },
+ "sow_term_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "sow_term_type": {
+ "enum": [
+ "deliverables",
+ "period",
+ "date"
+ ],
+ "type": "string"
+ },
+ "sow_term_unit": {
+ "enum": [
+ "month(s)",
+ "quarter(s)",
+ "year(s)"
+ ],
+ "type": "string"
+ },
+ "type": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "recipient_email": {
+ "format": "email",
+ "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "recipient_name": {
+ "type": "string"
+ },
+ "recipient_notice_email_address": {
+ "description": "Email address for legal notices to the recipient.",
+ "format": "email",
+ "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "recipient_organization": {
+ "type": "string"
+ },
+ "recipient_role": {
+ "description": "PSA only. The recipient's role: `Customer` (the default) or `Provider`. Send it with `sender_role`; the two must be one `Provider` and one `Customer`. Other standard agreement types ignore it.",
+ "type": "string"
+ },
+ "sender_last_to_sign": {
+ "description": "When true, your signer signs after the recipient.",
+ "type": "boolean"
+ },
+ "sender_notice_email_address": {
+ "description": "Email address for legal notices to the sender.",
+ "format": "email",
+ "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "sender_role": {
+ "description": "PSA only. Your company's role: `Provider` (the default) or `Customer` when you hire the recipient to provide the services. Send it with `recipient_role`; the two must be one `Provider` and one `Customer`. When reading a PSA, an empty `sender_role` means `Provider`. Other standard agreement types ignore it.",
+ "type": "string"
+ },
+ "software_license_attributes": {
+ "additionalProperties": false,
+ "description": "Override software license terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "effective_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "effective_date_type": {
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "type": "string"
+ },
+ "general_cap_amount": {
+ "type": "number"
+ },
+ "general_cap_amount_type": {
+ "enum": [
+ "preceding",
+ "base",
+ "period"
+ ],
+ "type": "string"
+ },
+ "general_cap_period_currency": {
+ "type": "number"
+ },
+ "general_cap_period_qty": {
+ "type": "number"
+ },
+ "general_cap_preceding_amount": {
+ "type": "number"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_additional_warranties": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_by_customer": {
+ "type": "string"
+ },
+ "include_additional_warranties_by_provider": {
+ "type": "string"
+ },
+ "include_additional_warranties_include_by_customer": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_include_by_provider": {
+ "type": "boolean"
+ },
+ "include_ai_addendum": {
+ "type": "boolean"
+ },
+ "include_ai_addendum_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_covered_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_customer_claims": {
+ "type": "string"
+ },
+ "include_covered_claims_include_customer_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_include_provider_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_provider_claims": {
+ "type": "string"
+ },
+ "include_dpa": {
+ "type": "boolean"
+ },
+ "include_dpa_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_dpa_location": {
+ "type": "string"
+ },
+ "include_dpa_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_increased_cap_amount": {
+ "type": "boolean"
+ },
+ "include_increased_claims": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_confidentiality": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_confidentiality_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_other": {
+ "type": "boolean"
+ },
+ "include_increased_claims_indemnification_obligation": {
+ "type": "boolean"
+ },
+ "include_increased_claims_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_other": {
+ "type": "string"
+ },
+ "include_increased_claims_restrictions": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_confidentiality": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_confidentiality_negligence": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_include_other": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_indemnification_obligation": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_license_or_restrictions": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_negligence": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_other": {
+ "type": "string"
+ },
+ "increased_cap_amount_currency": {
+ "type": "number"
+ },
+ "increased_cap_amount_period_currency": {
+ "type": "number"
+ },
+ "increased_cap_amount_period_qty": {
+ "type": "number"
+ },
+ "increased_cap_amount_qty": {
+ "type": "number"
+ },
+ "increased_cap_amount_type": {
+ "enum": [
+ "qty",
+ "currency",
+ "period"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "software_license_order_form_attributes": {
+ "additionalProperties": false,
+ "description": "Override software license order form terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "additional_changes": {
+ "type": "string"
+ },
+ "deletion_procedure_include_custom": {
+ "type": "boolean"
+ },
+ "deletion_procedure_include_custom_description": {
+ "type": "string"
+ },
+ "deletion_procedure_include_customer_disable": {
+ "type": "boolean"
+ },
+ "deletion_procedure_include_customer_proof": {
+ "type": "boolean"
+ },
+ "deletion_procedure_include_provider_disable": {
+ "type": "boolean"
+ },
+ "fee_custom_unit": {
+ "type": "string"
+ },
+ "fee_period": {
+ "enum": [
+ "Subscription Period",
+ "month",
+ "year",
+ "Custom unit"
+ ],
+ "type": "string"
+ },
+ "fees_attributes": {
+ "additionalProperties": {
+ "anyOf": [
+ {
+ "additionalProperties": false,
+ "description": "Fees::Flat (fee_type \"flat\"). A fixed recurring fee, e.g. a platform subscription. Set type to \"Fees::Flat\" or fee_type to \"flat\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Fixed amount in the order form's fees_currency, charged per fee_period. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"flat\". Alternative to type.",
+ "enum": [
+ "flat"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Flat\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Flat"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Discount (fee_type \"discount\"). A discount, as a fixed amount or a percentage, applied forever, once, or for a number of months. Set type to \"Fees::Discount\" or fee_type to \"discount\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Discount size: an amount in fees_currency when discount_type is fixed_amount (a plain amount, not cents: 20 means 20.00), or a percentage (e.g. 10 for 10%) when it is percentage.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "discount_duration_amount": {
+ "description": "Number of months the discount applies. Required when discount_duration_type is multiple_months.",
+ "type": "number"
+ },
+ "discount_duration_type": {
+ "description": "How long the discount applies. multiple_months also needs discount_duration_amount.",
+ "enum": [
+ "forever",
+ "once",
+ "multiple_months"
+ ],
+ "type": "string"
+ },
+ "discount_type": {
+ "description": "Whether cost is a currency amount or a percentage.",
+ "enum": [
+ "fixed_amount",
+ "percentage"
+ ],
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"discount\". Alternative to type.",
+ "enum": [
+ "discount"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Discount\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Discount"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Cost (fee_type \"cost\"). A per-unit fee: price per unit times quantity, e.g. seats. Set type to \"Fees::Cost\" or fee_type to \"cost\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Price per unit in fees_currency. The row total is quantity x cost. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"cost\". Alternative to type.",
+ "enum": [
+ "cost"
+ ],
+ "type": "string"
+ },
+ "quantity": {
+ "description": "Number of units.",
+ "type": "number"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Cost\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Cost"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Attachment (fee_type \"attachment\"). A fee described in an uploaded attachment instead of in the table. Set type to \"Fees::Attachment\" or fee_type to \"attachment\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "attachment_id": {
+ "description": "ID of an attachment uploaded with upload-attachment.",
+ "type": "string"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"attachment\". Alternative to type.",
+ "enum": [
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Attachment\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Attachment"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Graduated (fee_type \"graduated\"). Tiered pricing, with the price set per tier in graduated_fee_tiers_attributes. Set type to \"Fees::Graduated\" or fee_type to \"graduated\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"graduated\". Alternative to type.",
+ "enum": [
+ "graduated"
+ ],
+ "type": "string"
+ },
+ "graduated_fee_tiers_attributes": {
+ "additionalProperties": {
+ "additionalProperties": false,
+ "properties": {
+ "flat_price": {
+ "type": "number"
+ },
+ "price_per_unit": {
+ "type": "string"
+ },
+ "upper_limit": {
+ "type": "number"
+ }
+ },
+ "type": "object"
+ },
+ "description": "Graduated fee tiers. Use string keys such as \"0\", \"1\".",
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Graduated\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Graduated"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Included (fee_type \"included\"). An item included at no charge. Set type to \"Fees::Included\" or fee_type to \"included\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"included\". Alternative to type.",
+ "enum": [
+ "included"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Included\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Included"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Metered (fee_type \"metered\"). Usage-based pricing, billed per unit used. Set type to \"Fees::Metered\" or fee_type to \"metered\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Price per unit of usage in fees_currency. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"metered\". Alternative to type.",
+ "enum": [
+ "metered"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Metered\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Metered"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::OneTime (fee_type \"one_time\"). A one-time charge, such as a setup fee. Set type to \"Fees::OneTime\" or fee_type to \"one_time\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "One-time amount in fees_currency, charged once rather than per fee_period. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"one_time\". Alternative to type.",
+ "enum": [
+ "one_time"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::OneTime\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::OneTime"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Text (fee_type \"text\"). A fee term described in free text. Set type to \"Fees::Text\" or fee_type to \"text\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"text\". Alternative to type.",
+ "enum": [
+ "text"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Text\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Text"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ }
+ ]
+ },
+ "description": "Fee line items. Use string keys such as \"0\", \"1\". Replaces template fees when provided.",
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+ },
+ "fees_currency": {
+ "enum": [
+ "USD",
+ "EUR",
+ "GBP",
+ "CAD",
+ "AUD",
+ "SGD",
+ "ILS",
+ "JPY",
+ "CHF",
+ "HKD"
+ ],
+ "type": "string"
+ },
+ "fees_include_fee_increase_upon_renewal": {
+ "type": "boolean"
+ },
+ "fees_include_fee_increase_upon_renewal_fee": {
+ "type": "number"
+ },
+ "fees_include_fee_increase_upon_renewal_type": {
+ "enum": [
+ "will",
+ "may"
+ ],
+ "type": "string"
+ },
+ "fees_inclusive_of_taxes": {
+ "type": "boolean"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_additional_changes": {
+ "type": "boolean"
+ },
+ "include_license_compliance_verification": {
+ "type": "boolean"
+ },
+ "include_license_compliance_verification_description": {
+ "type": "string"
+ },
+ "include_license_limits": {
+ "type": "boolean"
+ },
+ "include_license_limits_description": {
+ "type": "string"
+ },
+ "include_payment_process_include_billing_email": {
+ "type": "boolean"
+ },
+ "include_pilot_period": {
+ "type": "boolean"
+ },
+ "include_pilot_period_duration_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_pilot_period_duration_type": {
+ "enum": [
+ "day",
+ "week",
+ "month"
+ ],
+ "type": "string"
+ },
+ "include_pilot_period_include_fees": {
+ "type": "boolean"
+ },
+ "include_pilot_period_include_fees_amount": {
+ "type": "number"
+ },
+ "include_pilot_period_include_modifications": {
+ "type": "boolean"
+ },
+ "include_pilot_period_include_modifications_description": {
+ "type": "string"
+ },
+ "include_services": {
+ "type": "boolean"
+ },
+ "include_services_description": {
+ "type": "string"
+ },
+ "negotiations_allowed": {
+ "description": "When true, the recipient can propose changes to the order form, even when the agreement-level `negotiations_allowed` is false. This only covers the order form.",
+ "type": "boolean"
+ },
+ "order_date_date": {
+ "type": "string"
+ },
+ "order_date_type": {
+ "enum": [
+ "signature",
+ "date",
+ "other"
+ ],
+ "type": "string"
+ },
+ "payment_process_automatic_frequency": {
+ "enum": [
+ "monthly",
+ "quarterly",
+ "semiannually",
+ "annually"
+ ],
+ "type": "string"
+ },
+ "payment_process_type": {
+ "enum": [
+ "automatic",
+ "invoice",
+ "custom"
+ ],
+ "type": "string"
+ },
+ "payment_process_type_custom_val": {
+ "type": "string"
+ },
+ "payment_process_type_invoice_amount": {
+ "type": "number"
+ },
+ "payment_process_type_invoice_custom_unit": {
+ "type": "string"
+ },
+ "payment_process_type_invoice_duration": {
+ "enum": [
+ "day",
+ "week",
+ "month",
+ "year",
+ "day(s)",
+ "week(s)",
+ "month(s)",
+ "year(s)"
+ ],
+ "type": "string"
+ },
+ "payment_process_type_invoice_duration_start": {
+ "enum": [
+ "Customer's receipt of invoice",
+ "date of invoice"
+ ],
+ "type": "string"
+ },
+ "payment_process_type_invoice_type": {
+ "enum": [
+ "monthly",
+ "quarterly",
+ "semiannually",
+ "annually",
+ "Custom unit"
+ ],
+ "type": "string"
+ },
+ "permitted_uses_include_custom": {
+ "type": "boolean"
+ },
+ "permitted_uses_include_custom_description": {
+ "type": "string"
+ },
+ "permitted_uses_include_customers_affiliates": {
+ "type": "boolean"
+ },
+ "permitted_uses_include_internal_business": {
+ "type": "boolean"
+ },
+ "pilot_period_stripe_product_id": {
+ "type": "string"
+ },
+ "software_description": {
+ "type": "string"
+ },
+ "subscription_auto_renew": {
+ "enum": [
+ "days",
+ "subscription_end"
+ ],
+ "type": "string"
+ },
+ "subscription_period": {
+ "type": "number"
+ },
+ "subscription_period_unit": {
+ "type": "string"
+ },
+ "subscription_renewal_notice_days": {
+ "type": "number"
+ },
+ "warranty_period_description_amount": {
+ "type": "number"
+ },
+ "warranty_period_description_duration": {
+ "enum": [
+ "day",
+ "week",
+ "month",
+ "year"
+ ],
+ "type": "string"
+ },
+ "warranty_period_description_duration_start": {
+ "enum": [
+ "initial delivery of the Software",
+ "delivery of the Software and each subsequent Update",
+ "the Order Date"
+ ],
+ "type": "string"
+ },
+ "warranty_period_type": {
+ "enum": [
+ "description",
+ "none"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "test_agreement": {
+ "description": "When true, marks the agreement as a test. Test agreements do not count against your monthly limit.",
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "recipient_name",
+ "recipient_email"
+ ],
+ "type": "object"
+ },
+ "cc_users": {
+ "items": {
+ "format": "email",
+ "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "draft": {
+ "description": "When true, the agreement is saved as a draft and not sent to the recipient. Use POST /v1/agreements/{id}/send to send a draft agreement later.",
+ "type": "boolean"
+ },
+ "owner_id": {
+ "description": "User id of the agreement owner (sender).",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "signer_id": {
+ "description": "User id of the signer from the owner's organization.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "template_id": {
+ "description": "UUID of a template from `GET /v1/templates`. Accepts both Common Paper standard templates and uploaded PDF templates (`type` `uploaded_template`).",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ }
+ },
+ "required": [
+ "template_id",
+ "owner_id",
+ "signer_id",
+ "agreement"
+ ],
+ "type": "object"
+ }
+]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": {
- "enum": [
- "signature",
- "date"
- ],
- "type": "string"
- },
- "framework_terms_type": {
- "type": "string"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "parent_agreement_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "underlying_agreement_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "underlying_agreement_type": {
- "type": "string"
- },
- "underlying_agreement_val": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "baa_attributes": {
- "additionalProperties": false,
- "description": "Override baa terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "aggregation_limitations_permitted": {
- "type": "boolean"
- },
- "aggregation_limitations_permitted_val": {
- "type": "string"
- },
- "breach_notification_unit": {
- "enum": [
- "hours",
- "business days",
- "calendar days"
- ],
- "type": "string"
- },
- "breach_notification_val": {
- "type": "number"
- },
- "business_associate_relationship_type": {
- "enum": [
- "provider",
- "company"
- ],
- "type": "string"
- },
- "deidentification_limitations_include_purpose": {
- "type": "boolean"
- },
- "deidentification_limitations_include_requirements": {
- "type": "boolean"
- },
- "deidentification_limitations_permitted": {
- "type": "boolean"
- },
- "deidentification_limitations_purpose_val": {
- "type": "string"
- },
- "deidentification_limitations_requirements_val": {
- "type": "string"
- },
- "designated_record_set_provider_maintains": {
- "type": "boolean"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_aggregation_limitations": {
- "type": "boolean"
- },
- "include_deidentification_limitations": {
- "type": "boolean"
- },
- "include_limitations": {
- "type": "boolean"
- },
- "include_offshore_limitations": {
- "type": "boolean"
- },
- "include_subcontract_limitations": {
- "type": "boolean"
- },
- "offshore_limitations_permitted": {
- "type": "boolean"
- },
- "offshore_limitations_permitted_val": {
- "type": "string"
- },
- "subcontract_limitations_include_notice": {
- "type": "boolean"
- },
- "subcontract_limitations_include_permission": {
- "type": "boolean"
- },
- "subcontract_limitations_notice_val": {
- "type": "string"
- },
- "subcontract_limitations_permission_val": {
- "type": "string"
- },
- "subcontract_limitations_permitted": {
- "type": "boolean"
- },
- "underlying_agreement_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "underlying_agreement_type": {
- "enum": [
- "internal",
- "external",
- "none"
- ],
- "type": "string"
- },
- "underlying_agreement_val": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "billing_email": {
- "description": "Email of the billing contact. Used when include_billing_info is true.",
- "format": "email",
- "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
- "type": "string"
- },
- "billing_name": {
- "description": "Name of the billing contact. Used when include_billing_info is true.",
- "type": "string"
- },
- "billing_workflow_type": {
- "description": "The type of billing workflow. Use \"link\" to provide a payment_link_url, or \"stripe\" for Stripe-managed billing.",
- "enum": [
- "link",
- "stripe"
- ],
- "type": "string"
- },
- "chosen_courts_country": {
- "description": "The country in which disputes will be resolved.",
- "type": "string"
- },
- "chosen_courts_region": {
- "description": "The state or region in which disputes will be resolved.",
- "type": "string"
- },
- "csa_attributes": {
- "additionalProperties": false,
- "description": "Override csa terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "customer_description": {
- "type": "string"
- },
- "effective_date": {
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "effective_date_marketplace": {
- "enum": [
- "AWS",
- "GCP",
- "Azure"
- ],
- "type": "string"
- },
- "effective_date_type": {
- "enum": [
- "signature",
- "date",
- "marketplace_acceptance"
- ],
- "type": "string"
- },
- "general_cap_amount": {
- "type": "number"
- },
- "general_cap_amount_type": {
- "enum": [
- "preceding",
- "base",
- "period"
- ],
- "type": "string"
- },
- "general_cap_period_currency": {
- "type": "number"
- },
- "general_cap_period_qty": {
- "type": "number"
- },
- "general_cap_preceding_amount": {
- "type": "number"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_acceptable_use_policy": {
- "type": "boolean"
- },
- "include_acceptable_use_policy_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_acceptable_use_policy_location": {
- "type": "string"
- },
- "include_acceptable_use_policy_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_additional_warranties": {
- "type": "boolean"
- },
- "include_additional_warranties_by_customer": {
- "type": "string"
- },
- "include_additional_warranties_by_provider": {
- "type": "string"
- },
- "include_additional_warranties_include_by_customer": {
- "type": "boolean"
- },
- "include_additional_warranties_include_by_provider": {
- "type": "boolean"
- },
- "include_ai_addendum": {
- "type": "boolean"
- },
- "include_ai_addendum_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_covered_claims": {
- "type": "boolean"
- },
- "include_covered_claims_customer_claims": {
- "type": "string"
- },
- "include_covered_claims_include_customer_claims": {
- "type": "boolean"
- },
- "include_covered_claims_include_provider_claims": {
- "type": "boolean"
- },
- "include_covered_claims_provider_claims": {
- "type": "string"
- },
- "include_dpa": {
- "type": "boolean"
- },
- "include_dpa_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_dpa_location": {
- "type": "string"
- },
- "include_dpa_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_increased_cap_amount": {
- "type": "boolean"
- },
- "include_increased_claims": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_confidentiality": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_confidentiality_negligence": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_privsec": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_privsec_negligence": {
- "type": "boolean"
- },
- "include_increased_claims_include_other": {
- "type": "boolean"
- },
- "include_increased_claims_indemnification_obligation": {
- "type": "boolean"
- },
- "include_increased_claims_other": {
- "type": "string"
- },
- "include_insurance_minimums": {
- "type": "boolean"
- },
- "include_insurance_minimums_add_customer": {
- "type": "boolean"
- },
- "include_insurance_minimums_add_customer_com_gen_liability": {
- "type": "boolean"
- },
- "include_insurance_minimums_add_customer_cyber_liability": {
- "type": "boolean"
- },
- "include_insurance_minimums_add_customer_errors_omissions": {
- "type": "boolean"
- },
- "include_insurance_minimums_additional_information": {
- "type": "boolean"
- },
- "include_insurance_minimums_additional_information_text": {
- "type": "string"
- },
- "include_insurance_minimums_cyber_liability_aggregate": {
- "type": "number"
- },
- "include_insurance_minimums_cyber_liability_minimum": {
- "type": "number"
- },
- "include_insurance_minimums_employer_liability_aggregate": {
- "type": "number"
- },
- "include_insurance_minimums_employer_liability_minimum": {
- "type": "number"
- },
- "include_insurance_minimums_general_liability_aggregate": {
- "type": "number"
- },
- "include_insurance_minimums_general_liability_minimum": {
- "type": "number"
- },
- "include_insurance_minimums_include_cyber_liability": {
- "type": "boolean"
- },
- "include_insurance_minimums_include_employer_liability": {
- "type": "boolean"
- },
- "include_insurance_minimums_include_general_liability": {
- "type": "boolean"
- },
- "include_insurance_minimums_include_workers_compensation": {
- "type": "boolean"
- },
- "include_publicity_rights": {
- "type": "boolean"
- },
- "include_publicity_rights_type": {
- "enum": [
- "public",
- "non-public"
- ],
- "type": "string"
- },
- "include_security_policy": {
- "type": "boolean"
- },
- "include_security_policy_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_security_policy_fedramp_auth": {
- "type": "boolean"
- },
- "include_security_policy_hipaa": {
- "type": "boolean"
- },
- "include_security_policy_hitrust": {
- "type": "boolean"
- },
- "include_security_policy_include_annual_maintenance": {
- "type": "boolean"
- },
- "include_security_policy_include_location": {
- "type": "boolean"
- },
- "include_security_policy_include_other": {
- "type": "boolean"
- },
- "include_security_policy_include_reasonable_efforts": {
- "type": "boolean"
- },
- "include_security_policy_iso27001": {
- "type": "boolean"
- },
- "include_security_policy_location": {
- "type": "string"
- },
- "include_security_policy_other": {
- "type": "string"
- },
- "include_security_policy_pci1": {
- "type": "boolean"
- },
- "include_security_policy_pci2": {
- "type": "boolean"
- },
- "include_security_policy_penetration_testing": {
- "type": "boolean"
- },
- "include_security_policy_soc2": {
- "type": "boolean"
- },
- "include_security_policy_soc2_type2": {
- "type": "boolean"
- },
- "include_security_policy_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_supercap": {
- "description": "CSA 3.0 renamed `include_increased_cap_amount` to `include_supercap`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_increased_cap_amount`. Sending the other spelling returns a 422.",
- "type": "boolean"
- },
- "include_uncapped_claims": {
- "description": "CSA 3.0 renamed `include_unlimited_claims` to `include_uncapped_claims`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims`. Sending the other spelling returns a 422.",
- "type": "boolean"
- },
- "include_uncapped_claims_breach_of_confidentiality": {
- "description": "CSA 3.0 renamed `include_unlimited_claims_breach_of_confidentiality` to `include_uncapped_claims_breach_of_confidentiality`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_breach_of_confidentiality`. Sending the other spelling returns a 422.",
- "type": "boolean"
- },
- "include_uncapped_claims_breach_of_confidentiality_negligence": {
- "description": "CSA 3.0 renamed `include_unlimited_claims_breach_of_confidentiality_negligence` to `include_uncapped_claims_breach_of_confidentiality_negligence`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_breach_of_confidentiality_negligence`. Sending the other spelling returns a 422.",
- "type": "boolean"
- },
- "include_uncapped_claims_breach_of_privsec": {
- "description": "CSA 3.0 renamed `include_unlimited_claims_breach_of_privsec` to `include_uncapped_claims_breach_of_privsec`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_breach_of_privsec`. Sending the other spelling returns a 422.",
- "type": "boolean"
- },
- "include_uncapped_claims_breach_of_privsec_negligence": {
- "description": "CSA 3.0 renamed `include_unlimited_claims_breach_of_privsec_negligence` to `include_uncapped_claims_breach_of_privsec_negligence`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_breach_of_privsec_negligence`. Sending the other spelling returns a 422.",
- "type": "boolean"
- },
- "include_uncapped_claims_include_other": {
- "description": "CSA 3.0 renamed `include_unlimited_claims_include_other` to `include_uncapped_claims_include_other`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_include_other`. Sending the other spelling returns a 422.",
- "type": "boolean"
- },
- "include_uncapped_claims_indemnification_obligation": {
- "description": "CSA 3.0 renamed `include_unlimited_claims_indemnification_obligation` to `include_uncapped_claims_indemnification_obligation`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_indemnification_obligation`. Sending the other spelling returns a 422.",
- "type": "boolean"
- },
- "include_uncapped_claims_other": {
- "description": "CSA 3.0 renamed `include_unlimited_claims_other` to `include_uncapped_claims_other`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_other`. Sending the other spelling returns a 422.",
- "type": "boolean"
- },
- "include_unlimited_claims": {
- "type": "boolean"
- },
- "include_unlimited_claims_breach_of_confidentiality": {
- "type": "boolean"
- },
- "include_unlimited_claims_breach_of_confidentiality_negligence": {
- "type": "boolean"
- },
- "include_unlimited_claims_breach_of_privsec": {
- "type": "boolean"
- },
- "include_unlimited_claims_breach_of_privsec_negligence": {
- "type": "boolean"
- },
- "include_unlimited_claims_include_other": {
- "type": "boolean"
- },
- "include_unlimited_claims_indemnification_obligation": {
- "type": "boolean"
- },
- "include_unlimited_claims_other": {
- "type": "string"
- },
- "increased_cap_amount_currency": {
- "type": "number"
- },
- "increased_cap_amount_period_currency": {
- "type": "number"
- },
- "increased_cap_amount_period_qty": {
- "type": "number"
- },
- "increased_cap_amount_qty": {
- "type": "number"
- },
- "increased_cap_amount_type": {
- "enum": [
- "qty",
- "currency",
- "period"
- ],
- "type": "string"
- },
- "provider": {
- "type": "string"
- },
- "supercap_currency": {
- "description": "CSA 3.0 renamed `increased_cap_amount_currency` to `supercap_currency`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `increased_cap_amount_currency`. Sending the other spelling returns a 422.",
- "type": "number"
- },
- "supercap_period_currency": {
- "description": "CSA 3.0 renamed `increased_cap_amount_period_currency` to `supercap_period_currency`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `increased_cap_amount_period_currency`. Sending the other spelling returns a 422.",
- "type": "number"
- },
- "supercap_period_qty": {
- "description": "CSA 3.0 renamed `increased_cap_amount_period_qty` to `supercap_period_qty`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `increased_cap_amount_period_qty`. Sending the other spelling returns a 422.",
- "type": "number"
- },
- "supercap_qty": {
- "description": "CSA 3.0 renamed `increased_cap_amount_qty` to `supercap_qty`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `increased_cap_amount_qty`. Sending the other spelling returns a 422.",
- "type": "number"
- },
- "supercap_type": {
- "description": "CSA 3.0 renamed `increased_cap_amount_type` to `supercap_type`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `increased_cap_amount_type`. Sending the other spelling returns a 422.",
- "type": "number"
- }
- },
- "type": "object"
- },
- "csa_order_form_attributes": {
- "additionalProperties": false,
- "description": "Override csa order form terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "additional_changes": {
- "type": "string"
- },
- "additional_parameters_or_limitations": {
- "type": "string"
- },
- "affiliates_as_users": {
- "type": "boolean"
- },
- "cloud_service_description": {
- "type": "string"
- },
- "consumption_units": {
- "type": "string"
- },
- "fee_amount": {
- "type": "number"
- },
- "fee_custom_unit": {
- "type": "string"
- },
- "fee_period": {
- "enum": [
- "Subscription Period",
- "month",
- "year",
- "User",
- "Custom unit"
- ],
- "type": "string"
- },
- "fees_attributes": {
- "additionalProperties": {
- "anyOf": [
- {
- "additionalProperties": false,
- "description": "Fees::Flat (fee_type \"flat\"). A fixed recurring fee, e.g. a platform subscription. Set type to \"Fees::Flat\" or fee_type to \"flat\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "Fixed amount in the order form's fees_currency, charged per fee_period. A plain amount, not cents: 20 means 20.00.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"flat\". Alternative to type.",
- "enum": [
- "flat"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Flat\". Optional when fee_type is set.",
- "enum": [
- "Fees::Flat"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Discount (fee_type \"discount\"). A discount, as a fixed amount or a percentage, applied forever, once, or for a number of months. Set type to \"Fees::Discount\" or fee_type to \"discount\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "Discount size: an amount in fees_currency when discount_type is fixed_amount (a plain amount, not cents: 20 means 20.00), or a percentage (e.g. 10 for 10%) when it is percentage.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "discount_duration_amount": {
- "description": "Number of months the discount applies. Required when discount_duration_type is multiple_months.",
- "type": "number"
- },
- "discount_duration_type": {
- "description": "How long the discount applies. multiple_months also needs discount_duration_amount.",
- "enum": [
- "forever",
- "once",
- "multiple_months"
- ],
- "type": "string"
- },
- "discount_type": {
- "description": "Whether cost is a currency amount or a percentage.",
- "enum": [
- "fixed_amount",
- "percentage"
- ],
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"discount\". Alternative to type.",
- "enum": [
- "discount"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Discount\". Optional when fee_type is set.",
- "enum": [
- "Fees::Discount"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Cost (fee_type \"cost\"). A per-unit fee: price per unit times quantity, e.g. seats. Set type to \"Fees::Cost\" or fee_type to \"cost\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "Price per unit in fees_currency. The row total is quantity x cost. A plain amount, not cents: 20 means 20.00.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"cost\". Alternative to type.",
- "enum": [
- "cost"
- ],
- "type": "string"
- },
- "quantity": {
- "description": "Number of units.",
- "type": "number"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Cost\". Optional when fee_type is set.",
- "enum": [
- "Fees::Cost"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Attachment (fee_type \"attachment\"). A fee described in an uploaded attachment instead of in the table. Set type to \"Fees::Attachment\" or fee_type to \"attachment\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "attachment_id": {
- "description": "ID of an attachment uploaded with upload-attachment.",
- "type": "string"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"attachment\". Alternative to type.",
- "enum": [
- "attachment"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Attachment\". Optional when fee_type is set.",
- "enum": [
- "Fees::Attachment"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Graduated (fee_type \"graduated\"). Tiered pricing, with the price set per tier in graduated_fee_tiers_attributes. Set type to \"Fees::Graduated\" or fee_type to \"graduated\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"graduated\". Alternative to type.",
- "enum": [
- "graduated"
- ],
- "type": "string"
- },
- "graduated_fee_tiers_attributes": {
- "additionalProperties": {
- "additionalProperties": false,
- "properties": {
- "flat_price": {
- "type": "number"
- },
- "price_per_unit": {
- "type": "string"
- },
- "upper_limit": {
- "type": "number"
- }
- },
- "type": "object"
- },
- "description": "Graduated fee tiers. Use string keys such as \"0\", \"1\".",
- "propertyNames": {
- "type": "string"
- },
- "type": "object"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Graduated\". Optional when fee_type is set.",
- "enum": [
- "Fees::Graduated"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Included (fee_type \"included\"). An item included at no charge. Set type to \"Fees::Included\" or fee_type to \"included\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"included\". Alternative to type.",
- "enum": [
- "included"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Included\". Optional when fee_type is set.",
- "enum": [
- "Fees::Included"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Metered (fee_type \"metered\"). Usage-based pricing, billed per unit used. Set type to \"Fees::Metered\" or fee_type to \"metered\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "Price per unit of usage in fees_currency. A plain amount, not cents: 20 means 20.00.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"metered\". Alternative to type.",
- "enum": [
- "metered"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Metered\". Optional when fee_type is set.",
- "enum": [
- "Fees::Metered"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::OneTime (fee_type \"one_time\"). A one-time charge, such as a setup fee. Set type to \"Fees::OneTime\" or fee_type to \"one_time\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "One-time amount in fees_currency, charged once rather than per fee_period. A plain amount, not cents: 20 means 20.00.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"one_time\". Alternative to type.",
- "enum": [
- "one_time"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::OneTime\". Optional when fee_type is set.",
- "enum": [
- "Fees::OneTime"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Text (fee_type \"text\"). A fee term described in free text. Set type to \"Fees::Text\" or fee_type to \"text\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"text\". Alternative to type.",
- "enum": [
- "text"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Text\". Optional when fee_type is set.",
- "enum": [
- "Fees::Text"
- ],
- "type": "string"
- }
- },
- "type": "object"
- }
- ]
- },
- "description": "Fee table rows, keyed by string index (\"0\", \"1\", ...). Replaces the template's fees when provided. Each row sets type or fee_type to pick the fee class. Amounts are in the order form's fees_currency and, for recurring fees, are charged per fee_period.",
- "examples": [
- {
- "0": {
- "cost": 2000,
- "description": "Platform subscription",
- "type": "Fees::Flat"
- }
- },
- {
- "0": {
- "cost": 50,
- "description": "Seats",
- "fee_type": "cost",
- "quantity": 10
- },
- "1": {
- "cost": 10,
- "description": "Launch discount",
- "discount_duration_amount": 3,
- "discount_duration_type": "multiple_months",
- "discount_type": "percentage",
- "fee_type": "discount"
- }
- }
- ],
- "propertyNames": {
- "type": "string"
- },
- "type": "object"
- },
- "fees_currency": {
- "enum": [
- "USD",
- "EUR",
- "GBP",
- "CAD",
- "AUD",
- "SGD",
- "ILS",
- "JPY",
- "CHF",
- "HKD"
- ],
- "type": "string"
- },
- "fees_include_fee_increase_upon_renewal": {
- "type": "boolean"
- },
- "fees_include_fee_increase_upon_renewal_fee": {
- "type": "number"
- },
- "fees_include_fee_increase_upon_renewal_type": {
- "enum": [
- "will",
- "may"
- ],
- "type": "string"
- },
- "fees_inclusive_of_taxes": {
- "type": "boolean"
- },
- "framework_terms_type": {
- "enum": [
- "new",
- "existing",
- "description"
- ],
- "type": "string"
- },
- "free_trial_days": {
- "type": "number"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_additional_changes": {
- "type": "boolean"
- },
- "include_additional_parameters_or_limitations": {
- "type": "boolean"
- },
- "include_consumption": {
- "type": "boolean"
- },
- "include_fees": {
- "type": "boolean"
- },
- "include_fees_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_fees_include_attachment": {
- "type": "boolean"
- },
- "include_fees_other": {
- "type": "boolean"
- },
- "include_fees_other_val": {
- "type": "string"
- },
- "include_fees_table": {
- "type": "boolean"
- },
- "include_fees_table_period": {
- "enum": [
- "Subscription Period",
- "month",
- "year",
- "User"
- ],
- "type": "string"
- },
- "include_free_trial": {
- "type": "boolean"
- },
- "include_max_users": {
- "type": "boolean"
- },
- "include_pilot_period": {
- "type": "boolean"
- },
- "include_pilot_period_duration_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_pilot_period_duration_type": {
- "enum": [
- "day",
- "week",
- "month"
- ],
- "type": "string"
- },
- "include_pilot_period_include_fees": {
- "type": "boolean"
- },
- "include_pilot_period_include_fees_amount": {
- "type": "number"
- },
- "include_pilot_period_include_modifications": {
- "type": "boolean"
- },
- "include_pilot_period_include_modifications_description": {
- "type": "string"
- },
- "include_product_support": {
- "type": "boolean"
- },
- "include_product_support_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_product_support_description": {
- "type": "string"
- },
- "include_product_support_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_professional_services": {
- "type": "boolean"
- },
- "include_professional_services_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_professional_services_custom_name": {
- "type": "string"
- },
- "include_professional_services_description": {
- "type": "string"
- },
- "include_professional_services_end_date": {
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "include_professional_services_fees_description": {
- "type": "string"
- },
- "include_professional_services_include_end_date": {
- "type": "boolean"
- },
- "include_professional_services_include_fees_description": {
- "type": "boolean"
- },
- "include_professional_services_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_sla": {
- "type": "boolean"
- },
- "include_sla_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_sla_description": {
- "type": "string"
- },
- "include_sla_include_response_time": {
- "type": "boolean"
- },
- "include_sla_include_response_time_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_sla_include_response_time_credit": {
- "type": "number"
- },
- "include_sla_include_response_time_duration": {
- "enum": [
- "hour",
- "day",
- "week",
- "month",
- "hours"
- ],
- "type": "string"
- },
- "include_sla_include_response_time_support_channel": {
- "type": "string"
- },
- "include_sla_include_target_uptime": {
- "type": "boolean"
- },
- "include_sla_maintenance_notice": {
- "type": "boolean"
- },
- "include_sla_maintenance_window": {
- "type": "boolean"
- },
- "include_sla_maintenance_window_type": {
- "enum": [
- "standard",
- "none"
- ],
- "type": "string"
- },
- "include_sla_standard_maintenance_notice_qty": {
- "type": "number"
- },
- "include_sla_standard_maintenance_notice_unit": {
- "enum": [
- "hour",
- "day",
- "week",
- "month"
- ],
- "type": "string"
- },
- "include_sla_standard_maintenance_window_end_time": {
- "type": "string"
- },
- "include_sla_standard_maintenance_window_friday": {
- "type": "boolean"
- },
- "include_sla_standard_maintenance_window_monday": {
- "type": "boolean"
- },
- "include_sla_standard_maintenance_window_saturday": {
- "type": "boolean"
- },
- "include_sla_standard_maintenance_window_start_time": {
- "type": "string"
- },
- "include_sla_standard_maintenance_window_sunday": {
- "type": "boolean"
- },
- "include_sla_standard_maintenance_window_thursday": {
- "type": "boolean"
- },
- "include_sla_standard_maintenance_window_time_zone": {
- "type": "string"
- },
- "include_sla_standard_maintenance_window_tuesday": {
- "type": "boolean"
- },
- "include_sla_standard_maintenance_window_wednesday": {
- "type": "boolean"
- },
- "include_sla_standard_target_uptime": {
- "type": "number"
- },
- "include_sla_type": {
- "enum": [
- "description",
- "standard",
- "attachment"
- ],
- "type": "string"
- },
- "include_subscription_start_date": {
- "type": "boolean"
- },
- "include_subscription_start_date_date": {
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "include_usage_review": {
- "type": "boolean"
- },
- "include_usage_review_val": {
- "type": "string"
- },
- "include_use_limitations": {
- "type": "boolean"
- },
- "include_use_limitations_val": {
- "type": "string"
- },
- "invoice_period": {
- "enum": [
- "monthly",
- "quarterly",
- "semiannually",
- "annually",
- "Custom unit",
- "Monthly",
- "Quarterly",
- "Semiannually",
- "Annually"
- ],
- "type": "string"
- },
- "invoice_period_custom_unit": {
- "type": "string"
- },
- "max_consumption": {
- "type": "number"
- },
- "max_users": {
- "type": "number"
- },
- "negotiations_allowed": {
- "description": "When true, the recipient can propose changes to the order form, even when the agreement-level `negotiations_allowed` is false. This only covers the order form.",
- "type": "boolean"
- },
- "order_date_date": {
- "type": "string"
- },
- "order_date_other": {
- "type": "string"
- },
- "order_date_type": {
- "enum": [
- "signature",
- "date",
- "other"
- ],
- "type": "string"
- },
- "payment_period": {
- "type": "number"
- },
- "payment_period_timeframe": {
- "enum": [
- "Customer's receipt of invoice",
- "date of invoice"
- ],
- "type": "string"
- },
- "payment_period_unit": {
- "enum": [
- "day(s)",
- "week(s)",
- "month(s)",
- "marketplace_acceptance"
- ],
- "type": "string"
- },
- "payment_process_automatic_frequency": {
- "enum": [
- "monthly",
- "quarterly",
- "semiannually",
- "annually"
- ],
- "type": "string"
- },
- "payment_process_type": {
- "enum": [
- "automatic",
- "invoice",
- "custom",
- "marketplace_acceptance"
- ],
- "type": "string"
- },
- "payment_process_type_custom_val": {
- "type": "string"
- },
- "payment_process_type_invoice_amount": {
- "type": "number"
- },
- "payment_process_type_invoice_custom_unit": {
- "type": "string"
- },
- "payment_process_type_invoice_duration": {
- "enum": [
- "day",
- "week",
- "month",
- "year",
- "day(s)",
- "week(s)",
- "month(s)",
- "year(s)"
- ],
- "type": "string"
- },
- "payment_process_type_invoice_duration_start": {
- "enum": [
- "Customer's receipt of invoice",
- "date of invoice"
- ],
- "type": "string"
- },
- "payment_process_type_invoice_type": {
- "enum": [
- "monthly",
- "quarterly",
- "semiannually",
- "annually",
- "Custom unit"
- ],
- "type": "string"
- },
- "pilot_period_stripe_product_id": {
- "type": "string"
- },
- "service_credits_attributes": {
- "additionalProperties": {
- "additionalProperties": false,
- "properties": {
- "credit": {
- "type": "number"
- },
- "max": {
- "type": "number"
- },
- "min": {
- "type": "number"
- }
- },
- "type": "object"
- },
- "description": "Service credits. Use string keys such as \"0\", \"1\".",
- "propertyNames": {
- "type": "string"
- },
- "type": "object"
- },
- "subscription_auto_renew": {
- "enum": [
- "days",
- "subscription_end"
- ],
- "type": "string"
- },
- "subscription_period": {
- "type": "number"
- },
- "subscription_period_unit": {
- "type": "string"
- },
- "subscription_renewal_notice_days": {
- "type": "number"
- },
- "subscription_start_date": {
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "subscription_start_date_type": {
- "enum": [
- "effective_date",
- "date"
- ],
- "type": "string"
- },
- "underlying_agreement_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "use_limitations_attributes": {
- "additionalProperties": {
- "additionalProperties": false,
- "properties": {
- "amount": {
- "type": "number"
- },
- "limitation_type": {
- "type": "string"
- },
- "unit": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "description": "Use limitations. Use string keys such as \"0\", \"1\".",
- "propertyNames": {
- "type": "string"
- },
- "type": "object"
- }
- },
- "type": "object"
- },
- "custom_field_values": {
- "description": "Values for a custom template's fields, keyed by the field keys defined in the template's YAML definition. Only used when template_id is a custom template. Template defaults fill any fields you omit; a required field with no default and no submitted value returns a 400 naming the field. Values are validated against the field's input type: select and radio values must be one of the field's options, multiselect values are an array of selections each of which must be one of the field's options, number and currency values must be numeric, date values must be YYYY-MM-DD, and email values must be valid addresses. An invalid value returns a 400 naming the field."
- },
- "design_partner_attributes": {
- "additionalProperties": false,
- "description": "Override design partner terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "customer_description": {
- "type": "string"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_fees": {
- "type": "boolean"
- },
- "include_fees_amount": {
- "type": "number"
- },
- "include_fees_description": {
- "type": "string"
- },
- "include_fees_pay_by_amount": {
- "type": "string"
- },
- "include_fees_type": {
- "enum": [
- "default_language",
- "description"
- ],
- "type": "string"
- },
- "include_fees_unit": {
- "enum": [
- "month",
- "quarter",
- "year",
- "Term"
- ],
- "type": "string"
- },
- "include_program_appear_as_customer_private": {
- "type": "boolean"
- },
- "include_program_appear_as_customer_public": {
- "type": "boolean"
- },
- "include_program_case_study": {
- "type": "boolean"
- },
- "include_program_develop_functionality": {
- "type": "boolean"
- },
- "include_program_develop_functionality_val": {
- "type": "string"
- },
- "include_program_discount": {
- "type": "boolean"
- },
- "include_program_discount_amount": {
- "type": "number"
- },
- "include_program_discount_unit": {
- "enum": [
- "U.S. Dollars",
- "percent"
- ],
- "type": "string"
- },
- "include_program_participation_feedback": {
- "type": "boolean"
- },
- "include_program_participation_feedback_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_program_participation_feedback_unit": {
- "enum": [
- "month",
- "quarter",
- "year",
- "Term"
- ],
- "type": "string"
- },
- "include_program_partner_other": {
- "type": "boolean"
- },
- "include_program_partner_other_val": {
- "type": "string"
- },
- "include_program_provider_other": {
- "type": "boolean"
- },
- "include_program_provider_other_val": {
- "type": "string"
- },
- "include_program_reference": {
- "type": "boolean"
- },
- "product_description": {
- "type": "string"
- },
- "term_amount": {
- "type": "number"
- },
- "term_unit": {
- "enum": [
- "day(s)",
- "week(s)",
- "month(s)",
- "quarter(s)",
- "year(s)"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- "district_or_county": {
- "description": "The district or county for dispute resolution.",
- "type": "string"
- },
- "dpa_attributes": {
- "additionalProperties": false,
- "description": "Override dpa terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "approved_subprocessor_type": {
- "description": "`internal` lists approved subprocessors in the agreement (`subprocessors_attributes`); `external` points to a list published elsewhere.",
- "enum": [
- "internal",
- "external"
- ],
- "type": "string"
- },
- "cloud_service_product_name": {
- "type": "string"
- },
- "competent_supervisory_authority": {
- "type": "string"
- },
- "customer_description": {
- "type": "string"
- },
- "data_exporter_address_city": {
- "type": "string"
- },
- "data_exporter_address_country": {
- "type": "string"
- },
- "data_exporter_address_state": {
- "type": "string"
- },
- "data_exporter_address_street_address": {
- "type": "string"
- },
- "data_exporter_address_zipcode": {
- "type": "string"
- },
- "data_exporter_contact_details": {
- "type": "string"
- },
- "data_exporter_contact_name": {
- "type": "string"
- },
- "data_exporter_contact_position": {
- "type": "string"
- },
- "data_exporter_role": {
- "description": "Role of the data exporter. Overwritten to `Controller` when the agreement is created from a template.",
- "enum": [
- "Controller",
- "Processor"
- ],
- "type": "string"
- },
- "data_importer_address": {
- "type": "string"
- },
- "data_importer_address_city": {
- "type": "string"
- },
- "data_importer_address_country": {
- "type": "string"
- },
- "data_importer_address_state": {
- "type": "string"
- },
- "data_importer_address_street_address": {
- "type": "string"
- },
- "data_importer_address_zipcode": {
- "type": "string"
- },
- "data_importer_contact_details": {
- "type": "string"
- },
- "data_importer_contact_name": {
- "type": "string"
- },
- "data_importer_contact_position": {
- "type": "string"
- },
- "duration_of_processing": {
- "type": "string"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_covered_claim": {
- "type": "boolean"
- },
- "include_covered_claim_external_val": {
- "type": "string"
- },
- "include_covered_claim_internal_val": {
- "type": "string"
- },
- "include_covered_claim_type": {
- "description": "Which covered-claim text applies: `internal` uses `include_covered_claim_internal_val`, `external` uses `include_covered_claim_external_val`. Required when `include_covered_claim` is true.",
- "enum": [
- "internal",
- "external"
- ],
- "type": "string"
- },
- "include_data_subjects_custom": {
- "type": "boolean"
- },
- "include_data_subjects_custom_val": {
- "type": "string"
- },
- "include_data_subjects_employees": {
- "type": "boolean"
- },
- "include_data_subjects_end_users": {
- "type": "boolean"
- },
- "include_external_subprocessor_location": {
- "type": "string"
- },
- "include_frequency_of_transfer_continuous": {
- "type": "boolean"
- },
- "include_frequency_of_transfer_custom": {
- "type": "boolean"
- },
- "include_frequency_of_transfer_custom_val": {
- "type": "string"
- },
- "include_governing_country_eu": {
- "type": "boolean"
- },
- "include_governing_country_eu_val": {
- "type": "string"
- },
- "include_governing_country_uk": {
- "type": "boolean"
- },
- "include_governing_country_uk_val": {
- "type": "string"
- },
- "include_governing_law": {
- "type": "boolean"
- },
- "include_governing_law_country": {
- "type": "string"
- },
- "include_governing_law_state": {
- "type": "string"
- },
- "include_increased_claim_amount": {
- "description": "Legacy field. Stored but not shown on the DPA; use the `include_liability_cap*` fields instead.",
- "type": "boolean"
- },
- "include_increased_claim_amount_currency": {
- "description": "Legacy field. Stored but not shown on the DPA; use the `include_liability_cap*` fields instead."
- },
- "include_increased_claim_amount_qty": {
- "description": "Legacy field. Stored but not shown on the DPA; use the `include_liability_cap*` fields instead."
- },
- "include_increased_claim_amount_type": {
- "description": "Legacy field. Stored but not shown on the DPA; use the `include_liability_cap*` fields instead.",
- "type": "string"
- },
- "include_liability_cap": {
- "type": "boolean"
- },
- "include_liability_cap_amount_constant_external": {
- "type": "string"
- },
- "include_liability_cap_amount_constant_internal": {
- "type": "string"
- },
- "include_liability_cap_amount_currency_external": {
- "description": "Currency amount. Numbers and numeric strings (commas allowed) are both accepted."
- },
- "include_liability_cap_amount_currency_internal": {
- "description": "Currency amount. Numbers and numeric strings (commas allowed) are both accepted."
- },
- "include_liability_cap_csa_type": {
- "description": "Which liability cap values apply: the `_internal` or `_external` amount fields. Required when `include_liability_cap` is true.",
- "enum": [
- "internal",
- "external"
- ],
- "type": "string"
- },
- "include_personal_data_biographic_info": {
- "type": "boolean"
- },
- "include_personal_data_contact_info": {
- "type": "boolean"
- },
- "include_personal_data_custom": {
- "type": "boolean"
- },
- "include_personal_data_custom_val": {
- "type": "string"
- },
- "include_personal_data_employment_info": {
- "type": "boolean"
- },
- "include_personal_data_financial_info": {
- "type": "boolean"
- },
- "include_personal_data_location": {
- "type": "boolean"
- },
- "include_personal_data_name": {
- "type": "boolean"
- },
- "include_personal_data_transactional_info": {
- "type": "boolean"
- },
- "include_personal_data_user_activity_info": {
- "type": "boolean"
- },
- "include_processing_purpose_custom": {
- "type": "boolean"
- },
- "include_processing_purpose_custom_val": {
- "type": "string"
- },
- "include_processing_purpose_erasing": {
- "type": "boolean"
- },
- "include_processing_purpose_holding": {
- "type": "boolean"
- },
- "include_processing_purpose_protecting": {
- "type": "boolean"
- },
- "include_processing_purpose_receiving": {
- "type": "boolean"
- },
- "include_processing_purpose_returning": {
- "type": "boolean"
- },
- "include_processing_purpose_sharing": {
- "type": "boolean"
- },
- "include_processing_purpose_updating": {
- "type": "boolean"
- },
- "include_processing_purpose_using": {
- "type": "boolean"
- },
- "include_provider_security_contact_address": {
- "type": "boolean"
- },
- "include_provider_security_contact_address_city": {
- "type": "string"
- },
- "include_provider_security_contact_address_country": {
- "type": "string"
- },
- "include_provider_security_contact_address_state": {
- "type": "string"
- },
- "include_provider_security_contact_address_street_address": {
- "type": "string"
- },
- "include_provider_security_contact_address_zipcode": {
- "type": "string"
- },
- "include_provider_security_contact_email": {
- "type": "boolean"
- },
- "include_provider_security_contact_email_val": {
- "format": "email",
- "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
- "type": "string"
- },
- "include_security_measures_accountability": {
- "type": "boolean"
- },
- "include_security_measures_accountability_val": {
- "type": "string"
- },
- "include_security_measures_certification_or_assurance": {
- "type": "boolean"
- },
- "include_security_measures_certification_or_assurance_val": {
- "type": "string"
- },
- "include_security_measures_confidentiality_integrity": {
- "type": "boolean"
- },
- "include_security_measures_confidentiality_integrity_val": {
- "type": "string"
- },
- "include_security_measures_data_at_rest": {
- "type": "boolean"
- },
- "include_security_measures_data_at_rest_val": {
- "type": "string"
- },
- "include_security_measures_data_minimization": {
- "type": "boolean"
- },
- "include_security_measures_data_minimization_val": {
- "type": "string"
- },
- "include_security_measures_data_quality": {
- "type": "boolean"
- },
- "include_security_measures_data_quality_val": {
- "type": "string"
- },
- "include_security_measures_data_retention": {
- "type": "boolean"
- },
- "include_security_measures_data_retention_val": {
- "type": "string"
- },
- "include_security_measures_data_transmission": {
- "type": "boolean"
- },
- "include_security_measures_data_transmission_val": {
- "type": "string"
- },
- "include_security_measures_event_logging": {
- "type": "boolean"
- },
- "include_security_measures_event_logging_val": {
- "type": "string"
- },
- "include_security_measures_identity_auth": {
- "type": "boolean"
- },
- "include_security_measures_identity_auth_val": {
- "type": "string"
- },
- "include_security_measures_it_security_governance": {
- "type": "boolean"
- },
- "include_security_measures_it_security_governance_val": {
- "type": "string"
- },
- "include_security_measures_physical_security": {
- "type": "boolean"
- },
- "include_security_measures_physical_security_val": {
- "type": "string"
- },
- "include_security_measures_portability_and_erasure": {
- "type": "boolean"
- },
- "include_security_measures_portability_and_erasure_val": {
- "type": "string"
- },
- "include_security_measures_pseudonym_encryption": {
- "type": "boolean"
- },
- "include_security_measures_pseudonym_encryption_val": {
- "type": "string"
- },
- "include_security_measures_restore_data_access": {
- "type": "boolean"
- },
- "include_security_measures_restore_data_access_val": {
- "type": "string"
- },
- "include_security_measures_security_policy": {
- "type": "boolean"
- },
- "include_security_measures_system_configuration": {
- "type": "boolean"
- },
- "include_security_measures_system_configuration_val": {
- "type": "string"
- },
- "include_security_measures_testing_assessment": {
- "type": "boolean"
- },
- "include_security_measures_testing_assessment_val": {
- "type": "string"
- },
- "include_security_policy": {
- "type": "boolean"
- },
- "include_security_policy_fedramp_auth": {
- "type": "boolean"
- },
- "include_security_policy_hipaa": {
- "type": "boolean"
- },
- "include_security_policy_hitrust": {
- "type": "boolean"
- },
- "include_security_policy_include_other": {
- "type": "boolean"
- },
- "include_security_policy_iso27001": {
- "type": "boolean"
- },
- "include_security_policy_other": {
- "type": "string"
- },
- "include_security_policy_pci1": {
- "type": "boolean"
- },
- "include_security_policy_pci2": {
- "type": "boolean"
- },
- "include_security_policy_penetration_testing": {
- "type": "boolean"
- },
- "include_security_policy_soc2": {
- "type": "boolean"
- },
- "include_security_policy_soc2_type2": {
- "type": "boolean"
- },
- "include_sensitive_data_restrictions_custom": {
- "type": "boolean"
- },
- "include_sensitive_data_restrictions_custom_val": {
- "type": "string"
- },
- "include_sensitive_data_restrictions_security_policy": {
- "type": "boolean"
- },
- "include_service_provider_relationship": {
- "type": "boolean"
- },
- "include_special_category_data": {
- "type": "boolean"
- },
- "provider": {
- "type": "string"
- },
- "security_policy_available_at": {
- "type": "string"
- },
- "security_policy_type": {
- "description": "Where the Security Policy is defined. For `external`, set `security_policy_available_at`.",
- "enum": [
- "defined in agreement",
- "provider service",
- "external"
- ],
- "type": "string"
- },
- "subprocessors_attributes": {
- "additionalProperties": {
- "additionalProperties": false,
- "properties": {
- "_destroy": {
- "description": "Set to true with `id` to remove that subprocessor.",
- "type": "boolean"
- },
- "country": {
- "type": "string"
- },
- "id": {
- "description": "ID of an existing subprocessor to update or remove. Omit to add a new subprocessor.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "name": {
- "type": "string"
- },
- "processing_task": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "description": "Subprocessors, keyed by string index such as \"0\", \"1\". On create these are added to the template's subprocessors. On a draft update, an entry without `id` adds a new subprocessor; pass `id` to change one and `id` with `_destroy: true` to remove one.",
- "propertyNames": {
- "type": "string"
- },
- "type": "object"
- },
- "underlying_agreement_id": {
- "description": "ID of the CSA this DPA supplements when `underlying_agreement_type` is `internal`.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "underlying_agreement_type": {
- "description": "`internal` links a CSA in Common Paper (`underlying_agreement_id`); `external` describes another agreement in `underlying_agreement_val` (required). Omit for none.",
- "enum": [
- "internal",
- "external"
- ],
- "type": "string"
- },
- "underlying_agreement_val": {
- "description": "Description of the agreement this DPA supplements. Required when `underlying_agreement_type` is `external`.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "framework_terms_description": {
- "description": "Custom framework terms description. Only used when framework_terms_type is \"description\".",
- "type": "string"
- },
- "framework_terms_type": {
- "description": "How framework terms are specified. Use \"new\" for standard terms or \"description\" to provide a custom framework_terms_description.",
- "enum": [
- "new",
- "description"
- ],
- "type": "string"
- },
- "governing_law_country": {
- "description": "The country whose laws govern the agreement.",
- "type": "string"
- },
- "governing_law_region": {
- "description": "The state or region whose laws govern the agreement.",
- "type": "string"
- },
- "include_automated_payment_reminders": {
- "description": "When true, automatically sends payment reminder emails.",
- "type": "boolean"
- },
- "include_billing_info": {
- "description": "When true, billing contact information (billing_name, billing_email) is included.",
- "type": "boolean"
- },
- "include_billing_workflow": {
- "description": "When true, enables a billing workflow after signing.",
- "type": "boolean"
- },
- "include_expiration_date": {
- "description": "Expiration date in YYYY-MM-DD format. Use when include_expiration_type is \"date\".",
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "include_expiration_days": {
- "description": "Number of days until the agreement expires. Use when include_expiration_type is \"days\".",
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_expiration_type": {
- "description": "How to set expiration: \"none\" (default), \"days\" (use include_expiration_days), or \"date\" (use include_expiration_date).",
- "enum": [
- "none",
- "days",
- "date"
- ],
- "type": "string"
- },
- "include_terms": {
- "description": "When true, the standard terms are included with the agreement.",
- "type": "boolean"
- },
- "loi_attributes": {
- "additionalProperties": false,
- "description": "Override loi terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "confidentiality_custom": {
- "type": "string"
- },
- "confidentiality_mutual_include_loi": {
- "type": "boolean"
- },
- "confidentiality_nda_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "confidentiality_nda_description": {
- "type": "string"
- },
- "confidentiality_nda_include_loi": {
- "type": "boolean"
- },
- "confidentiality_nda_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "confidentiality_type": {
- "enum": [
- "mutual",
- "nda",
- "provider",
- "custom"
- ],
- "type": "string"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_custom_details": {
- "type": "boolean"
- },
- "include_custom_details_val": {
- "type": "string"
- },
- "include_fees": {
- "type": "boolean"
- },
- "include_fees_amount": {
- "type": "number"
- },
- "include_fees_amount_duration": {
- "enum": [
- "month",
- "year",
- "quarter"
- ],
- "type": "string"
- },
- "include_fees_include_amount": {
- "type": "boolean"
- },
- "include_fees_include_other": {
- "type": "boolean"
- },
- "include_fees_other": {
- "type": "string"
- },
- "include_functionality": {
- "type": "boolean"
- },
- "include_functionality_val": {
- "type": "string"
- },
- "include_launch_date": {
- "type": "boolean"
- },
- "include_launch_date_custom": {
- "type": "string"
- },
- "include_launch_date_date": {
- "format": "date-time",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$",
- "type": "string"
- },
- "include_launch_date_type": {
- "enum": [
- "date",
- "custom"
- ],
- "type": "string"
- },
- "product_name": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "manual_send": {
- "description": "When true, the agreement is marked as manually sent outside the platform.",
- "type": "boolean"
- },
- "message": {
- "type": "string"
- },
- "negotiations_allowed": {
- "description": "When true, the recipient can propose changes to the legal terms. For agreement types without separate business terms, that covers every term. CSA order forms, PSA statements of work, partnership business terms and software license order forms have their own `negotiations_allowed` flag.",
- "type": "boolean"
- },
- "partnership_attributes": {
- "additionalProperties": false,
- "description": "Override partnership terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "effective_date": {
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "effective_date_type": {
- "enum": [
- "signature",
- "date"
- ],
- "type": "string"
- },
- "general_cap_amount_currency_val": {
- "type": "number"
- },
- "general_cap_amount_either_currency": {
- "type": "number"
- },
- "general_cap_amount_either_multiple": {
- "type": "number"
- },
- "general_cap_amount_multiple_val": {
- "type": "number"
- },
- "general_cap_amount_type": {
- "enum": [
- "multiple",
- "currency",
- "either",
- "base"
- ],
- "type": "string"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_additional_warranties": {
- "type": "boolean"
- },
- "include_additional_warranties_include_company": {
- "type": "boolean"
- },
- "include_additional_warranties_include_company_val": {
- "type": "string"
- },
- "include_additional_warranties_include_partner": {
- "type": "boolean"
- },
- "include_additional_warranties_include_partner_val": {
- "type": "string"
- },
- "include_brand_guidelines": {
- "type": "boolean"
- },
- "include_brand_guidelines_include_company": {
- "type": "boolean"
- },
- "include_brand_guidelines_include_company_val": {
- "type": "string"
- },
- "include_brand_guidelines_include_partner": {
- "type": "boolean"
- },
- "include_brand_guidelines_include_partner_val": {
- "type": "string"
- },
- "include_covered_claims": {
- "type": "boolean"
- },
- "include_covered_claims_company_claims": {
- "type": "string"
- },
- "include_covered_claims_include_company_claims": {
- "type": "boolean"
- },
- "include_covered_claims_include_partner_claims": {
- "type": "boolean"
- },
- "include_covered_claims_partner_claims": {
- "type": "string"
- },
- "include_dpa": {
- "type": "boolean"
- },
- "include_dpa_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_dpa_location": {
- "type": "string"
- },
- "include_dpa_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_increased_cap_amount": {
- "type": "boolean"
- },
- "include_increased_cap_amount_currency": {
- "type": "number"
- },
- "include_increased_cap_amount_either_currency": {
- "type": "number"
- },
- "include_increased_cap_amount_either_multiple": {
- "type": "string"
- },
- "include_increased_cap_amount_multiple": {
- "type": "string"
- },
- "include_increased_cap_amount_type": {
- "enum": [
- "multiple",
- "currency",
- "either"
- ],
- "type": "string"
- },
- "include_increased_claims": {
- "type": "boolean"
- },
- "include_increased_claims_include_confidentiality": {
- "type": "boolean"
- },
- "include_increased_claims_include_confidentiality_misconduct": {
- "type": "boolean"
- },
- "include_increased_claims_include_covered_claims": {
- "type": "boolean"
- },
- "include_increased_claims_include_misconduct": {
- "type": "boolean"
- },
- "include_increased_claims_include_other": {
- "type": "boolean"
- },
- "include_increased_claims_include_other_val": {
- "type": "string"
- },
- "include_unlimited_claims": {
- "type": "boolean"
- },
- "include_unlimited_claims_confidentiality": {
- "type": "boolean"
- },
- "include_unlimited_claims_confidentiality_misconduct": {
- "type": "boolean"
- },
- "include_unlimited_claims_covered_claims": {
- "type": "boolean"
- },
- "include_unlimited_claims_misconduct": {
- "type": "boolean"
- },
- "include_unlimited_claims_other": {
- "type": "boolean"
- },
- "include_unlimited_claims_other_val": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "partnership_business_terms_attributes": {
- "additionalProperties": false,
- "description": "Override partnership business terms terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "end_date_after_effective_date_amount": {
- "type": "number"
- },
- "end_date_after_effective_date_unit": {
- "enum": [
- "month(s)",
- "quarter(s)",
- "year(s)"
- ],
- "type": "string"
- },
- "end_date_date": {
- "type": "string"
- },
- "end_date_type": {
- "enum": [
- "date",
- "effective date"
- ],
- "type": "string"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_obligations_company_brand": {
- "type": "boolean"
- },
- "include_obligations_company_promotion": {
- "type": "boolean"
- },
- "include_obligations_company_promotion_include_activities": {
- "type": "boolean"
- },
- "include_obligations_company_promotion_include_activities_val": {
- "type": "string"
- },
- "include_obligations_company_promotion_include_materials": {
- "type": "boolean"
- },
- "include_obligations_company_promotion_include_materials_val": {
- "type": "string"
- },
- "include_obligations_company_referral": {
- "type": "boolean"
- },
- "include_obligations_company_referral_include_criteria": {
- "type": "boolean"
- },
- "include_obligations_company_referral_include_criteria_val": {
- "type": "string"
- },
- "include_obligations_company_referral_include_pay_sch": {
- "type": "boolean"
- },
- "include_obligations_company_referral_include_pay_sch_amount": {
- "type": "number"
- },
- "include_obligations_company_referral_include_pay_sch_custom": {
- "type": "string"
- },
- "include_obligations_company_referral_include_pay_sch_unit": {
- "enum": [
- "U.S. Dollars",
- "percent"
- ],
- "type": "string"
- },
- "include_obligations_company_sponsorship": {
- "type": "boolean"
- },
- "include_obligations_company_sponsorship_include_benefits": {
- "type": "boolean"
- },
- "include_obligations_company_sponsorship_include_benefits_val": {
- "type": "string"
- },
- "include_obligations_company_sponsorship_include_payments": {
- "type": "boolean"
- },
- "include_obligations_company_sponsorship_include_payments_amount": {
- "type": "number"
- },
- "include_obligations_company_sponsorship_include_payments_unit": {
- "enum": [
- "U.S. Dollars",
- "percent"
- ],
- "type": "string"
- },
- "include_obligations_partner_brand": {
- "type": "boolean"
- },
- "include_obligations_partner_promotion": {
- "type": "boolean"
- },
- "include_obligations_partner_promotion_include_activities": {
- "type": "boolean"
- },
- "include_obligations_partner_promotion_include_activities_val": {
- "type": "string"
- },
- "include_obligations_partner_promotion_include_materials": {
- "type": "boolean"
- },
- "include_obligations_partner_promotion_include_materials_val": {
- "type": "string"
- },
- "include_obligations_partner_referral": {
- "type": "boolean"
- },
- "include_obligations_partner_referral_include_criteria": {
- "type": "boolean"
- },
- "include_obligations_partner_referral_include_criteria_val": {
- "type": "string"
- },
- "include_obligations_partner_referral_include_pay_sch": {
- "type": "boolean"
- },
- "include_obligations_partner_referral_include_pay_sch_amount": {
- "type": "number"
- },
- "include_obligations_partner_referral_include_pay_sch_custom": {
- "type": "string"
- },
- "include_obligations_partner_referral_include_pay_sch_unit": {
- "enum": [
- "U.S. Dollars",
- "percent"
- ],
- "type": "string"
- },
- "include_obligations_partner_sponsorship": {
- "type": "boolean"
- },
- "include_obligations_partner_sponsorship_include_benefits": {
- "type": "boolean"
- },
- "include_obligations_partner_sponsorship_include_benefits_val": {
- "type": "string"
- },
- "include_obligations_partner_sponsorship_include_payments": {
- "type": "boolean"
- },
- "include_obligations_partner_sponsorship_include_payments_amount": {
- "type": "number"
- },
- "include_obligations_partner_sponsorship_include_payments_unit": {
- "enum": [
- "U.S. Dollars",
- "percent"
- ],
- "type": "string"
- },
- "include_payment_process": {
- "type": "boolean"
- },
- "include_payment_process_company": {
- "type": "boolean"
- },
- "include_payment_process_company_include_address": {
- "type": "boolean"
- },
- "include_payment_process_company_include_address_city": {
- "type": "string"
- },
- "include_payment_process_company_include_address_country": {
- "type": "string"
- },
- "include_payment_process_company_include_address_state": {
- "type": "string"
- },
- "include_payment_process_company_include_address_street_address": {
- "type": "string"
- },
- "include_payment_process_company_include_address_zipcode": {
- "type": "string"
- },
- "include_payment_process_company_include_email": {
- "type": "boolean"
- },
- "include_payment_process_company_include_email_val": {
- "type": "string"
- },
- "include_payment_process_partner": {
- "type": "boolean"
- },
- "include_payment_process_partner_include_address": {
- "type": "boolean"
- },
- "include_payment_process_partner_include_address_city": {
- "type": "string"
- },
- "include_payment_process_partner_include_address_country": {
- "type": "string"
- },
- "include_payment_process_partner_include_address_state": {
- "type": "string"
- },
- "include_payment_process_partner_include_address_street_address": {
- "type": "string"
- },
- "include_payment_process_partner_include_address_zipcode": {
- "type": "string"
- },
- "include_payment_process_partner_include_email": {
- "type": "boolean"
- },
- "include_payment_process_partner_include_email_val": {
- "type": "string"
- },
- "include_payment_schedule": {
- "type": "boolean"
- },
- "include_payment_schedule_custom": {
- "type": "string"
- },
- "include_payment_schedule_specified_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_payment_schedule_specified_timeframe": {
- "enum": [
- "receipt",
- "date"
- ],
- "type": "string"
- },
- "include_payment_schedule_specified_unit": {
- "enum": [
- "day(s)",
- "week(s)",
- "month(s)",
- "quarter(s)",
- "year(s)"
- ],
- "type": "string"
- },
- "include_payment_schedule_type": {
- "enum": [
- "specified",
- "custom"
- ],
- "type": "string"
- },
- "negotiations_allowed": {
- "description": "When true, the recipient can propose changes to the business terms, even when the agreement-level `negotiations_allowed` is false. This only covers the business terms.",
- "type": "boolean"
- },
- "territory_type": {
- "enum": [
- "worldwide",
- "custom"
- ],
- "type": "string"
- },
- "territory_type_val": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "payment_link_url": {
- "description": "A payment URL shown to the recipient after signing. Requires include_billing_workflow to be true and billing_workflow_type to be \"link\".",
- "type": "string"
- },
- "pilot_attributes": {
- "additionalProperties": false,
- "description": "Override pilot terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "fees_type": {
- "enum": [
- "free",
- "pilot_period_fees"
- ],
- "type": "string"
- },
- "general_cap_amount": {
- "type": "number"
- },
- "general_cap_amount_type": {
- "enum": [
- "preceding",
- "base",
- "period"
- ],
- "type": "string"
- },
- "general_cap_period_currency": {
- "type": "number"
- },
- "general_cap_period_qty": {
- "type": "number"
- },
- "general_cap_preceding_amount": {
- "type": "number"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_dpa": {
- "type": "boolean"
- },
- "include_dpa_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_dpa_location": {
- "type": "string"
- },
- "include_dpa_type": {
- "enum": [
- "description",
- "attachment",
- "standard"
- ],
- "type": "string"
- },
- "include_payment_process": {
- "type": "boolean"
- },
- "include_technical_support": {
- "type": "boolean"
- },
- "payment_process_automatic_frequency": {
- "enum": [
- "monthly",
- "quarterly",
- "annually",
- "once_per_period"
- ],
- "type": "string"
- },
- "payment_process_invoice_days": {
- "type": "number"
- },
- "payment_process_invoice_from": {
- "enum": [
- "receipt",
- "date"
- ],
- "type": "string"
- },
- "payment_process_invoice_timeframe": {
- "enum": [
- "days",
- "weeks",
- "months",
- "quarters",
- "years"
- ],
- "type": "string"
- },
- "payment_process_type": {
- "enum": [
- "automatic",
- "invoice"
- ],
- "type": "string"
- },
- "pilot_period_description": {
- "type": "string"
- },
- "pilot_period_fees_description": {
- "type": "string"
- },
- "product_description": {
- "type": "string"
- },
- "technical_support_description": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "psa_attributes": {
- "additionalProperties": false,
- "description": "Override psa terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "additional_changes": {
- "type": "string"
- },
- "customer_description": {
- "type": "string"
- },
- "effective_date": {
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "effective_date_type": {
- "enum": [
- "signature",
- "date"
- ],
- "type": "string"
- },
- "general_cap_amount": {
- "type": "number"
- },
- "general_cap_amount_type": {
- "enum": [
- "preceding",
- "base",
- "period"
- ],
- "type": "string"
- },
- "general_cap_period_currency": {
- "type": "number"
- },
- "general_cap_period_qty": {
- "type": "number"
- },
- "general_cap_preceding_amount": {
- "type": "number"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_additional_changes": {
- "type": "boolean"
- },
- "include_additional_warranties": {
- "type": "boolean"
- },
- "include_additional_warranties_by_customer": {
- "type": "string"
- },
- "include_additional_warranties_by_provider": {
- "type": "string"
- },
- "include_additional_warranties_include_by_customer": {
- "type": "boolean"
- },
- "include_additional_warranties_include_by_provider": {
- "type": "boolean"
- },
- "include_covered_claims": {
- "type": "boolean"
- },
- "include_covered_claims_customer_claims": {
- "type": "string"
- },
- "include_covered_claims_include_customer_claims": {
- "type": "boolean"
- },
- "include_covered_claims_include_provider_claims": {
- "type": "boolean"
- },
- "include_covered_claims_provider_claims": {
- "type": "string"
- },
- "include_customer_insurance_min": {
- "type": "boolean"
- },
- "include_customer_insurance_min_add_provider_com_gen_liability": {
- "type": "boolean"
- },
- "include_customer_insurance_min_add_provider_cyber_liability": {
- "type": "boolean"
- },
- "include_customer_insurance_min_add_provider_errors_omissions": {
- "type": "boolean"
- },
- "include_customer_insurance_min_auto_liability_aggregate": {
- "type": "number"
- },
- "include_customer_insurance_min_auto_liability_minimum": {
- "type": "number"
- },
- "include_customer_insurance_min_cyber_liability_aggregate": {
- "type": "number"
- },
- "include_customer_insurance_min_cyber_liability_minimum": {
- "type": "number"
- },
- "include_customer_insurance_min_employer_liability_aggregate": {
- "type": "number"
- },
- "include_customer_insurance_min_employer_liability_minimum": {
- "type": "number"
- },
- "include_customer_insurance_min_general_liability_aggregate": {
- "type": "number"
- },
- "include_customer_insurance_min_general_liability_minimum": {
- "type": "number"
- },
- "include_customer_insurance_min_include_add_provider": {
- "type": "boolean"
- },
- "include_customer_insurance_min_include_auto_liability": {
- "type": "boolean"
- },
- "include_customer_insurance_min_include_cyber_liability": {
- "type": "boolean"
- },
- "include_customer_insurance_min_include_employer_liability": {
- "type": "boolean"
- },
- "include_customer_insurance_min_include_general_liability": {
- "type": "boolean"
- },
- "include_customer_insurance_min_include_workers_comp": {
- "type": "boolean"
- },
- "include_customer_policies": {
- "type": "boolean"
- },
- "include_customer_policies_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_customer_policies_location": {
- "type": "string"
- },
- "include_customer_policies_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_dpa": {
- "type": "boolean"
- },
- "include_dpa_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_dpa_location": {
- "type": "string"
- },
- "include_dpa_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_increased_cap_amount": {
- "type": "boolean"
- },
- "include_increased_claims": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_confidentiality": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_confidentiality_negligence": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_privsec": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_privsec_negligence": {
- "type": "boolean"
- },
- "include_increased_claims_include_other": {
- "type": "boolean"
- },
- "include_increased_claims_indemnification_obligation": {
- "type": "boolean"
- },
- "include_increased_claims_negligence": {
- "type": "boolean"
- },
- "include_increased_claims_other": {
- "type": "string"
- },
- "include_provider_insurance_min": {
- "type": "boolean"
- },
- "include_provider_insurance_min_add_customer_com_gen_liability": {
- "type": "boolean"
- },
- "include_provider_insurance_min_add_customer_cyber_liability": {
- "type": "boolean"
- },
- "include_provider_insurance_min_add_customer_errors_omissions": {
- "type": "boolean"
- },
- "include_provider_insurance_min_auto_liability_aggregate": {
- "type": "number"
- },
- "include_provider_insurance_min_auto_liability_minimum": {
- "type": "number"
- },
- "include_provider_insurance_min_cyber_liability_aggregate": {
- "type": "number"
- },
- "include_provider_insurance_min_cyber_liability_minimum": {
- "type": "number"
- },
- "include_provider_insurance_min_employer_liability_aggregate": {
- "type": "number"
- },
- "include_provider_insurance_min_employer_liability_minimum": {
- "type": "number"
- },
- "include_provider_insurance_min_general_liability_aggregate": {
- "type": "number"
- },
- "include_provider_insurance_min_general_liability_minimum": {
- "type": "number"
- },
- "include_provider_insurance_min_include_add_customer": {
- "type": "boolean"
- },
- "include_provider_insurance_min_include_auto_liability": {
- "type": "boolean"
- },
- "include_provider_insurance_min_include_cyber_liability": {
- "type": "boolean"
- },
- "include_provider_insurance_min_include_employer_liability": {
- "type": "boolean"
- },
- "include_provider_insurance_min_include_general_liability": {
- "type": "boolean"
- },
- "include_provider_insurance_min_include_workers_comp": {
- "type": "boolean"
- },
- "include_publicity_rights": {
- "type": "boolean"
- },
- "include_publicity_rights_type": {
- "enum": [
- "public",
- "non-public"
- ],
- "type": "string"
- },
- "include_security_policy": {
- "type": "boolean"
- },
- "include_security_policy_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_security_policy_fedramp_auth": {
- "type": "boolean"
- },
- "include_security_policy_hitrust": {
- "type": "boolean"
- },
- "include_security_policy_include_annual_maintenance": {
- "type": "boolean"
- },
- "include_security_policy_include_other": {
- "type": "boolean"
- },
- "include_security_policy_include_other_val": {
- "type": "string"
- },
- "include_security_policy_iso27001": {
- "type": "boolean"
- },
- "include_security_policy_location": {
- "type": "string"
- },
- "include_security_policy_pci1": {
- "type": "boolean"
- },
- "include_security_policy_pci2": {
- "type": "boolean"
- },
- "include_security_policy_penetration_testing": {
- "type": "boolean"
- },
- "include_security_policy_soc2_type1": {
- "type": "boolean"
- },
- "include_security_policy_soc2_type2": {
- "type": "boolean"
- },
- "include_security_policy_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_unlimited_claims": {
- "type": "boolean"
- },
- "include_unlimited_claims_breach_of_confidentiality": {
- "type": "boolean"
- },
- "include_unlimited_claims_breach_of_confidentiality_negligence": {
- "type": "boolean"
- },
- "include_unlimited_claims_breach_of_privsec": {
- "type": "boolean"
- },
- "include_unlimited_claims_breach_of_privsec_negligence": {
- "type": "boolean"
- },
- "include_unlimited_claims_include_other": {
- "type": "boolean"
- },
- "include_unlimited_claims_indemnification_obligation": {
- "type": "boolean"
- },
- "include_unlimited_claims_negligence": {
- "type": "boolean"
- },
- "include_unlimited_claims_other": {
- "type": "string"
- },
- "increased_cap_amount_currency": {
- "type": "number"
- },
- "increased_cap_amount_period_currency": {
- "type": "number"
- },
- "increased_cap_amount_period_qty": {
- "type": "number"
- },
- "increased_cap_amount_qty": {
- "type": "number"
- },
- "increased_cap_amount_type": {
- "enum": [
- "qty",
- "currency",
- "period"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- "psa_statement_of_work_attributes": {
- "additionalProperties": false,
- "description": "Override psa statement of work terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "additional_changes": {
- "type": "string"
- },
- "cost": {
- "type": "number"
- },
- "description": {
- "type": "string"
- },
- "fee_type": {
- "type": "string"
- },
- "fees_attributes": {
- "additionalProperties": {
- "anyOf": [
- {
- "additionalProperties": false,
- "description": "Fees::Flat (fee_type \"flat\"). A fixed recurring fee, e.g. a platform subscription. Set type to \"Fees::Flat\" or fee_type to \"flat\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "Fixed amount in the order form's fees_currency, charged per fee_period. A plain amount, not cents: 20 means 20.00.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"flat\". Alternative to type.",
- "enum": [
- "flat"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Flat\". Optional when fee_type is set.",
- "enum": [
- "Fees::Flat"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Discount (fee_type \"discount\"). A discount, as a fixed amount or a percentage, applied forever, once, or for a number of months. Set type to \"Fees::Discount\" or fee_type to \"discount\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "Discount size: an amount in fees_currency when discount_type is fixed_amount (a plain amount, not cents: 20 means 20.00), or a percentage (e.g. 10 for 10%) when it is percentage.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "discount_duration_amount": {
- "description": "Number of months the discount applies. Required when discount_duration_type is multiple_months.",
- "type": "number"
- },
- "discount_duration_type": {
- "description": "How long the discount applies. multiple_months also needs discount_duration_amount.",
- "enum": [
- "forever",
- "once",
- "multiple_months"
- ],
- "type": "string"
- },
- "discount_type": {
- "description": "Whether cost is a currency amount or a percentage.",
- "enum": [
- "fixed_amount",
- "percentage"
- ],
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"discount\". Alternative to type.",
- "enum": [
- "discount"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Discount\". Optional when fee_type is set.",
- "enum": [
- "Fees::Discount"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Cost (fee_type \"cost\"). A per-unit fee: price per unit times quantity, e.g. seats. Set type to \"Fees::Cost\" or fee_type to \"cost\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "Price per unit in fees_currency. The row total is quantity x cost. A plain amount, not cents: 20 means 20.00.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"cost\". Alternative to type.",
- "enum": [
- "cost"
- ],
- "type": "string"
- },
- "quantity": {
- "description": "Number of units.",
- "type": "number"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Cost\". Optional when fee_type is set.",
- "enum": [
- "Fees::Cost"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Attachment (fee_type \"attachment\"). A fee described in an uploaded attachment instead of in the table. Set type to \"Fees::Attachment\" or fee_type to \"attachment\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "attachment_id": {
- "description": "ID of an attachment uploaded with upload-attachment.",
- "type": "string"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"attachment\". Alternative to type.",
- "enum": [
- "attachment"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Attachment\". Optional when fee_type is set.",
- "enum": [
- "Fees::Attachment"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Graduated (fee_type \"graduated\"). Tiered pricing, with the price set per tier in graduated_fee_tiers_attributes. Set type to \"Fees::Graduated\" or fee_type to \"graduated\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"graduated\". Alternative to type.",
- "enum": [
- "graduated"
- ],
- "type": "string"
- },
- "graduated_fee_tiers_attributes": {
- "additionalProperties": {
- "additionalProperties": false,
- "properties": {
- "flat_price": {
- "type": "number"
- },
- "price_per_unit": {
- "type": "string"
- },
- "upper_limit": {
- "type": "number"
- }
- },
- "type": "object"
- },
- "description": "Graduated fee tiers. Use string keys such as \"0\", \"1\".",
- "propertyNames": {
- "type": "string"
- },
- "type": "object"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Graduated\". Optional when fee_type is set.",
- "enum": [
- "Fees::Graduated"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Included (fee_type \"included\"). An item included at no charge. Set type to \"Fees::Included\" or fee_type to \"included\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"included\". Alternative to type.",
- "enum": [
- "included"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Included\". Optional when fee_type is set.",
- "enum": [
- "Fees::Included"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Metered (fee_type \"metered\"). Usage-based pricing, billed per unit used. Set type to \"Fees::Metered\" or fee_type to \"metered\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "Price per unit of usage in fees_currency. A plain amount, not cents: 20 means 20.00.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"metered\". Alternative to type.",
- "enum": [
- "metered"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Metered\". Optional when fee_type is set.",
- "enum": [
- "Fees::Metered"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::OneTime (fee_type \"one_time\"). A one-time charge, such as a setup fee. Set type to \"Fees::OneTime\" or fee_type to \"one_time\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "One-time amount in fees_currency, charged once rather than per fee_period. A plain amount, not cents: 20 means 20.00.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"one_time\". Alternative to type.",
- "enum": [
- "one_time"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::OneTime\". Optional when fee_type is set.",
- "enum": [
- "Fees::OneTime"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Text (fee_type \"text\"). A fee term described in free text. Set type to \"Fees::Text\" or fee_type to \"text\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"text\". Alternative to type.",
- "enum": [
- "text"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Text\". Optional when fee_type is set.",
- "enum": [
- "Fees::Text"
- ],
- "type": "string"
- }
- },
- "type": "object"
- }
- ]
- },
- "description": "Fee line items. Use string keys such as \"0\", \"1\". Replaces template fees when provided.",
- "propertyNames": {
- "type": "string"
- },
- "type": "object"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_additional_changes": {
- "type": "boolean"
- },
- "include_customer_obligation": {
- "type": "boolean"
- },
- "include_customer_obligation_val": {
- "type": "string"
- },
- "include_deliverables": {
- "type": "boolean"
- },
- "include_deliverables_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_deliverables_description": {
- "type": "string"
- },
- "include_deliverables_include_acceptance": {
- "type": "boolean"
- },
- "include_deliverables_include_attachment": {
- "type": "boolean"
- },
- "include_deliverables_include_draft_deliverables": {
- "type": "boolean"
- },
- "include_deliverables_rejection_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_deliverables_rejection_unit": {
- "enum": [
- "hours",
- "days",
- "weeks",
- "months"
- ],
- "type": "string"
- },
- "include_deliverables_resubmission_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_deliverables_resubmission_unit": {
- "enum": [
- "hours",
- "days",
- "weeks",
- "months"
- ],
- "type": "string"
- },
- "include_fees_other": {
- "type": "boolean"
- },
- "include_fees_other_val": {
- "type": "string"
- },
- "include_fees_table": {
- "type": "boolean"
- },
- "include_fees_table_total": {
- "type": "boolean"
- },
- "include_fees_travel": {
- "type": "boolean"
- },
- "include_fees_travel_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_fees_travel_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_fees_travel_val": {
- "type": "string"
- },
- "include_third_party_customer": {
- "type": "boolean"
- },
- "include_third_party_include_description": {
- "type": "boolean"
- },
- "include_third_party_include_description_val": {
- "type": "string"
- },
- "include_third_party_materials": {
- "type": "boolean"
- },
- "include_third_party_provider": {
- "type": "boolean"
- },
- "include_time_of_assignment": {
- "type": "boolean"
- },
- "include_time_of_assignment_type": {
- "enum": [
- "created",
- "paid"
- ],
- "type": "string"
- },
- "invoice_period_description": {
- "type": "string"
- },
- "negotiations_allowed": {
- "description": "When true, the recipient can propose changes to the statement of work, even when the agreement-level `negotiations_allowed` is false. This only covers the statement of work.",
- "type": "boolean"
- },
- "payment_period": {
- "type": "number"
- },
- "payment_period_other": {
- "type": "string"
- },
- "payment_period_timeframe": {
- "enum": [
- "receipt",
- "invoice",
- "Customer's receipt of invoice",
- "date of invoice"
- ],
- "type": "string"
- },
- "payment_period_type": {
- "enum": [
- "standard",
- "other"
- ],
- "type": "string"
- },
- "payment_period_unit": {
- "enum": [
- "day(s)",
- "week(s)",
- "month(s)",
- "quarter(s)",
- "year(s)"
- ],
- "type": "string"
- },
- "quantity": {
- "type": "number"
- },
- "services_description": {
- "type": "string"
- },
- "sow_date": {
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "sow_date_type": {
- "enum": [
- "signature",
- "date"
- ],
- "type": "string"
- },
- "sow_term_amount": {
- "type": "number"
- },
- "sow_term_date": {
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "sow_term_type": {
- "enum": [
- "deliverables",
- "period",
- "date"
- ],
- "type": "string"
- },
- "sow_term_unit": {
- "enum": [
- "month(s)",
- "quarter(s)",
- "year(s)"
- ],
- "type": "string"
- },
- "type": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "recipient_email": {
- "format": "email",
- "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
- "type": "string"
- },
- "recipient_name": {
- "type": "string"
- },
- "recipient_notice_email_address": {
- "description": "Email address for legal notices to the recipient.",
- "format": "email",
- "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
- "type": "string"
- },
- "recipient_organization": {
- "type": "string"
- },
- "sender_last_to_sign": {
- "description": "When true, your signer signs after the recipient.",
- "type": "boolean"
- },
- "sender_notice_email_address": {
- "description": "Email address for legal notices to the sender.",
- "format": "email",
- "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
- "type": "string"
- },
- "software_license_attributes": {
- "additionalProperties": false,
- "description": "Override software license terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "effective_date": {
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "effective_date_type": {
- "enum": [
- "signature",
- "date"
- ],
- "type": "string"
- },
- "general_cap_amount": {
- "type": "number"
- },
- "general_cap_amount_type": {
- "enum": [
- "preceding",
- "base",
- "period"
- ],
- "type": "string"
- },
- "general_cap_period_currency": {
- "type": "number"
- },
- "general_cap_period_qty": {
- "type": "number"
- },
- "general_cap_preceding_amount": {
- "type": "number"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_additional_warranties": {
- "type": "boolean"
- },
- "include_additional_warranties_by_customer": {
- "type": "string"
- },
- "include_additional_warranties_by_provider": {
- "type": "string"
- },
- "include_additional_warranties_include_by_customer": {
- "type": "boolean"
- },
- "include_additional_warranties_include_by_provider": {
- "type": "boolean"
- },
- "include_ai_addendum": {
- "type": "boolean"
- },
- "include_ai_addendum_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_covered_claims": {
- "type": "boolean"
- },
- "include_covered_claims_customer_claims": {
- "type": "string"
- },
- "include_covered_claims_include_customer_claims": {
- "type": "boolean"
- },
- "include_covered_claims_include_provider_claims": {
- "type": "boolean"
- },
- "include_covered_claims_provider_claims": {
- "type": "string"
- },
- "include_dpa": {
- "type": "boolean"
- },
- "include_dpa_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_dpa_location": {
- "type": "string"
- },
- "include_dpa_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_increased_cap_amount": {
- "type": "boolean"
- },
- "include_increased_claims": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_confidentiality": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_confidentiality_negligence": {
- "type": "boolean"
- },
- "include_increased_claims_include_other": {
- "type": "boolean"
- },
- "include_increased_claims_indemnification_obligation": {
- "type": "boolean"
- },
- "include_increased_claims_negligence": {
- "type": "boolean"
- },
- "include_increased_claims_other": {
- "type": "string"
- },
- "include_increased_claims_restrictions": {
- "type": "boolean"
- },
- "include_unlimited_claims": {
- "type": "boolean"
- },
- "include_unlimited_claims_breach_of_confidentiality": {
- "type": "boolean"
- },
- "include_unlimited_claims_breach_of_confidentiality_negligence": {
- "type": "boolean"
- },
- "include_unlimited_claims_include_other": {
- "type": "boolean"
- },
- "include_unlimited_claims_indemnification_obligation": {
- "type": "boolean"
- },
- "include_unlimited_claims_license_or_restrictions": {
- "type": "boolean"
- },
- "include_unlimited_claims_negligence": {
- "type": "boolean"
- },
- "include_unlimited_claims_other": {
- "type": "string"
- },
- "increased_cap_amount_currency": {
- "type": "number"
- },
- "increased_cap_amount_period_currency": {
- "type": "number"
- },
- "increased_cap_amount_period_qty": {
- "type": "number"
- },
- "increased_cap_amount_qty": {
- "type": "number"
- },
- "increased_cap_amount_type": {
- "enum": [
- "qty",
- "currency",
- "period"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- "software_license_order_form_attributes": {
- "additionalProperties": false,
- "description": "Override software license order form terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "additional_changes": {
- "type": "string"
- },
- "deletion_procedure_include_custom": {
- "type": "boolean"
- },
- "deletion_procedure_include_custom_description": {
- "type": "string"
- },
- "deletion_procedure_include_customer_disable": {
- "type": "boolean"
- },
- "deletion_procedure_include_customer_proof": {
- "type": "boolean"
- },
- "deletion_procedure_include_provider_disable": {
- "type": "boolean"
- },
- "fee_custom_unit": {
- "type": "string"
- },
- "fee_period": {
- "enum": [
- "Subscription Period",
- "month",
- "year",
- "Custom unit"
- ],
- "type": "string"
- },
- "fees_attributes": {
- "additionalProperties": {
- "anyOf": [
- {
- "additionalProperties": false,
- "description": "Fees::Flat (fee_type \"flat\"). A fixed recurring fee, e.g. a platform subscription. Set type to \"Fees::Flat\" or fee_type to \"flat\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "Fixed amount in the order form's fees_currency, charged per fee_period. A plain amount, not cents: 20 means 20.00.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"flat\". Alternative to type.",
- "enum": [
- "flat"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Flat\". Optional when fee_type is set.",
- "enum": [
- "Fees::Flat"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Discount (fee_type \"discount\"). A discount, as a fixed amount or a percentage, applied forever, once, or for a number of months. Set type to \"Fees::Discount\" or fee_type to \"discount\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "Discount size: an amount in fees_currency when discount_type is fixed_amount (a plain amount, not cents: 20 means 20.00), or a percentage (e.g. 10 for 10%) when it is percentage.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "discount_duration_amount": {
- "description": "Number of months the discount applies. Required when discount_duration_type is multiple_months.",
- "type": "number"
- },
- "discount_duration_type": {
- "description": "How long the discount applies. multiple_months also needs discount_duration_amount.",
- "enum": [
- "forever",
- "once",
- "multiple_months"
- ],
- "type": "string"
- },
- "discount_type": {
- "description": "Whether cost is a currency amount or a percentage.",
- "enum": [
- "fixed_amount",
- "percentage"
- ],
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"discount\". Alternative to type.",
- "enum": [
- "discount"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Discount\". Optional when fee_type is set.",
- "enum": [
- "Fees::Discount"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Cost (fee_type \"cost\"). A per-unit fee: price per unit times quantity, e.g. seats. Set type to \"Fees::Cost\" or fee_type to \"cost\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "Price per unit in fees_currency. The row total is quantity x cost. A plain amount, not cents: 20 means 20.00.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"cost\". Alternative to type.",
- "enum": [
- "cost"
- ],
- "type": "string"
- },
- "quantity": {
- "description": "Number of units.",
- "type": "number"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Cost\". Optional when fee_type is set.",
- "enum": [
- "Fees::Cost"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Attachment (fee_type \"attachment\"). A fee described in an uploaded attachment instead of in the table. Set type to \"Fees::Attachment\" or fee_type to \"attachment\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "attachment_id": {
- "description": "ID of an attachment uploaded with upload-attachment.",
- "type": "string"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"attachment\". Alternative to type.",
- "enum": [
- "attachment"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Attachment\". Optional when fee_type is set.",
- "enum": [
- "Fees::Attachment"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Graduated (fee_type \"graduated\"). Tiered pricing, with the price set per tier in graduated_fee_tiers_attributes. Set type to \"Fees::Graduated\" or fee_type to \"graduated\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"graduated\". Alternative to type.",
- "enum": [
- "graduated"
- ],
- "type": "string"
- },
- "graduated_fee_tiers_attributes": {
- "additionalProperties": {
- "additionalProperties": false,
- "properties": {
- "flat_price": {
- "type": "number"
- },
- "price_per_unit": {
- "type": "string"
- },
- "upper_limit": {
- "type": "number"
- }
- },
- "type": "object"
- },
- "description": "Graduated fee tiers. Use string keys such as \"0\", \"1\".",
- "propertyNames": {
- "type": "string"
- },
- "type": "object"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Graduated\". Optional when fee_type is set.",
- "enum": [
- "Fees::Graduated"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Included (fee_type \"included\"). An item included at no charge. Set type to \"Fees::Included\" or fee_type to \"included\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"included\". Alternative to type.",
- "enum": [
- "included"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Included\". Optional when fee_type is set.",
- "enum": [
- "Fees::Included"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Metered (fee_type \"metered\"). Usage-based pricing, billed per unit used. Set type to \"Fees::Metered\" or fee_type to \"metered\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "Price per unit of usage in fees_currency. A plain amount, not cents: 20 means 20.00.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"metered\". Alternative to type.",
- "enum": [
- "metered"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Metered\". Optional when fee_type is set.",
- "enum": [
- "Fees::Metered"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::OneTime (fee_type \"one_time\"). A one-time charge, such as a setup fee. Set type to \"Fees::OneTime\" or fee_type to \"one_time\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "One-time amount in fees_currency, charged once rather than per fee_period. A plain amount, not cents: 20 means 20.00.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"one_time\". Alternative to type.",
- "enum": [
- "one_time"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::OneTime\". Optional when fee_type is set.",
- "enum": [
- "Fees::OneTime"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Text (fee_type \"text\"). A fee term described in free text. Set type to \"Fees::Text\" or fee_type to \"text\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"text\". Alternative to type.",
- "enum": [
- "text"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Text\". Optional when fee_type is set.",
- "enum": [
- "Fees::Text"
- ],
- "type": "string"
- }
- },
- "type": "object"
- }
- ]
- },
- "description": "Fee line items. Use string keys such as \"0\", \"1\". Replaces template fees when provided.",
- "propertyNames": {
- "type": "string"
- },
- "type": "object"
- },
- "fees_currency": {
- "enum": [
- "USD",
- "EUR",
- "GBP",
- "CAD",
- "AUD",
- "SGD",
- "ILS",
- "JPY",
- "CHF",
- "HKD"
- ],
- "type": "string"
- },
- "fees_include_fee_increase_upon_renewal": {
- "type": "boolean"
- },
- "fees_include_fee_increase_upon_renewal_fee": {
- "type": "number"
- },
- "fees_include_fee_increase_upon_renewal_type": {
- "enum": [
- "will",
- "may"
- ],
- "type": "string"
- },
- "fees_inclusive_of_taxes": {
- "type": "boolean"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_additional_changes": {
- "type": "boolean"
- },
- "include_license_compliance_verification": {
- "type": "boolean"
- },
- "include_license_compliance_verification_description": {
- "type": "string"
- },
- "include_license_limits": {
- "type": "boolean"
- },
- "include_license_limits_description": {
- "type": "string"
- },
- "include_payment_process_include_billing_email": {
- "type": "boolean"
- },
- "include_pilot_period": {
- "type": "boolean"
- },
- "include_pilot_period_duration_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_pilot_period_duration_type": {
- "enum": [
- "day",
- "week",
- "month"
- ],
- "type": "string"
- },
- "include_pilot_period_include_fees": {
- "type": "boolean"
- },
- "include_pilot_period_include_fees_amount": {
- "type": "number"
- },
- "include_pilot_period_include_modifications": {
- "type": "boolean"
- },
- "include_pilot_period_include_modifications_description": {
- "type": "string"
- },
- "include_services": {
- "type": "boolean"
- },
- "include_services_description": {
- "type": "string"
- },
- "negotiations_allowed": {
- "description": "When true, the recipient can propose changes to the order form, even when the agreement-level `negotiations_allowed` is false. This only covers the order form.",
- "type": "boolean"
- },
- "order_date_date": {
- "type": "string"
- },
- "order_date_type": {
- "enum": [
- "signature",
- "date",
- "other"
- ],
- "type": "string"
- },
- "payment_process_automatic_frequency": {
- "enum": [
- "monthly",
- "quarterly",
- "semiannually",
- "annually"
- ],
- "type": "string"
- },
- "payment_process_type": {
- "enum": [
- "automatic",
- "invoice",
- "custom"
- ],
- "type": "string"
- },
- "payment_process_type_custom_val": {
- "type": "string"
- },
- "payment_process_type_invoice_amount": {
- "type": "number"
- },
- "payment_process_type_invoice_custom_unit": {
- "type": "string"
- },
- "payment_process_type_invoice_duration": {
- "enum": [
- "day",
- "week",
- "month",
- "year",
- "day(s)",
- "week(s)",
- "month(s)",
- "year(s)"
- ],
- "type": "string"
- },
- "payment_process_type_invoice_duration_start": {
- "enum": [
- "Customer's receipt of invoice",
- "date of invoice"
- ],
- "type": "string"
- },
- "payment_process_type_invoice_type": {
- "enum": [
- "monthly",
- "quarterly",
- "semiannually",
- "annually",
- "Custom unit"
- ],
- "type": "string"
- },
- "permitted_uses_include_custom": {
- "type": "boolean"
- },
- "permitted_uses_include_custom_description": {
- "type": "string"
- },
- "permitted_uses_include_customers_affiliates": {
- "type": "boolean"
- },
- "permitted_uses_include_internal_business": {
- "type": "boolean"
- },
- "pilot_period_stripe_product_id": {
- "type": "string"
- },
- "software_description": {
- "type": "string"
- },
- "subscription_auto_renew": {
- "enum": [
- "days",
- "subscription_end"
- ],
- "type": "string"
- },
- "subscription_period": {
- "type": "number"
- },
- "subscription_period_unit": {
- "type": "string"
- },
- "subscription_renewal_notice_days": {
- "type": "number"
- },
- "warranty_period_description_amount": {
- "type": "number"
- },
- "warranty_period_description_duration": {
- "enum": [
- "day",
- "week",
- "month",
- "year"
- ],
- "type": "string"
- },
- "warranty_period_description_duration_start": {
- "enum": [
- "initial delivery of the Software",
- "delivery of the Software and each subsequent Update",
- "the Order Date"
- ],
- "type": "string"
- },
- "warranty_period_type": {
- "enum": [
- "description",
- "none"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- "test_agreement": {
- "description": "When true, marks the agreement as a test. Test agreements do not count against your monthly limit.",
- "type": "boolean"
- }
- },
- "required": [
- "recipient_name",
- "recipient_email"
- ],
- "type": "object"
- },
- "cc_users": {
- "items": {
- "format": "email",
- "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
- "type": "string"
- },
- "type": "array"
- },
- "draft": {
- "description": "When true, the agreement is saved as a draft and not sent to the recipient. Use POST /v1/agreements/{id}/send to send a draft agreement later.",
- "type": "boolean"
- },
- "owner_email": {
- "description": "Email address of the agreement owner (sender).",
- "type": "string"
- },
- "signer_email": {
- "description": "Email address of the signer from the owner's organization.",
- "format": "email",
- "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
- "type": "string"
- },
- "template_id": {
- "description": "UUID of a template from `GET /v1/templates`. Accepts both Common Paper standard templates and uploaded PDF templates (`type` `uploaded_template`).",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- }
- },
- "required": [
- "template_id",
- "owner_email",
- "signer_email",
- "agreement"
- ],
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "agreement": {
- "additionalProperties": {},
- "properties": {
- "amendment_attributes": {
- "additionalProperties": false,
- "description": "Override amendment terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "amended_terms_attributes": {
- "additionalProperties": {
- "additionalProperties": false,
- "properties": {
- "description": {
- "type": "string"
- },
- "term": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "description": "Amended terms. Use string keys such as \"0\", \"1\".",
- "propertyNames": {
- "type": "string"
- },
- "type": "object"
- },
- "amendment_date": {
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "amendment_date_type": {
- "enum": [
- "signature",
- "date"
- ],
- "type": "string"
- },
- "framework_terms_type": {
- "type": "string"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "parent_agreement_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "underlying_agreement_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "underlying_agreement_type": {
- "type": "string"
- },
- "underlying_agreement_val": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "baa_attributes": {
- "additionalProperties": false,
- "description": "Override baa terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "aggregation_limitations_permitted": {
- "type": "boolean"
- },
- "aggregation_limitations_permitted_val": {
- "type": "string"
- },
- "breach_notification_unit": {
- "enum": [
- "hours",
- "business days",
- "calendar days"
- ],
- "type": "string"
- },
- "breach_notification_val": {
- "type": "number"
- },
- "business_associate_relationship_type": {
- "enum": [
- "provider",
- "company"
- ],
- "type": "string"
- },
- "deidentification_limitations_include_purpose": {
- "type": "boolean"
- },
- "deidentification_limitations_include_requirements": {
- "type": "boolean"
- },
- "deidentification_limitations_permitted": {
- "type": "boolean"
- },
- "deidentification_limitations_purpose_val": {
- "type": "string"
- },
- "deidentification_limitations_requirements_val": {
- "type": "string"
- },
- "designated_record_set_provider_maintains": {
- "type": "boolean"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_aggregation_limitations": {
- "type": "boolean"
- },
- "include_deidentification_limitations": {
- "type": "boolean"
- },
- "include_limitations": {
- "type": "boolean"
- },
- "include_offshore_limitations": {
- "type": "boolean"
- },
- "include_subcontract_limitations": {
- "type": "boolean"
- },
- "offshore_limitations_permitted": {
- "type": "boolean"
- },
- "offshore_limitations_permitted_val": {
- "type": "string"
- },
- "subcontract_limitations_include_notice": {
- "type": "boolean"
- },
- "subcontract_limitations_include_permission": {
- "type": "boolean"
- },
- "subcontract_limitations_notice_val": {
- "type": "string"
- },
- "subcontract_limitations_permission_val": {
- "type": "string"
- },
- "subcontract_limitations_permitted": {
- "type": "boolean"
- },
- "underlying_agreement_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "underlying_agreement_type": {
- "enum": [
- "internal",
- "external",
- "none"
- ],
- "type": "string"
- },
- "underlying_agreement_val": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "billing_email": {
- "description": "Email of the billing contact. Used when include_billing_info is true.",
- "format": "email",
- "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
- "type": "string"
- },
- "billing_name": {
- "description": "Name of the billing contact. Used when include_billing_info is true.",
- "type": "string"
- },
- "billing_workflow_type": {
- "description": "The type of billing workflow. Use \"link\" to provide a payment_link_url, or \"stripe\" for Stripe-managed billing.",
- "enum": [
- "link",
- "stripe"
- ],
- "type": "string"
- },
- "chosen_courts_country": {
- "description": "The country in which disputes will be resolved.",
- "type": "string"
- },
- "chosen_courts_region": {
- "description": "The state or region in which disputes will be resolved.",
- "type": "string"
- },
- "csa_attributes": {
- "additionalProperties": false,
- "description": "Override csa terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "customer_description": {
- "type": "string"
- },
- "effective_date": {
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "effective_date_marketplace": {
- "enum": [
- "AWS",
- "GCP",
- "Azure"
- ],
- "type": "string"
- },
- "effective_date_type": {
- "enum": [
- "signature",
- "date",
- "marketplace_acceptance"
- ],
- "type": "string"
- },
- "general_cap_amount": {
- "type": "number"
- },
- "general_cap_amount_type": {
- "enum": [
- "preceding",
- "base",
- "period"
- ],
- "type": "string"
- },
- "general_cap_period_currency": {
- "type": "number"
- },
- "general_cap_period_qty": {
- "type": "number"
- },
- "general_cap_preceding_amount": {
- "type": "number"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_acceptable_use_policy": {
- "type": "boolean"
- },
- "include_acceptable_use_policy_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_acceptable_use_policy_location": {
- "type": "string"
- },
- "include_acceptable_use_policy_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_additional_warranties": {
- "type": "boolean"
- },
- "include_additional_warranties_by_customer": {
- "type": "string"
- },
- "include_additional_warranties_by_provider": {
- "type": "string"
- },
- "include_additional_warranties_include_by_customer": {
- "type": "boolean"
- },
- "include_additional_warranties_include_by_provider": {
- "type": "boolean"
- },
- "include_ai_addendum": {
- "type": "boolean"
- },
- "include_ai_addendum_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_covered_claims": {
- "type": "boolean"
- },
- "include_covered_claims_customer_claims": {
- "type": "string"
- },
- "include_covered_claims_include_customer_claims": {
- "type": "boolean"
- },
- "include_covered_claims_include_provider_claims": {
- "type": "boolean"
- },
- "include_covered_claims_provider_claims": {
- "type": "string"
- },
- "include_dpa": {
- "type": "boolean"
- },
- "include_dpa_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_dpa_location": {
- "type": "string"
- },
- "include_dpa_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_increased_cap_amount": {
- "type": "boolean"
- },
- "include_increased_claims": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_confidentiality": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_confidentiality_negligence": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_privsec": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_privsec_negligence": {
- "type": "boolean"
- },
- "include_increased_claims_include_other": {
- "type": "boolean"
- },
- "include_increased_claims_indemnification_obligation": {
- "type": "boolean"
- },
- "include_increased_claims_other": {
- "type": "string"
- },
- "include_insurance_minimums": {
- "type": "boolean"
- },
- "include_insurance_minimums_add_customer": {
- "type": "boolean"
- },
- "include_insurance_minimums_add_customer_com_gen_liability": {
- "type": "boolean"
- },
- "include_insurance_minimums_add_customer_cyber_liability": {
- "type": "boolean"
- },
- "include_insurance_minimums_add_customer_errors_omissions": {
- "type": "boolean"
- },
- "include_insurance_minimums_additional_information": {
- "type": "boolean"
- },
- "include_insurance_minimums_additional_information_text": {
- "type": "string"
- },
- "include_insurance_minimums_cyber_liability_aggregate": {
- "type": "number"
- },
- "include_insurance_minimums_cyber_liability_minimum": {
- "type": "number"
- },
- "include_insurance_minimums_employer_liability_aggregate": {
- "type": "number"
- },
- "include_insurance_minimums_employer_liability_minimum": {
- "type": "number"
- },
- "include_insurance_minimums_general_liability_aggregate": {
- "type": "number"
- },
- "include_insurance_minimums_general_liability_minimum": {
- "type": "number"
- },
- "include_insurance_minimums_include_cyber_liability": {
- "type": "boolean"
- },
- "include_insurance_minimums_include_employer_liability": {
- "type": "boolean"
- },
- "include_insurance_minimums_include_general_liability": {
- "type": "boolean"
- },
- "include_insurance_minimums_include_workers_compensation": {
- "type": "boolean"
- },
- "include_publicity_rights": {
- "type": "boolean"
- },
- "include_publicity_rights_type": {
- "enum": [
- "public",
- "non-public"
- ],
- "type": "string"
- },
- "include_security_policy": {
- "type": "boolean"
- },
- "include_security_policy_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_security_policy_fedramp_auth": {
- "type": "boolean"
- },
- "include_security_policy_hipaa": {
- "type": "boolean"
- },
- "include_security_policy_hitrust": {
- "type": "boolean"
- },
- "include_security_policy_include_annual_maintenance": {
- "type": "boolean"
- },
- "include_security_policy_include_location": {
- "type": "boolean"
- },
- "include_security_policy_include_other": {
- "type": "boolean"
- },
- "include_security_policy_include_reasonable_efforts": {
- "type": "boolean"
- },
- "include_security_policy_iso27001": {
- "type": "boolean"
- },
- "include_security_policy_location": {
- "type": "string"
- },
- "include_security_policy_other": {
- "type": "string"
- },
- "include_security_policy_pci1": {
- "type": "boolean"
- },
- "include_security_policy_pci2": {
- "type": "boolean"
- },
- "include_security_policy_penetration_testing": {
- "type": "boolean"
- },
- "include_security_policy_soc2": {
- "type": "boolean"
- },
- "include_security_policy_soc2_type2": {
- "type": "boolean"
- },
- "include_security_policy_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_supercap": {
- "description": "CSA 3.0 renamed `include_increased_cap_amount` to `include_supercap`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_increased_cap_amount`. Sending the other spelling returns a 422.",
- "type": "boolean"
- },
- "include_uncapped_claims": {
- "description": "CSA 3.0 renamed `include_unlimited_claims` to `include_uncapped_claims`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims`. Sending the other spelling returns a 422.",
- "type": "boolean"
- },
- "include_uncapped_claims_breach_of_confidentiality": {
- "description": "CSA 3.0 renamed `include_unlimited_claims_breach_of_confidentiality` to `include_uncapped_claims_breach_of_confidentiality`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_breach_of_confidentiality`. Sending the other spelling returns a 422.",
- "type": "boolean"
- },
- "include_uncapped_claims_breach_of_confidentiality_negligence": {
- "description": "CSA 3.0 renamed `include_unlimited_claims_breach_of_confidentiality_negligence` to `include_uncapped_claims_breach_of_confidentiality_negligence`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_breach_of_confidentiality_negligence`. Sending the other spelling returns a 422.",
- "type": "boolean"
- },
- "include_uncapped_claims_breach_of_privsec": {
- "description": "CSA 3.0 renamed `include_unlimited_claims_breach_of_privsec` to `include_uncapped_claims_breach_of_privsec`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_breach_of_privsec`. Sending the other spelling returns a 422.",
- "type": "boolean"
- },
- "include_uncapped_claims_breach_of_privsec_negligence": {
- "description": "CSA 3.0 renamed `include_unlimited_claims_breach_of_privsec_negligence` to `include_uncapped_claims_breach_of_privsec_negligence`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_breach_of_privsec_negligence`. Sending the other spelling returns a 422.",
- "type": "boolean"
- },
- "include_uncapped_claims_include_other": {
- "description": "CSA 3.0 renamed `include_unlimited_claims_include_other` to `include_uncapped_claims_include_other`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_include_other`. Sending the other spelling returns a 422.",
- "type": "boolean"
- },
- "include_uncapped_claims_indemnification_obligation": {
- "description": "CSA 3.0 renamed `include_unlimited_claims_indemnification_obligation` to `include_uncapped_claims_indemnification_obligation`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_indemnification_obligation`. Sending the other spelling returns a 422.",
- "type": "boolean"
- },
- "include_uncapped_claims_other": {
- "description": "CSA 3.0 renamed `include_unlimited_claims_other` to `include_uncapped_claims_other`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_other`. Sending the other spelling returns a 422.",
- "type": "boolean"
- },
- "include_unlimited_claims": {
- "type": "boolean"
- },
- "include_unlimited_claims_breach_of_confidentiality": {
- "type": "boolean"
- },
- "include_unlimited_claims_breach_of_confidentiality_negligence": {
- "type": "boolean"
- },
- "include_unlimited_claims_breach_of_privsec": {
- "type": "boolean"
- },
- "include_unlimited_claims_breach_of_privsec_negligence": {
- "type": "boolean"
- },
- "include_unlimited_claims_include_other": {
- "type": "boolean"
- },
- "include_unlimited_claims_indemnification_obligation": {
- "type": "boolean"
- },
- "include_unlimited_claims_other": {
- "type": "string"
- },
- "increased_cap_amount_currency": {
- "type": "number"
- },
- "increased_cap_amount_period_currency": {
- "type": "number"
- },
- "increased_cap_amount_period_qty": {
- "type": "number"
- },
- "increased_cap_amount_qty": {
- "type": "number"
- },
- "increased_cap_amount_type": {
- "enum": [
- "qty",
- "currency",
- "period"
- ],
- "type": "string"
- },
- "provider": {
- "type": "string"
- },
- "supercap_currency": {
- "description": "CSA 3.0 renamed `increased_cap_amount_currency` to `supercap_currency`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `increased_cap_amount_currency`. Sending the other spelling returns a 422.",
- "type": "number"
- },
- "supercap_period_currency": {
- "description": "CSA 3.0 renamed `increased_cap_amount_period_currency` to `supercap_period_currency`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `increased_cap_amount_period_currency`. Sending the other spelling returns a 422.",
- "type": "number"
- },
- "supercap_period_qty": {
- "description": "CSA 3.0 renamed `increased_cap_amount_period_qty` to `supercap_period_qty`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `increased_cap_amount_period_qty`. Sending the other spelling returns a 422.",
- "type": "number"
- },
- "supercap_qty": {
- "description": "CSA 3.0 renamed `increased_cap_amount_qty` to `supercap_qty`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `increased_cap_amount_qty`. Sending the other spelling returns a 422.",
- "type": "number"
- },
- "supercap_type": {
- "description": "CSA 3.0 renamed `increased_cap_amount_type` to `supercap_type`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `increased_cap_amount_type`. Sending the other spelling returns a 422.",
- "type": "number"
- }
- },
- "type": "object"
- },
- "csa_order_form_attributes": {
- "additionalProperties": false,
- "description": "Override csa order form terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "additional_changes": {
- "type": "string"
- },
- "additional_parameters_or_limitations": {
- "type": "string"
- },
- "affiliates_as_users": {
- "type": "boolean"
- },
- "cloud_service_description": {
- "type": "string"
- },
- "consumption_units": {
- "type": "string"
- },
- "fee_amount": {
- "type": "number"
- },
- "fee_custom_unit": {
- "type": "string"
- },
- "fee_period": {
- "enum": [
- "Subscription Period",
- "month",
- "year",
- "User",
- "Custom unit"
- ],
- "type": "string"
- },
- "fees_attributes": {
- "additionalProperties": {
- "anyOf": [
- {
- "additionalProperties": false,
- "description": "Fees::Flat (fee_type \"flat\"). A fixed recurring fee, e.g. a platform subscription. Set type to \"Fees::Flat\" or fee_type to \"flat\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "Fixed amount in the order form's fees_currency, charged per fee_period. A plain amount, not cents: 20 means 20.00.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"flat\". Alternative to type.",
- "enum": [
- "flat"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Flat\". Optional when fee_type is set.",
- "enum": [
- "Fees::Flat"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Discount (fee_type \"discount\"). A discount, as a fixed amount or a percentage, applied forever, once, or for a number of months. Set type to \"Fees::Discount\" or fee_type to \"discount\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "Discount size: an amount in fees_currency when discount_type is fixed_amount (a plain amount, not cents: 20 means 20.00), or a percentage (e.g. 10 for 10%) when it is percentage.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "discount_duration_amount": {
- "description": "Number of months the discount applies. Required when discount_duration_type is multiple_months.",
- "type": "number"
- },
- "discount_duration_type": {
- "description": "How long the discount applies. multiple_months also needs discount_duration_amount.",
- "enum": [
- "forever",
- "once",
- "multiple_months"
- ],
- "type": "string"
- },
- "discount_type": {
- "description": "Whether cost is a currency amount or a percentage.",
- "enum": [
- "fixed_amount",
- "percentage"
- ],
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"discount\". Alternative to type.",
- "enum": [
- "discount"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Discount\". Optional when fee_type is set.",
- "enum": [
- "Fees::Discount"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Cost (fee_type \"cost\"). A per-unit fee: price per unit times quantity, e.g. seats. Set type to \"Fees::Cost\" or fee_type to \"cost\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "Price per unit in fees_currency. The row total is quantity x cost. A plain amount, not cents: 20 means 20.00.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"cost\". Alternative to type.",
- "enum": [
- "cost"
- ],
- "type": "string"
- },
- "quantity": {
- "description": "Number of units.",
- "type": "number"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Cost\". Optional when fee_type is set.",
- "enum": [
- "Fees::Cost"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Attachment (fee_type \"attachment\"). A fee described in an uploaded attachment instead of in the table. Set type to \"Fees::Attachment\" or fee_type to \"attachment\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "attachment_id": {
- "description": "ID of an attachment uploaded with upload-attachment.",
- "type": "string"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"attachment\". Alternative to type.",
- "enum": [
- "attachment"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Attachment\". Optional when fee_type is set.",
- "enum": [
- "Fees::Attachment"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Graduated (fee_type \"graduated\"). Tiered pricing, with the price set per tier in graduated_fee_tiers_attributes. Set type to \"Fees::Graduated\" or fee_type to \"graduated\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"graduated\". Alternative to type.",
- "enum": [
- "graduated"
- ],
- "type": "string"
- },
- "graduated_fee_tiers_attributes": {
- "additionalProperties": {
- "additionalProperties": false,
- "properties": {
- "flat_price": {
- "type": "number"
- },
- "price_per_unit": {
- "type": "string"
- },
- "upper_limit": {
- "type": "number"
- }
- },
- "type": "object"
- },
- "description": "Graduated fee tiers. Use string keys such as \"0\", \"1\".",
- "propertyNames": {
- "type": "string"
- },
- "type": "object"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Graduated\". Optional when fee_type is set.",
- "enum": [
- "Fees::Graduated"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Included (fee_type \"included\"). An item included at no charge. Set type to \"Fees::Included\" or fee_type to \"included\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"included\". Alternative to type.",
- "enum": [
- "included"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Included\". Optional when fee_type is set.",
- "enum": [
- "Fees::Included"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Metered (fee_type \"metered\"). Usage-based pricing, billed per unit used. Set type to \"Fees::Metered\" or fee_type to \"metered\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "Price per unit of usage in fees_currency. A plain amount, not cents: 20 means 20.00.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"metered\". Alternative to type.",
- "enum": [
- "metered"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Metered\". Optional when fee_type is set.",
- "enum": [
- "Fees::Metered"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::OneTime (fee_type \"one_time\"). A one-time charge, such as a setup fee. Set type to \"Fees::OneTime\" or fee_type to \"one_time\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "One-time amount in fees_currency, charged once rather than per fee_period. A plain amount, not cents: 20 means 20.00.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"one_time\". Alternative to type.",
- "enum": [
- "one_time"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::OneTime\". Optional when fee_type is set.",
- "enum": [
- "Fees::OneTime"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Text (fee_type \"text\"). A fee term described in free text. Set type to \"Fees::Text\" or fee_type to \"text\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"text\". Alternative to type.",
- "enum": [
- "text"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Text\". Optional when fee_type is set.",
- "enum": [
- "Fees::Text"
- ],
- "type": "string"
- }
- },
- "type": "object"
- }
- ]
- },
- "description": "Fee table rows, keyed by string index (\"0\", \"1\", ...). Replaces the template's fees when provided. Each row sets type or fee_type to pick the fee class. Amounts are in the order form's fees_currency and, for recurring fees, are charged per fee_period.",
- "examples": [
- {
- "0": {
- "cost": 2000,
- "description": "Platform subscription",
- "type": "Fees::Flat"
- }
- },
- {
- "0": {
- "cost": 50,
- "description": "Seats",
- "fee_type": "cost",
- "quantity": 10
- },
- "1": {
- "cost": 10,
- "description": "Launch discount",
- "discount_duration_amount": 3,
- "discount_duration_type": "multiple_months",
- "discount_type": "percentage",
- "fee_type": "discount"
- }
- }
- ],
- "propertyNames": {
- "type": "string"
- },
- "type": "object"
- },
- "fees_currency": {
- "enum": [
- "USD",
- "EUR",
- "GBP",
- "CAD",
- "AUD",
- "SGD",
- "ILS",
- "JPY",
- "CHF",
- "HKD"
- ],
- "type": "string"
- },
- "fees_include_fee_increase_upon_renewal": {
- "type": "boolean"
- },
- "fees_include_fee_increase_upon_renewal_fee": {
- "type": "number"
- },
- "fees_include_fee_increase_upon_renewal_type": {
- "enum": [
- "will",
- "may"
- ],
- "type": "string"
- },
- "fees_inclusive_of_taxes": {
- "type": "boolean"
- },
- "framework_terms_type": {
- "enum": [
- "new",
- "existing",
- "description"
- ],
- "type": "string"
- },
- "free_trial_days": {
- "type": "number"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_additional_changes": {
- "type": "boolean"
- },
- "include_additional_parameters_or_limitations": {
- "type": "boolean"
- },
- "include_consumption": {
- "type": "boolean"
- },
- "include_fees": {
- "type": "boolean"
- },
- "include_fees_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_fees_include_attachment": {
- "type": "boolean"
- },
- "include_fees_other": {
- "type": "boolean"
- },
- "include_fees_other_val": {
- "type": "string"
- },
- "include_fees_table": {
- "type": "boolean"
- },
- "include_fees_table_period": {
- "enum": [
- "Subscription Period",
- "month",
- "year",
- "User"
- ],
- "type": "string"
- },
- "include_free_trial": {
- "type": "boolean"
- },
- "include_max_users": {
- "type": "boolean"
- },
- "include_pilot_period": {
- "type": "boolean"
- },
- "include_pilot_period_duration_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_pilot_period_duration_type": {
- "enum": [
- "day",
- "week",
- "month"
- ],
- "type": "string"
- },
- "include_pilot_period_include_fees": {
- "type": "boolean"
- },
- "include_pilot_period_include_fees_amount": {
- "type": "number"
- },
- "include_pilot_period_include_modifications": {
- "type": "boolean"
- },
- "include_pilot_period_include_modifications_description": {
- "type": "string"
- },
- "include_product_support": {
- "type": "boolean"
- },
- "include_product_support_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_product_support_description": {
- "type": "string"
- },
- "include_product_support_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_professional_services": {
- "type": "boolean"
- },
- "include_professional_services_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_professional_services_custom_name": {
- "type": "string"
- },
- "include_professional_services_description": {
- "type": "string"
- },
- "include_professional_services_end_date": {
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "include_professional_services_fees_description": {
- "type": "string"
- },
- "include_professional_services_include_end_date": {
- "type": "boolean"
- },
- "include_professional_services_include_fees_description": {
- "type": "boolean"
- },
- "include_professional_services_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_sla": {
- "type": "boolean"
- },
- "include_sla_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_sla_description": {
- "type": "string"
- },
- "include_sla_include_response_time": {
- "type": "boolean"
- },
- "include_sla_include_response_time_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_sla_include_response_time_credit": {
- "type": "number"
- },
- "include_sla_include_response_time_duration": {
- "enum": [
- "hour",
- "day",
- "week",
- "month",
- "hours"
- ],
- "type": "string"
- },
- "include_sla_include_response_time_support_channel": {
- "type": "string"
- },
- "include_sla_include_target_uptime": {
- "type": "boolean"
- },
- "include_sla_maintenance_notice": {
- "type": "boolean"
- },
- "include_sla_maintenance_window": {
- "type": "boolean"
- },
- "include_sla_maintenance_window_type": {
- "enum": [
- "standard",
- "none"
- ],
- "type": "string"
- },
- "include_sla_standard_maintenance_notice_qty": {
- "type": "number"
- },
- "include_sla_standard_maintenance_notice_unit": {
- "enum": [
- "hour",
- "day",
- "week",
- "month"
- ],
- "type": "string"
- },
- "include_sla_standard_maintenance_window_end_time": {
- "type": "string"
- },
- "include_sla_standard_maintenance_window_friday": {
- "type": "boolean"
- },
- "include_sla_standard_maintenance_window_monday": {
- "type": "boolean"
- },
- "include_sla_standard_maintenance_window_saturday": {
- "type": "boolean"
- },
- "include_sla_standard_maintenance_window_start_time": {
- "type": "string"
- },
- "include_sla_standard_maintenance_window_sunday": {
- "type": "boolean"
- },
- "include_sla_standard_maintenance_window_thursday": {
- "type": "boolean"
- },
- "include_sla_standard_maintenance_window_time_zone": {
- "type": "string"
- },
- "include_sla_standard_maintenance_window_tuesday": {
- "type": "boolean"
- },
- "include_sla_standard_maintenance_window_wednesday": {
- "type": "boolean"
- },
- "include_sla_standard_target_uptime": {
- "type": "number"
- },
- "include_sla_type": {
- "enum": [
- "description",
- "standard",
- "attachment"
- ],
- "type": "string"
- },
- "include_subscription_start_date": {
- "type": "boolean"
- },
- "include_subscription_start_date_date": {
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "include_usage_review": {
- "type": "boolean"
- },
- "include_usage_review_val": {
- "type": "string"
- },
- "include_use_limitations": {
- "type": "boolean"
- },
- "include_use_limitations_val": {
- "type": "string"
- },
- "invoice_period": {
- "enum": [
- "monthly",
- "quarterly",
- "semiannually",
- "annually",
- "Custom unit",
- "Monthly",
- "Quarterly",
- "Semiannually",
- "Annually"
- ],
- "type": "string"
- },
- "invoice_period_custom_unit": {
- "type": "string"
- },
- "max_consumption": {
- "type": "number"
- },
- "max_users": {
- "type": "number"
- },
- "negotiations_allowed": {
- "description": "When true, the recipient can propose changes to the order form, even when the agreement-level `negotiations_allowed` is false. This only covers the order form.",
- "type": "boolean"
- },
- "order_date_date": {
- "type": "string"
- },
- "order_date_other": {
- "type": "string"
- },
- "order_date_type": {
- "enum": [
- "signature",
- "date",
- "other"
- ],
- "type": "string"
- },
- "payment_period": {
- "type": "number"
- },
- "payment_period_timeframe": {
- "enum": [
- "Customer's receipt of invoice",
- "date of invoice"
- ],
- "type": "string"
- },
- "payment_period_unit": {
- "enum": [
- "day(s)",
- "week(s)",
- "month(s)",
- "marketplace_acceptance"
- ],
- "type": "string"
- },
- "payment_process_automatic_frequency": {
- "enum": [
- "monthly",
- "quarterly",
- "semiannually",
- "annually"
- ],
- "type": "string"
- },
- "payment_process_type": {
- "enum": [
- "automatic",
- "invoice",
- "custom",
- "marketplace_acceptance"
- ],
- "type": "string"
- },
- "payment_process_type_custom_val": {
- "type": "string"
- },
- "payment_process_type_invoice_amount": {
- "type": "number"
- },
- "payment_process_type_invoice_custom_unit": {
- "type": "string"
- },
- "payment_process_type_invoice_duration": {
- "enum": [
- "day",
- "week",
- "month",
- "year",
- "day(s)",
- "week(s)",
- "month(s)",
- "year(s)"
- ],
- "type": "string"
- },
- "payment_process_type_invoice_duration_start": {
- "enum": [
- "Customer's receipt of invoice",
- "date of invoice"
- ],
- "type": "string"
- },
- "payment_process_type_invoice_type": {
- "enum": [
- "monthly",
- "quarterly",
- "semiannually",
- "annually",
- "Custom unit"
- ],
- "type": "string"
- },
- "pilot_period_stripe_product_id": {
- "type": "string"
- },
- "service_credits_attributes": {
- "additionalProperties": {
- "additionalProperties": false,
- "properties": {
- "credit": {
- "type": "number"
- },
- "max": {
- "type": "number"
- },
- "min": {
- "type": "number"
- }
- },
- "type": "object"
- },
- "description": "Service credits. Use string keys such as \"0\", \"1\".",
- "propertyNames": {
- "type": "string"
- },
- "type": "object"
- },
- "subscription_auto_renew": {
- "enum": [
- "days",
- "subscription_end"
- ],
- "type": "string"
- },
- "subscription_period": {
- "type": "number"
- },
- "subscription_period_unit": {
- "type": "string"
- },
- "subscription_renewal_notice_days": {
- "type": "number"
- },
- "subscription_start_date": {
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "subscription_start_date_type": {
- "enum": [
- "effective_date",
- "date"
- ],
- "type": "string"
- },
- "underlying_agreement_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "use_limitations_attributes": {
- "additionalProperties": {
- "additionalProperties": false,
- "properties": {
- "amount": {
- "type": "number"
- },
- "limitation_type": {
- "type": "string"
- },
- "unit": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "description": "Use limitations. Use string keys such as \"0\", \"1\".",
- "propertyNames": {
- "type": "string"
- },
- "type": "object"
- }
- },
- "type": "object"
- },
- "custom_field_values": {
- "description": "Values for a custom template's fields, keyed by the field keys defined in the template's YAML definition. Only used when template_id is a custom template. Template defaults fill any fields you omit; a required field with no default and no submitted value returns a 400 naming the field. Values are validated against the field's input type: select and radio values must be one of the field's options, multiselect values are an array of selections each of which must be one of the field's options, number and currency values must be numeric, date values must be YYYY-MM-DD, and email values must be valid addresses. An invalid value returns a 400 naming the field."
- },
- "design_partner_attributes": {
- "additionalProperties": false,
- "description": "Override design partner terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "customer_description": {
- "type": "string"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_fees": {
- "type": "boolean"
- },
- "include_fees_amount": {
- "type": "number"
- },
- "include_fees_description": {
- "type": "string"
- },
- "include_fees_pay_by_amount": {
- "type": "string"
- },
- "include_fees_type": {
- "enum": [
- "default_language",
- "description"
- ],
- "type": "string"
- },
- "include_fees_unit": {
- "enum": [
- "month",
- "quarter",
- "year",
- "Term"
- ],
- "type": "string"
- },
- "include_program_appear_as_customer_private": {
- "type": "boolean"
- },
- "include_program_appear_as_customer_public": {
- "type": "boolean"
- },
- "include_program_case_study": {
- "type": "boolean"
- },
- "include_program_develop_functionality": {
- "type": "boolean"
- },
- "include_program_develop_functionality_val": {
- "type": "string"
- },
- "include_program_discount": {
- "type": "boolean"
- },
- "include_program_discount_amount": {
- "type": "number"
- },
- "include_program_discount_unit": {
- "enum": [
- "U.S. Dollars",
- "percent"
- ],
- "type": "string"
- },
- "include_program_participation_feedback": {
- "type": "boolean"
- },
- "include_program_participation_feedback_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_program_participation_feedback_unit": {
- "enum": [
- "month",
- "quarter",
- "year",
- "Term"
- ],
- "type": "string"
- },
- "include_program_partner_other": {
- "type": "boolean"
- },
- "include_program_partner_other_val": {
- "type": "string"
- },
- "include_program_provider_other": {
- "type": "boolean"
- },
- "include_program_provider_other_val": {
- "type": "string"
- },
- "include_program_reference": {
- "type": "boolean"
- },
- "product_description": {
- "type": "string"
- },
- "term_amount": {
- "type": "number"
- },
- "term_unit": {
- "enum": [
- "day(s)",
- "week(s)",
- "month(s)",
- "quarter(s)",
- "year(s)"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- "district_or_county": {
- "description": "The district or county for dispute resolution.",
- "type": "string"
- },
- "dpa_attributes": {
- "additionalProperties": false,
- "description": "Override dpa terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "approved_subprocessor_type": {
- "description": "`internal` lists approved subprocessors in the agreement (`subprocessors_attributes`); `external` points to a list published elsewhere.",
- "enum": [
- "internal",
- "external"
- ],
- "type": "string"
- },
- "cloud_service_product_name": {
- "type": "string"
- },
- "competent_supervisory_authority": {
- "type": "string"
- },
- "customer_description": {
- "type": "string"
- },
- "data_exporter_address_city": {
- "type": "string"
- },
- "data_exporter_address_country": {
- "type": "string"
- },
- "data_exporter_address_state": {
- "type": "string"
- },
- "data_exporter_address_street_address": {
- "type": "string"
- },
- "data_exporter_address_zipcode": {
- "type": "string"
- },
- "data_exporter_contact_details": {
- "type": "string"
- },
- "data_exporter_contact_name": {
- "type": "string"
- },
- "data_exporter_contact_position": {
- "type": "string"
- },
- "data_exporter_role": {
- "description": "Role of the data exporter. Overwritten to `Controller` when the agreement is created from a template.",
- "enum": [
- "Controller",
- "Processor"
- ],
- "type": "string"
- },
- "data_importer_address": {
- "type": "string"
- },
- "data_importer_address_city": {
- "type": "string"
- },
- "data_importer_address_country": {
- "type": "string"
- },
- "data_importer_address_state": {
- "type": "string"
- },
- "data_importer_address_street_address": {
- "type": "string"
- },
- "data_importer_address_zipcode": {
- "type": "string"
- },
- "data_importer_contact_details": {
- "type": "string"
- },
- "data_importer_contact_name": {
- "type": "string"
- },
- "data_importer_contact_position": {
- "type": "string"
- },
- "duration_of_processing": {
- "type": "string"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_covered_claim": {
- "type": "boolean"
- },
- "include_covered_claim_external_val": {
- "type": "string"
- },
- "include_covered_claim_internal_val": {
- "type": "string"
- },
- "include_covered_claim_type": {
- "description": "Which covered-claim text applies: `internal` uses `include_covered_claim_internal_val`, `external` uses `include_covered_claim_external_val`. Required when `include_covered_claim` is true.",
- "enum": [
- "internal",
- "external"
- ],
- "type": "string"
- },
- "include_data_subjects_custom": {
- "type": "boolean"
- },
- "include_data_subjects_custom_val": {
- "type": "string"
- },
- "include_data_subjects_employees": {
- "type": "boolean"
- },
- "include_data_subjects_end_users": {
- "type": "boolean"
- },
- "include_external_subprocessor_location": {
- "type": "string"
- },
- "include_frequency_of_transfer_continuous": {
- "type": "boolean"
- },
- "include_frequency_of_transfer_custom": {
- "type": "boolean"
- },
- "include_frequency_of_transfer_custom_val": {
- "type": "string"
- },
- "include_governing_country_eu": {
- "type": "boolean"
- },
- "include_governing_country_eu_val": {
- "type": "string"
- },
- "include_governing_country_uk": {
- "type": "boolean"
- },
- "include_governing_country_uk_val": {
- "type": "string"
- },
- "include_governing_law": {
- "type": "boolean"
- },
- "include_governing_law_country": {
- "type": "string"
- },
- "include_governing_law_state": {
- "type": "string"
- },
- "include_increased_claim_amount": {
- "description": "Legacy field. Stored but not shown on the DPA; use the `include_liability_cap*` fields instead.",
- "type": "boolean"
- },
- "include_increased_claim_amount_currency": {
- "description": "Legacy field. Stored but not shown on the DPA; use the `include_liability_cap*` fields instead."
- },
- "include_increased_claim_amount_qty": {
- "description": "Legacy field. Stored but not shown on the DPA; use the `include_liability_cap*` fields instead."
- },
- "include_increased_claim_amount_type": {
- "description": "Legacy field. Stored but not shown on the DPA; use the `include_liability_cap*` fields instead.",
- "type": "string"
- },
- "include_liability_cap": {
- "type": "boolean"
- },
- "include_liability_cap_amount_constant_external": {
- "type": "string"
- },
- "include_liability_cap_amount_constant_internal": {
- "type": "string"
- },
- "include_liability_cap_amount_currency_external": {
- "description": "Currency amount. Numbers and numeric strings (commas allowed) are both accepted."
- },
- "include_liability_cap_amount_currency_internal": {
- "description": "Currency amount. Numbers and numeric strings (commas allowed) are both accepted."
- },
- "include_liability_cap_csa_type": {
- "description": "Which liability cap values apply: the `_internal` or `_external` amount fields. Required when `include_liability_cap` is true.",
- "enum": [
- "internal",
- "external"
- ],
- "type": "string"
- },
- "include_personal_data_biographic_info": {
- "type": "boolean"
- },
- "include_personal_data_contact_info": {
- "type": "boolean"
- },
- "include_personal_data_custom": {
- "type": "boolean"
- },
- "include_personal_data_custom_val": {
- "type": "string"
- },
- "include_personal_data_employment_info": {
- "type": "boolean"
- },
- "include_personal_data_financial_info": {
- "type": "boolean"
- },
- "include_personal_data_location": {
- "type": "boolean"
- },
- "include_personal_data_name": {
- "type": "boolean"
- },
- "include_personal_data_transactional_info": {
- "type": "boolean"
- },
- "include_personal_data_user_activity_info": {
- "type": "boolean"
- },
- "include_processing_purpose_custom": {
- "type": "boolean"
- },
- "include_processing_purpose_custom_val": {
- "type": "string"
- },
- "include_processing_purpose_erasing": {
- "type": "boolean"
- },
- "include_processing_purpose_holding": {
- "type": "boolean"
- },
- "include_processing_purpose_protecting": {
- "type": "boolean"
- },
- "include_processing_purpose_receiving": {
- "type": "boolean"
- },
- "include_processing_purpose_returning": {
- "type": "boolean"
- },
- "include_processing_purpose_sharing": {
- "type": "boolean"
- },
- "include_processing_purpose_updating": {
- "type": "boolean"
- },
- "include_processing_purpose_using": {
- "type": "boolean"
- },
- "include_provider_security_contact_address": {
- "type": "boolean"
- },
- "include_provider_security_contact_address_city": {
- "type": "string"
- },
- "include_provider_security_contact_address_country": {
- "type": "string"
- },
- "include_provider_security_contact_address_state": {
- "type": "string"
- },
- "include_provider_security_contact_address_street_address": {
- "type": "string"
- },
- "include_provider_security_contact_address_zipcode": {
- "type": "string"
- },
- "include_provider_security_contact_email": {
- "type": "boolean"
- },
- "include_provider_security_contact_email_val": {
- "format": "email",
- "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
- "type": "string"
- },
- "include_security_measures_accountability": {
- "type": "boolean"
- },
- "include_security_measures_accountability_val": {
- "type": "string"
- },
- "include_security_measures_certification_or_assurance": {
- "type": "boolean"
- },
- "include_security_measures_certification_or_assurance_val": {
- "type": "string"
- },
- "include_security_measures_confidentiality_integrity": {
- "type": "boolean"
- },
- "include_security_measures_confidentiality_integrity_val": {
- "type": "string"
- },
- "include_security_measures_data_at_rest": {
- "type": "boolean"
- },
- "include_security_measures_data_at_rest_val": {
- "type": "string"
- },
- "include_security_measures_data_minimization": {
- "type": "boolean"
- },
- "include_security_measures_data_minimization_val": {
- "type": "string"
- },
- "include_security_measures_data_quality": {
- "type": "boolean"
- },
- "include_security_measures_data_quality_val": {
- "type": "string"
- },
- "include_security_measures_data_retention": {
- "type": "boolean"
- },
- "include_security_measures_data_retention_val": {
- "type": "string"
- },
- "include_security_measures_data_transmission": {
- "type": "boolean"
- },
- "include_security_measures_data_transmission_val": {
- "type": "string"
- },
- "include_security_measures_event_logging": {
- "type": "boolean"
- },
- "include_security_measures_event_logging_val": {
- "type": "string"
- },
- "include_security_measures_identity_auth": {
- "type": "boolean"
- },
- "include_security_measures_identity_auth_val": {
- "type": "string"
- },
- "include_security_measures_it_security_governance": {
- "type": "boolean"
- },
- "include_security_measures_it_security_governance_val": {
- "type": "string"
- },
- "include_security_measures_physical_security": {
- "type": "boolean"
- },
- "include_security_measures_physical_security_val": {
- "type": "string"
- },
- "include_security_measures_portability_and_erasure": {
- "type": "boolean"
- },
- "include_security_measures_portability_and_erasure_val": {
- "type": "string"
- },
- "include_security_measures_pseudonym_encryption": {
- "type": "boolean"
- },
- "include_security_measures_pseudonym_encryption_val": {
- "type": "string"
- },
- "include_security_measures_restore_data_access": {
- "type": "boolean"
- },
- "include_security_measures_restore_data_access_val": {
- "type": "string"
- },
- "include_security_measures_security_policy": {
- "type": "boolean"
- },
- "include_security_measures_system_configuration": {
- "type": "boolean"
- },
- "include_security_measures_system_configuration_val": {
- "type": "string"
- },
- "include_security_measures_testing_assessment": {
- "type": "boolean"
- },
- "include_security_measures_testing_assessment_val": {
- "type": "string"
- },
- "include_security_policy": {
- "type": "boolean"
- },
- "include_security_policy_fedramp_auth": {
- "type": "boolean"
- },
- "include_security_policy_hipaa": {
- "type": "boolean"
- },
- "include_security_policy_hitrust": {
- "type": "boolean"
- },
- "include_security_policy_include_other": {
- "type": "boolean"
- },
- "include_security_policy_iso27001": {
- "type": "boolean"
- },
- "include_security_policy_other": {
- "type": "string"
- },
- "include_security_policy_pci1": {
- "type": "boolean"
- },
- "include_security_policy_pci2": {
- "type": "boolean"
- },
- "include_security_policy_penetration_testing": {
- "type": "boolean"
- },
- "include_security_policy_soc2": {
- "type": "boolean"
- },
- "include_security_policy_soc2_type2": {
- "type": "boolean"
- },
- "include_sensitive_data_restrictions_custom": {
- "type": "boolean"
- },
- "include_sensitive_data_restrictions_custom_val": {
- "type": "string"
- },
- "include_sensitive_data_restrictions_security_policy": {
- "type": "boolean"
- },
- "include_service_provider_relationship": {
- "type": "boolean"
- },
- "include_special_category_data": {
- "type": "boolean"
- },
- "provider": {
- "type": "string"
- },
- "security_policy_available_at": {
- "type": "string"
- },
- "security_policy_type": {
- "description": "Where the Security Policy is defined. For `external`, set `security_policy_available_at`.",
- "enum": [
- "defined in agreement",
- "provider service",
- "external"
- ],
- "type": "string"
- },
- "subprocessors_attributes": {
- "additionalProperties": {
- "additionalProperties": false,
- "properties": {
- "_destroy": {
- "description": "Set to true with `id` to remove that subprocessor.",
- "type": "boolean"
- },
- "country": {
- "type": "string"
- },
- "id": {
- "description": "ID of an existing subprocessor to update or remove. Omit to add a new subprocessor.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "name": {
- "type": "string"
- },
- "processing_task": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "description": "Subprocessors, keyed by string index such as \"0\", \"1\". On create these are added to the template's subprocessors. On a draft update, an entry without `id` adds a new subprocessor; pass `id` to change one and `id` with `_destroy: true` to remove one.",
- "propertyNames": {
- "type": "string"
- },
- "type": "object"
- },
- "underlying_agreement_id": {
- "description": "ID of the CSA this DPA supplements when `underlying_agreement_type` is `internal`.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "underlying_agreement_type": {
- "description": "`internal` links a CSA in Common Paper (`underlying_agreement_id`); `external` describes another agreement in `underlying_agreement_val` (required). Omit for none.",
- "enum": [
- "internal",
- "external"
- ],
- "type": "string"
- },
- "underlying_agreement_val": {
- "description": "Description of the agreement this DPA supplements. Required when `underlying_agreement_type` is `external`.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "framework_terms_description": {
- "description": "Custom framework terms description. Only used when framework_terms_type is \"description\".",
- "type": "string"
- },
- "framework_terms_type": {
- "description": "How framework terms are specified. Use \"new\" for standard terms or \"description\" to provide a custom framework_terms_description.",
- "enum": [
- "new",
- "description"
- ],
- "type": "string"
- },
- "governing_law_country": {
- "description": "The country whose laws govern the agreement.",
- "type": "string"
- },
- "governing_law_region": {
- "description": "The state or region whose laws govern the agreement.",
- "type": "string"
- },
- "include_automated_payment_reminders": {
- "description": "When true, automatically sends payment reminder emails.",
- "type": "boolean"
- },
- "include_billing_info": {
- "description": "When true, billing contact information (billing_name, billing_email) is included.",
- "type": "boolean"
- },
- "include_billing_workflow": {
- "description": "When true, enables a billing workflow after signing.",
- "type": "boolean"
- },
- "include_expiration_date": {
- "description": "Expiration date in YYYY-MM-DD format. Use when include_expiration_type is \"date\".",
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "include_expiration_days": {
- "description": "Number of days until the agreement expires. Use when include_expiration_type is \"days\".",
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_expiration_type": {
- "description": "How to set expiration: \"none\" (default), \"days\" (use include_expiration_days), or \"date\" (use include_expiration_date).",
- "enum": [
- "none",
- "days",
- "date"
- ],
- "type": "string"
- },
- "include_terms": {
- "description": "When true, the standard terms are included with the agreement.",
- "type": "boolean"
- },
- "loi_attributes": {
- "additionalProperties": false,
- "description": "Override loi terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "confidentiality_custom": {
- "type": "string"
- },
- "confidentiality_mutual_include_loi": {
- "type": "boolean"
- },
- "confidentiality_nda_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "confidentiality_nda_description": {
- "type": "string"
- },
- "confidentiality_nda_include_loi": {
- "type": "boolean"
- },
- "confidentiality_nda_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "confidentiality_type": {
- "enum": [
- "mutual",
- "nda",
- "provider",
- "custom"
- ],
- "type": "string"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_custom_details": {
- "type": "boolean"
- },
- "include_custom_details_val": {
- "type": "string"
- },
- "include_fees": {
- "type": "boolean"
- },
- "include_fees_amount": {
- "type": "number"
- },
- "include_fees_amount_duration": {
- "enum": [
- "month",
- "year",
- "quarter"
- ],
- "type": "string"
- },
- "include_fees_include_amount": {
- "type": "boolean"
- },
- "include_fees_include_other": {
- "type": "boolean"
- },
- "include_fees_other": {
- "type": "string"
- },
- "include_functionality": {
- "type": "boolean"
- },
- "include_functionality_val": {
- "type": "string"
- },
- "include_launch_date": {
- "type": "boolean"
- },
- "include_launch_date_custom": {
- "type": "string"
- },
- "include_launch_date_date": {
- "format": "date-time",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$",
- "type": "string"
- },
- "include_launch_date_type": {
- "enum": [
- "date",
- "custom"
- ],
- "type": "string"
- },
- "product_name": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "manual_send": {
- "description": "When true, the agreement is marked as manually sent outside the platform.",
- "type": "boolean"
- },
- "message": {
- "type": "string"
- },
- "negotiations_allowed": {
- "description": "When true, the recipient can propose changes to the legal terms. For agreement types without separate business terms, that covers every term. CSA order forms, PSA statements of work, partnership business terms and software license order forms have their own `negotiations_allowed` flag.",
- "type": "boolean"
- },
- "partnership_attributes": {
- "additionalProperties": false,
- "description": "Override partnership terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "effective_date": {
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "effective_date_type": {
- "enum": [
- "signature",
- "date"
- ],
- "type": "string"
- },
- "general_cap_amount_currency_val": {
- "type": "number"
- },
- "general_cap_amount_either_currency": {
- "type": "number"
- },
- "general_cap_amount_either_multiple": {
- "type": "number"
- },
- "general_cap_amount_multiple_val": {
- "type": "number"
- },
- "general_cap_amount_type": {
- "enum": [
- "multiple",
- "currency",
- "either",
- "base"
- ],
- "type": "string"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_additional_warranties": {
- "type": "boolean"
- },
- "include_additional_warranties_include_company": {
- "type": "boolean"
- },
- "include_additional_warranties_include_company_val": {
- "type": "string"
- },
- "include_additional_warranties_include_partner": {
- "type": "boolean"
- },
- "include_additional_warranties_include_partner_val": {
- "type": "string"
- },
- "include_brand_guidelines": {
- "type": "boolean"
- },
- "include_brand_guidelines_include_company": {
- "type": "boolean"
- },
- "include_brand_guidelines_include_company_val": {
- "type": "string"
- },
- "include_brand_guidelines_include_partner": {
- "type": "boolean"
- },
- "include_brand_guidelines_include_partner_val": {
- "type": "string"
- },
- "include_covered_claims": {
- "type": "boolean"
- },
- "include_covered_claims_company_claims": {
- "type": "string"
- },
- "include_covered_claims_include_company_claims": {
- "type": "boolean"
- },
- "include_covered_claims_include_partner_claims": {
- "type": "boolean"
- },
- "include_covered_claims_partner_claims": {
- "type": "string"
- },
- "include_dpa": {
- "type": "boolean"
- },
- "include_dpa_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_dpa_location": {
- "type": "string"
- },
- "include_dpa_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_increased_cap_amount": {
- "type": "boolean"
- },
- "include_increased_cap_amount_currency": {
- "type": "number"
- },
- "include_increased_cap_amount_either_currency": {
- "type": "number"
- },
- "include_increased_cap_amount_either_multiple": {
- "type": "string"
- },
- "include_increased_cap_amount_multiple": {
- "type": "string"
- },
- "include_increased_cap_amount_type": {
- "enum": [
- "multiple",
- "currency",
- "either"
- ],
- "type": "string"
- },
- "include_increased_claims": {
- "type": "boolean"
- },
- "include_increased_claims_include_confidentiality": {
- "type": "boolean"
- },
- "include_increased_claims_include_confidentiality_misconduct": {
- "type": "boolean"
- },
- "include_increased_claims_include_covered_claims": {
- "type": "boolean"
- },
- "include_increased_claims_include_misconduct": {
- "type": "boolean"
- },
- "include_increased_claims_include_other": {
- "type": "boolean"
- },
- "include_increased_claims_include_other_val": {
- "type": "string"
- },
- "include_unlimited_claims": {
- "type": "boolean"
- },
- "include_unlimited_claims_confidentiality": {
- "type": "boolean"
- },
- "include_unlimited_claims_confidentiality_misconduct": {
- "type": "boolean"
- },
- "include_unlimited_claims_covered_claims": {
- "type": "boolean"
- },
- "include_unlimited_claims_misconduct": {
- "type": "boolean"
- },
- "include_unlimited_claims_other": {
- "type": "boolean"
- },
- "include_unlimited_claims_other_val": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "partnership_business_terms_attributes": {
- "additionalProperties": false,
- "description": "Override partnership business terms terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "end_date_after_effective_date_amount": {
- "type": "number"
- },
- "end_date_after_effective_date_unit": {
- "enum": [
- "month(s)",
- "quarter(s)",
- "year(s)"
- ],
- "type": "string"
- },
- "end_date_date": {
- "type": "string"
- },
- "end_date_type": {
- "enum": [
- "date",
- "effective date"
- ],
- "type": "string"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_obligations_company_brand": {
- "type": "boolean"
- },
- "include_obligations_company_promotion": {
- "type": "boolean"
- },
- "include_obligations_company_promotion_include_activities": {
- "type": "boolean"
- },
- "include_obligations_company_promotion_include_activities_val": {
- "type": "string"
- },
- "include_obligations_company_promotion_include_materials": {
- "type": "boolean"
- },
- "include_obligations_company_promotion_include_materials_val": {
- "type": "string"
- },
- "include_obligations_company_referral": {
- "type": "boolean"
- },
- "include_obligations_company_referral_include_criteria": {
- "type": "boolean"
- },
- "include_obligations_company_referral_include_criteria_val": {
- "type": "string"
- },
- "include_obligations_company_referral_include_pay_sch": {
- "type": "boolean"
- },
- "include_obligations_company_referral_include_pay_sch_amount": {
- "type": "number"
- },
- "include_obligations_company_referral_include_pay_sch_custom": {
- "type": "string"
- },
- "include_obligations_company_referral_include_pay_sch_unit": {
- "enum": [
- "U.S. Dollars",
- "percent"
- ],
- "type": "string"
- },
- "include_obligations_company_sponsorship": {
- "type": "boolean"
- },
- "include_obligations_company_sponsorship_include_benefits": {
- "type": "boolean"
- },
- "include_obligations_company_sponsorship_include_benefits_val": {
- "type": "string"
- },
- "include_obligations_company_sponsorship_include_payments": {
- "type": "boolean"
- },
- "include_obligations_company_sponsorship_include_payments_amount": {
- "type": "number"
- },
- "include_obligations_company_sponsorship_include_payments_unit": {
- "enum": [
- "U.S. Dollars",
- "percent"
- ],
- "type": "string"
- },
- "include_obligations_partner_brand": {
- "type": "boolean"
- },
- "include_obligations_partner_promotion": {
- "type": "boolean"
- },
- "include_obligations_partner_promotion_include_activities": {
- "type": "boolean"
- },
- "include_obligations_partner_promotion_include_activities_val": {
- "type": "string"
- },
- "include_obligations_partner_promotion_include_materials": {
- "type": "boolean"
- },
- "include_obligations_partner_promotion_include_materials_val": {
- "type": "string"
- },
- "include_obligations_partner_referral": {
- "type": "boolean"
- },
- "include_obligations_partner_referral_include_criteria": {
- "type": "boolean"
- },
- "include_obligations_partner_referral_include_criteria_val": {
- "type": "string"
- },
- "include_obligations_partner_referral_include_pay_sch": {
- "type": "boolean"
- },
- "include_obligations_partner_referral_include_pay_sch_amount": {
- "type": "number"
- },
- "include_obligations_partner_referral_include_pay_sch_custom": {
- "type": "string"
- },
- "include_obligations_partner_referral_include_pay_sch_unit": {
- "enum": [
- "U.S. Dollars",
- "percent"
- ],
- "type": "string"
- },
- "include_obligations_partner_sponsorship": {
- "type": "boolean"
- },
- "include_obligations_partner_sponsorship_include_benefits": {
- "type": "boolean"
- },
- "include_obligations_partner_sponsorship_include_benefits_val": {
- "type": "string"
- },
- "include_obligations_partner_sponsorship_include_payments": {
- "type": "boolean"
- },
- "include_obligations_partner_sponsorship_include_payments_amount": {
- "type": "number"
- },
- "include_obligations_partner_sponsorship_include_payments_unit": {
- "enum": [
- "U.S. Dollars",
- "percent"
- ],
- "type": "string"
- },
- "include_payment_process": {
- "type": "boolean"
- },
- "include_payment_process_company": {
- "type": "boolean"
- },
- "include_payment_process_company_include_address": {
- "type": "boolean"
- },
- "include_payment_process_company_include_address_city": {
- "type": "string"
- },
- "include_payment_process_company_include_address_country": {
- "type": "string"
- },
- "include_payment_process_company_include_address_state": {
- "type": "string"
- },
- "include_payment_process_company_include_address_street_address": {
- "type": "string"
- },
- "include_payment_process_company_include_address_zipcode": {
- "type": "string"
- },
- "include_payment_process_company_include_email": {
- "type": "boolean"
- },
- "include_payment_process_company_include_email_val": {
- "type": "string"
- },
- "include_payment_process_partner": {
- "type": "boolean"
- },
- "include_payment_process_partner_include_address": {
- "type": "boolean"
- },
- "include_payment_process_partner_include_address_city": {
- "type": "string"
- },
- "include_payment_process_partner_include_address_country": {
- "type": "string"
- },
- "include_payment_process_partner_include_address_state": {
- "type": "string"
- },
- "include_payment_process_partner_include_address_street_address": {
- "type": "string"
- },
- "include_payment_process_partner_include_address_zipcode": {
- "type": "string"
- },
- "include_payment_process_partner_include_email": {
- "type": "boolean"
- },
- "include_payment_process_partner_include_email_val": {
- "type": "string"
- },
- "include_payment_schedule": {
- "type": "boolean"
- },
- "include_payment_schedule_custom": {
- "type": "string"
- },
- "include_payment_schedule_specified_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_payment_schedule_specified_timeframe": {
- "enum": [
- "receipt",
- "date"
- ],
- "type": "string"
- },
- "include_payment_schedule_specified_unit": {
- "enum": [
- "day(s)",
- "week(s)",
- "month(s)",
- "quarter(s)",
- "year(s)"
- ],
- "type": "string"
- },
- "include_payment_schedule_type": {
- "enum": [
- "specified",
- "custom"
- ],
- "type": "string"
- },
- "negotiations_allowed": {
- "description": "When true, the recipient can propose changes to the business terms, even when the agreement-level `negotiations_allowed` is false. This only covers the business terms.",
- "type": "boolean"
- },
- "territory_type": {
- "enum": [
- "worldwide",
- "custom"
- ],
- "type": "string"
- },
- "territory_type_val": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "payment_link_url": {
- "description": "A payment URL shown to the recipient after signing. Requires include_billing_workflow to be true and billing_workflow_type to be \"link\".",
- "type": "string"
- },
- "pilot_attributes": {
- "additionalProperties": false,
- "description": "Override pilot terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "fees_type": {
- "enum": [
- "free",
- "pilot_period_fees"
- ],
- "type": "string"
- },
- "general_cap_amount": {
- "type": "number"
- },
- "general_cap_amount_type": {
- "enum": [
- "preceding",
- "base",
- "period"
- ],
- "type": "string"
- },
- "general_cap_period_currency": {
- "type": "number"
- },
- "general_cap_period_qty": {
- "type": "number"
- },
- "general_cap_preceding_amount": {
- "type": "number"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_dpa": {
- "type": "boolean"
- },
- "include_dpa_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_dpa_location": {
- "type": "string"
- },
- "include_dpa_type": {
- "enum": [
- "description",
- "attachment",
- "standard"
- ],
- "type": "string"
- },
- "include_payment_process": {
- "type": "boolean"
- },
- "include_technical_support": {
- "type": "boolean"
- },
- "payment_process_automatic_frequency": {
- "enum": [
- "monthly",
- "quarterly",
- "annually",
- "once_per_period"
- ],
- "type": "string"
- },
- "payment_process_invoice_days": {
- "type": "number"
- },
- "payment_process_invoice_from": {
- "enum": [
- "receipt",
- "date"
- ],
- "type": "string"
- },
- "payment_process_invoice_timeframe": {
- "enum": [
- "days",
- "weeks",
- "months",
- "quarters",
- "years"
- ],
- "type": "string"
- },
- "payment_process_type": {
- "enum": [
- "automatic",
- "invoice"
- ],
- "type": "string"
- },
- "pilot_period_description": {
- "type": "string"
- },
- "pilot_period_fees_description": {
- "type": "string"
- },
- "product_description": {
- "type": "string"
- },
- "technical_support_description": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "psa_attributes": {
- "additionalProperties": false,
- "description": "Override psa terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "additional_changes": {
- "type": "string"
- },
- "customer_description": {
- "type": "string"
- },
- "effective_date": {
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "effective_date_type": {
- "enum": [
- "signature",
- "date"
- ],
- "type": "string"
- },
- "general_cap_amount": {
- "type": "number"
- },
- "general_cap_amount_type": {
- "enum": [
- "preceding",
- "base",
- "period"
- ],
- "type": "string"
- },
- "general_cap_period_currency": {
- "type": "number"
- },
- "general_cap_period_qty": {
- "type": "number"
- },
- "general_cap_preceding_amount": {
- "type": "number"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_additional_changes": {
- "type": "boolean"
- },
- "include_additional_warranties": {
- "type": "boolean"
- },
- "include_additional_warranties_by_customer": {
- "type": "string"
- },
- "include_additional_warranties_by_provider": {
- "type": "string"
- },
- "include_additional_warranties_include_by_customer": {
- "type": "boolean"
- },
- "include_additional_warranties_include_by_provider": {
- "type": "boolean"
- },
- "include_covered_claims": {
- "type": "boolean"
- },
- "include_covered_claims_customer_claims": {
- "type": "string"
- },
- "include_covered_claims_include_customer_claims": {
- "type": "boolean"
- },
- "include_covered_claims_include_provider_claims": {
- "type": "boolean"
- },
- "include_covered_claims_provider_claims": {
- "type": "string"
- },
- "include_customer_insurance_min": {
- "type": "boolean"
- },
- "include_customer_insurance_min_add_provider_com_gen_liability": {
- "type": "boolean"
- },
- "include_customer_insurance_min_add_provider_cyber_liability": {
- "type": "boolean"
- },
- "include_customer_insurance_min_add_provider_errors_omissions": {
- "type": "boolean"
- },
- "include_customer_insurance_min_auto_liability_aggregate": {
- "type": "number"
- },
- "include_customer_insurance_min_auto_liability_minimum": {
- "type": "number"
- },
- "include_customer_insurance_min_cyber_liability_aggregate": {
- "type": "number"
- },
- "include_customer_insurance_min_cyber_liability_minimum": {
- "type": "number"
- },
- "include_customer_insurance_min_employer_liability_aggregate": {
- "type": "number"
- },
- "include_customer_insurance_min_employer_liability_minimum": {
- "type": "number"
- },
- "include_customer_insurance_min_general_liability_aggregate": {
- "type": "number"
- },
- "include_customer_insurance_min_general_liability_minimum": {
- "type": "number"
- },
- "include_customer_insurance_min_include_add_provider": {
- "type": "boolean"
- },
- "include_customer_insurance_min_include_auto_liability": {
- "type": "boolean"
- },
- "include_customer_insurance_min_include_cyber_liability": {
- "type": "boolean"
- },
- "include_customer_insurance_min_include_employer_liability": {
- "type": "boolean"
- },
- "include_customer_insurance_min_include_general_liability": {
- "type": "boolean"
- },
- "include_customer_insurance_min_include_workers_comp": {
- "type": "boolean"
- },
- "include_customer_policies": {
- "type": "boolean"
- },
- "include_customer_policies_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_customer_policies_location": {
- "type": "string"
- },
- "include_customer_policies_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_dpa": {
- "type": "boolean"
- },
- "include_dpa_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_dpa_location": {
- "type": "string"
- },
- "include_dpa_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_increased_cap_amount": {
- "type": "boolean"
- },
- "include_increased_claims": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_confidentiality": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_confidentiality_negligence": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_privsec": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_privsec_negligence": {
- "type": "boolean"
- },
- "include_increased_claims_include_other": {
- "type": "boolean"
- },
- "include_increased_claims_indemnification_obligation": {
- "type": "boolean"
- },
- "include_increased_claims_negligence": {
- "type": "boolean"
- },
- "include_increased_claims_other": {
- "type": "string"
- },
- "include_provider_insurance_min": {
- "type": "boolean"
- },
- "include_provider_insurance_min_add_customer_com_gen_liability": {
- "type": "boolean"
- },
- "include_provider_insurance_min_add_customer_cyber_liability": {
- "type": "boolean"
- },
- "include_provider_insurance_min_add_customer_errors_omissions": {
- "type": "boolean"
- },
- "include_provider_insurance_min_auto_liability_aggregate": {
- "type": "number"
- },
- "include_provider_insurance_min_auto_liability_minimum": {
- "type": "number"
- },
- "include_provider_insurance_min_cyber_liability_aggregate": {
- "type": "number"
- },
- "include_provider_insurance_min_cyber_liability_minimum": {
- "type": "number"
- },
- "include_provider_insurance_min_employer_liability_aggregate": {
- "type": "number"
- },
- "include_provider_insurance_min_employer_liability_minimum": {
- "type": "number"
- },
- "include_provider_insurance_min_general_liability_aggregate": {
- "type": "number"
- },
- "include_provider_insurance_min_general_liability_minimum": {
- "type": "number"
- },
- "include_provider_insurance_min_include_add_customer": {
- "type": "boolean"
- },
- "include_provider_insurance_min_include_auto_liability": {
- "type": "boolean"
- },
- "include_provider_insurance_min_include_cyber_liability": {
- "type": "boolean"
- },
- "include_provider_insurance_min_include_employer_liability": {
- "type": "boolean"
- },
- "include_provider_insurance_min_include_general_liability": {
- "type": "boolean"
- },
- "include_provider_insurance_min_include_workers_comp": {
- "type": "boolean"
- },
- "include_publicity_rights": {
- "type": "boolean"
- },
- "include_publicity_rights_type": {
- "enum": [
- "public",
- "non-public"
- ],
- "type": "string"
- },
- "include_security_policy": {
- "type": "boolean"
- },
- "include_security_policy_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_security_policy_fedramp_auth": {
- "type": "boolean"
- },
- "include_security_policy_hitrust": {
- "type": "boolean"
- },
- "include_security_policy_include_annual_maintenance": {
- "type": "boolean"
- },
- "include_security_policy_include_other": {
- "type": "boolean"
- },
- "include_security_policy_include_other_val": {
- "type": "string"
- },
- "include_security_policy_iso27001": {
- "type": "boolean"
- },
- "include_security_policy_location": {
- "type": "string"
- },
- "include_security_policy_pci1": {
- "type": "boolean"
- },
- "include_security_policy_pci2": {
- "type": "boolean"
- },
- "include_security_policy_penetration_testing": {
- "type": "boolean"
- },
- "include_security_policy_soc2_type1": {
- "type": "boolean"
- },
- "include_security_policy_soc2_type2": {
- "type": "boolean"
- },
- "include_security_policy_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_unlimited_claims": {
- "type": "boolean"
- },
- "include_unlimited_claims_breach_of_confidentiality": {
- "type": "boolean"
- },
- "include_unlimited_claims_breach_of_confidentiality_negligence": {
- "type": "boolean"
- },
- "include_unlimited_claims_breach_of_privsec": {
- "type": "boolean"
- },
- "include_unlimited_claims_breach_of_privsec_negligence": {
- "type": "boolean"
- },
- "include_unlimited_claims_include_other": {
- "type": "boolean"
- },
- "include_unlimited_claims_indemnification_obligation": {
- "type": "boolean"
- },
- "include_unlimited_claims_negligence": {
- "type": "boolean"
- },
- "include_unlimited_claims_other": {
- "type": "string"
- },
- "increased_cap_amount_currency": {
- "type": "number"
- },
- "increased_cap_amount_period_currency": {
- "type": "number"
- },
- "increased_cap_amount_period_qty": {
- "type": "number"
- },
- "increased_cap_amount_qty": {
- "type": "number"
- },
- "increased_cap_amount_type": {
- "enum": [
- "qty",
- "currency",
- "period"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- "psa_statement_of_work_attributes": {
- "additionalProperties": false,
- "description": "Override psa statement of work terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "additional_changes": {
- "type": "string"
- },
- "cost": {
- "type": "number"
- },
- "description": {
- "type": "string"
- },
- "fee_type": {
- "type": "string"
- },
- "fees_attributes": {
- "additionalProperties": {
- "anyOf": [
- {
- "additionalProperties": false,
- "description": "Fees::Flat (fee_type \"flat\"). A fixed recurring fee, e.g. a platform subscription. Set type to \"Fees::Flat\" or fee_type to \"flat\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "Fixed amount in the order form's fees_currency, charged per fee_period. A plain amount, not cents: 20 means 20.00.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"flat\". Alternative to type.",
- "enum": [
- "flat"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Flat\". Optional when fee_type is set.",
- "enum": [
- "Fees::Flat"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Discount (fee_type \"discount\"). A discount, as a fixed amount or a percentage, applied forever, once, or for a number of months. Set type to \"Fees::Discount\" or fee_type to \"discount\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "Discount size: an amount in fees_currency when discount_type is fixed_amount (a plain amount, not cents: 20 means 20.00), or a percentage (e.g. 10 for 10%) when it is percentage.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "discount_duration_amount": {
- "description": "Number of months the discount applies. Required when discount_duration_type is multiple_months.",
- "type": "number"
- },
- "discount_duration_type": {
- "description": "How long the discount applies. multiple_months also needs discount_duration_amount.",
- "enum": [
- "forever",
- "once",
- "multiple_months"
- ],
- "type": "string"
- },
- "discount_type": {
- "description": "Whether cost is a currency amount or a percentage.",
- "enum": [
- "fixed_amount",
- "percentage"
- ],
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"discount\". Alternative to type.",
- "enum": [
- "discount"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Discount\". Optional when fee_type is set.",
- "enum": [
- "Fees::Discount"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Cost (fee_type \"cost\"). A per-unit fee: price per unit times quantity, e.g. seats. Set type to \"Fees::Cost\" or fee_type to \"cost\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "Price per unit in fees_currency. The row total is quantity x cost. A plain amount, not cents: 20 means 20.00.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"cost\". Alternative to type.",
- "enum": [
- "cost"
- ],
- "type": "string"
- },
- "quantity": {
- "description": "Number of units.",
- "type": "number"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Cost\". Optional when fee_type is set.",
- "enum": [
- "Fees::Cost"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Attachment (fee_type \"attachment\"). A fee described in an uploaded attachment instead of in the table. Set type to \"Fees::Attachment\" or fee_type to \"attachment\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "attachment_id": {
- "description": "ID of an attachment uploaded with upload-attachment.",
- "type": "string"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"attachment\". Alternative to type.",
- "enum": [
- "attachment"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Attachment\". Optional when fee_type is set.",
- "enum": [
- "Fees::Attachment"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Graduated (fee_type \"graduated\"). Tiered pricing, with the price set per tier in graduated_fee_tiers_attributes. Set type to \"Fees::Graduated\" or fee_type to \"graduated\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"graduated\". Alternative to type.",
- "enum": [
- "graduated"
- ],
- "type": "string"
- },
- "graduated_fee_tiers_attributes": {
- "additionalProperties": {
- "additionalProperties": false,
- "properties": {
- "flat_price": {
- "type": "number"
- },
- "price_per_unit": {
- "type": "string"
- },
- "upper_limit": {
- "type": "number"
- }
- },
- "type": "object"
- },
- "description": "Graduated fee tiers. Use string keys such as \"0\", \"1\".",
- "propertyNames": {
- "type": "string"
- },
- "type": "object"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Graduated\". Optional when fee_type is set.",
- "enum": [
- "Fees::Graduated"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Included (fee_type \"included\"). An item included at no charge. Set type to \"Fees::Included\" or fee_type to \"included\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"included\". Alternative to type.",
- "enum": [
- "included"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Included\". Optional when fee_type is set.",
- "enum": [
- "Fees::Included"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Metered (fee_type \"metered\"). Usage-based pricing, billed per unit used. Set type to \"Fees::Metered\" or fee_type to \"metered\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "Price per unit of usage in fees_currency. A plain amount, not cents: 20 means 20.00.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"metered\". Alternative to type.",
- "enum": [
- "metered"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Metered\". Optional when fee_type is set.",
- "enum": [
- "Fees::Metered"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::OneTime (fee_type \"one_time\"). A one-time charge, such as a setup fee. Set type to \"Fees::OneTime\" or fee_type to \"one_time\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "One-time amount in fees_currency, charged once rather than per fee_period. A plain amount, not cents: 20 means 20.00.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"one_time\". Alternative to type.",
- "enum": [
- "one_time"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::OneTime\". Optional when fee_type is set.",
- "enum": [
- "Fees::OneTime"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Text (fee_type \"text\"). A fee term described in free text. Set type to \"Fees::Text\" or fee_type to \"text\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"text\". Alternative to type.",
- "enum": [
- "text"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Text\". Optional when fee_type is set.",
- "enum": [
- "Fees::Text"
- ],
- "type": "string"
- }
- },
- "type": "object"
- }
- ]
- },
- "description": "Fee line items. Use string keys such as \"0\", \"1\". Replaces template fees when provided.",
- "propertyNames": {
- "type": "string"
- },
- "type": "object"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_additional_changes": {
- "type": "boolean"
- },
- "include_customer_obligation": {
- "type": "boolean"
- },
- "include_customer_obligation_val": {
- "type": "string"
- },
- "include_deliverables": {
- "type": "boolean"
- },
- "include_deliverables_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_deliverables_description": {
- "type": "string"
- },
- "include_deliverables_include_acceptance": {
- "type": "boolean"
- },
- "include_deliverables_include_attachment": {
- "type": "boolean"
- },
- "include_deliverables_include_draft_deliverables": {
- "type": "boolean"
- },
- "include_deliverables_rejection_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_deliverables_rejection_unit": {
- "enum": [
- "hours",
- "days",
- "weeks",
- "months"
- ],
- "type": "string"
- },
- "include_deliverables_resubmission_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_deliverables_resubmission_unit": {
- "enum": [
- "hours",
- "days",
- "weeks",
- "months"
- ],
- "type": "string"
- },
- "include_fees_other": {
- "type": "boolean"
- },
- "include_fees_other_val": {
- "type": "string"
- },
- "include_fees_table": {
- "type": "boolean"
- },
- "include_fees_table_total": {
- "type": "boolean"
- },
- "include_fees_travel": {
- "type": "boolean"
- },
- "include_fees_travel_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_fees_travel_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_fees_travel_val": {
- "type": "string"
- },
- "include_third_party_customer": {
- "type": "boolean"
- },
- "include_third_party_include_description": {
- "type": "boolean"
- },
- "include_third_party_include_description_val": {
- "type": "string"
- },
- "include_third_party_materials": {
- "type": "boolean"
- },
- "include_third_party_provider": {
- "type": "boolean"
- },
- "include_time_of_assignment": {
- "type": "boolean"
- },
- "include_time_of_assignment_type": {
- "enum": [
- "created",
- "paid"
- ],
- "type": "string"
- },
- "invoice_period_description": {
- "type": "string"
- },
- "negotiations_allowed": {
- "description": "When true, the recipient can propose changes to the statement of work, even when the agreement-level `negotiations_allowed` is false. This only covers the statement of work.",
- "type": "boolean"
- },
- "payment_period": {
- "type": "number"
- },
- "payment_period_other": {
- "type": "string"
- },
- "payment_period_timeframe": {
- "enum": [
- "receipt",
- "invoice",
- "Customer's receipt of invoice",
- "date of invoice"
- ],
- "type": "string"
- },
- "payment_period_type": {
- "enum": [
- "standard",
- "other"
- ],
- "type": "string"
- },
- "payment_period_unit": {
- "enum": [
- "day(s)",
- "week(s)",
- "month(s)",
- "quarter(s)",
- "year(s)"
- ],
- "type": "string"
- },
- "quantity": {
- "type": "number"
- },
- "services_description": {
- "type": "string"
- },
- "sow_date": {
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "sow_date_type": {
- "enum": [
- "signature",
- "date"
- ],
- "type": "string"
- },
- "sow_term_amount": {
- "type": "number"
- },
- "sow_term_date": {
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "sow_term_type": {
- "enum": [
- "deliverables",
- "period",
- "date"
- ],
- "type": "string"
- },
- "sow_term_unit": {
- "enum": [
- "month(s)",
- "quarter(s)",
- "year(s)"
- ],
- "type": "string"
- },
- "type": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "recipient_email": {
- "format": "email",
- "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
- "type": "string"
- },
- "recipient_name": {
- "type": "string"
- },
- "recipient_notice_email_address": {
- "description": "Email address for legal notices to the recipient.",
- "format": "email",
- "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
- "type": "string"
- },
- "recipient_organization": {
- "type": "string"
- },
- "sender_last_to_sign": {
- "description": "When true, your signer signs after the recipient.",
- "type": "boolean"
- },
- "sender_notice_email_address": {
- "description": "Email address for legal notices to the sender.",
- "format": "email",
- "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
- "type": "string"
- },
- "software_license_attributes": {
- "additionalProperties": false,
- "description": "Override software license terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "effective_date": {
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "effective_date_type": {
- "enum": [
- "signature",
- "date"
- ],
- "type": "string"
- },
- "general_cap_amount": {
- "type": "number"
- },
- "general_cap_amount_type": {
- "enum": [
- "preceding",
- "base",
- "period"
- ],
- "type": "string"
- },
- "general_cap_period_currency": {
- "type": "number"
- },
- "general_cap_period_qty": {
- "type": "number"
- },
- "general_cap_preceding_amount": {
- "type": "number"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_additional_warranties": {
- "type": "boolean"
- },
- "include_additional_warranties_by_customer": {
- "type": "string"
- },
- "include_additional_warranties_by_provider": {
- "type": "string"
- },
- "include_additional_warranties_include_by_customer": {
- "type": "boolean"
- },
- "include_additional_warranties_include_by_provider": {
- "type": "boolean"
- },
- "include_ai_addendum": {
- "type": "boolean"
- },
- "include_ai_addendum_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_covered_claims": {
- "type": "boolean"
- },
- "include_covered_claims_customer_claims": {
- "type": "string"
- },
- "include_covered_claims_include_customer_claims": {
- "type": "boolean"
- },
- "include_covered_claims_include_provider_claims": {
- "type": "boolean"
- },
- "include_covered_claims_provider_claims": {
- "type": "string"
- },
- "include_dpa": {
- "type": "boolean"
- },
- "include_dpa_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_dpa_location": {
- "type": "string"
- },
- "include_dpa_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_increased_cap_amount": {
- "type": "boolean"
- },
- "include_increased_claims": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_confidentiality": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_confidentiality_negligence": {
- "type": "boolean"
- },
- "include_increased_claims_include_other": {
- "type": "boolean"
- },
- "include_increased_claims_indemnification_obligation": {
- "type": "boolean"
- },
- "include_increased_claims_negligence": {
- "type": "boolean"
- },
- "include_increased_claims_other": {
- "type": "string"
- },
- "include_increased_claims_restrictions": {
- "type": "boolean"
- },
- "include_unlimited_claims": {
- "type": "boolean"
- },
- "include_unlimited_claims_breach_of_confidentiality": {
- "type": "boolean"
- },
- "include_unlimited_claims_breach_of_confidentiality_negligence": {
- "type": "boolean"
- },
- "include_unlimited_claims_include_other": {
- "type": "boolean"
- },
- "include_unlimited_claims_indemnification_obligation": {
- "type": "boolean"
- },
- "include_unlimited_claims_license_or_restrictions": {
- "type": "boolean"
- },
- "include_unlimited_claims_negligence": {
- "type": "boolean"
- },
- "include_unlimited_claims_other": {
- "type": "string"
- },
- "increased_cap_amount_currency": {
- "type": "number"
- },
- "increased_cap_amount_period_currency": {
- "type": "number"
- },
- "increased_cap_amount_period_qty": {
- "type": "number"
- },
- "increased_cap_amount_qty": {
- "type": "number"
- },
- "increased_cap_amount_type": {
- "enum": [
- "qty",
- "currency",
- "period"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- "software_license_order_form_attributes": {
- "additionalProperties": false,
- "description": "Override software license order form terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "additional_changes": {
- "type": "string"
- },
- "deletion_procedure_include_custom": {
- "type": "boolean"
- },
- "deletion_procedure_include_custom_description": {
- "type": "string"
- },
- "deletion_procedure_include_customer_disable": {
- "type": "boolean"
- },
- "deletion_procedure_include_customer_proof": {
- "type": "boolean"
- },
- "deletion_procedure_include_provider_disable": {
- "type": "boolean"
- },
- "fee_custom_unit": {
- "type": "string"
- },
- "fee_period": {
- "enum": [
- "Subscription Period",
- "month",
- "year",
- "Custom unit"
- ],
- "type": "string"
- },
- "fees_attributes": {
- "additionalProperties": {
- "anyOf": [
- {
- "additionalProperties": false,
- "description": "Fees::Flat (fee_type \"flat\"). A fixed recurring fee, e.g. a platform subscription. Set type to \"Fees::Flat\" or fee_type to \"flat\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "Fixed amount in the order form's fees_currency, charged per fee_period. A plain amount, not cents: 20 means 20.00.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"flat\". Alternative to type.",
- "enum": [
- "flat"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Flat\". Optional when fee_type is set.",
- "enum": [
- "Fees::Flat"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Discount (fee_type \"discount\"). A discount, as a fixed amount or a percentage, applied forever, once, or for a number of months. Set type to \"Fees::Discount\" or fee_type to \"discount\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "Discount size: an amount in fees_currency when discount_type is fixed_amount (a plain amount, not cents: 20 means 20.00), or a percentage (e.g. 10 for 10%) when it is percentage.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "discount_duration_amount": {
- "description": "Number of months the discount applies. Required when discount_duration_type is multiple_months.",
- "type": "number"
- },
- "discount_duration_type": {
- "description": "How long the discount applies. multiple_months also needs discount_duration_amount.",
- "enum": [
- "forever",
- "once",
- "multiple_months"
- ],
- "type": "string"
- },
- "discount_type": {
- "description": "Whether cost is a currency amount or a percentage.",
- "enum": [
- "fixed_amount",
- "percentage"
- ],
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"discount\". Alternative to type.",
- "enum": [
- "discount"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Discount\". Optional when fee_type is set.",
- "enum": [
- "Fees::Discount"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Cost (fee_type \"cost\"). A per-unit fee: price per unit times quantity, e.g. seats. Set type to \"Fees::Cost\" or fee_type to \"cost\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "Price per unit in fees_currency. The row total is quantity x cost. A plain amount, not cents: 20 means 20.00.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"cost\". Alternative to type.",
- "enum": [
- "cost"
- ],
- "type": "string"
- },
- "quantity": {
- "description": "Number of units.",
- "type": "number"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Cost\". Optional when fee_type is set.",
- "enum": [
- "Fees::Cost"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Attachment (fee_type \"attachment\"). A fee described in an uploaded attachment instead of in the table. Set type to \"Fees::Attachment\" or fee_type to \"attachment\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "attachment_id": {
- "description": "ID of an attachment uploaded with upload-attachment.",
- "type": "string"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"attachment\". Alternative to type.",
- "enum": [
- "attachment"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Attachment\". Optional when fee_type is set.",
- "enum": [
- "Fees::Attachment"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Graduated (fee_type \"graduated\"). Tiered pricing, with the price set per tier in graduated_fee_tiers_attributes. Set type to \"Fees::Graduated\" or fee_type to \"graduated\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"graduated\". Alternative to type.",
- "enum": [
- "graduated"
- ],
- "type": "string"
- },
- "graduated_fee_tiers_attributes": {
- "additionalProperties": {
- "additionalProperties": false,
- "properties": {
- "flat_price": {
- "type": "number"
- },
- "price_per_unit": {
- "type": "string"
- },
- "upper_limit": {
- "type": "number"
- }
- },
- "type": "object"
- },
- "description": "Graduated fee tiers. Use string keys such as \"0\", \"1\".",
- "propertyNames": {
- "type": "string"
- },
- "type": "object"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Graduated\". Optional when fee_type is set.",
- "enum": [
- "Fees::Graduated"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Included (fee_type \"included\"). An item included at no charge. Set type to \"Fees::Included\" or fee_type to \"included\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"included\". Alternative to type.",
- "enum": [
- "included"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Included\". Optional when fee_type is set.",
- "enum": [
- "Fees::Included"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Metered (fee_type \"metered\"). Usage-based pricing, billed per unit used. Set type to \"Fees::Metered\" or fee_type to \"metered\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "Price per unit of usage in fees_currency. A plain amount, not cents: 20 means 20.00.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"metered\". Alternative to type.",
- "enum": [
- "metered"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Metered\". Optional when fee_type is set.",
- "enum": [
- "Fees::Metered"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::OneTime (fee_type \"one_time\"). A one-time charge, such as a setup fee. Set type to \"Fees::OneTime\" or fee_type to \"one_time\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "One-time amount in fees_currency, charged once rather than per fee_period. A plain amount, not cents: 20 means 20.00.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"one_time\". Alternative to type.",
- "enum": [
- "one_time"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::OneTime\". Optional when fee_type is set.",
- "enum": [
- "Fees::OneTime"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Text (fee_type \"text\"). A fee term described in free text. Set type to \"Fees::Text\" or fee_type to \"text\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"text\". Alternative to type.",
- "enum": [
- "text"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Text\". Optional when fee_type is set.",
- "enum": [
- "Fees::Text"
- ],
- "type": "string"
- }
- },
- "type": "object"
- }
- ]
- },
- "description": "Fee line items. Use string keys such as \"0\", \"1\". Replaces template fees when provided.",
- "propertyNames": {
- "type": "string"
- },
- "type": "object"
- },
- "fees_currency": {
- "enum": [
- "USD",
- "EUR",
- "GBP",
- "CAD",
- "AUD",
- "SGD",
- "ILS",
- "JPY",
- "CHF",
- "HKD"
- ],
- "type": "string"
- },
- "fees_include_fee_increase_upon_renewal": {
- "type": "boolean"
- },
- "fees_include_fee_increase_upon_renewal_fee": {
- "type": "number"
- },
- "fees_include_fee_increase_upon_renewal_type": {
- "enum": [
- "will",
- "may"
- ],
- "type": "string"
- },
- "fees_inclusive_of_taxes": {
- "type": "boolean"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_additional_changes": {
- "type": "boolean"
- },
- "include_license_compliance_verification": {
- "type": "boolean"
- },
- "include_license_compliance_verification_description": {
- "type": "string"
- },
- "include_license_limits": {
- "type": "boolean"
- },
- "include_license_limits_description": {
- "type": "string"
- },
- "include_payment_process_include_billing_email": {
- "type": "boolean"
- },
- "include_pilot_period": {
- "type": "boolean"
- },
- "include_pilot_period_duration_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_pilot_period_duration_type": {
- "enum": [
- "day",
- "week",
- "month"
- ],
- "type": "string"
- },
- "include_pilot_period_include_fees": {
- "type": "boolean"
- },
- "include_pilot_period_include_fees_amount": {
- "type": "number"
- },
- "include_pilot_period_include_modifications": {
- "type": "boolean"
- },
- "include_pilot_period_include_modifications_description": {
- "type": "string"
- },
- "include_services": {
- "type": "boolean"
- },
- "include_services_description": {
- "type": "string"
- },
- "negotiations_allowed": {
- "description": "When true, the recipient can propose changes to the order form, even when the agreement-level `negotiations_allowed` is false. This only covers the order form.",
- "type": "boolean"
- },
- "order_date_date": {
- "type": "string"
- },
- "order_date_type": {
- "enum": [
- "signature",
- "date",
- "other"
- ],
- "type": "string"
- },
- "payment_process_automatic_frequency": {
- "enum": [
- "monthly",
- "quarterly",
- "semiannually",
- "annually"
- ],
- "type": "string"
- },
- "payment_process_type": {
- "enum": [
- "automatic",
- "invoice",
- "custom"
- ],
- "type": "string"
- },
- "payment_process_type_custom_val": {
- "type": "string"
- },
- "payment_process_type_invoice_amount": {
- "type": "number"
- },
- "payment_process_type_invoice_custom_unit": {
- "type": "string"
- },
- "payment_process_type_invoice_duration": {
- "enum": [
- "day",
- "week",
- "month",
- "year",
- "day(s)",
- "week(s)",
- "month(s)",
- "year(s)"
- ],
- "type": "string"
- },
- "payment_process_type_invoice_duration_start": {
- "enum": [
- "Customer's receipt of invoice",
- "date of invoice"
- ],
- "type": "string"
- },
- "payment_process_type_invoice_type": {
- "enum": [
- "monthly",
- "quarterly",
- "semiannually",
- "annually",
- "Custom unit"
- ],
- "type": "string"
- },
- "permitted_uses_include_custom": {
- "type": "boolean"
- },
- "permitted_uses_include_custom_description": {
- "type": "string"
- },
- "permitted_uses_include_customers_affiliates": {
- "type": "boolean"
- },
- "permitted_uses_include_internal_business": {
- "type": "boolean"
- },
- "pilot_period_stripe_product_id": {
- "type": "string"
- },
- "software_description": {
- "type": "string"
- },
- "subscription_auto_renew": {
- "enum": [
- "days",
- "subscription_end"
- ],
- "type": "string"
- },
- "subscription_period": {
- "type": "number"
- },
- "subscription_period_unit": {
- "type": "string"
- },
- "subscription_renewal_notice_days": {
- "type": "number"
- },
- "warranty_period_description_amount": {
- "type": "number"
- },
- "warranty_period_description_duration": {
- "enum": [
- "day",
- "week",
- "month",
- "year"
- ],
- "type": "string"
- },
- "warranty_period_description_duration_start": {
- "enum": [
- "initial delivery of the Software",
- "delivery of the Software and each subsequent Update",
- "the Order Date"
- ],
- "type": "string"
- },
- "warranty_period_type": {
- "enum": [
- "description",
- "none"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- "test_agreement": {
- "description": "When true, marks the agreement as a test. Test agreements do not count against your monthly limit.",
- "type": "boolean"
- }
- },
- "required": [
- "recipient_name",
- "recipient_email"
- ],
- "type": "object"
- },
- "cc_users": {
- "items": {
- "format": "email",
- "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
- "type": "string"
- },
- "type": "array"
- },
- "draft": {
- "description": "When true, the agreement is saved as a draft and not sent to the recipient. Use POST /v1/agreements/{id}/send to send a draft agreement later.",
- "type": "boolean"
- },
- "owner_email": {
- "description": "Email address of the agreement owner (sender).",
- "type": "string"
- },
- "signer_id": {
- "description": "User id of the signer from the owner's organization.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "template_id": {
- "description": "UUID of a template from `GET /v1/templates`. Accepts both Common Paper standard templates and uploaded PDF templates (`type` `uploaded_template`).",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- }
- },
- "required": [
- "template_id",
- "owner_email",
- "signer_id",
- "agreement"
- ],
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "agreement": {
- "additionalProperties": {},
- "properties": {
- "amendment_attributes": {
- "additionalProperties": false,
- "description": "Override amendment terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "amended_terms_attributes": {
- "additionalProperties": {
- "additionalProperties": false,
- "properties": {
- "description": {
- "type": "string"
- },
- "term": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "description": "Amended terms. Use string keys such as \"0\", \"1\".",
- "propertyNames": {
- "type": "string"
- },
- "type": "object"
- },
- "amendment_date": {
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "amendment_date_type": {
- "enum": [
- "signature",
- "date"
- ],
- "type": "string"
- },
- "framework_terms_type": {
- "type": "string"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "parent_agreement_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "underlying_agreement_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "underlying_agreement_type": {
- "type": "string"
- },
- "underlying_agreement_val": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "baa_attributes": {
- "additionalProperties": false,
- "description": "Override baa terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "aggregation_limitations_permitted": {
- "type": "boolean"
- },
- "aggregation_limitations_permitted_val": {
- "type": "string"
- },
- "breach_notification_unit": {
- "enum": [
- "hours",
- "business days",
- "calendar days"
- ],
- "type": "string"
- },
- "breach_notification_val": {
- "type": "number"
- },
- "business_associate_relationship_type": {
- "enum": [
- "provider",
- "company"
- ],
- "type": "string"
- },
- "deidentification_limitations_include_purpose": {
- "type": "boolean"
- },
- "deidentification_limitations_include_requirements": {
- "type": "boolean"
- },
- "deidentification_limitations_permitted": {
- "type": "boolean"
- },
- "deidentification_limitations_purpose_val": {
- "type": "string"
- },
- "deidentification_limitations_requirements_val": {
- "type": "string"
- },
- "designated_record_set_provider_maintains": {
- "type": "boolean"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_aggregation_limitations": {
- "type": "boolean"
- },
- "include_deidentification_limitations": {
- "type": "boolean"
- },
- "include_limitations": {
- "type": "boolean"
- },
- "include_offshore_limitations": {
- "type": "boolean"
- },
- "include_subcontract_limitations": {
- "type": "boolean"
- },
- "offshore_limitations_permitted": {
- "type": "boolean"
- },
- "offshore_limitations_permitted_val": {
- "type": "string"
- },
- "subcontract_limitations_include_notice": {
- "type": "boolean"
- },
- "subcontract_limitations_include_permission": {
- "type": "boolean"
- },
- "subcontract_limitations_notice_val": {
- "type": "string"
- },
- "subcontract_limitations_permission_val": {
- "type": "string"
- },
- "subcontract_limitations_permitted": {
- "type": "boolean"
- },
- "underlying_agreement_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "underlying_agreement_type": {
- "enum": [
- "internal",
- "external",
- "none"
- ],
- "type": "string"
- },
- "underlying_agreement_val": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "billing_email": {
- "description": "Email of the billing contact. Used when include_billing_info is true.",
- "format": "email",
- "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
- "type": "string"
- },
- "billing_name": {
- "description": "Name of the billing contact. Used when include_billing_info is true.",
- "type": "string"
- },
- "billing_workflow_type": {
- "description": "The type of billing workflow. Use \"link\" to provide a payment_link_url, or \"stripe\" for Stripe-managed billing.",
- "enum": [
- "link",
- "stripe"
- ],
- "type": "string"
- },
- "chosen_courts_country": {
- "description": "The country in which disputes will be resolved.",
- "type": "string"
- },
- "chosen_courts_region": {
- "description": "The state or region in which disputes will be resolved.",
- "type": "string"
- },
- "csa_attributes": {
- "additionalProperties": false,
- "description": "Override csa terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "customer_description": {
- "type": "string"
- },
- "effective_date": {
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "effective_date_marketplace": {
- "enum": [
- "AWS",
- "GCP",
- "Azure"
- ],
- "type": "string"
- },
- "effective_date_type": {
- "enum": [
- "signature",
- "date",
- "marketplace_acceptance"
- ],
- "type": "string"
- },
- "general_cap_amount": {
- "type": "number"
- },
- "general_cap_amount_type": {
- "enum": [
- "preceding",
- "base",
- "period"
- ],
- "type": "string"
- },
- "general_cap_period_currency": {
- "type": "number"
- },
- "general_cap_period_qty": {
- "type": "number"
- },
- "general_cap_preceding_amount": {
- "type": "number"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_acceptable_use_policy": {
- "type": "boolean"
- },
- "include_acceptable_use_policy_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_acceptable_use_policy_location": {
- "type": "string"
- },
- "include_acceptable_use_policy_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_additional_warranties": {
- "type": "boolean"
- },
- "include_additional_warranties_by_customer": {
- "type": "string"
- },
- "include_additional_warranties_by_provider": {
- "type": "string"
- },
- "include_additional_warranties_include_by_customer": {
- "type": "boolean"
- },
- "include_additional_warranties_include_by_provider": {
- "type": "boolean"
- },
- "include_ai_addendum": {
- "type": "boolean"
- },
- "include_ai_addendum_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_covered_claims": {
- "type": "boolean"
- },
- "include_covered_claims_customer_claims": {
- "type": "string"
- },
- "include_covered_claims_include_customer_claims": {
- "type": "boolean"
- },
- "include_covered_claims_include_provider_claims": {
- "type": "boolean"
- },
- "include_covered_claims_provider_claims": {
- "type": "string"
- },
- "include_dpa": {
- "type": "boolean"
- },
- "include_dpa_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_dpa_location": {
- "type": "string"
- },
- "include_dpa_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_increased_cap_amount": {
- "type": "boolean"
- },
- "include_increased_claims": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_confidentiality": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_confidentiality_negligence": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_privsec": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_privsec_negligence": {
- "type": "boolean"
- },
- "include_increased_claims_include_other": {
- "type": "boolean"
- },
- "include_increased_claims_indemnification_obligation": {
- "type": "boolean"
- },
- "include_increased_claims_other": {
- "type": "string"
- },
- "include_insurance_minimums": {
- "type": "boolean"
- },
- "include_insurance_minimums_add_customer": {
- "type": "boolean"
- },
- "include_insurance_minimums_add_customer_com_gen_liability": {
- "type": "boolean"
- },
- "include_insurance_minimums_add_customer_cyber_liability": {
- "type": "boolean"
- },
- "include_insurance_minimums_add_customer_errors_omissions": {
- "type": "boolean"
- },
- "include_insurance_minimums_additional_information": {
- "type": "boolean"
- },
- "include_insurance_minimums_additional_information_text": {
- "type": "string"
- },
- "include_insurance_minimums_cyber_liability_aggregate": {
- "type": "number"
- },
- "include_insurance_minimums_cyber_liability_minimum": {
- "type": "number"
- },
- "include_insurance_minimums_employer_liability_aggregate": {
- "type": "number"
- },
- "include_insurance_minimums_employer_liability_minimum": {
- "type": "number"
- },
- "include_insurance_minimums_general_liability_aggregate": {
- "type": "number"
- },
- "include_insurance_minimums_general_liability_minimum": {
- "type": "number"
- },
- "include_insurance_minimums_include_cyber_liability": {
- "type": "boolean"
- },
- "include_insurance_minimums_include_employer_liability": {
- "type": "boolean"
- },
- "include_insurance_minimums_include_general_liability": {
- "type": "boolean"
- },
- "include_insurance_minimums_include_workers_compensation": {
- "type": "boolean"
- },
- "include_publicity_rights": {
- "type": "boolean"
- },
- "include_publicity_rights_type": {
- "enum": [
- "public",
- "non-public"
- ],
- "type": "string"
- },
- "include_security_policy": {
- "type": "boolean"
- },
- "include_security_policy_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_security_policy_fedramp_auth": {
- "type": "boolean"
- },
- "include_security_policy_hipaa": {
- "type": "boolean"
- },
- "include_security_policy_hitrust": {
- "type": "boolean"
- },
- "include_security_policy_include_annual_maintenance": {
- "type": "boolean"
- },
- "include_security_policy_include_location": {
- "type": "boolean"
- },
- "include_security_policy_include_other": {
- "type": "boolean"
- },
- "include_security_policy_include_reasonable_efforts": {
- "type": "boolean"
- },
- "include_security_policy_iso27001": {
- "type": "boolean"
- },
- "include_security_policy_location": {
- "type": "string"
- },
- "include_security_policy_other": {
- "type": "string"
- },
- "include_security_policy_pci1": {
- "type": "boolean"
- },
- "include_security_policy_pci2": {
- "type": "boolean"
- },
- "include_security_policy_penetration_testing": {
- "type": "boolean"
- },
- "include_security_policy_soc2": {
- "type": "boolean"
- },
- "include_security_policy_soc2_type2": {
- "type": "boolean"
- },
- "include_security_policy_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_supercap": {
- "description": "CSA 3.0 renamed `include_increased_cap_amount` to `include_supercap`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_increased_cap_amount`. Sending the other spelling returns a 422.",
- "type": "boolean"
- },
- "include_uncapped_claims": {
- "description": "CSA 3.0 renamed `include_unlimited_claims` to `include_uncapped_claims`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims`. Sending the other spelling returns a 422.",
- "type": "boolean"
- },
- "include_uncapped_claims_breach_of_confidentiality": {
- "description": "CSA 3.0 renamed `include_unlimited_claims_breach_of_confidentiality` to `include_uncapped_claims_breach_of_confidentiality`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_breach_of_confidentiality`. Sending the other spelling returns a 422.",
- "type": "boolean"
- },
- "include_uncapped_claims_breach_of_confidentiality_negligence": {
- "description": "CSA 3.0 renamed `include_unlimited_claims_breach_of_confidentiality_negligence` to `include_uncapped_claims_breach_of_confidentiality_negligence`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_breach_of_confidentiality_negligence`. Sending the other spelling returns a 422.",
- "type": "boolean"
- },
- "include_uncapped_claims_breach_of_privsec": {
- "description": "CSA 3.0 renamed `include_unlimited_claims_breach_of_privsec` to `include_uncapped_claims_breach_of_privsec`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_breach_of_privsec`. Sending the other spelling returns a 422.",
- "type": "boolean"
- },
- "include_uncapped_claims_breach_of_privsec_negligence": {
- "description": "CSA 3.0 renamed `include_unlimited_claims_breach_of_privsec_negligence` to `include_uncapped_claims_breach_of_privsec_negligence`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_breach_of_privsec_negligence`. Sending the other spelling returns a 422.",
- "type": "boolean"
- },
- "include_uncapped_claims_include_other": {
- "description": "CSA 3.0 renamed `include_unlimited_claims_include_other` to `include_uncapped_claims_include_other`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_include_other`. Sending the other spelling returns a 422.",
- "type": "boolean"
- },
- "include_uncapped_claims_indemnification_obligation": {
- "description": "CSA 3.0 renamed `include_unlimited_claims_indemnification_obligation` to `include_uncapped_claims_indemnification_obligation`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_indemnification_obligation`. Sending the other spelling returns a 422.",
- "type": "boolean"
- },
- "include_uncapped_claims_other": {
- "description": "CSA 3.0 renamed `include_unlimited_claims_other` to `include_uncapped_claims_other`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_other`. Sending the other spelling returns a 422.",
- "type": "boolean"
- },
- "include_unlimited_claims": {
- "type": "boolean"
- },
- "include_unlimited_claims_breach_of_confidentiality": {
- "type": "boolean"
- },
- "include_unlimited_claims_breach_of_confidentiality_negligence": {
- "type": "boolean"
- },
- "include_unlimited_claims_breach_of_privsec": {
- "type": "boolean"
- },
- "include_unlimited_claims_breach_of_privsec_negligence": {
- "type": "boolean"
- },
- "include_unlimited_claims_include_other": {
- "type": "boolean"
- },
- "include_unlimited_claims_indemnification_obligation": {
- "type": "boolean"
- },
- "include_unlimited_claims_other": {
- "type": "string"
- },
- "increased_cap_amount_currency": {
- "type": "number"
- },
- "increased_cap_amount_period_currency": {
- "type": "number"
- },
- "increased_cap_amount_period_qty": {
- "type": "number"
- },
- "increased_cap_amount_qty": {
- "type": "number"
- },
- "increased_cap_amount_type": {
- "enum": [
- "qty",
- "currency",
- "period"
- ],
- "type": "string"
- },
- "provider": {
- "type": "string"
- },
- "supercap_currency": {
- "description": "CSA 3.0 renamed `increased_cap_amount_currency` to `supercap_currency`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `increased_cap_amount_currency`. Sending the other spelling returns a 422.",
- "type": "number"
- },
- "supercap_period_currency": {
- "description": "CSA 3.0 renamed `increased_cap_amount_period_currency` to `supercap_period_currency`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `increased_cap_amount_period_currency`. Sending the other spelling returns a 422.",
- "type": "number"
- },
- "supercap_period_qty": {
- "description": "CSA 3.0 renamed `increased_cap_amount_period_qty` to `supercap_period_qty`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `increased_cap_amount_period_qty`. Sending the other spelling returns a 422.",
- "type": "number"
- },
- "supercap_qty": {
- "description": "CSA 3.0 renamed `increased_cap_amount_qty` to `supercap_qty`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `increased_cap_amount_qty`. Sending the other spelling returns a 422.",
- "type": "number"
- },
- "supercap_type": {
- "description": "CSA 3.0 renamed `increased_cap_amount_type` to `supercap_type`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `increased_cap_amount_type`. Sending the other spelling returns a 422.",
- "type": "number"
- }
- },
- "type": "object"
- },
- "csa_order_form_attributes": {
- "additionalProperties": false,
- "description": "Override csa order form terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "additional_changes": {
- "type": "string"
- },
- "additional_parameters_or_limitations": {
- "type": "string"
- },
- "affiliates_as_users": {
- "type": "boolean"
- },
- "cloud_service_description": {
- "type": "string"
- },
- "consumption_units": {
- "type": "string"
- },
- "fee_amount": {
- "type": "number"
- },
- "fee_custom_unit": {
- "type": "string"
- },
- "fee_period": {
- "enum": [
- "Subscription Period",
- "month",
- "year",
- "User",
- "Custom unit"
- ],
- "type": "string"
- },
- "fees_attributes": {
- "additionalProperties": {
- "anyOf": [
- {
- "additionalProperties": false,
- "description": "Fees::Flat (fee_type \"flat\"). A fixed recurring fee, e.g. a platform subscription. Set type to \"Fees::Flat\" or fee_type to \"flat\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "Fixed amount in the order form's fees_currency, charged per fee_period. A plain amount, not cents: 20 means 20.00.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"flat\". Alternative to type.",
- "enum": [
- "flat"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Flat\". Optional when fee_type is set.",
- "enum": [
- "Fees::Flat"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Discount (fee_type \"discount\"). A discount, as a fixed amount or a percentage, applied forever, once, or for a number of months. Set type to \"Fees::Discount\" or fee_type to \"discount\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "Discount size: an amount in fees_currency when discount_type is fixed_amount (a plain amount, not cents: 20 means 20.00), or a percentage (e.g. 10 for 10%) when it is percentage.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "discount_duration_amount": {
- "description": "Number of months the discount applies. Required when discount_duration_type is multiple_months.",
- "type": "number"
- },
- "discount_duration_type": {
- "description": "How long the discount applies. multiple_months also needs discount_duration_amount.",
- "enum": [
- "forever",
- "once",
- "multiple_months"
- ],
- "type": "string"
- },
- "discount_type": {
- "description": "Whether cost is a currency amount or a percentage.",
- "enum": [
- "fixed_amount",
- "percentage"
- ],
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"discount\". Alternative to type.",
- "enum": [
- "discount"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Discount\". Optional when fee_type is set.",
- "enum": [
- "Fees::Discount"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Cost (fee_type \"cost\"). A per-unit fee: price per unit times quantity, e.g. seats. Set type to \"Fees::Cost\" or fee_type to \"cost\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "Price per unit in fees_currency. The row total is quantity x cost. A plain amount, not cents: 20 means 20.00.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"cost\". Alternative to type.",
- "enum": [
- "cost"
- ],
- "type": "string"
- },
- "quantity": {
- "description": "Number of units.",
- "type": "number"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Cost\". Optional when fee_type is set.",
- "enum": [
- "Fees::Cost"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Attachment (fee_type \"attachment\"). A fee described in an uploaded attachment instead of in the table. Set type to \"Fees::Attachment\" or fee_type to \"attachment\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "attachment_id": {
- "description": "ID of an attachment uploaded with upload-attachment.",
- "type": "string"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"attachment\". Alternative to type.",
- "enum": [
- "attachment"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Attachment\". Optional when fee_type is set.",
- "enum": [
- "Fees::Attachment"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Graduated (fee_type \"graduated\"). Tiered pricing, with the price set per tier in graduated_fee_tiers_attributes. Set type to \"Fees::Graduated\" or fee_type to \"graduated\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"graduated\". Alternative to type.",
- "enum": [
- "graduated"
- ],
- "type": "string"
- },
- "graduated_fee_tiers_attributes": {
- "additionalProperties": {
- "additionalProperties": false,
- "properties": {
- "flat_price": {
- "type": "number"
- },
- "price_per_unit": {
- "type": "string"
- },
- "upper_limit": {
- "type": "number"
- }
- },
- "type": "object"
- },
- "description": "Graduated fee tiers. Use string keys such as \"0\", \"1\".",
- "propertyNames": {
- "type": "string"
- },
- "type": "object"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Graduated\". Optional when fee_type is set.",
- "enum": [
- "Fees::Graduated"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Included (fee_type \"included\"). An item included at no charge. Set type to \"Fees::Included\" or fee_type to \"included\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"included\". Alternative to type.",
- "enum": [
- "included"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Included\". Optional when fee_type is set.",
- "enum": [
- "Fees::Included"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Metered (fee_type \"metered\"). Usage-based pricing, billed per unit used. Set type to \"Fees::Metered\" or fee_type to \"metered\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "Price per unit of usage in fees_currency. A plain amount, not cents: 20 means 20.00.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"metered\". Alternative to type.",
- "enum": [
- "metered"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Metered\". Optional when fee_type is set.",
- "enum": [
- "Fees::Metered"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::OneTime (fee_type \"one_time\"). A one-time charge, such as a setup fee. Set type to \"Fees::OneTime\" or fee_type to \"one_time\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "One-time amount in fees_currency, charged once rather than per fee_period. A plain amount, not cents: 20 means 20.00.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"one_time\". Alternative to type.",
- "enum": [
- "one_time"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::OneTime\". Optional when fee_type is set.",
- "enum": [
- "Fees::OneTime"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Text (fee_type \"text\"). A fee term described in free text. Set type to \"Fees::Text\" or fee_type to \"text\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"text\". Alternative to type.",
- "enum": [
- "text"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Text\". Optional when fee_type is set.",
- "enum": [
- "Fees::Text"
- ],
- "type": "string"
- }
- },
- "type": "object"
- }
- ]
- },
- "description": "Fee table rows, keyed by string index (\"0\", \"1\", ...). Replaces the template's fees when provided. Each row sets type or fee_type to pick the fee class. Amounts are in the order form's fees_currency and, for recurring fees, are charged per fee_period.",
- "examples": [
- {
- "0": {
- "cost": 2000,
- "description": "Platform subscription",
- "type": "Fees::Flat"
- }
- },
- {
- "0": {
- "cost": 50,
- "description": "Seats",
- "fee_type": "cost",
- "quantity": 10
- },
- "1": {
- "cost": 10,
- "description": "Launch discount",
- "discount_duration_amount": 3,
- "discount_duration_type": "multiple_months",
- "discount_type": "percentage",
- "fee_type": "discount"
- }
- }
- ],
- "propertyNames": {
- "type": "string"
- },
- "type": "object"
- },
- "fees_currency": {
- "enum": [
- "USD",
- "EUR",
- "GBP",
- "CAD",
- "AUD",
- "SGD",
- "ILS",
- "JPY",
- "CHF",
- "HKD"
- ],
- "type": "string"
- },
- "fees_include_fee_increase_upon_renewal": {
- "type": "boolean"
- },
- "fees_include_fee_increase_upon_renewal_fee": {
- "type": "number"
- },
- "fees_include_fee_increase_upon_renewal_type": {
- "enum": [
- "will",
- "may"
- ],
- "type": "string"
- },
- "fees_inclusive_of_taxes": {
- "type": "boolean"
- },
- "framework_terms_type": {
- "enum": [
- "new",
- "existing",
- "description"
- ],
- "type": "string"
- },
- "free_trial_days": {
- "type": "number"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_additional_changes": {
- "type": "boolean"
- },
- "include_additional_parameters_or_limitations": {
- "type": "boolean"
- },
- "include_consumption": {
- "type": "boolean"
- },
- "include_fees": {
- "type": "boolean"
- },
- "include_fees_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_fees_include_attachment": {
- "type": "boolean"
- },
- "include_fees_other": {
- "type": "boolean"
- },
- "include_fees_other_val": {
- "type": "string"
- },
- "include_fees_table": {
- "type": "boolean"
- },
- "include_fees_table_period": {
- "enum": [
- "Subscription Period",
- "month",
- "year",
- "User"
- ],
- "type": "string"
- },
- "include_free_trial": {
- "type": "boolean"
- },
- "include_max_users": {
- "type": "boolean"
- },
- "include_pilot_period": {
- "type": "boolean"
- },
- "include_pilot_period_duration_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_pilot_period_duration_type": {
- "enum": [
- "day",
- "week",
- "month"
- ],
- "type": "string"
- },
- "include_pilot_period_include_fees": {
- "type": "boolean"
- },
- "include_pilot_period_include_fees_amount": {
- "type": "number"
- },
- "include_pilot_period_include_modifications": {
- "type": "boolean"
- },
- "include_pilot_period_include_modifications_description": {
- "type": "string"
- },
- "include_product_support": {
- "type": "boolean"
- },
- "include_product_support_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_product_support_description": {
- "type": "string"
- },
- "include_product_support_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_professional_services": {
- "type": "boolean"
- },
- "include_professional_services_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_professional_services_custom_name": {
- "type": "string"
- },
- "include_professional_services_description": {
- "type": "string"
- },
- "include_professional_services_end_date": {
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "include_professional_services_fees_description": {
- "type": "string"
- },
- "include_professional_services_include_end_date": {
- "type": "boolean"
- },
- "include_professional_services_include_fees_description": {
- "type": "boolean"
- },
- "include_professional_services_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_sla": {
- "type": "boolean"
- },
- "include_sla_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_sla_description": {
- "type": "string"
- },
- "include_sla_include_response_time": {
- "type": "boolean"
- },
- "include_sla_include_response_time_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_sla_include_response_time_credit": {
- "type": "number"
- },
- "include_sla_include_response_time_duration": {
- "enum": [
- "hour",
- "day",
- "week",
- "month",
- "hours"
- ],
- "type": "string"
- },
- "include_sla_include_response_time_support_channel": {
- "type": "string"
- },
- "include_sla_include_target_uptime": {
- "type": "boolean"
- },
- "include_sla_maintenance_notice": {
- "type": "boolean"
- },
- "include_sla_maintenance_window": {
- "type": "boolean"
- },
- "include_sla_maintenance_window_type": {
- "enum": [
- "standard",
- "none"
- ],
- "type": "string"
- },
- "include_sla_standard_maintenance_notice_qty": {
- "type": "number"
- },
- "include_sla_standard_maintenance_notice_unit": {
- "enum": [
- "hour",
- "day",
- "week",
- "month"
- ],
- "type": "string"
- },
- "include_sla_standard_maintenance_window_end_time": {
- "type": "string"
- },
- "include_sla_standard_maintenance_window_friday": {
- "type": "boolean"
- },
- "include_sla_standard_maintenance_window_monday": {
- "type": "boolean"
- },
- "include_sla_standard_maintenance_window_saturday": {
- "type": "boolean"
- },
- "include_sla_standard_maintenance_window_start_time": {
- "type": "string"
- },
- "include_sla_standard_maintenance_window_sunday": {
- "type": "boolean"
- },
- "include_sla_standard_maintenance_window_thursday": {
- "type": "boolean"
- },
- "include_sla_standard_maintenance_window_time_zone": {
- "type": "string"
- },
- "include_sla_standard_maintenance_window_tuesday": {
- "type": "boolean"
- },
- "include_sla_standard_maintenance_window_wednesday": {
- "type": "boolean"
- },
- "include_sla_standard_target_uptime": {
- "type": "number"
- },
- "include_sla_type": {
- "enum": [
- "description",
- "standard",
- "attachment"
- ],
- "type": "string"
- },
- "include_subscription_start_date": {
- "type": "boolean"
- },
- "include_subscription_start_date_date": {
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "include_usage_review": {
- "type": "boolean"
- },
- "include_usage_review_val": {
- "type": "string"
- },
- "include_use_limitations": {
- "type": "boolean"
- },
- "include_use_limitations_val": {
- "type": "string"
- },
- "invoice_period": {
- "enum": [
- "monthly",
- "quarterly",
- "semiannually",
- "annually",
- "Custom unit",
- "Monthly",
- "Quarterly",
- "Semiannually",
- "Annually"
- ],
- "type": "string"
- },
- "invoice_period_custom_unit": {
- "type": "string"
- },
- "max_consumption": {
- "type": "number"
- },
- "max_users": {
- "type": "number"
- },
- "negotiations_allowed": {
- "description": "When true, the recipient can propose changes to the order form, even when the agreement-level `negotiations_allowed` is false. This only covers the order form.",
- "type": "boolean"
- },
- "order_date_date": {
- "type": "string"
- },
- "order_date_other": {
- "type": "string"
- },
- "order_date_type": {
- "enum": [
- "signature",
- "date",
- "other"
- ],
- "type": "string"
- },
- "payment_period": {
- "type": "number"
- },
- "payment_period_timeframe": {
- "enum": [
- "Customer's receipt of invoice",
- "date of invoice"
- ],
- "type": "string"
- },
- "payment_period_unit": {
- "enum": [
- "day(s)",
- "week(s)",
- "month(s)",
- "marketplace_acceptance"
- ],
- "type": "string"
- },
- "payment_process_automatic_frequency": {
- "enum": [
- "monthly",
- "quarterly",
- "semiannually",
- "annually"
- ],
- "type": "string"
- },
- "payment_process_type": {
- "enum": [
- "automatic",
- "invoice",
- "custom",
- "marketplace_acceptance"
- ],
- "type": "string"
- },
- "payment_process_type_custom_val": {
- "type": "string"
- },
- "payment_process_type_invoice_amount": {
- "type": "number"
- },
- "payment_process_type_invoice_custom_unit": {
- "type": "string"
- },
- "payment_process_type_invoice_duration": {
- "enum": [
- "day",
- "week",
- "month",
- "year",
- "day(s)",
- "week(s)",
- "month(s)",
- "year(s)"
- ],
- "type": "string"
- },
- "payment_process_type_invoice_duration_start": {
- "enum": [
- "Customer's receipt of invoice",
- "date of invoice"
- ],
- "type": "string"
- },
- "payment_process_type_invoice_type": {
- "enum": [
- "monthly",
- "quarterly",
- "semiannually",
- "annually",
- "Custom unit"
- ],
- "type": "string"
- },
- "pilot_period_stripe_product_id": {
- "type": "string"
- },
- "service_credits_attributes": {
- "additionalProperties": {
- "additionalProperties": false,
- "properties": {
- "credit": {
- "type": "number"
- },
- "max": {
- "type": "number"
- },
- "min": {
- "type": "number"
- }
- },
- "type": "object"
- },
- "description": "Service credits. Use string keys such as \"0\", \"1\".",
- "propertyNames": {
- "type": "string"
- },
- "type": "object"
- },
- "subscription_auto_renew": {
- "enum": [
- "days",
- "subscription_end"
- ],
- "type": "string"
- },
- "subscription_period": {
- "type": "number"
- },
- "subscription_period_unit": {
- "type": "string"
- },
- "subscription_renewal_notice_days": {
- "type": "number"
- },
- "subscription_start_date": {
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "subscription_start_date_type": {
- "enum": [
- "effective_date",
- "date"
- ],
- "type": "string"
- },
- "underlying_agreement_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "use_limitations_attributes": {
- "additionalProperties": {
- "additionalProperties": false,
- "properties": {
- "amount": {
- "type": "number"
- },
- "limitation_type": {
- "type": "string"
- },
- "unit": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "description": "Use limitations. Use string keys such as \"0\", \"1\".",
- "propertyNames": {
- "type": "string"
- },
- "type": "object"
- }
- },
- "type": "object"
- },
- "custom_field_values": {
- "description": "Values for a custom template's fields, keyed by the field keys defined in the template's YAML definition. Only used when template_id is a custom template. Template defaults fill any fields you omit; a required field with no default and no submitted value returns a 400 naming the field. Values are validated against the field's input type: select and radio values must be one of the field's options, multiselect values are an array of selections each of which must be one of the field's options, number and currency values must be numeric, date values must be YYYY-MM-DD, and email values must be valid addresses. An invalid value returns a 400 naming the field."
- },
- "design_partner_attributes": {
- "additionalProperties": false,
- "description": "Override design partner terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "customer_description": {
- "type": "string"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_fees": {
- "type": "boolean"
- },
- "include_fees_amount": {
- "type": "number"
- },
- "include_fees_description": {
- "type": "string"
- },
- "include_fees_pay_by_amount": {
- "type": "string"
- },
- "include_fees_type": {
- "enum": [
- "default_language",
- "description"
- ],
- "type": "string"
- },
- "include_fees_unit": {
- "enum": [
- "month",
- "quarter",
- "year",
- "Term"
- ],
- "type": "string"
- },
- "include_program_appear_as_customer_private": {
- "type": "boolean"
- },
- "include_program_appear_as_customer_public": {
- "type": "boolean"
- },
- "include_program_case_study": {
- "type": "boolean"
- },
- "include_program_develop_functionality": {
- "type": "boolean"
- },
- "include_program_develop_functionality_val": {
- "type": "string"
- },
- "include_program_discount": {
- "type": "boolean"
- },
- "include_program_discount_amount": {
- "type": "number"
- },
- "include_program_discount_unit": {
- "enum": [
- "U.S. Dollars",
- "percent"
- ],
- "type": "string"
- },
- "include_program_participation_feedback": {
- "type": "boolean"
- },
- "include_program_participation_feedback_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_program_participation_feedback_unit": {
- "enum": [
- "month",
- "quarter",
- "year",
- "Term"
- ],
- "type": "string"
- },
- "include_program_partner_other": {
- "type": "boolean"
- },
- "include_program_partner_other_val": {
- "type": "string"
- },
- "include_program_provider_other": {
- "type": "boolean"
- },
- "include_program_provider_other_val": {
- "type": "string"
- },
- "include_program_reference": {
- "type": "boolean"
- },
- "product_description": {
- "type": "string"
- },
- "term_amount": {
- "type": "number"
- },
- "term_unit": {
- "enum": [
- "day(s)",
- "week(s)",
- "month(s)",
- "quarter(s)",
- "year(s)"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- "district_or_county": {
- "description": "The district or county for dispute resolution.",
- "type": "string"
- },
- "dpa_attributes": {
- "additionalProperties": false,
- "description": "Override dpa terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "approved_subprocessor_type": {
- "description": "`internal` lists approved subprocessors in the agreement (`subprocessors_attributes`); `external` points to a list published elsewhere.",
- "enum": [
- "internal",
- "external"
- ],
- "type": "string"
- },
- "cloud_service_product_name": {
- "type": "string"
- },
- "competent_supervisory_authority": {
- "type": "string"
- },
- "customer_description": {
- "type": "string"
- },
- "data_exporter_address_city": {
- "type": "string"
- },
- "data_exporter_address_country": {
- "type": "string"
- },
- "data_exporter_address_state": {
- "type": "string"
- },
- "data_exporter_address_street_address": {
- "type": "string"
- },
- "data_exporter_address_zipcode": {
- "type": "string"
- },
- "data_exporter_contact_details": {
- "type": "string"
- },
- "data_exporter_contact_name": {
- "type": "string"
- },
- "data_exporter_contact_position": {
- "type": "string"
- },
- "data_exporter_role": {
- "description": "Role of the data exporter. Overwritten to `Controller` when the agreement is created from a template.",
- "enum": [
- "Controller",
- "Processor"
- ],
- "type": "string"
- },
- "data_importer_address": {
- "type": "string"
- },
- "data_importer_address_city": {
- "type": "string"
- },
- "data_importer_address_country": {
- "type": "string"
- },
- "data_importer_address_state": {
- "type": "string"
- },
- "data_importer_address_street_address": {
- "type": "string"
- },
- "data_importer_address_zipcode": {
- "type": "string"
- },
- "data_importer_contact_details": {
- "type": "string"
- },
- "data_importer_contact_name": {
- "type": "string"
- },
- "data_importer_contact_position": {
- "type": "string"
- },
- "duration_of_processing": {
- "type": "string"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_covered_claim": {
- "type": "boolean"
- },
- "include_covered_claim_external_val": {
- "type": "string"
- },
- "include_covered_claim_internal_val": {
- "type": "string"
- },
- "include_covered_claim_type": {
- "description": "Which covered-claim text applies: `internal` uses `include_covered_claim_internal_val`, `external` uses `include_covered_claim_external_val`. Required when `include_covered_claim` is true.",
- "enum": [
- "internal",
- "external"
- ],
- "type": "string"
- },
- "include_data_subjects_custom": {
- "type": "boolean"
- },
- "include_data_subjects_custom_val": {
- "type": "string"
- },
- "include_data_subjects_employees": {
- "type": "boolean"
- },
- "include_data_subjects_end_users": {
- "type": "boolean"
- },
- "include_external_subprocessor_location": {
- "type": "string"
- },
- "include_frequency_of_transfer_continuous": {
- "type": "boolean"
- },
- "include_frequency_of_transfer_custom": {
- "type": "boolean"
- },
- "include_frequency_of_transfer_custom_val": {
- "type": "string"
- },
- "include_governing_country_eu": {
- "type": "boolean"
- },
- "include_governing_country_eu_val": {
- "type": "string"
- },
- "include_governing_country_uk": {
- "type": "boolean"
- },
- "include_governing_country_uk_val": {
- "type": "string"
- },
- "include_governing_law": {
- "type": "boolean"
- },
- "include_governing_law_country": {
- "type": "string"
- },
- "include_governing_law_state": {
- "type": "string"
- },
- "include_increased_claim_amount": {
- "description": "Legacy field. Stored but not shown on the DPA; use the `include_liability_cap*` fields instead.",
- "type": "boolean"
- },
- "include_increased_claim_amount_currency": {
- "description": "Legacy field. Stored but not shown on the DPA; use the `include_liability_cap*` fields instead."
- },
- "include_increased_claim_amount_qty": {
- "description": "Legacy field. Stored but not shown on the DPA; use the `include_liability_cap*` fields instead."
- },
- "include_increased_claim_amount_type": {
- "description": "Legacy field. Stored but not shown on the DPA; use the `include_liability_cap*` fields instead.",
- "type": "string"
- },
- "include_liability_cap": {
- "type": "boolean"
- },
- "include_liability_cap_amount_constant_external": {
- "type": "string"
- },
- "include_liability_cap_amount_constant_internal": {
- "type": "string"
- },
- "include_liability_cap_amount_currency_external": {
- "description": "Currency amount. Numbers and numeric strings (commas allowed) are both accepted."
- },
- "include_liability_cap_amount_currency_internal": {
- "description": "Currency amount. Numbers and numeric strings (commas allowed) are both accepted."
- },
- "include_liability_cap_csa_type": {
- "description": "Which liability cap values apply: the `_internal` or `_external` amount fields. Required when `include_liability_cap` is true.",
- "enum": [
- "internal",
- "external"
- ],
- "type": "string"
- },
- "include_personal_data_biographic_info": {
- "type": "boolean"
- },
- "include_personal_data_contact_info": {
- "type": "boolean"
- },
- "include_personal_data_custom": {
- "type": "boolean"
- },
- "include_personal_data_custom_val": {
- "type": "string"
- },
- "include_personal_data_employment_info": {
- "type": "boolean"
- },
- "include_personal_data_financial_info": {
- "type": "boolean"
- },
- "include_personal_data_location": {
- "type": "boolean"
- },
- "include_personal_data_name": {
- "type": "boolean"
- },
- "include_personal_data_transactional_info": {
- "type": "boolean"
- },
- "include_personal_data_user_activity_info": {
- "type": "boolean"
- },
- "include_processing_purpose_custom": {
- "type": "boolean"
- },
- "include_processing_purpose_custom_val": {
- "type": "string"
- },
- "include_processing_purpose_erasing": {
- "type": "boolean"
- },
- "include_processing_purpose_holding": {
- "type": "boolean"
- },
- "include_processing_purpose_protecting": {
- "type": "boolean"
- },
- "include_processing_purpose_receiving": {
- "type": "boolean"
- },
- "include_processing_purpose_returning": {
- "type": "boolean"
- },
- "include_processing_purpose_sharing": {
- "type": "boolean"
- },
- "include_processing_purpose_updating": {
- "type": "boolean"
- },
- "include_processing_purpose_using": {
- "type": "boolean"
- },
- "include_provider_security_contact_address": {
- "type": "boolean"
- },
- "include_provider_security_contact_address_city": {
- "type": "string"
- },
- "include_provider_security_contact_address_country": {
- "type": "string"
- },
- "include_provider_security_contact_address_state": {
- "type": "string"
- },
- "include_provider_security_contact_address_street_address": {
- "type": "string"
- },
- "include_provider_security_contact_address_zipcode": {
- "type": "string"
- },
- "include_provider_security_contact_email": {
- "type": "boolean"
- },
- "include_provider_security_contact_email_val": {
- "format": "email",
- "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
- "type": "string"
- },
- "include_security_measures_accountability": {
- "type": "boolean"
- },
- "include_security_measures_accountability_val": {
- "type": "string"
- },
- "include_security_measures_certification_or_assurance": {
- "type": "boolean"
- },
- "include_security_measures_certification_or_assurance_val": {
- "type": "string"
- },
- "include_security_measures_confidentiality_integrity": {
- "type": "boolean"
- },
- "include_security_measures_confidentiality_integrity_val": {
- "type": "string"
- },
- "include_security_measures_data_at_rest": {
- "type": "boolean"
- },
- "include_security_measures_data_at_rest_val": {
- "type": "string"
- },
- "include_security_measures_data_minimization": {
- "type": "boolean"
- },
- "include_security_measures_data_minimization_val": {
- "type": "string"
- },
- "include_security_measures_data_quality": {
- "type": "boolean"
- },
- "include_security_measures_data_quality_val": {
- "type": "string"
- },
- "include_security_measures_data_retention": {
- "type": "boolean"
- },
- "include_security_measures_data_retention_val": {
- "type": "string"
- },
- "include_security_measures_data_transmission": {
- "type": "boolean"
- },
- "include_security_measures_data_transmission_val": {
- "type": "string"
- },
- "include_security_measures_event_logging": {
- "type": "boolean"
- },
- "include_security_measures_event_logging_val": {
- "type": "string"
- },
- "include_security_measures_identity_auth": {
- "type": "boolean"
- },
- "include_security_measures_identity_auth_val": {
- "type": "string"
- },
- "include_security_measures_it_security_governance": {
- "type": "boolean"
- },
- "include_security_measures_it_security_governance_val": {
- "type": "string"
- },
- "include_security_measures_physical_security": {
- "type": "boolean"
- },
- "include_security_measures_physical_security_val": {
- "type": "string"
- },
- "include_security_measures_portability_and_erasure": {
- "type": "boolean"
- },
- "include_security_measures_portability_and_erasure_val": {
- "type": "string"
- },
- "include_security_measures_pseudonym_encryption": {
- "type": "boolean"
- },
- "include_security_measures_pseudonym_encryption_val": {
- "type": "string"
- },
- "include_security_measures_restore_data_access": {
- "type": "boolean"
- },
- "include_security_measures_restore_data_access_val": {
- "type": "string"
- },
- "include_security_measures_security_policy": {
- "type": "boolean"
- },
- "include_security_measures_system_configuration": {
- "type": "boolean"
- },
- "include_security_measures_system_configuration_val": {
- "type": "string"
- },
- "include_security_measures_testing_assessment": {
- "type": "boolean"
- },
- "include_security_measures_testing_assessment_val": {
- "type": "string"
- },
- "include_security_policy": {
- "type": "boolean"
- },
- "include_security_policy_fedramp_auth": {
- "type": "boolean"
- },
- "include_security_policy_hipaa": {
- "type": "boolean"
- },
- "include_security_policy_hitrust": {
- "type": "boolean"
- },
- "include_security_policy_include_other": {
- "type": "boolean"
- },
- "include_security_policy_iso27001": {
- "type": "boolean"
- },
- "include_security_policy_other": {
- "type": "string"
- },
- "include_security_policy_pci1": {
- "type": "boolean"
- },
- "include_security_policy_pci2": {
- "type": "boolean"
- },
- "include_security_policy_penetration_testing": {
- "type": "boolean"
- },
- "include_security_policy_soc2": {
- "type": "boolean"
- },
- "include_security_policy_soc2_type2": {
- "type": "boolean"
- },
- "include_sensitive_data_restrictions_custom": {
- "type": "boolean"
- },
- "include_sensitive_data_restrictions_custom_val": {
- "type": "string"
- },
- "include_sensitive_data_restrictions_security_policy": {
- "type": "boolean"
- },
- "include_service_provider_relationship": {
- "type": "boolean"
- },
- "include_special_category_data": {
- "type": "boolean"
- },
- "provider": {
- "type": "string"
- },
- "security_policy_available_at": {
- "type": "string"
- },
- "security_policy_type": {
- "description": "Where the Security Policy is defined. For `external`, set `security_policy_available_at`.",
- "enum": [
- "defined in agreement",
- "provider service",
- "external"
- ],
- "type": "string"
- },
- "subprocessors_attributes": {
- "additionalProperties": {
- "additionalProperties": false,
- "properties": {
- "_destroy": {
- "description": "Set to true with `id` to remove that subprocessor.",
- "type": "boolean"
- },
- "country": {
- "type": "string"
- },
- "id": {
- "description": "ID of an existing subprocessor to update or remove. Omit to add a new subprocessor.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "name": {
- "type": "string"
- },
- "processing_task": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "description": "Subprocessors, keyed by string index such as \"0\", \"1\". On create these are added to the template's subprocessors. On a draft update, an entry without `id` adds a new subprocessor; pass `id` to change one and `id` with `_destroy: true` to remove one.",
- "propertyNames": {
- "type": "string"
- },
- "type": "object"
- },
- "underlying_agreement_id": {
- "description": "ID of the CSA this DPA supplements when `underlying_agreement_type` is `internal`.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "underlying_agreement_type": {
- "description": "`internal` links a CSA in Common Paper (`underlying_agreement_id`); `external` describes another agreement in `underlying_agreement_val` (required). Omit for none.",
- "enum": [
- "internal",
- "external"
- ],
- "type": "string"
- },
- "underlying_agreement_val": {
- "description": "Description of the agreement this DPA supplements. Required when `underlying_agreement_type` is `external`.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "framework_terms_description": {
- "description": "Custom framework terms description. Only used when framework_terms_type is \"description\".",
- "type": "string"
- },
- "framework_terms_type": {
- "description": "How framework terms are specified. Use \"new\" for standard terms or \"description\" to provide a custom framework_terms_description.",
- "enum": [
- "new",
- "description"
- ],
- "type": "string"
- },
- "governing_law_country": {
- "description": "The country whose laws govern the agreement.",
- "type": "string"
- },
- "governing_law_region": {
- "description": "The state or region whose laws govern the agreement.",
- "type": "string"
- },
- "include_automated_payment_reminders": {
- "description": "When true, automatically sends payment reminder emails.",
- "type": "boolean"
- },
- "include_billing_info": {
- "description": "When true, billing contact information (billing_name, billing_email) is included.",
- "type": "boolean"
- },
- "include_billing_workflow": {
- "description": "When true, enables a billing workflow after signing.",
- "type": "boolean"
- },
- "include_expiration_date": {
- "description": "Expiration date in YYYY-MM-DD format. Use when include_expiration_type is \"date\".",
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "include_expiration_days": {
- "description": "Number of days until the agreement expires. Use when include_expiration_type is \"days\".",
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_expiration_type": {
- "description": "How to set expiration: \"none\" (default), \"days\" (use include_expiration_days), or \"date\" (use include_expiration_date).",
- "enum": [
- "none",
- "days",
- "date"
- ],
- "type": "string"
- },
- "include_terms": {
- "description": "When true, the standard terms are included with the agreement.",
- "type": "boolean"
- },
- "loi_attributes": {
- "additionalProperties": false,
- "description": "Override loi terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "confidentiality_custom": {
- "type": "string"
- },
- "confidentiality_mutual_include_loi": {
- "type": "boolean"
- },
- "confidentiality_nda_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "confidentiality_nda_description": {
- "type": "string"
- },
- "confidentiality_nda_include_loi": {
- "type": "boolean"
- },
- "confidentiality_nda_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "confidentiality_type": {
- "enum": [
- "mutual",
- "nda",
- "provider",
- "custom"
- ],
- "type": "string"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_custom_details": {
- "type": "boolean"
- },
- "include_custom_details_val": {
- "type": "string"
- },
- "include_fees": {
- "type": "boolean"
- },
- "include_fees_amount": {
- "type": "number"
- },
- "include_fees_amount_duration": {
- "enum": [
- "month",
- "year",
- "quarter"
- ],
- "type": "string"
- },
- "include_fees_include_amount": {
- "type": "boolean"
- },
- "include_fees_include_other": {
- "type": "boolean"
- },
- "include_fees_other": {
- "type": "string"
- },
- "include_functionality": {
- "type": "boolean"
- },
- "include_functionality_val": {
- "type": "string"
- },
- "include_launch_date": {
- "type": "boolean"
- },
- "include_launch_date_custom": {
- "type": "string"
- },
- "include_launch_date_date": {
- "format": "date-time",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$",
- "type": "string"
- },
- "include_launch_date_type": {
- "enum": [
- "date",
- "custom"
- ],
- "type": "string"
- },
- "product_name": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "manual_send": {
- "description": "When true, the agreement is marked as manually sent outside the platform.",
- "type": "boolean"
- },
- "message": {
- "type": "string"
- },
- "negotiations_allowed": {
- "description": "When true, the recipient can propose changes to the legal terms. For agreement types without separate business terms, that covers every term. CSA order forms, PSA statements of work, partnership business terms and software license order forms have their own `negotiations_allowed` flag.",
- "type": "boolean"
- },
- "partnership_attributes": {
- "additionalProperties": false,
- "description": "Override partnership terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "effective_date": {
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "effective_date_type": {
- "enum": [
- "signature",
- "date"
- ],
- "type": "string"
- },
- "general_cap_amount_currency_val": {
- "type": "number"
- },
- "general_cap_amount_either_currency": {
- "type": "number"
- },
- "general_cap_amount_either_multiple": {
- "type": "number"
- },
- "general_cap_amount_multiple_val": {
- "type": "number"
- },
- "general_cap_amount_type": {
- "enum": [
- "multiple",
- "currency",
- "either",
- "base"
- ],
- "type": "string"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_additional_warranties": {
- "type": "boolean"
- },
- "include_additional_warranties_include_company": {
- "type": "boolean"
- },
- "include_additional_warranties_include_company_val": {
- "type": "string"
- },
- "include_additional_warranties_include_partner": {
- "type": "boolean"
- },
- "include_additional_warranties_include_partner_val": {
- "type": "string"
- },
- "include_brand_guidelines": {
- "type": "boolean"
- },
- "include_brand_guidelines_include_company": {
- "type": "boolean"
- },
- "include_brand_guidelines_include_company_val": {
- "type": "string"
- },
- "include_brand_guidelines_include_partner": {
- "type": "boolean"
- },
- "include_brand_guidelines_include_partner_val": {
- "type": "string"
- },
- "include_covered_claims": {
- "type": "boolean"
- },
- "include_covered_claims_company_claims": {
- "type": "string"
- },
- "include_covered_claims_include_company_claims": {
- "type": "boolean"
- },
- "include_covered_claims_include_partner_claims": {
- "type": "boolean"
- },
- "include_covered_claims_partner_claims": {
- "type": "string"
- },
- "include_dpa": {
- "type": "boolean"
- },
- "include_dpa_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_dpa_location": {
- "type": "string"
- },
- "include_dpa_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_increased_cap_amount": {
- "type": "boolean"
- },
- "include_increased_cap_amount_currency": {
- "type": "number"
- },
- "include_increased_cap_amount_either_currency": {
- "type": "number"
- },
- "include_increased_cap_amount_either_multiple": {
- "type": "string"
- },
- "include_increased_cap_amount_multiple": {
- "type": "string"
- },
- "include_increased_cap_amount_type": {
- "enum": [
- "multiple",
- "currency",
- "either"
- ],
- "type": "string"
- },
- "include_increased_claims": {
- "type": "boolean"
- },
- "include_increased_claims_include_confidentiality": {
- "type": "boolean"
- },
- "include_increased_claims_include_confidentiality_misconduct": {
- "type": "boolean"
- },
- "include_increased_claims_include_covered_claims": {
- "type": "boolean"
- },
- "include_increased_claims_include_misconduct": {
- "type": "boolean"
- },
- "include_increased_claims_include_other": {
- "type": "boolean"
- },
- "include_increased_claims_include_other_val": {
- "type": "string"
- },
- "include_unlimited_claims": {
- "type": "boolean"
- },
- "include_unlimited_claims_confidentiality": {
- "type": "boolean"
- },
- "include_unlimited_claims_confidentiality_misconduct": {
- "type": "boolean"
- },
- "include_unlimited_claims_covered_claims": {
- "type": "boolean"
- },
- "include_unlimited_claims_misconduct": {
- "type": "boolean"
- },
- "include_unlimited_claims_other": {
- "type": "boolean"
- },
- "include_unlimited_claims_other_val": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "partnership_business_terms_attributes": {
- "additionalProperties": false,
- "description": "Override partnership business terms terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "end_date_after_effective_date_amount": {
- "type": "number"
- },
- "end_date_after_effective_date_unit": {
- "enum": [
- "month(s)",
- "quarter(s)",
- "year(s)"
- ],
- "type": "string"
- },
- "end_date_date": {
- "type": "string"
- },
- "end_date_type": {
- "enum": [
- "date",
- "effective date"
- ],
- "type": "string"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_obligations_company_brand": {
- "type": "boolean"
- },
- "include_obligations_company_promotion": {
- "type": "boolean"
- },
- "include_obligations_company_promotion_include_activities": {
- "type": "boolean"
- },
- "include_obligations_company_promotion_include_activities_val": {
- "type": "string"
- },
- "include_obligations_company_promotion_include_materials": {
- "type": "boolean"
- },
- "include_obligations_company_promotion_include_materials_val": {
- "type": "string"
- },
- "include_obligations_company_referral": {
- "type": "boolean"
- },
- "include_obligations_company_referral_include_criteria": {
- "type": "boolean"
- },
- "include_obligations_company_referral_include_criteria_val": {
- "type": "string"
- },
- "include_obligations_company_referral_include_pay_sch": {
- "type": "boolean"
- },
- "include_obligations_company_referral_include_pay_sch_amount": {
- "type": "number"
- },
- "include_obligations_company_referral_include_pay_sch_custom": {
- "type": "string"
- },
- "include_obligations_company_referral_include_pay_sch_unit": {
- "enum": [
- "U.S. Dollars",
- "percent"
- ],
- "type": "string"
- },
- "include_obligations_company_sponsorship": {
- "type": "boolean"
- },
- "include_obligations_company_sponsorship_include_benefits": {
- "type": "boolean"
- },
- "include_obligations_company_sponsorship_include_benefits_val": {
- "type": "string"
- },
- "include_obligations_company_sponsorship_include_payments": {
- "type": "boolean"
- },
- "include_obligations_company_sponsorship_include_payments_amount": {
- "type": "number"
- },
- "include_obligations_company_sponsorship_include_payments_unit": {
- "enum": [
- "U.S. Dollars",
- "percent"
- ],
- "type": "string"
- },
- "include_obligations_partner_brand": {
- "type": "boolean"
- },
- "include_obligations_partner_promotion": {
- "type": "boolean"
- },
- "include_obligations_partner_promotion_include_activities": {
- "type": "boolean"
- },
- "include_obligations_partner_promotion_include_activities_val": {
- "type": "string"
- },
- "include_obligations_partner_promotion_include_materials": {
- "type": "boolean"
- },
- "include_obligations_partner_promotion_include_materials_val": {
- "type": "string"
- },
- "include_obligations_partner_referral": {
- "type": "boolean"
- },
- "include_obligations_partner_referral_include_criteria": {
- "type": "boolean"
- },
- "include_obligations_partner_referral_include_criteria_val": {
- "type": "string"
- },
- "include_obligations_partner_referral_include_pay_sch": {
- "type": "boolean"
- },
- "include_obligations_partner_referral_include_pay_sch_amount": {
- "type": "number"
- },
- "include_obligations_partner_referral_include_pay_sch_custom": {
- "type": "string"
- },
- "include_obligations_partner_referral_include_pay_sch_unit": {
- "enum": [
- "U.S. Dollars",
- "percent"
- ],
- "type": "string"
- },
- "include_obligations_partner_sponsorship": {
- "type": "boolean"
- },
- "include_obligations_partner_sponsorship_include_benefits": {
- "type": "boolean"
- },
- "include_obligations_partner_sponsorship_include_benefits_val": {
- "type": "string"
- },
- "include_obligations_partner_sponsorship_include_payments": {
- "type": "boolean"
- },
- "include_obligations_partner_sponsorship_include_payments_amount": {
- "type": "number"
- },
- "include_obligations_partner_sponsorship_include_payments_unit": {
- "enum": [
- "U.S. Dollars",
- "percent"
- ],
- "type": "string"
- },
- "include_payment_process": {
- "type": "boolean"
- },
- "include_payment_process_company": {
- "type": "boolean"
- },
- "include_payment_process_company_include_address": {
- "type": "boolean"
- },
- "include_payment_process_company_include_address_city": {
- "type": "string"
- },
- "include_payment_process_company_include_address_country": {
- "type": "string"
- },
- "include_payment_process_company_include_address_state": {
- "type": "string"
- },
- "include_payment_process_company_include_address_street_address": {
- "type": "string"
- },
- "include_payment_process_company_include_address_zipcode": {
- "type": "string"
- },
- "include_payment_process_company_include_email": {
- "type": "boolean"
- },
- "include_payment_process_company_include_email_val": {
- "type": "string"
- },
- "include_payment_process_partner": {
- "type": "boolean"
- },
- "include_payment_process_partner_include_address": {
- "type": "boolean"
- },
- "include_payment_process_partner_include_address_city": {
- "type": "string"
- },
- "include_payment_process_partner_include_address_country": {
- "type": "string"
- },
- "include_payment_process_partner_include_address_state": {
- "type": "string"
- },
- "include_payment_process_partner_include_address_street_address": {
- "type": "string"
- },
- "include_payment_process_partner_include_address_zipcode": {
- "type": "string"
- },
- "include_payment_process_partner_include_email": {
- "type": "boolean"
- },
- "include_payment_process_partner_include_email_val": {
- "type": "string"
- },
- "include_payment_schedule": {
- "type": "boolean"
- },
- "include_payment_schedule_custom": {
- "type": "string"
- },
- "include_payment_schedule_specified_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_payment_schedule_specified_timeframe": {
- "enum": [
- "receipt",
- "date"
- ],
- "type": "string"
- },
- "include_payment_schedule_specified_unit": {
- "enum": [
- "day(s)",
- "week(s)",
- "month(s)",
- "quarter(s)",
- "year(s)"
- ],
- "type": "string"
- },
- "include_payment_schedule_type": {
- "enum": [
- "specified",
- "custom"
- ],
- "type": "string"
- },
- "negotiations_allowed": {
- "description": "When true, the recipient can propose changes to the business terms, even when the agreement-level `negotiations_allowed` is false. This only covers the business terms.",
- "type": "boolean"
- },
- "territory_type": {
- "enum": [
- "worldwide",
- "custom"
- ],
- "type": "string"
- },
- "territory_type_val": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "payment_link_url": {
- "description": "A payment URL shown to the recipient after signing. Requires include_billing_workflow to be true and billing_workflow_type to be \"link\".",
- "type": "string"
- },
- "pilot_attributes": {
- "additionalProperties": false,
- "description": "Override pilot terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "fees_type": {
- "enum": [
- "free",
- "pilot_period_fees"
- ],
- "type": "string"
- },
- "general_cap_amount": {
- "type": "number"
- },
- "general_cap_amount_type": {
- "enum": [
- "preceding",
- "base",
- "period"
- ],
- "type": "string"
- },
- "general_cap_period_currency": {
- "type": "number"
- },
- "general_cap_period_qty": {
- "type": "number"
- },
- "general_cap_preceding_amount": {
- "type": "number"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_dpa": {
- "type": "boolean"
- },
- "include_dpa_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_dpa_location": {
- "type": "string"
- },
- "include_dpa_type": {
- "enum": [
- "description",
- "attachment",
- "standard"
- ],
- "type": "string"
- },
- "include_payment_process": {
- "type": "boolean"
- },
- "include_technical_support": {
- "type": "boolean"
- },
- "payment_process_automatic_frequency": {
- "enum": [
- "monthly",
- "quarterly",
- "annually",
- "once_per_period"
- ],
- "type": "string"
- },
- "payment_process_invoice_days": {
- "type": "number"
- },
- "payment_process_invoice_from": {
- "enum": [
- "receipt",
- "date"
- ],
- "type": "string"
- },
- "payment_process_invoice_timeframe": {
- "enum": [
- "days",
- "weeks",
- "months",
- "quarters",
- "years"
- ],
- "type": "string"
- },
- "payment_process_type": {
- "enum": [
- "automatic",
- "invoice"
- ],
- "type": "string"
- },
- "pilot_period_description": {
- "type": "string"
- },
- "pilot_period_fees_description": {
- "type": "string"
- },
- "product_description": {
- "type": "string"
- },
- "technical_support_description": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "psa_attributes": {
- "additionalProperties": false,
- "description": "Override psa terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "additional_changes": {
- "type": "string"
- },
- "customer_description": {
- "type": "string"
- },
- "effective_date": {
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "effective_date_type": {
- "enum": [
- "signature",
- "date"
- ],
- "type": "string"
- },
- "general_cap_amount": {
- "type": "number"
- },
- "general_cap_amount_type": {
- "enum": [
- "preceding",
- "base",
- "period"
- ],
- "type": "string"
- },
- "general_cap_period_currency": {
- "type": "number"
- },
- "general_cap_period_qty": {
- "type": "number"
- },
- "general_cap_preceding_amount": {
- "type": "number"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_additional_changes": {
- "type": "boolean"
- },
- "include_additional_warranties": {
- "type": "boolean"
- },
- "include_additional_warranties_by_customer": {
- "type": "string"
- },
- "include_additional_warranties_by_provider": {
- "type": "string"
- },
- "include_additional_warranties_include_by_customer": {
- "type": "boolean"
- },
- "include_additional_warranties_include_by_provider": {
- "type": "boolean"
- },
- "include_covered_claims": {
- "type": "boolean"
- },
- "include_covered_claims_customer_claims": {
- "type": "string"
- },
- "include_covered_claims_include_customer_claims": {
- "type": "boolean"
- },
- "include_covered_claims_include_provider_claims": {
- "type": "boolean"
- },
- "include_covered_claims_provider_claims": {
- "type": "string"
- },
- "include_customer_insurance_min": {
- "type": "boolean"
- },
- "include_customer_insurance_min_add_provider_com_gen_liability": {
- "type": "boolean"
- },
- "include_customer_insurance_min_add_provider_cyber_liability": {
- "type": "boolean"
- },
- "include_customer_insurance_min_add_provider_errors_omissions": {
- "type": "boolean"
- },
- "include_customer_insurance_min_auto_liability_aggregate": {
- "type": "number"
- },
- "include_customer_insurance_min_auto_liability_minimum": {
- "type": "number"
- },
- "include_customer_insurance_min_cyber_liability_aggregate": {
- "type": "number"
- },
- "include_customer_insurance_min_cyber_liability_minimum": {
- "type": "number"
- },
- "include_customer_insurance_min_employer_liability_aggregate": {
- "type": "number"
- },
- "include_customer_insurance_min_employer_liability_minimum": {
- "type": "number"
- },
- "include_customer_insurance_min_general_liability_aggregate": {
- "type": "number"
- },
- "include_customer_insurance_min_general_liability_minimum": {
- "type": "number"
- },
- "include_customer_insurance_min_include_add_provider": {
- "type": "boolean"
- },
- "include_customer_insurance_min_include_auto_liability": {
- "type": "boolean"
- },
- "include_customer_insurance_min_include_cyber_liability": {
- "type": "boolean"
- },
- "include_customer_insurance_min_include_employer_liability": {
- "type": "boolean"
- },
- "include_customer_insurance_min_include_general_liability": {
- "type": "boolean"
- },
- "include_customer_insurance_min_include_workers_comp": {
- "type": "boolean"
- },
- "include_customer_policies": {
- "type": "boolean"
- },
- "include_customer_policies_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_customer_policies_location": {
- "type": "string"
- },
- "include_customer_policies_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_dpa": {
- "type": "boolean"
- },
- "include_dpa_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_dpa_location": {
- "type": "string"
- },
- "include_dpa_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_increased_cap_amount": {
- "type": "boolean"
- },
- "include_increased_claims": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_confidentiality": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_confidentiality_negligence": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_privsec": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_privsec_negligence": {
- "type": "boolean"
- },
- "include_increased_claims_include_other": {
- "type": "boolean"
- },
- "include_increased_claims_indemnification_obligation": {
- "type": "boolean"
- },
- "include_increased_claims_negligence": {
- "type": "boolean"
- },
- "include_increased_claims_other": {
- "type": "string"
- },
- "include_provider_insurance_min": {
- "type": "boolean"
- },
- "include_provider_insurance_min_add_customer_com_gen_liability": {
- "type": "boolean"
- },
- "include_provider_insurance_min_add_customer_cyber_liability": {
- "type": "boolean"
- },
- "include_provider_insurance_min_add_customer_errors_omissions": {
- "type": "boolean"
- },
- "include_provider_insurance_min_auto_liability_aggregate": {
- "type": "number"
- },
- "include_provider_insurance_min_auto_liability_minimum": {
- "type": "number"
- },
- "include_provider_insurance_min_cyber_liability_aggregate": {
- "type": "number"
- },
- "include_provider_insurance_min_cyber_liability_minimum": {
- "type": "number"
- },
- "include_provider_insurance_min_employer_liability_aggregate": {
- "type": "number"
- },
- "include_provider_insurance_min_employer_liability_minimum": {
- "type": "number"
- },
- "include_provider_insurance_min_general_liability_aggregate": {
- "type": "number"
- },
- "include_provider_insurance_min_general_liability_minimum": {
- "type": "number"
- },
- "include_provider_insurance_min_include_add_customer": {
- "type": "boolean"
- },
- "include_provider_insurance_min_include_auto_liability": {
- "type": "boolean"
- },
- "include_provider_insurance_min_include_cyber_liability": {
- "type": "boolean"
- },
- "include_provider_insurance_min_include_employer_liability": {
- "type": "boolean"
- },
- "include_provider_insurance_min_include_general_liability": {
- "type": "boolean"
- },
- "include_provider_insurance_min_include_workers_comp": {
- "type": "boolean"
- },
- "include_publicity_rights": {
- "type": "boolean"
- },
- "include_publicity_rights_type": {
- "enum": [
- "public",
- "non-public"
- ],
- "type": "string"
- },
- "include_security_policy": {
- "type": "boolean"
- },
- "include_security_policy_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_security_policy_fedramp_auth": {
- "type": "boolean"
- },
- "include_security_policy_hitrust": {
- "type": "boolean"
- },
- "include_security_policy_include_annual_maintenance": {
- "type": "boolean"
- },
- "include_security_policy_include_other": {
- "type": "boolean"
- },
- "include_security_policy_include_other_val": {
- "type": "string"
- },
- "include_security_policy_iso27001": {
- "type": "boolean"
- },
- "include_security_policy_location": {
- "type": "string"
- },
- "include_security_policy_pci1": {
- "type": "boolean"
- },
- "include_security_policy_pci2": {
- "type": "boolean"
- },
- "include_security_policy_penetration_testing": {
- "type": "boolean"
- },
- "include_security_policy_soc2_type1": {
- "type": "boolean"
- },
- "include_security_policy_soc2_type2": {
- "type": "boolean"
- },
- "include_security_policy_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_unlimited_claims": {
- "type": "boolean"
- },
- "include_unlimited_claims_breach_of_confidentiality": {
- "type": "boolean"
- },
- "include_unlimited_claims_breach_of_confidentiality_negligence": {
- "type": "boolean"
- },
- "include_unlimited_claims_breach_of_privsec": {
- "type": "boolean"
- },
- "include_unlimited_claims_breach_of_privsec_negligence": {
- "type": "boolean"
- },
- "include_unlimited_claims_include_other": {
- "type": "boolean"
- },
- "include_unlimited_claims_indemnification_obligation": {
- "type": "boolean"
- },
- "include_unlimited_claims_negligence": {
- "type": "boolean"
- },
- "include_unlimited_claims_other": {
- "type": "string"
- },
- "increased_cap_amount_currency": {
- "type": "number"
- },
- "increased_cap_amount_period_currency": {
- "type": "number"
- },
- "increased_cap_amount_period_qty": {
- "type": "number"
- },
- "increased_cap_amount_qty": {
- "type": "number"
- },
- "increased_cap_amount_type": {
- "enum": [
- "qty",
- "currency",
- "period"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- "psa_statement_of_work_attributes": {
- "additionalProperties": false,
- "description": "Override psa statement of work terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "additional_changes": {
- "type": "string"
- },
- "cost": {
- "type": "number"
- },
- "description": {
- "type": "string"
- },
- "fee_type": {
- "type": "string"
- },
- "fees_attributes": {
- "additionalProperties": {
- "anyOf": [
- {
- "additionalProperties": false,
- "description": "Fees::Flat (fee_type \"flat\"). A fixed recurring fee, e.g. a platform subscription. Set type to \"Fees::Flat\" or fee_type to \"flat\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "Fixed amount in the order form's fees_currency, charged per fee_period. A plain amount, not cents: 20 means 20.00.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"flat\". Alternative to type.",
- "enum": [
- "flat"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Flat\". Optional when fee_type is set.",
- "enum": [
- "Fees::Flat"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Discount (fee_type \"discount\"). A discount, as a fixed amount or a percentage, applied forever, once, or for a number of months. Set type to \"Fees::Discount\" or fee_type to \"discount\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "Discount size: an amount in fees_currency when discount_type is fixed_amount (a plain amount, not cents: 20 means 20.00), or a percentage (e.g. 10 for 10%) when it is percentage.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "discount_duration_amount": {
- "description": "Number of months the discount applies. Required when discount_duration_type is multiple_months.",
- "type": "number"
- },
- "discount_duration_type": {
- "description": "How long the discount applies. multiple_months also needs discount_duration_amount.",
- "enum": [
- "forever",
- "once",
- "multiple_months"
- ],
- "type": "string"
- },
- "discount_type": {
- "description": "Whether cost is a currency amount or a percentage.",
- "enum": [
- "fixed_amount",
- "percentage"
- ],
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"discount\". Alternative to type.",
- "enum": [
- "discount"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Discount\". Optional when fee_type is set.",
- "enum": [
- "Fees::Discount"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Cost (fee_type \"cost\"). A per-unit fee: price per unit times quantity, e.g. seats. Set type to \"Fees::Cost\" or fee_type to \"cost\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "Price per unit in fees_currency. The row total is quantity x cost. A plain amount, not cents: 20 means 20.00.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"cost\". Alternative to type.",
- "enum": [
- "cost"
- ],
- "type": "string"
- },
- "quantity": {
- "description": "Number of units.",
- "type": "number"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Cost\". Optional when fee_type is set.",
- "enum": [
- "Fees::Cost"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Attachment (fee_type \"attachment\"). A fee described in an uploaded attachment instead of in the table. Set type to \"Fees::Attachment\" or fee_type to \"attachment\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "attachment_id": {
- "description": "ID of an attachment uploaded with upload-attachment.",
- "type": "string"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"attachment\". Alternative to type.",
- "enum": [
- "attachment"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Attachment\". Optional when fee_type is set.",
- "enum": [
- "Fees::Attachment"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Graduated (fee_type \"graduated\"). Tiered pricing, with the price set per tier in graduated_fee_tiers_attributes. Set type to \"Fees::Graduated\" or fee_type to \"graduated\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"graduated\". Alternative to type.",
- "enum": [
- "graduated"
- ],
- "type": "string"
- },
- "graduated_fee_tiers_attributes": {
- "additionalProperties": {
- "additionalProperties": false,
- "properties": {
- "flat_price": {
- "type": "number"
- },
- "price_per_unit": {
- "type": "string"
- },
- "upper_limit": {
- "type": "number"
- }
- },
- "type": "object"
- },
- "description": "Graduated fee tiers. Use string keys such as \"0\", \"1\".",
- "propertyNames": {
- "type": "string"
- },
- "type": "object"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Graduated\". Optional when fee_type is set.",
- "enum": [
- "Fees::Graduated"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Included (fee_type \"included\"). An item included at no charge. Set type to \"Fees::Included\" or fee_type to \"included\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"included\". Alternative to type.",
- "enum": [
- "included"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Included\". Optional when fee_type is set.",
- "enum": [
- "Fees::Included"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Metered (fee_type \"metered\"). Usage-based pricing, billed per unit used. Set type to \"Fees::Metered\" or fee_type to \"metered\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "Price per unit of usage in fees_currency. A plain amount, not cents: 20 means 20.00.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"metered\". Alternative to type.",
- "enum": [
- "metered"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Metered\". Optional when fee_type is set.",
- "enum": [
- "Fees::Metered"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::OneTime (fee_type \"one_time\"). A one-time charge, such as a setup fee. Set type to \"Fees::OneTime\" or fee_type to \"one_time\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "One-time amount in fees_currency, charged once rather than per fee_period. A plain amount, not cents: 20 means 20.00.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"one_time\". Alternative to type.",
- "enum": [
- "one_time"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::OneTime\". Optional when fee_type is set.",
- "enum": [
- "Fees::OneTime"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Text (fee_type \"text\"). A fee term described in free text. Set type to \"Fees::Text\" or fee_type to \"text\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"text\". Alternative to type.",
- "enum": [
- "text"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Text\". Optional when fee_type is set.",
- "enum": [
- "Fees::Text"
- ],
- "type": "string"
- }
- },
- "type": "object"
- }
- ]
- },
- "description": "Fee line items. Use string keys such as \"0\", \"1\". Replaces template fees when provided.",
- "propertyNames": {
- "type": "string"
- },
- "type": "object"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_additional_changes": {
- "type": "boolean"
- },
- "include_customer_obligation": {
- "type": "boolean"
- },
- "include_customer_obligation_val": {
- "type": "string"
- },
- "include_deliverables": {
- "type": "boolean"
- },
- "include_deliverables_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_deliverables_description": {
- "type": "string"
- },
- "include_deliverables_include_acceptance": {
- "type": "boolean"
- },
- "include_deliverables_include_attachment": {
- "type": "boolean"
- },
- "include_deliverables_include_draft_deliverables": {
- "type": "boolean"
- },
- "include_deliverables_rejection_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_deliverables_rejection_unit": {
- "enum": [
- "hours",
- "days",
- "weeks",
- "months"
- ],
- "type": "string"
- },
- "include_deliverables_resubmission_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_deliverables_resubmission_unit": {
- "enum": [
- "hours",
- "days",
- "weeks",
- "months"
- ],
- "type": "string"
- },
- "include_fees_other": {
- "type": "boolean"
- },
- "include_fees_other_val": {
- "type": "string"
- },
- "include_fees_table": {
- "type": "boolean"
- },
- "include_fees_table_total": {
- "type": "boolean"
- },
- "include_fees_travel": {
- "type": "boolean"
- },
- "include_fees_travel_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_fees_travel_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_fees_travel_val": {
- "type": "string"
- },
- "include_third_party_customer": {
- "type": "boolean"
- },
- "include_third_party_include_description": {
- "type": "boolean"
- },
- "include_third_party_include_description_val": {
- "type": "string"
- },
- "include_third_party_materials": {
- "type": "boolean"
- },
- "include_third_party_provider": {
- "type": "boolean"
- },
- "include_time_of_assignment": {
- "type": "boolean"
- },
- "include_time_of_assignment_type": {
- "enum": [
- "created",
- "paid"
- ],
- "type": "string"
- },
- "invoice_period_description": {
- "type": "string"
- },
- "negotiations_allowed": {
- "description": "When true, the recipient can propose changes to the statement of work, even when the agreement-level `negotiations_allowed` is false. This only covers the statement of work.",
- "type": "boolean"
- },
- "payment_period": {
- "type": "number"
- },
- "payment_period_other": {
- "type": "string"
- },
- "payment_period_timeframe": {
- "enum": [
- "receipt",
- "invoice",
- "Customer's receipt of invoice",
- "date of invoice"
- ],
- "type": "string"
- },
- "payment_period_type": {
- "enum": [
- "standard",
- "other"
- ],
- "type": "string"
- },
- "payment_period_unit": {
- "enum": [
- "day(s)",
- "week(s)",
- "month(s)",
- "quarter(s)",
- "year(s)"
- ],
- "type": "string"
- },
- "quantity": {
- "type": "number"
- },
- "services_description": {
- "type": "string"
- },
- "sow_date": {
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "sow_date_type": {
- "enum": [
- "signature",
- "date"
- ],
- "type": "string"
- },
- "sow_term_amount": {
- "type": "number"
- },
- "sow_term_date": {
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "sow_term_type": {
- "enum": [
- "deliverables",
- "period",
- "date"
- ],
- "type": "string"
- },
- "sow_term_unit": {
- "enum": [
- "month(s)",
- "quarter(s)",
- "year(s)"
- ],
- "type": "string"
- },
- "type": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "recipient_email": {
- "format": "email",
- "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
- "type": "string"
- },
- "recipient_name": {
- "type": "string"
- },
- "recipient_notice_email_address": {
- "description": "Email address for legal notices to the recipient.",
- "format": "email",
- "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
- "type": "string"
- },
- "recipient_organization": {
- "type": "string"
- },
- "sender_last_to_sign": {
- "description": "When true, your signer signs after the recipient.",
- "type": "boolean"
- },
- "sender_notice_email_address": {
- "description": "Email address for legal notices to the sender.",
- "format": "email",
- "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
- "type": "string"
- },
- "software_license_attributes": {
- "additionalProperties": false,
- "description": "Override software license terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "effective_date": {
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "effective_date_type": {
- "enum": [
- "signature",
- "date"
- ],
- "type": "string"
- },
- "general_cap_amount": {
- "type": "number"
- },
- "general_cap_amount_type": {
- "enum": [
- "preceding",
- "base",
- "period"
- ],
- "type": "string"
- },
- "general_cap_period_currency": {
- "type": "number"
- },
- "general_cap_period_qty": {
- "type": "number"
- },
- "general_cap_preceding_amount": {
- "type": "number"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_additional_warranties": {
- "type": "boolean"
- },
- "include_additional_warranties_by_customer": {
- "type": "string"
- },
- "include_additional_warranties_by_provider": {
- "type": "string"
- },
- "include_additional_warranties_include_by_customer": {
- "type": "boolean"
- },
- "include_additional_warranties_include_by_provider": {
- "type": "boolean"
- },
- "include_ai_addendum": {
- "type": "boolean"
- },
- "include_ai_addendum_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_covered_claims": {
- "type": "boolean"
- },
- "include_covered_claims_customer_claims": {
- "type": "string"
- },
- "include_covered_claims_include_customer_claims": {
- "type": "boolean"
- },
- "include_covered_claims_include_provider_claims": {
- "type": "boolean"
- },
- "include_covered_claims_provider_claims": {
- "type": "string"
- },
- "include_dpa": {
- "type": "boolean"
- },
- "include_dpa_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_dpa_location": {
- "type": "string"
- },
- "include_dpa_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_increased_cap_amount": {
- "type": "boolean"
- },
- "include_increased_claims": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_confidentiality": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_confidentiality_negligence": {
- "type": "boolean"
- },
- "include_increased_claims_include_other": {
- "type": "boolean"
- },
- "include_increased_claims_indemnification_obligation": {
- "type": "boolean"
- },
- "include_increased_claims_negligence": {
- "type": "boolean"
- },
- "include_increased_claims_other": {
- "type": "string"
- },
- "include_increased_claims_restrictions": {
- "type": "boolean"
- },
- "include_unlimited_claims": {
- "type": "boolean"
- },
- "include_unlimited_claims_breach_of_confidentiality": {
- "type": "boolean"
- },
- "include_unlimited_claims_breach_of_confidentiality_negligence": {
- "type": "boolean"
- },
- "include_unlimited_claims_include_other": {
- "type": "boolean"
- },
- "include_unlimited_claims_indemnification_obligation": {
- "type": "boolean"
- },
- "include_unlimited_claims_license_or_restrictions": {
- "type": "boolean"
- },
- "include_unlimited_claims_negligence": {
- "type": "boolean"
- },
- "include_unlimited_claims_other": {
- "type": "string"
- },
- "increased_cap_amount_currency": {
- "type": "number"
- },
- "increased_cap_amount_period_currency": {
- "type": "number"
- },
- "increased_cap_amount_period_qty": {
- "type": "number"
- },
- "increased_cap_amount_qty": {
- "type": "number"
- },
- "increased_cap_amount_type": {
- "enum": [
- "qty",
- "currency",
- "period"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- "software_license_order_form_attributes": {
- "additionalProperties": false,
- "description": "Override software license order form terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "additional_changes": {
- "type": "string"
- },
- "deletion_procedure_include_custom": {
- "type": "boolean"
- },
- "deletion_procedure_include_custom_description": {
- "type": "string"
- },
- "deletion_procedure_include_customer_disable": {
- "type": "boolean"
- },
- "deletion_procedure_include_customer_proof": {
- "type": "boolean"
- },
- "deletion_procedure_include_provider_disable": {
- "type": "boolean"
- },
- "fee_custom_unit": {
- "type": "string"
- },
- "fee_period": {
- "enum": [
- "Subscription Period",
- "month",
- "year",
- "Custom unit"
- ],
- "type": "string"
- },
- "fees_attributes": {
- "additionalProperties": {
- "anyOf": [
- {
- "additionalProperties": false,
- "description": "Fees::Flat (fee_type \"flat\"). A fixed recurring fee, e.g. a platform subscription. Set type to \"Fees::Flat\" or fee_type to \"flat\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "Fixed amount in the order form's fees_currency, charged per fee_period. A plain amount, not cents: 20 means 20.00.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"flat\". Alternative to type.",
- "enum": [
- "flat"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Flat\". Optional when fee_type is set.",
- "enum": [
- "Fees::Flat"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Discount (fee_type \"discount\"). A discount, as a fixed amount or a percentage, applied forever, once, or for a number of months. Set type to \"Fees::Discount\" or fee_type to \"discount\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "Discount size: an amount in fees_currency when discount_type is fixed_amount (a plain amount, not cents: 20 means 20.00), or a percentage (e.g. 10 for 10%) when it is percentage.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "discount_duration_amount": {
- "description": "Number of months the discount applies. Required when discount_duration_type is multiple_months.",
- "type": "number"
- },
- "discount_duration_type": {
- "description": "How long the discount applies. multiple_months also needs discount_duration_amount.",
- "enum": [
- "forever",
- "once",
- "multiple_months"
- ],
- "type": "string"
- },
- "discount_type": {
- "description": "Whether cost is a currency amount or a percentage.",
- "enum": [
- "fixed_amount",
- "percentage"
- ],
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"discount\". Alternative to type.",
- "enum": [
- "discount"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Discount\". Optional when fee_type is set.",
- "enum": [
- "Fees::Discount"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Cost (fee_type \"cost\"). A per-unit fee: price per unit times quantity, e.g. seats. Set type to \"Fees::Cost\" or fee_type to \"cost\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "Price per unit in fees_currency. The row total is quantity x cost. A plain amount, not cents: 20 means 20.00.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"cost\". Alternative to type.",
- "enum": [
- "cost"
- ],
- "type": "string"
- },
- "quantity": {
- "description": "Number of units.",
- "type": "number"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Cost\". Optional when fee_type is set.",
- "enum": [
- "Fees::Cost"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Attachment (fee_type \"attachment\"). A fee described in an uploaded attachment instead of in the table. Set type to \"Fees::Attachment\" or fee_type to \"attachment\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "attachment_id": {
- "description": "ID of an attachment uploaded with upload-attachment.",
- "type": "string"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"attachment\". Alternative to type.",
- "enum": [
- "attachment"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Attachment\". Optional when fee_type is set.",
- "enum": [
- "Fees::Attachment"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Graduated (fee_type \"graduated\"). Tiered pricing, with the price set per tier in graduated_fee_tiers_attributes. Set type to \"Fees::Graduated\" or fee_type to \"graduated\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"graduated\". Alternative to type.",
- "enum": [
- "graduated"
- ],
- "type": "string"
- },
- "graduated_fee_tiers_attributes": {
- "additionalProperties": {
- "additionalProperties": false,
- "properties": {
- "flat_price": {
- "type": "number"
- },
- "price_per_unit": {
- "type": "string"
- },
- "upper_limit": {
- "type": "number"
- }
- },
- "type": "object"
- },
- "description": "Graduated fee tiers. Use string keys such as \"0\", \"1\".",
- "propertyNames": {
- "type": "string"
- },
- "type": "object"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Graduated\". Optional when fee_type is set.",
- "enum": [
- "Fees::Graduated"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Included (fee_type \"included\"). An item included at no charge. Set type to \"Fees::Included\" or fee_type to \"included\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"included\". Alternative to type.",
- "enum": [
- "included"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Included\". Optional when fee_type is set.",
- "enum": [
- "Fees::Included"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Metered (fee_type \"metered\"). Usage-based pricing, billed per unit used. Set type to \"Fees::Metered\" or fee_type to \"metered\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "Price per unit of usage in fees_currency. A plain amount, not cents: 20 means 20.00.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"metered\". Alternative to type.",
- "enum": [
- "metered"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Metered\". Optional when fee_type is set.",
- "enum": [
- "Fees::Metered"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::OneTime (fee_type \"one_time\"). A one-time charge, such as a setup fee. Set type to \"Fees::OneTime\" or fee_type to \"one_time\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "One-time amount in fees_currency, charged once rather than per fee_period. A plain amount, not cents: 20 means 20.00.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"one_time\". Alternative to type.",
- "enum": [
- "one_time"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::OneTime\". Optional when fee_type is set.",
- "enum": [
- "Fees::OneTime"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Text (fee_type \"text\"). A fee term described in free text. Set type to \"Fees::Text\" or fee_type to \"text\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"text\". Alternative to type.",
- "enum": [
- "text"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Text\". Optional when fee_type is set.",
- "enum": [
- "Fees::Text"
- ],
- "type": "string"
- }
- },
- "type": "object"
- }
- ]
- },
- "description": "Fee line items. Use string keys such as \"0\", \"1\". Replaces template fees when provided.",
- "propertyNames": {
- "type": "string"
- },
- "type": "object"
- },
- "fees_currency": {
- "enum": [
- "USD",
- "EUR",
- "GBP",
- "CAD",
- "AUD",
- "SGD",
- "ILS",
- "JPY",
- "CHF",
- "HKD"
- ],
- "type": "string"
- },
- "fees_include_fee_increase_upon_renewal": {
- "type": "boolean"
- },
- "fees_include_fee_increase_upon_renewal_fee": {
- "type": "number"
- },
- "fees_include_fee_increase_upon_renewal_type": {
- "enum": [
- "will",
- "may"
- ],
- "type": "string"
- },
- "fees_inclusive_of_taxes": {
- "type": "boolean"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_additional_changes": {
- "type": "boolean"
- },
- "include_license_compliance_verification": {
- "type": "boolean"
- },
- "include_license_compliance_verification_description": {
- "type": "string"
- },
- "include_license_limits": {
- "type": "boolean"
- },
- "include_license_limits_description": {
- "type": "string"
- },
- "include_payment_process_include_billing_email": {
- "type": "boolean"
- },
- "include_pilot_period": {
- "type": "boolean"
- },
- "include_pilot_period_duration_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_pilot_period_duration_type": {
- "enum": [
- "day",
- "week",
- "month"
- ],
- "type": "string"
- },
- "include_pilot_period_include_fees": {
- "type": "boolean"
- },
- "include_pilot_period_include_fees_amount": {
- "type": "number"
- },
- "include_pilot_period_include_modifications": {
- "type": "boolean"
- },
- "include_pilot_period_include_modifications_description": {
- "type": "string"
- },
- "include_services": {
- "type": "boolean"
- },
- "include_services_description": {
- "type": "string"
- },
- "negotiations_allowed": {
- "description": "When true, the recipient can propose changes to the order form, even when the agreement-level `negotiations_allowed` is false. This only covers the order form.",
- "type": "boolean"
- },
- "order_date_date": {
- "type": "string"
- },
- "order_date_type": {
- "enum": [
- "signature",
- "date",
- "other"
- ],
- "type": "string"
- },
- "payment_process_automatic_frequency": {
- "enum": [
- "monthly",
- "quarterly",
- "semiannually",
- "annually"
- ],
- "type": "string"
- },
- "payment_process_type": {
- "enum": [
- "automatic",
- "invoice",
- "custom"
- ],
- "type": "string"
- },
- "payment_process_type_custom_val": {
- "type": "string"
- },
- "payment_process_type_invoice_amount": {
- "type": "number"
- },
- "payment_process_type_invoice_custom_unit": {
- "type": "string"
- },
- "payment_process_type_invoice_duration": {
- "enum": [
- "day",
- "week",
- "month",
- "year",
- "day(s)",
- "week(s)",
- "month(s)",
- "year(s)"
- ],
- "type": "string"
- },
- "payment_process_type_invoice_duration_start": {
- "enum": [
- "Customer's receipt of invoice",
- "date of invoice"
- ],
- "type": "string"
- },
- "payment_process_type_invoice_type": {
- "enum": [
- "monthly",
- "quarterly",
- "semiannually",
- "annually",
- "Custom unit"
- ],
- "type": "string"
- },
- "permitted_uses_include_custom": {
- "type": "boolean"
- },
- "permitted_uses_include_custom_description": {
- "type": "string"
- },
- "permitted_uses_include_customers_affiliates": {
- "type": "boolean"
- },
- "permitted_uses_include_internal_business": {
- "type": "boolean"
- },
- "pilot_period_stripe_product_id": {
- "type": "string"
- },
- "software_description": {
- "type": "string"
- },
- "subscription_auto_renew": {
- "enum": [
- "days",
- "subscription_end"
- ],
- "type": "string"
- },
- "subscription_period": {
- "type": "number"
- },
- "subscription_period_unit": {
- "type": "string"
- },
- "subscription_renewal_notice_days": {
- "type": "number"
- },
- "warranty_period_description_amount": {
- "type": "number"
- },
- "warranty_period_description_duration": {
- "enum": [
- "day",
- "week",
- "month",
- "year"
- ],
- "type": "string"
- },
- "warranty_period_description_duration_start": {
- "enum": [
- "initial delivery of the Software",
- "delivery of the Software and each subsequent Update",
- "the Order Date"
- ],
- "type": "string"
- },
- "warranty_period_type": {
- "enum": [
- "description",
- "none"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- "test_agreement": {
- "description": "When true, marks the agreement as a test. Test agreements do not count against your monthly limit.",
- "type": "boolean"
- }
- },
- "required": [
- "recipient_name",
- "recipient_email"
- ],
- "type": "object"
- },
- "cc_users": {
- "items": {
- "format": "email",
- "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
- "type": "string"
- },
- "type": "array"
- },
- "draft": {
- "description": "When true, the agreement is saved as a draft and not sent to the recipient. Use POST /v1/agreements/{id}/send to send a draft agreement later.",
- "type": "boolean"
- },
- "owner_id": {
- "description": "User id of the agreement owner (sender).",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "signer_email": {
- "description": "Email address of the signer from the owner's organization.",
- "format": "email",
- "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
- "type": "string"
- },
- "template_id": {
- "description": "UUID of a template from `GET /v1/templates`. Accepts both Common Paper standard templates and uploaded PDF templates (`type` `uploaded_template`).",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- }
- },
- "required": [
- "template_id",
- "owner_id",
- "signer_email",
- "agreement"
- ],
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "agreement": {
- "additionalProperties": {},
- "properties": {
- "amendment_attributes": {
- "additionalProperties": false,
- "description": "Override amendment terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "amended_terms_attributes": {
- "additionalProperties": {
- "additionalProperties": false,
- "properties": {
- "description": {
- "type": "string"
- },
- "term": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "description": "Amended terms. Use string keys such as \"0\", \"1\".",
- "propertyNames": {
- "type": "string"
- },
- "type": "object"
- },
- "amendment_date": {
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "amendment_date_type": {
- "enum": [
- "signature",
- "date"
- ],
- "type": "string"
- },
- "framework_terms_type": {
- "type": "string"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "parent_agreement_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "underlying_agreement_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "underlying_agreement_type": {
- "type": "string"
- },
- "underlying_agreement_val": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "baa_attributes": {
- "additionalProperties": false,
- "description": "Override baa terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "aggregation_limitations_permitted": {
- "type": "boolean"
- },
- "aggregation_limitations_permitted_val": {
- "type": "string"
- },
- "breach_notification_unit": {
- "enum": [
- "hours",
- "business days",
- "calendar days"
- ],
- "type": "string"
- },
- "breach_notification_val": {
- "type": "number"
- },
- "business_associate_relationship_type": {
- "enum": [
- "provider",
- "company"
- ],
- "type": "string"
- },
- "deidentification_limitations_include_purpose": {
- "type": "boolean"
- },
- "deidentification_limitations_include_requirements": {
- "type": "boolean"
- },
- "deidentification_limitations_permitted": {
- "type": "boolean"
- },
- "deidentification_limitations_purpose_val": {
- "type": "string"
- },
- "deidentification_limitations_requirements_val": {
- "type": "string"
- },
- "designated_record_set_provider_maintains": {
- "type": "boolean"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_aggregation_limitations": {
- "type": "boolean"
- },
- "include_deidentification_limitations": {
- "type": "boolean"
- },
- "include_limitations": {
- "type": "boolean"
- },
- "include_offshore_limitations": {
- "type": "boolean"
- },
- "include_subcontract_limitations": {
- "type": "boolean"
- },
- "offshore_limitations_permitted": {
- "type": "boolean"
- },
- "offshore_limitations_permitted_val": {
- "type": "string"
- },
- "subcontract_limitations_include_notice": {
- "type": "boolean"
- },
- "subcontract_limitations_include_permission": {
- "type": "boolean"
- },
- "subcontract_limitations_notice_val": {
- "type": "string"
- },
- "subcontract_limitations_permission_val": {
- "type": "string"
- },
- "subcontract_limitations_permitted": {
- "type": "boolean"
- },
- "underlying_agreement_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "underlying_agreement_type": {
- "enum": [
- "internal",
- "external",
- "none"
- ],
- "type": "string"
- },
- "underlying_agreement_val": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "billing_email": {
- "description": "Email of the billing contact. Used when include_billing_info is true.",
- "format": "email",
- "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
- "type": "string"
- },
- "billing_name": {
- "description": "Name of the billing contact. Used when include_billing_info is true.",
- "type": "string"
- },
- "billing_workflow_type": {
- "description": "The type of billing workflow. Use \"link\" to provide a payment_link_url, or \"stripe\" for Stripe-managed billing.",
- "enum": [
- "link",
- "stripe"
- ],
- "type": "string"
- },
- "chosen_courts_country": {
- "description": "The country in which disputes will be resolved.",
- "type": "string"
- },
- "chosen_courts_region": {
- "description": "The state or region in which disputes will be resolved.",
- "type": "string"
- },
- "csa_attributes": {
- "additionalProperties": false,
- "description": "Override csa terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "customer_description": {
- "type": "string"
- },
- "effective_date": {
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "effective_date_marketplace": {
- "enum": [
- "AWS",
- "GCP",
- "Azure"
- ],
- "type": "string"
- },
- "effective_date_type": {
- "enum": [
- "signature",
- "date",
- "marketplace_acceptance"
- ],
- "type": "string"
- },
- "general_cap_amount": {
- "type": "number"
- },
- "general_cap_amount_type": {
- "enum": [
- "preceding",
- "base",
- "period"
- ],
- "type": "string"
- },
- "general_cap_period_currency": {
- "type": "number"
- },
- "general_cap_period_qty": {
- "type": "number"
- },
- "general_cap_preceding_amount": {
- "type": "number"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_acceptable_use_policy": {
- "type": "boolean"
- },
- "include_acceptable_use_policy_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_acceptable_use_policy_location": {
- "type": "string"
- },
- "include_acceptable_use_policy_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_additional_warranties": {
- "type": "boolean"
- },
- "include_additional_warranties_by_customer": {
- "type": "string"
- },
- "include_additional_warranties_by_provider": {
- "type": "string"
- },
- "include_additional_warranties_include_by_customer": {
- "type": "boolean"
- },
- "include_additional_warranties_include_by_provider": {
- "type": "boolean"
- },
- "include_ai_addendum": {
- "type": "boolean"
- },
- "include_ai_addendum_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_covered_claims": {
- "type": "boolean"
- },
- "include_covered_claims_customer_claims": {
- "type": "string"
- },
- "include_covered_claims_include_customer_claims": {
- "type": "boolean"
- },
- "include_covered_claims_include_provider_claims": {
- "type": "boolean"
- },
- "include_covered_claims_provider_claims": {
- "type": "string"
- },
- "include_dpa": {
- "type": "boolean"
- },
- "include_dpa_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_dpa_location": {
- "type": "string"
- },
- "include_dpa_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_increased_cap_amount": {
- "type": "boolean"
- },
- "include_increased_claims": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_confidentiality": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_confidentiality_negligence": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_privsec": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_privsec_negligence": {
- "type": "boolean"
- },
- "include_increased_claims_include_other": {
- "type": "boolean"
- },
- "include_increased_claims_indemnification_obligation": {
- "type": "boolean"
- },
- "include_increased_claims_other": {
- "type": "string"
- },
- "include_insurance_minimums": {
- "type": "boolean"
- },
- "include_insurance_minimums_add_customer": {
- "type": "boolean"
- },
- "include_insurance_minimums_add_customer_com_gen_liability": {
- "type": "boolean"
- },
- "include_insurance_minimums_add_customer_cyber_liability": {
- "type": "boolean"
- },
- "include_insurance_minimums_add_customer_errors_omissions": {
- "type": "boolean"
- },
- "include_insurance_minimums_additional_information": {
- "type": "boolean"
- },
- "include_insurance_minimums_additional_information_text": {
- "type": "string"
- },
- "include_insurance_minimums_cyber_liability_aggregate": {
- "type": "number"
- },
- "include_insurance_minimums_cyber_liability_minimum": {
- "type": "number"
- },
- "include_insurance_minimums_employer_liability_aggregate": {
- "type": "number"
- },
- "include_insurance_minimums_employer_liability_minimum": {
- "type": "number"
- },
- "include_insurance_minimums_general_liability_aggregate": {
- "type": "number"
- },
- "include_insurance_minimums_general_liability_minimum": {
- "type": "number"
- },
- "include_insurance_minimums_include_cyber_liability": {
- "type": "boolean"
- },
- "include_insurance_minimums_include_employer_liability": {
- "type": "boolean"
- },
- "include_insurance_minimums_include_general_liability": {
- "type": "boolean"
- },
- "include_insurance_minimums_include_workers_compensation": {
- "type": "boolean"
- },
- "include_publicity_rights": {
- "type": "boolean"
- },
- "include_publicity_rights_type": {
- "enum": [
- "public",
- "non-public"
- ],
- "type": "string"
- },
- "include_security_policy": {
- "type": "boolean"
- },
- "include_security_policy_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_security_policy_fedramp_auth": {
- "type": "boolean"
- },
- "include_security_policy_hipaa": {
- "type": "boolean"
- },
- "include_security_policy_hitrust": {
- "type": "boolean"
- },
- "include_security_policy_include_annual_maintenance": {
- "type": "boolean"
- },
- "include_security_policy_include_location": {
- "type": "boolean"
- },
- "include_security_policy_include_other": {
- "type": "boolean"
- },
- "include_security_policy_include_reasonable_efforts": {
- "type": "boolean"
- },
- "include_security_policy_iso27001": {
- "type": "boolean"
- },
- "include_security_policy_location": {
- "type": "string"
- },
- "include_security_policy_other": {
- "type": "string"
- },
- "include_security_policy_pci1": {
- "type": "boolean"
- },
- "include_security_policy_pci2": {
- "type": "boolean"
- },
- "include_security_policy_penetration_testing": {
- "type": "boolean"
- },
- "include_security_policy_soc2": {
- "type": "boolean"
- },
- "include_security_policy_soc2_type2": {
- "type": "boolean"
- },
- "include_security_policy_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_supercap": {
- "description": "CSA 3.0 renamed `include_increased_cap_amount` to `include_supercap`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_increased_cap_amount`. Sending the other spelling returns a 422.",
- "type": "boolean"
- },
- "include_uncapped_claims": {
- "description": "CSA 3.0 renamed `include_unlimited_claims` to `include_uncapped_claims`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims`. Sending the other spelling returns a 422.",
- "type": "boolean"
- },
- "include_uncapped_claims_breach_of_confidentiality": {
- "description": "CSA 3.0 renamed `include_unlimited_claims_breach_of_confidentiality` to `include_uncapped_claims_breach_of_confidentiality`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_breach_of_confidentiality`. Sending the other spelling returns a 422.",
- "type": "boolean"
- },
- "include_uncapped_claims_breach_of_confidentiality_negligence": {
- "description": "CSA 3.0 renamed `include_unlimited_claims_breach_of_confidentiality_negligence` to `include_uncapped_claims_breach_of_confidentiality_negligence`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_breach_of_confidentiality_negligence`. Sending the other spelling returns a 422.",
- "type": "boolean"
- },
- "include_uncapped_claims_breach_of_privsec": {
- "description": "CSA 3.0 renamed `include_unlimited_claims_breach_of_privsec` to `include_uncapped_claims_breach_of_privsec`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_breach_of_privsec`. Sending the other spelling returns a 422.",
- "type": "boolean"
- },
- "include_uncapped_claims_breach_of_privsec_negligence": {
- "description": "CSA 3.0 renamed `include_unlimited_claims_breach_of_privsec_negligence` to `include_uncapped_claims_breach_of_privsec_negligence`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_breach_of_privsec_negligence`. Sending the other spelling returns a 422.",
- "type": "boolean"
- },
- "include_uncapped_claims_include_other": {
- "description": "CSA 3.0 renamed `include_unlimited_claims_include_other` to `include_uncapped_claims_include_other`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_include_other`. Sending the other spelling returns a 422.",
- "type": "boolean"
- },
- "include_uncapped_claims_indemnification_obligation": {
- "description": "CSA 3.0 renamed `include_unlimited_claims_indemnification_obligation` to `include_uncapped_claims_indemnification_obligation`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_indemnification_obligation`. Sending the other spelling returns a 422.",
- "type": "boolean"
- },
- "include_uncapped_claims_other": {
- "description": "CSA 3.0 renamed `include_unlimited_claims_other` to `include_uncapped_claims_other`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_other`. Sending the other spelling returns a 422.",
- "type": "boolean"
- },
- "include_unlimited_claims": {
- "type": "boolean"
- },
- "include_unlimited_claims_breach_of_confidentiality": {
- "type": "boolean"
- },
- "include_unlimited_claims_breach_of_confidentiality_negligence": {
- "type": "boolean"
- },
- "include_unlimited_claims_breach_of_privsec": {
- "type": "boolean"
- },
- "include_unlimited_claims_breach_of_privsec_negligence": {
- "type": "boolean"
- },
- "include_unlimited_claims_include_other": {
- "type": "boolean"
- },
- "include_unlimited_claims_indemnification_obligation": {
- "type": "boolean"
- },
- "include_unlimited_claims_other": {
- "type": "string"
- },
- "increased_cap_amount_currency": {
- "type": "number"
- },
- "increased_cap_amount_period_currency": {
- "type": "number"
- },
- "increased_cap_amount_period_qty": {
- "type": "number"
- },
- "increased_cap_amount_qty": {
- "type": "number"
- },
- "increased_cap_amount_type": {
- "enum": [
- "qty",
- "currency",
- "period"
- ],
- "type": "string"
- },
- "provider": {
- "type": "string"
- },
- "supercap_currency": {
- "description": "CSA 3.0 renamed `increased_cap_amount_currency` to `supercap_currency`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `increased_cap_amount_currency`. Sending the other spelling returns a 422.",
- "type": "number"
- },
- "supercap_period_currency": {
- "description": "CSA 3.0 renamed `increased_cap_amount_period_currency` to `supercap_period_currency`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `increased_cap_amount_period_currency`. Sending the other spelling returns a 422.",
- "type": "number"
- },
- "supercap_period_qty": {
- "description": "CSA 3.0 renamed `increased_cap_amount_period_qty` to `supercap_period_qty`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `increased_cap_amount_period_qty`. Sending the other spelling returns a 422.",
- "type": "number"
- },
- "supercap_qty": {
- "description": "CSA 3.0 renamed `increased_cap_amount_qty` to `supercap_qty`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `increased_cap_amount_qty`. Sending the other spelling returns a 422.",
- "type": "number"
- },
- "supercap_type": {
- "description": "CSA 3.0 renamed `increased_cap_amount_type` to `supercap_type`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `increased_cap_amount_type`. Sending the other spelling returns a 422.",
- "type": "number"
- }
- },
- "type": "object"
- },
- "csa_order_form_attributes": {
- "additionalProperties": false,
- "description": "Override csa order form terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "additional_changes": {
- "type": "string"
- },
- "additional_parameters_or_limitations": {
- "type": "string"
- },
- "affiliates_as_users": {
- "type": "boolean"
- },
- "cloud_service_description": {
- "type": "string"
- },
- "consumption_units": {
- "type": "string"
- },
- "fee_amount": {
- "type": "number"
- },
- "fee_custom_unit": {
- "type": "string"
- },
- "fee_period": {
- "enum": [
- "Subscription Period",
- "month",
- "year",
- "User",
- "Custom unit"
- ],
- "type": "string"
- },
- "fees_attributes": {
- "additionalProperties": {
- "anyOf": [
- {
- "additionalProperties": false,
- "description": "Fees::Flat (fee_type \"flat\"). A fixed recurring fee, e.g. a platform subscription. Set type to \"Fees::Flat\" or fee_type to \"flat\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "Fixed amount in the order form's fees_currency, charged per fee_period. A plain amount, not cents: 20 means 20.00.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"flat\". Alternative to type.",
- "enum": [
- "flat"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Flat\". Optional when fee_type is set.",
- "enum": [
- "Fees::Flat"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Discount (fee_type \"discount\"). A discount, as a fixed amount or a percentage, applied forever, once, or for a number of months. Set type to \"Fees::Discount\" or fee_type to \"discount\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "Discount size: an amount in fees_currency when discount_type is fixed_amount (a plain amount, not cents: 20 means 20.00), or a percentage (e.g. 10 for 10%) when it is percentage.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "discount_duration_amount": {
- "description": "Number of months the discount applies. Required when discount_duration_type is multiple_months.",
- "type": "number"
- },
- "discount_duration_type": {
- "description": "How long the discount applies. multiple_months also needs discount_duration_amount.",
- "enum": [
- "forever",
- "once",
- "multiple_months"
- ],
- "type": "string"
- },
- "discount_type": {
- "description": "Whether cost is a currency amount or a percentage.",
- "enum": [
- "fixed_amount",
- "percentage"
- ],
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"discount\". Alternative to type.",
- "enum": [
- "discount"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Discount\". Optional when fee_type is set.",
- "enum": [
- "Fees::Discount"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Cost (fee_type \"cost\"). A per-unit fee: price per unit times quantity, e.g. seats. Set type to \"Fees::Cost\" or fee_type to \"cost\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "Price per unit in fees_currency. The row total is quantity x cost. A plain amount, not cents: 20 means 20.00.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"cost\". Alternative to type.",
- "enum": [
- "cost"
- ],
- "type": "string"
- },
- "quantity": {
- "description": "Number of units.",
- "type": "number"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Cost\". Optional when fee_type is set.",
- "enum": [
- "Fees::Cost"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Attachment (fee_type \"attachment\"). A fee described in an uploaded attachment instead of in the table. Set type to \"Fees::Attachment\" or fee_type to \"attachment\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "attachment_id": {
- "description": "ID of an attachment uploaded with upload-attachment.",
- "type": "string"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"attachment\". Alternative to type.",
- "enum": [
- "attachment"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Attachment\". Optional when fee_type is set.",
- "enum": [
- "Fees::Attachment"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Graduated (fee_type \"graduated\"). Tiered pricing, with the price set per tier in graduated_fee_tiers_attributes. Set type to \"Fees::Graduated\" or fee_type to \"graduated\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"graduated\". Alternative to type.",
- "enum": [
- "graduated"
- ],
- "type": "string"
- },
- "graduated_fee_tiers_attributes": {
- "additionalProperties": {
- "additionalProperties": false,
- "properties": {
- "flat_price": {
- "type": "number"
- },
- "price_per_unit": {
- "type": "string"
- },
- "upper_limit": {
- "type": "number"
- }
- },
- "type": "object"
- },
- "description": "Graduated fee tiers. Use string keys such as \"0\", \"1\".",
- "propertyNames": {
- "type": "string"
- },
- "type": "object"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Graduated\". Optional when fee_type is set.",
- "enum": [
- "Fees::Graduated"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Included (fee_type \"included\"). An item included at no charge. Set type to \"Fees::Included\" or fee_type to \"included\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"included\". Alternative to type.",
- "enum": [
- "included"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Included\". Optional when fee_type is set.",
- "enum": [
- "Fees::Included"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Metered (fee_type \"metered\"). Usage-based pricing, billed per unit used. Set type to \"Fees::Metered\" or fee_type to \"metered\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "Price per unit of usage in fees_currency. A plain amount, not cents: 20 means 20.00.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"metered\". Alternative to type.",
- "enum": [
- "metered"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Metered\". Optional when fee_type is set.",
- "enum": [
- "Fees::Metered"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::OneTime (fee_type \"one_time\"). A one-time charge, such as a setup fee. Set type to \"Fees::OneTime\" or fee_type to \"one_time\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "One-time amount in fees_currency, charged once rather than per fee_period. A plain amount, not cents: 20 means 20.00.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"one_time\". Alternative to type.",
- "enum": [
- "one_time"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::OneTime\". Optional when fee_type is set.",
- "enum": [
- "Fees::OneTime"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Text (fee_type \"text\"). A fee term described in free text. Set type to \"Fees::Text\" or fee_type to \"text\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"text\". Alternative to type.",
- "enum": [
- "text"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Text\". Optional when fee_type is set.",
- "enum": [
- "Fees::Text"
- ],
- "type": "string"
- }
- },
- "type": "object"
- }
- ]
- },
- "description": "Fee table rows, keyed by string index (\"0\", \"1\", ...). Replaces the template's fees when provided. Each row sets type or fee_type to pick the fee class. Amounts are in the order form's fees_currency and, for recurring fees, are charged per fee_period.",
- "examples": [
- {
- "0": {
- "cost": 2000,
- "description": "Platform subscription",
- "type": "Fees::Flat"
- }
- },
- {
- "0": {
- "cost": 50,
- "description": "Seats",
- "fee_type": "cost",
- "quantity": 10
- },
- "1": {
- "cost": 10,
- "description": "Launch discount",
- "discount_duration_amount": 3,
- "discount_duration_type": "multiple_months",
- "discount_type": "percentage",
- "fee_type": "discount"
- }
- }
- ],
- "propertyNames": {
- "type": "string"
- },
- "type": "object"
- },
- "fees_currency": {
- "enum": [
- "USD",
- "EUR",
- "GBP",
- "CAD",
- "AUD",
- "SGD",
- "ILS",
- "JPY",
- "CHF",
- "HKD"
- ],
- "type": "string"
- },
- "fees_include_fee_increase_upon_renewal": {
- "type": "boolean"
- },
- "fees_include_fee_increase_upon_renewal_fee": {
- "type": "number"
- },
- "fees_include_fee_increase_upon_renewal_type": {
- "enum": [
- "will",
- "may"
- ],
- "type": "string"
- },
- "fees_inclusive_of_taxes": {
- "type": "boolean"
- },
- "framework_terms_type": {
- "enum": [
- "new",
- "existing",
- "description"
- ],
- "type": "string"
- },
- "free_trial_days": {
- "type": "number"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_additional_changes": {
- "type": "boolean"
- },
- "include_additional_parameters_or_limitations": {
- "type": "boolean"
- },
- "include_consumption": {
- "type": "boolean"
- },
- "include_fees": {
- "type": "boolean"
- },
- "include_fees_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_fees_include_attachment": {
- "type": "boolean"
- },
- "include_fees_other": {
- "type": "boolean"
- },
- "include_fees_other_val": {
- "type": "string"
- },
- "include_fees_table": {
- "type": "boolean"
- },
- "include_fees_table_period": {
- "enum": [
- "Subscription Period",
- "month",
- "year",
- "User"
- ],
- "type": "string"
- },
- "include_free_trial": {
- "type": "boolean"
- },
- "include_max_users": {
- "type": "boolean"
- },
- "include_pilot_period": {
- "type": "boolean"
- },
- "include_pilot_period_duration_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_pilot_period_duration_type": {
- "enum": [
- "day",
- "week",
- "month"
- ],
- "type": "string"
- },
- "include_pilot_period_include_fees": {
- "type": "boolean"
- },
- "include_pilot_period_include_fees_amount": {
- "type": "number"
- },
- "include_pilot_period_include_modifications": {
- "type": "boolean"
- },
- "include_pilot_period_include_modifications_description": {
- "type": "string"
- },
- "include_product_support": {
- "type": "boolean"
- },
- "include_product_support_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_product_support_description": {
- "type": "string"
- },
- "include_product_support_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_professional_services": {
- "type": "boolean"
- },
- "include_professional_services_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_professional_services_custom_name": {
- "type": "string"
- },
- "include_professional_services_description": {
- "type": "string"
- },
- "include_professional_services_end_date": {
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "include_professional_services_fees_description": {
- "type": "string"
- },
- "include_professional_services_include_end_date": {
- "type": "boolean"
- },
- "include_professional_services_include_fees_description": {
- "type": "boolean"
- },
- "include_professional_services_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_sla": {
- "type": "boolean"
- },
- "include_sla_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_sla_description": {
- "type": "string"
- },
- "include_sla_include_response_time": {
- "type": "boolean"
- },
- "include_sla_include_response_time_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_sla_include_response_time_credit": {
- "type": "number"
- },
- "include_sla_include_response_time_duration": {
- "enum": [
- "hour",
- "day",
- "week",
- "month",
- "hours"
- ],
- "type": "string"
- },
- "include_sla_include_response_time_support_channel": {
- "type": "string"
- },
- "include_sla_include_target_uptime": {
- "type": "boolean"
- },
- "include_sla_maintenance_notice": {
- "type": "boolean"
- },
- "include_sla_maintenance_window": {
- "type": "boolean"
- },
- "include_sla_maintenance_window_type": {
- "enum": [
- "standard",
- "none"
- ],
- "type": "string"
- },
- "include_sla_standard_maintenance_notice_qty": {
- "type": "number"
- },
- "include_sla_standard_maintenance_notice_unit": {
- "enum": [
- "hour",
- "day",
- "week",
- "month"
- ],
- "type": "string"
- },
- "include_sla_standard_maintenance_window_end_time": {
- "type": "string"
- },
- "include_sla_standard_maintenance_window_friday": {
- "type": "boolean"
- },
- "include_sla_standard_maintenance_window_monday": {
- "type": "boolean"
- },
- "include_sla_standard_maintenance_window_saturday": {
- "type": "boolean"
- },
- "include_sla_standard_maintenance_window_start_time": {
- "type": "string"
- },
- "include_sla_standard_maintenance_window_sunday": {
- "type": "boolean"
- },
- "include_sla_standard_maintenance_window_thursday": {
- "type": "boolean"
- },
- "include_sla_standard_maintenance_window_time_zone": {
- "type": "string"
- },
- "include_sla_standard_maintenance_window_tuesday": {
- "type": "boolean"
- },
- "include_sla_standard_maintenance_window_wednesday": {
- "type": "boolean"
- },
- "include_sla_standard_target_uptime": {
- "type": "number"
- },
- "include_sla_type": {
- "enum": [
- "description",
- "standard",
- "attachment"
- ],
- "type": "string"
- },
- "include_subscription_start_date": {
- "type": "boolean"
- },
- "include_subscription_start_date_date": {
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "include_usage_review": {
- "type": "boolean"
- },
- "include_usage_review_val": {
- "type": "string"
- },
- "include_use_limitations": {
- "type": "boolean"
- },
- "include_use_limitations_val": {
- "type": "string"
- },
- "invoice_period": {
- "enum": [
- "monthly",
- "quarterly",
- "semiannually",
- "annually",
- "Custom unit",
- "Monthly",
- "Quarterly",
- "Semiannually",
- "Annually"
- ],
- "type": "string"
- },
- "invoice_period_custom_unit": {
- "type": "string"
- },
- "max_consumption": {
- "type": "number"
- },
- "max_users": {
- "type": "number"
- },
- "negotiations_allowed": {
- "description": "When true, the recipient can propose changes to the order form, even when the agreement-level `negotiations_allowed` is false. This only covers the order form.",
- "type": "boolean"
- },
- "order_date_date": {
- "type": "string"
- },
- "order_date_other": {
- "type": "string"
- },
- "order_date_type": {
- "enum": [
- "signature",
- "date",
- "other"
- ],
- "type": "string"
- },
- "payment_period": {
- "type": "number"
- },
- "payment_period_timeframe": {
- "enum": [
- "Customer's receipt of invoice",
- "date of invoice"
- ],
- "type": "string"
- },
- "payment_period_unit": {
- "enum": [
- "day(s)",
- "week(s)",
- "month(s)",
- "marketplace_acceptance"
- ],
- "type": "string"
- },
- "payment_process_automatic_frequency": {
- "enum": [
- "monthly",
- "quarterly",
- "semiannually",
- "annually"
- ],
- "type": "string"
- },
- "payment_process_type": {
- "enum": [
- "automatic",
- "invoice",
- "custom",
- "marketplace_acceptance"
- ],
- "type": "string"
- },
- "payment_process_type_custom_val": {
- "type": "string"
- },
- "payment_process_type_invoice_amount": {
- "type": "number"
- },
- "payment_process_type_invoice_custom_unit": {
- "type": "string"
- },
- "payment_process_type_invoice_duration": {
- "enum": [
- "day",
- "week",
- "month",
- "year",
- "day(s)",
- "week(s)",
- "month(s)",
- "year(s)"
- ],
- "type": "string"
- },
- "payment_process_type_invoice_duration_start": {
- "enum": [
- "Customer's receipt of invoice",
- "date of invoice"
- ],
- "type": "string"
- },
- "payment_process_type_invoice_type": {
- "enum": [
- "monthly",
- "quarterly",
- "semiannually",
- "annually",
- "Custom unit"
- ],
- "type": "string"
- },
- "pilot_period_stripe_product_id": {
- "type": "string"
- },
- "service_credits_attributes": {
- "additionalProperties": {
- "additionalProperties": false,
- "properties": {
- "credit": {
- "type": "number"
- },
- "max": {
- "type": "number"
- },
- "min": {
- "type": "number"
- }
- },
- "type": "object"
- },
- "description": "Service credits. Use string keys such as \"0\", \"1\".",
- "propertyNames": {
- "type": "string"
- },
- "type": "object"
- },
- "subscription_auto_renew": {
- "enum": [
- "days",
- "subscription_end"
- ],
- "type": "string"
- },
- "subscription_period": {
- "type": "number"
- },
- "subscription_period_unit": {
- "type": "string"
- },
- "subscription_renewal_notice_days": {
- "type": "number"
- },
- "subscription_start_date": {
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "subscription_start_date_type": {
- "enum": [
- "effective_date",
- "date"
- ],
- "type": "string"
- },
- "underlying_agreement_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "use_limitations_attributes": {
- "additionalProperties": {
- "additionalProperties": false,
- "properties": {
- "amount": {
- "type": "number"
- },
- "limitation_type": {
- "type": "string"
- },
- "unit": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "description": "Use limitations. Use string keys such as \"0\", \"1\".",
- "propertyNames": {
- "type": "string"
- },
- "type": "object"
- }
- },
- "type": "object"
- },
- "custom_field_values": {
- "description": "Values for a custom template's fields, keyed by the field keys defined in the template's YAML definition. Only used when template_id is a custom template. Template defaults fill any fields you omit; a required field with no default and no submitted value returns a 400 naming the field. Values are validated against the field's input type: select and radio values must be one of the field's options, multiselect values are an array of selections each of which must be one of the field's options, number and currency values must be numeric, date values must be YYYY-MM-DD, and email values must be valid addresses. An invalid value returns a 400 naming the field."
- },
- "design_partner_attributes": {
- "additionalProperties": false,
- "description": "Override design partner terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "customer_description": {
- "type": "string"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_fees": {
- "type": "boolean"
- },
- "include_fees_amount": {
- "type": "number"
- },
- "include_fees_description": {
- "type": "string"
- },
- "include_fees_pay_by_amount": {
- "type": "string"
- },
- "include_fees_type": {
- "enum": [
- "default_language",
- "description"
- ],
- "type": "string"
- },
- "include_fees_unit": {
- "enum": [
- "month",
- "quarter",
- "year",
- "Term"
- ],
- "type": "string"
- },
- "include_program_appear_as_customer_private": {
- "type": "boolean"
- },
- "include_program_appear_as_customer_public": {
- "type": "boolean"
- },
- "include_program_case_study": {
- "type": "boolean"
- },
- "include_program_develop_functionality": {
- "type": "boolean"
- },
- "include_program_develop_functionality_val": {
- "type": "string"
- },
- "include_program_discount": {
- "type": "boolean"
- },
- "include_program_discount_amount": {
- "type": "number"
- },
- "include_program_discount_unit": {
- "enum": [
- "U.S. Dollars",
- "percent"
- ],
- "type": "string"
- },
- "include_program_participation_feedback": {
- "type": "boolean"
- },
- "include_program_participation_feedback_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_program_participation_feedback_unit": {
- "enum": [
- "month",
- "quarter",
- "year",
- "Term"
- ],
- "type": "string"
- },
- "include_program_partner_other": {
- "type": "boolean"
- },
- "include_program_partner_other_val": {
- "type": "string"
- },
- "include_program_provider_other": {
- "type": "boolean"
- },
- "include_program_provider_other_val": {
- "type": "string"
- },
- "include_program_reference": {
- "type": "boolean"
- },
- "product_description": {
- "type": "string"
- },
- "term_amount": {
- "type": "number"
- },
- "term_unit": {
- "enum": [
- "day(s)",
- "week(s)",
- "month(s)",
- "quarter(s)",
- "year(s)"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- "district_or_county": {
- "description": "The district or county for dispute resolution.",
- "type": "string"
- },
- "dpa_attributes": {
- "additionalProperties": false,
- "description": "Override dpa terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "approved_subprocessor_type": {
- "description": "`internal` lists approved subprocessors in the agreement (`subprocessors_attributes`); `external` points to a list published elsewhere.",
- "enum": [
- "internal",
- "external"
- ],
- "type": "string"
- },
- "cloud_service_product_name": {
- "type": "string"
- },
- "competent_supervisory_authority": {
- "type": "string"
- },
- "customer_description": {
- "type": "string"
- },
- "data_exporter_address_city": {
- "type": "string"
- },
- "data_exporter_address_country": {
- "type": "string"
- },
- "data_exporter_address_state": {
- "type": "string"
- },
- "data_exporter_address_street_address": {
- "type": "string"
- },
- "data_exporter_address_zipcode": {
- "type": "string"
- },
- "data_exporter_contact_details": {
- "type": "string"
- },
- "data_exporter_contact_name": {
- "type": "string"
- },
- "data_exporter_contact_position": {
- "type": "string"
- },
- "data_exporter_role": {
- "description": "Role of the data exporter. Overwritten to `Controller` when the agreement is created from a template.",
- "enum": [
- "Controller",
- "Processor"
- ],
- "type": "string"
- },
- "data_importer_address": {
- "type": "string"
- },
- "data_importer_address_city": {
- "type": "string"
- },
- "data_importer_address_country": {
- "type": "string"
- },
- "data_importer_address_state": {
- "type": "string"
- },
- "data_importer_address_street_address": {
- "type": "string"
- },
- "data_importer_address_zipcode": {
- "type": "string"
- },
- "data_importer_contact_details": {
- "type": "string"
- },
- "data_importer_contact_name": {
- "type": "string"
- },
- "data_importer_contact_position": {
- "type": "string"
- },
- "duration_of_processing": {
- "type": "string"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_covered_claim": {
- "type": "boolean"
- },
- "include_covered_claim_external_val": {
- "type": "string"
- },
- "include_covered_claim_internal_val": {
- "type": "string"
- },
- "include_covered_claim_type": {
- "description": "Which covered-claim text applies: `internal` uses `include_covered_claim_internal_val`, `external` uses `include_covered_claim_external_val`. Required when `include_covered_claim` is true.",
- "enum": [
- "internal",
- "external"
- ],
- "type": "string"
- },
- "include_data_subjects_custom": {
- "type": "boolean"
- },
- "include_data_subjects_custom_val": {
- "type": "string"
- },
- "include_data_subjects_employees": {
- "type": "boolean"
- },
- "include_data_subjects_end_users": {
- "type": "boolean"
- },
- "include_external_subprocessor_location": {
- "type": "string"
- },
- "include_frequency_of_transfer_continuous": {
- "type": "boolean"
- },
- "include_frequency_of_transfer_custom": {
- "type": "boolean"
- },
- "include_frequency_of_transfer_custom_val": {
- "type": "string"
- },
- "include_governing_country_eu": {
- "type": "boolean"
- },
- "include_governing_country_eu_val": {
- "type": "string"
- },
- "include_governing_country_uk": {
- "type": "boolean"
- },
- "include_governing_country_uk_val": {
- "type": "string"
- },
- "include_governing_law": {
- "type": "boolean"
- },
- "include_governing_law_country": {
- "type": "string"
- },
- "include_governing_law_state": {
- "type": "string"
- },
- "include_increased_claim_amount": {
- "description": "Legacy field. Stored but not shown on the DPA; use the `include_liability_cap*` fields instead.",
- "type": "boolean"
- },
- "include_increased_claim_amount_currency": {
- "description": "Legacy field. Stored but not shown on the DPA; use the `include_liability_cap*` fields instead."
- },
- "include_increased_claim_amount_qty": {
- "description": "Legacy field. Stored but not shown on the DPA; use the `include_liability_cap*` fields instead."
- },
- "include_increased_claim_amount_type": {
- "description": "Legacy field. Stored but not shown on the DPA; use the `include_liability_cap*` fields instead.",
- "type": "string"
- },
- "include_liability_cap": {
- "type": "boolean"
- },
- "include_liability_cap_amount_constant_external": {
- "type": "string"
- },
- "include_liability_cap_amount_constant_internal": {
- "type": "string"
- },
- "include_liability_cap_amount_currency_external": {
- "description": "Currency amount. Numbers and numeric strings (commas allowed) are both accepted."
- },
- "include_liability_cap_amount_currency_internal": {
- "description": "Currency amount. Numbers and numeric strings (commas allowed) are both accepted."
- },
- "include_liability_cap_csa_type": {
- "description": "Which liability cap values apply: the `_internal` or `_external` amount fields. Required when `include_liability_cap` is true.",
- "enum": [
- "internal",
- "external"
- ],
- "type": "string"
- },
- "include_personal_data_biographic_info": {
- "type": "boolean"
- },
- "include_personal_data_contact_info": {
- "type": "boolean"
- },
- "include_personal_data_custom": {
- "type": "boolean"
- },
- "include_personal_data_custom_val": {
- "type": "string"
- },
- "include_personal_data_employment_info": {
- "type": "boolean"
- },
- "include_personal_data_financial_info": {
- "type": "boolean"
- },
- "include_personal_data_location": {
- "type": "boolean"
- },
- "include_personal_data_name": {
- "type": "boolean"
- },
- "include_personal_data_transactional_info": {
- "type": "boolean"
- },
- "include_personal_data_user_activity_info": {
- "type": "boolean"
- },
- "include_processing_purpose_custom": {
- "type": "boolean"
- },
- "include_processing_purpose_custom_val": {
- "type": "string"
- },
- "include_processing_purpose_erasing": {
- "type": "boolean"
- },
- "include_processing_purpose_holding": {
- "type": "boolean"
- },
- "include_processing_purpose_protecting": {
- "type": "boolean"
- },
- "include_processing_purpose_receiving": {
- "type": "boolean"
- },
- "include_processing_purpose_returning": {
- "type": "boolean"
- },
- "include_processing_purpose_sharing": {
- "type": "boolean"
- },
- "include_processing_purpose_updating": {
- "type": "boolean"
- },
- "include_processing_purpose_using": {
- "type": "boolean"
- },
- "include_provider_security_contact_address": {
- "type": "boolean"
- },
- "include_provider_security_contact_address_city": {
- "type": "string"
- },
- "include_provider_security_contact_address_country": {
- "type": "string"
- },
- "include_provider_security_contact_address_state": {
- "type": "string"
- },
- "include_provider_security_contact_address_street_address": {
- "type": "string"
- },
- "include_provider_security_contact_address_zipcode": {
- "type": "string"
- },
- "include_provider_security_contact_email": {
- "type": "boolean"
- },
- "include_provider_security_contact_email_val": {
- "format": "email",
- "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
- "type": "string"
- },
- "include_security_measures_accountability": {
- "type": "boolean"
- },
- "include_security_measures_accountability_val": {
- "type": "string"
- },
- "include_security_measures_certification_or_assurance": {
- "type": "boolean"
- },
- "include_security_measures_certification_or_assurance_val": {
- "type": "string"
- },
- "include_security_measures_confidentiality_integrity": {
- "type": "boolean"
- },
- "include_security_measures_confidentiality_integrity_val": {
- "type": "string"
- },
- "include_security_measures_data_at_rest": {
- "type": "boolean"
- },
- "include_security_measures_data_at_rest_val": {
- "type": "string"
- },
- "include_security_measures_data_minimization": {
- "type": "boolean"
- },
- "include_security_measures_data_minimization_val": {
- "type": "string"
- },
- "include_security_measures_data_quality": {
- "type": "boolean"
- },
- "include_security_measures_data_quality_val": {
- "type": "string"
- },
- "include_security_measures_data_retention": {
- "type": "boolean"
- },
- "include_security_measures_data_retention_val": {
- "type": "string"
- },
- "include_security_measures_data_transmission": {
- "type": "boolean"
- },
- "include_security_measures_data_transmission_val": {
- "type": "string"
- },
- "include_security_measures_event_logging": {
- "type": "boolean"
- },
- "include_security_measures_event_logging_val": {
- "type": "string"
- },
- "include_security_measures_identity_auth": {
- "type": "boolean"
- },
- "include_security_measures_identity_auth_val": {
- "type": "string"
- },
- "include_security_measures_it_security_governance": {
- "type": "boolean"
- },
- "include_security_measures_it_security_governance_val": {
- "type": "string"
- },
- "include_security_measures_physical_security": {
- "type": "boolean"
- },
- "include_security_measures_physical_security_val": {
- "type": "string"
- },
- "include_security_measures_portability_and_erasure": {
- "type": "boolean"
- },
- "include_security_measures_portability_and_erasure_val": {
- "type": "string"
- },
- "include_security_measures_pseudonym_encryption": {
- "type": "boolean"
- },
- "include_security_measures_pseudonym_encryption_val": {
- "type": "string"
- },
- "include_security_measures_restore_data_access": {
- "type": "boolean"
- },
- "include_security_measures_restore_data_access_val": {
- "type": "string"
- },
- "include_security_measures_security_policy": {
- "type": "boolean"
- },
- "include_security_measures_system_configuration": {
- "type": "boolean"
- },
- "include_security_measures_system_configuration_val": {
- "type": "string"
- },
- "include_security_measures_testing_assessment": {
- "type": "boolean"
- },
- "include_security_measures_testing_assessment_val": {
- "type": "string"
- },
- "include_security_policy": {
- "type": "boolean"
- },
- "include_security_policy_fedramp_auth": {
- "type": "boolean"
- },
- "include_security_policy_hipaa": {
- "type": "boolean"
- },
- "include_security_policy_hitrust": {
- "type": "boolean"
- },
- "include_security_policy_include_other": {
- "type": "boolean"
- },
- "include_security_policy_iso27001": {
- "type": "boolean"
- },
- "include_security_policy_other": {
- "type": "string"
- },
- "include_security_policy_pci1": {
- "type": "boolean"
- },
- "include_security_policy_pci2": {
- "type": "boolean"
- },
- "include_security_policy_penetration_testing": {
- "type": "boolean"
- },
- "include_security_policy_soc2": {
- "type": "boolean"
- },
- "include_security_policy_soc2_type2": {
- "type": "boolean"
- },
- "include_sensitive_data_restrictions_custom": {
- "type": "boolean"
- },
- "include_sensitive_data_restrictions_custom_val": {
- "type": "string"
- },
- "include_sensitive_data_restrictions_security_policy": {
- "type": "boolean"
- },
- "include_service_provider_relationship": {
- "type": "boolean"
- },
- "include_special_category_data": {
- "type": "boolean"
- },
- "provider": {
- "type": "string"
- },
- "security_policy_available_at": {
- "type": "string"
- },
- "security_policy_type": {
- "description": "Where the Security Policy is defined. For `external`, set `security_policy_available_at`.",
- "enum": [
- "defined in agreement",
- "provider service",
- "external"
- ],
- "type": "string"
- },
- "subprocessors_attributes": {
- "additionalProperties": {
- "additionalProperties": false,
- "properties": {
- "_destroy": {
- "description": "Set to true with `id` to remove that subprocessor.",
- "type": "boolean"
- },
- "country": {
- "type": "string"
- },
- "id": {
- "description": "ID of an existing subprocessor to update or remove. Omit to add a new subprocessor.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "name": {
- "type": "string"
- },
- "processing_task": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "description": "Subprocessors, keyed by string index such as \"0\", \"1\". On create these are added to the template's subprocessors. On a draft update, an entry without `id` adds a new subprocessor; pass `id` to change one and `id` with `_destroy: true` to remove one.",
- "propertyNames": {
- "type": "string"
- },
- "type": "object"
- },
- "underlying_agreement_id": {
- "description": "ID of the CSA this DPA supplements when `underlying_agreement_type` is `internal`.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "underlying_agreement_type": {
- "description": "`internal` links a CSA in Common Paper (`underlying_agreement_id`); `external` describes another agreement in `underlying_agreement_val` (required). Omit for none.",
- "enum": [
- "internal",
- "external"
- ],
- "type": "string"
- },
- "underlying_agreement_val": {
- "description": "Description of the agreement this DPA supplements. Required when `underlying_agreement_type` is `external`.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "framework_terms_description": {
- "description": "Custom framework terms description. Only used when framework_terms_type is \"description\".",
- "type": "string"
- },
- "framework_terms_type": {
- "description": "How framework terms are specified. Use \"new\" for standard terms or \"description\" to provide a custom framework_terms_description.",
- "enum": [
- "new",
- "description"
- ],
- "type": "string"
- },
- "governing_law_country": {
- "description": "The country whose laws govern the agreement.",
- "type": "string"
- },
- "governing_law_region": {
- "description": "The state or region whose laws govern the agreement.",
- "type": "string"
- },
- "include_automated_payment_reminders": {
- "description": "When true, automatically sends payment reminder emails.",
- "type": "boolean"
- },
- "include_billing_info": {
- "description": "When true, billing contact information (billing_name, billing_email) is included.",
- "type": "boolean"
- },
- "include_billing_workflow": {
- "description": "When true, enables a billing workflow after signing.",
- "type": "boolean"
- },
- "include_expiration_date": {
- "description": "Expiration date in YYYY-MM-DD format. Use when include_expiration_type is \"date\".",
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "include_expiration_days": {
- "description": "Number of days until the agreement expires. Use when include_expiration_type is \"days\".",
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_expiration_type": {
- "description": "How to set expiration: \"none\" (default), \"days\" (use include_expiration_days), or \"date\" (use include_expiration_date).",
- "enum": [
- "none",
- "days",
- "date"
- ],
- "type": "string"
- },
- "include_terms": {
- "description": "When true, the standard terms are included with the agreement.",
- "type": "boolean"
- },
- "loi_attributes": {
- "additionalProperties": false,
- "description": "Override loi terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "confidentiality_custom": {
- "type": "string"
- },
- "confidentiality_mutual_include_loi": {
- "type": "boolean"
- },
- "confidentiality_nda_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "confidentiality_nda_description": {
- "type": "string"
- },
- "confidentiality_nda_include_loi": {
- "type": "boolean"
- },
- "confidentiality_nda_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "confidentiality_type": {
- "enum": [
- "mutual",
- "nda",
- "provider",
- "custom"
- ],
- "type": "string"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_custom_details": {
- "type": "boolean"
- },
- "include_custom_details_val": {
- "type": "string"
- },
- "include_fees": {
- "type": "boolean"
- },
- "include_fees_amount": {
- "type": "number"
- },
- "include_fees_amount_duration": {
- "enum": [
- "month",
- "year",
- "quarter"
- ],
- "type": "string"
- },
- "include_fees_include_amount": {
- "type": "boolean"
- },
- "include_fees_include_other": {
- "type": "boolean"
- },
- "include_fees_other": {
- "type": "string"
- },
- "include_functionality": {
- "type": "boolean"
- },
- "include_functionality_val": {
- "type": "string"
- },
- "include_launch_date": {
- "type": "boolean"
- },
- "include_launch_date_custom": {
- "type": "string"
- },
- "include_launch_date_date": {
- "format": "date-time",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$",
- "type": "string"
- },
- "include_launch_date_type": {
- "enum": [
- "date",
- "custom"
- ],
- "type": "string"
- },
- "product_name": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "manual_send": {
- "description": "When true, the agreement is marked as manually sent outside the platform.",
- "type": "boolean"
- },
- "message": {
- "type": "string"
- },
- "negotiations_allowed": {
- "description": "When true, the recipient can propose changes to the legal terms. For agreement types without separate business terms, that covers every term. CSA order forms, PSA statements of work, partnership business terms and software license order forms have their own `negotiations_allowed` flag.",
- "type": "boolean"
- },
- "partnership_attributes": {
- "additionalProperties": false,
- "description": "Override partnership terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "effective_date": {
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "effective_date_type": {
- "enum": [
- "signature",
- "date"
- ],
- "type": "string"
- },
- "general_cap_amount_currency_val": {
- "type": "number"
- },
- "general_cap_amount_either_currency": {
- "type": "number"
- },
- "general_cap_amount_either_multiple": {
- "type": "number"
- },
- "general_cap_amount_multiple_val": {
- "type": "number"
- },
- "general_cap_amount_type": {
- "enum": [
- "multiple",
- "currency",
- "either",
- "base"
- ],
- "type": "string"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_additional_warranties": {
- "type": "boolean"
- },
- "include_additional_warranties_include_company": {
- "type": "boolean"
- },
- "include_additional_warranties_include_company_val": {
- "type": "string"
- },
- "include_additional_warranties_include_partner": {
- "type": "boolean"
- },
- "include_additional_warranties_include_partner_val": {
- "type": "string"
- },
- "include_brand_guidelines": {
- "type": "boolean"
- },
- "include_brand_guidelines_include_company": {
- "type": "boolean"
- },
- "include_brand_guidelines_include_company_val": {
- "type": "string"
- },
- "include_brand_guidelines_include_partner": {
- "type": "boolean"
- },
- "include_brand_guidelines_include_partner_val": {
- "type": "string"
- },
- "include_covered_claims": {
- "type": "boolean"
- },
- "include_covered_claims_company_claims": {
- "type": "string"
- },
- "include_covered_claims_include_company_claims": {
- "type": "boolean"
- },
- "include_covered_claims_include_partner_claims": {
- "type": "boolean"
- },
- "include_covered_claims_partner_claims": {
- "type": "string"
- },
- "include_dpa": {
- "type": "boolean"
- },
- "include_dpa_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_dpa_location": {
- "type": "string"
- },
- "include_dpa_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_increased_cap_amount": {
- "type": "boolean"
- },
- "include_increased_cap_amount_currency": {
- "type": "number"
- },
- "include_increased_cap_amount_either_currency": {
- "type": "number"
- },
- "include_increased_cap_amount_either_multiple": {
- "type": "string"
- },
- "include_increased_cap_amount_multiple": {
- "type": "string"
- },
- "include_increased_cap_amount_type": {
- "enum": [
- "multiple",
- "currency",
- "either"
- ],
- "type": "string"
- },
- "include_increased_claims": {
- "type": "boolean"
- },
- "include_increased_claims_include_confidentiality": {
- "type": "boolean"
- },
- "include_increased_claims_include_confidentiality_misconduct": {
- "type": "boolean"
- },
- "include_increased_claims_include_covered_claims": {
- "type": "boolean"
- },
- "include_increased_claims_include_misconduct": {
- "type": "boolean"
- },
- "include_increased_claims_include_other": {
- "type": "boolean"
- },
- "include_increased_claims_include_other_val": {
- "type": "string"
- },
- "include_unlimited_claims": {
- "type": "boolean"
- },
- "include_unlimited_claims_confidentiality": {
- "type": "boolean"
- },
- "include_unlimited_claims_confidentiality_misconduct": {
- "type": "boolean"
- },
- "include_unlimited_claims_covered_claims": {
- "type": "boolean"
- },
- "include_unlimited_claims_misconduct": {
- "type": "boolean"
- },
- "include_unlimited_claims_other": {
- "type": "boolean"
- },
- "include_unlimited_claims_other_val": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "partnership_business_terms_attributes": {
- "additionalProperties": false,
- "description": "Override partnership business terms terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "end_date_after_effective_date_amount": {
- "type": "number"
- },
- "end_date_after_effective_date_unit": {
- "enum": [
- "month(s)",
- "quarter(s)",
- "year(s)"
- ],
- "type": "string"
- },
- "end_date_date": {
- "type": "string"
- },
- "end_date_type": {
- "enum": [
- "date",
- "effective date"
- ],
- "type": "string"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_obligations_company_brand": {
- "type": "boolean"
- },
- "include_obligations_company_promotion": {
- "type": "boolean"
- },
- "include_obligations_company_promotion_include_activities": {
- "type": "boolean"
- },
- "include_obligations_company_promotion_include_activities_val": {
- "type": "string"
- },
- "include_obligations_company_promotion_include_materials": {
- "type": "boolean"
- },
- "include_obligations_company_promotion_include_materials_val": {
- "type": "string"
- },
- "include_obligations_company_referral": {
- "type": "boolean"
- },
- "include_obligations_company_referral_include_criteria": {
- "type": "boolean"
- },
- "include_obligations_company_referral_include_criteria_val": {
- "type": "string"
- },
- "include_obligations_company_referral_include_pay_sch": {
- "type": "boolean"
- },
- "include_obligations_company_referral_include_pay_sch_amount": {
- "type": "number"
- },
- "include_obligations_company_referral_include_pay_sch_custom": {
- "type": "string"
- },
- "include_obligations_company_referral_include_pay_sch_unit": {
- "enum": [
- "U.S. Dollars",
- "percent"
- ],
- "type": "string"
- },
- "include_obligations_company_sponsorship": {
- "type": "boolean"
- },
- "include_obligations_company_sponsorship_include_benefits": {
- "type": "boolean"
- },
- "include_obligations_company_sponsorship_include_benefits_val": {
- "type": "string"
- },
- "include_obligations_company_sponsorship_include_payments": {
- "type": "boolean"
- },
- "include_obligations_company_sponsorship_include_payments_amount": {
- "type": "number"
- },
- "include_obligations_company_sponsorship_include_payments_unit": {
- "enum": [
- "U.S. Dollars",
- "percent"
- ],
- "type": "string"
- },
- "include_obligations_partner_brand": {
- "type": "boolean"
- },
- "include_obligations_partner_promotion": {
- "type": "boolean"
- },
- "include_obligations_partner_promotion_include_activities": {
- "type": "boolean"
- },
- "include_obligations_partner_promotion_include_activities_val": {
- "type": "string"
- },
- "include_obligations_partner_promotion_include_materials": {
- "type": "boolean"
- },
- "include_obligations_partner_promotion_include_materials_val": {
- "type": "string"
- },
- "include_obligations_partner_referral": {
- "type": "boolean"
- },
- "include_obligations_partner_referral_include_criteria": {
- "type": "boolean"
- },
- "include_obligations_partner_referral_include_criteria_val": {
- "type": "string"
- },
- "include_obligations_partner_referral_include_pay_sch": {
- "type": "boolean"
- },
- "include_obligations_partner_referral_include_pay_sch_amount": {
- "type": "number"
- },
- "include_obligations_partner_referral_include_pay_sch_custom": {
- "type": "string"
- },
- "include_obligations_partner_referral_include_pay_sch_unit": {
- "enum": [
- "U.S. Dollars",
- "percent"
- ],
- "type": "string"
- },
- "include_obligations_partner_sponsorship": {
- "type": "boolean"
- },
- "include_obligations_partner_sponsorship_include_benefits": {
- "type": "boolean"
- },
- "include_obligations_partner_sponsorship_include_benefits_val": {
- "type": "string"
- },
- "include_obligations_partner_sponsorship_include_payments": {
- "type": "boolean"
- },
- "include_obligations_partner_sponsorship_include_payments_amount": {
- "type": "number"
- },
- "include_obligations_partner_sponsorship_include_payments_unit": {
- "enum": [
- "U.S. Dollars",
- "percent"
- ],
- "type": "string"
- },
- "include_payment_process": {
- "type": "boolean"
- },
- "include_payment_process_company": {
- "type": "boolean"
- },
- "include_payment_process_company_include_address": {
- "type": "boolean"
- },
- "include_payment_process_company_include_address_city": {
- "type": "string"
- },
- "include_payment_process_company_include_address_country": {
- "type": "string"
- },
- "include_payment_process_company_include_address_state": {
- "type": "string"
- },
- "include_payment_process_company_include_address_street_address": {
- "type": "string"
- },
- "include_payment_process_company_include_address_zipcode": {
- "type": "string"
- },
- "include_payment_process_company_include_email": {
- "type": "boolean"
- },
- "include_payment_process_company_include_email_val": {
- "type": "string"
- },
- "include_payment_process_partner": {
- "type": "boolean"
- },
- "include_payment_process_partner_include_address": {
- "type": "boolean"
- },
- "include_payment_process_partner_include_address_city": {
- "type": "string"
- },
- "include_payment_process_partner_include_address_country": {
- "type": "string"
- },
- "include_payment_process_partner_include_address_state": {
- "type": "string"
- },
- "include_payment_process_partner_include_address_street_address": {
- "type": "string"
- },
- "include_payment_process_partner_include_address_zipcode": {
- "type": "string"
- },
- "include_payment_process_partner_include_email": {
- "type": "boolean"
- },
- "include_payment_process_partner_include_email_val": {
- "type": "string"
- },
- "include_payment_schedule": {
- "type": "boolean"
- },
- "include_payment_schedule_custom": {
- "type": "string"
- },
- "include_payment_schedule_specified_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_payment_schedule_specified_timeframe": {
- "enum": [
- "receipt",
- "date"
- ],
- "type": "string"
- },
- "include_payment_schedule_specified_unit": {
- "enum": [
- "day(s)",
- "week(s)",
- "month(s)",
- "quarter(s)",
- "year(s)"
- ],
- "type": "string"
- },
- "include_payment_schedule_type": {
- "enum": [
- "specified",
- "custom"
- ],
- "type": "string"
- },
- "negotiations_allowed": {
- "description": "When true, the recipient can propose changes to the business terms, even when the agreement-level `negotiations_allowed` is false. This only covers the business terms.",
- "type": "boolean"
- },
- "territory_type": {
- "enum": [
- "worldwide",
- "custom"
- ],
- "type": "string"
- },
- "territory_type_val": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "payment_link_url": {
- "description": "A payment URL shown to the recipient after signing. Requires include_billing_workflow to be true and billing_workflow_type to be \"link\".",
- "type": "string"
- },
- "pilot_attributes": {
- "additionalProperties": false,
- "description": "Override pilot terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "fees_type": {
- "enum": [
- "free",
- "pilot_period_fees"
- ],
- "type": "string"
- },
- "general_cap_amount": {
- "type": "number"
- },
- "general_cap_amount_type": {
- "enum": [
- "preceding",
- "base",
- "period"
- ],
- "type": "string"
- },
- "general_cap_period_currency": {
- "type": "number"
- },
- "general_cap_period_qty": {
- "type": "number"
- },
- "general_cap_preceding_amount": {
- "type": "number"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_dpa": {
- "type": "boolean"
- },
- "include_dpa_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_dpa_location": {
- "type": "string"
- },
- "include_dpa_type": {
- "enum": [
- "description",
- "attachment",
- "standard"
- ],
- "type": "string"
- },
- "include_payment_process": {
- "type": "boolean"
- },
- "include_technical_support": {
- "type": "boolean"
- },
- "payment_process_automatic_frequency": {
- "enum": [
- "monthly",
- "quarterly",
- "annually",
- "once_per_period"
- ],
- "type": "string"
- },
- "payment_process_invoice_days": {
- "type": "number"
- },
- "payment_process_invoice_from": {
- "enum": [
- "receipt",
- "date"
- ],
- "type": "string"
- },
- "payment_process_invoice_timeframe": {
- "enum": [
- "days",
- "weeks",
- "months",
- "quarters",
- "years"
- ],
- "type": "string"
- },
- "payment_process_type": {
- "enum": [
- "automatic",
- "invoice"
- ],
- "type": "string"
- },
- "pilot_period_description": {
- "type": "string"
- },
- "pilot_period_fees_description": {
- "type": "string"
- },
- "product_description": {
- "type": "string"
- },
- "technical_support_description": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "psa_attributes": {
- "additionalProperties": false,
- "description": "Override psa terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "additional_changes": {
- "type": "string"
- },
- "customer_description": {
- "type": "string"
- },
- "effective_date": {
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "effective_date_type": {
- "enum": [
- "signature",
- "date"
- ],
- "type": "string"
- },
- "general_cap_amount": {
- "type": "number"
- },
- "general_cap_amount_type": {
- "enum": [
- "preceding",
- "base",
- "period"
- ],
- "type": "string"
- },
- "general_cap_period_currency": {
- "type": "number"
- },
- "general_cap_period_qty": {
- "type": "number"
- },
- "general_cap_preceding_amount": {
- "type": "number"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_additional_changes": {
- "type": "boolean"
- },
- "include_additional_warranties": {
- "type": "boolean"
- },
- "include_additional_warranties_by_customer": {
- "type": "string"
- },
- "include_additional_warranties_by_provider": {
- "type": "string"
- },
- "include_additional_warranties_include_by_customer": {
- "type": "boolean"
- },
- "include_additional_warranties_include_by_provider": {
- "type": "boolean"
- },
- "include_covered_claims": {
- "type": "boolean"
- },
- "include_covered_claims_customer_claims": {
- "type": "string"
- },
- "include_covered_claims_include_customer_claims": {
- "type": "boolean"
- },
- "include_covered_claims_include_provider_claims": {
- "type": "boolean"
- },
- "include_covered_claims_provider_claims": {
- "type": "string"
- },
- "include_customer_insurance_min": {
- "type": "boolean"
- },
- "include_customer_insurance_min_add_provider_com_gen_liability": {
- "type": "boolean"
- },
- "include_customer_insurance_min_add_provider_cyber_liability": {
- "type": "boolean"
- },
- "include_customer_insurance_min_add_provider_errors_omissions": {
- "type": "boolean"
- },
- "include_customer_insurance_min_auto_liability_aggregate": {
- "type": "number"
- },
- "include_customer_insurance_min_auto_liability_minimum": {
- "type": "number"
- },
- "include_customer_insurance_min_cyber_liability_aggregate": {
- "type": "number"
- },
- "include_customer_insurance_min_cyber_liability_minimum": {
- "type": "number"
- },
- "include_customer_insurance_min_employer_liability_aggregate": {
- "type": "number"
- },
- "include_customer_insurance_min_employer_liability_minimum": {
- "type": "number"
- },
- "include_customer_insurance_min_general_liability_aggregate": {
- "type": "number"
- },
- "include_customer_insurance_min_general_liability_minimum": {
- "type": "number"
- },
- "include_customer_insurance_min_include_add_provider": {
- "type": "boolean"
- },
- "include_customer_insurance_min_include_auto_liability": {
- "type": "boolean"
- },
- "include_customer_insurance_min_include_cyber_liability": {
- "type": "boolean"
- },
- "include_customer_insurance_min_include_employer_liability": {
- "type": "boolean"
- },
- "include_customer_insurance_min_include_general_liability": {
- "type": "boolean"
- },
- "include_customer_insurance_min_include_workers_comp": {
- "type": "boolean"
- },
- "include_customer_policies": {
- "type": "boolean"
- },
- "include_customer_policies_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_customer_policies_location": {
- "type": "string"
- },
- "include_customer_policies_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_dpa": {
- "type": "boolean"
- },
- "include_dpa_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_dpa_location": {
- "type": "string"
- },
- "include_dpa_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_increased_cap_amount": {
- "type": "boolean"
- },
- "include_increased_claims": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_confidentiality": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_confidentiality_negligence": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_privsec": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_privsec_negligence": {
- "type": "boolean"
- },
- "include_increased_claims_include_other": {
- "type": "boolean"
- },
- "include_increased_claims_indemnification_obligation": {
- "type": "boolean"
- },
- "include_increased_claims_negligence": {
- "type": "boolean"
- },
- "include_increased_claims_other": {
- "type": "string"
- },
- "include_provider_insurance_min": {
- "type": "boolean"
- },
- "include_provider_insurance_min_add_customer_com_gen_liability": {
- "type": "boolean"
- },
- "include_provider_insurance_min_add_customer_cyber_liability": {
- "type": "boolean"
- },
- "include_provider_insurance_min_add_customer_errors_omissions": {
- "type": "boolean"
- },
- "include_provider_insurance_min_auto_liability_aggregate": {
- "type": "number"
- },
- "include_provider_insurance_min_auto_liability_minimum": {
- "type": "number"
- },
- "include_provider_insurance_min_cyber_liability_aggregate": {
- "type": "number"
- },
- "include_provider_insurance_min_cyber_liability_minimum": {
- "type": "number"
- },
- "include_provider_insurance_min_employer_liability_aggregate": {
- "type": "number"
- },
- "include_provider_insurance_min_employer_liability_minimum": {
- "type": "number"
- },
- "include_provider_insurance_min_general_liability_aggregate": {
- "type": "number"
- },
- "include_provider_insurance_min_general_liability_minimum": {
- "type": "number"
- },
- "include_provider_insurance_min_include_add_customer": {
- "type": "boolean"
- },
- "include_provider_insurance_min_include_auto_liability": {
- "type": "boolean"
- },
- "include_provider_insurance_min_include_cyber_liability": {
- "type": "boolean"
- },
- "include_provider_insurance_min_include_employer_liability": {
- "type": "boolean"
- },
- "include_provider_insurance_min_include_general_liability": {
- "type": "boolean"
- },
- "include_provider_insurance_min_include_workers_comp": {
- "type": "boolean"
- },
- "include_publicity_rights": {
- "type": "boolean"
- },
- "include_publicity_rights_type": {
- "enum": [
- "public",
- "non-public"
- ],
- "type": "string"
- },
- "include_security_policy": {
- "type": "boolean"
- },
- "include_security_policy_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_security_policy_fedramp_auth": {
- "type": "boolean"
- },
- "include_security_policy_hitrust": {
- "type": "boolean"
- },
- "include_security_policy_include_annual_maintenance": {
- "type": "boolean"
- },
- "include_security_policy_include_other": {
- "type": "boolean"
- },
- "include_security_policy_include_other_val": {
- "type": "string"
- },
- "include_security_policy_iso27001": {
- "type": "boolean"
- },
- "include_security_policy_location": {
- "type": "string"
- },
- "include_security_policy_pci1": {
- "type": "boolean"
- },
- "include_security_policy_pci2": {
- "type": "boolean"
- },
- "include_security_policy_penetration_testing": {
- "type": "boolean"
- },
- "include_security_policy_soc2_type1": {
- "type": "boolean"
- },
- "include_security_policy_soc2_type2": {
- "type": "boolean"
- },
- "include_security_policy_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_unlimited_claims": {
- "type": "boolean"
- },
- "include_unlimited_claims_breach_of_confidentiality": {
- "type": "boolean"
- },
- "include_unlimited_claims_breach_of_confidentiality_negligence": {
- "type": "boolean"
- },
- "include_unlimited_claims_breach_of_privsec": {
- "type": "boolean"
- },
- "include_unlimited_claims_breach_of_privsec_negligence": {
- "type": "boolean"
- },
- "include_unlimited_claims_include_other": {
- "type": "boolean"
- },
- "include_unlimited_claims_indemnification_obligation": {
- "type": "boolean"
- },
- "include_unlimited_claims_negligence": {
- "type": "boolean"
- },
- "include_unlimited_claims_other": {
- "type": "string"
- },
- "increased_cap_amount_currency": {
- "type": "number"
- },
- "increased_cap_amount_period_currency": {
- "type": "number"
- },
- "increased_cap_amount_period_qty": {
- "type": "number"
- },
- "increased_cap_amount_qty": {
- "type": "number"
- },
- "increased_cap_amount_type": {
- "enum": [
- "qty",
- "currency",
- "period"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- "psa_statement_of_work_attributes": {
- "additionalProperties": false,
- "description": "Override psa statement of work terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "additional_changes": {
- "type": "string"
- },
- "cost": {
- "type": "number"
- },
- "description": {
- "type": "string"
- },
- "fee_type": {
- "type": "string"
- },
- "fees_attributes": {
- "additionalProperties": {
- "anyOf": [
- {
- "additionalProperties": false,
- "description": "Fees::Flat (fee_type \"flat\"). A fixed recurring fee, e.g. a platform subscription. Set type to \"Fees::Flat\" or fee_type to \"flat\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "Fixed amount in the order form's fees_currency, charged per fee_period. A plain amount, not cents: 20 means 20.00.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"flat\". Alternative to type.",
- "enum": [
- "flat"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Flat\". Optional when fee_type is set.",
- "enum": [
- "Fees::Flat"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Discount (fee_type \"discount\"). A discount, as a fixed amount or a percentage, applied forever, once, or for a number of months. Set type to \"Fees::Discount\" or fee_type to \"discount\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "Discount size: an amount in fees_currency when discount_type is fixed_amount (a plain amount, not cents: 20 means 20.00), or a percentage (e.g. 10 for 10%) when it is percentage.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "discount_duration_amount": {
- "description": "Number of months the discount applies. Required when discount_duration_type is multiple_months.",
- "type": "number"
- },
- "discount_duration_type": {
- "description": "How long the discount applies. multiple_months also needs discount_duration_amount.",
- "enum": [
- "forever",
- "once",
- "multiple_months"
- ],
- "type": "string"
- },
- "discount_type": {
- "description": "Whether cost is a currency amount or a percentage.",
- "enum": [
- "fixed_amount",
- "percentage"
- ],
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"discount\". Alternative to type.",
- "enum": [
- "discount"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Discount\". Optional when fee_type is set.",
- "enum": [
- "Fees::Discount"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Cost (fee_type \"cost\"). A per-unit fee: price per unit times quantity, e.g. seats. Set type to \"Fees::Cost\" or fee_type to \"cost\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "Price per unit in fees_currency. The row total is quantity x cost. A plain amount, not cents: 20 means 20.00.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"cost\". Alternative to type.",
- "enum": [
- "cost"
- ],
- "type": "string"
- },
- "quantity": {
- "description": "Number of units.",
- "type": "number"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Cost\". Optional when fee_type is set.",
- "enum": [
- "Fees::Cost"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Attachment (fee_type \"attachment\"). A fee described in an uploaded attachment instead of in the table. Set type to \"Fees::Attachment\" or fee_type to \"attachment\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "attachment_id": {
- "description": "ID of an attachment uploaded with upload-attachment.",
- "type": "string"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"attachment\". Alternative to type.",
- "enum": [
- "attachment"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Attachment\". Optional when fee_type is set.",
- "enum": [
- "Fees::Attachment"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Graduated (fee_type \"graduated\"). Tiered pricing, with the price set per tier in graduated_fee_tiers_attributes. Set type to \"Fees::Graduated\" or fee_type to \"graduated\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"graduated\". Alternative to type.",
- "enum": [
- "graduated"
- ],
- "type": "string"
- },
- "graduated_fee_tiers_attributes": {
- "additionalProperties": {
- "additionalProperties": false,
- "properties": {
- "flat_price": {
- "type": "number"
- },
- "price_per_unit": {
- "type": "string"
- },
- "upper_limit": {
- "type": "number"
- }
- },
- "type": "object"
- },
- "description": "Graduated fee tiers. Use string keys such as \"0\", \"1\".",
- "propertyNames": {
- "type": "string"
- },
- "type": "object"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Graduated\". Optional when fee_type is set.",
- "enum": [
- "Fees::Graduated"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Included (fee_type \"included\"). An item included at no charge. Set type to \"Fees::Included\" or fee_type to \"included\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"included\". Alternative to type.",
- "enum": [
- "included"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Included\". Optional when fee_type is set.",
- "enum": [
- "Fees::Included"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Metered (fee_type \"metered\"). Usage-based pricing, billed per unit used. Set type to \"Fees::Metered\" or fee_type to \"metered\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "Price per unit of usage in fees_currency. A plain amount, not cents: 20 means 20.00.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"metered\". Alternative to type.",
- "enum": [
- "metered"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Metered\". Optional when fee_type is set.",
- "enum": [
- "Fees::Metered"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::OneTime (fee_type \"one_time\"). A one-time charge, such as a setup fee. Set type to \"Fees::OneTime\" or fee_type to \"one_time\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "One-time amount in fees_currency, charged once rather than per fee_period. A plain amount, not cents: 20 means 20.00.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"one_time\". Alternative to type.",
- "enum": [
- "one_time"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::OneTime\". Optional when fee_type is set.",
- "enum": [
- "Fees::OneTime"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Text (fee_type \"text\"). A fee term described in free text. Set type to \"Fees::Text\" or fee_type to \"text\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"text\". Alternative to type.",
- "enum": [
- "text"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Text\". Optional when fee_type is set.",
- "enum": [
- "Fees::Text"
- ],
- "type": "string"
- }
- },
- "type": "object"
- }
- ]
- },
- "description": "Fee line items. Use string keys such as \"0\", \"1\". Replaces template fees when provided.",
- "propertyNames": {
- "type": "string"
- },
- "type": "object"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_additional_changes": {
- "type": "boolean"
- },
- "include_customer_obligation": {
- "type": "boolean"
- },
- "include_customer_obligation_val": {
- "type": "string"
- },
- "include_deliverables": {
- "type": "boolean"
- },
- "include_deliverables_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_deliverables_description": {
- "type": "string"
- },
- "include_deliverables_include_acceptance": {
- "type": "boolean"
- },
- "include_deliverables_include_attachment": {
- "type": "boolean"
- },
- "include_deliverables_include_draft_deliverables": {
- "type": "boolean"
- },
- "include_deliverables_rejection_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_deliverables_rejection_unit": {
- "enum": [
- "hours",
- "days",
- "weeks",
- "months"
- ],
- "type": "string"
- },
- "include_deliverables_resubmission_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_deliverables_resubmission_unit": {
- "enum": [
- "hours",
- "days",
- "weeks",
- "months"
- ],
- "type": "string"
- },
- "include_fees_other": {
- "type": "boolean"
- },
- "include_fees_other_val": {
- "type": "string"
- },
- "include_fees_table": {
- "type": "boolean"
- },
- "include_fees_table_total": {
- "type": "boolean"
- },
- "include_fees_travel": {
- "type": "boolean"
- },
- "include_fees_travel_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_fees_travel_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_fees_travel_val": {
- "type": "string"
- },
- "include_third_party_customer": {
- "type": "boolean"
- },
- "include_third_party_include_description": {
- "type": "boolean"
- },
- "include_third_party_include_description_val": {
- "type": "string"
- },
- "include_third_party_materials": {
- "type": "boolean"
- },
- "include_third_party_provider": {
- "type": "boolean"
- },
- "include_time_of_assignment": {
- "type": "boolean"
- },
- "include_time_of_assignment_type": {
- "enum": [
- "created",
- "paid"
- ],
- "type": "string"
- },
- "invoice_period_description": {
- "type": "string"
- },
- "negotiations_allowed": {
- "description": "When true, the recipient can propose changes to the statement of work, even when the agreement-level `negotiations_allowed` is false. This only covers the statement of work.",
- "type": "boolean"
- },
- "payment_period": {
- "type": "number"
- },
- "payment_period_other": {
- "type": "string"
- },
- "payment_period_timeframe": {
- "enum": [
- "receipt",
- "invoice",
- "Customer's receipt of invoice",
- "date of invoice"
- ],
- "type": "string"
- },
- "payment_period_type": {
- "enum": [
- "standard",
- "other"
- ],
- "type": "string"
- },
- "payment_period_unit": {
- "enum": [
- "day(s)",
- "week(s)",
- "month(s)",
- "quarter(s)",
- "year(s)"
- ],
- "type": "string"
- },
- "quantity": {
- "type": "number"
- },
- "services_description": {
- "type": "string"
- },
- "sow_date": {
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "sow_date_type": {
- "enum": [
- "signature",
- "date"
- ],
- "type": "string"
- },
- "sow_term_amount": {
- "type": "number"
- },
- "sow_term_date": {
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "sow_term_type": {
- "enum": [
- "deliverables",
- "period",
- "date"
- ],
- "type": "string"
- },
- "sow_term_unit": {
- "enum": [
- "month(s)",
- "quarter(s)",
- "year(s)"
- ],
- "type": "string"
- },
- "type": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "recipient_email": {
- "format": "email",
- "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
- "type": "string"
- },
- "recipient_name": {
- "type": "string"
- },
- "recipient_notice_email_address": {
- "description": "Email address for legal notices to the recipient.",
- "format": "email",
- "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
- "type": "string"
- },
- "recipient_organization": {
- "type": "string"
- },
- "sender_last_to_sign": {
- "description": "When true, your signer signs after the recipient.",
- "type": "boolean"
- },
- "sender_notice_email_address": {
- "description": "Email address for legal notices to the sender.",
- "format": "email",
- "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
- "type": "string"
- },
- "software_license_attributes": {
- "additionalProperties": false,
- "description": "Override software license terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "effective_date": {
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "effective_date_type": {
- "enum": [
- "signature",
- "date"
- ],
- "type": "string"
- },
- "general_cap_amount": {
- "type": "number"
- },
- "general_cap_amount_type": {
- "enum": [
- "preceding",
- "base",
- "period"
- ],
- "type": "string"
- },
- "general_cap_period_currency": {
- "type": "number"
- },
- "general_cap_period_qty": {
- "type": "number"
- },
- "general_cap_preceding_amount": {
- "type": "number"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_additional_warranties": {
- "type": "boolean"
- },
- "include_additional_warranties_by_customer": {
- "type": "string"
- },
- "include_additional_warranties_by_provider": {
- "type": "string"
- },
- "include_additional_warranties_include_by_customer": {
- "type": "boolean"
- },
- "include_additional_warranties_include_by_provider": {
- "type": "boolean"
- },
- "include_ai_addendum": {
- "type": "boolean"
- },
- "include_ai_addendum_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_covered_claims": {
- "type": "boolean"
- },
- "include_covered_claims_customer_claims": {
- "type": "string"
- },
- "include_covered_claims_include_customer_claims": {
- "type": "boolean"
- },
- "include_covered_claims_include_provider_claims": {
- "type": "boolean"
- },
- "include_covered_claims_provider_claims": {
- "type": "string"
- },
- "include_dpa": {
- "type": "boolean"
- },
- "include_dpa_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_dpa_location": {
- "type": "string"
- },
- "include_dpa_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_increased_cap_amount": {
- "type": "boolean"
- },
- "include_increased_claims": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_confidentiality": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_confidentiality_negligence": {
- "type": "boolean"
- },
- "include_increased_claims_include_other": {
- "type": "boolean"
- },
- "include_increased_claims_indemnification_obligation": {
- "type": "boolean"
- },
- "include_increased_claims_negligence": {
- "type": "boolean"
- },
- "include_increased_claims_other": {
- "type": "string"
- },
- "include_increased_claims_restrictions": {
- "type": "boolean"
- },
- "include_unlimited_claims": {
- "type": "boolean"
- },
- "include_unlimited_claims_breach_of_confidentiality": {
- "type": "boolean"
- },
- "include_unlimited_claims_breach_of_confidentiality_negligence": {
- "type": "boolean"
- },
- "include_unlimited_claims_include_other": {
- "type": "boolean"
- },
- "include_unlimited_claims_indemnification_obligation": {
- "type": "boolean"
- },
- "include_unlimited_claims_license_or_restrictions": {
- "type": "boolean"
- },
- "include_unlimited_claims_negligence": {
- "type": "boolean"
- },
- "include_unlimited_claims_other": {
- "type": "string"
- },
- "increased_cap_amount_currency": {
- "type": "number"
- },
- "increased_cap_amount_period_currency": {
- "type": "number"
- },
- "increased_cap_amount_period_qty": {
- "type": "number"
- },
- "increased_cap_amount_qty": {
- "type": "number"
- },
- "increased_cap_amount_type": {
- "enum": [
- "qty",
- "currency",
- "period"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- "software_license_order_form_attributes": {
- "additionalProperties": false,
- "description": "Override software license order form terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "additional_changes": {
- "type": "string"
- },
- "deletion_procedure_include_custom": {
- "type": "boolean"
- },
- "deletion_procedure_include_custom_description": {
- "type": "string"
- },
- "deletion_procedure_include_customer_disable": {
- "type": "boolean"
- },
- "deletion_procedure_include_customer_proof": {
- "type": "boolean"
- },
- "deletion_procedure_include_provider_disable": {
- "type": "boolean"
- },
- "fee_custom_unit": {
- "type": "string"
- },
- "fee_period": {
- "enum": [
- "Subscription Period",
- "month",
- "year",
- "Custom unit"
- ],
- "type": "string"
- },
- "fees_attributes": {
- "additionalProperties": {
- "anyOf": [
- {
- "additionalProperties": false,
- "description": "Fees::Flat (fee_type \"flat\"). A fixed recurring fee, e.g. a platform subscription. Set type to \"Fees::Flat\" or fee_type to \"flat\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "Fixed amount in the order form's fees_currency, charged per fee_period. A plain amount, not cents: 20 means 20.00.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"flat\". Alternative to type.",
- "enum": [
- "flat"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Flat\". Optional when fee_type is set.",
- "enum": [
- "Fees::Flat"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Discount (fee_type \"discount\"). A discount, as a fixed amount or a percentage, applied forever, once, or for a number of months. Set type to \"Fees::Discount\" or fee_type to \"discount\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "Discount size: an amount in fees_currency when discount_type is fixed_amount (a plain amount, not cents: 20 means 20.00), or a percentage (e.g. 10 for 10%) when it is percentage.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "discount_duration_amount": {
- "description": "Number of months the discount applies. Required when discount_duration_type is multiple_months.",
- "type": "number"
- },
- "discount_duration_type": {
- "description": "How long the discount applies. multiple_months also needs discount_duration_amount.",
- "enum": [
- "forever",
- "once",
- "multiple_months"
- ],
- "type": "string"
- },
- "discount_type": {
- "description": "Whether cost is a currency amount or a percentage.",
- "enum": [
- "fixed_amount",
- "percentage"
- ],
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"discount\". Alternative to type.",
- "enum": [
- "discount"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Discount\". Optional when fee_type is set.",
- "enum": [
- "Fees::Discount"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Cost (fee_type \"cost\"). A per-unit fee: price per unit times quantity, e.g. seats. Set type to \"Fees::Cost\" or fee_type to \"cost\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "Price per unit in fees_currency. The row total is quantity x cost. A plain amount, not cents: 20 means 20.00.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"cost\". Alternative to type.",
- "enum": [
- "cost"
- ],
- "type": "string"
- },
- "quantity": {
- "description": "Number of units.",
- "type": "number"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Cost\". Optional when fee_type is set.",
- "enum": [
- "Fees::Cost"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Attachment (fee_type \"attachment\"). A fee described in an uploaded attachment instead of in the table. Set type to \"Fees::Attachment\" or fee_type to \"attachment\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "attachment_id": {
- "description": "ID of an attachment uploaded with upload-attachment.",
- "type": "string"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"attachment\". Alternative to type.",
- "enum": [
- "attachment"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Attachment\". Optional when fee_type is set.",
- "enum": [
- "Fees::Attachment"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Graduated (fee_type \"graduated\"). Tiered pricing, with the price set per tier in graduated_fee_tiers_attributes. Set type to \"Fees::Graduated\" or fee_type to \"graduated\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"graduated\". Alternative to type.",
- "enum": [
- "graduated"
- ],
- "type": "string"
- },
- "graduated_fee_tiers_attributes": {
- "additionalProperties": {
- "additionalProperties": false,
- "properties": {
- "flat_price": {
- "type": "number"
- },
- "price_per_unit": {
- "type": "string"
- },
- "upper_limit": {
- "type": "number"
- }
- },
- "type": "object"
- },
- "description": "Graduated fee tiers. Use string keys such as \"0\", \"1\".",
- "propertyNames": {
- "type": "string"
- },
- "type": "object"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Graduated\". Optional when fee_type is set.",
- "enum": [
- "Fees::Graduated"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Included (fee_type \"included\"). An item included at no charge. Set type to \"Fees::Included\" or fee_type to \"included\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"included\". Alternative to type.",
- "enum": [
- "included"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Included\". Optional when fee_type is set.",
- "enum": [
- "Fees::Included"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Metered (fee_type \"metered\"). Usage-based pricing, billed per unit used. Set type to \"Fees::Metered\" or fee_type to \"metered\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "Price per unit of usage in fees_currency. A plain amount, not cents: 20 means 20.00.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"metered\". Alternative to type.",
- "enum": [
- "metered"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Metered\". Optional when fee_type is set.",
- "enum": [
- "Fees::Metered"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::OneTime (fee_type \"one_time\"). A one-time charge, such as a setup fee. Set type to \"Fees::OneTime\" or fee_type to \"one_time\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "One-time amount in fees_currency, charged once rather than per fee_period. A plain amount, not cents: 20 means 20.00.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"one_time\". Alternative to type.",
- "enum": [
- "one_time"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::OneTime\". Optional when fee_type is set.",
- "enum": [
- "Fees::OneTime"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Text (fee_type \"text\"). A fee term described in free text. Set type to \"Fees::Text\" or fee_type to \"text\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"text\". Alternative to type.",
- "enum": [
- "text"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Text\". Optional when fee_type is set.",
- "enum": [
- "Fees::Text"
- ],
- "type": "string"
- }
- },
- "type": "object"
- }
- ]
- },
- "description": "Fee line items. Use string keys such as \"0\", \"1\". Replaces template fees when provided.",
- "propertyNames": {
- "type": "string"
- },
- "type": "object"
- },
- "fees_currency": {
- "enum": [
- "USD",
- "EUR",
- "GBP",
- "CAD",
- "AUD",
- "SGD",
- "ILS",
- "JPY",
- "CHF",
- "HKD"
- ],
- "type": "string"
- },
- "fees_include_fee_increase_upon_renewal": {
- "type": "boolean"
- },
- "fees_include_fee_increase_upon_renewal_fee": {
- "type": "number"
- },
- "fees_include_fee_increase_upon_renewal_type": {
- "enum": [
- "will",
- "may"
- ],
- "type": "string"
- },
- "fees_inclusive_of_taxes": {
- "type": "boolean"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_additional_changes": {
- "type": "boolean"
- },
- "include_license_compliance_verification": {
- "type": "boolean"
- },
- "include_license_compliance_verification_description": {
- "type": "string"
- },
- "include_license_limits": {
- "type": "boolean"
- },
- "include_license_limits_description": {
- "type": "string"
- },
- "include_payment_process_include_billing_email": {
- "type": "boolean"
- },
- "include_pilot_period": {
- "type": "boolean"
- },
- "include_pilot_period_duration_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_pilot_period_duration_type": {
- "enum": [
- "day",
- "week",
- "month"
- ],
- "type": "string"
- },
- "include_pilot_period_include_fees": {
- "type": "boolean"
- },
- "include_pilot_period_include_fees_amount": {
- "type": "number"
- },
- "include_pilot_period_include_modifications": {
- "type": "boolean"
- },
- "include_pilot_period_include_modifications_description": {
- "type": "string"
- },
- "include_services": {
- "type": "boolean"
- },
- "include_services_description": {
- "type": "string"
- },
- "negotiations_allowed": {
- "description": "When true, the recipient can propose changes to the order form, even when the agreement-level `negotiations_allowed` is false. This only covers the order form.",
- "type": "boolean"
- },
- "order_date_date": {
- "type": "string"
- },
- "order_date_type": {
- "enum": [
- "signature",
- "date",
- "other"
- ],
- "type": "string"
- },
- "payment_process_automatic_frequency": {
- "enum": [
- "monthly",
- "quarterly",
- "semiannually",
- "annually"
- ],
- "type": "string"
- },
- "payment_process_type": {
- "enum": [
- "automatic",
- "invoice",
- "custom"
- ],
- "type": "string"
- },
- "payment_process_type_custom_val": {
- "type": "string"
- },
- "payment_process_type_invoice_amount": {
- "type": "number"
- },
- "payment_process_type_invoice_custom_unit": {
- "type": "string"
- },
- "payment_process_type_invoice_duration": {
- "enum": [
- "day",
- "week",
- "month",
- "year",
- "day(s)",
- "week(s)",
- "month(s)",
- "year(s)"
- ],
- "type": "string"
- },
- "payment_process_type_invoice_duration_start": {
- "enum": [
- "Customer's receipt of invoice",
- "date of invoice"
- ],
- "type": "string"
- },
- "payment_process_type_invoice_type": {
- "enum": [
- "monthly",
- "quarterly",
- "semiannually",
- "annually",
- "Custom unit"
- ],
- "type": "string"
- },
- "permitted_uses_include_custom": {
- "type": "boolean"
- },
- "permitted_uses_include_custom_description": {
- "type": "string"
- },
- "permitted_uses_include_customers_affiliates": {
- "type": "boolean"
- },
- "permitted_uses_include_internal_business": {
- "type": "boolean"
- },
- "pilot_period_stripe_product_id": {
- "type": "string"
- },
- "software_description": {
- "type": "string"
- },
- "subscription_auto_renew": {
- "enum": [
- "days",
- "subscription_end"
- ],
- "type": "string"
- },
- "subscription_period": {
- "type": "number"
- },
- "subscription_period_unit": {
- "type": "string"
- },
- "subscription_renewal_notice_days": {
- "type": "number"
- },
- "warranty_period_description_amount": {
- "type": "number"
- },
- "warranty_period_description_duration": {
- "enum": [
- "day",
- "week",
- "month",
- "year"
- ],
- "type": "string"
- },
- "warranty_period_description_duration_start": {
- "enum": [
- "initial delivery of the Software",
- "delivery of the Software and each subsequent Update",
- "the Order Date"
- ],
- "type": "string"
- },
- "warranty_period_type": {
- "enum": [
- "description",
- "none"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- "test_agreement": {
- "description": "When true, marks the agreement as a test. Test agreements do not count against your monthly limit.",
- "type": "boolean"
- }
- },
- "required": [
- "recipient_name",
- "recipient_email"
- ],
- "type": "object"
- },
- "cc_users": {
- "items": {
- "format": "email",
- "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
- "type": "string"
- },
- "type": "array"
- },
- "draft": {
- "description": "When true, the agreement is saved as a draft and not sent to the recipient. Use POST /v1/agreements/{id}/send to send a draft agreement later.",
- "type": "boolean"
- },
- "owner_id": {
- "description": "User id of the agreement owner (sender).",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "signer_id": {
- "description": "User id of the signer from the owner's organization.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "template_id": {
- "description": "UUID of a template from `GET /v1/templates`. Accepts both Common Paper standard templates and uploaded PDF templates (`type` `uploaded_template`).",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- }
- },
- "required": [
- "template_id",
- "owner_id",
- "signer_id",
- "agreement"
- ],
- "type": "object"
- }
-]New value: +[
+ {
+ "additionalProperties": false,
+ "properties": {
+ "agreement": {
+ "additionalProperties": {},
+ "properties": {
+ "amendment_attributes": {
+ "additionalProperties": false,
+ "description": "Override amendment terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "amended_terms_attributes": {
+ "additionalProperties": {
+ "additionalProperties": false,
+ "properties": {
+ "description": {
+ "type": "string"
+ },
+ "term": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "description": "Amended terms. Use string keys such as \"0\", \"1\".",
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+ },
+ "amendment_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "amendment_date_type": {
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "type": "string"
+ },
+ "framework_terms_type": {
+ "type": "string"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "parent_agreement_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "underlying_agreement_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "underlying_agreement_type": {
+ "type": "string"
+ },
+ "underlying_agreement_val": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "baa_attributes": {
+ "additionalProperties": false,
+ "description": "Override baa terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "aggregation_limitations_permitted": {
+ "type": "boolean"
+ },
+ "aggregation_limitations_permitted_val": {
+ "type": "string"
+ },
+ "breach_notification_unit": {
+ "enum": [
+ "hours",
+ "business days",
+ "calendar days"
+ ],
+ "type": "string"
+ },
+ "breach_notification_val": {
+ "type": "number"
+ },
+ "business_associate_relationship_type": {
+ "enum": [
+ "provider",
+ "company"
+ ],
+ "type": "string"
+ },
+ "deidentification_limitations_include_purpose": {
+ "type": "boolean"
+ },
+ "deidentification_limitations_include_requirements": {
+ "type": "boolean"
+ },
+ "deidentification_limitations_permitted": {
+ "type": "boolean"
+ },
+ "deidentification_limitations_purpose_val": {
+ "type": "string"
+ },
+ "deidentification_limitations_requirements_val": {
+ "type": "string"
+ },
+ "designated_record_set_provider_maintains": {
+ "type": "boolean"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_aggregation_limitations": {
+ "type": "boolean"
+ },
+ "include_deidentification_limitations": {
+ "type": "boolean"
+ },
+ "include_limitations": {
+ "type": "boolean"
+ },
+ "include_offshore_limitations": {
+ "type": "boolean"
+ },
+ "include_subcontract_limitations": {
+ "type": "boolean"
+ },
+ "offshore_limitations_permitted": {
+ "type": "boolean"
+ },
+ "offshore_limitations_permitted_val": {
+ "type": "string"
+ },
+ "subcontract_limitations_include_notice": {
+ "type": "boolean"
+ },
+ "subcontract_limitations_include_permission": {
+ "type": "boolean"
+ },
+ "subcontract_limitations_notice_val": {
+ "type": "string"
+ },
+ "subcontract_limitations_permission_val": {
+ "type": "string"
+ },
+ "subcontract_limitations_permitted": {
+ "type": "boolean"
+ },
+ "underlying_agreement_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "underlying_agreement_type": {
+ "enum": [
+ "internal",
+ "external",
+ "none"
+ ],
+ "type": "string"
+ },
+ "underlying_agreement_val": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "billing_email": {
+ "description": "Email of the billing contact. Used when include_billing_info is true.",
+ "format": "email",
+ "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "billing_name": {
+ "description": "Name of the billing contact. Used when include_billing_info is true.",
+ "type": "string"
+ },
+ "billing_workflow_type": {
+ "description": "The type of billing workflow. Use \"link\" to provide a payment_link_url, or \"stripe\" for Stripe-managed billing.",
+ "enum": [
+ "link",
+ "stripe"
+ ],
+ "type": "string"
+ },
+ "chosen_courts_country": {
+ "description": "The country in which disputes will be resolved.",
+ "type": "string"
+ },
+ "chosen_courts_region": {
+ "description": "The state or region in which disputes will be resolved.",
+ "type": "string"
+ },
+ "csa_attributes": {
+ "additionalProperties": false,
+ "description": "Override csa terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "customer_description": {
+ "type": "string"
+ },
+ "effective_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "effective_date_marketplace": {
+ "enum": [
+ "AWS",
+ "GCP",
+ "Azure"
+ ],
+ "type": "string"
+ },
+ "effective_date_type": {
+ "enum": [
+ "signature",
+ "date",
+ "marketplace_acceptance"
+ ],
+ "type": "string"
+ },
+ "general_cap_amount": {
+ "type": "number"
+ },
+ "general_cap_amount_type": {
+ "enum": [
+ "preceding",
+ "base",
+ "period"
+ ],
+ "type": "string"
+ },
+ "general_cap_period_currency": {
+ "type": "number"
+ },
+ "general_cap_period_qty": {
+ "type": "number"
+ },
+ "general_cap_preceding_amount": {
+ "type": "number"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_acceptable_use_policy": {
+ "type": "boolean"
+ },
+ "include_acceptable_use_policy_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_acceptable_use_policy_location": {
+ "type": "string"
+ },
+ "include_acceptable_use_policy_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_additional_warranties": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_by_customer": {
+ "type": "string"
+ },
+ "include_additional_warranties_by_provider": {
+ "type": "string"
+ },
+ "include_additional_warranties_include_by_customer": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_include_by_provider": {
+ "type": "boolean"
+ },
+ "include_ai_addendum": {
+ "type": "boolean"
+ },
+ "include_ai_addendum_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_covered_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_customer_claims": {
+ "type": "string"
+ },
+ "include_covered_claims_include_customer_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_include_provider_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_provider_claims": {
+ "type": "string"
+ },
+ "include_dpa": {
+ "type": "boolean"
+ },
+ "include_dpa_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_dpa_location": {
+ "type": "string"
+ },
+ "include_dpa_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_increased_cap_amount": {
+ "type": "boolean"
+ },
+ "include_increased_claims": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_confidentiality": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_confidentiality_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_privsec": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_privsec_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_other": {
+ "type": "boolean"
+ },
+ "include_increased_claims_indemnification_obligation": {
+ "type": "boolean"
+ },
+ "include_increased_claims_other": {
+ "type": "string"
+ },
+ "include_insurance_minimums": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_add_customer": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_add_customer_com_gen_liability": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_add_customer_cyber_liability": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_add_customer_errors_omissions": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_additional_information": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_additional_information_text": {
+ "type": "string"
+ },
+ "include_insurance_minimums_cyber_liability_aggregate": {
+ "type": "number"
+ },
+ "include_insurance_minimums_cyber_liability_minimum": {
+ "type": "number"
+ },
+ "include_insurance_minimums_employer_liability_aggregate": {
+ "type": "number"
+ },
+ "include_insurance_minimums_employer_liability_minimum": {
+ "type": "number"
+ },
+ "include_insurance_minimums_general_liability_aggregate": {
+ "type": "number"
+ },
+ "include_insurance_minimums_general_liability_minimum": {
+ "type": "number"
+ },
+ "include_insurance_minimums_include_cyber_liability": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_include_employer_liability": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_include_general_liability": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_include_workers_compensation": {
+ "type": "boolean"
+ },
+ "include_publicity_rights": {
+ "type": "boolean"
+ },
+ "include_publicity_rights_type": {
+ "enum": [
+ "public",
+ "non-public"
+ ],
+ "type": "string"
+ },
+ "include_security_policy": {
+ "type": "boolean"
+ },
+ "include_security_policy_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_security_policy_fedramp_auth": {
+ "type": "boolean"
+ },
+ "include_security_policy_hipaa": {
+ "type": "boolean"
+ },
+ "include_security_policy_hitrust": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_annual_maintenance": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_location": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_other": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_reasonable_efforts": {
+ "type": "boolean"
+ },
+ "include_security_policy_iso27001": {
+ "type": "boolean"
+ },
+ "include_security_policy_location": {
+ "type": "string"
+ },
+ "include_security_policy_other": {
+ "type": "string"
+ },
+ "include_security_policy_pci1": {
+ "type": "boolean"
+ },
+ "include_security_policy_pci2": {
+ "type": "boolean"
+ },
+ "include_security_policy_penetration_testing": {
+ "type": "boolean"
+ },
+ "include_security_policy_soc2": {
+ "type": "boolean"
+ },
+ "include_security_policy_soc2_type2": {
+ "type": "boolean"
+ },
+ "include_security_policy_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_supercap": {
+ "description": "CSA 3.0 renamed `include_increased_cap_amount` to `include_supercap`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_increased_cap_amount`. Sending the other spelling returns a 422.",
+ "type": "boolean"
+ },
+ "include_uncapped_claims": {
+ "description": "CSA 3.0 renamed `include_unlimited_claims` to `include_uncapped_claims`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims`. Sending the other spelling returns a 422.",
+ "type": "boolean"
+ },
+ "include_uncapped_claims_breach_of_confidentiality": {
+ "description": "CSA 3.0 renamed `include_unlimited_claims_breach_of_confidentiality` to `include_uncapped_claims_breach_of_confidentiality`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_breach_of_confidentiality`. Sending the other spelling returns a 422.",
+ "type": "boolean"
+ },
+ "include_uncapped_claims_breach_of_confidentiality_negligence": {
+ "description": "CSA 3.0 renamed `include_unlimited_claims_breach_of_confidentiality_negligence` to `include_uncapped_claims_breach_of_confidentiality_negligence`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_breach_of_confidentiality_negligence`. Sending the other spelling returns a 422.",
+ "type": "boolean"
+ },
+ "include_uncapped_claims_breach_of_privsec": {
+ "description": "CSA 3.0 renamed `include_unlimited_claims_breach_of_privsec` to `include_uncapped_claims_breach_of_privsec`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_breach_of_privsec`. Sending the other spelling returns a 422.",
+ "type": "boolean"
+ },
+ "include_uncapped_claims_breach_of_privsec_negligence": {
+ "description": "CSA 3.0 renamed `include_unlimited_claims_breach_of_privsec_negligence` to `include_uncapped_claims_breach_of_privsec_negligence`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_breach_of_privsec_negligence`. Sending the other spelling returns a 422.",
+ "type": "boolean"
+ },
+ "include_uncapped_claims_include_other": {
+ "description": "CSA 3.0 renamed `include_unlimited_claims_include_other` to `include_uncapped_claims_include_other`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_include_other`. Sending the other spelling returns a 422.",
+ "type": "boolean"
+ },
+ "include_uncapped_claims_indemnification_obligation": {
+ "description": "CSA 3.0 renamed `include_unlimited_claims_indemnification_obligation` to `include_uncapped_claims_indemnification_obligation`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_indemnification_obligation`. Sending the other spelling returns a 422.",
+ "type": "boolean"
+ },
+ "include_uncapped_claims_other": {
+ "description": "CSA 3.0 renamed `include_unlimited_claims_other` to `include_uncapped_claims_other`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_other`. Sending the other spelling returns a 422.",
+ "type": "boolean"
+ },
+ "include_unlimited_claims": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_confidentiality": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_confidentiality_negligence": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_privsec": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_privsec_negligence": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_include_other": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_indemnification_obligation": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_other": {
+ "type": "string"
+ },
+ "increased_cap_amount_currency": {
+ "type": "number"
+ },
+ "increased_cap_amount_period_currency": {
+ "type": "number"
+ },
+ "increased_cap_amount_period_qty": {
+ "type": "number"
+ },
+ "increased_cap_amount_qty": {
+ "type": "number"
+ },
+ "increased_cap_amount_type": {
+ "enum": [
+ "qty",
+ "currency",
+ "period"
+ ],
+ "type": "string"
+ },
+ "provider": {
+ "type": "string"
+ },
+ "supercap_currency": {
+ "description": "CSA 3.0 renamed `increased_cap_amount_currency` to `supercap_currency`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `increased_cap_amount_currency`. Sending the other spelling returns a 422.",
+ "type": "number"
+ },
+ "supercap_period_currency": {
+ "description": "CSA 3.0 renamed `increased_cap_amount_period_currency` to `supercap_period_currency`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `increased_cap_amount_period_currency`. Sending the other spelling returns a 422.",
+ "type": "number"
+ },
+ "supercap_period_qty": {
+ "description": "CSA 3.0 renamed `increased_cap_amount_period_qty` to `supercap_period_qty`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `increased_cap_amount_period_qty`. Sending the other spelling returns a 422.",
+ "type": "number"
+ },
+ "supercap_qty": {
+ "description": "CSA 3.0 renamed `increased_cap_amount_qty` to `supercap_qty`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `increased_cap_amount_qty`. Sending the other spelling returns a 422.",
+ "type": "number"
+ },
+ "supercap_type": {
+ "description": "CSA 3.0 renamed `increased_cap_amount_type` to `supercap_type`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `increased_cap_amount_type`. Sending the other spelling returns a 422.",
+ "type": "number"
+ }
+ },
+ "type": "object"
+ },
+ "csa_order_form_attributes": {
+ "additionalProperties": false,
+ "description": "Override csa order form terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "additional_changes": {
+ "type": "string"
+ },
+ "additional_parameters_or_limitations": {
+ "type": "string"
+ },
+ "affiliates_as_users": {
+ "type": "boolean"
+ },
+ "cloud_service_description": {
+ "type": "string"
+ },
+ "consumption_units": {
+ "type": "string"
+ },
+ "fee_amount": {
+ "type": "number"
+ },
+ "fee_custom_unit": {
+ "type": "string"
+ },
+ "fee_period": {
+ "enum": [
+ "Subscription Period",
+ "month",
+ "year",
+ "User",
+ "Custom unit"
+ ],
+ "type": "string"
+ },
+ "fees_attributes": {
+ "additionalProperties": {
+ "anyOf": [
+ {
+ "additionalProperties": false,
+ "description": "Fees::Flat (fee_type \"flat\"). A fixed recurring fee, e.g. a platform subscription. Set type to \"Fees::Flat\" or fee_type to \"flat\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Fixed amount in the order form's fees_currency, charged per fee_period. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"flat\". Alternative to type.",
+ "enum": [
+ "flat"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Flat\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Flat"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Discount (fee_type \"discount\"). A discount, as a fixed amount or a percentage, applied forever, once, or for a number of months. Set type to \"Fees::Discount\" or fee_type to \"discount\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Discount size: an amount in fees_currency when discount_type is fixed_amount (a plain amount, not cents: 20 means 20.00), or a percentage (e.g. 10 for 10%) when it is percentage.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "discount_duration_amount": {
+ "description": "Number of months the discount applies. Required when discount_duration_type is multiple_months.",
+ "type": "number"
+ },
+ "discount_duration_type": {
+ "description": "How long the discount applies. multiple_months also needs discount_duration_amount.",
+ "enum": [
+ "forever",
+ "once",
+ "multiple_months"
+ ],
+ "type": "string"
+ },
+ "discount_type": {
+ "description": "Whether cost is a currency amount or a percentage.",
+ "enum": [
+ "fixed_amount",
+ "percentage"
+ ],
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"discount\". Alternative to type.",
+ "enum": [
+ "discount"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Discount\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Discount"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Cost (fee_type \"cost\"). A per-unit fee: price per unit times quantity, e.g. seats. Set type to \"Fees::Cost\" or fee_type to \"cost\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Price per unit in fees_currency. The row total is quantity x cost. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"cost\". Alternative to type.",
+ "enum": [
+ "cost"
+ ],
+ "type": "string"
+ },
+ "quantity": {
+ "description": "Number of units.",
+ "type": "number"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Cost\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Cost"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Attachment (fee_type \"attachment\"). A fee described in an uploaded attachment instead of in the table. Set type to \"Fees::Attachment\" or fee_type to \"attachment\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "attachment_id": {
+ "description": "ID of an attachment uploaded with upload-attachment.",
+ "type": "string"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"attachment\". Alternative to type.",
+ "enum": [
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Attachment\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Attachment"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Graduated (fee_type \"graduated\"). Tiered pricing, with the price set per tier in graduated_fee_tiers_attributes. Set type to \"Fees::Graduated\" or fee_type to \"graduated\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"graduated\". Alternative to type.",
+ "enum": [
+ "graduated"
+ ],
+ "type": "string"
+ },
+ "graduated_fee_tiers_attributes": {
+ "additionalProperties": {
+ "additionalProperties": false,
+ "properties": {
+ "flat_price": {
+ "type": "number"
+ },
+ "price_per_unit": {
+ "type": "string"
+ },
+ "upper_limit": {
+ "type": "number"
+ }
+ },
+ "type": "object"
+ },
+ "description": "Graduated fee tiers. Use string keys such as \"0\", \"1\".",
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Graduated\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Graduated"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Included (fee_type \"included\"). An item included at no charge. Set type to \"Fees::Included\" or fee_type to \"included\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"included\". Alternative to type.",
+ "enum": [
+ "included"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Included\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Included"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Metered (fee_type \"metered\"). Usage-based pricing, billed per unit used. Set type to \"Fees::Metered\" or fee_type to \"metered\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Price per unit of usage in fees_currency. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"metered\". Alternative to type.",
+ "enum": [
+ "metered"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Metered\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Metered"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::OneTime (fee_type \"one_time\"). A one-time charge, such as a setup fee. Set type to \"Fees::OneTime\" or fee_type to \"one_time\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "One-time amount in fees_currency, charged once rather than per fee_period. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"one_time\". Alternative to type.",
+ "enum": [
+ "one_time"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::OneTime\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::OneTime"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Text (fee_type \"text\"). A fee term described in free text. Set type to \"Fees::Text\" or fee_type to \"text\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"text\". Alternative to type.",
+ "enum": [
+ "text"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Text\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Text"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ }
+ ]
+ },
+ "description": "Fee table rows, keyed by string index (\"0\", \"1\", ...). Replaces the template's fees when provided. Each row sets type or fee_type to pick the fee class. Amounts are in the order form's fees_currency and, for recurring fees, are charged per fee_period.",
+ "examples": [
+ {
+ "0": {
+ "cost": 2000,
+ "description": "Platform subscription",
+ "type": "Fees::Flat"
+ }
+ },
+ {
+ "0": {
+ "cost": 50,
+ "description": "Seats",
+ "fee_type": "cost",
+ "quantity": 10
+ },
+ "1": {
+ "cost": 10,
+ "description": "Launch discount",
+ "discount_duration_amount": 3,
+ "discount_duration_type": "multiple_months",
+ "discount_type": "percentage",
+ "fee_type": "discount"
+ }
+ }
+ ],
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+ },
+ "fees_currency": {
+ "enum": [
+ "USD",
+ "EUR",
+ "GBP",
+ "CAD",
+ "AUD",
+ "SGD",
+ "ILS",
+ "JPY",
+ "CHF",
+ "HKD"
+ ],
+ "type": "string"
+ },
+ "fees_include_fee_increase_upon_renewal": {
+ "type": "boolean"
+ },
+ "fees_include_fee_increase_upon_renewal_fee": {
+ "type": "number"
+ },
+ "fees_include_fee_increase_upon_renewal_type": {
+ "enum": [
+ "will",
+ "may"
+ ],
+ "type": "string"
+ },
+ "fees_inclusive_of_taxes": {
+ "type": "boolean"
+ },
+ "framework_terms_type": {
+ "enum": [
+ "new",
+ "existing",
+ "description"
+ ],
+ "type": "string"
+ },
+ "free_trial_days": {
+ "type": "number"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_additional_changes": {
+ "type": "boolean"
+ },
+ "include_additional_parameters_or_limitations": {
+ "type": "boolean"
+ },
+ "include_consumption": {
+ "type": "boolean"
+ },
+ "include_fees": {
+ "type": "boolean"
+ },
+ "include_fees_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_fees_include_attachment": {
+ "type": "boolean"
+ },
+ "include_fees_other": {
+ "type": "boolean"
+ },
+ "include_fees_other_val": {
+ "type": "string"
+ },
+ "include_fees_table": {
+ "type": "boolean"
+ },
+ "include_fees_table_period": {
+ "enum": [
+ "Subscription Period",
+ "month",
+ "year",
+ "User"
+ ],
+ "type": "string"
+ },
+ "include_free_trial": {
+ "type": "boolean"
+ },
+ "include_max_users": {
+ "type": "boolean"
+ },
+ "include_pilot_period": {
+ "type": "boolean"
+ },
+ "include_pilot_period_duration_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_pilot_period_duration_type": {
+ "enum": [
+ "day",
+ "week",
+ "month"
+ ],
+ "type": "string"
+ },
+ "include_pilot_period_include_fees": {
+ "type": "boolean"
+ },
+ "include_pilot_period_include_fees_amount": {
+ "type": "number"
+ },
+ "include_pilot_period_include_modifications": {
+ "type": "boolean"
+ },
+ "include_pilot_period_include_modifications_description": {
+ "type": "string"
+ },
+ "include_product_support": {
+ "type": "boolean"
+ },
+ "include_product_support_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_product_support_description": {
+ "type": "string"
+ },
+ "include_product_support_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_professional_services": {
+ "type": "boolean"
+ },
+ "include_professional_services_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_professional_services_custom_name": {
+ "type": "string"
+ },
+ "include_professional_services_description": {
+ "type": "string"
+ },
+ "include_professional_services_end_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "include_professional_services_fees_description": {
+ "type": "string"
+ },
+ "include_professional_services_include_end_date": {
+ "type": "boolean"
+ },
+ "include_professional_services_include_fees_description": {
+ "type": "boolean"
+ },
+ "include_professional_services_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_sla": {
+ "type": "boolean"
+ },
+ "include_sla_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_sla_description": {
+ "type": "string"
+ },
+ "include_sla_include_response_time": {
+ "type": "boolean"
+ },
+ "include_sla_include_response_time_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_sla_include_response_time_credit": {
+ "type": "number"
+ },
+ "include_sla_include_response_time_duration": {
+ "enum": [
+ "hour",
+ "day",
+ "week",
+ "month",
+ "hours"
+ ],
+ "type": "string"
+ },
+ "include_sla_include_response_time_support_channel": {
+ "type": "string"
+ },
+ "include_sla_include_target_uptime": {
+ "type": "boolean"
+ },
+ "include_sla_maintenance_notice": {
+ "type": "boolean"
+ },
+ "include_sla_maintenance_window": {
+ "type": "boolean"
+ },
+ "include_sla_maintenance_window_type": {
+ "enum": [
+ "standard",
+ "none"
+ ],
+ "type": "string"
+ },
+ "include_sla_standard_maintenance_notice_qty": {
+ "type": "number"
+ },
+ "include_sla_standard_maintenance_notice_unit": {
+ "enum": [
+ "hour",
+ "day",
+ "week",
+ "month"
+ ],
+ "type": "string"
+ },
+ "include_sla_standard_maintenance_window_end_time": {
+ "type": "string"
+ },
+ "include_sla_standard_maintenance_window_friday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_monday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_saturday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_start_time": {
+ "type": "string"
+ },
+ "include_sla_standard_maintenance_window_sunday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_thursday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_time_zone": {
+ "type": "string"
+ },
+ "include_sla_standard_maintenance_window_tuesday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_wednesday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_target_uptime": {
+ "type": "number"
+ },
+ "include_sla_type": {
+ "enum": [
+ "description",
+ "standard",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_subscription_start_date": {
+ "type": "boolean"
+ },
+ "include_subscription_start_date_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "include_usage_review": {
+ "type": "boolean"
+ },
+ "include_usage_review_val": {
+ "type": "string"
+ },
+ "include_use_limitations": {
+ "type": "boolean"
+ },
+ "include_use_limitations_val": {
+ "type": "string"
+ },
+ "invoice_period": {
+ "enum": [
+ "monthly",
+ "quarterly",
+ "semiannually",
+ "annually",
+ "Custom unit",
+ "Monthly",
+ "Quarterly",
+ "Semiannually",
+ "Annually"
+ ],
+ "type": "string"
+ },
+ "invoice_period_custom_unit": {
+ "type": "string"
+ },
+ "max_consumption": {
+ "type": "number"
+ },
+ "max_users": {
+ "type": "number"
+ },
+ "negotiations_allowed": {
+ "description": "When true, the recipient can propose changes to the order form, even when the agreement-level `negotiations_allowed` is false. This only covers the order form.",
+ "type": "boolean"
+ },
+ "order_date_date": {
+ "type": "string"
+ },
+ "order_date_other": {
+ "type": "string"
+ },
+ "order_date_type": {
+ "enum": [
+ "signature",
+ "date",
+ "other"
+ ],
+ "type": "string"
+ },
+ "payment_period": {
+ "type": "number"
+ },
+ "payment_period_timeframe": {
+ "enum": [
+ "Customer's receipt of invoice",
+ "date of invoice"
+ ],
+ "type": "string"
+ },
+ "payment_period_unit": {
+ "enum": [
+ "day(s)",
+ "week(s)",
+ "month(s)",
+ "marketplace_acceptance"
+ ],
+ "type": "string"
+ },
+ "payment_process_automatic_frequency": {
+ "enum": [
+ "monthly",
+ "quarterly",
+ "semiannually",
+ "annually"
+ ],
+ "type": "string"
+ },
+ "payment_process_type": {
+ "enum": [
+ "automatic",
+ "invoice",
+ "custom",
+ "marketplace_acceptance"
+ ],
+ "type": "string"
+ },
+ "payment_process_type_custom_val": {
+ "type": "string"
+ },
+ "payment_process_type_invoice_amount": {
+ "type": "number"
+ },
+ "payment_process_type_invoice_custom_unit": {
+ "type": "string"
+ },
+ "payment_process_type_invoice_duration": {
+ "enum": [
+ "day",
+ "week",
+ "month",
+ "year",
+ "day(s)",
+ "week(s)",
+ "month(s)",
+ "year(s)"
+ ],
+ "type": "string"
+ },
+ "payment_process_type_invoice_duration_start": {
+ "enum": [
+ "Customer's receipt of invoice",
+ "date of invoice"
+ ],
+ "type": "string"
+ },
+ "payment_process_type_invoice_type": {
+ "enum": [
+ "monthly",
+ "quarterly",
+ "semiannually",
+ "annually",
+ "Custom unit"
+ ],
+ "type": "string"
+ },
+ "pilot_period_stripe_product_id": {
+ "type": "string"
+ },
+ "service_credits_attributes": {
+ "additionalProperties": {
+ "additionalProperties": false,
+ "properties": {
+ "credit": {
+ "type": "number"
+ },
+ "max": {
+ "type": "number"
+ },
+ "min": {
+ "type": "number"
+ }
+ },
+ "type": "object"
+ },
+ "description": "Service credits. Use string keys such as \"0\", \"1\".",
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+ },
+ "subscription_auto_renew": {
+ "enum": [
+ "days",
+ "subscription_end"
+ ],
+ "type": "string"
+ },
+ "subscription_period": {
+ "type": "number"
+ },
+ "subscription_period_unit": {
+ "type": "string"
+ },
+ "subscription_renewal_notice_days": {
+ "type": "number"
+ },
+ "subscription_start_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "subscription_start_date_type": {
+ "enum": [
+ "effective_date",
+ "date"
+ ],
+ "type": "string"
+ },
+ "underlying_agreement_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "use_limitations_attributes": {
+ "additionalProperties": {
+ "additionalProperties": false,
+ "properties": {
+ "amount": {
+ "type": "number"
+ },
+ "limitation_type": {
+ "type": "string"
+ },
+ "unit": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "description": "Use limitations. Use string keys such as \"0\", \"1\".",
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+ }
+ },
+ "type": "object"
+ },
+ "custom_field_values": {
+ "description": "Values for a custom template's fields, keyed by the field keys defined in the template's YAML definition. Only used when template_id is a custom template. Template defaults fill any fields you omit; a required field with no default and no submitted value returns a 400 naming the field. Values are validated against the field's input type: select and radio values must be one of the field's options, multiselect values are an array of selections each of which must be one of the field's options, number and currency values must be numeric, date values must be YYYY-MM-DD, and email values must be valid addresses. An invalid value returns a 400 naming the field."
+ },
+ "design_partner_attributes": {
+ "additionalProperties": false,
+ "description": "Override design partner terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "customer_description": {
+ "type": "string"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_fees": {
+ "type": "boolean"
+ },
+ "include_fees_amount": {
+ "type": "number"
+ },
+ "include_fees_description": {
+ "type": "string"
+ },
+ "include_fees_pay_by_amount": {
+ "type": "string"
+ },
+ "include_fees_type": {
+ "enum": [
+ "default_language",
+ "description"
+ ],
+ "type": "string"
+ },
+ "include_fees_unit": {
+ "enum": [
+ "month",
+ "quarter",
+ "year",
+ "Term"
+ ],
+ "type": "string"
+ },
+ "include_program_appear_as_customer_private": {
+ "type": "boolean"
+ },
+ "include_program_appear_as_customer_public": {
+ "type": "boolean"
+ },
+ "include_program_case_study": {
+ "type": "boolean"
+ },
+ "include_program_develop_functionality": {
+ "type": "boolean"
+ },
+ "include_program_develop_functionality_val": {
+ "type": "string"
+ },
+ "include_program_discount": {
+ "type": "boolean"
+ },
+ "include_program_discount_amount": {
+ "type": "number"
+ },
+ "include_program_discount_unit": {
+ "enum": [
+ "U.S. Dollars",
+ "percent"
+ ],
+ "type": "string"
+ },
+ "include_program_participation_feedback": {
+ "type": "boolean"
+ },
+ "include_program_participation_feedback_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_program_participation_feedback_unit": {
+ "enum": [
+ "month",
+ "quarter",
+ "year",
+ "Term"
+ ],
+ "type": "string"
+ },
+ "include_program_partner_other": {
+ "type": "boolean"
+ },
+ "include_program_partner_other_val": {
+ "type": "string"
+ },
+ "include_program_provider_other": {
+ "type": "boolean"
+ },
+ "include_program_provider_other_val": {
+ "type": "string"
+ },
+ "include_program_reference": {
+ "type": "boolean"
+ },
+ "product_description": {
+ "type": "string"
+ },
+ "term_amount": {
+ "type": "number"
+ },
+ "term_unit": {
+ "enum": [
+ "day(s)",
+ "week(s)",
+ "month(s)",
+ "quarter(s)",
+ "year(s)"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "district_or_county": {
+ "description": "The district or county for dispute resolution.",
+ "type": "string"
+ },
+ "dpa_attributes": {
+ "additionalProperties": false,
+ "description": "Override dpa terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "approved_subprocessor_type": {
+ "description": "`internal` lists approved subprocessors in the agreement (`subprocessors_attributes`); `external` points to a list published elsewhere.",
+ "enum": [
+ "internal",
+ "external"
+ ],
+ "type": "string"
+ },
+ "cloud_service_product_name": {
+ "type": "string"
+ },
+ "competent_supervisory_authority": {
+ "type": "string"
+ },
+ "customer_description": {
+ "type": "string"
+ },
+ "data_exporter_address_city": {
+ "type": "string"
+ },
+ "data_exporter_address_country": {
+ "type": "string"
+ },
+ "data_exporter_address_state": {
+ "type": "string"
+ },
+ "data_exporter_address_street_address": {
+ "type": "string"
+ },
+ "data_exporter_address_zipcode": {
+ "type": "string"
+ },
+ "data_exporter_contact_details": {
+ "type": "string"
+ },
+ "data_exporter_contact_name": {
+ "type": "string"
+ },
+ "data_exporter_contact_position": {
+ "type": "string"
+ },
+ "data_exporter_role": {
+ "description": "Role of the data exporter. Overwritten to `Controller` when the agreement is created from a template.",
+ "enum": [
+ "Controller",
+ "Processor"
+ ],
+ "type": "string"
+ },
+ "data_importer_address": {
+ "type": "string"
+ },
+ "data_importer_address_city": {
+ "type": "string"
+ },
+ "data_importer_address_country": {
+ "type": "string"
+ },
+ "data_importer_address_state": {
+ "type": "string"
+ },
+ "data_importer_address_street_address": {
+ "type": "string"
+ },
+ "data_importer_address_zipcode": {
+ "type": "string"
+ },
+ "data_importer_contact_details": {
+ "type": "string"
+ },
+ "data_importer_contact_name": {
+ "type": "string"
+ },
+ "data_importer_contact_position": {
+ "type": "string"
+ },
+ "duration_of_processing": {
+ "type": "string"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_covered_claim": {
+ "type": "boolean"
+ },
+ "include_covered_claim_external_val": {
+ "type": "string"
+ },
+ "include_covered_claim_internal_val": {
+ "type": "string"
+ },
+ "include_covered_claim_type": {
+ "description": "Which covered-claim text applies: `internal` uses `include_covered_claim_internal_val`, `external` uses `include_covered_claim_external_val`. Required when `include_covered_claim` is true.",
+ "enum": [
+ "internal",
+ "external"
+ ],
+ "type": "string"
+ },
+ "include_data_subjects_custom": {
+ "type": "boolean"
+ },
+ "include_data_subjects_custom_val": {
+ "type": "string"
+ },
+ "include_data_subjects_employees": {
+ "type": "boolean"
+ },
+ "include_data_subjects_end_users": {
+ "type": "boolean"
+ },
+ "include_external_subprocessor_location": {
+ "type": "string"
+ },
+ "include_frequency_of_transfer_continuous": {
+ "type": "boolean"
+ },
+ "include_frequency_of_transfer_custom": {
+ "type": "boolean"
+ },
+ "include_frequency_of_transfer_custom_val": {
+ "type": "string"
+ },
+ "include_governing_country_eu": {
+ "type": "boolean"
+ },
+ "include_governing_country_eu_val": {
+ "type": "string"
+ },
+ "include_governing_country_uk": {
+ "type": "boolean"
+ },
+ "include_governing_country_uk_val": {
+ "type": "string"
+ },
+ "include_governing_law": {
+ "type": "boolean"
+ },
+ "include_governing_law_country": {
+ "type": "string"
+ },
+ "include_governing_law_state": {
+ "type": "string"
+ },
+ "include_increased_claim_amount": {
+ "description": "Legacy field. Stored but not shown on the DPA; use the `include_liability_cap*` fields instead.",
+ "type": "boolean"
+ },
+ "include_increased_claim_amount_currency": {
+ "description": "Legacy field. Stored but not shown on the DPA; use the `include_liability_cap*` fields instead."
+ },
+ "include_increased_claim_amount_qty": {
+ "description": "Legacy field. Stored but not shown on the DPA; use the `include_liability_cap*` fields instead."
+ },
+ "include_increased_claim_amount_type": {
+ "description": "Legacy field. Stored but not shown on the DPA; use the `include_liability_cap*` fields instead.",
+ "type": "string"
+ },
+ "include_liability_cap": {
+ "type": "boolean"
+ },
+ "include_liability_cap_amount_constant_external": {
+ "type": "string"
+ },
+ "include_liability_cap_amount_constant_internal": {
+ "type": "string"
+ },
+ "include_liability_cap_amount_currency_external": {
+ "description": "Currency amount. Numbers and numeric strings (commas allowed) are both accepted."
+ },
+ "include_liability_cap_amount_currency_internal": {
+ "description": "Currency amount. Numbers and numeric strings (commas allowed) are both accepted."
+ },
+ "include_liability_cap_csa_type": {
+ "description": "Which liability cap values apply: the `_internal` or `_external` amount fields. Required when `include_liability_cap` is true.",
+ "enum": [
+ "internal",
+ "external"
+ ],
+ "type": "string"
+ },
+ "include_personal_data_biographic_info": {
+ "type": "boolean"
+ },
+ "include_personal_data_contact_info": {
+ "type": "boolean"
+ },
+ "include_personal_data_custom": {
+ "type": "boolean"
+ },
+ "include_personal_data_custom_val": {
+ "type": "string"
+ },
+ "include_personal_data_employment_info": {
+ "type": "boolean"
+ },
+ "include_personal_data_financial_info": {
+ "type": "boolean"
+ },
+ "include_personal_data_location": {
+ "type": "boolean"
+ },
+ "include_personal_data_name": {
+ "type": "boolean"
+ },
+ "include_personal_data_transactional_info": {
+ "type": "boolean"
+ },
+ "include_personal_data_user_activity_info": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_custom": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_custom_val": {
+ "type": "string"
+ },
+ "include_processing_purpose_erasing": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_holding": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_protecting": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_receiving": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_returning": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_sharing": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_updating": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_using": {
+ "type": "boolean"
+ },
+ "include_provider_security_contact_address": {
+ "type": "boolean"
+ },
+ "include_provider_security_contact_address_city": {
+ "type": "string"
+ },
+ "include_provider_security_contact_address_country": {
+ "type": "string"
+ },
+ "include_provider_security_contact_address_state": {
+ "type": "string"
+ },
+ "include_provider_security_contact_address_street_address": {
+ "type": "string"
+ },
+ "include_provider_security_contact_address_zipcode": {
+ "type": "string"
+ },
+ "include_provider_security_contact_email": {
+ "type": "boolean"
+ },
+ "include_provider_security_contact_email_val": {
+ "format": "email",
+ "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "include_security_measures_accountability": {
+ "type": "boolean"
+ },
+ "include_security_measures_accountability_val": {
+ "type": "string"
+ },
+ "include_security_measures_certification_or_assurance": {
+ "type": "boolean"
+ },
+ "include_security_measures_certification_or_assurance_val": {
+ "type": "string"
+ },
+ "include_security_measures_confidentiality_integrity": {
+ "type": "boolean"
+ },
+ "include_security_measures_confidentiality_integrity_val": {
+ "type": "string"
+ },
+ "include_security_measures_data_at_rest": {
+ "type": "boolean"
+ },
+ "include_security_measures_data_at_rest_val": {
+ "type": "string"
+ },
+ "include_security_measures_data_minimization": {
+ "type": "boolean"
+ },
+ "include_security_measures_data_minimization_val": {
+ "type": "string"
+ },
+ "include_security_measures_data_quality": {
+ "type": "boolean"
+ },
+ "include_security_measures_data_quality_val": {
+ "type": "string"
+ },
+ "include_security_measures_data_retention": {
+ "type": "boolean"
+ },
+ "include_security_measures_data_retention_val": {
+ "type": "string"
+ },
+ "include_security_measures_data_transmission": {
+ "type": "boolean"
+ },
+ "include_security_measures_data_transmission_val": {
+ "type": "string"
+ },
+ "include_security_measures_event_logging": {
+ "type": "boolean"
+ },
+ "include_security_measures_event_logging_val": {
+ "type": "string"
+ },
+ "include_security_measures_identity_auth": {
+ "type": "boolean"
+ },
+ "include_security_measures_identity_auth_val": {
+ "type": "string"
+ },
+ "include_security_measures_it_security_governance": {
+ "type": "boolean"
+ },
+ "include_security_measures_it_security_governance_val": {
+ "type": "string"
+ },
+ "include_security_measures_physical_security": {
+ "type": "boolean"
+ },
+ "include_security_measures_physical_security_val": {
+ "type": "string"
+ },
+ "include_security_measures_portability_and_erasure": {
+ "type": "boolean"
+ },
+ "include_security_measures_portability_and_erasure_val": {
+ "type": "string"
+ },
+ "include_security_measures_pseudonym_encryption": {
+ "type": "boolean"
+ },
+ "include_security_measures_pseudonym_encryption_val": {
+ "type": "string"
+ },
+ "include_security_measures_restore_data_access": {
+ "type": "boolean"
+ },
+ "include_security_measures_restore_data_access_val": {
+ "type": "string"
+ },
+ "include_security_measures_security_policy": {
+ "type": "boolean"
+ },
+ "include_security_measures_system_configuration": {
+ "type": "boolean"
+ },
+ "include_security_measures_system_configuration_val": {
+ "type": "string"
+ },
+ "include_security_measures_testing_assessment": {
+ "type": "boolean"
+ },
+ "include_security_measures_testing_assessment_val": {
+ "type": "string"
+ },
+ "include_security_policy": {
+ "type": "boolean"
+ },
+ "include_security_policy_fedramp_auth": {
+ "type": "boolean"
+ },
+ "include_security_policy_hipaa": {
+ "type": "boolean"
+ },
+ "include_security_policy_hitrust": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_other": {
+ "type": "boolean"
+ },
+ "include_security_policy_iso27001": {
+ "type": "boolean"
+ },
+ "include_security_policy_other": {
+ "type": "string"
+ },
+ "include_security_policy_pci1": {
+ "type": "boolean"
+ },
+ "include_security_policy_pci2": {
+ "type": "boolean"
+ },
+ "include_security_policy_penetration_testing": {
+ "type": "boolean"
+ },
+ "include_security_policy_soc2": {
+ "type": "boolean"
+ },
+ "include_security_policy_soc2_type2": {
+ "type": "boolean"
+ },
+ "include_sensitive_data_restrictions_custom": {
+ "type": "boolean"
+ },
+ "include_sensitive_data_restrictions_custom_val": {
+ "type": "string"
+ },
+ "include_sensitive_data_restrictions_security_policy": {
+ "type": "boolean"
+ },
+ "include_service_provider_relationship": {
+ "type": "boolean"
+ },
+ "include_special_category_data": {
+ "type": "boolean"
+ },
+ "provider": {
+ "type": "string"
+ },
+ "security_policy_available_at": {
+ "type": "string"
+ },
+ "security_policy_type": {
+ "description": "Where the Security Policy is defined. For `external`, set `security_policy_available_at`.",
+ "enum": [
+ "defined in agreement",
+ "provider service",
+ "external"
+ ],
+ "type": "string"
+ },
+ "subprocessors_attributes": {
+ "additionalProperties": {
+ "additionalProperties": false,
+ "properties": {
+ "_destroy": {
+ "description": "Set to true with `id` to remove that subprocessor.",
+ "type": "boolean"
+ },
+ "country": {
+ "type": "string"
+ },
+ "id": {
+ "description": "ID of an existing subprocessor to update or remove. Omit to add a new subprocessor.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "processing_task": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "description": "Subprocessors, keyed by string index such as \"0\", \"1\". On create these are added to the template's subprocessors. On a draft update, an entry without `id` adds a new subprocessor; pass `id` to change one and `id` with `_destroy: true` to remove one.",
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+ },
+ "underlying_agreement_id": {
+ "description": "ID of the CSA this DPA supplements when `underlying_agreement_type` is `internal`.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "underlying_agreement_type": {
+ "description": "`internal` links a CSA in Common Paper (`underlying_agreement_id`); `external` describes another agreement in `underlying_agreement_val` (required). Omit for none.",
+ "enum": [
+ "internal",
+ "external"
+ ],
+ "type": "string"
+ },
+ "underlying_agreement_val": {
+ "description": "Description of the agreement this DPA supplements. Required when `underlying_agreement_type` is `external`.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "framework_terms_description": {
+ "description": "Custom framework terms description. Only used when framework_terms_type is \"description\".",
+ "type": "string"
+ },
+ "framework_terms_type": {
+ "description": "How framework terms are specified. Use \"new\" for standard terms or \"description\" to provide a custom framework_terms_description.",
+ "enum": [
+ "new",
+ "description"
+ ],
+ "type": "string"
+ },
+ "governing_law_country": {
+ "description": "The country whose laws govern the agreement.",
+ "type": "string"
+ },
+ "governing_law_region": {
+ "description": "The state or region whose laws govern the agreement.",
+ "type": "string"
+ },
+ "include_automated_payment_reminders": {
+ "description": "When true, automatically sends payment reminder emails.",
+ "type": "boolean"
+ },
+ "include_billing_info": {
+ "description": "When true, billing contact information (billing_name, billing_email) is included.",
+ "type": "boolean"
+ },
+ "include_billing_workflow": {
+ "description": "When true, enables a billing workflow after signing.",
+ "type": "boolean"
+ },
+ "include_expiration_date": {
+ "description": "Expiration date in YYYY-MM-DD format. Use when include_expiration_type is \"date\".",
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "include_expiration_days": {
+ "description": "Number of days until the agreement expires. Use when include_expiration_type is \"days\".",
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_expiration_type": {
+ "description": "How to set expiration: \"none\" (default), \"days\" (use include_expiration_days), or \"date\" (use include_expiration_date).",
+ "enum": [
+ "none",
+ "days",
+ "date"
+ ],
+ "type": "string"
+ },
+ "include_terms": {
+ "description": "When true, the standard terms are included with the agreement.",
+ "type": "boolean"
+ },
+ "loi_attributes": {
+ "additionalProperties": false,
+ "description": "Override loi terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "confidentiality_custom": {
+ "type": "string"
+ },
+ "confidentiality_mutual_include_loi": {
+ "type": "boolean"
+ },
+ "confidentiality_nda_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "confidentiality_nda_description": {
+ "type": "string"
+ },
+ "confidentiality_nda_include_loi": {
+ "type": "boolean"
+ },
+ "confidentiality_nda_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "confidentiality_type": {
+ "enum": [
+ "mutual",
+ "nda",
+ "provider",
+ "custom"
+ ],
+ "type": "string"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_custom_details": {
+ "type": "boolean"
+ },
+ "include_custom_details_val": {
+ "type": "string"
+ },
+ "include_fees": {
+ "type": "boolean"
+ },
+ "include_fees_amount": {
+ "type": "number"
+ },
+ "include_fees_amount_duration": {
+ "enum": [
+ "month",
+ "year",
+ "quarter"
+ ],
+ "type": "string"
+ },
+ "include_fees_include_amount": {
+ "type": "boolean"
+ },
+ "include_fees_include_other": {
+ "type": "boolean"
+ },
+ "include_fees_other": {
+ "type": "string"
+ },
+ "include_functionality": {
+ "type": "boolean"
+ },
+ "include_functionality_val": {
+ "type": "string"
+ },
+ "include_launch_date": {
+ "type": "boolean"
+ },
+ "include_launch_date_custom": {
+ "type": "string"
+ },
+ "include_launch_date_date": {
+ "format": "date-time",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$",
+ "type": "string"
+ },
+ "include_launch_date_type": {
+ "enum": [
+ "date",
+ "custom"
+ ],
+ "type": "string"
+ },
+ "product_name": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "manual_send": {
+ "description": "When true, the agreement is marked as manually sent outside the platform.",
+ "type": "boolean"
+ },
+ "message": {
+ "type": "string"
+ },
+ "negotiations_allowed": {
+ "description": "When true, the recipient can propose changes to the legal terms. For agreement types without separate business terms, that covers every term. CSA order forms, PSA statements of work, partnership business terms and software license order forms have their own `negotiations_allowed` flag.",
+ "type": "boolean"
+ },
+ "partnership_attributes": {
+ "additionalProperties": false,
+ "description": "Override partnership terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "effective_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "effective_date_type": {
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "type": "string"
+ },
+ "general_cap_amount_currency_val": {
+ "type": "number"
+ },
+ "general_cap_amount_either_currency": {
+ "type": "number"
+ },
+ "general_cap_amount_either_multiple": {
+ "type": "number"
+ },
+ "general_cap_amount_multiple_val": {
+ "type": "number"
+ },
+ "general_cap_amount_type": {
+ "enum": [
+ "multiple",
+ "currency",
+ "either",
+ "base"
+ ],
+ "type": "string"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_additional_warranties": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_include_company": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_include_company_val": {
+ "type": "string"
+ },
+ "include_additional_warranties_include_partner": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_include_partner_val": {
+ "type": "string"
+ },
+ "include_brand_guidelines": {
+ "type": "boolean"
+ },
+ "include_brand_guidelines_include_company": {
+ "type": "boolean"
+ },
+ "include_brand_guidelines_include_company_val": {
+ "type": "string"
+ },
+ "include_brand_guidelines_include_partner": {
+ "type": "boolean"
+ },
+ "include_brand_guidelines_include_partner_val": {
+ "type": "string"
+ },
+ "include_covered_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_company_claims": {
+ "type": "string"
+ },
+ "include_covered_claims_include_company_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_include_partner_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_partner_claims": {
+ "type": "string"
+ },
+ "include_dpa": {
+ "type": "boolean"
+ },
+ "include_dpa_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_dpa_location": {
+ "type": "string"
+ },
+ "include_dpa_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_increased_cap_amount": {
+ "type": "boolean"
+ },
+ "include_increased_cap_amount_currency": {
+ "type": "number"
+ },
+ "include_increased_cap_amount_either_currency": {
+ "type": "number"
+ },
+ "include_increased_cap_amount_either_multiple": {
+ "type": "string"
+ },
+ "include_increased_cap_amount_multiple": {
+ "type": "string"
+ },
+ "include_increased_cap_amount_type": {
+ "enum": [
+ "multiple",
+ "currency",
+ "either"
+ ],
+ "type": "string"
+ },
+ "include_increased_claims": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_confidentiality": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_confidentiality_misconduct": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_covered_claims": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_misconduct": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_other": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_other_val": {
+ "type": "string"
+ },
+ "include_unlimited_claims": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_confidentiality": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_confidentiality_misconduct": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_covered_claims": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_misconduct": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_other": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_other_val": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "partnership_business_terms_attributes": {
+ "additionalProperties": false,
+ "description": "Override partnership business terms terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "end_date_after_effective_date_amount": {
+ "type": "number"
+ },
+ "end_date_after_effective_date_unit": {
+ "enum": [
+ "month(s)",
+ "quarter(s)",
+ "year(s)"
+ ],
+ "type": "string"
+ },
+ "end_date_date": {
+ "type": "string"
+ },
+ "end_date_type": {
+ "enum": [
+ "date",
+ "effective date"
+ ],
+ "type": "string"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_obligations_company_brand": {
+ "type": "boolean"
+ },
+ "include_obligations_company_promotion": {
+ "type": "boolean"
+ },
+ "include_obligations_company_promotion_include_activities": {
+ "type": "boolean"
+ },
+ "include_obligations_company_promotion_include_activities_val": {
+ "type": "string"
+ },
+ "include_obligations_company_promotion_include_materials": {
+ "type": "boolean"
+ },
+ "include_obligations_company_promotion_include_materials_val": {
+ "type": "string"
+ },
+ "include_obligations_company_referral": {
+ "type": "boolean"
+ },
+ "include_obligations_company_referral_include_criteria": {
+ "type": "boolean"
+ },
+ "include_obligations_company_referral_include_criteria_val": {
+ "type": "string"
+ },
+ "include_obligations_company_referral_include_pay_sch": {
+ "type": "boolean"
+ },
+ "include_obligations_company_referral_include_pay_sch_amount": {
+ "type": "number"
+ },
+ "include_obligations_company_referral_include_pay_sch_custom": {
+ "type": "string"
+ },
+ "include_obligations_company_referral_include_pay_sch_unit": {
+ "enum": [
+ "U.S. Dollars",
+ "percent"
+ ],
+ "type": "string"
+ },
+ "include_obligations_company_sponsorship": {
+ "type": "boolean"
+ },
+ "include_obligations_company_sponsorship_include_benefits": {
+ "type": "boolean"
+ },
+ "include_obligations_company_sponsorship_include_benefits_val": {
+ "type": "string"
+ },
+ "include_obligations_company_sponsorship_include_payments": {
+ "type": "boolean"
+ },
+ "include_obligations_company_sponsorship_include_payments_amount": {
+ "type": "number"
+ },
+ "include_obligations_company_sponsorship_include_payments_unit": {
+ "enum": [
+ "U.S. Dollars",
+ "percent"
+ ],
+ "type": "string"
+ },
+ "include_obligations_partner_brand": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_promotion": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_promotion_include_activities": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_promotion_include_activities_val": {
+ "type": "string"
+ },
+ "include_obligations_partner_promotion_include_materials": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_promotion_include_materials_val": {
+ "type": "string"
+ },
+ "include_obligations_partner_referral": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_referral_include_criteria": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_referral_include_criteria_val": {
+ "type": "string"
+ },
+ "include_obligations_partner_referral_include_pay_sch": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_referral_include_pay_sch_amount": {
+ "type": "number"
+ },
+ "include_obligations_partner_referral_include_pay_sch_custom": {
+ "type": "string"
+ },
+ "include_obligations_partner_referral_include_pay_sch_unit": {
+ "enum": [
+ "U.S. Dollars",
+ "percent"
+ ],
+ "type": "string"
+ },
+ "include_obligations_partner_sponsorship": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_sponsorship_include_benefits": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_sponsorship_include_benefits_val": {
+ "type": "string"
+ },
+ "include_obligations_partner_sponsorship_include_payments": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_sponsorship_include_payments_amount": {
+ "type": "number"
+ },
+ "include_obligations_partner_sponsorship_include_payments_unit": {
+ "enum": [
+ "U.S. Dollars",
+ "percent"
+ ],
+ "type": "string"
+ },
+ "include_payment_process": {
+ "type": "boolean"
+ },
+ "include_payment_process_company": {
+ "type": "boolean"
+ },
+ "include_payment_process_company_include_address": {
+ "type": "boolean"
+ },
+ "include_payment_process_company_include_address_city": {
+ "type": "string"
+ },
+ "include_payment_process_company_include_address_country": {
+ "type": "string"
+ },
+ "include_payment_process_company_include_address_state": {
+ "type": "string"
+ },
+ "include_payment_process_company_include_address_street_address": {
+ "type": "string"
+ },
+ "include_payment_process_company_include_address_zipcode": {
+ "type": "string"
+ },
+ "include_payment_process_company_include_email": {
+ "type": "boolean"
+ },
+ "include_payment_process_company_include_email_val": {
+ "type": "string"
+ },
+ "include_payment_process_partner": {
+ "type": "boolean"
+ },
+ "include_payment_process_partner_include_address": {
+ "type": "boolean"
+ },
+ "include_payment_process_partner_include_address_city": {
+ "type": "string"
+ },
+ "include_payment_process_partner_include_address_country": {
+ "type": "string"
+ },
+ "include_payment_process_partner_include_address_state": {
+ "type": "string"
+ },
+ "include_payment_process_partner_include_address_street_address": {
+ "type": "string"
+ },
+ "include_payment_process_partner_include_address_zipcode": {
+ "type": "string"
+ },
+ "include_payment_process_partner_include_email": {
+ "type": "boolean"
+ },
+ "include_payment_process_partner_include_email_val": {
+ "type": "string"
+ },
+ "include_payment_schedule": {
+ "type": "boolean"
+ },
+ "include_payment_schedule_custom": {
+ "type": "string"
+ },
+ "include_payment_schedule_specified_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_payment_schedule_specified_timeframe": {
+ "enum": [
+ "receipt",
+ "date"
+ ],
+ "type": "string"
+ },
+ "include_payment_schedule_specified_unit": {
+ "enum": [
+ "day(s)",
+ "week(s)",
+ "month(s)",
+ "quarter(s)",
+ "year(s)"
+ ],
+ "type": "string"
+ },
+ "include_payment_schedule_type": {
+ "enum": [
+ "specified",
+ "custom"
+ ],
+ "type": "string"
+ },
+ "negotiations_allowed": {
+ "description": "When true, the recipient can propose changes to the business terms, even when the agreement-level `negotiations_allowed` is false. This only covers the business terms.",
+ "type": "boolean"
+ },
+ "territory_type": {
+ "enum": [
+ "worldwide",
+ "custom"
+ ],
+ "type": "string"
+ },
+ "territory_type_val": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "payment_link_url": {
+ "description": "A payment URL shown to the recipient after signing. Requires include_billing_workflow to be true and billing_workflow_type to be \"link\".",
+ "type": "string"
+ },
+ "pilot_attributes": {
+ "additionalProperties": false,
+ "description": "Override pilot terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "fees_type": {
+ "enum": [
+ "free",
+ "pilot_period_fees"
+ ],
+ "type": "string"
+ },
+ "general_cap_amount": {
+ "type": "number"
+ },
+ "general_cap_amount_type": {
+ "enum": [
+ "preceding",
+ "base",
+ "period"
+ ],
+ "type": "string"
+ },
+ "general_cap_period_currency": {
+ "type": "number"
+ },
+ "general_cap_period_qty": {
+ "type": "number"
+ },
+ "general_cap_preceding_amount": {
+ "type": "number"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_dpa": {
+ "type": "boolean"
+ },
+ "include_dpa_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_dpa_location": {
+ "type": "string"
+ },
+ "include_dpa_type": {
+ "enum": [
+ "description",
+ "attachment",
+ "standard"
+ ],
+ "type": "string"
+ },
+ "include_payment_process": {
+ "type": "boolean"
+ },
+ "include_technical_support": {
+ "type": "boolean"
+ },
+ "payment_process_automatic_frequency": {
+ "enum": [
+ "monthly",
+ "quarterly",
+ "annually",
+ "once_per_period"
+ ],
+ "type": "string"
+ },
+ "payment_process_invoice_days": {
+ "type": "number"
+ },
+ "payment_process_invoice_from": {
+ "enum": [
+ "receipt",
+ "date"
+ ],
+ "type": "string"
+ },
+ "payment_process_invoice_timeframe": {
+ "enum": [
+ "days",
+ "weeks",
+ "months",
+ "quarters",
+ "years"
+ ],
+ "type": "string"
+ },
+ "payment_process_type": {
+ "enum": [
+ "automatic",
+ "invoice"
+ ],
+ "type": "string"
+ },
+ "pilot_period_description": {
+ "type": "string"
+ },
+ "pilot_period_fees_description": {
+ "type": "string"
+ },
+ "product_description": {
+ "type": "string"
+ },
+ "technical_support_description": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "psa_attributes": {
+ "additionalProperties": false,
+ "description": "Override psa terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "additional_changes": {
+ "type": "string"
+ },
+ "customer_description": {
+ "type": "string"
+ },
+ "effective_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "effective_date_type": {
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "type": "string"
+ },
+ "general_cap_amount": {
+ "type": "number"
+ },
+ "general_cap_amount_type": {
+ "enum": [
+ "preceding",
+ "base",
+ "period"
+ ],
+ "type": "string"
+ },
+ "general_cap_period_currency": {
+ "type": "number"
+ },
+ "general_cap_period_qty": {
+ "type": "number"
+ },
+ "general_cap_preceding_amount": {
+ "type": "number"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_additional_changes": {
+ "type": "boolean"
+ },
+ "include_additional_warranties": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_by_customer": {
+ "type": "string"
+ },
+ "include_additional_warranties_by_provider": {
+ "type": "string"
+ },
+ "include_additional_warranties_include_by_customer": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_include_by_provider": {
+ "type": "boolean"
+ },
+ "include_covered_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_customer_claims": {
+ "type": "string"
+ },
+ "include_covered_claims_include_customer_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_include_provider_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_provider_claims": {
+ "type": "string"
+ },
+ "include_customer_insurance_min": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_add_provider_com_gen_liability": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_add_provider_cyber_liability": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_add_provider_errors_omissions": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_auto_liability_aggregate": {
+ "type": "number"
+ },
+ "include_customer_insurance_min_auto_liability_minimum": {
+ "type": "number"
+ },
+ "include_customer_insurance_min_cyber_liability_aggregate": {
+ "type": "number"
+ },
+ "include_customer_insurance_min_cyber_liability_minimum": {
+ "type": "number"
+ },
+ "include_customer_insurance_min_employer_liability_aggregate": {
+ "type": "number"
+ },
+ "include_customer_insurance_min_employer_liability_minimum": {
+ "type": "number"
+ },
+ "include_customer_insurance_min_general_liability_aggregate": {
+ "type": "number"
+ },
+ "include_customer_insurance_min_general_liability_minimum": {
+ "type": "number"
+ },
+ "include_customer_insurance_min_include_add_provider": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_include_auto_liability": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_include_cyber_liability": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_include_employer_liability": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_include_general_liability": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_include_workers_comp": {
+ "type": "boolean"
+ },
+ "include_customer_policies": {
+ "type": "boolean"
+ },
+ "include_customer_policies_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_customer_policies_location": {
+ "type": "string"
+ },
+ "include_customer_policies_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_dpa": {
+ "type": "boolean"
+ },
+ "include_dpa_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_dpa_location": {
+ "type": "string"
+ },
+ "include_dpa_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_increased_cap_amount": {
+ "type": "boolean"
+ },
+ "include_increased_claims": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_confidentiality": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_confidentiality_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_privsec": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_privsec_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_other": {
+ "type": "boolean"
+ },
+ "include_increased_claims_indemnification_obligation": {
+ "type": "boolean"
+ },
+ "include_increased_claims_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_other": {
+ "type": "string"
+ },
+ "include_provider_insurance_min": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_add_customer_com_gen_liability": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_add_customer_cyber_liability": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_add_customer_errors_omissions": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_auto_liability_aggregate": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_auto_liability_minimum": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_cyber_liability_aggregate": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_cyber_liability_minimum": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_employer_liability_aggregate": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_employer_liability_minimum": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_general_liability_aggregate": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_general_liability_minimum": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_include_add_customer": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_include_auto_liability": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_include_cyber_liability": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_include_employer_liability": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_include_general_liability": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_include_workers_comp": {
+ "type": "boolean"
+ },
+ "include_publicity_rights": {
+ "type": "boolean"
+ },
+ "include_publicity_rights_type": {
+ "enum": [
+ "public",
+ "non-public"
+ ],
+ "type": "string"
+ },
+ "include_security_policy": {
+ "type": "boolean"
+ },
+ "include_security_policy_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_security_policy_fedramp_auth": {
+ "type": "boolean"
+ },
+ "include_security_policy_hitrust": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_annual_maintenance": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_other": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_other_val": {
+ "type": "string"
+ },
+ "include_security_policy_iso27001": {
+ "type": "boolean"
+ },
+ "include_security_policy_location": {
+ "type": "string"
+ },
+ "include_security_policy_pci1": {
+ "type": "boolean"
+ },
+ "include_security_policy_pci2": {
+ "type": "boolean"
+ },
+ "include_security_policy_penetration_testing": {
+ "type": "boolean"
+ },
+ "include_security_policy_soc2_type1": {
+ "type": "boolean"
+ },
+ "include_security_policy_soc2_type2": {
+ "type": "boolean"
+ },
+ "include_security_policy_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_unlimited_claims": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_confidentiality": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_confidentiality_negligence": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_privsec": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_privsec_negligence": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_include_other": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_indemnification_obligation": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_negligence": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_other": {
+ "type": "string"
+ },
+ "increased_cap_amount_currency": {
+ "type": "number"
+ },
+ "increased_cap_amount_period_currency": {
+ "type": "number"
+ },
+ "increased_cap_amount_period_qty": {
+ "type": "number"
+ },
+ "increased_cap_amount_qty": {
+ "type": "number"
+ },
+ "increased_cap_amount_type": {
+ "enum": [
+ "qty",
+ "currency",
+ "period"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "psa_statement_of_work_attributes": {
+ "additionalProperties": false,
+ "description": "Override psa statement of work terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "additional_changes": {
+ "type": "string"
+ },
+ "cost": {
+ "type": "number"
+ },
+ "description": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "fees_attributes": {
+ "additionalProperties": {
+ "anyOf": [
+ {
+ "additionalProperties": false,
+ "description": "Fees::Flat (fee_type \"flat\"). A fixed recurring fee, e.g. a platform subscription. Set type to \"Fees::Flat\" or fee_type to \"flat\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Fixed amount in the order form's fees_currency, charged per fee_period. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"flat\". Alternative to type.",
+ "enum": [
+ "flat"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Flat\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Flat"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Discount (fee_type \"discount\"). A discount, as a fixed amount or a percentage, applied forever, once, or for a number of months. Set type to \"Fees::Discount\" or fee_type to \"discount\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Discount size: an amount in fees_currency when discount_type is fixed_amount (a plain amount, not cents: 20 means 20.00), or a percentage (e.g. 10 for 10%) when it is percentage.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "discount_duration_amount": {
+ "description": "Number of months the discount applies. Required when discount_duration_type is multiple_months.",
+ "type": "number"
+ },
+ "discount_duration_type": {
+ "description": "How long the discount applies. multiple_months also needs discount_duration_amount.",
+ "enum": [
+ "forever",
+ "once",
+ "multiple_months"
+ ],
+ "type": "string"
+ },
+ "discount_type": {
+ "description": "Whether cost is a currency amount or a percentage.",
+ "enum": [
+ "fixed_amount",
+ "percentage"
+ ],
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"discount\". Alternative to type.",
+ "enum": [
+ "discount"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Discount\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Discount"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Cost (fee_type \"cost\"). A per-unit fee: price per unit times quantity, e.g. seats. Set type to \"Fees::Cost\" or fee_type to \"cost\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Price per unit in fees_currency. The row total is quantity x cost. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"cost\". Alternative to type.",
+ "enum": [
+ "cost"
+ ],
+ "type": "string"
+ },
+ "quantity": {
+ "description": "Number of units.",
+ "type": "number"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Cost\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Cost"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Attachment (fee_type \"attachment\"). A fee described in an uploaded attachment instead of in the table. Set type to \"Fees::Attachment\" or fee_type to \"attachment\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "attachment_id": {
+ "description": "ID of an attachment uploaded with upload-attachment.",
+ "type": "string"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"attachment\". Alternative to type.",
+ "enum": [
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Attachment\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Attachment"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Graduated (fee_type \"graduated\"). Tiered pricing, with the price set per tier in graduated_fee_tiers_attributes. Set type to \"Fees::Graduated\" or fee_type to \"graduated\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"graduated\". Alternative to type.",
+ "enum": [
+ "graduated"
+ ],
+ "type": "string"
+ },
+ "graduated_fee_tiers_attributes": {
+ "additionalProperties": {
+ "additionalProperties": false,
+ "properties": {
+ "flat_price": {
+ "type": "number"
+ },
+ "price_per_unit": {
+ "type": "string"
+ },
+ "upper_limit": {
+ "type": "number"
+ }
+ },
+ "type": "object"
+ },
+ "description": "Graduated fee tiers. Use string keys such as \"0\", \"1\".",
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Graduated\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Graduated"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Included (fee_type \"included\"). An item included at no charge. Set type to \"Fees::Included\" or fee_type to \"included\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"included\". Alternative to type.",
+ "enum": [
+ "included"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Included\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Included"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Metered (fee_type \"metered\"). Usage-based pricing, billed per unit used. Set type to \"Fees::Metered\" or fee_type to \"metered\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Price per unit of usage in fees_currency. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"metered\". Alternative to type.",
+ "enum": [
+ "metered"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Metered\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Metered"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::OneTime (fee_type \"one_time\"). A one-time charge, such as a setup fee. Set type to \"Fees::OneTime\" or fee_type to \"one_time\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "One-time amount in fees_currency, charged once rather than per fee_period. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"one_time\". Alternative to type.",
+ "enum": [
+ "one_time"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::OneTime\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::OneTime"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Text (fee_type \"text\"). A fee term described in free text. Set type to \"Fees::Text\" or fee_type to \"text\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"text\". Alternative to type.",
+ "enum": [
+ "text"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Text\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Text"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ }
+ ]
+ },
+ "description": "Fee line items. Use string keys such as \"0\", \"1\". Replaces template fees when provided.",
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_additional_changes": {
+ "type": "boolean"
+ },
+ "include_customer_obligation": {
+ "type": "boolean"
+ },
+ "include_customer_obligation_val": {
+ "type": "string"
+ },
+ "include_deliverables": {
+ "type": "boolean"
+ },
+ "include_deliverables_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_deliverables_description": {
+ "type": "string"
+ },
+ "include_deliverables_include_acceptance": {
+ "type": "boolean"
+ },
+ "include_deliverables_include_attachment": {
+ "type": "boolean"
+ },
+ "include_deliverables_include_draft_deliverables": {
+ "type": "boolean"
+ },
+ "include_deliverables_rejection_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_deliverables_rejection_unit": {
+ "enum": [
+ "hours",
+ "days",
+ "weeks",
+ "months"
+ ],
+ "type": "string"
+ },
+ "include_deliverables_resubmission_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_deliverables_resubmission_unit": {
+ "enum": [
+ "hours",
+ "days",
+ "weeks",
+ "months"
+ ],
+ "type": "string"
+ },
+ "include_fees_other": {
+ "type": "boolean"
+ },
+ "include_fees_other_val": {
+ "type": "string"
+ },
+ "include_fees_table": {
+ "type": "boolean"
+ },
+ "include_fees_table_total": {
+ "type": "boolean"
+ },
+ "include_fees_travel": {
+ "type": "boolean"
+ },
+ "include_fees_travel_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_fees_travel_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_fees_travel_val": {
+ "type": "string"
+ },
+ "include_third_party_customer": {
+ "type": "boolean"
+ },
+ "include_third_party_include_description": {
+ "type": "boolean"
+ },
+ "include_third_party_include_description_val": {
+ "type": "string"
+ },
+ "include_third_party_materials": {
+ "type": "boolean"
+ },
+ "include_third_party_provider": {
+ "type": "boolean"
+ },
+ "include_time_of_assignment": {
+ "type": "boolean"
+ },
+ "include_time_of_assignment_type": {
+ "enum": [
+ "created",
+ "paid"
+ ],
+ "type": "string"
+ },
+ "invoice_period_description": {
+ "type": "string"
+ },
+ "negotiations_allowed": {
+ "description": "When true, the recipient can propose changes to the statement of work, even when the agreement-level `negotiations_allowed` is false. This only covers the statement of work.",
+ "type": "boolean"
+ },
+ "payment_period": {
+ "type": "number"
+ },
+ "payment_period_other": {
+ "type": "string"
+ },
+ "payment_period_timeframe": {
+ "enum": [
+ "receipt",
+ "invoice",
+ "Customer's receipt of invoice",
+ "date of invoice"
+ ],
+ "type": "string"
+ },
+ "payment_period_type": {
+ "enum": [
+ "standard",
+ "other"
+ ],
+ "type": "string"
+ },
+ "payment_period_unit": {
+ "enum": [
+ "day(s)",
+ "week(s)",
+ "month(s)",
+ "quarter(s)",
+ "year(s)"
+ ],
+ "type": "string"
+ },
+ "quantity": {
+ "type": "number"
+ },
+ "services_description": {
+ "type": "string"
+ },
+ "sow_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "sow_date_type": {
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "type": "string"
+ },
+ "sow_term_amount": {
+ "type": "number"
+ },
+ "sow_term_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "sow_term_type": {
+ "enum": [
+ "deliverables",
+ "period",
+ "date"
+ ],
+ "type": "string"
+ },
+ "sow_term_unit": {
+ "enum": [
+ "month(s)",
+ "quarter(s)",
+ "year(s)"
+ ],
+ "type": "string"
+ },
+ "type": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "recipient_email": {
+ "format": "email",
+ "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "recipient_name": {
+ "type": "string"
+ },
+ "recipient_notice_email_address": {
+ "description": "Email address for legal notices to the recipient.",
+ "format": "email",
+ "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "recipient_organization": {
+ "type": "string"
+ },
+ "recipient_role": {
+ "description": "PSA only. The recipient's role: `Customer` (the default) or `Provider`. Send it with `sender_role`; the two must be one `Provider` and one `Customer`. Other standard agreement types ignore it.",
+ "type": "string"
+ },
+ "sender_last_to_sign": {
+ "description": "When true, your signer signs after the recipient.",
+ "type": "boolean"
+ },
+ "sender_notice_email_address": {
+ "description": "Email address for legal notices to the sender.",
+ "format": "email",
+ "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "sender_role": {
+ "description": "PSA only. Your company's role: `Provider` (the default) or `Customer` when you hire the recipient to provide the services. Send it with `recipient_role`; the two must be one `Provider` and one `Customer`. When reading a PSA, an empty `sender_role` means `Provider`. Other standard agreement types ignore it.",
+ "type": "string"
+ },
+ "software_license_attributes": {
+ "additionalProperties": false,
+ "description": "Override software license terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "effective_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "effective_date_type": {
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "type": "string"
+ },
+ "general_cap_amount": {
+ "type": "number"
+ },
+ "general_cap_amount_type": {
+ "enum": [
+ "preceding",
+ "base",
+ "period"
+ ],
+ "type": "string"
+ },
+ "general_cap_period_currency": {
+ "type": "number"
+ },
+ "general_cap_period_qty": {
+ "type": "number"
+ },
+ "general_cap_preceding_amount": {
+ "type": "number"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_additional_warranties": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_by_customer": {
+ "type": "string"
+ },
+ "include_additional_warranties_by_provider": {
+ "type": "string"
+ },
+ "include_additional_warranties_include_by_customer": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_include_by_provider": {
+ "type": "boolean"
+ },
+ "include_ai_addendum": {
+ "type": "boolean"
+ },
+ "include_ai_addendum_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_covered_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_customer_claims": {
+ "type": "string"
+ },
+ "include_covered_claims_include_customer_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_include_provider_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_provider_claims": {
+ "type": "string"
+ },
+ "include_dpa": {
+ "type": "boolean"
+ },
+ "include_dpa_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_dpa_location": {
+ "type": "string"
+ },
+ "include_dpa_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_increased_cap_amount": {
+ "type": "boolean"
+ },
+ "include_increased_claims": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_confidentiality": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_confidentiality_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_other": {
+ "type": "boolean"
+ },
+ "include_increased_claims_indemnification_obligation": {
+ "type": "boolean"
+ },
+ "include_increased_claims_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_other": {
+ "type": "string"
+ },
+ "include_increased_claims_restrictions": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_confidentiality": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_confidentiality_negligence": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_include_other": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_indemnification_obligation": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_license_or_restrictions": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_negligence": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_other": {
+ "type": "string"
+ },
+ "increased_cap_amount_currency": {
+ "type": "number"
+ },
+ "increased_cap_amount_period_currency": {
+ "type": "number"
+ },
+ "increased_cap_amount_period_qty": {
+ "type": "number"
+ },
+ "increased_cap_amount_qty": {
+ "type": "number"
+ },
+ "increased_cap_amount_type": {
+ "enum": [
+ "qty",
+ "currency",
+ "period"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "software_license_order_form_attributes": {
+ "additionalProperties": false,
+ "description": "Override software license order form terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "additional_changes": {
+ "type": "string"
+ },
+ "deletion_procedure_include_custom": {
+ "type": "boolean"
+ },
+ "deletion_procedure_include_custom_description": {
+ "type": "string"
+ },
+ "deletion_procedure_include_customer_disable": {
+ "type": "boolean"
+ },
+ "deletion_procedure_include_customer_proof": {
+ "type": "boolean"
+ },
+ "deletion_procedure_include_provider_disable": {
+ "type": "boolean"
+ },
+ "fee_custom_unit": {
+ "type": "string"
+ },
+ "fee_period": {
+ "enum": [
+ "Subscription Period",
+ "month",
+ "year",
+ "Custom unit"
+ ],
+ "type": "string"
+ },
+ "fees_attributes": {
+ "additionalProperties": {
+ "anyOf": [
+ {
+ "additionalProperties": false,
+ "description": "Fees::Flat (fee_type \"flat\"). A fixed recurring fee, e.g. a platform subscription. Set type to \"Fees::Flat\" or fee_type to \"flat\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Fixed amount in the order form's fees_currency, charged per fee_period. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"flat\". Alternative to type.",
+ "enum": [
+ "flat"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Flat\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Flat"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Discount (fee_type \"discount\"). A discount, as a fixed amount or a percentage, applied forever, once, or for a number of months. Set type to \"Fees::Discount\" or fee_type to \"discount\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Discount size: an amount in fees_currency when discount_type is fixed_amount (a plain amount, not cents: 20 means 20.00), or a percentage (e.g. 10 for 10%) when it is percentage.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "discount_duration_amount": {
+ "description": "Number of months the discount applies. Required when discount_duration_type is multiple_months.",
+ "type": "number"
+ },
+ "discount_duration_type": {
+ "description": "How long the discount applies. multiple_months also needs discount_duration_amount.",
+ "enum": [
+ "forever",
+ "once",
+ "multiple_months"
+ ],
+ "type": "string"
+ },
+ "discount_type": {
+ "description": "Whether cost is a currency amount or a percentage.",
+ "enum": [
+ "fixed_amount",
+ "percentage"
+ ],
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"discount\". Alternative to type.",
+ "enum": [
+ "discount"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Discount\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Discount"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Cost (fee_type \"cost\"). A per-unit fee: price per unit times quantity, e.g. seats. Set type to \"Fees::Cost\" or fee_type to \"cost\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Price per unit in fees_currency. The row total is quantity x cost. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"cost\". Alternative to type.",
+ "enum": [
+ "cost"
+ ],
+ "type": "string"
+ },
+ "quantity": {
+ "description": "Number of units.",
+ "type": "number"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Cost\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Cost"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Attachment (fee_type \"attachment\"). A fee described in an uploaded attachment instead of in the table. Set type to \"Fees::Attachment\" or fee_type to \"attachment\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "attachment_id": {
+ "description": "ID of an attachment uploaded with upload-attachment.",
+ "type": "string"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"attachment\". Alternative to type.",
+ "enum": [
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Attachment\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Attachment"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Graduated (fee_type \"graduated\"). Tiered pricing, with the price set per tier in graduated_fee_tiers_attributes. Set type to \"Fees::Graduated\" or fee_type to \"graduated\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"graduated\". Alternative to type.",
+ "enum": [
+ "graduated"
+ ],
+ "type": "string"
+ },
+ "graduated_fee_tiers_attributes": {
+ "additionalProperties": {
+ "additionalProperties": false,
+ "properties": {
+ "flat_price": {
+ "type": "number"
+ },
+ "price_per_unit": {
+ "type": "string"
+ },
+ "upper_limit": {
+ "type": "number"
+ }
+ },
+ "type": "object"
+ },
+ "description": "Graduated fee tiers. Use string keys such as \"0\", \"1\".",
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Graduated\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Graduated"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Included (fee_type \"included\"). An item included at no charge. Set type to \"Fees::Included\" or fee_type to \"included\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"included\". Alternative to type.",
+ "enum": [
+ "included"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Included\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Included"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Metered (fee_type \"metered\"). Usage-based pricing, billed per unit used. Set type to \"Fees::Metered\" or fee_type to \"metered\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Price per unit of usage in fees_currency. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"metered\". Alternative to type.",
+ "enum": [
+ "metered"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Metered\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Metered"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::OneTime (fee_type \"one_time\"). A one-time charge, such as a setup fee. Set type to \"Fees::OneTime\" or fee_type to \"one_time\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "One-time amount in fees_currency, charged once rather than per fee_period. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"one_time\". Alternative to type.",
+ "enum": [
+ "one_time"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::OneTime\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::OneTime"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Text (fee_type \"text\"). A fee term described in free text. Set type to \"Fees::Text\" or fee_type to \"text\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"text\". Alternative to type.",
+ "enum": [
+ "text"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Text\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Text"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ }
+ ]
+ },
+ "description": "Fee line items. Use string keys such as \"0\", \"1\". Replaces template fees when provided.",
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+ },
+ "fees_currency": {
+ "enum": [
+ "USD",
+ "EUR",
+ "GBP",
+ "CAD",
+ "AUD",
+ "SGD",
+ "ILS",
+ "JPY",
+ "CHF",
+ "HKD"
+ ],
+ "type": "string"
+ },
+ "fees_include_fee_increase_upon_renewal": {
+ "type": "boolean"
+ },
+ "fees_include_fee_increase_upon_renewal_fee": {
+ "type": "number"
+ },
+ "fees_include_fee_increase_upon_renewal_type": {
+ "enum": [
+ "will",
+ "may"
+ ],
+ "type": "string"
+ },
+ "fees_inclusive_of_taxes": {
+ "type": "boolean"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_additional_changes": {
+ "type": "boolean"
+ },
+ "include_license_compliance_verification": {
+ "type": "boolean"
+ },
+ "include_license_compliance_verification_description": {
+ "type": "string"
+ },
+ "include_license_limits": {
+ "type": "boolean"
+ },
+ "include_license_limits_description": {
+ "type": "string"
+ },
+ "include_payment_process_include_billing_email": {
+ "type": "boolean"
+ },
+ "include_pilot_period": {
+ "type": "boolean"
+ },
+ "include_pilot_period_duration_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_pilot_period_duration_type": {
+ "enum": [
+ "day",
+ "week",
+ "month"
+ ],
+ "type": "string"
+ },
+ "include_pilot_period_include_fees": {
+ "type": "boolean"
+ },
+ "include_pilot_period_include_fees_amount": {
+ "type": "number"
+ },
+ "include_pilot_period_include_modifications": {
+ "type": "boolean"
+ },
+ "include_pilot_period_include_modifications_description": {
+ "type": "string"
+ },
+ "include_services": {
+ "type": "boolean"
+ },
+ "include_services_description": {
+ "type": "string"
+ },
+ "negotiations_allowed": {
+ "description": "When true, the recipient can propose changes to the order form, even when the agreement-level `negotiations_allowed` is false. This only covers the order form.",
+ "type": "boolean"
+ },
+ "order_date_date": {
+ "type": "string"
+ },
+ "order_date_type": {
+ "enum": [
+ "signature",
+ "date",
+ "other"
+ ],
+ "type": "string"
+ },
+ "payment_process_automatic_frequency": {
+ "enum": [
+ "monthly",
+ "quarterly",
+ "semiannually",
+ "annually"
+ ],
+ "type": "string"
+ },
+ "payment_process_type": {
+ "enum": [
+ "automatic",
+ "invoice",
+ "custom"
+ ],
+ "type": "string"
+ },
+ "payment_process_type_custom_val": {
+ "type": "string"
+ },
+ "payment_process_type_invoice_amount": {
+ "type": "number"
+ },
+ "payment_process_type_invoice_custom_unit": {
+ "type": "string"
+ },
+ "payment_process_type_invoice_duration": {
+ "enum": [
+ "day",
+ "week",
+ "month",
+ "year",
+ "day(s)",
+ "week(s)",
+ "month(s)",
+ "year(s)"
+ ],
+ "type": "string"
+ },
+ "payment_process_type_invoice_duration_start": {
+ "enum": [
+ "Customer's receipt of invoice",
+ "date of invoice"
+ ],
+ "type": "string"
+ },
+ "payment_process_type_invoice_type": {
+ "enum": [
+ "monthly",
+ "quarterly",
+ "semiannually",
+ "annually",
+ "Custom unit"
+ ],
+ "type": "string"
+ },
+ "permitted_uses_include_custom": {
+ "type": "boolean"
+ },
+ "permitted_uses_include_custom_description": {
+ "type": "string"
+ },
+ "permitted_uses_include_customers_affiliates": {
+ "type": "boolean"
+ },
+ "permitted_uses_include_internal_business": {
+ "type": "boolean"
+ },
+ "pilot_period_stripe_product_id": {
+ "type": "string"
+ },
+ "software_description": {
+ "type": "string"
+ },
+ "subscription_auto_renew": {
+ "enum": [
+ "days",
+ "subscription_end"
+ ],
+ "type": "string"
+ },
+ "subscription_period": {
+ "type": "number"
+ },
+ "subscription_period_unit": {
+ "type": "string"
+ },
+ "subscription_renewal_notice_days": {
+ "type": "number"
+ },
+ "warranty_period_description_amount": {
+ "type": "number"
+ },
+ "warranty_period_description_duration": {
+ "enum": [
+ "day",
+ "week",
+ "month",
+ "year"
+ ],
+ "type": "string"
+ },
+ "warranty_period_description_duration_start": {
+ "enum": [
+ "initial delivery of the Software",
+ "delivery of the Software and each subsequent Update",
+ "the Order Date"
+ ],
+ "type": "string"
+ },
+ "warranty_period_type": {
+ "enum": [
+ "description",
+ "none"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "test_agreement": {
+ "description": "When true, marks the agreement as a test. Test agreements do not count against your monthly limit.",
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "recipient_name",
+ "recipient_email"
+ ],
+ "type": "object"
+ },
+ "cc_users": {
+ "items": {
+ "format": "email",
+ "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "draft": {
+ "description": "When true, the agreement is saved as a draft and not sent to the recipient. Use POST /v1/agreements/{id}/send to send a draft agreement later.",
+ "type": "boolean"
+ },
+ "owner_email": {
+ "description": "Email address of the agreement owner (sender).",
+ "type": "string"
+ },
+ "signer_email": {
+ "description": "Email address of the signer from the owner's organization.",
+ "format": "email",
+ "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "template_id": {
+ "description": "UUID of a template from `GET /v1/templates`. Accepts both Common Paper standard templates and uploaded PDF templates (`type` `uploaded_template`).",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ }
+ },
+ "required": [
+ "template_id",
+ "owner_email",
+ "signer_email",
+ "agreement"
+ ],
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "agreement": {
+ "additionalProperties": {},
+ "properties": {
+ "amendment_attributes": {
+ "additionalProperties": false,
+ "description": "Override amendment terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "amended_terms_attributes": {
+ "additionalProperties": {
+ "additionalProperties": false,
+ "properties": {
+ "description": {
+ "type": "string"
+ },
+ "term": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "description": "Amended terms. Use string keys such as \"0\", \"1\".",
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+ },
+ "amendment_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "amendment_date_type": {
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "type": "string"
+ },
+ "framework_terms_type": {
+ "type": "string"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "parent_agreement_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "underlying_agreement_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "underlying_agreement_type": {
+ "type": "string"
+ },
+ "underlying_agreement_val": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "baa_attributes": {
+ "additionalProperties": false,
+ "description": "Override baa terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "aggregation_limitations_permitted": {
+ "type": "boolean"
+ },
+ "aggregation_limitations_permitted_val": {
+ "type": "string"
+ },
+ "breach_notification_unit": {
+ "enum": [
+ "hours",
+ "business days",
+ "calendar days"
+ ],
+ "type": "string"
+ },
+ "breach_notification_val": {
+ "type": "number"
+ },
+ "business_associate_relationship_type": {
+ "enum": [
+ "provider",
+ "company"
+ ],
+ "type": "string"
+ },
+ "deidentification_limitations_include_purpose": {
+ "type": "boolean"
+ },
+ "deidentification_limitations_include_requirements": {
+ "type": "boolean"
+ },
+ "deidentification_limitations_permitted": {
+ "type": "boolean"
+ },
+ "deidentification_limitations_purpose_val": {
+ "type": "string"
+ },
+ "deidentification_limitations_requirements_val": {
+ "type": "string"
+ },
+ "designated_record_set_provider_maintains": {
+ "type": "boolean"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_aggregation_limitations": {
+ "type": "boolean"
+ },
+ "include_deidentification_limitations": {
+ "type": "boolean"
+ },
+ "include_limitations": {
+ "type": "boolean"
+ },
+ "include_offshore_limitations": {
+ "type": "boolean"
+ },
+ "include_subcontract_limitations": {
+ "type": "boolean"
+ },
+ "offshore_limitations_permitted": {
+ "type": "boolean"
+ },
+ "offshore_limitations_permitted_val": {
+ "type": "string"
+ },
+ "subcontract_limitations_include_notice": {
+ "type": "boolean"
+ },
+ "subcontract_limitations_include_permission": {
+ "type": "boolean"
+ },
+ "subcontract_limitations_notice_val": {
+ "type": "string"
+ },
+ "subcontract_limitations_permission_val": {
+ "type": "string"
+ },
+ "subcontract_limitations_permitted": {
+ "type": "boolean"
+ },
+ "underlying_agreement_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "underlying_agreement_type": {
+ "enum": [
+ "internal",
+ "external",
+ "none"
+ ],
+ "type": "string"
+ },
+ "underlying_agreement_val": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "billing_email": {
+ "description": "Email of the billing contact. Used when include_billing_info is true.",
+ "format": "email",
+ "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "billing_name": {
+ "description": "Name of the billing contact. Used when include_billing_info is true.",
+ "type": "string"
+ },
+ "billing_workflow_type": {
+ "description": "The type of billing workflow. Use \"link\" to provide a payment_link_url, or \"stripe\" for Stripe-managed billing.",
+ "enum": [
+ "link",
+ "stripe"
+ ],
+ "type": "string"
+ },
+ "chosen_courts_country": {
+ "description": "The country in which disputes will be resolved.",
+ "type": "string"
+ },
+ "chosen_courts_region": {
+ "description": "The state or region in which disputes will be resolved.",
+ "type": "string"
+ },
+ "csa_attributes": {
+ "additionalProperties": false,
+ "description": "Override csa terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "customer_description": {
+ "type": "string"
+ },
+ "effective_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "effective_date_marketplace": {
+ "enum": [
+ "AWS",
+ "GCP",
+ "Azure"
+ ],
+ "type": "string"
+ },
+ "effective_date_type": {
+ "enum": [
+ "signature",
+ "date",
+ "marketplace_acceptance"
+ ],
+ "type": "string"
+ },
+ "general_cap_amount": {
+ "type": "number"
+ },
+ "general_cap_amount_type": {
+ "enum": [
+ "preceding",
+ "base",
+ "period"
+ ],
+ "type": "string"
+ },
+ "general_cap_period_currency": {
+ "type": "number"
+ },
+ "general_cap_period_qty": {
+ "type": "number"
+ },
+ "general_cap_preceding_amount": {
+ "type": "number"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_acceptable_use_policy": {
+ "type": "boolean"
+ },
+ "include_acceptable_use_policy_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_acceptable_use_policy_location": {
+ "type": "string"
+ },
+ "include_acceptable_use_policy_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_additional_warranties": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_by_customer": {
+ "type": "string"
+ },
+ "include_additional_warranties_by_provider": {
+ "type": "string"
+ },
+ "include_additional_warranties_include_by_customer": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_include_by_provider": {
+ "type": "boolean"
+ },
+ "include_ai_addendum": {
+ "type": "boolean"
+ },
+ "include_ai_addendum_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_covered_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_customer_claims": {
+ "type": "string"
+ },
+ "include_covered_claims_include_customer_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_include_provider_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_provider_claims": {
+ "type": "string"
+ },
+ "include_dpa": {
+ "type": "boolean"
+ },
+ "include_dpa_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_dpa_location": {
+ "type": "string"
+ },
+ "include_dpa_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_increased_cap_amount": {
+ "type": "boolean"
+ },
+ "include_increased_claims": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_confidentiality": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_confidentiality_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_privsec": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_privsec_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_other": {
+ "type": "boolean"
+ },
+ "include_increased_claims_indemnification_obligation": {
+ "type": "boolean"
+ },
+ "include_increased_claims_other": {
+ "type": "string"
+ },
+ "include_insurance_minimums": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_add_customer": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_add_customer_com_gen_liability": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_add_customer_cyber_liability": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_add_customer_errors_omissions": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_additional_information": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_additional_information_text": {
+ "type": "string"
+ },
+ "include_insurance_minimums_cyber_liability_aggregate": {
+ "type": "number"
+ },
+ "include_insurance_minimums_cyber_liability_minimum": {
+ "type": "number"
+ },
+ "include_insurance_minimums_employer_liability_aggregate": {
+ "type": "number"
+ },
+ "include_insurance_minimums_employer_liability_minimum": {
+ "type": "number"
+ },
+ "include_insurance_minimums_general_liability_aggregate": {
+ "type": "number"
+ },
+ "include_insurance_minimums_general_liability_minimum": {
+ "type": "number"
+ },
+ "include_insurance_minimums_include_cyber_liability": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_include_employer_liability": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_include_general_liability": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_include_workers_compensation": {
+ "type": "boolean"
+ },
+ "include_publicity_rights": {
+ "type": "boolean"
+ },
+ "include_publicity_rights_type": {
+ "enum": [
+ "public",
+ "non-public"
+ ],
+ "type": "string"
+ },
+ "include_security_policy": {
+ "type": "boolean"
+ },
+ "include_security_policy_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_security_policy_fedramp_auth": {
+ "type": "boolean"
+ },
+ "include_security_policy_hipaa": {
+ "type": "boolean"
+ },
+ "include_security_policy_hitrust": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_annual_maintenance": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_location": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_other": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_reasonable_efforts": {
+ "type": "boolean"
+ },
+ "include_security_policy_iso27001": {
+ "type": "boolean"
+ },
+ "include_security_policy_location": {
+ "type": "string"
+ },
+ "include_security_policy_other": {
+ "type": "string"
+ },
+ "include_security_policy_pci1": {
+ "type": "boolean"
+ },
+ "include_security_policy_pci2": {
+ "type": "boolean"
+ },
+ "include_security_policy_penetration_testing": {
+ "type": "boolean"
+ },
+ "include_security_policy_soc2": {
+ "type": "boolean"
+ },
+ "include_security_policy_soc2_type2": {
+ "type": "boolean"
+ },
+ "include_security_policy_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_supercap": {
+ "description": "CSA 3.0 renamed `include_increased_cap_amount` to `include_supercap`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_increased_cap_amount`. Sending the other spelling returns a 422.",
+ "type": "boolean"
+ },
+ "include_uncapped_claims": {
+ "description": "CSA 3.0 renamed `include_unlimited_claims` to `include_uncapped_claims`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims`. Sending the other spelling returns a 422.",
+ "type": "boolean"
+ },
+ "include_uncapped_claims_breach_of_confidentiality": {
+ "description": "CSA 3.0 renamed `include_unlimited_claims_breach_of_confidentiality` to `include_uncapped_claims_breach_of_confidentiality`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_breach_of_confidentiality`. Sending the other spelling returns a 422.",
+ "type": "boolean"
+ },
+ "include_uncapped_claims_breach_of_confidentiality_negligence": {
+ "description": "CSA 3.0 renamed `include_unlimited_claims_breach_of_confidentiality_negligence` to `include_uncapped_claims_breach_of_confidentiality_negligence`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_breach_of_confidentiality_negligence`. Sending the other spelling returns a 422.",
+ "type": "boolean"
+ },
+ "include_uncapped_claims_breach_of_privsec": {
+ "description": "CSA 3.0 renamed `include_unlimited_claims_breach_of_privsec` to `include_uncapped_claims_breach_of_privsec`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_breach_of_privsec`. Sending the other spelling returns a 422.",
+ "type": "boolean"
+ },
+ "include_uncapped_claims_breach_of_privsec_negligence": {
+ "description": "CSA 3.0 renamed `include_unlimited_claims_breach_of_privsec_negligence` to `include_uncapped_claims_breach_of_privsec_negligence`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_breach_of_privsec_negligence`. Sending the other spelling returns a 422.",
+ "type": "boolean"
+ },
+ "include_uncapped_claims_include_other": {
+ "description": "CSA 3.0 renamed `include_unlimited_claims_include_other` to `include_uncapped_claims_include_other`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_include_other`. Sending the other spelling returns a 422.",
+ "type": "boolean"
+ },
+ "include_uncapped_claims_indemnification_obligation": {
+ "description": "CSA 3.0 renamed `include_unlimited_claims_indemnification_obligation` to `include_uncapped_claims_indemnification_obligation`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_indemnification_obligation`. Sending the other spelling returns a 422.",
+ "type": "boolean"
+ },
+ "include_uncapped_claims_other": {
+ "description": "CSA 3.0 renamed `include_unlimited_claims_other` to `include_uncapped_claims_other`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_other`. Sending the other spelling returns a 422.",
+ "type": "boolean"
+ },
+ "include_unlimited_claims": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_confidentiality": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_confidentiality_negligence": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_privsec": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_privsec_negligence": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_include_other": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_indemnification_obligation": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_other": {
+ "type": "string"
+ },
+ "increased_cap_amount_currency": {
+ "type": "number"
+ },
+ "increased_cap_amount_period_currency": {
+ "type": "number"
+ },
+ "increased_cap_amount_period_qty": {
+ "type": "number"
+ },
+ "increased_cap_amount_qty": {
+ "type": "number"
+ },
+ "increased_cap_amount_type": {
+ "enum": [
+ "qty",
+ "currency",
+ "period"
+ ],
+ "type": "string"
+ },
+ "provider": {
+ "type": "string"
+ },
+ "supercap_currency": {
+ "description": "CSA 3.0 renamed `increased_cap_amount_currency` to `supercap_currency`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `increased_cap_amount_currency`. Sending the other spelling returns a 422.",
+ "type": "number"
+ },
+ "supercap_period_currency": {
+ "description": "CSA 3.0 renamed `increased_cap_amount_period_currency` to `supercap_period_currency`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `increased_cap_amount_period_currency`. Sending the other spelling returns a 422.",
+ "type": "number"
+ },
+ "supercap_period_qty": {
+ "description": "CSA 3.0 renamed `increased_cap_amount_period_qty` to `supercap_period_qty`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `increased_cap_amount_period_qty`. Sending the other spelling returns a 422.",
+ "type": "number"
+ },
+ "supercap_qty": {
+ "description": "CSA 3.0 renamed `increased_cap_amount_qty` to `supercap_qty`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `increased_cap_amount_qty`. Sending the other spelling returns a 422.",
+ "type": "number"
+ },
+ "supercap_type": {
+ "description": "CSA 3.0 renamed `increased_cap_amount_type` to `supercap_type`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `increased_cap_amount_type`. Sending the other spelling returns a 422.",
+ "type": "number"
+ }
+ },
+ "type": "object"
+ },
+ "csa_order_form_attributes": {
+ "additionalProperties": false,
+ "description": "Override csa order form terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "additional_changes": {
+ "type": "string"
+ },
+ "additional_parameters_or_limitations": {
+ "type": "string"
+ },
+ "affiliates_as_users": {
+ "type": "boolean"
+ },
+ "cloud_service_description": {
+ "type": "string"
+ },
+ "consumption_units": {
+ "type": "string"
+ },
+ "fee_amount": {
+ "type": "number"
+ },
+ "fee_custom_unit": {
+ "type": "string"
+ },
+ "fee_period": {
+ "enum": [
+ "Subscription Period",
+ "month",
+ "year",
+ "User",
+ "Custom unit"
+ ],
+ "type": "string"
+ },
+ "fees_attributes": {
+ "additionalProperties": {
+ "anyOf": [
+ {
+ "additionalProperties": false,
+ "description": "Fees::Flat (fee_type \"flat\"). A fixed recurring fee, e.g. a platform subscription. Set type to \"Fees::Flat\" or fee_type to \"flat\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Fixed amount in the order form's fees_currency, charged per fee_period. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"flat\". Alternative to type.",
+ "enum": [
+ "flat"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Flat\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Flat"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Discount (fee_type \"discount\"). A discount, as a fixed amount or a percentage, applied forever, once, or for a number of months. Set type to \"Fees::Discount\" or fee_type to \"discount\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Discount size: an amount in fees_currency when discount_type is fixed_amount (a plain amount, not cents: 20 means 20.00), or a percentage (e.g. 10 for 10%) when it is percentage.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "discount_duration_amount": {
+ "description": "Number of months the discount applies. Required when discount_duration_type is multiple_months.",
+ "type": "number"
+ },
+ "discount_duration_type": {
+ "description": "How long the discount applies. multiple_months also needs discount_duration_amount.",
+ "enum": [
+ "forever",
+ "once",
+ "multiple_months"
+ ],
+ "type": "string"
+ },
+ "discount_type": {
+ "description": "Whether cost is a currency amount or a percentage.",
+ "enum": [
+ "fixed_amount",
+ "percentage"
+ ],
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"discount\". Alternative to type.",
+ "enum": [
+ "discount"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Discount\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Discount"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Cost (fee_type \"cost\"). A per-unit fee: price per unit times quantity, e.g. seats. Set type to \"Fees::Cost\" or fee_type to \"cost\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Price per unit in fees_currency. The row total is quantity x cost. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"cost\". Alternative to type.",
+ "enum": [
+ "cost"
+ ],
+ "type": "string"
+ },
+ "quantity": {
+ "description": "Number of units.",
+ "type": "number"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Cost\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Cost"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Attachment (fee_type \"attachment\"). A fee described in an uploaded attachment instead of in the table. Set type to \"Fees::Attachment\" or fee_type to \"attachment\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "attachment_id": {
+ "description": "ID of an attachment uploaded with upload-attachment.",
+ "type": "string"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"attachment\". Alternative to type.",
+ "enum": [
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Attachment\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Attachment"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Graduated (fee_type \"graduated\"). Tiered pricing, with the price set per tier in graduated_fee_tiers_attributes. Set type to \"Fees::Graduated\" or fee_type to \"graduated\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"graduated\". Alternative to type.",
+ "enum": [
+ "graduated"
+ ],
+ "type": "string"
+ },
+ "graduated_fee_tiers_attributes": {
+ "additionalProperties": {
+ "additionalProperties": false,
+ "properties": {
+ "flat_price": {
+ "type": "number"
+ },
+ "price_per_unit": {
+ "type": "string"
+ },
+ "upper_limit": {
+ "type": "number"
+ }
+ },
+ "type": "object"
+ },
+ "description": "Graduated fee tiers. Use string keys such as \"0\", \"1\".",
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Graduated\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Graduated"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Included (fee_type \"included\"). An item included at no charge. Set type to \"Fees::Included\" or fee_type to \"included\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"included\". Alternative to type.",
+ "enum": [
+ "included"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Included\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Included"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Metered (fee_type \"metered\"). Usage-based pricing, billed per unit used. Set type to \"Fees::Metered\" or fee_type to \"metered\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Price per unit of usage in fees_currency. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"metered\". Alternative to type.",
+ "enum": [
+ "metered"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Metered\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Metered"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::OneTime (fee_type \"one_time\"). A one-time charge, such as a setup fee. Set type to \"Fees::OneTime\" or fee_type to \"one_time\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "One-time amount in fees_currency, charged once rather than per fee_period. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"one_time\". Alternative to type.",
+ "enum": [
+ "one_time"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::OneTime\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::OneTime"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Text (fee_type \"text\"). A fee term described in free text. Set type to \"Fees::Text\" or fee_type to \"text\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"text\". Alternative to type.",
+ "enum": [
+ "text"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Text\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Text"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ }
+ ]
+ },
+ "description": "Fee table rows, keyed by string index (\"0\", \"1\", ...). Replaces the template's fees when provided. Each row sets type or fee_type to pick the fee class. Amounts are in the order form's fees_currency and, for recurring fees, are charged per fee_period.",
+ "examples": [
+ {
+ "0": {
+ "cost": 2000,
+ "description": "Platform subscription",
+ "type": "Fees::Flat"
+ }
+ },
+ {
+ "0": {
+ "cost": 50,
+ "description": "Seats",
+ "fee_type": "cost",
+ "quantity": 10
+ },
+ "1": {
+ "cost": 10,
+ "description": "Launch discount",
+ "discount_duration_amount": 3,
+ "discount_duration_type": "multiple_months",
+ "discount_type": "percentage",
+ "fee_type": "discount"
+ }
+ }
+ ],
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+ },
+ "fees_currency": {
+ "enum": [
+ "USD",
+ "EUR",
+ "GBP",
+ "CAD",
+ "AUD",
+ "SGD",
+ "ILS",
+ "JPY",
+ "CHF",
+ "HKD"
+ ],
+ "type": "string"
+ },
+ "fees_include_fee_increase_upon_renewal": {
+ "type": "boolean"
+ },
+ "fees_include_fee_increase_upon_renewal_fee": {
+ "type": "number"
+ },
+ "fees_include_fee_increase_upon_renewal_type": {
+ "enum": [
+ "will",
+ "may"
+ ],
+ "type": "string"
+ },
+ "fees_inclusive_of_taxes": {
+ "type": "boolean"
+ },
+ "framework_terms_type": {
+ "enum": [
+ "new",
+ "existing",
+ "description"
+ ],
+ "type": "string"
+ },
+ "free_trial_days": {
+ "type": "number"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_additional_changes": {
+ "type": "boolean"
+ },
+ "include_additional_parameters_or_limitations": {
+ "type": "boolean"
+ },
+ "include_consumption": {
+ "type": "boolean"
+ },
+ "include_fees": {
+ "type": "boolean"
+ },
+ "include_fees_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_fees_include_attachment": {
+ "type": "boolean"
+ },
+ "include_fees_other": {
+ "type": "boolean"
+ },
+ "include_fees_other_val": {
+ "type": "string"
+ },
+ "include_fees_table": {
+ "type": "boolean"
+ },
+ "include_fees_table_period": {
+ "enum": [
+ "Subscription Period",
+ "month",
+ "year",
+ "User"
+ ],
+ "type": "string"
+ },
+ "include_free_trial": {
+ "type": "boolean"
+ },
+ "include_max_users": {
+ "type": "boolean"
+ },
+ "include_pilot_period": {
+ "type": "boolean"
+ },
+ "include_pilot_period_duration_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_pilot_period_duration_type": {
+ "enum": [
+ "day",
+ "week",
+ "month"
+ ],
+ "type": "string"
+ },
+ "include_pilot_period_include_fees": {
+ "type": "boolean"
+ },
+ "include_pilot_period_include_fees_amount": {
+ "type": "number"
+ },
+ "include_pilot_period_include_modifications": {
+ "type": "boolean"
+ },
+ "include_pilot_period_include_modifications_description": {
+ "type": "string"
+ },
+ "include_product_support": {
+ "type": "boolean"
+ },
+ "include_product_support_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_product_support_description": {
+ "type": "string"
+ },
+ "include_product_support_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_professional_services": {
+ "type": "boolean"
+ },
+ "include_professional_services_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_professional_services_custom_name": {
+ "type": "string"
+ },
+ "include_professional_services_description": {
+ "type": "string"
+ },
+ "include_professional_services_end_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "include_professional_services_fees_description": {
+ "type": "string"
+ },
+ "include_professional_services_include_end_date": {
+ "type": "boolean"
+ },
+ "include_professional_services_include_fees_description": {
+ "type": "boolean"
+ },
+ "include_professional_services_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_sla": {
+ "type": "boolean"
+ },
+ "include_sla_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_sla_description": {
+ "type": "string"
+ },
+ "include_sla_include_response_time": {
+ "type": "boolean"
+ },
+ "include_sla_include_response_time_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_sla_include_response_time_credit": {
+ "type": "number"
+ },
+ "include_sla_include_response_time_duration": {
+ "enum": [
+ "hour",
+ "day",
+ "week",
+ "month",
+ "hours"
+ ],
+ "type": "string"
+ },
+ "include_sla_include_response_time_support_channel": {
+ "type": "string"
+ },
+ "include_sla_include_target_uptime": {
+ "type": "boolean"
+ },
+ "include_sla_maintenance_notice": {
+ "type": "boolean"
+ },
+ "include_sla_maintenance_window": {
+ "type": "boolean"
+ },
+ "include_sla_maintenance_window_type": {
+ "enum": [
+ "standard",
+ "none"
+ ],
+ "type": "string"
+ },
+ "include_sla_standard_maintenance_notice_qty": {
+ "type": "number"
+ },
+ "include_sla_standard_maintenance_notice_unit": {
+ "enum": [
+ "hour",
+ "day",
+ "week",
+ "month"
+ ],
+ "type": "string"
+ },
+ "include_sla_standard_maintenance_window_end_time": {
+ "type": "string"
+ },
+ "include_sla_standard_maintenance_window_friday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_monday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_saturday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_start_time": {
+ "type": "string"
+ },
+ "include_sla_standard_maintenance_window_sunday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_thursday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_time_zone": {
+ "type": "string"
+ },
+ "include_sla_standard_maintenance_window_tuesday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_wednesday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_target_uptime": {
+ "type": "number"
+ },
+ "include_sla_type": {
+ "enum": [
+ "description",
+ "standard",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_subscription_start_date": {
+ "type": "boolean"
+ },
+ "include_subscription_start_date_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "include_usage_review": {
+ "type": "boolean"
+ },
+ "include_usage_review_val": {
+ "type": "string"
+ },
+ "include_use_limitations": {
+ "type": "boolean"
+ },
+ "include_use_limitations_val": {
+ "type": "string"
+ },
+ "invoice_period": {
+ "enum": [
+ "monthly",
+ "quarterly",
+ "semiannually",
+ "annually",
+ "Custom unit",
+ "Monthly",
+ "Quarterly",
+ "Semiannually",
+ "Annually"
+ ],
+ "type": "string"
+ },
+ "invoice_period_custom_unit": {
+ "type": "string"
+ },
+ "max_consumption": {
+ "type": "number"
+ },
+ "max_users": {
+ "type": "number"
+ },
+ "negotiations_allowed": {
+ "description": "When true, the recipient can propose changes to the order form, even when the agreement-level `negotiations_allowed` is false. This only covers the order form.",
+ "type": "boolean"
+ },
+ "order_date_date": {
+ "type": "string"
+ },
+ "order_date_other": {
+ "type": "string"
+ },
+ "order_date_type": {
+ "enum": [
+ "signature",
+ "date",
+ "other"
+ ],
+ "type": "string"
+ },
+ "payment_period": {
+ "type": "number"
+ },
+ "payment_period_timeframe": {
+ "enum": [
+ "Customer's receipt of invoice",
+ "date of invoice"
+ ],
+ "type": "string"
+ },
+ "payment_period_unit": {
+ "enum": [
+ "day(s)",
+ "week(s)",
+ "month(s)",
+ "marketplace_acceptance"
+ ],
+ "type": "string"
+ },
+ "payment_process_automatic_frequency": {
+ "enum": [
+ "monthly",
+ "quarterly",
+ "semiannually",
+ "annually"
+ ],
+ "type": "string"
+ },
+ "payment_process_type": {
+ "enum": [
+ "automatic",
+ "invoice",
+ "custom",
+ "marketplace_acceptance"
+ ],
+ "type": "string"
+ },
+ "payment_process_type_custom_val": {
+ "type": "string"
+ },
+ "payment_process_type_invoice_amount": {
+ "type": "number"
+ },
+ "payment_process_type_invoice_custom_unit": {
+ "type": "string"
+ },
+ "payment_process_type_invoice_duration": {
+ "enum": [
+ "day",
+ "week",
+ "month",
+ "year",
+ "day(s)",
+ "week(s)",
+ "month(s)",
+ "year(s)"
+ ],
+ "type": "string"
+ },
+ "payment_process_type_invoice_duration_start": {
+ "enum": [
+ "Customer's receipt of invoice",
+ "date of invoice"
+ ],
+ "type": "string"
+ },
+ "payment_process_type_invoice_type": {
+ "enum": [
+ "monthly",
+ "quarterly",
+ "semiannually",
+ "annually",
+ "Custom unit"
+ ],
+ "type": "string"
+ },
+ "pilot_period_stripe_product_id": {
+ "type": "string"
+ },
+ "service_credits_attributes": {
+ "additionalProperties": {
+ "additionalProperties": false,
+ "properties": {
+ "credit": {
+ "type": "number"
+ },
+ "max": {
+ "type": "number"
+ },
+ "min": {
+ "type": "number"
+ }
+ },
+ "type": "object"
+ },
+ "description": "Service credits. Use string keys such as \"0\", \"1\".",
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+ },
+ "subscription_auto_renew": {
+ "enum": [
+ "days",
+ "subscription_end"
+ ],
+ "type": "string"
+ },
+ "subscription_period": {
+ "type": "number"
+ },
+ "subscription_period_unit": {
+ "type": "string"
+ },
+ "subscription_renewal_notice_days": {
+ "type": "number"
+ },
+ "subscription_start_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "subscription_start_date_type": {
+ "enum": [
+ "effective_date",
+ "date"
+ ],
+ "type": "string"
+ },
+ "underlying_agreement_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "use_limitations_attributes": {
+ "additionalProperties": {
+ "additionalProperties": false,
+ "properties": {
+ "amount": {
+ "type": "number"
+ },
+ "limitation_type": {
+ "type": "string"
+ },
+ "unit": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "description": "Use limitations. Use string keys such as \"0\", \"1\".",
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+ }
+ },
+ "type": "object"
+ },
+ "custom_field_values": {
+ "description": "Values for a custom template's fields, keyed by the field keys defined in the template's YAML definition. Only used when template_id is a custom template. Template defaults fill any fields you omit; a required field with no default and no submitted value returns a 400 naming the field. Values are validated against the field's input type: select and radio values must be one of the field's options, multiselect values are an array of selections each of which must be one of the field's options, number and currency values must be numeric, date values must be YYYY-MM-DD, and email values must be valid addresses. An invalid value returns a 400 naming the field."
+ },
+ "design_partner_attributes": {
+ "additionalProperties": false,
+ "description": "Override design partner terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "customer_description": {
+ "type": "string"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_fees": {
+ "type": "boolean"
+ },
+ "include_fees_amount": {
+ "type": "number"
+ },
+ "include_fees_description": {
+ "type": "string"
+ },
+ "include_fees_pay_by_amount": {
+ "type": "string"
+ },
+ "include_fees_type": {
+ "enum": [
+ "default_language",
+ "description"
+ ],
+ "type": "string"
+ },
+ "include_fees_unit": {
+ "enum": [
+ "month",
+ "quarter",
+ "year",
+ "Term"
+ ],
+ "type": "string"
+ },
+ "include_program_appear_as_customer_private": {
+ "type": "boolean"
+ },
+ "include_program_appear_as_customer_public": {
+ "type": "boolean"
+ },
+ "include_program_case_study": {
+ "type": "boolean"
+ },
+ "include_program_develop_functionality": {
+ "type": "boolean"
+ },
+ "include_program_develop_functionality_val": {
+ "type": "string"
+ },
+ "include_program_discount": {
+ "type": "boolean"
+ },
+ "include_program_discount_amount": {
+ "type": "number"
+ },
+ "include_program_discount_unit": {
+ "enum": [
+ "U.S. Dollars",
+ "percent"
+ ],
+ "type": "string"
+ },
+ "include_program_participation_feedback": {
+ "type": "boolean"
+ },
+ "include_program_participation_feedback_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_program_participation_feedback_unit": {
+ "enum": [
+ "month",
+ "quarter",
+ "year",
+ "Term"
+ ],
+ "type": "string"
+ },
+ "include_program_partner_other": {
+ "type": "boolean"
+ },
+ "include_program_partner_other_val": {
+ "type": "string"
+ },
+ "include_program_provider_other": {
+ "type": "boolean"
+ },
+ "include_program_provider_other_val": {
+ "type": "string"
+ },
+ "include_program_reference": {
+ "type": "boolean"
+ },
+ "product_description": {
+ "type": "string"
+ },
+ "term_amount": {
+ "type": "number"
+ },
+ "term_unit": {
+ "enum": [
+ "day(s)",
+ "week(s)",
+ "month(s)",
+ "quarter(s)",
+ "year(s)"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "district_or_county": {
+ "description": "The district or county for dispute resolution.",
+ "type": "string"
+ },
+ "dpa_attributes": {
+ "additionalProperties": false,
+ "description": "Override dpa terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "approved_subprocessor_type": {
+ "description": "`internal` lists approved subprocessors in the agreement (`subprocessors_attributes`); `external` points to a list published elsewhere.",
+ "enum": [
+ "internal",
+ "external"
+ ],
+ "type": "string"
+ },
+ "cloud_service_product_name": {
+ "type": "string"
+ },
+ "competent_supervisory_authority": {
+ "type": "string"
+ },
+ "customer_description": {
+ "type": "string"
+ },
+ "data_exporter_address_city": {
+ "type": "string"
+ },
+ "data_exporter_address_country": {
+ "type": "string"
+ },
+ "data_exporter_address_state": {
+ "type": "string"
+ },
+ "data_exporter_address_street_address": {
+ "type": "string"
+ },
+ "data_exporter_address_zipcode": {
+ "type": "string"
+ },
+ "data_exporter_contact_details": {
+ "type": "string"
+ },
+ "data_exporter_contact_name": {
+ "type": "string"
+ },
+ "data_exporter_contact_position": {
+ "type": "string"
+ },
+ "data_exporter_role": {
+ "description": "Role of the data exporter. Overwritten to `Controller` when the agreement is created from a template.",
+ "enum": [
+ "Controller",
+ "Processor"
+ ],
+ "type": "string"
+ },
+ "data_importer_address": {
+ "type": "string"
+ },
+ "data_importer_address_city": {
+ "type": "string"
+ },
+ "data_importer_address_country": {
+ "type": "string"
+ },
+ "data_importer_address_state": {
+ "type": "string"
+ },
+ "data_importer_address_street_address": {
+ "type": "string"
+ },
+ "data_importer_address_zipcode": {
+ "type": "string"
+ },
+ "data_importer_contact_details": {
+ "type": "string"
+ },
+ "data_importer_contact_name": {
+ "type": "string"
+ },
+ "data_importer_contact_position": {
+ "type": "string"
+ },
+ "duration_of_processing": {
+ "type": "string"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_covered_claim": {
+ "type": "boolean"
+ },
+ "include_covered_claim_external_val": {
+ "type": "string"
+ },
+ "include_covered_claim_internal_val": {
+ "type": "string"
+ },
+ "include_covered_claim_type": {
+ "description": "Which covered-claim text applies: `internal` uses `include_covered_claim_internal_val`, `external` uses `include_covered_claim_external_val`. Required when `include_covered_claim` is true.",
+ "enum": [
+ "internal",
+ "external"
+ ],
+ "type": "string"
+ },
+ "include_data_subjects_custom": {
+ "type": "boolean"
+ },
+ "include_data_subjects_custom_val": {
+ "type": "string"
+ },
+ "include_data_subjects_employees": {
+ "type": "boolean"
+ },
+ "include_data_subjects_end_users": {
+ "type": "boolean"
+ },
+ "include_external_subprocessor_location": {
+ "type": "string"
+ },
+ "include_frequency_of_transfer_continuous": {
+ "type": "boolean"
+ },
+ "include_frequency_of_transfer_custom": {
+ "type": "boolean"
+ },
+ "include_frequency_of_transfer_custom_val": {
+ "type": "string"
+ },
+ "include_governing_country_eu": {
+ "type": "boolean"
+ },
+ "include_governing_country_eu_val": {
+ "type": "string"
+ },
+ "include_governing_country_uk": {
+ "type": "boolean"
+ },
+ "include_governing_country_uk_val": {
+ "type": "string"
+ },
+ "include_governing_law": {
+ "type": "boolean"
+ },
+ "include_governing_law_country": {
+ "type": "string"
+ },
+ "include_governing_law_state": {
+ "type": "string"
+ },
+ "include_increased_claim_amount": {
+ "description": "Legacy field. Stored but not shown on the DPA; use the `include_liability_cap*` fields instead.",
+ "type": "boolean"
+ },
+ "include_increased_claim_amount_currency": {
+ "description": "Legacy field. Stored but not shown on the DPA; use the `include_liability_cap*` fields instead."
+ },
+ "include_increased_claim_amount_qty": {
+ "description": "Legacy field. Stored but not shown on the DPA; use the `include_liability_cap*` fields instead."
+ },
+ "include_increased_claim_amount_type": {
+ "description": "Legacy field. Stored but not shown on the DPA; use the `include_liability_cap*` fields instead.",
+ "type": "string"
+ },
+ "include_liability_cap": {
+ "type": "boolean"
+ },
+ "include_liability_cap_amount_constant_external": {
+ "type": "string"
+ },
+ "include_liability_cap_amount_constant_internal": {
+ "type": "string"
+ },
+ "include_liability_cap_amount_currency_external": {
+ "description": "Currency amount. Numbers and numeric strings (commas allowed) are both accepted."
+ },
+ "include_liability_cap_amount_currency_internal": {
+ "description": "Currency amount. Numbers and numeric strings (commas allowed) are both accepted."
+ },
+ "include_liability_cap_csa_type": {
+ "description": "Which liability cap values apply: the `_internal` or `_external` amount fields. Required when `include_liability_cap` is true.",
+ "enum": [
+ "internal",
+ "external"
+ ],
+ "type": "string"
+ },
+ "include_personal_data_biographic_info": {
+ "type": "boolean"
+ },
+ "include_personal_data_contact_info": {
+ "type": "boolean"
+ },
+ "include_personal_data_custom": {
+ "type": "boolean"
+ },
+ "include_personal_data_custom_val": {
+ "type": "string"
+ },
+ "include_personal_data_employment_info": {
+ "type": "boolean"
+ },
+ "include_personal_data_financial_info": {
+ "type": "boolean"
+ },
+ "include_personal_data_location": {
+ "type": "boolean"
+ },
+ "include_personal_data_name": {
+ "type": "boolean"
+ },
+ "include_personal_data_transactional_info": {
+ "type": "boolean"
+ },
+ "include_personal_data_user_activity_info": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_custom": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_custom_val": {
+ "type": "string"
+ },
+ "include_processing_purpose_erasing": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_holding": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_protecting": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_receiving": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_returning": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_sharing": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_updating": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_using": {
+ "type": "boolean"
+ },
+ "include_provider_security_contact_address": {
+ "type": "boolean"
+ },
+ "include_provider_security_contact_address_city": {
+ "type": "string"
+ },
+ "include_provider_security_contact_address_country": {
+ "type": "string"
+ },
+ "include_provider_security_contact_address_state": {
+ "type": "string"
+ },
+ "include_provider_security_contact_address_street_address": {
+ "type": "string"
+ },
+ "include_provider_security_contact_address_zipcode": {
+ "type": "string"
+ },
+ "include_provider_security_contact_email": {
+ "type": "boolean"
+ },
+ "include_provider_security_contact_email_val": {
+ "format": "email",
+ "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "include_security_measures_accountability": {
+ "type": "boolean"
+ },
+ "include_security_measures_accountability_val": {
+ "type": "string"
+ },
+ "include_security_measures_certification_or_assurance": {
+ "type": "boolean"
+ },
+ "include_security_measures_certification_or_assurance_val": {
+ "type": "string"
+ },
+ "include_security_measures_confidentiality_integrity": {
+ "type": "boolean"
+ },
+ "include_security_measures_confidentiality_integrity_val": {
+ "type": "string"
+ },
+ "include_security_measures_data_at_rest": {
+ "type": "boolean"
+ },
+ "include_security_measures_data_at_rest_val": {
+ "type": "string"
+ },
+ "include_security_measures_data_minimization": {
+ "type": "boolean"
+ },
+ "include_security_measures_data_minimization_val": {
+ "type": "string"
+ },
+ "include_security_measures_data_quality": {
+ "type": "boolean"
+ },
+ "include_security_measures_data_quality_val": {
+ "type": "string"
+ },
+ "include_security_measures_data_retention": {
+ "type": "boolean"
+ },
+ "include_security_measures_data_retention_val": {
+ "type": "string"
+ },
+ "include_security_measures_data_transmission": {
+ "type": "boolean"
+ },
+ "include_security_measures_data_transmission_val": {
+ "type": "string"
+ },
+ "include_security_measures_event_logging": {
+ "type": "boolean"
+ },
+ "include_security_measures_event_logging_val": {
+ "type": "string"
+ },
+ "include_security_measures_identity_auth": {
+ "type": "boolean"
+ },
+ "include_security_measures_identity_auth_val": {
+ "type": "string"
+ },
+ "include_security_measures_it_security_governance": {
+ "type": "boolean"
+ },
+ "include_security_measures_it_security_governance_val": {
+ "type": "string"
+ },
+ "include_security_measures_physical_security": {
+ "type": "boolean"
+ },
+ "include_security_measures_physical_security_val": {
+ "type": "string"
+ },
+ "include_security_measures_portability_and_erasure": {
+ "type": "boolean"
+ },
+ "include_security_measures_portability_and_erasure_val": {
+ "type": "string"
+ },
+ "include_security_measures_pseudonym_encryption": {
+ "type": "boolean"
+ },
+ "include_security_measures_pseudonym_encryption_val": {
+ "type": "string"
+ },
+ "include_security_measures_restore_data_access": {
+ "type": "boolean"
+ },
+ "include_security_measures_restore_data_access_val": {
+ "type": "string"
+ },
+ "include_security_measures_security_policy": {
+ "type": "boolean"
+ },
+ "include_security_measures_system_configuration": {
+ "type": "boolean"
+ },
+ "include_security_measures_system_configuration_val": {
+ "type": "string"
+ },
+ "include_security_measures_testing_assessment": {
+ "type": "boolean"
+ },
+ "include_security_measures_testing_assessment_val": {
+ "type": "string"
+ },
+ "include_security_policy": {
+ "type": "boolean"
+ },
+ "include_security_policy_fedramp_auth": {
+ "type": "boolean"
+ },
+ "include_security_policy_hipaa": {
+ "type": "boolean"
+ },
+ "include_security_policy_hitrust": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_other": {
+ "type": "boolean"
+ },
+ "include_security_policy_iso27001": {
+ "type": "boolean"
+ },
+ "include_security_policy_other": {
+ "type": "string"
+ },
+ "include_security_policy_pci1": {
+ "type": "boolean"
+ },
+ "include_security_policy_pci2": {
+ "type": "boolean"
+ },
+ "include_security_policy_penetration_testing": {
+ "type": "boolean"
+ },
+ "include_security_policy_soc2": {
+ "type": "boolean"
+ },
+ "include_security_policy_soc2_type2": {
+ "type": "boolean"
+ },
+ "include_sensitive_data_restrictions_custom": {
+ "type": "boolean"
+ },
+ "include_sensitive_data_restrictions_custom_val": {
+ "type": "string"
+ },
+ "include_sensitive_data_restrictions_security_policy": {
+ "type": "boolean"
+ },
+ "include_service_provider_relationship": {
+ "type": "boolean"
+ },
+ "include_special_category_data": {
+ "type": "boolean"
+ },
+ "provider": {
+ "type": "string"
+ },
+ "security_policy_available_at": {
+ "type": "string"
+ },
+ "security_policy_type": {
+ "description": "Where the Security Policy is defined. For `external`, set `security_policy_available_at`.",
+ "enum": [
+ "defined in agreement",
+ "provider service",
+ "external"
+ ],
+ "type": "string"
+ },
+ "subprocessors_attributes": {
+ "additionalProperties": {
+ "additionalProperties": false,
+ "properties": {
+ "_destroy": {
+ "description": "Set to true with `id` to remove that subprocessor.",
+ "type": "boolean"
+ },
+ "country": {
+ "type": "string"
+ },
+ "id": {
+ "description": "ID of an existing subprocessor to update or remove. Omit to add a new subprocessor.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "processing_task": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "description": "Subprocessors, keyed by string index such as \"0\", \"1\". On create these are added to the template's subprocessors. On a draft update, an entry without `id` adds a new subprocessor; pass `id` to change one and `id` with `_destroy: true` to remove one.",
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+ },
+ "underlying_agreement_id": {
+ "description": "ID of the CSA this DPA supplements when `underlying_agreement_type` is `internal`.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "underlying_agreement_type": {
+ "description": "`internal` links a CSA in Common Paper (`underlying_agreement_id`); `external` describes another agreement in `underlying_agreement_val` (required). Omit for none.",
+ "enum": [
+ "internal",
+ "external"
+ ],
+ "type": "string"
+ },
+ "underlying_agreement_val": {
+ "description": "Description of the agreement this DPA supplements. Required when `underlying_agreement_type` is `external`.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "framework_terms_description": {
+ "description": "Custom framework terms description. Only used when framework_terms_type is \"description\".",
+ "type": "string"
+ },
+ "framework_terms_type": {
+ "description": "How framework terms are specified. Use \"new\" for standard terms or \"description\" to provide a custom framework_terms_description.",
+ "enum": [
+ "new",
+ "description"
+ ],
+ "type": "string"
+ },
+ "governing_law_country": {
+ "description": "The country whose laws govern the agreement.",
+ "type": "string"
+ },
+ "governing_law_region": {
+ "description": "The state or region whose laws govern the agreement.",
+ "type": "string"
+ },
+ "include_automated_payment_reminders": {
+ "description": "When true, automatically sends payment reminder emails.",
+ "type": "boolean"
+ },
+ "include_billing_info": {
+ "description": "When true, billing contact information (billing_name, billing_email) is included.",
+ "type": "boolean"
+ },
+ "include_billing_workflow": {
+ "description": "When true, enables a billing workflow after signing.",
+ "type": "boolean"
+ },
+ "include_expiration_date": {
+ "description": "Expiration date in YYYY-MM-DD format. Use when include_expiration_type is \"date\".",
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "include_expiration_days": {
+ "description": "Number of days until the agreement expires. Use when include_expiration_type is \"days\".",
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_expiration_type": {
+ "description": "How to set expiration: \"none\" (default), \"days\" (use include_expiration_days), or \"date\" (use include_expiration_date).",
+ "enum": [
+ "none",
+ "days",
+ "date"
+ ],
+ "type": "string"
+ },
+ "include_terms": {
+ "description": "When true, the standard terms are included with the agreement.",
+ "type": "boolean"
+ },
+ "loi_attributes": {
+ "additionalProperties": false,
+ "description": "Override loi terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "confidentiality_custom": {
+ "type": "string"
+ },
+ "confidentiality_mutual_include_loi": {
+ "type": "boolean"
+ },
+ "confidentiality_nda_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "confidentiality_nda_description": {
+ "type": "string"
+ },
+ "confidentiality_nda_include_loi": {
+ "type": "boolean"
+ },
+ "confidentiality_nda_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "confidentiality_type": {
+ "enum": [
+ "mutual",
+ "nda",
+ "provider",
+ "custom"
+ ],
+ "type": "string"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_custom_details": {
+ "type": "boolean"
+ },
+ "include_custom_details_val": {
+ "type": "string"
+ },
+ "include_fees": {
+ "type": "boolean"
+ },
+ "include_fees_amount": {
+ "type": "number"
+ },
+ "include_fees_amount_duration": {
+ "enum": [
+ "month",
+ "year",
+ "quarter"
+ ],
+ "type": "string"
+ },
+ "include_fees_include_amount": {
+ "type": "boolean"
+ },
+ "include_fees_include_other": {
+ "type": "boolean"
+ },
+ "include_fees_other": {
+ "type": "string"
+ },
+ "include_functionality": {
+ "type": "boolean"
+ },
+ "include_functionality_val": {
+ "type": "string"
+ },
+ "include_launch_date": {
+ "type": "boolean"
+ },
+ "include_launch_date_custom": {
+ "type": "string"
+ },
+ "include_launch_date_date": {
+ "format": "date-time",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$",
+ "type": "string"
+ },
+ "include_launch_date_type": {
+ "enum": [
+ "date",
+ "custom"
+ ],
+ "type": "string"
+ },
+ "product_name": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "manual_send": {
+ "description": "When true, the agreement is marked as manually sent outside the platform.",
+ "type": "boolean"
+ },
+ "message": {
+ "type": "string"
+ },
+ "negotiations_allowed": {
+ "description": "When true, the recipient can propose changes to the legal terms. For agreement types without separate business terms, that covers every term. CSA order forms, PSA statements of work, partnership business terms and software license order forms have their own `negotiations_allowed` flag.",
+ "type": "boolean"
+ },
+ "partnership_attributes": {
+ "additionalProperties": false,
+ "description": "Override partnership terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "effective_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "effective_date_type": {
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "type": "string"
+ },
+ "general_cap_amount_currency_val": {
+ "type": "number"
+ },
+ "general_cap_amount_either_currency": {
+ "type": "number"
+ },
+ "general_cap_amount_either_multiple": {
+ "type": "number"
+ },
+ "general_cap_amount_multiple_val": {
+ "type": "number"
+ },
+ "general_cap_amount_type": {
+ "enum": [
+ "multiple",
+ "currency",
+ "either",
+ "base"
+ ],
+ "type": "string"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_additional_warranties": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_include_company": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_include_company_val": {
+ "type": "string"
+ },
+ "include_additional_warranties_include_partner": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_include_partner_val": {
+ "type": "string"
+ },
+ "include_brand_guidelines": {
+ "type": "boolean"
+ },
+ "include_brand_guidelines_include_company": {
+ "type": "boolean"
+ },
+ "include_brand_guidelines_include_company_val": {
+ "type": "string"
+ },
+ "include_brand_guidelines_include_partner": {
+ "type": "boolean"
+ },
+ "include_brand_guidelines_include_partner_val": {
+ "type": "string"
+ },
+ "include_covered_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_company_claims": {
+ "type": "string"
+ },
+ "include_covered_claims_include_company_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_include_partner_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_partner_claims": {
+ "type": "string"
+ },
+ "include_dpa": {
+ "type": "boolean"
+ },
+ "include_dpa_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_dpa_location": {
+ "type": "string"
+ },
+ "include_dpa_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_increased_cap_amount": {
+ "type": "boolean"
+ },
+ "include_increased_cap_amount_currency": {
+ "type": "number"
+ },
+ "include_increased_cap_amount_either_currency": {
+ "type": "number"
+ },
+ "include_increased_cap_amount_either_multiple": {
+ "type": "string"
+ },
+ "include_increased_cap_amount_multiple": {
+ "type": "string"
+ },
+ "include_increased_cap_amount_type": {
+ "enum": [
+ "multiple",
+ "currency",
+ "either"
+ ],
+ "type": "string"
+ },
+ "include_increased_claims": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_confidentiality": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_confidentiality_misconduct": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_covered_claims": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_misconduct": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_other": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_other_val": {
+ "type": "string"
+ },
+ "include_unlimited_claims": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_confidentiality": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_confidentiality_misconduct": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_covered_claims": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_misconduct": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_other": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_other_val": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "partnership_business_terms_attributes": {
+ "additionalProperties": false,
+ "description": "Override partnership business terms terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "end_date_after_effective_date_amount": {
+ "type": "number"
+ },
+ "end_date_after_effective_date_unit": {
+ "enum": [
+ "month(s)",
+ "quarter(s)",
+ "year(s)"
+ ],
+ "type": "string"
+ },
+ "end_date_date": {
+ "type": "string"
+ },
+ "end_date_type": {
+ "enum": [
+ "date",
+ "effective date"
+ ],
+ "type": "string"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_obligations_company_brand": {
+ "type": "boolean"
+ },
+ "include_obligations_company_promotion": {
+ "type": "boolean"
+ },
+ "include_obligations_company_promotion_include_activities": {
+ "type": "boolean"
+ },
+ "include_obligations_company_promotion_include_activities_val": {
+ "type": "string"
+ },
+ "include_obligations_company_promotion_include_materials": {
+ "type": "boolean"
+ },
+ "include_obligations_company_promotion_include_materials_val": {
+ "type": "string"
+ },
+ "include_obligations_company_referral": {
+ "type": "boolean"
+ },
+ "include_obligations_company_referral_include_criteria": {
+ "type": "boolean"
+ },
+ "include_obligations_company_referral_include_criteria_val": {
+ "type": "string"
+ },
+ "include_obligations_company_referral_include_pay_sch": {
+ "type": "boolean"
+ },
+ "include_obligations_company_referral_include_pay_sch_amount": {
+ "type": "number"
+ },
+ "include_obligations_company_referral_include_pay_sch_custom": {
+ "type": "string"
+ },
+ "include_obligations_company_referral_include_pay_sch_unit": {
+ "enum": [
+ "U.S. Dollars",
+ "percent"
+ ],
+ "type": "string"
+ },
+ "include_obligations_company_sponsorship": {
+ "type": "boolean"
+ },
+ "include_obligations_company_sponsorship_include_benefits": {
+ "type": "boolean"
+ },
+ "include_obligations_company_sponsorship_include_benefits_val": {
+ "type": "string"
+ },
+ "include_obligations_company_sponsorship_include_payments": {
+ "type": "boolean"
+ },
+ "include_obligations_company_sponsorship_include_payments_amount": {
+ "type": "number"
+ },
+ "include_obligations_company_sponsorship_include_payments_unit": {
+ "enum": [
+ "U.S. Dollars",
+ "percent"
+ ],
+ "type": "string"
+ },
+ "include_obligations_partner_brand": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_promotion": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_promotion_include_activities": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_promotion_include_activities_val": {
+ "type": "string"
+ },
+ "include_obligations_partner_promotion_include_materials": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_promotion_include_materials_val": {
+ "type": "string"
+ },
+ "include_obligations_partner_referral": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_referral_include_criteria": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_referral_include_criteria_val": {
+ "type": "string"
+ },
+ "include_obligations_partner_referral_include_pay_sch": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_referral_include_pay_sch_amount": {
+ "type": "number"
+ },
+ "include_obligations_partner_referral_include_pay_sch_custom": {
+ "type": "string"
+ },
+ "include_obligations_partner_referral_include_pay_sch_unit": {
+ "enum": [
+ "U.S. Dollars",
+ "percent"
+ ],
+ "type": "string"
+ },
+ "include_obligations_partner_sponsorship": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_sponsorship_include_benefits": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_sponsorship_include_benefits_val": {
+ "type": "string"
+ },
+ "include_obligations_partner_sponsorship_include_payments": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_sponsorship_include_payments_amount": {
+ "type": "number"
+ },
+ "include_obligations_partner_sponsorship_include_payments_unit": {
+ "enum": [
+ "U.S. Dollars",
+ "percent"
+ ],
+ "type": "string"
+ },
+ "include_payment_process": {
+ "type": "boolean"
+ },
+ "include_payment_process_company": {
+ "type": "boolean"
+ },
+ "include_payment_process_company_include_address": {
+ "type": "boolean"
+ },
+ "include_payment_process_company_include_address_city": {
+ "type": "string"
+ },
+ "include_payment_process_company_include_address_country": {
+ "type": "string"
+ },
+ "include_payment_process_company_include_address_state": {
+ "type": "string"
+ },
+ "include_payment_process_company_include_address_street_address": {
+ "type": "string"
+ },
+ "include_payment_process_company_include_address_zipcode": {
+ "type": "string"
+ },
+ "include_payment_process_company_include_email": {
+ "type": "boolean"
+ },
+ "include_payment_process_company_include_email_val": {
+ "type": "string"
+ },
+ "include_payment_process_partner": {
+ "type": "boolean"
+ },
+ "include_payment_process_partner_include_address": {
+ "type": "boolean"
+ },
+ "include_payment_process_partner_include_address_city": {
+ "type": "string"
+ },
+ "include_payment_process_partner_include_address_country": {
+ "type": "string"
+ },
+ "include_payment_process_partner_include_address_state": {
+ "type": "string"
+ },
+ "include_payment_process_partner_include_address_street_address": {
+ "type": "string"
+ },
+ "include_payment_process_partner_include_address_zipcode": {
+ "type": "string"
+ },
+ "include_payment_process_partner_include_email": {
+ "type": "boolean"
+ },
+ "include_payment_process_partner_include_email_val": {
+ "type": "string"
+ },
+ "include_payment_schedule": {
+ "type": "boolean"
+ },
+ "include_payment_schedule_custom": {
+ "type": "string"
+ },
+ "include_payment_schedule_specified_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_payment_schedule_specified_timeframe": {
+ "enum": [
+ "receipt",
+ "date"
+ ],
+ "type": "string"
+ },
+ "include_payment_schedule_specified_unit": {
+ "enum": [
+ "day(s)",
+ "week(s)",
+ "month(s)",
+ "quarter(s)",
+ "year(s)"
+ ],
+ "type": "string"
+ },
+ "include_payment_schedule_type": {
+ "enum": [
+ "specified",
+ "custom"
+ ],
+ "type": "string"
+ },
+ "negotiations_allowed": {
+ "description": "When true, the recipient can propose changes to the business terms, even when the agreement-level `negotiations_allowed` is false. This only covers the business terms.",
+ "type": "boolean"
+ },
+ "territory_type": {
+ "enum": [
+ "worldwide",
+ "custom"
+ ],
+ "type": "string"
+ },
+ "territory_type_val": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "payment_link_url": {
+ "description": "A payment URL shown to the recipient after signing. Requires include_billing_workflow to be true and billing_workflow_type to be \"link\".",
+ "type": "string"
+ },
+ "pilot_attributes": {
+ "additionalProperties": false,
+ "description": "Override pilot terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "fees_type": {
+ "enum": [
+ "free",
+ "pilot_period_fees"
+ ],
+ "type": "string"
+ },
+ "general_cap_amount": {
+ "type": "number"
+ },
+ "general_cap_amount_type": {
+ "enum": [
+ "preceding",
+ "base",
+ "period"
+ ],
+ "type": "string"
+ },
+ "general_cap_period_currency": {
+ "type": "number"
+ },
+ "general_cap_period_qty": {
+ "type": "number"
+ },
+ "general_cap_preceding_amount": {
+ "type": "number"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_dpa": {
+ "type": "boolean"
+ },
+ "include_dpa_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_dpa_location": {
+ "type": "string"
+ },
+ "include_dpa_type": {
+ "enum": [
+ "description",
+ "attachment",
+ "standard"
+ ],
+ "type": "string"
+ },
+ "include_payment_process": {
+ "type": "boolean"
+ },
+ "include_technical_support": {
+ "type": "boolean"
+ },
+ "payment_process_automatic_frequency": {
+ "enum": [
+ "monthly",
+ "quarterly",
+ "annually",
+ "once_per_period"
+ ],
+ "type": "string"
+ },
+ "payment_process_invoice_days": {
+ "type": "number"
+ },
+ "payment_process_invoice_from": {
+ "enum": [
+ "receipt",
+ "date"
+ ],
+ "type": "string"
+ },
+ "payment_process_invoice_timeframe": {
+ "enum": [
+ "days",
+ "weeks",
+ "months",
+ "quarters",
+ "years"
+ ],
+ "type": "string"
+ },
+ "payment_process_type": {
+ "enum": [
+ "automatic",
+ "invoice"
+ ],
+ "type": "string"
+ },
+ "pilot_period_description": {
+ "type": "string"
+ },
+ "pilot_period_fees_description": {
+ "type": "string"
+ },
+ "product_description": {
+ "type": "string"
+ },
+ "technical_support_description": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "psa_attributes": {
+ "additionalProperties": false,
+ "description": "Override psa terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "additional_changes": {
+ "type": "string"
+ },
+ "customer_description": {
+ "type": "string"
+ },
+ "effective_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "effective_date_type": {
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "type": "string"
+ },
+ "general_cap_amount": {
+ "type": "number"
+ },
+ "general_cap_amount_type": {
+ "enum": [
+ "preceding",
+ "base",
+ "period"
+ ],
+ "type": "string"
+ },
+ "general_cap_period_currency": {
+ "type": "number"
+ },
+ "general_cap_period_qty": {
+ "type": "number"
+ },
+ "general_cap_preceding_amount": {
+ "type": "number"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_additional_changes": {
+ "type": "boolean"
+ },
+ "include_additional_warranties": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_by_customer": {
+ "type": "string"
+ },
+ "include_additional_warranties_by_provider": {
+ "type": "string"
+ },
+ "include_additional_warranties_include_by_customer": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_include_by_provider": {
+ "type": "boolean"
+ },
+ "include_covered_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_customer_claims": {
+ "type": "string"
+ },
+ "include_covered_claims_include_customer_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_include_provider_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_provider_claims": {
+ "type": "string"
+ },
+ "include_customer_insurance_min": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_add_provider_com_gen_liability": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_add_provider_cyber_liability": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_add_provider_errors_omissions": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_auto_liability_aggregate": {
+ "type": "number"
+ },
+ "include_customer_insurance_min_auto_liability_minimum": {
+ "type": "number"
+ },
+ "include_customer_insurance_min_cyber_liability_aggregate": {
+ "type": "number"
+ },
+ "include_customer_insurance_min_cyber_liability_minimum": {
+ "type": "number"
+ },
+ "include_customer_insurance_min_employer_liability_aggregate": {
+ "type": "number"
+ },
+ "include_customer_insurance_min_employer_liability_minimum": {
+ "type": "number"
+ },
+ "include_customer_insurance_min_general_liability_aggregate": {
+ "type": "number"
+ },
+ "include_customer_insurance_min_general_liability_minimum": {
+ "type": "number"
+ },
+ "include_customer_insurance_min_include_add_provider": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_include_auto_liability": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_include_cyber_liability": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_include_employer_liability": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_include_general_liability": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_include_workers_comp": {
+ "type": "boolean"
+ },
+ "include_customer_policies": {
+ "type": "boolean"
+ },
+ "include_customer_policies_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_customer_policies_location": {
+ "type": "string"
+ },
+ "include_customer_policies_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_dpa": {
+ "type": "boolean"
+ },
+ "include_dpa_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_dpa_location": {
+ "type": "string"
+ },
+ "include_dpa_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_increased_cap_amount": {
+ "type": "boolean"
+ },
+ "include_increased_claims": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_confidentiality": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_confidentiality_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_privsec": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_privsec_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_other": {
+ "type": "boolean"
+ },
+ "include_increased_claims_indemnification_obligation": {
+ "type": "boolean"
+ },
+ "include_increased_claims_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_other": {
+ "type": "string"
+ },
+ "include_provider_insurance_min": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_add_customer_com_gen_liability": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_add_customer_cyber_liability": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_add_customer_errors_omissions": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_auto_liability_aggregate": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_auto_liability_minimum": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_cyber_liability_aggregate": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_cyber_liability_minimum": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_employer_liability_aggregate": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_employer_liability_minimum": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_general_liability_aggregate": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_general_liability_minimum": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_include_add_customer": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_include_auto_liability": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_include_cyber_liability": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_include_employer_liability": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_include_general_liability": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_include_workers_comp": {
+ "type": "boolean"
+ },
+ "include_publicity_rights": {
+ "type": "boolean"
+ },
+ "include_publicity_rights_type": {
+ "enum": [
+ "public",
+ "non-public"
+ ],
+ "type": "string"
+ },
+ "include_security_policy": {
+ "type": "boolean"
+ },
+ "include_security_policy_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_security_policy_fedramp_auth": {
+ "type": "boolean"
+ },
+ "include_security_policy_hitrust": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_annual_maintenance": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_other": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_other_val": {
+ "type": "string"
+ },
+ "include_security_policy_iso27001": {
+ "type": "boolean"
+ },
+ "include_security_policy_location": {
+ "type": "string"
+ },
+ "include_security_policy_pci1": {
+ "type": "boolean"
+ },
+ "include_security_policy_pci2": {
+ "type": "boolean"
+ },
+ "include_security_policy_penetration_testing": {
+ "type": "boolean"
+ },
+ "include_security_policy_soc2_type1": {
+ "type": "boolean"
+ },
+ "include_security_policy_soc2_type2": {
+ "type": "boolean"
+ },
+ "include_security_policy_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_unlimited_claims": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_confidentiality": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_confidentiality_negligence": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_privsec": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_privsec_negligence": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_include_other": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_indemnification_obligation": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_negligence": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_other": {
+ "type": "string"
+ },
+ "increased_cap_amount_currency": {
+ "type": "number"
+ },
+ "increased_cap_amount_period_currency": {
+ "type": "number"
+ },
+ "increased_cap_amount_period_qty": {
+ "type": "number"
+ },
+ "increased_cap_amount_qty": {
+ "type": "number"
+ },
+ "increased_cap_amount_type": {
+ "enum": [
+ "qty",
+ "currency",
+ "period"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "psa_statement_of_work_attributes": {
+ "additionalProperties": false,
+ "description": "Override psa statement of work terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "additional_changes": {
+ "type": "string"
+ },
+ "cost": {
+ "type": "number"
+ },
+ "description": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "fees_attributes": {
+ "additionalProperties": {
+ "anyOf": [
+ {
+ "additionalProperties": false,
+ "description": "Fees::Flat (fee_type \"flat\"). A fixed recurring fee, e.g. a platform subscription. Set type to \"Fees::Flat\" or fee_type to \"flat\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Fixed amount in the order form's fees_currency, charged per fee_period. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"flat\". Alternative to type.",
+ "enum": [
+ "flat"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Flat\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Flat"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Discount (fee_type \"discount\"). A discount, as a fixed amount or a percentage, applied forever, once, or for a number of months. Set type to \"Fees::Discount\" or fee_type to \"discount\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Discount size: an amount in fees_currency when discount_type is fixed_amount (a plain amount, not cents: 20 means 20.00), or a percentage (e.g. 10 for 10%) when it is percentage.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "discount_duration_amount": {
+ "description": "Number of months the discount applies. Required when discount_duration_type is multiple_months.",
+ "type": "number"
+ },
+ "discount_duration_type": {
+ "description": "How long the discount applies. multiple_months also needs discount_duration_amount.",
+ "enum": [
+ "forever",
+ "once",
+ "multiple_months"
+ ],
+ "type": "string"
+ },
+ "discount_type": {
+ "description": "Whether cost is a currency amount or a percentage.",
+ "enum": [
+ "fixed_amount",
+ "percentage"
+ ],
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"discount\". Alternative to type.",
+ "enum": [
+ "discount"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Discount\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Discount"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Cost (fee_type \"cost\"). A per-unit fee: price per unit times quantity, e.g. seats. Set type to \"Fees::Cost\" or fee_type to \"cost\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Price per unit in fees_currency. The row total is quantity x cost. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"cost\". Alternative to type.",
+ "enum": [
+ "cost"
+ ],
+ "type": "string"
+ },
+ "quantity": {
+ "description": "Number of units.",
+ "type": "number"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Cost\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Cost"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Attachment (fee_type \"attachment\"). A fee described in an uploaded attachment instead of in the table. Set type to \"Fees::Attachment\" or fee_type to \"attachment\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "attachment_id": {
+ "description": "ID of an attachment uploaded with upload-attachment.",
+ "type": "string"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"attachment\". Alternative to type.",
+ "enum": [
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Attachment\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Attachment"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Graduated (fee_type \"graduated\"). Tiered pricing, with the price set per tier in graduated_fee_tiers_attributes. Set type to \"Fees::Graduated\" or fee_type to \"graduated\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"graduated\". Alternative to type.",
+ "enum": [
+ "graduated"
+ ],
+ "type": "string"
+ },
+ "graduated_fee_tiers_attributes": {
+ "additionalProperties": {
+ "additionalProperties": false,
+ "properties": {
+ "flat_price": {
+ "type": "number"
+ },
+ "price_per_unit": {
+ "type": "string"
+ },
+ "upper_limit": {
+ "type": "number"
+ }
+ },
+ "type": "object"
+ },
+ "description": "Graduated fee tiers. Use string keys such as \"0\", \"1\".",
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Graduated\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Graduated"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Included (fee_type \"included\"). An item included at no charge. Set type to \"Fees::Included\" or fee_type to \"included\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"included\". Alternative to type.",
+ "enum": [
+ "included"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Included\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Included"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Metered (fee_type \"metered\"). Usage-based pricing, billed per unit used. Set type to \"Fees::Metered\" or fee_type to \"metered\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Price per unit of usage in fees_currency. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"metered\". Alternative to type.",
+ "enum": [
+ "metered"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Metered\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Metered"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::OneTime (fee_type \"one_time\"). A one-time charge, such as a setup fee. Set type to \"Fees::OneTime\" or fee_type to \"one_time\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "One-time amount in fees_currency, charged once rather than per fee_period. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"one_time\". Alternative to type.",
+ "enum": [
+ "one_time"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::OneTime\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::OneTime"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Text (fee_type \"text\"). A fee term described in free text. Set type to \"Fees::Text\" or fee_type to \"text\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"text\". Alternative to type.",
+ "enum": [
+ "text"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Text\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Text"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ }
+ ]
+ },
+ "description": "Fee line items. Use string keys such as \"0\", \"1\". Replaces template fees when provided.",
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_additional_changes": {
+ "type": "boolean"
+ },
+ "include_customer_obligation": {
+ "type": "boolean"
+ },
+ "include_customer_obligation_val": {
+ "type": "string"
+ },
+ "include_deliverables": {
+ "type": "boolean"
+ },
+ "include_deliverables_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_deliverables_description": {
+ "type": "string"
+ },
+ "include_deliverables_include_acceptance": {
+ "type": "boolean"
+ },
+ "include_deliverables_include_attachment": {
+ "type": "boolean"
+ },
+ "include_deliverables_include_draft_deliverables": {
+ "type": "boolean"
+ },
+ "include_deliverables_rejection_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_deliverables_rejection_unit": {
+ "enum": [
+ "hours",
+ "days",
+ "weeks",
+ "months"
+ ],
+ "type": "string"
+ },
+ "include_deliverables_resubmission_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_deliverables_resubmission_unit": {
+ "enum": [
+ "hours",
+ "days",
+ "weeks",
+ "months"
+ ],
+ "type": "string"
+ },
+ "include_fees_other": {
+ "type": "boolean"
+ },
+ "include_fees_other_val": {
+ "type": "string"
+ },
+ "include_fees_table": {
+ "type": "boolean"
+ },
+ "include_fees_table_total": {
+ "type": "boolean"
+ },
+ "include_fees_travel": {
+ "type": "boolean"
+ },
+ "include_fees_travel_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_fees_travel_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_fees_travel_val": {
+ "type": "string"
+ },
+ "include_third_party_customer": {
+ "type": "boolean"
+ },
+ "include_third_party_include_description": {
+ "type": "boolean"
+ },
+ "include_third_party_include_description_val": {
+ "type": "string"
+ },
+ "include_third_party_materials": {
+ "type": "boolean"
+ },
+ "include_third_party_provider": {
+ "type": "boolean"
+ },
+ "include_time_of_assignment": {
+ "type": "boolean"
+ },
+ "include_time_of_assignment_type": {
+ "enum": [
+ "created",
+ "paid"
+ ],
+ "type": "string"
+ },
+ "invoice_period_description": {
+ "type": "string"
+ },
+ "negotiations_allowed": {
+ "description": "When true, the recipient can propose changes to the statement of work, even when the agreement-level `negotiations_allowed` is false. This only covers the statement of work.",
+ "type": "boolean"
+ },
+ "payment_period": {
+ "type": "number"
+ },
+ "payment_period_other": {
+ "type": "string"
+ },
+ "payment_period_timeframe": {
+ "enum": [
+ "receipt",
+ "invoice",
+ "Customer's receipt of invoice",
+ "date of invoice"
+ ],
+ "type": "string"
+ },
+ "payment_period_type": {
+ "enum": [
+ "standard",
+ "other"
+ ],
+ "type": "string"
+ },
+ "payment_period_unit": {
+ "enum": [
+ "day(s)",
+ "week(s)",
+ "month(s)",
+ "quarter(s)",
+ "year(s)"
+ ],
+ "type": "string"
+ },
+ "quantity": {
+ "type": "number"
+ },
+ "services_description": {
+ "type": "string"
+ },
+ "sow_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "sow_date_type": {
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "type": "string"
+ },
+ "sow_term_amount": {
+ "type": "number"
+ },
+ "sow_term_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "sow_term_type": {
+ "enum": [
+ "deliverables",
+ "period",
+ "date"
+ ],
+ "type": "string"
+ },
+ "sow_term_unit": {
+ "enum": [
+ "month(s)",
+ "quarter(s)",
+ "year(s)"
+ ],
+ "type": "string"
+ },
+ "type": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "recipient_email": {
+ "format": "email",
+ "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "recipient_name": {
+ "type": "string"
+ },
+ "recipient_notice_email_address": {
+ "description": "Email address for legal notices to the recipient.",
+ "format": "email",
+ "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "recipient_organization": {
+ "type": "string"
+ },
+ "recipient_role": {
+ "description": "PSA only. The recipient's role: `Customer` (the default) or `Provider`. Send it with `sender_role`; the two must be one `Provider` and one `Customer`. Other standard agreement types ignore it.",
+ "type": "string"
+ },
+ "sender_last_to_sign": {
+ "description": "When true, your signer signs after the recipient.",
+ "type": "boolean"
+ },
+ "sender_notice_email_address": {
+ "description": "Email address for legal notices to the sender.",
+ "format": "email",
+ "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "sender_role": {
+ "description": "PSA only. Your company's role: `Provider` (the default) or `Customer` when you hire the recipient to provide the services. Send it with `recipient_role`; the two must be one `Provider` and one `Customer`. When reading a PSA, an empty `sender_role` means `Provider`. Other standard agreement types ignore it.",
+ "type": "string"
+ },
+ "software_license_attributes": {
+ "additionalProperties": false,
+ "description": "Override software license terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "effective_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "effective_date_type": {
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "type": "string"
+ },
+ "general_cap_amount": {
+ "type": "number"
+ },
+ "general_cap_amount_type": {
+ "enum": [
+ "preceding",
+ "base",
+ "period"
+ ],
+ "type": "string"
+ },
+ "general_cap_period_currency": {
+ "type": "number"
+ },
+ "general_cap_period_qty": {
+ "type": "number"
+ },
+ "general_cap_preceding_amount": {
+ "type": "number"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_additional_warranties": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_by_customer": {
+ "type": "string"
+ },
+ "include_additional_warranties_by_provider": {
+ "type": "string"
+ },
+ "include_additional_warranties_include_by_customer": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_include_by_provider": {
+ "type": "boolean"
+ },
+ "include_ai_addendum": {
+ "type": "boolean"
+ },
+ "include_ai_addendum_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_covered_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_customer_claims": {
+ "type": "string"
+ },
+ "include_covered_claims_include_customer_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_include_provider_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_provider_claims": {
+ "type": "string"
+ },
+ "include_dpa": {
+ "type": "boolean"
+ },
+ "include_dpa_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_dpa_location": {
+ "type": "string"
+ },
+ "include_dpa_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_increased_cap_amount": {
+ "type": "boolean"
+ },
+ "include_increased_claims": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_confidentiality": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_confidentiality_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_other": {
+ "type": "boolean"
+ },
+ "include_increased_claims_indemnification_obligation": {
+ "type": "boolean"
+ },
+ "include_increased_claims_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_other": {
+ "type": "string"
+ },
+ "include_increased_claims_restrictions": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_confidentiality": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_confidentiality_negligence": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_include_other": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_indemnification_obligation": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_license_or_restrictions": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_negligence": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_other": {
+ "type": "string"
+ },
+ "increased_cap_amount_currency": {
+ "type": "number"
+ },
+ "increased_cap_amount_period_currency": {
+ "type": "number"
+ },
+ "increased_cap_amount_period_qty": {
+ "type": "number"
+ },
+ "increased_cap_amount_qty": {
+ "type": "number"
+ },
+ "increased_cap_amount_type": {
+ "enum": [
+ "qty",
+ "currency",
+ "period"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "software_license_order_form_attributes": {
+ "additionalProperties": false,
+ "description": "Override software license order form terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "additional_changes": {
+ "type": "string"
+ },
+ "deletion_procedure_include_custom": {
+ "type": "boolean"
+ },
+ "deletion_procedure_include_custom_description": {
+ "type": "string"
+ },
+ "deletion_procedure_include_customer_disable": {
+ "type": "boolean"
+ },
+ "deletion_procedure_include_customer_proof": {
+ "type": "boolean"
+ },
+ "deletion_procedure_include_provider_disable": {
+ "type": "boolean"
+ },
+ "fee_custom_unit": {
+ "type": "string"
+ },
+ "fee_period": {
+ "enum": [
+ "Subscription Period",
+ "month",
+ "year",
+ "Custom unit"
+ ],
+ "type": "string"
+ },
+ "fees_attributes": {
+ "additionalProperties": {
+ "anyOf": [
+ {
+ "additionalProperties": false,
+ "description": "Fees::Flat (fee_type \"flat\"). A fixed recurring fee, e.g. a platform subscription. Set type to \"Fees::Flat\" or fee_type to \"flat\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Fixed amount in the order form's fees_currency, charged per fee_period. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"flat\". Alternative to type.",
+ "enum": [
+ "flat"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Flat\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Flat"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Discount (fee_type \"discount\"). A discount, as a fixed amount or a percentage, applied forever, once, or for a number of months. Set type to \"Fees::Discount\" or fee_type to \"discount\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Discount size: an amount in fees_currency when discount_type is fixed_amount (a plain amount, not cents: 20 means 20.00), or a percentage (e.g. 10 for 10%) when it is percentage.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "discount_duration_amount": {
+ "description": "Number of months the discount applies. Required when discount_duration_type is multiple_months.",
+ "type": "number"
+ },
+ "discount_duration_type": {
+ "description": "How long the discount applies. multiple_months also needs discount_duration_amount.",
+ "enum": [
+ "forever",
+ "once",
+ "multiple_months"
+ ],
+ "type": "string"
+ },
+ "discount_type": {
+ "description": "Whether cost is a currency amount or a percentage.",
+ "enum": [
+ "fixed_amount",
+ "percentage"
+ ],
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"discount\". Alternative to type.",
+ "enum": [
+ "discount"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Discount\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Discount"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Cost (fee_type \"cost\"). A per-unit fee: price per unit times quantity, e.g. seats. Set type to \"Fees::Cost\" or fee_type to \"cost\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Price per unit in fees_currency. The row total is quantity x cost. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"cost\". Alternative to type.",
+ "enum": [
+ "cost"
+ ],
+ "type": "string"
+ },
+ "quantity": {
+ "description": "Number of units.",
+ "type": "number"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Cost\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Cost"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Attachment (fee_type \"attachment\"). A fee described in an uploaded attachment instead of in the table. Set type to \"Fees::Attachment\" or fee_type to \"attachment\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "attachment_id": {
+ "description": "ID of an attachment uploaded with upload-attachment.",
+ "type": "string"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"attachment\". Alternative to type.",
+ "enum": [
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Attachment\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Attachment"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Graduated (fee_type \"graduated\"). Tiered pricing, with the price set per tier in graduated_fee_tiers_attributes. Set type to \"Fees::Graduated\" or fee_type to \"graduated\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"graduated\". Alternative to type.",
+ "enum": [
+ "graduated"
+ ],
+ "type": "string"
+ },
+ "graduated_fee_tiers_attributes": {
+ "additionalProperties": {
+ "additionalProperties": false,
+ "properties": {
+ "flat_price": {
+ "type": "number"
+ },
+ "price_per_unit": {
+ "type": "string"
+ },
+ "upper_limit": {
+ "type": "number"
+ }
+ },
+ "type": "object"
+ },
+ "description": "Graduated fee tiers. Use string keys such as \"0\", \"1\".",
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Graduated\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Graduated"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Included (fee_type \"included\"). An item included at no charge. Set type to \"Fees::Included\" or fee_type to \"included\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"included\". Alternative to type.",
+ "enum": [
+ "included"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Included\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Included"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Metered (fee_type \"metered\"). Usage-based pricing, billed per unit used. Set type to \"Fees::Metered\" or fee_type to \"metered\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Price per unit of usage in fees_currency. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"metered\". Alternative to type.",
+ "enum": [
+ "metered"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Metered\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Metered"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::OneTime (fee_type \"one_time\"). A one-time charge, such as a setup fee. Set type to \"Fees::OneTime\" or fee_type to \"one_time\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "One-time amount in fees_currency, charged once rather than per fee_period. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"one_time\". Alternative to type.",
+ "enum": [
+ "one_time"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::OneTime\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::OneTime"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Text (fee_type \"text\"). A fee term described in free text. Set type to \"Fees::Text\" or fee_type to \"text\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"text\". Alternative to type.",
+ "enum": [
+ "text"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Text\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Text"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ }
+ ]
+ },
+ "description": "Fee line items. Use string keys such as \"0\", \"1\". Replaces template fees when provided.",
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+ },
+ "fees_currency": {
+ "enum": [
+ "USD",
+ "EUR",
+ "GBP",
+ "CAD",
+ "AUD",
+ "SGD",
+ "ILS",
+ "JPY",
+ "CHF",
+ "HKD"
+ ],
+ "type": "string"
+ },
+ "fees_include_fee_increase_upon_renewal": {
+ "type": "boolean"
+ },
+ "fees_include_fee_increase_upon_renewal_fee": {
+ "type": "number"
+ },
+ "fees_include_fee_increase_upon_renewal_type": {
+ "enum": [
+ "will",
+ "may"
+ ],
+ "type": "string"
+ },
+ "fees_inclusive_of_taxes": {
+ "type": "boolean"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_additional_changes": {
+ "type": "boolean"
+ },
+ "include_license_compliance_verification": {
+ "type": "boolean"
+ },
+ "include_license_compliance_verification_description": {
+ "type": "string"
+ },
+ "include_license_limits": {
+ "type": "boolean"
+ },
+ "include_license_limits_description": {
+ "type": "string"
+ },
+ "include_payment_process_include_billing_email": {
+ "type": "boolean"
+ },
+ "include_pilot_period": {
+ "type": "boolean"
+ },
+ "include_pilot_period_duration_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_pilot_period_duration_type": {
+ "enum": [
+ "day",
+ "week",
+ "month"
+ ],
+ "type": "string"
+ },
+ "include_pilot_period_include_fees": {
+ "type": "boolean"
+ },
+ "include_pilot_period_include_fees_amount": {
+ "type": "number"
+ },
+ "include_pilot_period_include_modifications": {
+ "type": "boolean"
+ },
+ "include_pilot_period_include_modifications_description": {
+ "type": "string"
+ },
+ "include_services": {
+ "type": "boolean"
+ },
+ "include_services_description": {
+ "type": "string"
+ },
+ "negotiations_allowed": {
+ "description": "When true, the recipient can propose changes to the order form, even when the agreement-level `negotiations_allowed` is false. This only covers the order form.",
+ "type": "boolean"
+ },
+ "order_date_date": {
+ "type": "string"
+ },
+ "order_date_type": {
+ "enum": [
+ "signature",
+ "date",
+ "other"
+ ],
+ "type": "string"
+ },
+ "payment_process_automatic_frequency": {
+ "enum": [
+ "monthly",
+ "quarterly",
+ "semiannually",
+ "annually"
+ ],
+ "type": "string"
+ },
+ "payment_process_type": {
+ "enum": [
+ "automatic",
+ "invoice",
+ "custom"
+ ],
+ "type": "string"
+ },
+ "payment_process_type_custom_val": {
+ "type": "string"
+ },
+ "payment_process_type_invoice_amount": {
+ "type": "number"
+ },
+ "payment_process_type_invoice_custom_unit": {
+ "type": "string"
+ },
+ "payment_process_type_invoice_duration": {
+ "enum": [
+ "day",
+ "week",
+ "month",
+ "year",
+ "day(s)",
+ "week(s)",
+ "month(s)",
+ "year(s)"
+ ],
+ "type": "string"
+ },
+ "payment_process_type_invoice_duration_start": {
+ "enum": [
+ "Customer's receipt of invoice",
+ "date of invoice"
+ ],
+ "type": "string"
+ },
+ "payment_process_type_invoice_type": {
+ "enum": [
+ "monthly",
+ "quarterly",
+ "semiannually",
+ "annually",
+ "Custom unit"
+ ],
+ "type": "string"
+ },
+ "permitted_uses_include_custom": {
+ "type": "boolean"
+ },
+ "permitted_uses_include_custom_description": {
+ "type": "string"
+ },
+ "permitted_uses_include_customers_affiliates": {
+ "type": "boolean"
+ },
+ "permitted_uses_include_internal_business": {
+ "type": "boolean"
+ },
+ "pilot_period_stripe_product_id": {
+ "type": "string"
+ },
+ "software_description": {
+ "type": "string"
+ },
+ "subscription_auto_renew": {
+ "enum": [
+ "days",
+ "subscription_end"
+ ],
+ "type": "string"
+ },
+ "subscription_period": {
+ "type": "number"
+ },
+ "subscription_period_unit": {
+ "type": "string"
+ },
+ "subscription_renewal_notice_days": {
+ "type": "number"
+ },
+ "warranty_period_description_amount": {
+ "type": "number"
+ },
+ "warranty_period_description_duration": {
+ "enum": [
+ "day",
+ "week",
+ "month",
+ "year"
+ ],
+ "type": "string"
+ },
+ "warranty_period_description_duration_start": {
+ "enum": [
+ "initial delivery of the Software",
+ "delivery of the Software and each subsequent Update",
+ "the Order Date"
+ ],
+ "type": "string"
+ },
+ "warranty_period_type": {
+ "enum": [
+ "description",
+ "none"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "test_agreement": {
+ "description": "When true, marks the agreement as a test. Test agreements do not count against your monthly limit.",
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "recipient_name",
+ "recipient_email"
+ ],
+ "type": "object"
+ },
+ "cc_users": {
+ "items": {
+ "format": "email",
+ "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "draft": {
+ "description": "When true, the agreement is saved as a draft and not sent to the recipient. Use POST /v1/agreements/{id}/send to send a draft agreement later.",
+ "type": "boolean"
+ },
+ "owner_email": {
+ "description": "Email address of the agreement owner (sender).",
+ "type": "string"
+ },
+ "signer_id": {
+ "description": "User id of the signer from the owner's organization.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "template_id": {
+ "description": "UUID of a template from `GET /v1/templates`. Accepts both Common Paper standard templates and uploaded PDF templates (`type` `uploaded_template`).",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ }
+ },
+ "required": [
+ "template_id",
+ "owner_email",
+ "signer_id",
+ "agreement"
+ ],
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "agreement": {
+ "additionalProperties": {},
+ "properties": {
+ "amendment_attributes": {
+ "additionalProperties": false,
+ "description": "Override amendment terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "amended_terms_attributes": {
+ "additionalProperties": {
+ "additionalProperties": false,
+ "properties": {
+ "description": {
+ "type": "string"
+ },
+ "term": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "description": "Amended terms. Use string keys such as \"0\", \"1\".",
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+ },
+ "amendment_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "amendment_date_type": {
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "type": "string"
+ },
+ "framework_terms_type": {
+ "type": "string"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "parent_agreement_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "underlying_agreement_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "underlying_agreement_type": {
+ "type": "string"
+ },
+ "underlying_agreement_val": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "baa_attributes": {
+ "additionalProperties": false,
+ "description": "Override baa terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "aggregation_limitations_permitted": {
+ "type": "boolean"
+ },
+ "aggregation_limitations_permitted_val": {
+ "type": "string"
+ },
+ "breach_notification_unit": {
+ "enum": [
+ "hours",
+ "business days",
+ "calendar days"
+ ],
+ "type": "string"
+ },
+ "breach_notification_val": {
+ "type": "number"
+ },
+ "business_associate_relationship_type": {
+ "enum": [
+ "provider",
+ "company"
+ ],
+ "type": "string"
+ },
+ "deidentification_limitations_include_purpose": {
+ "type": "boolean"
+ },
+ "deidentification_limitations_include_requirements": {
+ "type": "boolean"
+ },
+ "deidentification_limitations_permitted": {
+ "type": "boolean"
+ },
+ "deidentification_limitations_purpose_val": {
+ "type": "string"
+ },
+ "deidentification_limitations_requirements_val": {
+ "type": "string"
+ },
+ "designated_record_set_provider_maintains": {
+ "type": "boolean"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_aggregation_limitations": {
+ "type": "boolean"
+ },
+ "include_deidentification_limitations": {
+ "type": "boolean"
+ },
+ "include_limitations": {
+ "type": "boolean"
+ },
+ "include_offshore_limitations": {
+ "type": "boolean"
+ },
+ "include_subcontract_limitations": {
+ "type": "boolean"
+ },
+ "offshore_limitations_permitted": {
+ "type": "boolean"
+ },
+ "offshore_limitations_permitted_val": {
+ "type": "string"
+ },
+ "subcontract_limitations_include_notice": {
+ "type": "boolean"
+ },
+ "subcontract_limitations_include_permission": {
+ "type": "boolean"
+ },
+ "subcontract_limitations_notice_val": {
+ "type": "string"
+ },
+ "subcontract_limitations_permission_val": {
+ "type": "string"
+ },
+ "subcontract_limitations_permitted": {
+ "type": "boolean"
+ },
+ "underlying_agreement_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "underlying_agreement_type": {
+ "enum": [
+ "internal",
+ "external",
+ "none"
+ ],
+ "type": "string"
+ },
+ "underlying_agreement_val": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "billing_email": {
+ "description": "Email of the billing contact. Used when include_billing_info is true.",
+ "format": "email",
+ "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "billing_name": {
+ "description": "Name of the billing contact. Used when include_billing_info is true.",
+ "type": "string"
+ },
+ "billing_workflow_type": {
+ "description": "The type of billing workflow. Use \"link\" to provide a payment_link_url, or \"stripe\" for Stripe-managed billing.",
+ "enum": [
+ "link",
+ "stripe"
+ ],
+ "type": "string"
+ },
+ "chosen_courts_country": {
+ "description": "The country in which disputes will be resolved.",
+ "type": "string"
+ },
+ "chosen_courts_region": {
+ "description": "The state or region in which disputes will be resolved.",
+ "type": "string"
+ },
+ "csa_attributes": {
+ "additionalProperties": false,
+ "description": "Override csa terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "customer_description": {
+ "type": "string"
+ },
+ "effective_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "effective_date_marketplace": {
+ "enum": [
+ "AWS",
+ "GCP",
+ "Azure"
+ ],
+ "type": "string"
+ },
+ "effective_date_type": {
+ "enum": [
+ "signature",
+ "date",
+ "marketplace_acceptance"
+ ],
+ "type": "string"
+ },
+ "general_cap_amount": {
+ "type": "number"
+ },
+ "general_cap_amount_type": {
+ "enum": [
+ "preceding",
+ "base",
+ "period"
+ ],
+ "type": "string"
+ },
+ "general_cap_period_currency": {
+ "type": "number"
+ },
+ "general_cap_period_qty": {
+ "type": "number"
+ },
+ "general_cap_preceding_amount": {
+ "type": "number"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_acceptable_use_policy": {
+ "type": "boolean"
+ },
+ "include_acceptable_use_policy_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_acceptable_use_policy_location": {
+ "type": "string"
+ },
+ "include_acceptable_use_policy_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_additional_warranties": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_by_customer": {
+ "type": "string"
+ },
+ "include_additional_warranties_by_provider": {
+ "type": "string"
+ },
+ "include_additional_warranties_include_by_customer": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_include_by_provider": {
+ "type": "boolean"
+ },
+ "include_ai_addendum": {
+ "type": "boolean"
+ },
+ "include_ai_addendum_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_covered_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_customer_claims": {
+ "type": "string"
+ },
+ "include_covered_claims_include_customer_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_include_provider_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_provider_claims": {
+ "type": "string"
+ },
+ "include_dpa": {
+ "type": "boolean"
+ },
+ "include_dpa_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_dpa_location": {
+ "type": "string"
+ },
+ "include_dpa_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_increased_cap_amount": {
+ "type": "boolean"
+ },
+ "include_increased_claims": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_confidentiality": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_confidentiality_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_privsec": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_privsec_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_other": {
+ "type": "boolean"
+ },
+ "include_increased_claims_indemnification_obligation": {
+ "type": "boolean"
+ },
+ "include_increased_claims_other": {
+ "type": "string"
+ },
+ "include_insurance_minimums": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_add_customer": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_add_customer_com_gen_liability": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_add_customer_cyber_liability": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_add_customer_errors_omissions": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_additional_information": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_additional_information_text": {
+ "type": "string"
+ },
+ "include_insurance_minimums_cyber_liability_aggregate": {
+ "type": "number"
+ },
+ "include_insurance_minimums_cyber_liability_minimum": {
+ "type": "number"
+ },
+ "include_insurance_minimums_employer_liability_aggregate": {
+ "type": "number"
+ },
+ "include_insurance_minimums_employer_liability_minimum": {
+ "type": "number"
+ },
+ "include_insurance_minimums_general_liability_aggregate": {
+ "type": "number"
+ },
+ "include_insurance_minimums_general_liability_minimum": {
+ "type": "number"
+ },
+ "include_insurance_minimums_include_cyber_liability": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_include_employer_liability": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_include_general_liability": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_include_workers_compensation": {
+ "type": "boolean"
+ },
+ "include_publicity_rights": {
+ "type": "boolean"
+ },
+ "include_publicity_rights_type": {
+ "enum": [
+ "public",
+ "non-public"
+ ],
+ "type": "string"
+ },
+ "include_security_policy": {
+ "type": "boolean"
+ },
+ "include_security_policy_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_security_policy_fedramp_auth": {
+ "type": "boolean"
+ },
+ "include_security_policy_hipaa": {
+ "type": "boolean"
+ },
+ "include_security_policy_hitrust": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_annual_maintenance": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_location": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_other": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_reasonable_efforts": {
+ "type": "boolean"
+ },
+ "include_security_policy_iso27001": {
+ "type": "boolean"
+ },
+ "include_security_policy_location": {
+ "type": "string"
+ },
+ "include_security_policy_other": {
+ "type": "string"
+ },
+ "include_security_policy_pci1": {
+ "type": "boolean"
+ },
+ "include_security_policy_pci2": {
+ "type": "boolean"
+ },
+ "include_security_policy_penetration_testing": {
+ "type": "boolean"
+ },
+ "include_security_policy_soc2": {
+ "type": "boolean"
+ },
+ "include_security_policy_soc2_type2": {
+ "type": "boolean"
+ },
+ "include_security_policy_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_supercap": {
+ "description": "CSA 3.0 renamed `include_increased_cap_amount` to `include_supercap`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_increased_cap_amount`. Sending the other spelling returns a 422.",
+ "type": "boolean"
+ },
+ "include_uncapped_claims": {
+ "description": "CSA 3.0 renamed `include_unlimited_claims` to `include_uncapped_claims`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims`. Sending the other spelling returns a 422.",
+ "type": "boolean"
+ },
+ "include_uncapped_claims_breach_of_confidentiality": {
+ "description": "CSA 3.0 renamed `include_unlimited_claims_breach_of_confidentiality` to `include_uncapped_claims_breach_of_confidentiality`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_breach_of_confidentiality`. Sending the other spelling returns a 422.",
+ "type": "boolean"
+ },
+ "include_uncapped_claims_breach_of_confidentiality_negligence": {
+ "description": "CSA 3.0 renamed `include_unlimited_claims_breach_of_confidentiality_negligence` to `include_uncapped_claims_breach_of_confidentiality_negligence`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_breach_of_confidentiality_negligence`. Sending the other spelling returns a 422.",
+ "type": "boolean"
+ },
+ "include_uncapped_claims_breach_of_privsec": {
+ "description": "CSA 3.0 renamed `include_unlimited_claims_breach_of_privsec` to `include_uncapped_claims_breach_of_privsec`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_breach_of_privsec`. Sending the other spelling returns a 422.",
+ "type": "boolean"
+ },
+ "include_uncapped_claims_breach_of_privsec_negligence": {
+ "description": "CSA 3.0 renamed `include_unlimited_claims_breach_of_privsec_negligence` to `include_uncapped_claims_breach_of_privsec_negligence`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_breach_of_privsec_negligence`. Sending the other spelling returns a 422.",
+ "type": "boolean"
+ },
+ "include_uncapped_claims_include_other": {
+ "description": "CSA 3.0 renamed `include_unlimited_claims_include_other` to `include_uncapped_claims_include_other`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_include_other`. Sending the other spelling returns a 422.",
+ "type": "boolean"
+ },
+ "include_uncapped_claims_indemnification_obligation": {
+ "description": "CSA 3.0 renamed `include_unlimited_claims_indemnification_obligation` to `include_uncapped_claims_indemnification_obligation`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_indemnification_obligation`. Sending the other spelling returns a 422.",
+ "type": "boolean"
+ },
+ "include_uncapped_claims_other": {
+ "description": "CSA 3.0 renamed `include_unlimited_claims_other` to `include_uncapped_claims_other`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_other`. Sending the other spelling returns a 422.",
+ "type": "boolean"
+ },
+ "include_unlimited_claims": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_confidentiality": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_confidentiality_negligence": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_privsec": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_privsec_negligence": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_include_other": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_indemnification_obligation": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_other": {
+ "type": "string"
+ },
+ "increased_cap_amount_currency": {
+ "type": "number"
+ },
+ "increased_cap_amount_period_currency": {
+ "type": "number"
+ },
+ "increased_cap_amount_period_qty": {
+ "type": "number"
+ },
+ "increased_cap_amount_qty": {
+ "type": "number"
+ },
+ "increased_cap_amount_type": {
+ "enum": [
+ "qty",
+ "currency",
+ "period"
+ ],
+ "type": "string"
+ },
+ "provider": {
+ "type": "string"
+ },
+ "supercap_currency": {
+ "description": "CSA 3.0 renamed `increased_cap_amount_currency` to `supercap_currency`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `increased_cap_amount_currency`. Sending the other spelling returns a 422.",
+ "type": "number"
+ },
+ "supercap_period_currency": {
+ "description": "CSA 3.0 renamed `increased_cap_amount_period_currency` to `supercap_period_currency`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `increased_cap_amount_period_currency`. Sending the other spelling returns a 422.",
+ "type": "number"
+ },
+ "supercap_period_qty": {
+ "description": "CSA 3.0 renamed `increased_cap_amount_period_qty` to `supercap_period_qty`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `increased_cap_amount_period_qty`. Sending the other spelling returns a 422.",
+ "type": "number"
+ },
+ "supercap_qty": {
+ "description": "CSA 3.0 renamed `increased_cap_amount_qty` to `supercap_qty`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `increased_cap_amount_qty`. Sending the other spelling returns a 422.",
+ "type": "number"
+ },
+ "supercap_type": {
+ "description": "CSA 3.0 renamed `increased_cap_amount_type` to `supercap_type`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `increased_cap_amount_type`. Sending the other spelling returns a 422.",
+ "type": "number"
+ }
+ },
+ "type": "object"
+ },
+ "csa_order_form_attributes": {
+ "additionalProperties": false,
+ "description": "Override csa order form terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "additional_changes": {
+ "type": "string"
+ },
+ "additional_parameters_or_limitations": {
+ "type": "string"
+ },
+ "affiliates_as_users": {
+ "type": "boolean"
+ },
+ "cloud_service_description": {
+ "type": "string"
+ },
+ "consumption_units": {
+ "type": "string"
+ },
+ "fee_amount": {
+ "type": "number"
+ },
+ "fee_custom_unit": {
+ "type": "string"
+ },
+ "fee_period": {
+ "enum": [
+ "Subscription Period",
+ "month",
+ "year",
+ "User",
+ "Custom unit"
+ ],
+ "type": "string"
+ },
+ "fees_attributes": {
+ "additionalProperties": {
+ "anyOf": [
+ {
+ "additionalProperties": false,
+ "description": "Fees::Flat (fee_type \"flat\"). A fixed recurring fee, e.g. a platform subscription. Set type to \"Fees::Flat\" or fee_type to \"flat\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Fixed amount in the order form's fees_currency, charged per fee_period. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"flat\". Alternative to type.",
+ "enum": [
+ "flat"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Flat\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Flat"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Discount (fee_type \"discount\"). A discount, as a fixed amount or a percentage, applied forever, once, or for a number of months. Set type to \"Fees::Discount\" or fee_type to \"discount\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Discount size: an amount in fees_currency when discount_type is fixed_amount (a plain amount, not cents: 20 means 20.00), or a percentage (e.g. 10 for 10%) when it is percentage.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "discount_duration_amount": {
+ "description": "Number of months the discount applies. Required when discount_duration_type is multiple_months.",
+ "type": "number"
+ },
+ "discount_duration_type": {
+ "description": "How long the discount applies. multiple_months also needs discount_duration_amount.",
+ "enum": [
+ "forever",
+ "once",
+ "multiple_months"
+ ],
+ "type": "string"
+ },
+ "discount_type": {
+ "description": "Whether cost is a currency amount or a percentage.",
+ "enum": [
+ "fixed_amount",
+ "percentage"
+ ],
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"discount\". Alternative to type.",
+ "enum": [
+ "discount"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Discount\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Discount"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Cost (fee_type \"cost\"). A per-unit fee: price per unit times quantity, e.g. seats. Set type to \"Fees::Cost\" or fee_type to \"cost\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Price per unit in fees_currency. The row total is quantity x cost. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"cost\". Alternative to type.",
+ "enum": [
+ "cost"
+ ],
+ "type": "string"
+ },
+ "quantity": {
+ "description": "Number of units.",
+ "type": "number"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Cost\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Cost"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Attachment (fee_type \"attachment\"). A fee described in an uploaded attachment instead of in the table. Set type to \"Fees::Attachment\" or fee_type to \"attachment\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "attachment_id": {
+ "description": "ID of an attachment uploaded with upload-attachment.",
+ "type": "string"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"attachment\". Alternative to type.",
+ "enum": [
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Attachment\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Attachment"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Graduated (fee_type \"graduated\"). Tiered pricing, with the price set per tier in graduated_fee_tiers_attributes. Set type to \"Fees::Graduated\" or fee_type to \"graduated\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"graduated\". Alternative to type.",
+ "enum": [
+ "graduated"
+ ],
+ "type": "string"
+ },
+ "graduated_fee_tiers_attributes": {
+ "additionalProperties": {
+ "additionalProperties": false,
+ "properties": {
+ "flat_price": {
+ "type": "number"
+ },
+ "price_per_unit": {
+ "type": "string"
+ },
+ "upper_limit": {
+ "type": "number"
+ }
+ },
+ "type": "object"
+ },
+ "description": "Graduated fee tiers. Use string keys such as \"0\", \"1\".",
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Graduated\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Graduated"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Included (fee_type \"included\"). An item included at no charge. Set type to \"Fees::Included\" or fee_type to \"included\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"included\". Alternative to type.",
+ "enum": [
+ "included"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Included\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Included"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Metered (fee_type \"metered\"). Usage-based pricing, billed per unit used. Set type to \"Fees::Metered\" or fee_type to \"metered\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Price per unit of usage in fees_currency. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"metered\". Alternative to type.",
+ "enum": [
+ "metered"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Metered\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Metered"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::OneTime (fee_type \"one_time\"). A one-time charge, such as a setup fee. Set type to \"Fees::OneTime\" or fee_type to \"one_time\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "One-time amount in fees_currency, charged once rather than per fee_period. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"one_time\". Alternative to type.",
+ "enum": [
+ "one_time"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::OneTime\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::OneTime"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Text (fee_type \"text\"). A fee term described in free text. Set type to \"Fees::Text\" or fee_type to \"text\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"text\". Alternative to type.",
+ "enum": [
+ "text"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Text\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Text"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ }
+ ]
+ },
+ "description": "Fee table rows, keyed by string index (\"0\", \"1\", ...). Replaces the template's fees when provided. Each row sets type or fee_type to pick the fee class. Amounts are in the order form's fees_currency and, for recurring fees, are charged per fee_period.",
+ "examples": [
+ {
+ "0": {
+ "cost": 2000,
+ "description": "Platform subscription",
+ "type": "Fees::Flat"
+ }
+ },
+ {
+ "0": {
+ "cost": 50,
+ "description": "Seats",
+ "fee_type": "cost",
+ "quantity": 10
+ },
+ "1": {
+ "cost": 10,
+ "description": "Launch discount",
+ "discount_duration_amount": 3,
+ "discount_duration_type": "multiple_months",
+ "discount_type": "percentage",
+ "fee_type": "discount"
+ }
+ }
+ ],
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+ },
+ "fees_currency": {
+ "enum": [
+ "USD",
+ "EUR",
+ "GBP",
+ "CAD",
+ "AUD",
+ "SGD",
+ "ILS",
+ "JPY",
+ "CHF",
+ "HKD"
+ ],
+ "type": "string"
+ },
+ "fees_include_fee_increase_upon_renewal": {
+ "type": "boolean"
+ },
+ "fees_include_fee_increase_upon_renewal_fee": {
+ "type": "number"
+ },
+ "fees_include_fee_increase_upon_renewal_type": {
+ "enum": [
+ "will",
+ "may"
+ ],
+ "type": "string"
+ },
+ "fees_inclusive_of_taxes": {
+ "type": "boolean"
+ },
+ "framework_terms_type": {
+ "enum": [
+ "new",
+ "existing",
+ "description"
+ ],
+ "type": "string"
+ },
+ "free_trial_days": {
+ "type": "number"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_additional_changes": {
+ "type": "boolean"
+ },
+ "include_additional_parameters_or_limitations": {
+ "type": "boolean"
+ },
+ "include_consumption": {
+ "type": "boolean"
+ },
+ "include_fees": {
+ "type": "boolean"
+ },
+ "include_fees_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_fees_include_attachment": {
+ "type": "boolean"
+ },
+ "include_fees_other": {
+ "type": "boolean"
+ },
+ "include_fees_other_val": {
+ "type": "string"
+ },
+ "include_fees_table": {
+ "type": "boolean"
+ },
+ "include_fees_table_period": {
+ "enum": [
+ "Subscription Period",
+ "month",
+ "year",
+ "User"
+ ],
+ "type": "string"
+ },
+ "include_free_trial": {
+ "type": "boolean"
+ },
+ "include_max_users": {
+ "type": "boolean"
+ },
+ "include_pilot_period": {
+ "type": "boolean"
+ },
+ "include_pilot_period_duration_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_pilot_period_duration_type": {
+ "enum": [
+ "day",
+ "week",
+ "month"
+ ],
+ "type": "string"
+ },
+ "include_pilot_period_include_fees": {
+ "type": "boolean"
+ },
+ "include_pilot_period_include_fees_amount": {
+ "type": "number"
+ },
+ "include_pilot_period_include_modifications": {
+ "type": "boolean"
+ },
+ "include_pilot_period_include_modifications_description": {
+ "type": "string"
+ },
+ "include_product_support": {
+ "type": "boolean"
+ },
+ "include_product_support_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_product_support_description": {
+ "type": "string"
+ },
+ "include_product_support_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_professional_services": {
+ "type": "boolean"
+ },
+ "include_professional_services_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_professional_services_custom_name": {
+ "type": "string"
+ },
+ "include_professional_services_description": {
+ "type": "string"
+ },
+ "include_professional_services_end_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "include_professional_services_fees_description": {
+ "type": "string"
+ },
+ "include_professional_services_include_end_date": {
+ "type": "boolean"
+ },
+ "include_professional_services_include_fees_description": {
+ "type": "boolean"
+ },
+ "include_professional_services_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_sla": {
+ "type": "boolean"
+ },
+ "include_sla_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_sla_description": {
+ "type": "string"
+ },
+ "include_sla_include_response_time": {
+ "type": "boolean"
+ },
+ "include_sla_include_response_time_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_sla_include_response_time_credit": {
+ "type": "number"
+ },
+ "include_sla_include_response_time_duration": {
+ "enum": [
+ "hour",
+ "day",
+ "week",
+ "month",
+ "hours"
+ ],
+ "type": "string"
+ },
+ "include_sla_include_response_time_support_channel": {
+ "type": "string"
+ },
+ "include_sla_include_target_uptime": {
+ "type": "boolean"
+ },
+ "include_sla_maintenance_notice": {
+ "type": "boolean"
+ },
+ "include_sla_maintenance_window": {
+ "type": "boolean"
+ },
+ "include_sla_maintenance_window_type": {
+ "enum": [
+ "standard",
+ "none"
+ ],
+ "type": "string"
+ },
+ "include_sla_standard_maintenance_notice_qty": {
+ "type": "number"
+ },
+ "include_sla_standard_maintenance_notice_unit": {
+ "enum": [
+ "hour",
+ "day",
+ "week",
+ "month"
+ ],
+ "type": "string"
+ },
+ "include_sla_standard_maintenance_window_end_time": {
+ "type": "string"
+ },
+ "include_sla_standard_maintenance_window_friday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_monday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_saturday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_start_time": {
+ "type": "string"
+ },
+ "include_sla_standard_maintenance_window_sunday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_thursday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_time_zone": {
+ "type": "string"
+ },
+ "include_sla_standard_maintenance_window_tuesday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_wednesday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_target_uptime": {
+ "type": "number"
+ },
+ "include_sla_type": {
+ "enum": [
+ "description",
+ "standard",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_subscription_start_date": {
+ "type": "boolean"
+ },
+ "include_subscription_start_date_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "include_usage_review": {
+ "type": "boolean"
+ },
+ "include_usage_review_val": {
+ "type": "string"
+ },
+ "include_use_limitations": {
+ "type": "boolean"
+ },
+ "include_use_limitations_val": {
+ "type": "string"
+ },
+ "invoice_period": {
+ "enum": [
+ "monthly",
+ "quarterly",
+ "semiannually",
+ "annually",
+ "Custom unit",
+ "Monthly",
+ "Quarterly",
+ "Semiannually",
+ "Annually"
+ ],
+ "type": "string"
+ },
+ "invoice_period_custom_unit": {
+ "type": "string"
+ },
+ "max_consumption": {
+ "type": "number"
+ },
+ "max_users": {
+ "type": "number"
+ },
+ "negotiations_allowed": {
+ "description": "When true, the recipient can propose changes to the order form, even when the agreement-level `negotiations_allowed` is false. This only covers the order form.",
+ "type": "boolean"
+ },
+ "order_date_date": {
+ "type": "string"
+ },
+ "order_date_other": {
+ "type": "string"
+ },
+ "order_date_type": {
+ "enum": [
+ "signature",
+ "date",
+ "other"
+ ],
+ "type": "string"
+ },
+ "payment_period": {
+ "type": "number"
+ },
+ "payment_period_timeframe": {
+ "enum": [
+ "Customer's receipt of invoice",
+ "date of invoice"
+ ],
+ "type": "string"
+ },
+ "payment_period_unit": {
+ "enum": [
+ "day(s)",
+ "week(s)",
+ "month(s)",
+ "marketplace_acceptance"
+ ],
+ "type": "string"
+ },
+ "payment_process_automatic_frequency": {
+ "enum": [
+ "monthly",
+ "quarterly",
+ "semiannually",
+ "annually"
+ ],
+ "type": "string"
+ },
+ "payment_process_type": {
+ "enum": [
+ "automatic",
+ "invoice",
+ "custom",
+ "marketplace_acceptance"
+ ],
+ "type": "string"
+ },
+ "payment_process_type_custom_val": {
+ "type": "string"
+ },
+ "payment_process_type_invoice_amount": {
+ "type": "number"
+ },
+ "payment_process_type_invoice_custom_unit": {
+ "type": "string"
+ },
+ "payment_process_type_invoice_duration": {
+ "enum": [
+ "day",
+ "week",
+ "month",
+ "year",
+ "day(s)",
+ "week(s)",
+ "month(s)",
+ "year(s)"
+ ],
+ "type": "string"
+ },
+ "payment_process_type_invoice_duration_start": {
+ "enum": [
+ "Customer's receipt of invoice",
+ "date of invoice"
+ ],
+ "type": "string"
+ },
+ "payment_process_type_invoice_type": {
+ "enum": [
+ "monthly",
+ "quarterly",
+ "semiannually",
+ "annually",
+ "Custom unit"
+ ],
+ "type": "string"
+ },
+ "pilot_period_stripe_product_id": {
+ "type": "string"
+ },
+ "service_credits_attributes": {
+ "additionalProperties": {
+ "additionalProperties": false,
+ "properties": {
+ "credit": {
+ "type": "number"
+ },
+ "max": {
+ "type": "number"
+ },
+ "min": {
+ "type": "number"
+ }
+ },
+ "type": "object"
+ },
+ "description": "Service credits. Use string keys such as \"0\", \"1\".",
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+ },
+ "subscription_auto_renew": {
+ "enum": [
+ "days",
+ "subscription_end"
+ ],
+ "type": "string"
+ },
+ "subscription_period": {
+ "type": "number"
+ },
+ "subscription_period_unit": {
+ "type": "string"
+ },
+ "subscription_renewal_notice_days": {
+ "type": "number"
+ },
+ "subscription_start_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "subscription_start_date_type": {
+ "enum": [
+ "effective_date",
+ "date"
+ ],
+ "type": "string"
+ },
+ "underlying_agreement_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "use_limitations_attributes": {
+ "additionalProperties": {
+ "additionalProperties": false,
+ "properties": {
+ "amount": {
+ "type": "number"
+ },
+ "limitation_type": {
+ "type": "string"
+ },
+ "unit": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "description": "Use limitations. Use string keys such as \"0\", \"1\".",
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+ }
+ },
+ "type": "object"
+ },
+ "custom_field_values": {
+ "description": "Values for a custom template's fields, keyed by the field keys defined in the template's YAML definition. Only used when template_id is a custom template. Template defaults fill any fields you omit; a required field with no default and no submitted value returns a 400 naming the field. Values are validated against the field's input type: select and radio values must be one of the field's options, multiselect values are an array of selections each of which must be one of the field's options, number and currency values must be numeric, date values must be YYYY-MM-DD, and email values must be valid addresses. An invalid value returns a 400 naming the field."
+ },
+ "design_partner_attributes": {
+ "additionalProperties": false,
+ "description": "Override design partner terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "customer_description": {
+ "type": "string"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_fees": {
+ "type": "boolean"
+ },
+ "include_fees_amount": {
+ "type": "number"
+ },
+ "include_fees_description": {
+ "type": "string"
+ },
+ "include_fees_pay_by_amount": {
+ "type": "string"
+ },
+ "include_fees_type": {
+ "enum": [
+ "default_language",
+ "description"
+ ],
+ "type": "string"
+ },
+ "include_fees_unit": {
+ "enum": [
+ "month",
+ "quarter",
+ "year",
+ "Term"
+ ],
+ "type": "string"
+ },
+ "include_program_appear_as_customer_private": {
+ "type": "boolean"
+ },
+ "include_program_appear_as_customer_public": {
+ "type": "boolean"
+ },
+ "include_program_case_study": {
+ "type": "boolean"
+ },
+ "include_program_develop_functionality": {
+ "type": "boolean"
+ },
+ "include_program_develop_functionality_val": {
+ "type": "string"
+ },
+ "include_program_discount": {
+ "type": "boolean"
+ },
+ "include_program_discount_amount": {
+ "type": "number"
+ },
+ "include_program_discount_unit": {
+ "enum": [
+ "U.S. Dollars",
+ "percent"
+ ],
+ "type": "string"
+ },
+ "include_program_participation_feedback": {
+ "type": "boolean"
+ },
+ "include_program_participation_feedback_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_program_participation_feedback_unit": {
+ "enum": [
+ "month",
+ "quarter",
+ "year",
+ "Term"
+ ],
+ "type": "string"
+ },
+ "include_program_partner_other": {
+ "type": "boolean"
+ },
+ "include_program_partner_other_val": {
+ "type": "string"
+ },
+ "include_program_provider_other": {
+ "type": "boolean"
+ },
+ "include_program_provider_other_val": {
+ "type": "string"
+ },
+ "include_program_reference": {
+ "type": "boolean"
+ },
+ "product_description": {
+ "type": "string"
+ },
+ "term_amount": {
+ "type": "number"
+ },
+ "term_unit": {
+ "enum": [
+ "day(s)",
+ "week(s)",
+ "month(s)",
+ "quarter(s)",
+ "year(s)"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "district_or_county": {
+ "description": "The district or county for dispute resolution.",
+ "type": "string"
+ },
+ "dpa_attributes": {
+ "additionalProperties": false,
+ "description": "Override dpa terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "approved_subprocessor_type": {
+ "description": "`internal` lists approved subprocessors in the agreement (`subprocessors_attributes`); `external` points to a list published elsewhere.",
+ "enum": [
+ "internal",
+ "external"
+ ],
+ "type": "string"
+ },
+ "cloud_service_product_name": {
+ "type": "string"
+ },
+ "competent_supervisory_authority": {
+ "type": "string"
+ },
+ "customer_description": {
+ "type": "string"
+ },
+ "data_exporter_address_city": {
+ "type": "string"
+ },
+ "data_exporter_address_country": {
+ "type": "string"
+ },
+ "data_exporter_address_state": {
+ "type": "string"
+ },
+ "data_exporter_address_street_address": {
+ "type": "string"
+ },
+ "data_exporter_address_zipcode": {
+ "type": "string"
+ },
+ "data_exporter_contact_details": {
+ "type": "string"
+ },
+ "data_exporter_contact_name": {
+ "type": "string"
+ },
+ "data_exporter_contact_position": {
+ "type": "string"
+ },
+ "data_exporter_role": {
+ "description": "Role of the data exporter. Overwritten to `Controller` when the agreement is created from a template.",
+ "enum": [
+ "Controller",
+ "Processor"
+ ],
+ "type": "string"
+ },
+ "data_importer_address": {
+ "type": "string"
+ },
+ "data_importer_address_city": {
+ "type": "string"
+ },
+ "data_importer_address_country": {
+ "type": "string"
+ },
+ "data_importer_address_state": {
+ "type": "string"
+ },
+ "data_importer_address_street_address": {
+ "type": "string"
+ },
+ "data_importer_address_zipcode": {
+ "type": "string"
+ },
+ "data_importer_contact_details": {
+ "type": "string"
+ },
+ "data_importer_contact_name": {
+ "type": "string"
+ },
+ "data_importer_contact_position": {
+ "type": "string"
+ },
+ "duration_of_processing": {
+ "type": "string"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_covered_claim": {
+ "type": "boolean"
+ },
+ "include_covered_claim_external_val": {
+ "type": "string"
+ },
+ "include_covered_claim_internal_val": {
+ "type": "string"
+ },
+ "include_covered_claim_type": {
+ "description": "Which covered-claim text applies: `internal` uses `include_covered_claim_internal_val`, `external` uses `include_covered_claim_external_val`. Required when `include_covered_claim` is true.",
+ "enum": [
+ "internal",
+ "external"
+ ],
+ "type": "string"
+ },
+ "include_data_subjects_custom": {
+ "type": "boolean"
+ },
+ "include_data_subjects_custom_val": {
+ "type": "string"
+ },
+ "include_data_subjects_employees": {
+ "type": "boolean"
+ },
+ "include_data_subjects_end_users": {
+ "type": "boolean"
+ },
+ "include_external_subprocessor_location": {
+ "type": "string"
+ },
+ "include_frequency_of_transfer_continuous": {
+ "type": "boolean"
+ },
+ "include_frequency_of_transfer_custom": {
+ "type": "boolean"
+ },
+ "include_frequency_of_transfer_custom_val": {
+ "type": "string"
+ },
+ "include_governing_country_eu": {
+ "type": "boolean"
+ },
+ "include_governing_country_eu_val": {
+ "type": "string"
+ },
+ "include_governing_country_uk": {
+ "type": "boolean"
+ },
+ "include_governing_country_uk_val": {
+ "type": "string"
+ },
+ "include_governing_law": {
+ "type": "boolean"
+ },
+ "include_governing_law_country": {
+ "type": "string"
+ },
+ "include_governing_law_state": {
+ "type": "string"
+ },
+ "include_increased_claim_amount": {
+ "description": "Legacy field. Stored but not shown on the DPA; use the `include_liability_cap*` fields instead.",
+ "type": "boolean"
+ },
+ "include_increased_claim_amount_currency": {
+ "description": "Legacy field. Stored but not shown on the DPA; use the `include_liability_cap*` fields instead."
+ },
+ "include_increased_claim_amount_qty": {
+ "description": "Legacy field. Stored but not shown on the DPA; use the `include_liability_cap*` fields instead."
+ },
+ "include_increased_claim_amount_type": {
+ "description": "Legacy field. Stored but not shown on the DPA; use the `include_liability_cap*` fields instead.",
+ "type": "string"
+ },
+ "include_liability_cap": {
+ "type": "boolean"
+ },
+ "include_liability_cap_amount_constant_external": {
+ "type": "string"
+ },
+ "include_liability_cap_amount_constant_internal": {
+ "type": "string"
+ },
+ "include_liability_cap_amount_currency_external": {
+ "description": "Currency amount. Numbers and numeric strings (commas allowed) are both accepted."
+ },
+ "include_liability_cap_amount_currency_internal": {
+ "description": "Currency amount. Numbers and numeric strings (commas allowed) are both accepted."
+ },
+ "include_liability_cap_csa_type": {
+ "description": "Which liability cap values apply: the `_internal` or `_external` amount fields. Required when `include_liability_cap` is true.",
+ "enum": [
+ "internal",
+ "external"
+ ],
+ "type": "string"
+ },
+ "include_personal_data_biographic_info": {
+ "type": "boolean"
+ },
+ "include_personal_data_contact_info": {
+ "type": "boolean"
+ },
+ "include_personal_data_custom": {
+ "type": "boolean"
+ },
+ "include_personal_data_custom_val": {
+ "type": "string"
+ },
+ "include_personal_data_employment_info": {
+ "type": "boolean"
+ },
+ "include_personal_data_financial_info": {
+ "type": "boolean"
+ },
+ "include_personal_data_location": {
+ "type": "boolean"
+ },
+ "include_personal_data_name": {
+ "type": "boolean"
+ },
+ "include_personal_data_transactional_info": {
+ "type": "boolean"
+ },
+ "include_personal_data_user_activity_info": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_custom": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_custom_val": {
+ "type": "string"
+ },
+ "include_processing_purpose_erasing": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_holding": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_protecting": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_receiving": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_returning": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_sharing": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_updating": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_using": {
+ "type": "boolean"
+ },
+ "include_provider_security_contact_address": {
+ "type": "boolean"
+ },
+ "include_provider_security_contact_address_city": {
+ "type": "string"
+ },
+ "include_provider_security_contact_address_country": {
+ "type": "string"
+ },
+ "include_provider_security_contact_address_state": {
+ "type": "string"
+ },
+ "include_provider_security_contact_address_street_address": {
+ "type": "string"
+ },
+ "include_provider_security_contact_address_zipcode": {
+ "type": "string"
+ },
+ "include_provider_security_contact_email": {
+ "type": "boolean"
+ },
+ "include_provider_security_contact_email_val": {
+ "format": "email",
+ "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "include_security_measures_accountability": {
+ "type": "boolean"
+ },
+ "include_security_measures_accountability_val": {
+ "type": "string"
+ },
+ "include_security_measures_certification_or_assurance": {
+ "type": "boolean"
+ },
+ "include_security_measures_certification_or_assurance_val": {
+ "type": "string"
+ },
+ "include_security_measures_confidentiality_integrity": {
+ "type": "boolean"
+ },
+ "include_security_measures_confidentiality_integrity_val": {
+ "type": "string"
+ },
+ "include_security_measures_data_at_rest": {
+ "type": "boolean"
+ },
+ "include_security_measures_data_at_rest_val": {
+ "type": "string"
+ },
+ "include_security_measures_data_minimization": {
+ "type": "boolean"
+ },
+ "include_security_measures_data_minimization_val": {
+ "type": "string"
+ },
+ "include_security_measures_data_quality": {
+ "type": "boolean"
+ },
+ "include_security_measures_data_quality_val": {
+ "type": "string"
+ },
+ "include_security_measures_data_retention": {
+ "type": "boolean"
+ },
+ "include_security_measures_data_retention_val": {
+ "type": "string"
+ },
+ "include_security_measures_data_transmission": {
+ "type": "boolean"
+ },
+ "include_security_measures_data_transmission_val": {
+ "type": "string"
+ },
+ "include_security_measures_event_logging": {
+ "type": "boolean"
+ },
+ "include_security_measures_event_logging_val": {
+ "type": "string"
+ },
+ "include_security_measures_identity_auth": {
+ "type": "boolean"
+ },
+ "include_security_measures_identity_auth_val": {
+ "type": "string"
+ },
+ "include_security_measures_it_security_governance": {
+ "type": "boolean"
+ },
+ "include_security_measures_it_security_governance_val": {
+ "type": "string"
+ },
+ "include_security_measures_physical_security": {
+ "type": "boolean"
+ },
+ "include_security_measures_physical_security_val": {
+ "type": "string"
+ },
+ "include_security_measures_portability_and_erasure": {
+ "type": "boolean"
+ },
+ "include_security_measures_portability_and_erasure_val": {
+ "type": "string"
+ },
+ "include_security_measures_pseudonym_encryption": {
+ "type": "boolean"
+ },
+ "include_security_measures_pseudonym_encryption_val": {
+ "type": "string"
+ },
+ "include_security_measures_restore_data_access": {
+ "type": "boolean"
+ },
+ "include_security_measures_restore_data_access_val": {
+ "type": "string"
+ },
+ "include_security_measures_security_policy": {
+ "type": "boolean"
+ },
+ "include_security_measures_system_configuration": {
+ "type": "boolean"
+ },
+ "include_security_measures_system_configuration_val": {
+ "type": "string"
+ },
+ "include_security_measures_testing_assessment": {
+ "type": "boolean"
+ },
+ "include_security_measures_testing_assessment_val": {
+ "type": "string"
+ },
+ "include_security_policy": {
+ "type": "boolean"
+ },
+ "include_security_policy_fedramp_auth": {
+ "type": "boolean"
+ },
+ "include_security_policy_hipaa": {
+ "type": "boolean"
+ },
+ "include_security_policy_hitrust": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_other": {
+ "type": "boolean"
+ },
+ "include_security_policy_iso27001": {
+ "type": "boolean"
+ },
+ "include_security_policy_other": {
+ "type": "string"
+ },
+ "include_security_policy_pci1": {
+ "type": "boolean"
+ },
+ "include_security_policy_pci2": {
+ "type": "boolean"
+ },
+ "include_security_policy_penetration_testing": {
+ "type": "boolean"
+ },
+ "include_security_policy_soc2": {
+ "type": "boolean"
+ },
+ "include_security_policy_soc2_type2": {
+ "type": "boolean"
+ },
+ "include_sensitive_data_restrictions_custom": {
+ "type": "boolean"
+ },
+ "include_sensitive_data_restrictions_custom_val": {
+ "type": "string"
+ },
+ "include_sensitive_data_restrictions_security_policy": {
+ "type": "boolean"
+ },
+ "include_service_provider_relationship": {
+ "type": "boolean"
+ },
+ "include_special_category_data": {
+ "type": "boolean"
+ },
+ "provider": {
+ "type": "string"
+ },
+ "security_policy_available_at": {
+ "type": "string"
+ },
+ "security_policy_type": {
+ "description": "Where the Security Policy is defined. For `external`, set `security_policy_available_at`.",
+ "enum": [
+ "defined in agreement",
+ "provider service",
+ "external"
+ ],
+ "type": "string"
+ },
+ "subprocessors_attributes": {
+ "additionalProperties": {
+ "additionalProperties": false,
+ "properties": {
+ "_destroy": {
+ "description": "Set to true with `id` to remove that subprocessor.",
+ "type": "boolean"
+ },
+ "country": {
+ "type": "string"
+ },
+ "id": {
+ "description": "ID of an existing subprocessor to update or remove. Omit to add a new subprocessor.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "processing_task": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "description": "Subprocessors, keyed by string index such as \"0\", \"1\". On create these are added to the template's subprocessors. On a draft update, an entry without `id` adds a new subprocessor; pass `id` to change one and `id` with `_destroy: true` to remove one.",
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+ },
+ "underlying_agreement_id": {
+ "description": "ID of the CSA this DPA supplements when `underlying_agreement_type` is `internal`.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "underlying_agreement_type": {
+ "description": "`internal` links a CSA in Common Paper (`underlying_agreement_id`); `external` describes another agreement in `underlying_agreement_val` (required). Omit for none.",
+ "enum": [
+ "internal",
+ "external"
+ ],
+ "type": "string"
+ },
+ "underlying_agreement_val": {
+ "description": "Description of the agreement this DPA supplements. Required when `underlying_agreement_type` is `external`.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "framework_terms_description": {
+ "description": "Custom framework terms description. Only used when framework_terms_type is \"description\".",
+ "type": "string"
+ },
+ "framework_terms_type": {
+ "description": "How framework terms are specified. Use \"new\" for standard terms or \"description\" to provide a custom framework_terms_description.",
+ "enum": [
+ "new",
+ "description"
+ ],
+ "type": "string"
+ },
+ "governing_law_country": {
+ "description": "The country whose laws govern the agreement.",
+ "type": "string"
+ },
+ "governing_law_region": {
+ "description": "The state or region whose laws govern the agreement.",
+ "type": "string"
+ },
+ "include_automated_payment_reminders": {
+ "description": "When true, automatically sends payment reminder emails.",
+ "type": "boolean"
+ },
+ "include_billing_info": {
+ "description": "When true, billing contact information (billing_name, billing_email) is included.",
+ "type": "boolean"
+ },
+ "include_billing_workflow": {
+ "description": "When true, enables a billing workflow after signing.",
+ "type": "boolean"
+ },
+ "include_expiration_date": {
+ "description": "Expiration date in YYYY-MM-DD format. Use when include_expiration_type is \"date\".",
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "include_expiration_days": {
+ "description": "Number of days until the agreement expires. Use when include_expiration_type is \"days\".",
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_expiration_type": {
+ "description": "How to set expiration: \"none\" (default), \"days\" (use include_expiration_days), or \"date\" (use include_expiration_date).",
+ "enum": [
+ "none",
+ "days",
+ "date"
+ ],
+ "type": "string"
+ },
+ "include_terms": {
+ "description": "When true, the standard terms are included with the agreement.",
+ "type": "boolean"
+ },
+ "loi_attributes": {
+ "additionalProperties": false,
+ "description": "Override loi terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "confidentiality_custom": {
+ "type": "string"
+ },
+ "confidentiality_mutual_include_loi": {
+ "type": "boolean"
+ },
+ "confidentiality_nda_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "confidentiality_nda_description": {
+ "type": "string"
+ },
+ "confidentiality_nda_include_loi": {
+ "type": "boolean"
+ },
+ "confidentiality_nda_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "confidentiality_type": {
+ "enum": [
+ "mutual",
+ "nda",
+ "provider",
+ "custom"
+ ],
+ "type": "string"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_custom_details": {
+ "type": "boolean"
+ },
+ "include_custom_details_val": {
+ "type": "string"
+ },
+ "include_fees": {
+ "type": "boolean"
+ },
+ "include_fees_amount": {
+ "type": "number"
+ },
+ "include_fees_amount_duration": {
+ "enum": [
+ "month",
+ "year",
+ "quarter"
+ ],
+ "type": "string"
+ },
+ "include_fees_include_amount": {
+ "type": "boolean"
+ },
+ "include_fees_include_other": {
+ "type": "boolean"
+ },
+ "include_fees_other": {
+ "type": "string"
+ },
+ "include_functionality": {
+ "type": "boolean"
+ },
+ "include_functionality_val": {
+ "type": "string"
+ },
+ "include_launch_date": {
+ "type": "boolean"
+ },
+ "include_launch_date_custom": {
+ "type": "string"
+ },
+ "include_launch_date_date": {
+ "format": "date-time",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$",
+ "type": "string"
+ },
+ "include_launch_date_type": {
+ "enum": [
+ "date",
+ "custom"
+ ],
+ "type": "string"
+ },
+ "product_name": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "manual_send": {
+ "description": "When true, the agreement is marked as manually sent outside the platform.",
+ "type": "boolean"
+ },
+ "message": {
+ "type": "string"
+ },
+ "negotiations_allowed": {
+ "description": "When true, the recipient can propose changes to the legal terms. For agreement types without separate business terms, that covers every term. CSA order forms, PSA statements of work, partnership business terms and software license order forms have their own `negotiations_allowed` flag.",
+ "type": "boolean"
+ },
+ "partnership_attributes": {
+ "additionalProperties": false,
+ "description": "Override partnership terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "effective_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "effective_date_type": {
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "type": "string"
+ },
+ "general_cap_amount_currency_val": {
+ "type": "number"
+ },
+ "general_cap_amount_either_currency": {
+ "type": "number"
+ },
+ "general_cap_amount_either_multiple": {
+ "type": "number"
+ },
+ "general_cap_amount_multiple_val": {
+ "type": "number"
+ },
+ "general_cap_amount_type": {
+ "enum": [
+ "multiple",
+ "currency",
+ "either",
+ "base"
+ ],
+ "type": "string"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_additional_warranties": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_include_company": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_include_company_val": {
+ "type": "string"
+ },
+ "include_additional_warranties_include_partner": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_include_partner_val": {
+ "type": "string"
+ },
+ "include_brand_guidelines": {
+ "type": "boolean"
+ },
+ "include_brand_guidelines_include_company": {
+ "type": "boolean"
+ },
+ "include_brand_guidelines_include_company_val": {
+ "type": "string"
+ },
+ "include_brand_guidelines_include_partner": {
+ "type": "boolean"
+ },
+ "include_brand_guidelines_include_partner_val": {
+ "type": "string"
+ },
+ "include_covered_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_company_claims": {
+ "type": "string"
+ },
+ "include_covered_claims_include_company_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_include_partner_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_partner_claims": {
+ "type": "string"
+ },
+ "include_dpa": {
+ "type": "boolean"
+ },
+ "include_dpa_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_dpa_location": {
+ "type": "string"
+ },
+ "include_dpa_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_increased_cap_amount": {
+ "type": "boolean"
+ },
+ "include_increased_cap_amount_currency": {
+ "type": "number"
+ },
+ "include_increased_cap_amount_either_currency": {
+ "type": "number"
+ },
+ "include_increased_cap_amount_either_multiple": {
+ "type": "string"
+ },
+ "include_increased_cap_amount_multiple": {
+ "type": "string"
+ },
+ "include_increased_cap_amount_type": {
+ "enum": [
+ "multiple",
+ "currency",
+ "either"
+ ],
+ "type": "string"
+ },
+ "include_increased_claims": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_confidentiality": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_confidentiality_misconduct": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_covered_claims": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_misconduct": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_other": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_other_val": {
+ "type": "string"
+ },
+ "include_unlimited_claims": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_confidentiality": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_confidentiality_misconduct": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_covered_claims": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_misconduct": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_other": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_other_val": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "partnership_business_terms_attributes": {
+ "additionalProperties": false,
+ "description": "Override partnership business terms terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "end_date_after_effective_date_amount": {
+ "type": "number"
+ },
+ "end_date_after_effective_date_unit": {
+ "enum": [
+ "month(s)",
+ "quarter(s)",
+ "year(s)"
+ ],
+ "type": "string"
+ },
+ "end_date_date": {
+ "type": "string"
+ },
+ "end_date_type": {
+ "enum": [
+ "date",
+ "effective date"
+ ],
+ "type": "string"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_obligations_company_brand": {
+ "type": "boolean"
+ },
+ "include_obligations_company_promotion": {
+ "type": "boolean"
+ },
+ "include_obligations_company_promotion_include_activities": {
+ "type": "boolean"
+ },
+ "include_obligations_company_promotion_include_activities_val": {
+ "type": "string"
+ },
+ "include_obligations_company_promotion_include_materials": {
+ "type": "boolean"
+ },
+ "include_obligations_company_promotion_include_materials_val": {
+ "type": "string"
+ },
+ "include_obligations_company_referral": {
+ "type": "boolean"
+ },
+ "include_obligations_company_referral_include_criteria": {
+ "type": "boolean"
+ },
+ "include_obligations_company_referral_include_criteria_val": {
+ "type": "string"
+ },
+ "include_obligations_company_referral_include_pay_sch": {
+ "type": "boolean"
+ },
+ "include_obligations_company_referral_include_pay_sch_amount": {
+ "type": "number"
+ },
+ "include_obligations_company_referral_include_pay_sch_custom": {
+ "type": "string"
+ },
+ "include_obligations_company_referral_include_pay_sch_unit": {
+ "enum": [
+ "U.S. Dollars",
+ "percent"
+ ],
+ "type": "string"
+ },
+ "include_obligations_company_sponsorship": {
+ "type": "boolean"
+ },
+ "include_obligations_company_sponsorship_include_benefits": {
+ "type": "boolean"
+ },
+ "include_obligations_company_sponsorship_include_benefits_val": {
+ "type": "string"
+ },
+ "include_obligations_company_sponsorship_include_payments": {
+ "type": "boolean"
+ },
+ "include_obligations_company_sponsorship_include_payments_amount": {
+ "type": "number"
+ },
+ "include_obligations_company_sponsorship_include_payments_unit": {
+ "enum": [
+ "U.S. Dollars",
+ "percent"
+ ],
+ "type": "string"
+ },
+ "include_obligations_partner_brand": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_promotion": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_promotion_include_activities": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_promotion_include_activities_val": {
+ "type": "string"
+ },
+ "include_obligations_partner_promotion_include_materials": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_promotion_include_materials_val": {
+ "type": "string"
+ },
+ "include_obligations_partner_referral": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_referral_include_criteria": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_referral_include_criteria_val": {
+ "type": "string"
+ },
+ "include_obligations_partner_referral_include_pay_sch": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_referral_include_pay_sch_amount": {
+ "type": "number"
+ },
+ "include_obligations_partner_referral_include_pay_sch_custom": {
+ "type": "string"
+ },
+ "include_obligations_partner_referral_include_pay_sch_unit": {
+ "enum": [
+ "U.S. Dollars",
+ "percent"
+ ],
+ "type": "string"
+ },
+ "include_obligations_partner_sponsorship": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_sponsorship_include_benefits": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_sponsorship_include_benefits_val": {
+ "type": "string"
+ },
+ "include_obligations_partner_sponsorship_include_payments": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_sponsorship_include_payments_amount": {
+ "type": "number"
+ },
+ "include_obligations_partner_sponsorship_include_payments_unit": {
+ "enum": [
+ "U.S. Dollars",
+ "percent"
+ ],
+ "type": "string"
+ },
+ "include_payment_process": {
+ "type": "boolean"
+ },
+ "include_payment_process_company": {
+ "type": "boolean"
+ },
+ "include_payment_process_company_include_address": {
+ "type": "boolean"
+ },
+ "include_payment_process_company_include_address_city": {
+ "type": "string"
+ },
+ "include_payment_process_company_include_address_country": {
+ "type": "string"
+ },
+ "include_payment_process_company_include_address_state": {
+ "type": "string"
+ },
+ "include_payment_process_company_include_address_street_address": {
+ "type": "string"
+ },
+ "include_payment_process_company_include_address_zipcode": {
+ "type": "string"
+ },
+ "include_payment_process_company_include_email": {
+ "type": "boolean"
+ },
+ "include_payment_process_company_include_email_val": {
+ "type": "string"
+ },
+ "include_payment_process_partner": {
+ "type": "boolean"
+ },
+ "include_payment_process_partner_include_address": {
+ "type": "boolean"
+ },
+ "include_payment_process_partner_include_address_city": {
+ "type": "string"
+ },
+ "include_payment_process_partner_include_address_country": {
+ "type": "string"
+ },
+ "include_payment_process_partner_include_address_state": {
+ "type": "string"
+ },
+ "include_payment_process_partner_include_address_street_address": {
+ "type": "string"
+ },
+ "include_payment_process_partner_include_address_zipcode": {
+ "type": "string"
+ },
+ "include_payment_process_partner_include_email": {
+ "type": "boolean"
+ },
+ "include_payment_process_partner_include_email_val": {
+ "type": "string"
+ },
+ "include_payment_schedule": {
+ "type": "boolean"
+ },
+ "include_payment_schedule_custom": {
+ "type": "string"
+ },
+ "include_payment_schedule_specified_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_payment_schedule_specified_timeframe": {
+ "enum": [
+ "receipt",
+ "date"
+ ],
+ "type": "string"
+ },
+ "include_payment_schedule_specified_unit": {
+ "enum": [
+ "day(s)",
+ "week(s)",
+ "month(s)",
+ "quarter(s)",
+ "year(s)"
+ ],
+ "type": "string"
+ },
+ "include_payment_schedule_type": {
+ "enum": [
+ "specified",
+ "custom"
+ ],
+ "type": "string"
+ },
+ "negotiations_allowed": {
+ "description": "When true, the recipient can propose changes to the business terms, even when the agreement-level `negotiations_allowed` is false. This only covers the business terms.",
+ "type": "boolean"
+ },
+ "territory_type": {
+ "enum": [
+ "worldwide",
+ "custom"
+ ],
+ "type": "string"
+ },
+ "territory_type_val": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "payment_link_url": {
+ "description": "A payment URL shown to the recipient after signing. Requires include_billing_workflow to be true and billing_workflow_type to be \"link\".",
+ "type": "string"
+ },
+ "pilot_attributes": {
+ "additionalProperties": false,
+ "description": "Override pilot terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "fees_type": {
+ "enum": [
+ "free",
+ "pilot_period_fees"
+ ],
+ "type": "string"
+ },
+ "general_cap_amount": {
+ "type": "number"
+ },
+ "general_cap_amount_type": {
+ "enum": [
+ "preceding",
+ "base",
+ "period"
+ ],
+ "type": "string"
+ },
+ "general_cap_period_currency": {
+ "type": "number"
+ },
+ "general_cap_period_qty": {
+ "type": "number"
+ },
+ "general_cap_preceding_amount": {
+ "type": "number"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_dpa": {
+ "type": "boolean"
+ },
+ "include_dpa_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_dpa_location": {
+ "type": "string"
+ },
+ "include_dpa_type": {
+ "enum": [
+ "description",
+ "attachment",
+ "standard"
+ ],
+ "type": "string"
+ },
+ "include_payment_process": {
+ "type": "boolean"
+ },
+ "include_technical_support": {
+ "type": "boolean"
+ },
+ "payment_process_automatic_frequency": {
+ "enum": [
+ "monthly",
+ "quarterly",
+ "annually",
+ "once_per_period"
+ ],
+ "type": "string"
+ },
+ "payment_process_invoice_days": {
+ "type": "number"
+ },
+ "payment_process_invoice_from": {
+ "enum": [
+ "receipt",
+ "date"
+ ],
+ "type": "string"
+ },
+ "payment_process_invoice_timeframe": {
+ "enum": [
+ "days",
+ "weeks",
+ "months",
+ "quarters",
+ "years"
+ ],
+ "type": "string"
+ },
+ "payment_process_type": {
+ "enum": [
+ "automatic",
+ "invoice"
+ ],
+ "type": "string"
+ },
+ "pilot_period_description": {
+ "type": "string"
+ },
+ "pilot_period_fees_description": {
+ "type": "string"
+ },
+ "product_description": {
+ "type": "string"
+ },
+ "technical_support_description": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "psa_attributes": {
+ "additionalProperties": false,
+ "description": "Override psa terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "additional_changes": {
+ "type": "string"
+ },
+ "customer_description": {
+ "type": "string"
+ },
+ "effective_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "effective_date_type": {
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "type": "string"
+ },
+ "general_cap_amount": {
+ "type": "number"
+ },
+ "general_cap_amount_type": {
+ "enum": [
+ "preceding",
+ "base",
+ "period"
+ ],
+ "type": "string"
+ },
+ "general_cap_period_currency": {
+ "type": "number"
+ },
+ "general_cap_period_qty": {
+ "type": "number"
+ },
+ "general_cap_preceding_amount": {
+ "type": "number"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_additional_changes": {
+ "type": "boolean"
+ },
+ "include_additional_warranties": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_by_customer": {
+ "type": "string"
+ },
+ "include_additional_warranties_by_provider": {
+ "type": "string"
+ },
+ "include_additional_warranties_include_by_customer": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_include_by_provider": {
+ "type": "boolean"
+ },
+ "include_covered_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_customer_claims": {
+ "type": "string"
+ },
+ "include_covered_claims_include_customer_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_include_provider_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_provider_claims": {
+ "type": "string"
+ },
+ "include_customer_insurance_min": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_add_provider_com_gen_liability": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_add_provider_cyber_liability": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_add_provider_errors_omissions": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_auto_liability_aggregate": {
+ "type": "number"
+ },
+ "include_customer_insurance_min_auto_liability_minimum": {
+ "type": "number"
+ },
+ "include_customer_insurance_min_cyber_liability_aggregate": {
+ "type": "number"
+ },
+ "include_customer_insurance_min_cyber_liability_minimum": {
+ "type": "number"
+ },
+ "include_customer_insurance_min_employer_liability_aggregate": {
+ "type": "number"
+ },
+ "include_customer_insurance_min_employer_liability_minimum": {
+ "type": "number"
+ },
+ "include_customer_insurance_min_general_liability_aggregate": {
+ "type": "number"
+ },
+ "include_customer_insurance_min_general_liability_minimum": {
+ "type": "number"
+ },
+ "include_customer_insurance_min_include_add_provider": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_include_auto_liability": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_include_cyber_liability": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_include_employer_liability": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_include_general_liability": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_include_workers_comp": {
+ "type": "boolean"
+ },
+ "include_customer_policies": {
+ "type": "boolean"
+ },
+ "include_customer_policies_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_customer_policies_location": {
+ "type": "string"
+ },
+ "include_customer_policies_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_dpa": {
+ "type": "boolean"
+ },
+ "include_dpa_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_dpa_location": {
+ "type": "string"
+ },
+ "include_dpa_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_increased_cap_amount": {
+ "type": "boolean"
+ },
+ "include_increased_claims": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_confidentiality": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_confidentiality_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_privsec": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_privsec_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_other": {
+ "type": "boolean"
+ },
+ "include_increased_claims_indemnification_obligation": {
+ "type": "boolean"
+ },
+ "include_increased_claims_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_other": {
+ "type": "string"
+ },
+ "include_provider_insurance_min": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_add_customer_com_gen_liability": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_add_customer_cyber_liability": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_add_customer_errors_omissions": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_auto_liability_aggregate": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_auto_liability_minimum": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_cyber_liability_aggregate": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_cyber_liability_minimum": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_employer_liability_aggregate": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_employer_liability_minimum": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_general_liability_aggregate": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_general_liability_minimum": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_include_add_customer": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_include_auto_liability": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_include_cyber_liability": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_include_employer_liability": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_include_general_liability": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_include_workers_comp": {
+ "type": "boolean"
+ },
+ "include_publicity_rights": {
+ "type": "boolean"
+ },
+ "include_publicity_rights_type": {
+ "enum": [
+ "public",
+ "non-public"
+ ],
+ "type": "string"
+ },
+ "include_security_policy": {
+ "type": "boolean"
+ },
+ "include_security_policy_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_security_policy_fedramp_auth": {
+ "type": "boolean"
+ },
+ "include_security_policy_hitrust": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_annual_maintenance": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_other": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_other_val": {
+ "type": "string"
+ },
+ "include_security_policy_iso27001": {
+ "type": "boolean"
+ },
+ "include_security_policy_location": {
+ "type": "string"
+ },
+ "include_security_policy_pci1": {
+ "type": "boolean"
+ },
+ "include_security_policy_pci2": {
+ "type": "boolean"
+ },
+ "include_security_policy_penetration_testing": {
+ "type": "boolean"
+ },
+ "include_security_policy_soc2_type1": {
+ "type": "boolean"
+ },
+ "include_security_policy_soc2_type2": {
+ "type": "boolean"
+ },
+ "include_security_policy_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_unlimited_claims": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_confidentiality": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_confidentiality_negligence": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_privsec": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_privsec_negligence": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_include_other": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_indemnification_obligation": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_negligence": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_other": {
+ "type": "string"
+ },
+ "increased_cap_amount_currency": {
+ "type": "number"
+ },
+ "increased_cap_amount_period_currency": {
+ "type": "number"
+ },
+ "increased_cap_amount_period_qty": {
+ "type": "number"
+ },
+ "increased_cap_amount_qty": {
+ "type": "number"
+ },
+ "increased_cap_amount_type": {
+ "enum": [
+ "qty",
+ "currency",
+ "period"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "psa_statement_of_work_attributes": {
+ "additionalProperties": false,
+ "description": "Override psa statement of work terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "additional_changes": {
+ "type": "string"
+ },
+ "cost": {
+ "type": "number"
+ },
+ "description": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "fees_attributes": {
+ "additionalProperties": {
+ "anyOf": [
+ {
+ "additionalProperties": false,
+ "description": "Fees::Flat (fee_type \"flat\"). A fixed recurring fee, e.g. a platform subscription. Set type to \"Fees::Flat\" or fee_type to \"flat\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Fixed amount in the order form's fees_currency, charged per fee_period. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"flat\". Alternative to type.",
+ "enum": [
+ "flat"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Flat\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Flat"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Discount (fee_type \"discount\"). A discount, as a fixed amount or a percentage, applied forever, once, or for a number of months. Set type to \"Fees::Discount\" or fee_type to \"discount\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Discount size: an amount in fees_currency when discount_type is fixed_amount (a plain amount, not cents: 20 means 20.00), or a percentage (e.g. 10 for 10%) when it is percentage.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "discount_duration_amount": {
+ "description": "Number of months the discount applies. Required when discount_duration_type is multiple_months.",
+ "type": "number"
+ },
+ "discount_duration_type": {
+ "description": "How long the discount applies. multiple_months also needs discount_duration_amount.",
+ "enum": [
+ "forever",
+ "once",
+ "multiple_months"
+ ],
+ "type": "string"
+ },
+ "discount_type": {
+ "description": "Whether cost is a currency amount or a percentage.",
+ "enum": [
+ "fixed_amount",
+ "percentage"
+ ],
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"discount\". Alternative to type.",
+ "enum": [
+ "discount"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Discount\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Discount"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Cost (fee_type \"cost\"). A per-unit fee: price per unit times quantity, e.g. seats. Set type to \"Fees::Cost\" or fee_type to \"cost\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Price per unit in fees_currency. The row total is quantity x cost. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"cost\". Alternative to type.",
+ "enum": [
+ "cost"
+ ],
+ "type": "string"
+ },
+ "quantity": {
+ "description": "Number of units.",
+ "type": "number"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Cost\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Cost"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Attachment (fee_type \"attachment\"). A fee described in an uploaded attachment instead of in the table. Set type to \"Fees::Attachment\" or fee_type to \"attachment\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "attachment_id": {
+ "description": "ID of an attachment uploaded with upload-attachment.",
+ "type": "string"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"attachment\". Alternative to type.",
+ "enum": [
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Attachment\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Attachment"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Graduated (fee_type \"graduated\"). Tiered pricing, with the price set per tier in graduated_fee_tiers_attributes. Set type to \"Fees::Graduated\" or fee_type to \"graduated\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"graduated\". Alternative to type.",
+ "enum": [
+ "graduated"
+ ],
+ "type": "string"
+ },
+ "graduated_fee_tiers_attributes": {
+ "additionalProperties": {
+ "additionalProperties": false,
+ "properties": {
+ "flat_price": {
+ "type": "number"
+ },
+ "price_per_unit": {
+ "type": "string"
+ },
+ "upper_limit": {
+ "type": "number"
+ }
+ },
+ "type": "object"
+ },
+ "description": "Graduated fee tiers. Use string keys such as \"0\", \"1\".",
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Graduated\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Graduated"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Included (fee_type \"included\"). An item included at no charge. Set type to \"Fees::Included\" or fee_type to \"included\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"included\". Alternative to type.",
+ "enum": [
+ "included"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Included\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Included"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Metered (fee_type \"metered\"). Usage-based pricing, billed per unit used. Set type to \"Fees::Metered\" or fee_type to \"metered\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Price per unit of usage in fees_currency. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"metered\". Alternative to type.",
+ "enum": [
+ "metered"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Metered\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Metered"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::OneTime (fee_type \"one_time\"). A one-time charge, such as a setup fee. Set type to \"Fees::OneTime\" or fee_type to \"one_time\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "One-time amount in fees_currency, charged once rather than per fee_period. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"one_time\". Alternative to type.",
+ "enum": [
+ "one_time"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::OneTime\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::OneTime"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Text (fee_type \"text\"). A fee term described in free text. Set type to \"Fees::Text\" or fee_type to \"text\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"text\". Alternative to type.",
+ "enum": [
+ "text"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Text\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Text"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ }
+ ]
+ },
+ "description": "Fee line items. Use string keys such as \"0\", \"1\". Replaces template fees when provided.",
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_additional_changes": {
+ "type": "boolean"
+ },
+ "include_customer_obligation": {
+ "type": "boolean"
+ },
+ "include_customer_obligation_val": {
+ "type": "string"
+ },
+ "include_deliverables": {
+ "type": "boolean"
+ },
+ "include_deliverables_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_deliverables_description": {
+ "type": "string"
+ },
+ "include_deliverables_include_acceptance": {
+ "type": "boolean"
+ },
+ "include_deliverables_include_attachment": {
+ "type": "boolean"
+ },
+ "include_deliverables_include_draft_deliverables": {
+ "type": "boolean"
+ },
+ "include_deliverables_rejection_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_deliverables_rejection_unit": {
+ "enum": [
+ "hours",
+ "days",
+ "weeks",
+ "months"
+ ],
+ "type": "string"
+ },
+ "include_deliverables_resubmission_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_deliverables_resubmission_unit": {
+ "enum": [
+ "hours",
+ "days",
+ "weeks",
+ "months"
+ ],
+ "type": "string"
+ },
+ "include_fees_other": {
+ "type": "boolean"
+ },
+ "include_fees_other_val": {
+ "type": "string"
+ },
+ "include_fees_table": {
+ "type": "boolean"
+ },
+ "include_fees_table_total": {
+ "type": "boolean"
+ },
+ "include_fees_travel": {
+ "type": "boolean"
+ },
+ "include_fees_travel_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_fees_travel_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_fees_travel_val": {
+ "type": "string"
+ },
+ "include_third_party_customer": {
+ "type": "boolean"
+ },
+ "include_third_party_include_description": {
+ "type": "boolean"
+ },
+ "include_third_party_include_description_val": {
+ "type": "string"
+ },
+ "include_third_party_materials": {
+ "type": "boolean"
+ },
+ "include_third_party_provider": {
+ "type": "boolean"
+ },
+ "include_time_of_assignment": {
+ "type": "boolean"
+ },
+ "include_time_of_assignment_type": {
+ "enum": [
+ "created",
+ "paid"
+ ],
+ "type": "string"
+ },
+ "invoice_period_description": {
+ "type": "string"
+ },
+ "negotiations_allowed": {
+ "description": "When true, the recipient can propose changes to the statement of work, even when the agreement-level `negotiations_allowed` is false. This only covers the statement of work.",
+ "type": "boolean"
+ },
+ "payment_period": {
+ "type": "number"
+ },
+ "payment_period_other": {
+ "type": "string"
+ },
+ "payment_period_timeframe": {
+ "enum": [
+ "receipt",
+ "invoice",
+ "Customer's receipt of invoice",
+ "date of invoice"
+ ],
+ "type": "string"
+ },
+ "payment_period_type": {
+ "enum": [
+ "standard",
+ "other"
+ ],
+ "type": "string"
+ },
+ "payment_period_unit": {
+ "enum": [
+ "day(s)",
+ "week(s)",
+ "month(s)",
+ "quarter(s)",
+ "year(s)"
+ ],
+ "type": "string"
+ },
+ "quantity": {
+ "type": "number"
+ },
+ "services_description": {
+ "type": "string"
+ },
+ "sow_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "sow_date_type": {
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "type": "string"
+ },
+ "sow_term_amount": {
+ "type": "number"
+ },
+ "sow_term_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "sow_term_type": {
+ "enum": [
+ "deliverables",
+ "period",
+ "date"
+ ],
+ "type": "string"
+ },
+ "sow_term_unit": {
+ "enum": [
+ "month(s)",
+ "quarter(s)",
+ "year(s)"
+ ],
+ "type": "string"
+ },
+ "type": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "recipient_email": {
+ "format": "email",
+ "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "recipient_name": {
+ "type": "string"
+ },
+ "recipient_notice_email_address": {
+ "description": "Email address for legal notices to the recipient.",
+ "format": "email",
+ "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "recipient_organization": {
+ "type": "string"
+ },
+ "recipient_role": {
+ "description": "PSA only. The recipient's role: `Customer` (the default) or `Provider`. Send it with `sender_role`; the two must be one `Provider` and one `Customer`. Other standard agreement types ignore it.",
+ "type": "string"
+ },
+ "sender_last_to_sign": {
+ "description": "When true, your signer signs after the recipient.",
+ "type": "boolean"
+ },
+ "sender_notice_email_address": {
+ "description": "Email address for legal notices to the sender.",
+ "format": "email",
+ "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "sender_role": {
+ "description": "PSA only. Your company's role: `Provider` (the default) or `Customer` when you hire the recipient to provide the services. Send it with `recipient_role`; the two must be one `Provider` and one `Customer`. When reading a PSA, an empty `sender_role` means `Provider`. Other standard agreement types ignore it.",
+ "type": "string"
+ },
+ "software_license_attributes": {
+ "additionalProperties": false,
+ "description": "Override software license terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "effective_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "effective_date_type": {
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "type": "string"
+ },
+ "general_cap_amount": {
+ "type": "number"
+ },
+ "general_cap_amount_type": {
+ "enum": [
+ "preceding",
+ "base",
+ "period"
+ ],
+ "type": "string"
+ },
+ "general_cap_period_currency": {
+ "type": "number"
+ },
+ "general_cap_period_qty": {
+ "type": "number"
+ },
+ "general_cap_preceding_amount": {
+ "type": "number"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_additional_warranties": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_by_customer": {
+ "type": "string"
+ },
+ "include_additional_warranties_by_provider": {
+ "type": "string"
+ },
+ "include_additional_warranties_include_by_customer": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_include_by_provider": {
+ "type": "boolean"
+ },
+ "include_ai_addendum": {
+ "type": "boolean"
+ },
+ "include_ai_addendum_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_covered_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_customer_claims": {
+ "type": "string"
+ },
+ "include_covered_claims_include_customer_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_include_provider_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_provider_claims": {
+ "type": "string"
+ },
+ "include_dpa": {
+ "type": "boolean"
+ },
+ "include_dpa_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_dpa_location": {
+ "type": "string"
+ },
+ "include_dpa_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_increased_cap_amount": {
+ "type": "boolean"
+ },
+ "include_increased_claims": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_confidentiality": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_confidentiality_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_other": {
+ "type": "boolean"
+ },
+ "include_increased_claims_indemnification_obligation": {
+ "type": "boolean"
+ },
+ "include_increased_claims_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_other": {
+ "type": "string"
+ },
+ "include_increased_claims_restrictions": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_confidentiality": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_confidentiality_negligence": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_include_other": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_indemnification_obligation": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_license_or_restrictions": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_negligence": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_other": {
+ "type": "string"
+ },
+ "increased_cap_amount_currency": {
+ "type": "number"
+ },
+ "increased_cap_amount_period_currency": {
+ "type": "number"
+ },
+ "increased_cap_amount_period_qty": {
+ "type": "number"
+ },
+ "increased_cap_amount_qty": {
+ "type": "number"
+ },
+ "increased_cap_amount_type": {
+ "enum": [
+ "qty",
+ "currency",
+ "period"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "software_license_order_form_attributes": {
+ "additionalProperties": false,
+ "description": "Override software license order form terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "additional_changes": {
+ "type": "string"
+ },
+ "deletion_procedure_include_custom": {
+ "type": "boolean"
+ },
+ "deletion_procedure_include_custom_description": {
+ "type": "string"
+ },
+ "deletion_procedure_include_customer_disable": {
+ "type": "boolean"
+ },
+ "deletion_procedure_include_customer_proof": {
+ "type": "boolean"
+ },
+ "deletion_procedure_include_provider_disable": {
+ "type": "boolean"
+ },
+ "fee_custom_unit": {
+ "type": "string"
+ },
+ "fee_period": {
+ "enum": [
+ "Subscription Period",
+ "month",
+ "year",
+ "Custom unit"
+ ],
+ "type": "string"
+ },
+ "fees_attributes": {
+ "additionalProperties": {
+ "anyOf": [
+ {
+ "additionalProperties": false,
+ "description": "Fees::Flat (fee_type \"flat\"). A fixed recurring fee, e.g. a platform subscription. Set type to \"Fees::Flat\" or fee_type to \"flat\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Fixed amount in the order form's fees_currency, charged per fee_period. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"flat\". Alternative to type.",
+ "enum": [
+ "flat"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Flat\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Flat"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Discount (fee_type \"discount\"). A discount, as a fixed amount or a percentage, applied forever, once, or for a number of months. Set type to \"Fees::Discount\" or fee_type to \"discount\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Discount size: an amount in fees_currency when discount_type is fixed_amount (a plain amount, not cents: 20 means 20.00), or a percentage (e.g. 10 for 10%) when it is percentage.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "discount_duration_amount": {
+ "description": "Number of months the discount applies. Required when discount_duration_type is multiple_months.",
+ "type": "number"
+ },
+ "discount_duration_type": {
+ "description": "How long the discount applies. multiple_months also needs discount_duration_amount.",
+ "enum": [
+ "forever",
+ "once",
+ "multiple_months"
+ ],
+ "type": "string"
+ },
+ "discount_type": {
+ "description": "Whether cost is a currency amount or a percentage.",
+ "enum": [
+ "fixed_amount",
+ "percentage"
+ ],
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"discount\". Alternative to type.",
+ "enum": [
+ "discount"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Discount\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Discount"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Cost (fee_type \"cost\"). A per-unit fee: price per unit times quantity, e.g. seats. Set type to \"Fees::Cost\" or fee_type to \"cost\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Price per unit in fees_currency. The row total is quantity x cost. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"cost\". Alternative to type.",
+ "enum": [
+ "cost"
+ ],
+ "type": "string"
+ },
+ "quantity": {
+ "description": "Number of units.",
+ "type": "number"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Cost\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Cost"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Attachment (fee_type \"attachment\"). A fee described in an uploaded attachment instead of in the table. Set type to \"Fees::Attachment\" or fee_type to \"attachment\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "attachment_id": {
+ "description": "ID of an attachment uploaded with upload-attachment.",
+ "type": "string"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"attachment\". Alternative to type.",
+ "enum": [
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Attachment\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Attachment"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Graduated (fee_type \"graduated\"). Tiered pricing, with the price set per tier in graduated_fee_tiers_attributes. Set type to \"Fees::Graduated\" or fee_type to \"graduated\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"graduated\". Alternative to type.",
+ "enum": [
+ "graduated"
+ ],
+ "type": "string"
+ },
+ "graduated_fee_tiers_attributes": {
+ "additionalProperties": {
+ "additionalProperties": false,
+ "properties": {
+ "flat_price": {
+ "type": "number"
+ },
+ "price_per_unit": {
+ "type": "string"
+ },
+ "upper_limit": {
+ "type": "number"
+ }
+ },
+ "type": "object"
+ },
+ "description": "Graduated fee tiers. Use string keys such as \"0\", \"1\".",
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Graduated\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Graduated"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Included (fee_type \"included\"). An item included at no charge. Set type to \"Fees::Included\" or fee_type to \"included\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"included\". Alternative to type.",
+ "enum": [
+ "included"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Included\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Included"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Metered (fee_type \"metered\"). Usage-based pricing, billed per unit used. Set type to \"Fees::Metered\" or fee_type to \"metered\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Price per unit of usage in fees_currency. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"metered\". Alternative to type.",
+ "enum": [
+ "metered"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Metered\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Metered"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::OneTime (fee_type \"one_time\"). A one-time charge, such as a setup fee. Set type to \"Fees::OneTime\" or fee_type to \"one_time\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "One-time amount in fees_currency, charged once rather than per fee_period. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"one_time\". Alternative to type.",
+ "enum": [
+ "one_time"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::OneTime\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::OneTime"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Text (fee_type \"text\"). A fee term described in free text. Set type to \"Fees::Text\" or fee_type to \"text\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"text\". Alternative to type.",
+ "enum": [
+ "text"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Text\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Text"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ }
+ ]
+ },
+ "description": "Fee line items. Use string keys such as \"0\", \"1\". Replaces template fees when provided.",
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+ },
+ "fees_currency": {
+ "enum": [
+ "USD",
+ "EUR",
+ "GBP",
+ "CAD",
+ "AUD",
+ "SGD",
+ "ILS",
+ "JPY",
+ "CHF",
+ "HKD"
+ ],
+ "type": "string"
+ },
+ "fees_include_fee_increase_upon_renewal": {
+ "type": "boolean"
+ },
+ "fees_include_fee_increase_upon_renewal_fee": {
+ "type": "number"
+ },
+ "fees_include_fee_increase_upon_renewal_type": {
+ "enum": [
+ "will",
+ "may"
+ ],
+ "type": "string"
+ },
+ "fees_inclusive_of_taxes": {
+ "type": "boolean"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_additional_changes": {
+ "type": "boolean"
+ },
+ "include_license_compliance_verification": {
+ "type": "boolean"
+ },
+ "include_license_compliance_verification_description": {
+ "type": "string"
+ },
+ "include_license_limits": {
+ "type": "boolean"
+ },
+ "include_license_limits_description": {
+ "type": "string"
+ },
+ "include_payment_process_include_billing_email": {
+ "type": "boolean"
+ },
+ "include_pilot_period": {
+ "type": "boolean"
+ },
+ "include_pilot_period_duration_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_pilot_period_duration_type": {
+ "enum": [
+ "day",
+ "week",
+ "month"
+ ],
+ "type": "string"
+ },
+ "include_pilot_period_include_fees": {
+ "type": "boolean"
+ },
+ "include_pilot_period_include_fees_amount": {
+ "type": "number"
+ },
+ "include_pilot_period_include_modifications": {
+ "type": "boolean"
+ },
+ "include_pilot_period_include_modifications_description": {
+ "type": "string"
+ },
+ "include_services": {
+ "type": "boolean"
+ },
+ "include_services_description": {
+ "type": "string"
+ },
+ "negotiations_allowed": {
+ "description": "When true, the recipient can propose changes to the order form, even when the agreement-level `negotiations_allowed` is false. This only covers the order form.",
+ "type": "boolean"
+ },
+ "order_date_date": {
+ "type": "string"
+ },
+ "order_date_type": {
+ "enum": [
+ "signature",
+ "date",
+ "other"
+ ],
+ "type": "string"
+ },
+ "payment_process_automatic_frequency": {
+ "enum": [
+ "monthly",
+ "quarterly",
+ "semiannually",
+ "annually"
+ ],
+ "type": "string"
+ },
+ "payment_process_type": {
+ "enum": [
+ "automatic",
+ "invoice",
+ "custom"
+ ],
+ "type": "string"
+ },
+ "payment_process_type_custom_val": {
+ "type": "string"
+ },
+ "payment_process_type_invoice_amount": {
+ "type": "number"
+ },
+ "payment_process_type_invoice_custom_unit": {
+ "type": "string"
+ },
+ "payment_process_type_invoice_duration": {
+ "enum": [
+ "day",
+ "week",
+ "month",
+ "year",
+ "day(s)",
+ "week(s)",
+ "month(s)",
+ "year(s)"
+ ],
+ "type": "string"
+ },
+ "payment_process_type_invoice_duration_start": {
+ "enum": [
+ "Customer's receipt of invoice",
+ "date of invoice"
+ ],
+ "type": "string"
+ },
+ "payment_process_type_invoice_type": {
+ "enum": [
+ "monthly",
+ "quarterly",
+ "semiannually",
+ "annually",
+ "Custom unit"
+ ],
+ "type": "string"
+ },
+ "permitted_uses_include_custom": {
+ "type": "boolean"
+ },
+ "permitted_uses_include_custom_description": {
+ "type": "string"
+ },
+ "permitted_uses_include_customers_affiliates": {
+ "type": "boolean"
+ },
+ "permitted_uses_include_internal_business": {
+ "type": "boolean"
+ },
+ "pilot_period_stripe_product_id": {
+ "type": "string"
+ },
+ "software_description": {
+ "type": "string"
+ },
+ "subscription_auto_renew": {
+ "enum": [
+ "days",
+ "subscription_end"
+ ],
+ "type": "string"
+ },
+ "subscription_period": {
+ "type": "number"
+ },
+ "subscription_period_unit": {
+ "type": "string"
+ },
+ "subscription_renewal_notice_days": {
+ "type": "number"
+ },
+ "warranty_period_description_amount": {
+ "type": "number"
+ },
+ "warranty_period_description_duration": {
+ "enum": [
+ "day",
+ "week",
+ "month",
+ "year"
+ ],
+ "type": "string"
+ },
+ "warranty_period_description_duration_start": {
+ "enum": [
+ "initial delivery of the Software",
+ "delivery of the Software and each subsequent Update",
+ "the Order Date"
+ ],
+ "type": "string"
+ },
+ "warranty_period_type": {
+ "enum": [
+ "description",
+ "none"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "test_agreement": {
+ "description": "When true, marks the agreement as a test. Test agreements do not count against your monthly limit.",
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "recipient_name",
+ "recipient_email"
+ ],
+ "type": "object"
+ },
+ "cc_users": {
+ "items": {
+ "format": "email",
+ "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "draft": {
+ "description": "When true, the agreement is saved as a draft and not sent to the recipient. Use POST /v1/agreements/{id}/send to send a draft agreement later.",
+ "type": "boolean"
+ },
+ "owner_id": {
+ "description": "User id of the agreement owner (sender).",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "signer_email": {
+ "description": "Email address of the signer from the owner's organization.",
+ "format": "email",
+ "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "template_id": {
+ "description": "UUID of a template from `GET /v1/templates`. Accepts both Common Paper standard templates and uploaded PDF templates (`type` `uploaded_template`).",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ }
+ },
+ "required": [
+ "template_id",
+ "owner_id",
+ "signer_email",
+ "agreement"
+ ],
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "agreement": {
+ "additionalProperties": {},
+ "properties": {
+ "amendment_attributes": {
+ "additionalProperties": false,
+ "description": "Override amendment terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "amended_terms_attributes": {
+ "additionalProperties": {
+ "additionalProperties": false,
+ "properties": {
+ "description": {
+ "type": "string"
+ },
+ "term": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "description": "Amended terms. Use string keys such as \"0\", \"1\".",
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+ },
+ "amendment_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "amendment_date_type": {
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "type": "string"
+ },
+ "framework_terms_type": {
+ "type": "string"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "parent_agreement_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "underlying_agreement_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "underlying_agreement_type": {
+ "type": "string"
+ },
+ "underlying_agreement_val": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "baa_attributes": {
+ "additionalProperties": false,
+ "description": "Override baa terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "aggregation_limitations_permitted": {
+ "type": "boolean"
+ },
+ "aggregation_limitations_permitted_val": {
+ "type": "string"
+ },
+ "breach_notification_unit": {
+ "enum": [
+ "hours",
+ "business days",
+ "calendar days"
+ ],
+ "type": "string"
+ },
+ "breach_notification_val": {
+ "type": "number"
+ },
+ "business_associate_relationship_type": {
+ "enum": [
+ "provider",
+ "company"
+ ],
+ "type": "string"
+ },
+ "deidentification_limitations_include_purpose": {
+ "type": "boolean"
+ },
+ "deidentification_limitations_include_requirements": {
+ "type": "boolean"
+ },
+ "deidentification_limitations_permitted": {
+ "type": "boolean"
+ },
+ "deidentification_limitations_purpose_val": {
+ "type": "string"
+ },
+ "deidentification_limitations_requirements_val": {
+ "type": "string"
+ },
+ "designated_record_set_provider_maintains": {
+ "type": "boolean"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_aggregation_limitations": {
+ "type": "boolean"
+ },
+ "include_deidentification_limitations": {
+ "type": "boolean"
+ },
+ "include_limitations": {
+ "type": "boolean"
+ },
+ "include_offshore_limitations": {
+ "type": "boolean"
+ },
+ "include_subcontract_limitations": {
+ "type": "boolean"
+ },
+ "offshore_limitations_permitted": {
+ "type": "boolean"
+ },
+ "offshore_limitations_permitted_val": {
+ "type": "string"
+ },
+ "subcontract_limitations_include_notice": {
+ "type": "boolean"
+ },
+ "subcontract_limitations_include_permission": {
+ "type": "boolean"
+ },
+ "subcontract_limitations_notice_val": {
+ "type": "string"
+ },
+ "subcontract_limitations_permission_val": {
+ "type": "string"
+ },
+ "subcontract_limitations_permitted": {
+ "type": "boolean"
+ },
+ "underlying_agreement_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "underlying_agreement_type": {
+ "enum": [
+ "internal",
+ "external",
+ "none"
+ ],
+ "type": "string"
+ },
+ "underlying_agreement_val": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "billing_email": {
+ "description": "Email of the billing contact. Used when include_billing_info is true.",
+ "format": "email",
+ "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "billing_name": {
+ "description": "Name of the billing contact. Used when include_billing_info is true.",
+ "type": "string"
+ },
+ "billing_workflow_type": {
+ "description": "The type of billing workflow. Use \"link\" to provide a payment_link_url, or \"stripe\" for Stripe-managed billing.",
+ "enum": [
+ "link",
+ "stripe"
+ ],
+ "type": "string"
+ },
+ "chosen_courts_country": {
+ "description": "The country in which disputes will be resolved.",
+ "type": "string"
+ },
+ "chosen_courts_region": {
+ "description": "The state or region in which disputes will be resolved.",
+ "type": "string"
+ },
+ "csa_attributes": {
+ "additionalProperties": false,
+ "description": "Override csa terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "customer_description": {
+ "type": "string"
+ },
+ "effective_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "effective_date_marketplace": {
+ "enum": [
+ "AWS",
+ "GCP",
+ "Azure"
+ ],
+ "type": "string"
+ },
+ "effective_date_type": {
+ "enum": [
+ "signature",
+ "date",
+ "marketplace_acceptance"
+ ],
+ "type": "string"
+ },
+ "general_cap_amount": {
+ "type": "number"
+ },
+ "general_cap_amount_type": {
+ "enum": [
+ "preceding",
+ "base",
+ "period"
+ ],
+ "type": "string"
+ },
+ "general_cap_period_currency": {
+ "type": "number"
+ },
+ "general_cap_period_qty": {
+ "type": "number"
+ },
+ "general_cap_preceding_amount": {
+ "type": "number"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_acceptable_use_policy": {
+ "type": "boolean"
+ },
+ "include_acceptable_use_policy_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_acceptable_use_policy_location": {
+ "type": "string"
+ },
+ "include_acceptable_use_policy_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_additional_warranties": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_by_customer": {
+ "type": "string"
+ },
+ "include_additional_warranties_by_provider": {
+ "type": "string"
+ },
+ "include_additional_warranties_include_by_customer": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_include_by_provider": {
+ "type": "boolean"
+ },
+ "include_ai_addendum": {
+ "type": "boolean"
+ },
+ "include_ai_addendum_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_covered_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_customer_claims": {
+ "type": "string"
+ },
+ "include_covered_claims_include_customer_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_include_provider_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_provider_claims": {
+ "type": "string"
+ },
+ "include_dpa": {
+ "type": "boolean"
+ },
+ "include_dpa_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_dpa_location": {
+ "type": "string"
+ },
+ "include_dpa_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_increased_cap_amount": {
+ "type": "boolean"
+ },
+ "include_increased_claims": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_confidentiality": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_confidentiality_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_privsec": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_privsec_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_other": {
+ "type": "boolean"
+ },
+ "include_increased_claims_indemnification_obligation": {
+ "type": "boolean"
+ },
+ "include_increased_claims_other": {
+ "type": "string"
+ },
+ "include_insurance_minimums": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_add_customer": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_add_customer_com_gen_liability": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_add_customer_cyber_liability": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_add_customer_errors_omissions": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_additional_information": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_additional_information_text": {
+ "type": "string"
+ },
+ "include_insurance_minimums_cyber_liability_aggregate": {
+ "type": "number"
+ },
+ "include_insurance_minimums_cyber_liability_minimum": {
+ "type": "number"
+ },
+ "include_insurance_minimums_employer_liability_aggregate": {
+ "type": "number"
+ },
+ "include_insurance_minimums_employer_liability_minimum": {
+ "type": "number"
+ },
+ "include_insurance_minimums_general_liability_aggregate": {
+ "type": "number"
+ },
+ "include_insurance_minimums_general_liability_minimum": {
+ "type": "number"
+ },
+ "include_insurance_minimums_include_cyber_liability": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_include_employer_liability": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_include_general_liability": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_include_workers_compensation": {
+ "type": "boolean"
+ },
+ "include_publicity_rights": {
+ "type": "boolean"
+ },
+ "include_publicity_rights_type": {
+ "enum": [
+ "public",
+ "non-public"
+ ],
+ "type": "string"
+ },
+ "include_security_policy": {
+ "type": "boolean"
+ },
+ "include_security_policy_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_security_policy_fedramp_auth": {
+ "type": "boolean"
+ },
+ "include_security_policy_hipaa": {
+ "type": "boolean"
+ },
+ "include_security_policy_hitrust": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_annual_maintenance": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_location": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_other": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_reasonable_efforts": {
+ "type": "boolean"
+ },
+ "include_security_policy_iso27001": {
+ "type": "boolean"
+ },
+ "include_security_policy_location": {
+ "type": "string"
+ },
+ "include_security_policy_other": {
+ "type": "string"
+ },
+ "include_security_policy_pci1": {
+ "type": "boolean"
+ },
+ "include_security_policy_pci2": {
+ "type": "boolean"
+ },
+ "include_security_policy_penetration_testing": {
+ "type": "boolean"
+ },
+ "include_security_policy_soc2": {
+ "type": "boolean"
+ },
+ "include_security_policy_soc2_type2": {
+ "type": "boolean"
+ },
+ "include_security_policy_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_supercap": {
+ "description": "CSA 3.0 renamed `include_increased_cap_amount` to `include_supercap`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_increased_cap_amount`. Sending the other spelling returns a 422.",
+ "type": "boolean"
+ },
+ "include_uncapped_claims": {
+ "description": "CSA 3.0 renamed `include_unlimited_claims` to `include_uncapped_claims`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims`. Sending the other spelling returns a 422.",
+ "type": "boolean"
+ },
+ "include_uncapped_claims_breach_of_confidentiality": {
+ "description": "CSA 3.0 renamed `include_unlimited_claims_breach_of_confidentiality` to `include_uncapped_claims_breach_of_confidentiality`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_breach_of_confidentiality`. Sending the other spelling returns a 422.",
+ "type": "boolean"
+ },
+ "include_uncapped_claims_breach_of_confidentiality_negligence": {
+ "description": "CSA 3.0 renamed `include_unlimited_claims_breach_of_confidentiality_negligence` to `include_uncapped_claims_breach_of_confidentiality_negligence`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_breach_of_confidentiality_negligence`. Sending the other spelling returns a 422.",
+ "type": "boolean"
+ },
+ "include_uncapped_claims_breach_of_privsec": {
+ "description": "CSA 3.0 renamed `include_unlimited_claims_breach_of_privsec` to `include_uncapped_claims_breach_of_privsec`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_breach_of_privsec`. Sending the other spelling returns a 422.",
+ "type": "boolean"
+ },
+ "include_uncapped_claims_breach_of_privsec_negligence": {
+ "description": "CSA 3.0 renamed `include_unlimited_claims_breach_of_privsec_negligence` to `include_uncapped_claims_breach_of_privsec_negligence`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_breach_of_privsec_negligence`. Sending the other spelling returns a 422.",
+ "type": "boolean"
+ },
+ "include_uncapped_claims_include_other": {
+ "description": "CSA 3.0 renamed `include_unlimited_claims_include_other` to `include_uncapped_claims_include_other`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_include_other`. Sending the other spelling returns a 422.",
+ "type": "boolean"
+ },
+ "include_uncapped_claims_indemnification_obligation": {
+ "description": "CSA 3.0 renamed `include_unlimited_claims_indemnification_obligation` to `include_uncapped_claims_indemnification_obligation`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_indemnification_obligation`. Sending the other spelling returns a 422.",
+ "type": "boolean"
+ },
+ "include_uncapped_claims_other": {
+ "description": "CSA 3.0 renamed `include_unlimited_claims_other` to `include_uncapped_claims_other`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_other`. Sending the other spelling returns a 422.",
+ "type": "boolean"
+ },
+ "include_unlimited_claims": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_confidentiality": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_confidentiality_negligence": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_privsec": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_privsec_negligence": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_include_other": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_indemnification_obligation": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_other": {
+ "type": "string"
+ },
+ "increased_cap_amount_currency": {
+ "type": "number"
+ },
+ "increased_cap_amount_period_currency": {
+ "type": "number"
+ },
+ "increased_cap_amount_period_qty": {
+ "type": "number"
+ },
+ "increased_cap_amount_qty": {
+ "type": "number"
+ },
+ "increased_cap_amount_type": {
+ "enum": [
+ "qty",
+ "currency",
+ "period"
+ ],
+ "type": "string"
+ },
+ "provider": {
+ "type": "string"
+ },
+ "supercap_currency": {
+ "description": "CSA 3.0 renamed `increased_cap_amount_currency` to `supercap_currency`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `increased_cap_amount_currency`. Sending the other spelling returns a 422.",
+ "type": "number"
+ },
+ "supercap_period_currency": {
+ "description": "CSA 3.0 renamed `increased_cap_amount_period_currency` to `supercap_period_currency`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `increased_cap_amount_period_currency`. Sending the other spelling returns a 422.",
+ "type": "number"
+ },
+ "supercap_period_qty": {
+ "description": "CSA 3.0 renamed `increased_cap_amount_period_qty` to `supercap_period_qty`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `increased_cap_amount_period_qty`. Sending the other spelling returns a 422.",
+ "type": "number"
+ },
+ "supercap_qty": {
+ "description": "CSA 3.0 renamed `increased_cap_amount_qty` to `supercap_qty`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `increased_cap_amount_qty`. Sending the other spelling returns a 422.",
+ "type": "number"
+ },
+ "supercap_type": {
+ "description": "CSA 3.0 renamed `increased_cap_amount_type` to `supercap_type`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `increased_cap_amount_type`. Sending the other spelling returns a 422.",
+ "type": "number"
+ }
+ },
+ "type": "object"
+ },
+ "csa_order_form_attributes": {
+ "additionalProperties": false,
+ "description": "Override csa order form terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "additional_changes": {
+ "type": "string"
+ },
+ "additional_parameters_or_limitations": {
+ "type": "string"
+ },
+ "affiliates_as_users": {
+ "type": "boolean"
+ },
+ "cloud_service_description": {
+ "type": "string"
+ },
+ "consumption_units": {
+ "type": "string"
+ },
+ "fee_amount": {
+ "type": "number"
+ },
+ "fee_custom_unit": {
+ "type": "string"
+ },
+ "fee_period": {
+ "enum": [
+ "Subscription Period",
+ "month",
+ "year",
+ "User",
+ "Custom unit"
+ ],
+ "type": "string"
+ },
+ "fees_attributes": {
+ "additionalProperties": {
+ "anyOf": [
+ {
+ "additionalProperties": false,
+ "description": "Fees::Flat (fee_type \"flat\"). A fixed recurring fee, e.g. a platform subscription. Set type to \"Fees::Flat\" or fee_type to \"flat\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Fixed amount in the order form's fees_currency, charged per fee_period. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"flat\". Alternative to type.",
+ "enum": [
+ "flat"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Flat\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Flat"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Discount (fee_type \"discount\"). A discount, as a fixed amount or a percentage, applied forever, once, or for a number of months. Set type to \"Fees::Discount\" or fee_type to \"discount\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Discount size: an amount in fees_currency when discount_type is fixed_amount (a plain amount, not cents: 20 means 20.00), or a percentage (e.g. 10 for 10%) when it is percentage.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "discount_duration_amount": {
+ "description": "Number of months the discount applies. Required when discount_duration_type is multiple_months.",
+ "type": "number"
+ },
+ "discount_duration_type": {
+ "description": "How long the discount applies. multiple_months also needs discount_duration_amount.",
+ "enum": [
+ "forever",
+ "once",
+ "multiple_months"
+ ],
+ "type": "string"
+ },
+ "discount_type": {
+ "description": "Whether cost is a currency amount or a percentage.",
+ "enum": [
+ "fixed_amount",
+ "percentage"
+ ],
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"discount\". Alternative to type.",
+ "enum": [
+ "discount"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Discount\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Discount"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Cost (fee_type \"cost\"). A per-unit fee: price per unit times quantity, e.g. seats. Set type to \"Fees::Cost\" or fee_type to \"cost\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Price per unit in fees_currency. The row total is quantity x cost. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"cost\". Alternative to type.",
+ "enum": [
+ "cost"
+ ],
+ "type": "string"
+ },
+ "quantity": {
+ "description": "Number of units.",
+ "type": "number"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Cost\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Cost"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Attachment (fee_type \"attachment\"). A fee described in an uploaded attachment instead of in the table. Set type to \"Fees::Attachment\" or fee_type to \"attachment\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "attachment_id": {
+ "description": "ID of an attachment uploaded with upload-attachment.",
+ "type": "string"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"attachment\". Alternative to type.",
+ "enum": [
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Attachment\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Attachment"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Graduated (fee_type \"graduated\"). Tiered pricing, with the price set per tier in graduated_fee_tiers_attributes. Set type to \"Fees::Graduated\" or fee_type to \"graduated\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"graduated\". Alternative to type.",
+ "enum": [
+ "graduated"
+ ],
+ "type": "string"
+ },
+ "graduated_fee_tiers_attributes": {
+ "additionalProperties": {
+ "additionalProperties": false,
+ "properties": {
+ "flat_price": {
+ "type": "number"
+ },
+ "price_per_unit": {
+ "type": "string"
+ },
+ "upper_limit": {
+ "type": "number"
+ }
+ },
+ "type": "object"
+ },
+ "description": "Graduated fee tiers. Use string keys such as \"0\", \"1\".",
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Graduated\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Graduated"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Included (fee_type \"included\"). An item included at no charge. Set type to \"Fees::Included\" or fee_type to \"included\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"included\". Alternative to type.",
+ "enum": [
+ "included"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Included\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Included"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Metered (fee_type \"metered\"). Usage-based pricing, billed per unit used. Set type to \"Fees::Metered\" or fee_type to \"metered\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Price per unit of usage in fees_currency. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"metered\". Alternative to type.",
+ "enum": [
+ "metered"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Metered\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Metered"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::OneTime (fee_type \"one_time\"). A one-time charge, such as a setup fee. Set type to \"Fees::OneTime\" or fee_type to \"one_time\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "One-time amount in fees_currency, charged once rather than per fee_period. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"one_time\". Alternative to type.",
+ "enum": [
+ "one_time"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::OneTime\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::OneTime"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Text (fee_type \"text\"). A fee term described in free text. Set type to \"Fees::Text\" or fee_type to \"text\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"text\". Alternative to type.",
+ "enum": [
+ "text"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Text\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Text"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ }
+ ]
+ },
+ "description": "Fee table rows, keyed by string index (\"0\", \"1\", ...). Replaces the template's fees when provided. Each row sets type or fee_type to pick the fee class. Amounts are in the order form's fees_currency and, for recurring fees, are charged per fee_period.",
+ "examples": [
+ {
+ "0": {
+ "cost": 2000,
+ "description": "Platform subscription",
+ "type": "Fees::Flat"
+ }
+ },
+ {
+ "0": {
+ "cost": 50,
+ "description": "Seats",
+ "fee_type": "cost",
+ "quantity": 10
+ },
+ "1": {
+ "cost": 10,
+ "description": "Launch discount",
+ "discount_duration_amount": 3,
+ "discount_duration_type": "multiple_months",
+ "discount_type": "percentage",
+ "fee_type": "discount"
+ }
+ }
+ ],
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+ },
+ "fees_currency": {
+ "enum": [
+ "USD",
+ "EUR",
+ "GBP",
+ "CAD",
+ "AUD",
+ "SGD",
+ "ILS",
+ "JPY",
+ "CHF",
+ "HKD"
+ ],
+ "type": "string"
+ },
+ "fees_include_fee_increase_upon_renewal": {
+ "type": "boolean"
+ },
+ "fees_include_fee_increase_upon_renewal_fee": {
+ "type": "number"
+ },
+ "fees_include_fee_increase_upon_renewal_type": {
+ "enum": [
+ "will",
+ "may"
+ ],
+ "type": "string"
+ },
+ "fees_inclusive_of_taxes": {
+ "type": "boolean"
+ },
+ "framework_terms_type": {
+ "enum": [
+ "new",
+ "existing",
+ "description"
+ ],
+ "type": "string"
+ },
+ "free_trial_days": {
+ "type": "number"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_additional_changes": {
+ "type": "boolean"
+ },
+ "include_additional_parameters_or_limitations": {
+ "type": "boolean"
+ },
+ "include_consumption": {
+ "type": "boolean"
+ },
+ "include_fees": {
+ "type": "boolean"
+ },
+ "include_fees_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_fees_include_attachment": {
+ "type": "boolean"
+ },
+ "include_fees_other": {
+ "type": "boolean"
+ },
+ "include_fees_other_val": {
+ "type": "string"
+ },
+ "include_fees_table": {
+ "type": "boolean"
+ },
+ "include_fees_table_period": {
+ "enum": [
+ "Subscription Period",
+ "month",
+ "year",
+ "User"
+ ],
+ "type": "string"
+ },
+ "include_free_trial": {
+ "type": "boolean"
+ },
+ "include_max_users": {
+ "type": "boolean"
+ },
+ "include_pilot_period": {
+ "type": "boolean"
+ },
+ "include_pilot_period_duration_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_pilot_period_duration_type": {
+ "enum": [
+ "day",
+ "week",
+ "month"
+ ],
+ "type": "string"
+ },
+ "include_pilot_period_include_fees": {
+ "type": "boolean"
+ },
+ "include_pilot_period_include_fees_amount": {
+ "type": "number"
+ },
+ "include_pilot_period_include_modifications": {
+ "type": "boolean"
+ },
+ "include_pilot_period_include_modifications_description": {
+ "type": "string"
+ },
+ "include_product_support": {
+ "type": "boolean"
+ },
+ "include_product_support_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_product_support_description": {
+ "type": "string"
+ },
+ "include_product_support_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_professional_services": {
+ "type": "boolean"
+ },
+ "include_professional_services_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_professional_services_custom_name": {
+ "type": "string"
+ },
+ "include_professional_services_description": {
+ "type": "string"
+ },
+ "include_professional_services_end_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "include_professional_services_fees_description": {
+ "type": "string"
+ },
+ "include_professional_services_include_end_date": {
+ "type": "boolean"
+ },
+ "include_professional_services_include_fees_description": {
+ "type": "boolean"
+ },
+ "include_professional_services_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_sla": {
+ "type": "boolean"
+ },
+ "include_sla_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_sla_description": {
+ "type": "string"
+ },
+ "include_sla_include_response_time": {
+ "type": "boolean"
+ },
+ "include_sla_include_response_time_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_sla_include_response_time_credit": {
+ "type": "number"
+ },
+ "include_sla_include_response_time_duration": {
+ "enum": [
+ "hour",
+ "day",
+ "week",
+ "month",
+ "hours"
+ ],
+ "type": "string"
+ },
+ "include_sla_include_response_time_support_channel": {
+ "type": "string"
+ },
+ "include_sla_include_target_uptime": {
+ "type": "boolean"
+ },
+ "include_sla_maintenance_notice": {
+ "type": "boolean"
+ },
+ "include_sla_maintenance_window": {
+ "type": "boolean"
+ },
+ "include_sla_maintenance_window_type": {
+ "enum": [
+ "standard",
+ "none"
+ ],
+ "type": "string"
+ },
+ "include_sla_standard_maintenance_notice_qty": {
+ "type": "number"
+ },
+ "include_sla_standard_maintenance_notice_unit": {
+ "enum": [
+ "hour",
+ "day",
+ "week",
+ "month"
+ ],
+ "type": "string"
+ },
+ "include_sla_standard_maintenance_window_end_time": {
+ "type": "string"
+ },
+ "include_sla_standard_maintenance_window_friday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_monday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_saturday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_start_time": {
+ "type": "string"
+ },
+ "include_sla_standard_maintenance_window_sunday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_thursday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_time_zone": {
+ "type": "string"
+ },
+ "include_sla_standard_maintenance_window_tuesday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_wednesday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_target_uptime": {
+ "type": "number"
+ },
+ "include_sla_type": {
+ "enum": [
+ "description",
+ "standard",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_subscription_start_date": {
+ "type": "boolean"
+ },
+ "include_subscription_start_date_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "include_usage_review": {
+ "type": "boolean"
+ },
+ "include_usage_review_val": {
+ "type": "string"
+ },
+ "include_use_limitations": {
+ "type": "boolean"
+ },
+ "include_use_limitations_val": {
+ "type": "string"
+ },
+ "invoice_period": {
+ "enum": [
+ "monthly",
+ "quarterly",
+ "semiannually",
+ "annually",
+ "Custom unit",
+ "Monthly",
+ "Quarterly",
+ "Semiannually",
+ "Annually"
+ ],
+ "type": "string"
+ },
+ "invoice_period_custom_unit": {
+ "type": "string"
+ },
+ "max_consumption": {
+ "type": "number"
+ },
+ "max_users": {
+ "type": "number"
+ },
+ "negotiations_allowed": {
+ "description": "When true, the recipient can propose changes to the order form, even when the agreement-level `negotiations_allowed` is false. This only covers the order form.",
+ "type": "boolean"
+ },
+ "order_date_date": {
+ "type": "string"
+ },
+ "order_date_other": {
+ "type": "string"
+ },
+ "order_date_type": {
+ "enum": [
+ "signature",
+ "date",
+ "other"
+ ],
+ "type": "string"
+ },
+ "payment_period": {
+ "type": "number"
+ },
+ "payment_period_timeframe": {
+ "enum": [
+ "Customer's receipt of invoice",
+ "date of invoice"
+ ],
+ "type": "string"
+ },
+ "payment_period_unit": {
+ "enum": [
+ "day(s)",
+ "week(s)",
+ "month(s)",
+ "marketplace_acceptance"
+ ],
+ "type": "string"
+ },
+ "payment_process_automatic_frequency": {
+ "enum": [
+ "monthly",
+ "quarterly",
+ "semiannually",
+ "annually"
+ ],
+ "type": "string"
+ },
+ "payment_process_type": {
+ "enum": [
+ "automatic",
+ "invoice",
+ "custom",
+ "marketplace_acceptance"
+ ],
+ "type": "string"
+ },
+ "payment_process_type_custom_val": {
+ "type": "string"
+ },
+ "payment_process_type_invoice_amount": {
+ "type": "number"
+ },
+ "payment_process_type_invoice_custom_unit": {
+ "type": "string"
+ },
+ "payment_process_type_invoice_duration": {
+ "enum": [
+ "day",
+ "week",
+ "month",
+ "year",
+ "day(s)",
+ "week(s)",
+ "month(s)",
+ "year(s)"
+ ],
+ "type": "string"
+ },
+ "payment_process_type_invoice_duration_start": {
+ "enum": [
+ "Customer's receipt of invoice",
+ "date of invoice"
+ ],
+ "type": "string"
+ },
+ "payment_process_type_invoice_type": {
+ "enum": [
+ "monthly",
+ "quarterly",
+ "semiannually",
+ "annually",
+ "Custom unit"
+ ],
+ "type": "string"
+ },
+ "pilot_period_stripe_product_id": {
+ "type": "string"
+ },
+ "service_credits_attributes": {
+ "additionalProperties": {
+ "additionalProperties": false,
+ "properties": {
+ "credit": {
+ "type": "number"
+ },
+ "max": {
+ "type": "number"
+ },
+ "min": {
+ "type": "number"
+ }
+ },
+ "type": "object"
+ },
+ "description": "Service credits. Use string keys such as \"0\", \"1\".",
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+ },
+ "subscription_auto_renew": {
+ "enum": [
+ "days",
+ "subscription_end"
+ ],
+ "type": "string"
+ },
+ "subscription_period": {
+ "type": "number"
+ },
+ "subscription_period_unit": {
+ "type": "string"
+ },
+ "subscription_renewal_notice_days": {
+ "type": "number"
+ },
+ "subscription_start_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "subscription_start_date_type": {
+ "enum": [
+ "effective_date",
+ "date"
+ ],
+ "type": "string"
+ },
+ "underlying_agreement_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "use_limitations_attributes": {
+ "additionalProperties": {
+ "additionalProperties": false,
+ "properties": {
+ "amount": {
+ "type": "number"
+ },
+ "limitation_type": {
+ "type": "string"
+ },
+ "unit": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "description": "Use limitations. Use string keys such as \"0\", \"1\".",
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+ }
+ },
+ "type": "object"
+ },
+ "custom_field_values": {
+ "description": "Values for a custom template's fields, keyed by the field keys defined in the template's YAML definition. Only used when template_id is a custom template. Template defaults fill any fields you omit; a required field with no default and no submitted value returns a 400 naming the field. Values are validated against the field's input type: select and radio values must be one of the field's options, multiselect values are an array of selections each of which must be one of the field's options, number and currency values must be numeric, date values must be YYYY-MM-DD, and email values must be valid addresses. An invalid value returns a 400 naming the field."
+ },
+ "design_partner_attributes": {
+ "additionalProperties": false,
+ "description": "Override design partner terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "customer_description": {
+ "type": "string"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_fees": {
+ "type": "boolean"
+ },
+ "include_fees_amount": {
+ "type": "number"
+ },
+ "include_fees_description": {
+ "type": "string"
+ },
+ "include_fees_pay_by_amount": {
+ "type": "string"
+ },
+ "include_fees_type": {
+ "enum": [
+ "default_language",
+ "description"
+ ],
+ "type": "string"
+ },
+ "include_fees_unit": {
+ "enum": [
+ "month",
+ "quarter",
+ "year",
+ "Term"
+ ],
+ "type": "string"
+ },
+ "include_program_appear_as_customer_private": {
+ "type": "boolean"
+ },
+ "include_program_appear_as_customer_public": {
+ "type": "boolean"
+ },
+ "include_program_case_study": {
+ "type": "boolean"
+ },
+ "include_program_develop_functionality": {
+ "type": "boolean"
+ },
+ "include_program_develop_functionality_val": {
+ "type": "string"
+ },
+ "include_program_discount": {
+ "type": "boolean"
+ },
+ "include_program_discount_amount": {
+ "type": "number"
+ },
+ "include_program_discount_unit": {
+ "enum": [
+ "U.S. Dollars",
+ "percent"
+ ],
+ "type": "string"
+ },
+ "include_program_participation_feedback": {
+ "type": "boolean"
+ },
+ "include_program_participation_feedback_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_program_participation_feedback_unit": {
+ "enum": [
+ "month",
+ "quarter",
+ "year",
+ "Term"
+ ],
+ "type": "string"
+ },
+ "include_program_partner_other": {
+ "type": "boolean"
+ },
+ "include_program_partner_other_val": {
+ "type": "string"
+ },
+ "include_program_provider_other": {
+ "type": "boolean"
+ },
+ "include_program_provider_other_val": {
+ "type": "string"
+ },
+ "include_program_reference": {
+ "type": "boolean"
+ },
+ "product_description": {
+ "type": "string"
+ },
+ "term_amount": {
+ "type": "number"
+ },
+ "term_unit": {
+ "enum": [
+ "day(s)",
+ "week(s)",
+ "month(s)",
+ "quarter(s)",
+ "year(s)"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "district_or_county": {
+ "description": "The district or county for dispute resolution.",
+ "type": "string"
+ },
+ "dpa_attributes": {
+ "additionalProperties": false,
+ "description": "Override dpa terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "approved_subprocessor_type": {
+ "description": "`internal` lists approved subprocessors in the agreement (`subprocessors_attributes`); `external` points to a list published elsewhere.",
+ "enum": [
+ "internal",
+ "external"
+ ],
+ "type": "string"
+ },
+ "cloud_service_product_name": {
+ "type": "string"
+ },
+ "competent_supervisory_authority": {
+ "type": "string"
+ },
+ "customer_description": {
+ "type": "string"
+ },
+ "data_exporter_address_city": {
+ "type": "string"
+ },
+ "data_exporter_address_country": {
+ "type": "string"
+ },
+ "data_exporter_address_state": {
+ "type": "string"
+ },
+ "data_exporter_address_street_address": {
+ "type": "string"
+ },
+ "data_exporter_address_zipcode": {
+ "type": "string"
+ },
+ "data_exporter_contact_details": {
+ "type": "string"
+ },
+ "data_exporter_contact_name": {
+ "type": "string"
+ },
+ "data_exporter_contact_position": {
+ "type": "string"
+ },
+ "data_exporter_role": {
+ "description": "Role of the data exporter. Overwritten to `Controller` when the agreement is created from a template.",
+ "enum": [
+ "Controller",
+ "Processor"
+ ],
+ "type": "string"
+ },
+ "data_importer_address": {
+ "type": "string"
+ },
+ "data_importer_address_city": {
+ "type": "string"
+ },
+ "data_importer_address_country": {
+ "type": "string"
+ },
+ "data_importer_address_state": {
+ "type": "string"
+ },
+ "data_importer_address_street_address": {
+ "type": "string"
+ },
+ "data_importer_address_zipcode": {
+ "type": "string"
+ },
+ "data_importer_contact_details": {
+ "type": "string"
+ },
+ "data_importer_contact_name": {
+ "type": "string"
+ },
+ "data_importer_contact_position": {
+ "type": "string"
+ },
+ "duration_of_processing": {
+ "type": "string"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_covered_claim": {
+ "type": "boolean"
+ },
+ "include_covered_claim_external_val": {
+ "type": "string"
+ },
+ "include_covered_claim_internal_val": {
+ "type": "string"
+ },
+ "include_covered_claim_type": {
+ "description": "Which covered-claim text applies: `internal` uses `include_covered_claim_internal_val`, `external` uses `include_covered_claim_external_val`. Required when `include_covered_claim` is true.",
+ "enum": [
+ "internal",
+ "external"
+ ],
+ "type": "string"
+ },
+ "include_data_subjects_custom": {
+ "type": "boolean"
+ },
+ "include_data_subjects_custom_val": {
+ "type": "string"
+ },
+ "include_data_subjects_employees": {
+ "type": "boolean"
+ },
+ "include_data_subjects_end_users": {
+ "type": "boolean"
+ },
+ "include_external_subprocessor_location": {
+ "type": "string"
+ },
+ "include_frequency_of_transfer_continuous": {
+ "type": "boolean"
+ },
+ "include_frequency_of_transfer_custom": {
+ "type": "boolean"
+ },
+ "include_frequency_of_transfer_custom_val": {
+ "type": "string"
+ },
+ "include_governing_country_eu": {
+ "type": "boolean"
+ },
+ "include_governing_country_eu_val": {
+ "type": "string"
+ },
+ "include_governing_country_uk": {
+ "type": "boolean"
+ },
+ "include_governing_country_uk_val": {
+ "type": "string"
+ },
+ "include_governing_law": {
+ "type": "boolean"
+ },
+ "include_governing_law_country": {
+ "type": "string"
+ },
+ "include_governing_law_state": {
+ "type": "string"
+ },
+ "include_increased_claim_amount": {
+ "description": "Legacy field. Stored but not shown on the DPA; use the `include_liability_cap*` fields instead.",
+ "type": "boolean"
+ },
+ "include_increased_claim_amount_currency": {
+ "description": "Legacy field. Stored but not shown on the DPA; use the `include_liability_cap*` fields instead."
+ },
+ "include_increased_claim_amount_qty": {
+ "description": "Legacy field. Stored but not shown on the DPA; use the `include_liability_cap*` fields instead."
+ },
+ "include_increased_claim_amount_type": {
+ "description": "Legacy field. Stored but not shown on the DPA; use the `include_liability_cap*` fields instead.",
+ "type": "string"
+ },
+ "include_liability_cap": {
+ "type": "boolean"
+ },
+ "include_liability_cap_amount_constant_external": {
+ "type": "string"
+ },
+ "include_liability_cap_amount_constant_internal": {
+ "type": "string"
+ },
+ "include_liability_cap_amount_currency_external": {
+ "description": "Currency amount. Numbers and numeric strings (commas allowed) are both accepted."
+ },
+ "include_liability_cap_amount_currency_internal": {
+ "description": "Currency amount. Numbers and numeric strings (commas allowed) are both accepted."
+ },
+ "include_liability_cap_csa_type": {
+ "description": "Which liability cap values apply: the `_internal` or `_external` amount fields. Required when `include_liability_cap` is true.",
+ "enum": [
+ "internal",
+ "external"
+ ],
+ "type": "string"
+ },
+ "include_personal_data_biographic_info": {
+ "type": "boolean"
+ },
+ "include_personal_data_contact_info": {
+ "type": "boolean"
+ },
+ "include_personal_data_custom": {
+ "type": "boolean"
+ },
+ "include_personal_data_custom_val": {
+ "type": "string"
+ },
+ "include_personal_data_employment_info": {
+ "type": "boolean"
+ },
+ "include_personal_data_financial_info": {
+ "type": "boolean"
+ },
+ "include_personal_data_location": {
+ "type": "boolean"
+ },
+ "include_personal_data_name": {
+ "type": "boolean"
+ },
+ "include_personal_data_transactional_info": {
+ "type": "boolean"
+ },
+ "include_personal_data_user_activity_info": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_custom": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_custom_val": {
+ "type": "string"
+ },
+ "include_processing_purpose_erasing": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_holding": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_protecting": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_receiving": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_returning": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_sharing": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_updating": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_using": {
+ "type": "boolean"
+ },
+ "include_provider_security_contact_address": {
+ "type": "boolean"
+ },
+ "include_provider_security_contact_address_city": {
+ "type": "string"
+ },
+ "include_provider_security_contact_address_country": {
+ "type": "string"
+ },
+ "include_provider_security_contact_address_state": {
+ "type": "string"
+ },
+ "include_provider_security_contact_address_street_address": {
+ "type": "string"
+ },
+ "include_provider_security_contact_address_zipcode": {
+ "type": "string"
+ },
+ "include_provider_security_contact_email": {
+ "type": "boolean"
+ },
+ "include_provider_security_contact_email_val": {
+ "format": "email",
+ "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "include_security_measures_accountability": {
+ "type": "boolean"
+ },
+ "include_security_measures_accountability_val": {
+ "type": "string"
+ },
+ "include_security_measures_certification_or_assurance": {
+ "type": "boolean"
+ },
+ "include_security_measures_certification_or_assurance_val": {
+ "type": "string"
+ },
+ "include_security_measures_confidentiality_integrity": {
+ "type": "boolean"
+ },
+ "include_security_measures_confidentiality_integrity_val": {
+ "type": "string"
+ },
+ "include_security_measures_data_at_rest": {
+ "type": "boolean"
+ },
+ "include_security_measures_data_at_rest_val": {
+ "type": "string"
+ },
+ "include_security_measures_data_minimization": {
+ "type": "boolean"
+ },
+ "include_security_measures_data_minimization_val": {
+ "type": "string"
+ },
+ "include_security_measures_data_quality": {
+ "type": "boolean"
+ },
+ "include_security_measures_data_quality_val": {
+ "type": "string"
+ },
+ "include_security_measures_data_retention": {
+ "type": "boolean"
+ },
+ "include_security_measures_data_retention_val": {
+ "type": "string"
+ },
+ "include_security_measures_data_transmission": {
+ "type": "boolean"
+ },
+ "include_security_measures_data_transmission_val": {
+ "type": "string"
+ },
+ "include_security_measures_event_logging": {
+ "type": "boolean"
+ },
+ "include_security_measures_event_logging_val": {
+ "type": "string"
+ },
+ "include_security_measures_identity_auth": {
+ "type": "boolean"
+ },
+ "include_security_measures_identity_auth_val": {
+ "type": "string"
+ },
+ "include_security_measures_it_security_governance": {
+ "type": "boolean"
+ },
+ "include_security_measures_it_security_governance_val": {
+ "type": "string"
+ },
+ "include_security_measures_physical_security": {
+ "type": "boolean"
+ },
+ "include_security_measures_physical_security_val": {
+ "type": "string"
+ },
+ "include_security_measures_portability_and_erasure": {
+ "type": "boolean"
+ },
+ "include_security_measures_portability_and_erasure_val": {
+ "type": "string"
+ },
+ "include_security_measures_pseudonym_encryption": {
+ "type": "boolean"
+ },
+ "include_security_measures_pseudonym_encryption_val": {
+ "type": "string"
+ },
+ "include_security_measures_restore_data_access": {
+ "type": "boolean"
+ },
+ "include_security_measures_restore_data_access_val": {
+ "type": "string"
+ },
+ "include_security_measures_security_policy": {
+ "type": "boolean"
+ },
+ "include_security_measures_system_configuration": {
+ "type": "boolean"
+ },
+ "include_security_measures_system_configuration_val": {
+ "type": "string"
+ },
+ "include_security_measures_testing_assessment": {
+ "type": "boolean"
+ },
+ "include_security_measures_testing_assessment_val": {
+ "type": "string"
+ },
+ "include_security_policy": {
+ "type": "boolean"
+ },
+ "include_security_policy_fedramp_auth": {
+ "type": "boolean"
+ },
+ "include_security_policy_hipaa": {
+ "type": "boolean"
+ },
+ "include_security_policy_hitrust": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_other": {
+ "type": "boolean"
+ },
+ "include_security_policy_iso27001": {
+ "type": "boolean"
+ },
+ "include_security_policy_other": {
+ "type": "string"
+ },
+ "include_security_policy_pci1": {
+ "type": "boolean"
+ },
+ "include_security_policy_pci2": {
+ "type": "boolean"
+ },
+ "include_security_policy_penetration_testing": {
+ "type": "boolean"
+ },
+ "include_security_policy_soc2": {
+ "type": "boolean"
+ },
+ "include_security_policy_soc2_type2": {
+ "type": "boolean"
+ },
+ "include_sensitive_data_restrictions_custom": {
+ "type": "boolean"
+ },
+ "include_sensitive_data_restrictions_custom_val": {
+ "type": "string"
+ },
+ "include_sensitive_data_restrictions_security_policy": {
+ "type": "boolean"
+ },
+ "include_service_provider_relationship": {
+ "type": "boolean"
+ },
+ "include_special_category_data": {
+ "type": "boolean"
+ },
+ "provider": {
+ "type": "string"
+ },
+ "security_policy_available_at": {
+ "type": "string"
+ },
+ "security_policy_type": {
+ "description": "Where the Security Policy is defined. For `external`, set `security_policy_available_at`.",
+ "enum": [
+ "defined in agreement",
+ "provider service",
+ "external"
+ ],
+ "type": "string"
+ },
+ "subprocessors_attributes": {
+ "additionalProperties": {
+ "additionalProperties": false,
+ "properties": {
+ "_destroy": {
+ "description": "Set to true with `id` to remove that subprocessor.",
+ "type": "boolean"
+ },
+ "country": {
+ "type": "string"
+ },
+ "id": {
+ "description": "ID of an existing subprocessor to update or remove. Omit to add a new subprocessor.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "processing_task": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "description": "Subprocessors, keyed by string index such as \"0\", \"1\". On create these are added to the template's subprocessors. On a draft update, an entry without `id` adds a new subprocessor; pass `id` to change one and `id` with `_destroy: true` to remove one.",
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+ },
+ "underlying_agreement_id": {
+ "description": "ID of the CSA this DPA supplements when `underlying_agreement_type` is `internal`.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "underlying_agreement_type": {
+ "description": "`internal` links a CSA in Common Paper (`underlying_agreement_id`); `external` describes another agreement in `underlying_agreement_val` (required). Omit for none.",
+ "enum": [
+ "internal",
+ "external"
+ ],
+ "type": "string"
+ },
+ "underlying_agreement_val": {
+ "description": "Description of the agreement this DPA supplements. Required when `underlying_agreement_type` is `external`.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "framework_terms_description": {
+ "description": "Custom framework terms description. Only used when framework_terms_type is \"description\".",
+ "type": "string"
+ },
+ "framework_terms_type": {
+ "description": "How framework terms are specified. Use \"new\" for standard terms or \"description\" to provide a custom framework_terms_description.",
+ "enum": [
+ "new",
+ "description"
+ ],
+ "type": "string"
+ },
+ "governing_law_country": {
+ "description": "The country whose laws govern the agreement.",
+ "type": "string"
+ },
+ "governing_law_region": {
+ "description": "The state or region whose laws govern the agreement.",
+ "type": "string"
+ },
+ "include_automated_payment_reminders": {
+ "description": "When true, automatically sends payment reminder emails.",
+ "type": "boolean"
+ },
+ "include_billing_info": {
+ "description": "When true, billing contact information (billing_name, billing_email) is included.",
+ "type": "boolean"
+ },
+ "include_billing_workflow": {
+ "description": "When true, enables a billing workflow after signing.",
+ "type": "boolean"
+ },
+ "include_expiration_date": {
+ "description": "Expiration date in YYYY-MM-DD format. Use when include_expiration_type is \"date\".",
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "include_expiration_days": {
+ "description": "Number of days until the agreement expires. Use when include_expiration_type is \"days\".",
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_expiration_type": {
+ "description": "How to set expiration: \"none\" (default), \"days\" (use include_expiration_days), or \"date\" (use include_expiration_date).",
+ "enum": [
+ "none",
+ "days",
+ "date"
+ ],
+ "type": "string"
+ },
+ "include_terms": {
+ "description": "When true, the standard terms are included with the agreement.",
+ "type": "boolean"
+ },
+ "loi_attributes": {
+ "additionalProperties": false,
+ "description": "Override loi terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "confidentiality_custom": {
+ "type": "string"
+ },
+ "confidentiality_mutual_include_loi": {
+ "type": "boolean"
+ },
+ "confidentiality_nda_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "confidentiality_nda_description": {
+ "type": "string"
+ },
+ "confidentiality_nda_include_loi": {
+ "type": "boolean"
+ },
+ "confidentiality_nda_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "confidentiality_type": {
+ "enum": [
+ "mutual",
+ "nda",
+ "provider",
+ "custom"
+ ],
+ "type": "string"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_custom_details": {
+ "type": "boolean"
+ },
+ "include_custom_details_val": {
+ "type": "string"
+ },
+ "include_fees": {
+ "type": "boolean"
+ },
+ "include_fees_amount": {
+ "type": "number"
+ },
+ "include_fees_amount_duration": {
+ "enum": [
+ "month",
+ "year",
+ "quarter"
+ ],
+ "type": "string"
+ },
+ "include_fees_include_amount": {
+ "type": "boolean"
+ },
+ "include_fees_include_other": {
+ "type": "boolean"
+ },
+ "include_fees_other": {
+ "type": "string"
+ },
+ "include_functionality": {
+ "type": "boolean"
+ },
+ "include_functionality_val": {
+ "type": "string"
+ },
+ "include_launch_date": {
+ "type": "boolean"
+ },
+ "include_launch_date_custom": {
+ "type": "string"
+ },
+ "include_launch_date_date": {
+ "format": "date-time",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$",
+ "type": "string"
+ },
+ "include_launch_date_type": {
+ "enum": [
+ "date",
+ "custom"
+ ],
+ "type": "string"
+ },
+ "product_name": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "manual_send": {
+ "description": "When true, the agreement is marked as manually sent outside the platform.",
+ "type": "boolean"
+ },
+ "message": {
+ "type": "string"
+ },
+ "negotiations_allowed": {
+ "description": "When true, the recipient can propose changes to the legal terms. For agreement types without separate business terms, that covers every term. CSA order forms, PSA statements of work, partnership business terms and software license order forms have their own `negotiations_allowed` flag.",
+ "type": "boolean"
+ },
+ "partnership_attributes": {
+ "additionalProperties": false,
+ "description": "Override partnership terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "effective_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "effective_date_type": {
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "type": "string"
+ },
+ "general_cap_amount_currency_val": {
+ "type": "number"
+ },
+ "general_cap_amount_either_currency": {
+ "type": "number"
+ },
+ "general_cap_amount_either_multiple": {
+ "type": "number"
+ },
+ "general_cap_amount_multiple_val": {
+ "type": "number"
+ },
+ "general_cap_amount_type": {
+ "enum": [
+ "multiple",
+ "currency",
+ "either",
+ "base"
+ ],
+ "type": "string"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_additional_warranties": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_include_company": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_include_company_val": {
+ "type": "string"
+ },
+ "include_additional_warranties_include_partner": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_include_partner_val": {
+ "type": "string"
+ },
+ "include_brand_guidelines": {
+ "type": "boolean"
+ },
+ "include_brand_guidelines_include_company": {
+ "type": "boolean"
+ },
+ "include_brand_guidelines_include_company_val": {
+ "type": "string"
+ },
+ "include_brand_guidelines_include_partner": {
+ "type": "boolean"
+ },
+ "include_brand_guidelines_include_partner_val": {
+ "type": "string"
+ },
+ "include_covered_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_company_claims": {
+ "type": "string"
+ },
+ "include_covered_claims_include_company_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_include_partner_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_partner_claims": {
+ "type": "string"
+ },
+ "include_dpa": {
+ "type": "boolean"
+ },
+ "include_dpa_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_dpa_location": {
+ "type": "string"
+ },
+ "include_dpa_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_increased_cap_amount": {
+ "type": "boolean"
+ },
+ "include_increased_cap_amount_currency": {
+ "type": "number"
+ },
+ "include_increased_cap_amount_either_currency": {
+ "type": "number"
+ },
+ "include_increased_cap_amount_either_multiple": {
+ "type": "string"
+ },
+ "include_increased_cap_amount_multiple": {
+ "type": "string"
+ },
+ "include_increased_cap_amount_type": {
+ "enum": [
+ "multiple",
+ "currency",
+ "either"
+ ],
+ "type": "string"
+ },
+ "include_increased_claims": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_confidentiality": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_confidentiality_misconduct": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_covered_claims": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_misconduct": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_other": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_other_val": {
+ "type": "string"
+ },
+ "include_unlimited_claims": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_confidentiality": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_confidentiality_misconduct": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_covered_claims": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_misconduct": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_other": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_other_val": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "partnership_business_terms_attributes": {
+ "additionalProperties": false,
+ "description": "Override partnership business terms terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "end_date_after_effective_date_amount": {
+ "type": "number"
+ },
+ "end_date_after_effective_date_unit": {
+ "enum": [
+ "month(s)",
+ "quarter(s)",
+ "year(s)"
+ ],
+ "type": "string"
+ },
+ "end_date_date": {
+ "type": "string"
+ },
+ "end_date_type": {
+ "enum": [
+ "date",
+ "effective date"
+ ],
+ "type": "string"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_obligations_company_brand": {
+ "type": "boolean"
+ },
+ "include_obligations_company_promotion": {
+ "type": "boolean"
+ },
+ "include_obligations_company_promotion_include_activities": {
+ "type": "boolean"
+ },
+ "include_obligations_company_promotion_include_activities_val": {
+ "type": "string"
+ },
+ "include_obligations_company_promotion_include_materials": {
+ "type": "boolean"
+ },
+ "include_obligations_company_promotion_include_materials_val": {
+ "type": "string"
+ },
+ "include_obligations_company_referral": {
+ "type": "boolean"
+ },
+ "include_obligations_company_referral_include_criteria": {
+ "type": "boolean"
+ },
+ "include_obligations_company_referral_include_criteria_val": {
+ "type": "string"
+ },
+ "include_obligations_company_referral_include_pay_sch": {
+ "type": "boolean"
+ },
+ "include_obligations_company_referral_include_pay_sch_amount": {
+ "type": "number"
+ },
+ "include_obligations_company_referral_include_pay_sch_custom": {
+ "type": "string"
+ },
+ "include_obligations_company_referral_include_pay_sch_unit": {
+ "enum": [
+ "U.S. Dollars",
+ "percent"
+ ],
+ "type": "string"
+ },
+ "include_obligations_company_sponsorship": {
+ "type": "boolean"
+ },
+ "include_obligations_company_sponsorship_include_benefits": {
+ "type": "boolean"
+ },
+ "include_obligations_company_sponsorship_include_benefits_val": {
+ "type": "string"
+ },
+ "include_obligations_company_sponsorship_include_payments": {
+ "type": "boolean"
+ },
+ "include_obligations_company_sponsorship_include_payments_amount": {
+ "type": "number"
+ },
+ "include_obligations_company_sponsorship_include_payments_unit": {
+ "enum": [
+ "U.S. Dollars",
+ "percent"
+ ],
+ "type": "string"
+ },
+ "include_obligations_partner_brand": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_promotion": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_promotion_include_activities": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_promotion_include_activities_val": {
+ "type": "string"
+ },
+ "include_obligations_partner_promotion_include_materials": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_promotion_include_materials_val": {
+ "type": "string"
+ },
+ "include_obligations_partner_referral": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_referral_include_criteria": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_referral_include_criteria_val": {
+ "type": "string"
+ },
+ "include_obligations_partner_referral_include_pay_sch": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_referral_include_pay_sch_amount": {
+ "type": "number"
+ },
+ "include_obligations_partner_referral_include_pay_sch_custom": {
+ "type": "string"
+ },
+ "include_obligations_partner_referral_include_pay_sch_unit": {
+ "enum": [
+ "U.S. Dollars",
+ "percent"
+ ],
+ "type": "string"
+ },
+ "include_obligations_partner_sponsorship": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_sponsorship_include_benefits": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_sponsorship_include_benefits_val": {
+ "type": "string"
+ },
+ "include_obligations_partner_sponsorship_include_payments": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_sponsorship_include_payments_amount": {
+ "type": "number"
+ },
+ "include_obligations_partner_sponsorship_include_payments_unit": {
+ "enum": [
+ "U.S. Dollars",
+ "percent"
+ ],
+ "type": "string"
+ },
+ "include_payment_process": {
+ "type": "boolean"
+ },
+ "include_payment_process_company": {
+ "type": "boolean"
+ },
+ "include_payment_process_company_include_address": {
+ "type": "boolean"
+ },
+ "include_payment_process_company_include_address_city": {
+ "type": "string"
+ },
+ "include_payment_process_company_include_address_country": {
+ "type": "string"
+ },
+ "include_payment_process_company_include_address_state": {
+ "type": "string"
+ },
+ "include_payment_process_company_include_address_street_address": {
+ "type": "string"
+ },
+ "include_payment_process_company_include_address_zipcode": {
+ "type": "string"
+ },
+ "include_payment_process_company_include_email": {
+ "type": "boolean"
+ },
+ "include_payment_process_company_include_email_val": {
+ "type": "string"
+ },
+ "include_payment_process_partner": {
+ "type": "boolean"
+ },
+ "include_payment_process_partner_include_address": {
+ "type": "boolean"
+ },
+ "include_payment_process_partner_include_address_city": {
+ "type": "string"
+ },
+ "include_payment_process_partner_include_address_country": {
+ "type": "string"
+ },
+ "include_payment_process_partner_include_address_state": {
+ "type": "string"
+ },
+ "include_payment_process_partner_include_address_street_address": {
+ "type": "string"
+ },
+ "include_payment_process_partner_include_address_zipcode": {
+ "type": "string"
+ },
+ "include_payment_process_partner_include_email": {
+ "type": "boolean"
+ },
+ "include_payment_process_partner_include_email_val": {
+ "type": "string"
+ },
+ "include_payment_schedule": {
+ "type": "boolean"
+ },
+ "include_payment_schedule_custom": {
+ "type": "string"
+ },
+ "include_payment_schedule_specified_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_payment_schedule_specified_timeframe": {
+ "enum": [
+ "receipt",
+ "date"
+ ],
+ "type": "string"
+ },
+ "include_payment_schedule_specified_unit": {
+ "enum": [
+ "day(s)",
+ "week(s)",
+ "month(s)",
+ "quarter(s)",
+ "year(s)"
+ ],
+ "type": "string"
+ },
+ "include_payment_schedule_type": {
+ "enum": [
+ "specified",
+ "custom"
+ ],
+ "type": "string"
+ },
+ "negotiations_allowed": {
+ "description": "When true, the recipient can propose changes to the business terms, even when the agreement-level `negotiations_allowed` is false. This only covers the business terms.",
+ "type": "boolean"
+ },
+ "territory_type": {
+ "enum": [
+ "worldwide",
+ "custom"
+ ],
+ "type": "string"
+ },
+ "territory_type_val": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "payment_link_url": {
+ "description": "A payment URL shown to the recipient after signing. Requires include_billing_workflow to be true and billing_workflow_type to be \"link\".",
+ "type": "string"
+ },
+ "pilot_attributes": {
+ "additionalProperties": false,
+ "description": "Override pilot terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "fees_type": {
+ "enum": [
+ "free",
+ "pilot_period_fees"
+ ],
+ "type": "string"
+ },
+ "general_cap_amount": {
+ "type": "number"
+ },
+ "general_cap_amount_type": {
+ "enum": [
+ "preceding",
+ "base",
+ "period"
+ ],
+ "type": "string"
+ },
+ "general_cap_period_currency": {
+ "type": "number"
+ },
+ "general_cap_period_qty": {
+ "type": "number"
+ },
+ "general_cap_preceding_amount": {
+ "type": "number"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_dpa": {
+ "type": "boolean"
+ },
+ "include_dpa_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_dpa_location": {
+ "type": "string"
+ },
+ "include_dpa_type": {
+ "enum": [
+ "description",
+ "attachment",
+ "standard"
+ ],
+ "type": "string"
+ },
+ "include_payment_process": {
+ "type": "boolean"
+ },
+ "include_technical_support": {
+ "type": "boolean"
+ },
+ "payment_process_automatic_frequency": {
+ "enum": [
+ "monthly",
+ "quarterly",
+ "annually",
+ "once_per_period"
+ ],
+ "type": "string"
+ },
+ "payment_process_invoice_days": {
+ "type": "number"
+ },
+ "payment_process_invoice_from": {
+ "enum": [
+ "receipt",
+ "date"
+ ],
+ "type": "string"
+ },
+ "payment_process_invoice_timeframe": {
+ "enum": [
+ "days",
+ "weeks",
+ "months",
+ "quarters",
+ "years"
+ ],
+ "type": "string"
+ },
+ "payment_process_type": {
+ "enum": [
+ "automatic",
+ "invoice"
+ ],
+ "type": "string"
+ },
+ "pilot_period_description": {
+ "type": "string"
+ },
+ "pilot_period_fees_description": {
+ "type": "string"
+ },
+ "product_description": {
+ "type": "string"
+ },
+ "technical_support_description": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "psa_attributes": {
+ "additionalProperties": false,
+ "description": "Override psa terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "additional_changes": {
+ "type": "string"
+ },
+ "customer_description": {
+ "type": "string"
+ },
+ "effective_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "effective_date_type": {
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "type": "string"
+ },
+ "general_cap_amount": {
+ "type": "number"
+ },
+ "general_cap_amount_type": {
+ "enum": [
+ "preceding",
+ "base",
+ "period"
+ ],
+ "type": "string"
+ },
+ "general_cap_period_currency": {
+ "type": "number"
+ },
+ "general_cap_period_qty": {
+ "type": "number"
+ },
+ "general_cap_preceding_amount": {
+ "type": "number"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_additional_changes": {
+ "type": "boolean"
+ },
+ "include_additional_warranties": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_by_customer": {
+ "type": "string"
+ },
+ "include_additional_warranties_by_provider": {
+ "type": "string"
+ },
+ "include_additional_warranties_include_by_customer": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_include_by_provider": {
+ "type": "boolean"
+ },
+ "include_covered_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_customer_claims": {
+ "type": "string"
+ },
+ "include_covered_claims_include_customer_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_include_provider_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_provider_claims": {
+ "type": "string"
+ },
+ "include_customer_insurance_min": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_add_provider_com_gen_liability": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_add_provider_cyber_liability": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_add_provider_errors_omissions": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_auto_liability_aggregate": {
+ "type": "number"
+ },
+ "include_customer_insurance_min_auto_liability_minimum": {
+ "type": "number"
+ },
+ "include_customer_insurance_min_cyber_liability_aggregate": {
+ "type": "number"
+ },
+ "include_customer_insurance_min_cyber_liability_minimum": {
+ "type": "number"
+ },
+ "include_customer_insurance_min_employer_liability_aggregate": {
+ "type": "number"
+ },
+ "include_customer_insurance_min_employer_liability_minimum": {
+ "type": "number"
+ },
+ "include_customer_insurance_min_general_liability_aggregate": {
+ "type": "number"
+ },
+ "include_customer_insurance_min_general_liability_minimum": {
+ "type": "number"
+ },
+ "include_customer_insurance_min_include_add_provider": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_include_auto_liability": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_include_cyber_liability": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_include_employer_liability": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_include_general_liability": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_include_workers_comp": {
+ "type": "boolean"
+ },
+ "include_customer_policies": {
+ "type": "boolean"
+ },
+ "include_customer_policies_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_customer_policies_location": {
+ "type": "string"
+ },
+ "include_customer_policies_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_dpa": {
+ "type": "boolean"
+ },
+ "include_dpa_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_dpa_location": {
+ "type": "string"
+ },
+ "include_dpa_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_increased_cap_amount": {
+ "type": "boolean"
+ },
+ "include_increased_claims": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_confidentiality": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_confidentiality_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_privsec": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_privsec_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_other": {
+ "type": "boolean"
+ },
+ "include_increased_claims_indemnification_obligation": {
+ "type": "boolean"
+ },
+ "include_increased_claims_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_other": {
+ "type": "string"
+ },
+ "include_provider_insurance_min": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_add_customer_com_gen_liability": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_add_customer_cyber_liability": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_add_customer_errors_omissions": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_auto_liability_aggregate": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_auto_liability_minimum": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_cyber_liability_aggregate": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_cyber_liability_minimum": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_employer_liability_aggregate": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_employer_liability_minimum": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_general_liability_aggregate": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_general_liability_minimum": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_include_add_customer": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_include_auto_liability": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_include_cyber_liability": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_include_employer_liability": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_include_general_liability": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_include_workers_comp": {
+ "type": "boolean"
+ },
+ "include_publicity_rights": {
+ "type": "boolean"
+ },
+ "include_publicity_rights_type": {
+ "enum": [
+ "public",
+ "non-public"
+ ],
+ "type": "string"
+ },
+ "include_security_policy": {
+ "type": "boolean"
+ },
+ "include_security_policy_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_security_policy_fedramp_auth": {
+ "type": "boolean"
+ },
+ "include_security_policy_hitrust": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_annual_maintenance": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_other": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_other_val": {
+ "type": "string"
+ },
+ "include_security_policy_iso27001": {
+ "type": "boolean"
+ },
+ "include_security_policy_location": {
+ "type": "string"
+ },
+ "include_security_policy_pci1": {
+ "type": "boolean"
+ },
+ "include_security_policy_pci2": {
+ "type": "boolean"
+ },
+ "include_security_policy_penetration_testing": {
+ "type": "boolean"
+ },
+ "include_security_policy_soc2_type1": {
+ "type": "boolean"
+ },
+ "include_security_policy_soc2_type2": {
+ "type": "boolean"
+ },
+ "include_security_policy_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_unlimited_claims": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_confidentiality": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_confidentiality_negligence": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_privsec": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_privsec_negligence": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_include_other": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_indemnification_obligation": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_negligence": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_other": {
+ "type": "string"
+ },
+ "increased_cap_amount_currency": {
+ "type": "number"
+ },
+ "increased_cap_amount_period_currency": {
+ "type": "number"
+ },
+ "increased_cap_amount_period_qty": {
+ "type": "number"
+ },
+ "increased_cap_amount_qty": {
+ "type": "number"
+ },
+ "increased_cap_amount_type": {
+ "enum": [
+ "qty",
+ "currency",
+ "period"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "psa_statement_of_work_attributes": {
+ "additionalProperties": false,
+ "description": "Override psa statement of work terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "additional_changes": {
+ "type": "string"
+ },
+ "cost": {
+ "type": "number"
+ },
+ "description": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "fees_attributes": {
+ "additionalProperties": {
+ "anyOf": [
+ {
+ "additionalProperties": false,
+ "description": "Fees::Flat (fee_type \"flat\"). A fixed recurring fee, e.g. a platform subscription. Set type to \"Fees::Flat\" or fee_type to \"flat\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Fixed amount in the order form's fees_currency, charged per fee_period. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"flat\". Alternative to type.",
+ "enum": [
+ "flat"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Flat\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Flat"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Discount (fee_type \"discount\"). A discount, as a fixed amount or a percentage, applied forever, once, or for a number of months. Set type to \"Fees::Discount\" or fee_type to \"discount\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Discount size: an amount in fees_currency when discount_type is fixed_amount (a plain amount, not cents: 20 means 20.00), or a percentage (e.g. 10 for 10%) when it is percentage.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "discount_duration_amount": {
+ "description": "Number of months the discount applies. Required when discount_duration_type is multiple_months.",
+ "type": "number"
+ },
+ "discount_duration_type": {
+ "description": "How long the discount applies. multiple_months also needs discount_duration_amount.",
+ "enum": [
+ "forever",
+ "once",
+ "multiple_months"
+ ],
+ "type": "string"
+ },
+ "discount_type": {
+ "description": "Whether cost is a currency amount or a percentage.",
+ "enum": [
+ "fixed_amount",
+ "percentage"
+ ],
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"discount\". Alternative to type.",
+ "enum": [
+ "discount"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Discount\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Discount"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Cost (fee_type \"cost\"). A per-unit fee: price per unit times quantity, e.g. seats. Set type to \"Fees::Cost\" or fee_type to \"cost\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Price per unit in fees_currency. The row total is quantity x cost. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"cost\". Alternative to type.",
+ "enum": [
+ "cost"
+ ],
+ "type": "string"
+ },
+ "quantity": {
+ "description": "Number of units.",
+ "type": "number"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Cost\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Cost"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Attachment (fee_type \"attachment\"). A fee described in an uploaded attachment instead of in the table. Set type to \"Fees::Attachment\" or fee_type to \"attachment\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "attachment_id": {
+ "description": "ID of an attachment uploaded with upload-attachment.",
+ "type": "string"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"attachment\". Alternative to type.",
+ "enum": [
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Attachment\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Attachment"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Graduated (fee_type \"graduated\"). Tiered pricing, with the price set per tier in graduated_fee_tiers_attributes. Set type to \"Fees::Graduated\" or fee_type to \"graduated\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"graduated\". Alternative to type.",
+ "enum": [
+ "graduated"
+ ],
+ "type": "string"
+ },
+ "graduated_fee_tiers_attributes": {
+ "additionalProperties": {
+ "additionalProperties": false,
+ "properties": {
+ "flat_price": {
+ "type": "number"
+ },
+ "price_per_unit": {
+ "type": "string"
+ },
+ "upper_limit": {
+ "type": "number"
+ }
+ },
+ "type": "object"
+ },
+ "description": "Graduated fee tiers. Use string keys such as \"0\", \"1\".",
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Graduated\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Graduated"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Included (fee_type \"included\"). An item included at no charge. Set type to \"Fees::Included\" or fee_type to \"included\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"included\". Alternative to type.",
+ "enum": [
+ "included"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Included\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Included"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Metered (fee_type \"metered\"). Usage-based pricing, billed per unit used. Set type to \"Fees::Metered\" or fee_type to \"metered\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Price per unit of usage in fees_currency. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"metered\". Alternative to type.",
+ "enum": [
+ "metered"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Metered\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Metered"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::OneTime (fee_type \"one_time\"). A one-time charge, such as a setup fee. Set type to \"Fees::OneTime\" or fee_type to \"one_time\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "One-time amount in fees_currency, charged once rather than per fee_period. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"one_time\". Alternative to type.",
+ "enum": [
+ "one_time"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::OneTime\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::OneTime"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Text (fee_type \"text\"). A fee term described in free text. Set type to \"Fees::Text\" or fee_type to \"text\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"text\". Alternative to type.",
+ "enum": [
+ "text"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Text\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Text"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ }
+ ]
+ },
+ "description": "Fee line items. Use string keys such as \"0\", \"1\". Replaces template fees when provided.",
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_additional_changes": {
+ "type": "boolean"
+ },
+ "include_customer_obligation": {
+ "type": "boolean"
+ },
+ "include_customer_obligation_val": {
+ "type": "string"
+ },
+ "include_deliverables": {
+ "type": "boolean"
+ },
+ "include_deliverables_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_deliverables_description": {
+ "type": "string"
+ },
+ "include_deliverables_include_acceptance": {
+ "type": "boolean"
+ },
+ "include_deliverables_include_attachment": {
+ "type": "boolean"
+ },
+ "include_deliverables_include_draft_deliverables": {
+ "type": "boolean"
+ },
+ "include_deliverables_rejection_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_deliverables_rejection_unit": {
+ "enum": [
+ "hours",
+ "days",
+ "weeks",
+ "months"
+ ],
+ "type": "string"
+ },
+ "include_deliverables_resubmission_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_deliverables_resubmission_unit": {
+ "enum": [
+ "hours",
+ "days",
+ "weeks",
+ "months"
+ ],
+ "type": "string"
+ },
+ "include_fees_other": {
+ "type": "boolean"
+ },
+ "include_fees_other_val": {
+ "type": "string"
+ },
+ "include_fees_table": {
+ "type": "boolean"
+ },
+ "include_fees_table_total": {
+ "type": "boolean"
+ },
+ "include_fees_travel": {
+ "type": "boolean"
+ },
+ "include_fees_travel_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_fees_travel_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_fees_travel_val": {
+ "type": "string"
+ },
+ "include_third_party_customer": {
+ "type": "boolean"
+ },
+ "include_third_party_include_description": {
+ "type": "boolean"
+ },
+ "include_third_party_include_description_val": {
+ "type": "string"
+ },
+ "include_third_party_materials": {
+ "type": "boolean"
+ },
+ "include_third_party_provider": {
+ "type": "boolean"
+ },
+ "include_time_of_assignment": {
+ "type": "boolean"
+ },
+ "include_time_of_assignment_type": {
+ "enum": [
+ "created",
+ "paid"
+ ],
+ "type": "string"
+ },
+ "invoice_period_description": {
+ "type": "string"
+ },
+ "negotiations_allowed": {
+ "description": "When true, the recipient can propose changes to the statement of work, even when the agreement-level `negotiations_allowed` is false. This only covers the statement of work.",
+ "type": "boolean"
+ },
+ "payment_period": {
+ "type": "number"
+ },
+ "payment_period_other": {
+ "type": "string"
+ },
+ "payment_period_timeframe": {
+ "enum": [
+ "receipt",
+ "invoice",
+ "Customer's receipt of invoice",
+ "date of invoice"
+ ],
+ "type": "string"
+ },
+ "payment_period_type": {
+ "enum": [
+ "standard",
+ "other"
+ ],
+ "type": "string"
+ },
+ "payment_period_unit": {
+ "enum": [
+ "day(s)",
+ "week(s)",
+ "month(s)",
+ "quarter(s)",
+ "year(s)"
+ ],
+ "type": "string"
+ },
+ "quantity": {
+ "type": "number"
+ },
+ "services_description": {
+ "type": "string"
+ },
+ "sow_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "sow_date_type": {
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "type": "string"
+ },
+ "sow_term_amount": {
+ "type": "number"
+ },
+ "sow_term_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "sow_term_type": {
+ "enum": [
+ "deliverables",
+ "period",
+ "date"
+ ],
+ "type": "string"
+ },
+ "sow_term_unit": {
+ "enum": [
+ "month(s)",
+ "quarter(s)",
+ "year(s)"
+ ],
+ "type": "string"
+ },
+ "type": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "recipient_email": {
+ "format": "email",
+ "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "recipient_name": {
+ "type": "string"
+ },
+ "recipient_notice_email_address": {
+ "description": "Email address for legal notices to the recipient.",
+ "format": "email",
+ "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "recipient_organization": {
+ "type": "string"
+ },
+ "recipient_role": {
+ "description": "PSA only. The recipient's role: `Customer` (the default) or `Provider`. Send it with `sender_role`; the two must be one `Provider` and one `Customer`. Other standard agreement types ignore it.",
+ "type": "string"
+ },
+ "sender_last_to_sign": {
+ "description": "When true, your signer signs after the recipient.",
+ "type": "boolean"
+ },
+ "sender_notice_email_address": {
+ "description": "Email address for legal notices to the sender.",
+ "format": "email",
+ "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "sender_role": {
+ "description": "PSA only. Your company's role: `Provider` (the default) or `Customer` when you hire the recipient to provide the services. Send it with `recipient_role`; the two must be one `Provider` and one `Customer`. When reading a PSA, an empty `sender_role` means `Provider`. Other standard agreement types ignore it.",
+ "type": "string"
+ },
+ "software_license_attributes": {
+ "additionalProperties": false,
+ "description": "Override software license terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "effective_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "effective_date_type": {
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "type": "string"
+ },
+ "general_cap_amount": {
+ "type": "number"
+ },
+ "general_cap_amount_type": {
+ "enum": [
+ "preceding",
+ "base",
+ "period"
+ ],
+ "type": "string"
+ },
+ "general_cap_period_currency": {
+ "type": "number"
+ },
+ "general_cap_period_qty": {
+ "type": "number"
+ },
+ "general_cap_preceding_amount": {
+ "type": "number"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_additional_warranties": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_by_customer": {
+ "type": "string"
+ },
+ "include_additional_warranties_by_provider": {
+ "type": "string"
+ },
+ "include_additional_warranties_include_by_customer": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_include_by_provider": {
+ "type": "boolean"
+ },
+ "include_ai_addendum": {
+ "type": "boolean"
+ },
+ "include_ai_addendum_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_covered_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_customer_claims": {
+ "type": "string"
+ },
+ "include_covered_claims_include_customer_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_include_provider_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_provider_claims": {
+ "type": "string"
+ },
+ "include_dpa": {
+ "type": "boolean"
+ },
+ "include_dpa_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_dpa_location": {
+ "type": "string"
+ },
+ "include_dpa_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_increased_cap_amount": {
+ "type": "boolean"
+ },
+ "include_increased_claims": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_confidentiality": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_confidentiality_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_other": {
+ "type": "boolean"
+ },
+ "include_increased_claims_indemnification_obligation": {
+ "type": "boolean"
+ },
+ "include_increased_claims_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_other": {
+ "type": "string"
+ },
+ "include_increased_claims_restrictions": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_confidentiality": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_confidentiality_negligence": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_include_other": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_indemnification_obligation": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_license_or_restrictions": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_negligence": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_other": {
+ "type": "string"
+ },
+ "increased_cap_amount_currency": {
+ "type": "number"
+ },
+ "increased_cap_amount_period_currency": {
+ "type": "number"
+ },
+ "increased_cap_amount_period_qty": {
+ "type": "number"
+ },
+ "increased_cap_amount_qty": {
+ "type": "number"
+ },
+ "increased_cap_amount_type": {
+ "enum": [
+ "qty",
+ "currency",
+ "period"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "software_license_order_form_attributes": {
+ "additionalProperties": false,
+ "description": "Override software license order form terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "additional_changes": {
+ "type": "string"
+ },
+ "deletion_procedure_include_custom": {
+ "type": "boolean"
+ },
+ "deletion_procedure_include_custom_description": {
+ "type": "string"
+ },
+ "deletion_procedure_include_customer_disable": {
+ "type": "boolean"
+ },
+ "deletion_procedure_include_customer_proof": {
+ "type": "boolean"
+ },
+ "deletion_procedure_include_provider_disable": {
+ "type": "boolean"
+ },
+ "fee_custom_unit": {
+ "type": "string"
+ },
+ "fee_period": {
+ "enum": [
+ "Subscription Period",
+ "month",
+ "year",
+ "Custom unit"
+ ],
+ "type": "string"
+ },
+ "fees_attributes": {
+ "additionalProperties": {
+ "anyOf": [
+ {
+ "additionalProperties": false,
+ "description": "Fees::Flat (fee_type \"flat\"). A fixed recurring fee, e.g. a platform subscription. Set type to \"Fees::Flat\" or fee_type to \"flat\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Fixed amount in the order form's fees_currency, charged per fee_period. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"flat\". Alternative to type.",
+ "enum": [
+ "flat"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Flat\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Flat"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Discount (fee_type \"discount\"). A discount, as a fixed amount or a percentage, applied forever, once, or for a number of months. Set type to \"Fees::Discount\" or fee_type to \"discount\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Discount size: an amount in fees_currency when discount_type is fixed_amount (a plain amount, not cents: 20 means 20.00), or a percentage (e.g. 10 for 10%) when it is percentage.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "discount_duration_amount": {
+ "description": "Number of months the discount applies. Required when discount_duration_type is multiple_months.",
+ "type": "number"
+ },
+ "discount_duration_type": {
+ "description": "How long the discount applies. multiple_months also needs discount_duration_amount.",
+ "enum": [
+ "forever",
+ "once",
+ "multiple_months"
+ ],
+ "type": "string"
+ },
+ "discount_type": {
+ "description": "Whether cost is a currency amount or a percentage.",
+ "enum": [
+ "fixed_amount",
+ "percentage"
+ ],
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"discount\". Alternative to type.",
+ "enum": [
+ "discount"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Discount\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Discount"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Cost (fee_type \"cost\"). A per-unit fee: price per unit times quantity, e.g. seats. Set type to \"Fees::Cost\" or fee_type to \"cost\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Price per unit in fees_currency. The row total is quantity x cost. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"cost\". Alternative to type.",
+ "enum": [
+ "cost"
+ ],
+ "type": "string"
+ },
+ "quantity": {
+ "description": "Number of units.",
+ "type": "number"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Cost\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Cost"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Attachment (fee_type \"attachment\"). A fee described in an uploaded attachment instead of in the table. Set type to \"Fees::Attachment\" or fee_type to \"attachment\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "attachment_id": {
+ "description": "ID of an attachment uploaded with upload-attachment.",
+ "type": "string"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"attachment\". Alternative to type.",
+ "enum": [
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Attachment\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Attachment"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Graduated (fee_type \"graduated\"). Tiered pricing, with the price set per tier in graduated_fee_tiers_attributes. Set type to \"Fees::Graduated\" or fee_type to \"graduated\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"graduated\". Alternative to type.",
+ "enum": [
+ "graduated"
+ ],
+ "type": "string"
+ },
+ "graduated_fee_tiers_attributes": {
+ "additionalProperties": {
+ "additionalProperties": false,
+ "properties": {
+ "flat_price": {
+ "type": "number"
+ },
+ "price_per_unit": {
+ "type": "string"
+ },
+ "upper_limit": {
+ "type": "number"
+ }
+ },
+ "type": "object"
+ },
+ "description": "Graduated fee tiers. Use string keys such as \"0\", \"1\".",
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Graduated\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Graduated"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Included (fee_type \"included\"). An item included at no charge. Set type to \"Fees::Included\" or fee_type to \"included\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"included\". Alternative to type.",
+ "enum": [
+ "included"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Included\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Included"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Metered (fee_type \"metered\"). Usage-based pricing, billed per unit used. Set type to \"Fees::Metered\" or fee_type to \"metered\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Price per unit of usage in fees_currency. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"metered\". Alternative to type.",
+ "enum": [
+ "metered"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Metered\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Metered"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::OneTime (fee_type \"one_time\"). A one-time charge, such as a setup fee. Set type to \"Fees::OneTime\" or fee_type to \"one_time\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "One-time amount in fees_currency, charged once rather than per fee_period. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"one_time\". Alternative to type.",
+ "enum": [
+ "one_time"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::OneTime\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::OneTime"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Text (fee_type \"text\"). A fee term described in free text. Set type to \"Fees::Text\" or fee_type to \"text\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"text\". Alternative to type.",
+ "enum": [
+ "text"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Text\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Text"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ }
+ ]
+ },
+ "description": "Fee line items. Use string keys such as \"0\", \"1\". Replaces template fees when provided.",
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+ },
+ "fees_currency": {
+ "enum": [
+ "USD",
+ "EUR",
+ "GBP",
+ "CAD",
+ "AUD",
+ "SGD",
+ "ILS",
+ "JPY",
+ "CHF",
+ "HKD"
+ ],
+ "type": "string"
+ },
+ "fees_include_fee_increase_upon_renewal": {
+ "type": "boolean"
+ },
+ "fees_include_fee_increase_upon_renewal_fee": {
+ "type": "number"
+ },
+ "fees_include_fee_increase_upon_renewal_type": {
+ "enum": [
+ "will",
+ "may"
+ ],
+ "type": "string"
+ },
+ "fees_inclusive_of_taxes": {
+ "type": "boolean"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_additional_changes": {
+ "type": "boolean"
+ },
+ "include_license_compliance_verification": {
+ "type": "boolean"
+ },
+ "include_license_compliance_verification_description": {
+ "type": "string"
+ },
+ "include_license_limits": {
+ "type": "boolean"
+ },
+ "include_license_limits_description": {
+ "type": "string"
+ },
+ "include_payment_process_include_billing_email": {
+ "type": "boolean"
+ },
+ "include_pilot_period": {
+ "type": "boolean"
+ },
+ "include_pilot_period_duration_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_pilot_period_duration_type": {
+ "enum": [
+ "day",
+ "week",
+ "month"
+ ],
+ "type": "string"
+ },
+ "include_pilot_period_include_fees": {
+ "type": "boolean"
+ },
+ "include_pilot_period_include_fees_amount": {
+ "type": "number"
+ },
+ "include_pilot_period_include_modifications": {
+ "type": "boolean"
+ },
+ "include_pilot_period_include_modifications_description": {
+ "type": "string"
+ },
+ "include_services": {
+ "type": "boolean"
+ },
+ "include_services_description": {
+ "type": "string"
+ },
+ "negotiations_allowed": {
+ "description": "When true, the recipient can propose changes to the order form, even when the agreement-level `negotiations_allowed` is false. This only covers the order form.",
+ "type": "boolean"
+ },
+ "order_date_date": {
+ "type": "string"
+ },
+ "order_date_type": {
+ "enum": [
+ "signature",
+ "date",
+ "other"
+ ],
+ "type": "string"
+ },
+ "payment_process_automatic_frequency": {
+ "enum": [
+ "monthly",
+ "quarterly",
+ "semiannually",
+ "annually"
+ ],
+ "type": "string"
+ },
+ "payment_process_type": {
+ "enum": [
+ "automatic",
+ "invoice",
+ "custom"
+ ],
+ "type": "string"
+ },
+ "payment_process_type_custom_val": {
+ "type": "string"
+ },
+ "payment_process_type_invoice_amount": {
+ "type": "number"
+ },
+ "payment_process_type_invoice_custom_unit": {
+ "type": "string"
+ },
+ "payment_process_type_invoice_duration": {
+ "enum": [
+ "day",
+ "week",
+ "month",
+ "year",
+ "day(s)",
+ "week(s)",
+ "month(s)",
+ "year(s)"
+ ],
+ "type": "string"
+ },
+ "payment_process_type_invoice_duration_start": {
+ "enum": [
+ "Customer's receipt of invoice",
+ "date of invoice"
+ ],
+ "type": "string"
+ },
+ "payment_process_type_invoice_type": {
+ "enum": [
+ "monthly",
+ "quarterly",
+ "semiannually",
+ "annually",
+ "Custom unit"
+ ],
+ "type": "string"
+ },
+ "permitted_uses_include_custom": {
+ "type": "boolean"
+ },
+ "permitted_uses_include_custom_description": {
+ "type": "string"
+ },
+ "permitted_uses_include_customers_affiliates": {
+ "type": "boolean"
+ },
+ "permitted_uses_include_internal_business": {
+ "type": "boolean"
+ },
+ "pilot_period_stripe_product_id": {
+ "type": "string"
+ },
+ "software_description": {
+ "type": "string"
+ },
+ "subscription_auto_renew": {
+ "enum": [
+ "days",
+ "subscription_end"
+ ],
+ "type": "string"
+ },
+ "subscription_period": {
+ "type": "number"
+ },
+ "subscription_period_unit": {
+ "type": "string"
+ },
+ "subscription_renewal_notice_days": {
+ "type": "number"
+ },
+ "warranty_period_description_amount": {
+ "type": "number"
+ },
+ "warranty_period_description_duration": {
+ "enum": [
+ "day",
+ "week",
+ "month",
+ "year"
+ ],
+ "type": "string"
+ },
+ "warranty_period_description_duration_start": {
+ "enum": [
+ "initial delivery of the Software",
+ "delivery of the Software and each subsequent Update",
+ "the Order Date"
+ ],
+ "type": "string"
+ },
+ "warranty_period_type": {
+ "enum": [
+ "description",
+ "none"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "test_agreement": {
+ "description": "When true, marks the agreement as a test. Test agreements do not count against your monthly limit.",
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "recipient_name",
+ "recipient_email"
+ ],
+ "type": "object"
+ },
+ "cc_users": {
+ "items": {
+ "format": "email",
+ "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "draft": {
+ "description": "When true, the agreement is saved as a draft and not sent to the recipient. Use POST /v1/agreements/{id}/send to send a draft agreement later.",
+ "type": "boolean"
+ },
+ "owner_id": {
+ "description": "User id of the agreement owner (sender).",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "signer_id": {
+ "description": "User id of the signer from the owner's organization.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "template_id": {
+ "description": "UUID of a template from `GET /v1/templates`. Accepts both Common Paper standard templates and uploaded PDF templates (`type` `uploaded_template`).",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ }
+ },
+ "required": [
+ "template_id",
+ "owner_id",
+ "signer_id",
+ "agreement"
+ ],
+ "type": "object"
+ }
+]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-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": {
- "enum": [
- "signature",
- "date"
- ],
- "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.",
- "enum": [
- "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": {
- "enum": [
- "stripe",
- "link"
- ],
- "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-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": {
- "enum": [
- "AWS",
- "GCP",
- "Azure"
- ],
- "type": "string"
- },
- "effective_date_type": {
- "enum": [
- "signature",
- "date",
- "marketplace_acceptance"
- ],
- "type": "string"
- },
- "general_cap_amount": {
- "type": "number"
- },
- "general_cap_amount_type": {
- "enum": [
- "preceding",
- "base",
- "period"
- ],
- "type": "string"
- },
- "general_cap_period_currency": {
- "type": "number"
- },
- "general_cap_period_qty": {
- "type": "number"
- },
- "general_cap_preceding_amount": {
- "type": "number"
- },
- "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": {
- "enum": [
- "description",
- "attachment"
- ],
- "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": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_increased_cap_amount": {
- "type": "boolean"
- },
- "include_increased_claims": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_confidentiality": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_confidentiality_negligence": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_privsec": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_privsec_negligence": {
- "type": "boolean"
- },
- "include_increased_claims_include_other": {
- "type": "boolean"
- },
- "include_increased_claims_indemnification_obligation": {
- "type": "boolean"
- },
- "include_increased_claims_other": {
- "type": "string"
- },
- "include_insurance_minimums": {
- "type": "boolean"
- },
- "include_insurance_minimums_add_customer": {
- "type": "boolean"
- },
- "include_insurance_minimums_add_customer_com_gen_liability": {
- "type": "boolean"
- },
- "include_insurance_minimums_add_customer_cyber_liability": {
- "type": "boolean"
- },
- "include_insurance_minimums_add_customer_errors_omissions": {
- "type": "boolean"
- },
- "include_insurance_minimums_additional_information": {
- "type": "boolean"
- },
- "include_insurance_minimums_additional_information_text": {
- "type": "string"
- },
- "include_insurance_minimums_cyber_liability_aggregate": {
- "type": "number"
- },
- "include_insurance_minimums_cyber_liability_minimum": {
- "type": "number"
- },
- "include_insurance_minimums_employer_liability_aggregate": {
- "type": "number"
- },
- "include_insurance_minimums_employer_liability_minimum": {
- "type": "number"
- },
- "include_insurance_minimums_general_liability_aggregate": {
- "type": "number"
- },
- "include_insurance_minimums_general_liability_minimum": {
- "type": "number"
- },
- "include_insurance_minimums_include_cyber_liability": {
- "type": "boolean"
- },
- "include_insurance_minimums_include_employer_liability": {
- "type": "boolean"
- },
- "include_insurance_minimums_include_general_liability": {
- "type": "boolean"
- },
- "include_insurance_minimums_include_workers_compensation": {
- "type": "boolean"
- },
- "include_publicity_rights": {
- "type": "boolean"
- },
- "include_publicity_rights_type": {
- "enum": [
- "public",
- "non-public"
- ],
- "type": "string"
- },
- "include_security_policy": {
- "type": "boolean"
- },
- "include_security_policy_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_security_policy_fedramp_auth": {
- "type": "boolean"
- },
- "include_security_policy_hipaa": {
- "type": "boolean"
- },
- "include_security_policy_hitrust": {
- "type": "boolean"
- },
- "include_security_policy_include_annual_maintenance": {
- "type": "boolean"
- },
- "include_security_policy_include_location": {
- "type": "boolean"
- },
- "include_security_policy_include_other": {
- "type": "boolean"
- },
- "include_security_policy_include_reasonable_efforts": {
- "type": "boolean"
- },
- "include_security_policy_iso27001": {
- "type": "boolean"
- },
- "include_security_policy_location": {
- "type": "string"
- },
- "include_security_policy_other": {
- "type": "string"
- },
- "include_security_policy_pci1": {
- "type": "boolean"
- },
- "include_security_policy_pci2": {
- "type": "boolean"
- },
- "include_security_policy_penetration_testing": {
- "type": "boolean"
- },
- "include_security_policy_soc2": {
- "type": "boolean"
- },
- "include_security_policy_soc2_type2": {
- "type": "boolean"
- },
- "include_security_policy_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_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": {
- "type": "number"
- },
- "increased_cap_amount_qty": {
- "type": "number"
- },
- "increased_cap_amount_type": {
- "enum": [
- "qty",
- "currency",
- "period"
- ],
- "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": {
- "enum": [
- "automatic",
- "invoice"
- ],
- "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": {
- "enum": [
- "Subscription Period",
- "month",
- "year",
- "User",
- "Custom unit"
- ],
- "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": {
- "enum": [
- "USD",
- "EUR",
- "GBP",
- "CAD",
- "AUD",
- "SGD",
- "ILS",
- "JPY",
- "CHF",
- "HKD"
- ],
- "type": "string"
- },
- "fees_include_fee_increase_upon_renewal": {
- "type": "boolean"
- },
- "fees_include_fee_increase_upon_renewal_fee": {
- "type": "number"
- },
- "fees_include_fee_increase_upon_renewal_type": {
- "enum": [
- "will",
- "may"
- ],
- "type": "string"
- },
- "fees_inclusive_of_taxes": {
- "type": "boolean"
- },
- "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": {
- "enum": [
- "Subscription Period",
- "month",
- "year",
- "User"
- ],
- "type": "string"
- },
- "include_free_trial": {
- "type": "boolean"
- },
- "include_max_users": {
- "type": "boolean"
- },
- "include_pilot_period": {
- "type": "boolean"
- },
- "include_pilot_period_duration_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_pilot_period_duration_type": {
- "enum": [
- "day",
- "week",
- "month"
- ],
- "type": "string"
- },
- "include_pilot_period_include_fees": {
- "type": "boolean"
- },
- "include_pilot_period_include_fees_amount": {
- "type": "number"
- },
- "include_pilot_period_include_modifications": {
- "type": "boolean"
- },
- "include_pilot_period_include_modifications_description": {
- "type": "string"
- },
- "include_product_support": {
- "type": "boolean"
- },
- "include_product_support_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_product_support_description": {
- "type": "string"
- },
- "include_product_support_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_professional_services": {
- "type": "boolean"
- },
- "include_professional_services_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_professional_services_custom_name": {
- "type": "string"
- },
- "include_professional_services_description": {
- "type": "string"
- },
- "include_professional_services_end_date": {
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "include_professional_services_fees_description": {
- "type": "string"
- },
- "include_professional_services_include_end_date": {
- "type": "boolean"
- },
- "include_professional_services_include_fees_description": {
- "type": "boolean"
- },
- "include_professional_services_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_sla": {
- "type": "boolean"
- },
- "include_sla_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_sla_description": {
- "type": "string"
- },
- "include_sla_include_response_time": {
- "type": "boolean"
- },
- "include_sla_include_response_time_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_sla_include_response_time_credit": {
- "type": "number"
- },
- "include_sla_include_response_time_duration": {
- "enum": [
- "hour",
- "day",
- "week",
- "month",
- "hours"
- ],
- "type": "string"
- },
- "include_sla_include_response_time_support_channel": {
- "type": "string"
- },
- "include_sla_include_target_uptime": {
- "type": "boolean"
- },
- "include_sla_maintenance_notice": {
- "type": "boolean"
- },
- "include_sla_maintenance_window": {
- "type": "boolean"
- },
- "include_sla_maintenance_window_type": {
- "enum": [
- "standard",
- "none"
- ],
- "type": "string"
- },
- "include_sla_standard_maintenance_notice_qty": {
- "type": "number"
- },
- "include_sla_standard_maintenance_notice_unit": {
- "enum": [
- "hour",
- "day",
- "week",
- "month"
- ],
- "type": "string"
- },
- "include_sla_standard_maintenance_window_end_time": {
- "type": "string"
- },
- "include_sla_standard_maintenance_window_friday": {
- "type": "boolean"
- },
- "include_sla_standard_maintenance_window_monday": {
- "type": "boolean"
- },
- "include_sla_standard_maintenance_window_saturday": {
- "type": "boolean"
- },
- "include_sla_standard_maintenance_window_start_time": {
- "type": "string"
- },
- "include_sla_standard_maintenance_window_sunday": {
- "type": "boolean"
- },
- "include_sla_standard_maintenance_window_thursday": {
- "type": "boolean"
- },
- "include_sla_standard_maintenance_window_time_zone": {
- "type": "string"
- },
- "include_sla_standard_maintenance_window_tuesday": {
- "type": "boolean"
- },
- "include_sla_standard_maintenance_window_wednesday": {
- "type": "boolean"
- },
- "include_sla_standard_target_uptime": {
- "type": "number"
- },
- "include_sla_type": {
- "enum": [
- "description",
- "standard",
- "attachment"
- ],
- "type": "string"
- },
- "include_subscription_start_date": {
- "type": "boolean"
- },
- "include_subscription_start_date_date": {
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "include_usage_review": {
- "type": "boolean"
- },
- "include_usage_review_val": {
- "type": "string"
- },
- "include_use_limitations": {
- "type": "boolean"
- },
- "include_use_limitations_val": {
- "type": "string"
- },
- "invoice_period": {
- "enum": [
- "monthly",
- "quarterly",
- "semiannually",
- "annually",
- "Custom unit",
- "Monthly",
- "Quarterly",
- "Semiannually",
- "Annually"
- ],
- "type": "string"
- },
- "invoice_period_custom_unit": {
- "type": "string"
- },
- "max_consumption": {
- "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": {
- "enum": [
- "signature",
- "date",
- "other"
- ],
- "type": "string"
- },
- "payment_period": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "payment_period_timeframe": {
- "enum": [
- "Customer's receipt of invoice",
- "date of invoice"
- ],
- "type": "string"
- },
- "payment_period_unit": {
- "enum": [
- "day(s)",
- "week(s)",
- "month(s)",
- "marketplace_acceptance"
- ],
- "type": "string"
- },
- "payment_process_automatic_frequency": {
- "enum": [
- "monthly",
- "quarterly",
- "semiannually",
- "annually"
- ],
- "type": "string"
- },
- "payment_process_type": {
- "enum": [
- "automatic",
- "invoice",
- "custom",
- "marketplace_acceptance"
- ],
- "type": "string"
- },
- "payment_process_type_custom_val": {
- "type": "string"
- },
- "payment_process_type_invoice_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "payment_process_type_invoice_custom_unit": {
- "type": "string"
- },
- "payment_process_type_invoice_duration": {
- "enum": [
- "day",
- "week",
- "month",
- "year",
- "day(s)",
- "week(s)",
- "month(s)",
- "year(s)"
- ],
- "type": "string"
- },
- "payment_process_type_invoice_duration_start": {
- "enum": [
- "Customer's receipt of invoice",
- "date of invoice"
- ],
- "type": "string"
- },
- "payment_process_type_invoice_type": {
- "enum": [
- "monthly",
- "quarterly",
- "semiannually",
- "annually",
- "Custom unit"
- ],
- "type": "string"
- },
- "pilot_period_stripe_product_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-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": {
- "enum": [
- "days",
- "subscription_end"
- ],
- "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": {
- "enum": [
- "effective_date",
- "date"
- ],
- "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.",
- "enum": [
- "CSA"
- ],
- "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-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-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.",
- "enum": [
- "DPA"
- ],
- "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-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": {
- "enum": [
- "signature",
- "date"
- ],
- "type": "string"
- },
- "general_cap_amount": {
- "type": "number"
- },
- "general_cap_amount_type": {
- "enum": [
- "preceding",
- "base",
- "period"
- ],
- "type": "string"
- },
- "general_cap_period_currency": {
- "type": "number"
- },
- "general_cap_period_qty": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "general_cap_preceding_amount": {
- "type": "number"
- },
- "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": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_dpa": {
- "type": "boolean"
- },
- "include_dpa_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_dpa_location": {
- "type": "string"
- },
- "include_dpa_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_increased_cap_amount": {
- "type": "boolean"
- },
- "include_increased_claims": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_confidentiality": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_confidentiality_negligence": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_privsec": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_privsec_negligence": {
- "type": "boolean"
- },
- "include_increased_claims_include_other": {
- "type": "boolean"
- },
- "include_increased_claims_indemnification_obligation": {
- "type": "boolean"
- },
- "include_increased_claims_negligence": {
- "type": "boolean"
- },
- "include_increased_claims_other": {
- "type": "string"
- },
- "include_provider_insurance_min": {
- "type": "boolean"
- },
- "include_provider_insurance_min_add_customer_com_gen_liability": {
- "type": "boolean"
- },
- "include_provider_insurance_min_add_customer_cyber_liability": {
- "type": "boolean"
- },
- "include_provider_insurance_min_add_customer_errors_omissions": {
- "type": "boolean"
- },
- "include_provider_insurance_min_auto_liability_aggregate": {
- "type": "number"
- },
- "include_provider_insurance_min_auto_liability_minimum": {
- "type": "number"
- },
- "include_provider_insurance_min_cyber_liability_aggregate": {
- "type": "number"
- },
- "include_provider_insurance_min_cyber_liability_minimum": {
- "type": "number"
- },
- "include_provider_insurance_min_employer_liability_aggregate": {
- "type": "number"
- },
- "include_provider_insurance_min_employer_liability_minimum": {
- "type": "number"
- },
- "include_provider_insurance_min_general_liability_aggregate": {
- "type": "number"
- },
- "include_provider_insurance_min_general_liability_minimum": {
- "type": "number"
- },
- "include_provider_insurance_min_include_add_customer": {
- "type": "boolean"
- },
- "include_provider_insurance_min_include_auto_liability": {
- "type": "boolean"
- },
- "include_provider_insurance_min_include_cyber_liability": {
- "type": "boolean"
- },
- "include_provider_insurance_min_include_employer_liability": {
- "type": "boolean"
- },
- "include_provider_insurance_min_include_general_liability": {
- "type": "boolean"
- },
- "include_provider_insurance_min_include_workers_comp": {
- "type": "boolean"
- },
- "include_publicity_rights": {
- "type": "boolean"
- },
- "include_publicity_rights_type": {
- "enum": [
- "public",
- "non-public"
- ],
- "type": "string"
- },
- "include_security_policy": {
- "type": "boolean"
- },
- "include_security_policy_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_security_policy_fedramp_auth": {
- "type": "boolean"
- },
- "include_security_policy_hitrust": {
- "type": "boolean"
- },
- "include_security_policy_include_annual_maintenance": {
- "type": "boolean"
- },
- "include_security_policy_include_other": {
- "type": "boolean"
- },
- "include_security_policy_include_other_val": {
- "type": "string"
- },
- "include_security_policy_iso27001": {
- "type": "boolean"
- },
- "include_security_policy_location": {
- "type": "string"
- },
- "include_security_policy_pci1": {
- "type": "boolean"
- },
- "include_security_policy_pci2": {
- "type": "boolean"
- },
- "include_security_policy_penetration_testing": {
- "type": "boolean"
- },
- "include_security_policy_soc2_type1": {
- "type": "boolean"
- },
- "include_security_policy_soc2_type2": {
- "type": "boolean"
- },
- "include_security_policy_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_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": {
- "enum": [
- "qty",
- "currency",
- "period"
- ],
- "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": {
- "enum": [
- "hours",
- "days",
- "weeks",
- "months"
- ],
- "type": "string"
- },
- "include_deliverables_resubmission_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_deliverables_resubmission_unit": {
- "enum": [
- "hours",
- "days",
- "weeks",
- "months"
- ],
- "type": "string"
- },
- "include_fees_other": {
- "type": "boolean"
- },
- "include_fees_other_val": {
- "type": "string"
- },
- "include_fees_table": {
- "type": "boolean"
- },
- "include_fees_table_total": {
- "type": "boolean"
- },
- "include_fees_travel": {
- "type": "boolean"
- },
- "include_fees_travel_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_fees_travel_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_fees_travel_val": {
- "type": "string"
- },
- "include_third_party_customer": {
- "type": "boolean"
- },
- "include_third_party_include_description": {
- "type": "boolean"
- },
- "include_third_party_include_description_val": {
- "type": "string"
- },
- "include_third_party_materials": {
- "type": "boolean"
- },
- "include_third_party_provider": {
- "type": "boolean"
- },
- "include_time_of_assignment": {
- "type": "boolean"
- },
- "include_time_of_assignment_type": {
- "enum": [
- "created",
- "paid"
- ],
- "type": "string"
- },
- "invoice_period_description": {
- "type": "string"
- },
- "negotiations_allowed": {
- "description": "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": {
- "enum": [
- "receipt",
- "invoice",
- "Customer's receipt of invoice",
- "date of invoice"
- ],
- "type": "string"
- },
- "payment_period_type": {
- "enum": [
- "standard",
- "other"
- ],
- "type": "string"
- },
- "payment_period_unit": {
- "enum": [
- "day(s)",
- "week(s)",
- "month(s)",
- "quarter(s)",
- "year(s)"
- ],
- "type": "string"
- },
- "services_description": {
- "type": "string"
- },
- "sow_date": {
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "sow_date_type": {
- "enum": [
- "signature",
- "date"
- ],
- "type": "string"
- },
- "sow_term_amount": {
- "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": {
- "enum": [
- "deliverables",
- "period",
- "date"
- ],
- "type": "string"
- },
- "sow_term_unit": {
- "enum": [
- "month(s)",
- "quarter(s)",
- "year(s)"
- ],
- "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.",
- "enum": [
- "PSA"
- ],
- "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-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": {
- "enum": [
- "signature",
- "date"
- ],
- "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": {
- "enum": [
- "default_language",
- "description"
- ],
- "type": "string"
- },
- "include_fees_unit": {
- "enum": [
- "month",
- "quarter",
- "year",
- "Term"
- ],
- "type": "string"
- },
- "include_program_appear_as_customer_private": {
- "type": "boolean"
- },
- "include_program_appear_as_customer_public": {
- "type": "boolean"
- },
- "include_program_case_study": {
- "type": "boolean"
- },
- "include_program_develop_functionality": {
- "type": "boolean"
- },
- "include_program_develop_functionality_val": {
- "type": "string"
- },
- "include_program_discount": {
- "type": "boolean"
- },
- "include_program_discount_amount": {
- "type": "number"
- },
- "include_program_discount_unit": {
- "enum": [
- "U.S. Dollars",
- "percent"
- ],
- "type": "string"
- },
- "include_program_participation_feedback": {
- "type": "boolean"
- },
- "include_program_participation_feedback_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_program_participation_feedback_unit": {
- "enum": [
- "month",
- "quarter",
- "year",
- "Term"
- ],
- "type": "string"
- },
- "include_program_partner_other": {
- "type": "boolean"
- },
- "include_program_partner_other_val": {
- "type": "string"
- },
- "include_program_provider_other": {
- "type": "boolean"
- },
- "include_program_provider_other_val": {
- "type": "string"
- },
- "include_program_reference": {
- "type": "boolean"
- },
- "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": {
- "enum": [
- "day(s)",
- "week(s)",
- "month(s)",
- "quarter(s)",
- "year(s)"
- ],
- "type": "string"
- },
- "type": {
- "description": "The type of template to create.",
- "enum": [
- "Design"
- ],
- "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": {
- "enum": [
- "stripe",
- "link"
- ],
- "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-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": {
- "enum": [
- "signature",
- "date"
- ],
- "type": "string"
- },
- "general_cap_amount": {
- "type": "number"
- },
- "general_cap_amount_type": {
- "enum": [
- "preceding",
- "base",
- "period"
- ],
- "type": "string"
- },
- "general_cap_period_currency": {
- "type": "number"
- },
- "general_cap_period_qty": {
- "type": "number"
- },
- "general_cap_preceding_amount": {
- "type": "number"
- },
- "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": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_increased_cap_amount": {
- "type": "boolean"
- },
- "include_increased_claims": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_confidentiality": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_confidentiality_negligence": {
- "type": "boolean"
- },
- "include_increased_claims_include_other": {
- "type": "boolean"
- },
- "include_increased_claims_indemnification_obligation": {
- "type": "boolean"
- },
- "include_increased_claims_negligence": {
- "type": "boolean"
- },
- "include_increased_claims_other": {
- "type": "string"
- },
- "include_increased_claims_restrictions": {
- "type": "boolean"
- },
- "include_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": {
- "enum": [
- "qty",
- "currency",
- "period"
- ],
- "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": {
- "enum": [
- "automatic",
- "manual"
- ],
- "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": {
- "enum": [
- "automatic",
- "invoice"
- ],
- "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": {
- "enum": [
- "Subscription Period",
- "month",
- "year",
- "Custom unit"
- ],
- "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": {
- "enum": [
- "USD",
- "EUR",
- "GBP",
- "CAD",
- "AUD",
- "SGD",
- "ILS",
- "JPY",
- "CHF",
- "HKD"
- ],
- "type": "string"
- },
- "fees_include_fee_increase_upon_renewal": {
- "type": "boolean"
- },
- "fees_include_fee_increase_upon_renewal_fee": {
- "type": "number"
- },
- "fees_include_fee_increase_upon_renewal_type": {
- "enum": [
- "will",
- "may"
- ],
- "type": "string"
- },
- "fees_inclusive_of_taxes": {
- "type": "boolean"
- },
- "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": {
- "enum": [
- "day",
- "week",
- "month"
- ],
- "type": "string"
- },
- "include_pilot_period_include_fees": {
- "type": "boolean"
- },
- "include_pilot_period_include_fees_amount": {
- "type": "number"
- },
- "include_pilot_period_include_modifications": {
- "type": "boolean"
- },
- "include_pilot_period_include_modifications_description": {
- "type": "string"
- },
- "include_services": {
- "type": "boolean"
- },
- "include_services_description": {
- "type": "string"
- },
- "negotiations_allowed": {
- "description": "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": {
- "enum": [
- "signature",
- "date",
- "other"
- ],
- "type": "string"
- },
- "payment_process_automatic_frequency": {
- "enum": [
- "monthly",
- "quarterly",
- "semiannually",
- "annually"
- ],
- "type": "string"
- },
- "payment_process_type": {
- "enum": [
- "automatic",
- "invoice",
- "custom"
- ],
- "type": "string"
- },
- "payment_process_type_custom_val": {
- "type": "string"
- },
- "payment_process_type_invoice_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "payment_process_type_invoice_custom_unit": {
- "type": "string"
- },
- "payment_process_type_invoice_duration": {
- "enum": [
- "day",
- "week",
- "month",
- "year",
- "day(s)",
- "week(s)",
- "month(s)",
- "year(s)"
- ],
- "type": "string"
- },
- "payment_process_type_invoice_duration_start": {
- "enum": [
- "Customer's receipt of invoice",
- "date of invoice"
- ],
- "type": "string"
- },
- "payment_process_type_invoice_type": {
- "enum": [
- "monthly",
- "quarterly",
- "semiannually",
- "annually",
- "Custom unit"
- ],
- "type": "string"
- },
- "permitted_uses_include_custom": {
- "type": "boolean"
- },
- "permitted_uses_include_custom_description": {
- "type": "string"
- },
- "permitted_uses_include_customers_affiliates": {
- "type": "boolean"
- },
- "permitted_uses_include_internal_business": {
- "type": "boolean"
- },
- "pilot_period_stripe_product_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-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": {
- "enum": [
- "days",
- "subscription_end"
- ],
- "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": {
- "enum": [
- "day",
- "week",
- "month",
- "year"
- ],
- "type": "string"
- },
- "warranty_period_description_duration_start": {
- "enum": [
- "initial delivery of the Software",
- "delivery of the Software and each subsequent Update",
- "the Order Date"
- ],
- "type": "string"
- },
- "warranty_period_type": {
- "enum": [
- "description",
- "none"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- "type": {
- "description": "The type of template to create.",
- "enum": [
- "Software License"
- ],
- "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-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": {
- "enum": [
- "signature",
- "date"
- ],
- "type": "string"
- },
- "fees_type": {
- "enum": [
- "free",
- "pilot_period_fees"
- ],
- "type": "string"
- },
- "general_cap_amount": {
- "type": "number"
- },
- "general_cap_amount_type": {
- "enum": [
- "preceding",
- "base",
- "period"
- ],
- "type": "string"
- },
- "general_cap_period_currency": {
- "type": "number"
- },
- "general_cap_period_qty": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "general_cap_preceding_amount": {
- "type": "number"
- },
- "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": {
- "enum": [
- "description",
- "attachment",
- "standard"
- ],
- "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": {
- "enum": [
- "monthly",
- "quarterly",
- "annually",
- "once_per_period"
- ],
- "type": "string"
- },
- "payment_process_invoice_days": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "payment_process_invoice_from": {
- "enum": [
- "receipt",
- "date"
- ],
- "type": "string"
- },
- "payment_process_invoice_timeframe": {
- "enum": [
- "days",
- "weeks",
- "months",
- "quarters",
- "years"
- ],
- "type": "string"
- },
- "payment_process_type": {
- "enum": [
- "automatic",
- "invoice"
- ],
- "type": "string"
- },
- "pilot_period_description": {
- "type": "string"
- },
- "pilot_period_fees_description": {
- "type": "string"
- },
- "product_description": {
- "type": "string"
- },
- "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.",
- "enum": [
- "Pilot"
- ],
- "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-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": {
- "enum": [
- "signature",
- "date"
- ],
- "type": "string"
- },
- "general_cap_amount_currency_val": {
- "type": "number"
- },
- "general_cap_amount_either_currency": {
- "type": "number"
- },
- "general_cap_amount_either_multiple": {
- "type": "number"
- },
- "general_cap_amount_multiple_val": {
- "type": "number"
- },
- "general_cap_amount_type": {
- "enum": [
- "multiple",
- "currency",
- "either",
- "base"
- ],
- "type": "string"
- },
- "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": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_increased_cap_amount": {
- "type": "boolean"
- },
- "include_increased_cap_amount_currency": {
- "type": "number"
- },
- "include_increased_cap_amount_either_currency": {
- "type": "number"
- },
- "include_increased_cap_amount_either_multiple": {},
- "include_increased_cap_amount_multiple": {},
- "include_increased_cap_amount_type": {
- "enum": [
- "multiple",
- "currency",
- "either"
- ],
- "type": "string"
- },
- "include_increased_claims": {
- "type": "boolean"
- },
- "include_increased_claims_include_confidentiality": {
- "type": "boolean"
- },
- "include_increased_claims_include_confidentiality_misconduct": {
- "type": "boolean"
- },
- "include_increased_claims_include_covered_claims": {
- "type": "boolean"
- },
- "include_increased_claims_include_misconduct": {
- "type": "boolean"
- },
- "include_increased_claims_include_other": {
- "type": "boolean"
- },
- "include_increased_claims_include_other_val": {
- "type": "string"
- },
- "include_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": {
- "enum": [
- "month(s)",
- "quarter(s)",
- "year(s)"
- ],
- "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": {
- "enum": [
- "date",
- "effective date"
- ],
- "type": "string"
- },
- "include_obligations_company_brand": {
- "type": "boolean"
- },
- "include_obligations_company_promotion": {
- "type": "boolean"
- },
- "include_obligations_company_promotion_include_activities": {
- "type": "boolean"
- },
- "include_obligations_company_promotion_include_activities_val": {
- "type": "string"
- },
- "include_obligations_company_promotion_include_materials": {
- "type": "boolean"
- },
- "include_obligations_company_promotion_include_materials_val": {
- "type": "string"
- },
- "include_obligations_company_referral": {
- "type": "boolean"
- },
- "include_obligations_company_referral_include_criteria": {
- "type": "boolean"
- },
- "include_obligations_company_referral_include_criteria_val": {
- "type": "string"
- },
- "include_obligations_company_referral_include_pay_sch": {
- "type": "boolean"
- },
- "include_obligations_company_referral_include_pay_sch_amount": {
- "type": "number"
- },
- "include_obligations_company_referral_include_pay_sch_custom": {
- "type": "string"
- },
- "include_obligations_company_referral_include_pay_sch_unit": {
- "enum": [
- "U.S. Dollars",
- "percent"
- ],
- "type": "string"
- },
- "include_obligations_company_sponsorship": {
- "type": "boolean"
- },
- "include_obligations_company_sponsorship_include_benefits": {
- "type": "boolean"
- },
- "include_obligations_company_sponsorship_include_benefits_val": {
- "type": "string"
- },
- "include_obligations_company_sponsorship_include_payments": {
- "type": "boolean"
- },
- "include_obligations_company_sponsorship_include_payments_amount": {
- "type": "number"
- },
- "include_obligations_company_sponsorship_include_payments_unit": {
- "enum": [
- "U.S. Dollars",
- "percent"
- ],
- "type": "string"
- },
- "include_obligations_partner_brand": {
- "type": "boolean"
- },
- "include_obligations_partner_promotion": {
- "type": "boolean"
- },
- "include_obligations_partner_promotion_include_activities": {
- "type": "boolean"
- },
- "include_obligations_partner_promotion_include_activities_val": {
- "type": "string"
- },
- "include_obligations_partner_promotion_include_materials": {
- "type": "boolean"
- },
- "include_obligations_partner_promotion_include_materials_val": {
- "type": "string"
- },
- "include_obligations_partner_referral": {
- "type": "boolean"
- },
- "include_obligations_partner_referral_include_criteria": {
- "type": "boolean"
- },
- "include_obligations_partner_referral_include_criteria_val": {
- "type": "string"
- },
- "include_obligations_partner_referral_include_pay_sch": {
- "type": "boolean"
- },
- "include_obligations_partner_referral_include_pay_sch_amount": {
- "type": "number"
- },
- "include_obligations_partner_referral_include_pay_sch_custom": {
- "type": "string"
- },
- "include_obligations_partner_referral_include_pay_sch_unit": {
- "enum": [
- "U.S. Dollars",
- "percent"
- ],
- "type": "string"
- },
- "include_obligations_partner_sponsorship": {
- "type": "boolean"
- },
- "include_obligations_partner_sponsorship_include_benefits": {
- "type": "boolean"
- },
- "include_obligations_partner_sponsorship_include_benefits_val": {
- "type": "string"
- },
- "include_obligations_partner_sponsorship_include_payments": {
- "type": "boolean"
- },
- "include_obligations_partner_sponsorship_include_payments_amount": {
- "type": "number"
- },
- "include_obligations_partner_sponsorship_include_payments_unit": {
- "enum": [
- "U.S. Dollars",
- "percent"
- ],
- "type": "string"
- },
- "include_payment_process": {
- "type": "boolean"
- },
- "include_payment_process_company": {
- "type": "boolean"
- },
- "include_payment_process_company_include_address": {
- "type": "boolean"
- },
- "include_payment_process_company_include_address_city": {
- "type": "string"
- },
- "include_payment_process_company_include_address_country": {
- "type": "string"
- },
- "include_payment_process_company_include_address_state": {
- "type": "string"
- },
- "include_payment_process_company_include_address_street_address": {
- "type": "string"
- },
- "include_payment_process_company_include_address_zipcode": {
- "type": "string"
- },
- "include_payment_process_company_include_email": {
- "type": "boolean"
- },
- "include_payment_process_company_include_email_val": {
- "format": "email",
- "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
- "type": "string"
- },
- "include_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-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": {
- "enum": [
- "receipt",
- "date"
- ],
- "type": "string"
- },
- "include_payment_schedule_specified_unit": {
- "enum": [
- "day(s)",
- "week(s)",
- "month(s)",
- "quarter(s)",
- "year(s)"
- ],
- "type": "string"
- },
- "include_payment_schedule_type": {
- "enum": [
- "specified",
- "custom"
- ],
- "type": "string"
- },
- "negotiations_allowed": {
- "description": "Whether counterparties can propose changes to agreements created from this template.",
- "type": "boolean"
- },
- "territory_type": {
- "enum": [
- "worldwide",
- "custom"
- ],
- "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.",
- "enum": [
- "Partnership"
- ],
- "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": {
- "enum": [
- "hours",
- "business days",
- "calendar days"
- ],
- "type": "string"
- },
- "breach_notification_val": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "business_associate_relationship_type": {
- "enum": [
- "provider",
- "company"
- ],
- "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-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": {
- "enum": [
- "signature",
- "date"
- ],
- "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.",
- "enum": [
- "BAA"
- ],
- "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": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "confidentiality_type": {
- "enum": [
- "mutual",
- "nda",
- "provider",
- "custom"
- ],
- "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-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": {
- "enum": [
- "month",
- "year",
- "quarter"
- ],
- "type": "string"
- },
- "include_fees_include_amount": {
- "type": "boolean"
- },
- "include_fees_include_other": {
- "type": "boolean"
- },
- "include_fees_other": {
- "type": "string"
- },
- "include_functionality": {
- "type": "boolean"
- },
- "include_functionality_val": {
- "type": "string"
- },
- "include_launch_date": {
- "type": "boolean"
- },
- "include_launch_date_custom": {
- "type": "string"
- },
- "include_launch_date_date": {
- "format": "date-time",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$",
- "type": "string"
- },
- "include_launch_date_type": {
- "enum": [
- "date",
- "custom"
- ],
- "type": "string"
- },
- "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.",
- "enum": [
- "LOI"
- ],
- "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-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": {
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "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.",
+ "enum": [
+ "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": {
+ "enum": [
+ "stripe",
+ "link"
+ ],
+ "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-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": {
+ "enum": [
+ "AWS",
+ "GCP",
+ "Azure"
+ ],
+ "type": "string"
+ },
+ "effective_date_type": {
+ "enum": [
+ "signature",
+ "date",
+ "marketplace_acceptance"
+ ],
+ "type": "string"
+ },
+ "general_cap_amount": {
+ "type": "number"
+ },
+ "general_cap_amount_type": {
+ "enum": [
+ "preceding",
+ "base",
+ "period"
+ ],
+ "type": "string"
+ },
+ "general_cap_period_currency": {
+ "type": "number"
+ },
+ "general_cap_period_qty": {
+ "type": "number"
+ },
+ "general_cap_preceding_amount": {
+ "type": "number"
+ },
+ "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": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "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": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_increased_cap_amount": {
+ "type": "boolean"
+ },
+ "include_increased_claims": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_confidentiality": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_confidentiality_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_privsec": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_privsec_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_other": {
+ "type": "boolean"
+ },
+ "include_increased_claims_indemnification_obligation": {
+ "type": "boolean"
+ },
+ "include_increased_claims_other": {
+ "type": "string"
+ },
+ "include_insurance_minimums": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_add_customer": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_add_customer_com_gen_liability": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_add_customer_cyber_liability": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_add_customer_errors_omissions": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_additional_information": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_additional_information_text": {
+ "type": "string"
+ },
+ "include_insurance_minimums_cyber_liability_aggregate": {
+ "type": "number"
+ },
+ "include_insurance_minimums_cyber_liability_minimum": {
+ "type": "number"
+ },
+ "include_insurance_minimums_employer_liability_aggregate": {
+ "type": "number"
+ },
+ "include_insurance_minimums_employer_liability_minimum": {
+ "type": "number"
+ },
+ "include_insurance_minimums_general_liability_aggregate": {
+ "type": "number"
+ },
+ "include_insurance_minimums_general_liability_minimum": {
+ "type": "number"
+ },
+ "include_insurance_minimums_include_cyber_liability": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_include_employer_liability": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_include_general_liability": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_include_workers_compensation": {
+ "type": "boolean"
+ },
+ "include_publicity_rights": {
+ "type": "boolean"
+ },
+ "include_publicity_rights_type": {
+ "enum": [
+ "public",
+ "non-public"
+ ],
+ "type": "string"
+ },
+ "include_security_policy": {
+ "type": "boolean"
+ },
+ "include_security_policy_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_security_policy_fedramp_auth": {
+ "type": "boolean"
+ },
+ "include_security_policy_hipaa": {
+ "type": "boolean"
+ },
+ "include_security_policy_hitrust": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_annual_maintenance": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_location": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_other": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_reasonable_efforts": {
+ "type": "boolean"
+ },
+ "include_security_policy_iso27001": {
+ "type": "boolean"
+ },
+ "include_security_policy_location": {
+ "type": "string"
+ },
+ "include_security_policy_other": {
+ "type": "string"
+ },
+ "include_security_policy_pci1": {
+ "type": "boolean"
+ },
+ "include_security_policy_pci2": {
+ "type": "boolean"
+ },
+ "include_security_policy_penetration_testing": {
+ "type": "boolean"
+ },
+ "include_security_policy_soc2": {
+ "type": "boolean"
+ },
+ "include_security_policy_soc2_type2": {
+ "type": "boolean"
+ },
+ "include_security_policy_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_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": {
+ "type": "number"
+ },
+ "increased_cap_amount_qty": {
+ "type": "number"
+ },
+ "increased_cap_amount_type": {
+ "enum": [
+ "qty",
+ "currency",
+ "period"
+ ],
+ "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": {
+ "enum": [
+ "automatic",
+ "invoice"
+ ],
+ "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": {
+ "enum": [
+ "Subscription Period",
+ "month",
+ "year",
+ "User",
+ "Custom unit"
+ ],
+ "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": {
+ "enum": [
+ "USD",
+ "EUR",
+ "GBP",
+ "CAD",
+ "AUD",
+ "SGD",
+ "ILS",
+ "JPY",
+ "CHF",
+ "HKD"
+ ],
+ "type": "string"
+ },
+ "fees_include_fee_increase_upon_renewal": {
+ "type": "boolean"
+ },
+ "fees_include_fee_increase_upon_renewal_fee": {
+ "type": "number"
+ },
+ "fees_include_fee_increase_upon_renewal_type": {
+ "enum": [
+ "will",
+ "may"
+ ],
+ "type": "string"
+ },
+ "fees_inclusive_of_taxes": {
+ "type": "boolean"
+ },
+ "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": {
+ "enum": [
+ "Subscription Period",
+ "month",
+ "year",
+ "User"
+ ],
+ "type": "string"
+ },
+ "include_free_trial": {
+ "type": "boolean"
+ },
+ "include_max_users": {
+ "type": "boolean"
+ },
+ "include_pilot_period": {
+ "type": "boolean"
+ },
+ "include_pilot_period_duration_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_pilot_period_duration_type": {
+ "enum": [
+ "day",
+ "week",
+ "month"
+ ],
+ "type": "string"
+ },
+ "include_pilot_period_include_fees": {
+ "type": "boolean"
+ },
+ "include_pilot_period_include_fees_amount": {
+ "type": "number"
+ },
+ "include_pilot_period_include_modifications": {
+ "type": "boolean"
+ },
+ "include_pilot_period_include_modifications_description": {
+ "type": "string"
+ },
+ "include_product_support": {
+ "type": "boolean"
+ },
+ "include_product_support_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_product_support_description": {
+ "type": "string"
+ },
+ "include_product_support_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_professional_services": {
+ "type": "boolean"
+ },
+ "include_professional_services_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_professional_services_custom_name": {
+ "type": "string"
+ },
+ "include_professional_services_description": {
+ "type": "string"
+ },
+ "include_professional_services_end_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "include_professional_services_fees_description": {
+ "type": "string"
+ },
+ "include_professional_services_include_end_date": {
+ "type": "boolean"
+ },
+ "include_professional_services_include_fees_description": {
+ "type": "boolean"
+ },
+ "include_professional_services_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_sla": {
+ "type": "boolean"
+ },
+ "include_sla_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_sla_description": {
+ "type": "string"
+ },
+ "include_sla_include_response_time": {
+ "type": "boolean"
+ },
+ "include_sla_include_response_time_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_sla_include_response_time_credit": {
+ "type": "number"
+ },
+ "include_sla_include_response_time_duration": {
+ "enum": [
+ "hour",
+ "day",
+ "week",
+ "month",
+ "hours"
+ ],
+ "type": "string"
+ },
+ "include_sla_include_response_time_support_channel": {
+ "type": "string"
+ },
+ "include_sla_include_target_uptime": {
+ "type": "boolean"
+ },
+ "include_sla_maintenance_notice": {
+ "type": "boolean"
+ },
+ "include_sla_maintenance_window": {
+ "type": "boolean"
+ },
+ "include_sla_maintenance_window_type": {
+ "enum": [
+ "standard",
+ "none"
+ ],
+ "type": "string"
+ },
+ "include_sla_standard_maintenance_notice_qty": {
+ "type": "number"
+ },
+ "include_sla_standard_maintenance_notice_unit": {
+ "enum": [
+ "hour",
+ "day",
+ "week",
+ "month"
+ ],
+ "type": "string"
+ },
+ "include_sla_standard_maintenance_window_end_time": {
+ "type": "string"
+ },
+ "include_sla_standard_maintenance_window_friday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_monday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_saturday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_start_time": {
+ "type": "string"
+ },
+ "include_sla_standard_maintenance_window_sunday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_thursday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_time_zone": {
+ "type": "string"
+ },
+ "include_sla_standard_maintenance_window_tuesday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_wednesday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_target_uptime": {
+ "type": "number"
+ },
+ "include_sla_type": {
+ "enum": [
+ "description",
+ "standard",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_subscription_start_date": {
+ "type": "boolean"
+ },
+ "include_subscription_start_date_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "include_usage_review": {
+ "type": "boolean"
+ },
+ "include_usage_review_val": {
+ "type": "string"
+ },
+ "include_use_limitations": {
+ "type": "boolean"
+ },
+ "include_use_limitations_val": {
+ "type": "string"
+ },
+ "invoice_period": {
+ "enum": [
+ "monthly",
+ "quarterly",
+ "semiannually",
+ "annually",
+ "Custom unit",
+ "Monthly",
+ "Quarterly",
+ "Semiannually",
+ "Annually"
+ ],
+ "type": "string"
+ },
+ "invoice_period_custom_unit": {
+ "type": "string"
+ },
+ "max_consumption": {
+ "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": {
+ "enum": [
+ "signature",
+ "date",
+ "other"
+ ],
+ "type": "string"
+ },
+ "payment_period": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "payment_period_timeframe": {
+ "enum": [
+ "Customer's receipt of invoice",
+ "date of invoice"
+ ],
+ "type": "string"
+ },
+ "payment_period_unit": {
+ "enum": [
+ "day(s)",
+ "week(s)",
+ "month(s)",
+ "marketplace_acceptance"
+ ],
+ "type": "string"
+ },
+ "payment_process_automatic_frequency": {
+ "enum": [
+ "monthly",
+ "quarterly",
+ "semiannually",
+ "annually"
+ ],
+ "type": "string"
+ },
+ "payment_process_type": {
+ "enum": [
+ "automatic",
+ "invoice",
+ "custom",
+ "marketplace_acceptance"
+ ],
+ "type": "string"
+ },
+ "payment_process_type_custom_val": {
+ "type": "string"
+ },
+ "payment_process_type_invoice_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "payment_process_type_invoice_custom_unit": {
+ "type": "string"
+ },
+ "payment_process_type_invoice_duration": {
+ "enum": [
+ "day",
+ "week",
+ "month",
+ "year",
+ "day(s)",
+ "week(s)",
+ "month(s)",
+ "year(s)"
+ ],
+ "type": "string"
+ },
+ "payment_process_type_invoice_duration_start": {
+ "enum": [
+ "Customer's receipt of invoice",
+ "date of invoice"
+ ],
+ "type": "string"
+ },
+ "payment_process_type_invoice_type": {
+ "enum": [
+ "monthly",
+ "quarterly",
+ "semiannually",
+ "annually",
+ "Custom unit"
+ ],
+ "type": "string"
+ },
+ "pilot_period_stripe_product_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-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": {
+ "enum": [
+ "days",
+ "subscription_end"
+ ],
+ "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": {
+ "enum": [
+ "effective_date",
+ "date"
+ ],
+ "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.",
+ "enum": [
+ "CSA"
+ ],
+ "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-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-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.",
+ "enum": [
+ "DPA"
+ ],
+ "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-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": {
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "type": "string"
+ },
+ "general_cap_amount": {
+ "type": "number"
+ },
+ "general_cap_amount_type": {
+ "enum": [
+ "preceding",
+ "base",
+ "period"
+ ],
+ "type": "string"
+ },
+ "general_cap_period_currency": {
+ "type": "number"
+ },
+ "general_cap_period_qty": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "general_cap_preceding_amount": {
+ "type": "number"
+ },
+ "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": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_dpa": {
+ "type": "boolean"
+ },
+ "include_dpa_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_dpa_location": {
+ "type": "string"
+ },
+ "include_dpa_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_increased_cap_amount": {
+ "type": "boolean"
+ },
+ "include_increased_claims": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_confidentiality": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_confidentiality_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_privsec": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_privsec_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_other": {
+ "type": "boolean"
+ },
+ "include_increased_claims_indemnification_obligation": {
+ "type": "boolean"
+ },
+ "include_increased_claims_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_other": {
+ "type": "string"
+ },
+ "include_provider_insurance_min": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_add_customer_com_gen_liability": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_add_customer_cyber_liability": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_add_customer_errors_omissions": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_auto_liability_aggregate": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_auto_liability_minimum": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_cyber_liability_aggregate": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_cyber_liability_minimum": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_employer_liability_aggregate": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_employer_liability_minimum": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_general_liability_aggregate": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_general_liability_minimum": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_include_add_customer": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_include_auto_liability": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_include_cyber_liability": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_include_employer_liability": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_include_general_liability": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_include_workers_comp": {
+ "type": "boolean"
+ },
+ "include_publicity_rights": {
+ "type": "boolean"
+ },
+ "include_publicity_rights_type": {
+ "enum": [
+ "public",
+ "non-public"
+ ],
+ "type": "string"
+ },
+ "include_security_policy": {
+ "type": "boolean"
+ },
+ "include_security_policy_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_security_policy_fedramp_auth": {
+ "type": "boolean"
+ },
+ "include_security_policy_hitrust": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_annual_maintenance": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_other": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_other_val": {
+ "type": "string"
+ },
+ "include_security_policy_iso27001": {
+ "type": "boolean"
+ },
+ "include_security_policy_location": {
+ "type": "string"
+ },
+ "include_security_policy_pci1": {
+ "type": "boolean"
+ },
+ "include_security_policy_pci2": {
+ "type": "boolean"
+ },
+ "include_security_policy_penetration_testing": {
+ "type": "boolean"
+ },
+ "include_security_policy_soc2_type1": {
+ "type": "boolean"
+ },
+ "include_security_policy_soc2_type2": {
+ "type": "boolean"
+ },
+ "include_security_policy_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_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": {
+ "enum": [
+ "qty",
+ "currency",
+ "period"
+ ],
+ "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 recipient's role on agreements from this template: `Customer` (the default) or `Provider`. Send it with `sender_role`; the two must be one `Provider` and one `Customer`.",
+ "type": "string"
+ },
+ "sender_last_to_sign": {
+ "description": "When true, the sender signs after the recipient.",
+ "type": "boolean"
+ },
+ "sender_role": {
+ "description": "Your company's role on agreements from this template: `Provider` (the default) or `Customer` when you hire the recipient to provide the services. Send it with `recipient_role`; the two must be one `Provider` and one `Customer`.",
+ "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": {
+ "enum": [
+ "hours",
+ "days",
+ "weeks",
+ "months"
+ ],
+ "type": "string"
+ },
+ "include_deliverables_resubmission_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_deliverables_resubmission_unit": {
+ "enum": [
+ "hours",
+ "days",
+ "weeks",
+ "months"
+ ],
+ "type": "string"
+ },
+ "include_fees_other": {
+ "type": "boolean"
+ },
+ "include_fees_other_val": {
+ "type": "string"
+ },
+ "include_fees_table": {
+ "type": "boolean"
+ },
+ "include_fees_table_total": {
+ "type": "boolean"
+ },
+ "include_fees_travel": {
+ "type": "boolean"
+ },
+ "include_fees_travel_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_fees_travel_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_fees_travel_val": {
+ "type": "string"
+ },
+ "include_third_party_customer": {
+ "type": "boolean"
+ },
+ "include_third_party_include_description": {
+ "type": "boolean"
+ },
+ "include_third_party_include_description_val": {
+ "type": "string"
+ },
+ "include_third_party_materials": {
+ "type": "boolean"
+ },
+ "include_third_party_provider": {
+ "type": "boolean"
+ },
+ "include_time_of_assignment": {
+ "type": "boolean"
+ },
+ "include_time_of_assignment_type": {
+ "enum": [
+ "created",
+ "paid"
+ ],
+ "type": "string"
+ },
+ "invoice_period_description": {
+ "type": "string"
+ },
+ "negotiations_allowed": {
+ "description": "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": {
+ "enum": [
+ "receipt",
+ "invoice",
+ "Customer's receipt of invoice",
+ "date of invoice"
+ ],
+ "type": "string"
+ },
+ "payment_period_type": {
+ "enum": [
+ "standard",
+ "other"
+ ],
+ "type": "string"
+ },
+ "payment_period_unit": {
+ "enum": [
+ "day(s)",
+ "week(s)",
+ "month(s)",
+ "quarter(s)",
+ "year(s)"
+ ],
+ "type": "string"
+ },
+ "services_description": {
+ "type": "string"
+ },
+ "sow_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "sow_date_type": {
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "type": "string"
+ },
+ "sow_term_amount": {
+ "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": {
+ "enum": [
+ "deliverables",
+ "period",
+ "date"
+ ],
+ "type": "string"
+ },
+ "sow_term_unit": {
+ "enum": [
+ "month(s)",
+ "quarter(s)",
+ "year(s)"
+ ],
+ "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.",
+ "enum": [
+ "PSA"
+ ],
+ "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-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": {
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "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": {
+ "enum": [
+ "default_language",
+ "description"
+ ],
+ "type": "string"
+ },
+ "include_fees_unit": {
+ "enum": [
+ "month",
+ "quarter",
+ "year",
+ "Term"
+ ],
+ "type": "string"
+ },
+ "include_program_appear_as_customer_private": {
+ "type": "boolean"
+ },
+ "include_program_appear_as_customer_public": {
+ "type": "boolean"
+ },
+ "include_program_case_study": {
+ "type": "boolean"
+ },
+ "include_program_develop_functionality": {
+ "type": "boolean"
+ },
+ "include_program_develop_functionality_val": {
+ "type": "string"
+ },
+ "include_program_discount": {
+ "type": "boolean"
+ },
+ "include_program_discount_amount": {
+ "type": "number"
+ },
+ "include_program_discount_unit": {
+ "enum": [
+ "U.S. Dollars",
+ "percent"
+ ],
+ "type": "string"
+ },
+ "include_program_participation_feedback": {
+ "type": "boolean"
+ },
+ "include_program_participation_feedback_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_program_participation_feedback_unit": {
+ "enum": [
+ "month",
+ "quarter",
+ "year",
+ "Term"
+ ],
+ "type": "string"
+ },
+ "include_program_partner_other": {
+ "type": "boolean"
+ },
+ "include_program_partner_other_val": {
+ "type": "string"
+ },
+ "include_program_provider_other": {
+ "type": "boolean"
+ },
+ "include_program_provider_other_val": {
+ "type": "string"
+ },
+ "include_program_reference": {
+ "type": "boolean"
+ },
+ "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": {
+ "enum": [
+ "day(s)",
+ "week(s)",
+ "month(s)",
+ "quarter(s)",
+ "year(s)"
+ ],
+ "type": "string"
+ },
+ "type": {
+ "description": "The type of template to create.",
+ "enum": [
+ "Design"
+ ],
+ "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": {
+ "enum": [
+ "stripe",
+ "link"
+ ],
+ "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-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": {
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "type": "string"
+ },
+ "general_cap_amount": {
+ "type": "number"
+ },
+ "general_cap_amount_type": {
+ "enum": [
+ "preceding",
+ "base",
+ "period"
+ ],
+ "type": "string"
+ },
+ "general_cap_period_currency": {
+ "type": "number"
+ },
+ "general_cap_period_qty": {
+ "type": "number"
+ },
+ "general_cap_preceding_amount": {
+ "type": "number"
+ },
+ "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": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_increased_cap_amount": {
+ "type": "boolean"
+ },
+ "include_increased_claims": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_confidentiality": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_confidentiality_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_other": {
+ "type": "boolean"
+ },
+ "include_increased_claims_indemnification_obligation": {
+ "type": "boolean"
+ },
+ "include_increased_claims_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_other": {
+ "type": "string"
+ },
+ "include_increased_claims_restrictions": {
+ "type": "boolean"
+ },
+ "include_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": {
+ "enum": [
+ "qty",
+ "currency",
+ "period"
+ ],
+ "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": {
+ "enum": [
+ "automatic",
+ "manual"
+ ],
+ "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": {
+ "enum": [
+ "automatic",
+ "invoice"
+ ],
+ "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": {
+ "enum": [
+ "Subscription Period",
+ "month",
+ "year",
+ "Custom unit"
+ ],
+ "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": {
+ "enum": [
+ "USD",
+ "EUR",
+ "GBP",
+ "CAD",
+ "AUD",
+ "SGD",
+ "ILS",
+ "JPY",
+ "CHF",
+ "HKD"
+ ],
+ "type": "string"
+ },
+ "fees_include_fee_increase_upon_renewal": {
+ "type": "boolean"
+ },
+ "fees_include_fee_increase_upon_renewal_fee": {
+ "type": "number"
+ },
+ "fees_include_fee_increase_upon_renewal_type": {
+ "enum": [
+ "will",
+ "may"
+ ],
+ "type": "string"
+ },
+ "fees_inclusive_of_taxes": {
+ "type": "boolean"
+ },
+ "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": {
+ "enum": [
+ "day",
+ "week",
+ "month"
+ ],
+ "type": "string"
+ },
+ "include_pilot_period_include_fees": {
+ "type": "boolean"
+ },
+ "include_pilot_period_include_fees_amount": {
+ "type": "number"
+ },
+ "include_pilot_period_include_modifications": {
+ "type": "boolean"
+ },
+ "include_pilot_period_include_modifications_description": {
+ "type": "string"
+ },
+ "include_services": {
+ "type": "boolean"
+ },
+ "include_services_description": {
+ "type": "string"
+ },
+ "negotiations_allowed": {
+ "description": "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": {
+ "enum": [
+ "signature",
+ "date",
+ "other"
+ ],
+ "type": "string"
+ },
+ "payment_process_automatic_frequency": {
+ "enum": [
+ "monthly",
+ "quarterly",
+ "semiannually",
+ "annually"
+ ],
+ "type": "string"
+ },
+ "payment_process_type": {
+ "enum": [
+ "automatic",
+ "invoice",
+ "custom"
+ ],
+ "type": "string"
+ },
+ "payment_process_type_custom_val": {
+ "type": "string"
+ },
+ "payment_process_type_invoice_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "payment_process_type_invoice_custom_unit": {
+ "type": "string"
+ },
+ "payment_process_type_invoice_duration": {
+ "enum": [
+ "day",
+ "week",
+ "month",
+ "year",
+ "day(s)",
+ "week(s)",
+ "month(s)",
+ "year(s)"
+ ],
+ "type": "string"
+ },
+ "payment_process_type_invoice_duration_start": {
+ "enum": [
+ "Customer's receipt of invoice",
+ "date of invoice"
+ ],
+ "type": "string"
+ },
+ "payment_process_type_invoice_type": {
+ "enum": [
+ "monthly",
+ "quarterly",
+ "semiannually",
+ "annually",
+ "Custom unit"
+ ],
+ "type": "string"
+ },
+ "permitted_uses_include_custom": {
+ "type": "boolean"
+ },
+ "permitted_uses_include_custom_description": {
+ "type": "string"
+ },
+ "permitted_uses_include_customers_affiliates": {
+ "type": "boolean"
+ },
+ "permitted_uses_include_internal_business": {
+ "type": "boolean"
+ },
+ "pilot_period_stripe_product_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-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": {
+ "enum": [
+ "days",
+ "subscription_end"
+ ],
+ "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": {
+ "enum": [
+ "day",
+ "week",
+ "month",
+ "year"
+ ],
+ "type": "string"
+ },
+ "warranty_period_description_duration_start": {
+ "enum": [
+ "initial delivery of the Software",
+ "delivery of the Software and each subsequent Update",
+ "the Order Date"
+ ],
+ "type": "string"
+ },
+ "warranty_period_type": {
+ "enum": [
+ "description",
+ "none"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "type": {
+ "description": "The type of template to create.",
+ "enum": [
+ "Software License"
+ ],
+ "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-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": {
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "type": "string"
+ },
+ "fees_type": {
+ "enum": [
+ "free",
+ "pilot_period_fees"
+ ],
+ "type": "string"
+ },
+ "general_cap_amount": {
+ "type": "number"
+ },
+ "general_cap_amount_type": {
+ "enum": [
+ "preceding",
+ "base",
+ "period"
+ ],
+ "type": "string"
+ },
+ "general_cap_period_currency": {
+ "type": "number"
+ },
+ "general_cap_period_qty": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "general_cap_preceding_amount": {
+ "type": "number"
+ },
+ "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": {
+ "enum": [
+ "description",
+ "attachment",
+ "standard"
+ ],
+ "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": {
+ "enum": [
+ "monthly",
+ "quarterly",
+ "annually",
+ "once_per_period"
+ ],
+ "type": "string"
+ },
+ "payment_process_invoice_days": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "payment_process_invoice_from": {
+ "enum": [
+ "receipt",
+ "date"
+ ],
+ "type": "string"
+ },
+ "payment_process_invoice_timeframe": {
+ "enum": [
+ "days",
+ "weeks",
+ "months",
+ "quarters",
+ "years"
+ ],
+ "type": "string"
+ },
+ "payment_process_type": {
+ "enum": [
+ "automatic",
+ "invoice"
+ ],
+ "type": "string"
+ },
+ "pilot_period_description": {
+ "type": "string"
+ },
+ "pilot_period_fees_description": {
+ "type": "string"
+ },
+ "product_description": {
+ "type": "string"
+ },
+ "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.",
+ "enum": [
+ "Pilot"
+ ],
+ "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-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": {
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "type": "string"
+ },
+ "general_cap_amount_currency_val": {
+ "type": "number"
+ },
+ "general_cap_amount_either_currency": {
+ "type": "number"
+ },
+ "general_cap_amount_either_multiple": {
+ "type": "number"
+ },
+ "general_cap_amount_multiple_val": {
+ "type": "number"
+ },
+ "general_cap_amount_type": {
+ "enum": [
+ "multiple",
+ "currency",
+ "either",
+ "base"
+ ],
+ "type": "string"
+ },
+ "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": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_increased_cap_amount": {
+ "type": "boolean"
+ },
+ "include_increased_cap_amount_currency": {
+ "type": "number"
+ },
+ "include_increased_cap_amount_either_currency": {
+ "type": "number"
+ },
+ "include_increased_cap_amount_either_multiple": {},
+ "include_increased_cap_amount_multiple": {},
+ "include_increased_cap_amount_type": {
+ "enum": [
+ "multiple",
+ "currency",
+ "either"
+ ],
+ "type": "string"
+ },
+ "include_increased_claims": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_confidentiality": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_confidentiality_misconduct": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_covered_claims": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_misconduct": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_other": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_other_val": {
+ "type": "string"
+ },
+ "include_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": {
+ "enum": [
+ "month(s)",
+ "quarter(s)",
+ "year(s)"
+ ],
+ "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": {
+ "enum": [
+ "date",
+ "effective date"
+ ],
+ "type": "string"
+ },
+ "include_obligations_company_brand": {
+ "type": "boolean"
+ },
+ "include_obligations_company_promotion": {
+ "type": "boolean"
+ },
+ "include_obligations_company_promotion_include_activities": {
+ "type": "boolean"
+ },
+ "include_obligations_company_promotion_include_activities_val": {
+ "type": "string"
+ },
+ "include_obligations_company_promotion_include_materials": {
+ "type": "boolean"
+ },
+ "include_obligations_company_promotion_include_materials_val": {
+ "type": "string"
+ },
+ "include_obligations_company_referral": {
+ "type": "boolean"
+ },
+ "include_obligations_company_referral_include_criteria": {
+ "type": "boolean"
+ },
+ "include_obligations_company_referral_include_criteria_val": {
+ "type": "string"
+ },
+ "include_obligations_company_referral_include_pay_sch": {
+ "type": "boolean"
+ },
+ "include_obligations_company_referral_include_pay_sch_amount": {
+ "type": "number"
+ },
+ "include_obligations_company_referral_include_pay_sch_custom": {
+ "type": "string"
+ },
+ "include_obligations_company_referral_include_pay_sch_unit": {
+ "enum": [
+ "U.S. Dollars",
+ "percent"
+ ],
+ "type": "string"
+ },
+ "include_obligations_company_sponsorship": {
+ "type": "boolean"
+ },
+ "include_obligations_company_sponsorship_include_benefits": {
+ "type": "boolean"
+ },
+ "include_obligations_company_sponsorship_include_benefits_val": {
+ "type": "string"
+ },
+ "include_obligations_company_sponsorship_include_payments": {
+ "type": "boolean"
+ },
+ "include_obligations_company_sponsorship_include_payments_amount": {
+ "type": "number"
+ },
+ "include_obligations_company_sponsorship_include_payments_unit": {
+ "enum": [
+ "U.S. Dollars",
+ "percent"
+ ],
+ "type": "string"
+ },
+ "include_obligations_partner_brand": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_promotion": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_promotion_include_activities": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_promotion_include_activities_val": {
+ "type": "string"
+ },
+ "include_obligations_partner_promotion_include_materials": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_promotion_include_materials_val": {
+ "type": "string"
+ },
+ "include_obligations_partner_referral": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_referral_include_criteria": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_referral_include_criteria_val": {
+ "type": "string"
+ },
+ "include_obligations_partner_referral_include_pay_sch": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_referral_include_pay_sch_amount": {
+ "type": "number"
+ },
+ "include_obligations_partner_referral_include_pay_sch_custom": {
+ "type": "string"
+ },
+ "include_obligations_partner_referral_include_pay_sch_unit": {
+ "enum": [
+ "U.S. Dollars",
+ "percent"
+ ],
+ "type": "string"
+ },
+ "include_obligations_partner_sponsorship": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_sponsorship_include_benefits": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_sponsorship_include_benefits_val": {
+ "type": "string"
+ },
+ "include_obligations_partner_sponsorship_include_payments": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_sponsorship_include_payments_amount": {
+ "type": "number"
+ },
+ "include_obligations_partner_sponsorship_include_payments_unit": {
+ "enum": [
+ "U.S. Dollars",
+ "percent"
+ ],
+ "type": "string"
+ },
+ "include_payment_process": {
+ "type": "boolean"
+ },
+ "include_payment_process_company": {
+ "type": "boolean"
+ },
+ "include_payment_process_company_include_address": {
+ "type": "boolean"
+ },
+ "include_payment_process_company_include_address_city": {
+ "type": "string"
+ },
+ "include_payment_process_company_include_address_country": {
+ "type": "string"
+ },
+ "include_payment_process_company_include_address_state": {
+ "type": "string"
+ },
+ "include_payment_process_company_include_address_street_address": {
+ "type": "string"
+ },
+ "include_payment_process_company_include_address_zipcode": {
+ "type": "string"
+ },
+ "include_payment_process_company_include_email": {
+ "type": "boolean"
+ },
+ "include_payment_process_company_include_email_val": {
+ "format": "email",
+ "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "include_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-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": {
+ "enum": [
+ "receipt",
+ "date"
+ ],
+ "type": "string"
+ },
+ "include_payment_schedule_specified_unit": {
+ "enum": [
+ "day(s)",
+ "week(s)",
+ "month(s)",
+ "quarter(s)",
+ "year(s)"
+ ],
+ "type": "string"
+ },
+ "include_payment_schedule_type": {
+ "enum": [
+ "specified",
+ "custom"
+ ],
+ "type": "string"
+ },
+ "negotiations_allowed": {
+ "description": "Whether counterparties can propose changes to agreements created from this template.",
+ "type": "boolean"
+ },
+ "territory_type": {
+ "enum": [
+ "worldwide",
+ "custom"
+ ],
+ "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.",
+ "enum": [
+ "Partnership"
+ ],
+ "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": {
+ "enum": [
+ "hours",
+ "business days",
+ "calendar days"
+ ],
+ "type": "string"
+ },
+ "breach_notification_val": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "business_associate_relationship_type": {
+ "enum": [
+ "provider",
+ "company"
+ ],
+ "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-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": {
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "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.",
+ "enum": [
+ "BAA"
+ ],
+ "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": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "confidentiality_type": {
+ "enum": [
+ "mutual",
+ "nda",
+ "provider",
+ "custom"
+ ],
+ "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-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": {
+ "enum": [
+ "month",
+ "year",
+ "quarter"
+ ],
+ "type": "string"
+ },
+ "include_fees_include_amount": {
+ "type": "boolean"
+ },
+ "include_fees_include_other": {
+ "type": "boolean"
+ },
+ "include_fees_other": {
+ "type": "string"
+ },
+ "include_functionality": {
+ "type": "boolean"
+ },
+ "include_functionality_val": {
+ "type": "string"
+ },
+ "include_launch_date": {
+ "type": "boolean"
+ },
+ "include_launch_date_custom": {
+ "type": "string"
+ },
+ "include_launch_date_date": {
+ "format": "date-time",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$",
+ "type": "string"
+ },
+ "include_launch_date_type": {
+ "enum": [
+ "date",
+ "custom"
+ ],
+ "type": "string"
+ },
+ "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.",
+ "enum": [
+ "LOI"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "type"
+ ],
+ "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-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-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.",
- "enum": [
- "signature",
- "date"
- ],
- "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"
- },
- "include_terms": {
- "description": "When true, the standard terms are included 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 to the legal terms. For agreement types without separate business terms, that covers every term. CSA order forms, PSA statements of work, partnership business terms and software license order forms have their own `negotiations_allowed` flag.",
- "type": "boolean"
- },
- "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-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-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-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-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-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.",
- "enum": [
- "signature",
- "date"
- ],
- "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"
- },
- "include_terms": {
- "description": "When true, the standard terms are included 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 to the legal terms. For agreement types without separate business terms, that covers every term. CSA order forms, PSA statements of work, partnership business terms and software license order forms have their own `negotiations_allowed` flag.",
- "type": "boolean"
- },
- "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-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-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-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-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-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.",
- "enum": [
- "signature",
- "date"
- ],
- "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"
- },
- "include_terms": {
- "description": "When true, the standard terms are included 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 to the legal terms. For agreement types without separate business terms, that covers every term. CSA order forms, PSA statements of work, partnership business terms and software license order forms have their own `negotiations_allowed` flag.",
- "type": "boolean"
- },
- "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-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-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-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-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-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.",
- "enum": [
- "signature",
- "date"
- ],
- "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"
- },
- "include_terms": {
- "description": "When true, the standard terms are included 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 to the legal terms. For agreement types without separate business terms, that covers every term. CSA order forms, PSA statements of work, partnership business terms and software license order forms have their own `negotiations_allowed` flag.",
- "type": "boolean"
- },
- "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-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-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-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-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-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.",
- "enum": [
- "signature",
- "date"
- ],
- "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"
- },
- "include_terms": {
- "description": "When true, the standard terms are included 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 to the legal terms. For agreement types without separate business terms, that covers every term. CSA order forms, PSA statements of work, partnership business terms and software license order forms have their own `negotiations_allowed` flag.",
- "type": "boolean"
- },
- "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-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-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-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-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-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.",
- "enum": [
- "signature",
- "date"
- ],
- "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"
- },
- "include_terms": {
- "description": "When true, the standard terms are included 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 to the legal terms. For agreement types without separate business terms, that covers every term. CSA order forms, PSA statements of work, partnership business terms and software license order forms have their own `negotiations_allowed` flag.",
- "type": "boolean"
- },
- "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-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-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-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-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-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.",
- "enum": [
- "signature",
- "date"
- ],
- "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"
- },
- "include_terms": {
- "description": "When true, the standard terms are included 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 to the legal terms. For agreement types without separate business terms, that covers every term. CSA order forms, PSA statements of work, partnership business terms and software license order forms have their own `negotiations_allowed` flag.",
- "type": "boolean"
- },
- "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-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-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-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-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-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.",
- "enum": [
- "signature",
- "date"
- ],
- "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"
- },
- "include_terms": {
- "description": "When true, the standard terms are included 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 to the legal terms. For agreement types without separate business terms, that covers every term. CSA order forms, PSA statements of work, partnership business terms and software license order forms have their own `negotiations_allowed` flag.",
- "type": "boolean"
- },
- "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-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-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-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-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-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.",
- "enum": [
- "signature",
- "date"
- ],
- "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"
- },
- "include_terms": {
- "description": "When true, the standard terms are included 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 to the legal terms. For agreement types without separate business terms, that covers every term. CSA order forms, PSA statements of work, partnership business terms and software license order forms have their own `negotiations_allowed` flag.",
- "type": "boolean"
- },
- "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-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-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-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-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-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.",
- "enum": [
- "signature",
- "date"
- ],
- "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"
- },
- "include_terms": {
- "description": "When true, the standard terms are included 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 to the legal terms. For agreement types without separate business terms, that covers every term. CSA order forms, PSA statements of work, partnership business terms and software license order forms have their own `negotiations_allowed` flag.",
- "type": "boolean"
- },
- "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-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-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-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-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-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.",
- "enum": [
- "signature",
- "date"
- ],
- "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"
- },
- "include_terms": {
- "description": "When true, the standard terms are included 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 to the legal terms. For agreement types without separate business terms, that covers every term. CSA order forms, PSA statements of work, partnership business terms and software license order forms have their own `negotiations_allowed` flag.",
- "type": "boolean"
- },
- "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-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-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-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-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-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.",
- "enum": [
- "signature",
- "date"
- ],
- "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"
- },
- "include_terms": {
- "description": "When true, the standard terms are included 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 to the legal terms. For agreement types without separate business terms, that covers every term. CSA order forms, PSA statements of work, partnership business terms and software license order forms have their own `negotiations_allowed` flag.",
- "type": "boolean"
- },
- "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-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-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-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"
- }
-]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-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-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.",
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "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"
+ },
+ "include_terms": {
+ "description": "When true, the standard terms are included 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 to the legal terms. For agreement types without separate business terms, that covers every term. CSA order forms, PSA statements of work, partnership business terms and software license order forms have their own `negotiations_allowed` flag.",
+ "type": "boolean"
+ },
+ "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-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-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "recipient_organization": {
+ "description": "The counterparty's organization.",
+ "type": "string"
+ },
+ "recipient_role": {
+ "description": "PSA only. The recipient's role: `Customer` (the default) or `Provider`. Send it with `sender_role`; the two must be one `Provider` and one `Customer`. Other standard agreement types ignore it.",
+ "type": "string"
+ },
+ "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-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "sender_role": {
+ "description": "PSA only. Your company's role: `Provider` (the default) or `Customer` when you hire the recipient to provide the services. Send it with `recipient_role`; the two must be one `Provider` and one `Customer`. When reading a PSA, an empty `sender_role` means `Provider`. Other standard agreement types ignore it.",
+ "type": "string"
+ },
+ "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-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-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.",
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "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"
+ },
+ "include_terms": {
+ "description": "When true, the standard terms are included 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 to the legal terms. For agreement types without separate business terms, that covers every term. CSA order forms, PSA statements of work, partnership business terms and software license order forms have their own `negotiations_allowed` flag.",
+ "type": "boolean"
+ },
+ "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-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-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "recipient_organization": {
+ "description": "The counterparty's organization.",
+ "type": "string"
+ },
+ "recipient_role": {
+ "description": "PSA only. The recipient's role: `Customer` (the default) or `Provider`. Send it with `sender_role`; the two must be one `Provider` and one `Customer`. Other standard agreement types ignore it.",
+ "type": "string"
+ },
+ "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-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "sender_role": {
+ "description": "PSA only. Your company's role: `Provider` (the default) or `Customer` when you hire the recipient to provide the services. Send it with `recipient_role`; the two must be one `Provider` and one `Customer`. When reading a PSA, an empty `sender_role` means `Provider`. Other standard agreement types ignore it.",
+ "type": "string"
+ },
+ "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-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-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.",
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "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"
+ },
+ "include_terms": {
+ "description": "When true, the standard terms are included 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 to the legal terms. For agreement types without separate business terms, that covers every term. CSA order forms, PSA statements of work, partnership business terms and software license order forms have their own `negotiations_allowed` flag.",
+ "type": "boolean"
+ },
+ "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-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-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "recipient_organization": {
+ "description": "The counterparty's organization.",
+ "type": "string"
+ },
+ "recipient_role": {
+ "description": "PSA only. The recipient's role: `Customer` (the default) or `Provider`. Send it with `sender_role`; the two must be one `Provider` and one `Customer`. Other standard agreement types ignore it.",
+ "type": "string"
+ },
+ "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-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "sender_role": {
+ "description": "PSA only. Your company's role: `Provider` (the default) or `Customer` when you hire the recipient to provide the services. Send it with `recipient_role`; the two must be one `Provider` and one `Customer`. When reading a PSA, an empty `sender_role` means `Provider`. Other standard agreement types ignore it.",
+ "type": "string"
+ },
+ "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-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-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.",
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "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"
+ },
+ "include_terms": {
+ "description": "When true, the standard terms are included 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 to the legal terms. For agreement types without separate business terms, that covers every term. CSA order forms, PSA statements of work, partnership business terms and software license order forms have their own `negotiations_allowed` flag.",
+ "type": "boolean"
+ },
+ "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-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-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "recipient_organization": {
+ "description": "The counterparty's organization.",
+ "type": "string"
+ },
+ "recipient_role": {
+ "description": "PSA only. The recipient's role: `Customer` (the default) or `Provider`. Send it with `sender_role`; the two must be one `Provider` and one `Customer`. Other standard agreement types ignore it.",
+ "type": "string"
+ },
+ "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-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "sender_role": {
+ "description": "PSA only. Your company's role: `Provider` (the default) or `Customer` when you hire the recipient to provide the services. Send it with `recipient_role`; the two must be one `Provider` and one `Customer`. When reading a PSA, an empty `sender_role` means `Provider`. Other standard agreement types ignore it.",
+ "type": "string"
+ },
+ "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-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-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.",
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "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"
+ },
+ "include_terms": {
+ "description": "When true, the standard terms are included 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 to the legal terms. For agreement types without separate business terms, that covers every term. CSA order forms, PSA statements of work, partnership business terms and software license order forms have their own `negotiations_allowed` flag.",
+ "type": "boolean"
+ },
+ "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-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-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "recipient_organization": {
+ "description": "The counterparty's organization.",
+ "type": "string"
+ },
+ "recipient_role": {
+ "description": "PSA only. The recipient's role: `Customer` (the default) or `Provider`. Send it with `sender_role`; the two must be one `Provider` and one `Customer`. Other standard agreement types ignore it.",
+ "type": "string"
+ },
+ "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-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "sender_role": {
+ "description": "PSA only. Your company's role: `Provider` (the default) or `Customer` when you hire the recipient to provide the services. Send it with `recipient_role`; the two must be one `Provider` and one `Customer`. When reading a PSA, an empty `sender_role` means `Provider`. Other standard agreement types ignore it.",
+ "type": "string"
+ },
+ "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-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-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.",
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "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"
+ },
+ "include_terms": {
+ "description": "When true, the standard terms are included 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 to the legal terms. For agreement types without separate business terms, that covers every term. CSA order forms, PSA statements of work, partnership business terms and software license order forms have their own `negotiations_allowed` flag.",
+ "type": "boolean"
+ },
+ "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-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-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "recipient_organization": {
+ "description": "The counterparty's organization.",
+ "type": "string"
+ },
+ "recipient_role": {
+ "description": "PSA only. The recipient's role: `Customer` (the default) or `Provider`. Send it with `sender_role`; the two must be one `Provider` and one `Customer`. Other standard agreement types ignore it.",
+ "type": "string"
+ },
+ "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-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "sender_role": {
+ "description": "PSA only. Your company's role: `Provider` (the default) or `Customer` when you hire the recipient to provide the services. Send it with `recipient_role`; the two must be one `Provider` and one `Customer`. When reading a PSA, an empty `sender_role` means `Provider`. Other standard agreement types ignore it.",
+ "type": "string"
+ },
+ "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-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-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.",
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "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"
+ },
+ "include_terms": {
+ "description": "When true, the standard terms are included 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 to the legal terms. For agreement types without separate business terms, that covers every term. CSA order forms, PSA statements of work, partnership business terms and software license order forms have their own `negotiations_allowed` flag.",
+ "type": "boolean"
+ },
+ "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-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-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "recipient_organization": {
+ "description": "The counterparty's organization.",
+ "type": "string"
+ },
+ "recipient_role": {
+ "description": "PSA only. The recipient's role: `Customer` (the default) or `Provider`. Send it with `sender_role`; the two must be one `Provider` and one `Customer`. Other standard agreement types ignore it.",
+ "type": "string"
+ },
+ "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-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "sender_role": {
+ "description": "PSA only. Your company's role: `Provider` (the default) or `Customer` when you hire the recipient to provide the services. Send it with `recipient_role`; the two must be one `Provider` and one `Customer`. When reading a PSA, an empty `sender_role` means `Provider`. Other standard agreement types ignore it.",
+ "type": "string"
+ },
+ "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-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-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.",
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "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"
+ },
+ "include_terms": {
+ "description": "When true, the standard terms are included 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 to the legal terms. For agreement types without separate business terms, that covers every term. CSA order forms, PSA statements of work, partnership business terms and software license order forms have their own `negotiations_allowed` flag.",
+ "type": "boolean"
+ },
+ "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-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-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "recipient_organization": {
+ "description": "The counterparty's organization.",
+ "type": "string"
+ },
+ "recipient_role": {
+ "description": "PSA only. The recipient's role: `Customer` (the default) or `Provider`. Send it with `sender_role`; the two must be one `Provider` and one `Customer`. Other standard agreement types ignore it.",
+ "type": "string"
+ },
+ "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-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "sender_role": {
+ "description": "PSA only. Your company's role: `Provider` (the default) or `Customer` when you hire the recipient to provide the services. Send it with `recipient_role`; the two must be one `Provider` and one `Customer`. When reading a PSA, an empty `sender_role` means `Provider`. Other standard agreement types ignore it.",
+ "type": "string"
+ },
+ "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-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-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.",
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "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"
+ },
+ "include_terms": {
+ "description": "When true, the standard terms are included 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 to the legal terms. For agreement types without separate business terms, that covers every term. CSA order forms, PSA statements of work, partnership business terms and software license order forms have their own `negotiations_allowed` flag.",
+ "type": "boolean"
+ },
+ "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-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-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "recipient_organization": {
+ "description": "The counterparty's organization.",
+ "type": "string"
+ },
+ "recipient_role": {
+ "description": "PSA only. The recipient's role: `Customer` (the default) or `Provider`. Send it with `sender_role`; the two must be one `Provider` and one `Customer`. Other standard agreement types ignore it.",
+ "type": "string"
+ },
+ "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-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "sender_role": {
+ "description": "PSA only. Your company's role: `Provider` (the default) or `Customer` when you hire the recipient to provide the services. Send it with `recipient_role`; the two must be one `Provider` and one `Customer`. When reading a PSA, an empty `sender_role` means `Provider`. Other standard agreement types ignore it.",
+ "type": "string"
+ },
+ "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-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-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.",
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "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"
+ },
+ "include_terms": {
+ "description": "When true, the standard terms are included 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 to the legal terms. For agreement types without separate business terms, that covers every term. CSA order forms, PSA statements of work, partnership business terms and software license order forms have their own `negotiations_allowed` flag.",
+ "type": "boolean"
+ },
+ "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-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-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "recipient_organization": {
+ "description": "The counterparty's organization.",
+ "type": "string"
+ },
+ "recipient_role": {
+ "description": "PSA only. The recipient's role: `Customer` (the default) or `Provider`. Send it with `sender_role`; the two must be one `Provider` and one `Customer`. Other standard agreement types ignore it.",
+ "type": "string"
+ },
+ "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-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "sender_role": {
+ "description": "PSA only. Your company's role: `Provider` (the default) or `Customer` when you hire the recipient to provide the services. Send it with `recipient_role`; the two must be one `Provider` and one `Customer`. When reading a PSA, an empty `sender_role` means `Provider`. Other standard agreement types ignore it.",
+ "type": "string"
+ },
+ "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-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-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.",
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "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"
+ },
+ "include_terms": {
+ "description": "When true, the standard terms are included 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 to the legal terms. For agreement types without separate business terms, that covers every term. CSA order forms, PSA statements of work, partnership business terms and software license order forms have their own `negotiations_allowed` flag.",
+ "type": "boolean"
+ },
+ "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-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-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "recipient_organization": {
+ "description": "The counterparty's organization.",
+ "type": "string"
+ },
+ "recipient_role": {
+ "description": "PSA only. The recipient's role: `Customer` (the default) or `Provider`. Send it with `sender_role`; the two must be one `Provider` and one `Customer`. Other standard agreement types ignore it.",
+ "type": "string"
+ },
+ "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-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "sender_role": {
+ "description": "PSA only. Your company's role: `Provider` (the default) or `Customer` when you hire the recipient to provide the services. Send it with `recipient_role`; the two must be one `Provider` and one `Customer`. When reading a PSA, an empty `sender_role` means `Provider`. Other standard agreement types ignore it.",
+ "type": "string"
+ },
+ "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-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-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.",
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "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"
+ },
+ "include_terms": {
+ "description": "When true, the standard terms are included 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 to the legal terms. For agreement types without separate business terms, that covers every term. CSA order forms, PSA statements of work, partnership business terms and software license order forms have their own `negotiations_allowed` flag.",
+ "type": "boolean"
+ },
+ "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-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-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "recipient_organization": {
+ "description": "The counterparty's organization.",
+ "type": "string"
+ },
+ "recipient_role": {
+ "description": "PSA only. The recipient's role: `Customer` (the default) or `Provider`. Send it with `sender_role`; the two must be one `Provider` and one `Customer`. Other standard agreement types ignore it.",
+ "type": "string"
+ },
+ "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-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "sender_role": {
+ "description": "PSA only. Your company's role: `Provider` (the default) or `Customer` when you hire the recipient to provide the services. Send it with `recipient_role`; the two must be one `Provider` and one `Customer`. When reading a PSA, an empty `sender_role` means `Provider`. Other standard agreement types ignore it.",
+ "type": "string"
+ },
+ "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"
+ }
+]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-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": {
- "enum": [
- "signature",
- "date"
- ],
- "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": {
- "enum": [
- "stripe",
- "link"
- ],
- "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-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": {
- "enum": [
- "AWS",
- "GCP",
- "Azure"
- ],
- "type": "string"
- },
- "effective_date_type": {
- "enum": [
- "signature",
- "date",
- "marketplace_acceptance"
- ],
- "type": "string"
- },
- "general_cap_amount": {
- "type": "number"
- },
- "general_cap_amount_type": {
- "enum": [
- "preceding",
- "base",
- "period"
- ],
- "type": "string"
- },
- "general_cap_period_currency": {
- "type": "number"
- },
- "general_cap_period_qty": {
- "type": "number"
- },
- "general_cap_preceding_amount": {
- "type": "number"
- },
- "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": {
- "enum": [
- "description",
- "attachment"
- ],
- "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": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_increased_cap_amount": {
- "type": "boolean"
- },
- "include_increased_claims": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_confidentiality": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_confidentiality_negligence": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_privsec": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_privsec_negligence": {
- "type": "boolean"
- },
- "include_increased_claims_include_other": {
- "type": "boolean"
- },
- "include_increased_claims_indemnification_obligation": {
- "type": "boolean"
- },
- "include_increased_claims_other": {
- "type": "string"
- },
- "include_insurance_minimums": {
- "type": "boolean"
- },
- "include_insurance_minimums_add_customer": {
- "type": "boolean"
- },
- "include_insurance_minimums_add_customer_com_gen_liability": {
- "type": "boolean"
- },
- "include_insurance_minimums_add_customer_cyber_liability": {
- "type": "boolean"
- },
- "include_insurance_minimums_add_customer_errors_omissions": {
- "type": "boolean"
- },
- "include_insurance_minimums_additional_information": {
- "type": "boolean"
- },
- "include_insurance_minimums_additional_information_text": {
- "type": "string"
- },
- "include_insurance_minimums_cyber_liability_aggregate": {
- "type": "number"
- },
- "include_insurance_minimums_cyber_liability_minimum": {
- "type": "number"
- },
- "include_insurance_minimums_employer_liability_aggregate": {
- "type": "number"
- },
- "include_insurance_minimums_employer_liability_minimum": {
- "type": "number"
- },
- "include_insurance_minimums_general_liability_aggregate": {
- "type": "number"
- },
- "include_insurance_minimums_general_liability_minimum": {
- "type": "number"
- },
- "include_insurance_minimums_include_cyber_liability": {
- "type": "boolean"
- },
- "include_insurance_minimums_include_employer_liability": {
- "type": "boolean"
- },
- "include_insurance_minimums_include_general_liability": {
- "type": "boolean"
- },
- "include_insurance_minimums_include_workers_compensation": {
- "type": "boolean"
- },
- "include_publicity_rights": {
- "type": "boolean"
- },
- "include_publicity_rights_type": {
- "enum": [
- "public",
- "non-public"
- ],
- "type": "string"
- },
- "include_security_policy": {
- "type": "boolean"
- },
- "include_security_policy_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_security_policy_fedramp_auth": {
- "type": "boolean"
- },
- "include_security_policy_hipaa": {
- "type": "boolean"
- },
- "include_security_policy_hitrust": {
- "type": "boolean"
- },
- "include_security_policy_include_annual_maintenance": {
- "type": "boolean"
- },
- "include_security_policy_include_location": {
- "type": "boolean"
- },
- "include_security_policy_include_other": {
- "type": "boolean"
- },
- "include_security_policy_include_reasonable_efforts": {
- "type": "boolean"
- },
- "include_security_policy_iso27001": {
- "type": "boolean"
- },
- "include_security_policy_location": {
- "type": "string"
- },
- "include_security_policy_other": {
- "type": "string"
- },
- "include_security_policy_pci1": {
- "type": "boolean"
- },
- "include_security_policy_pci2": {
- "type": "boolean"
- },
- "include_security_policy_penetration_testing": {
- "type": "boolean"
- },
- "include_security_policy_soc2": {
- "type": "boolean"
- },
- "include_security_policy_soc2_type2": {
- "type": "boolean"
- },
- "include_security_policy_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_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": {
- "type": "number"
- },
- "increased_cap_amount_qty": {
- "type": "number"
- },
- "increased_cap_amount_type": {
- "enum": [
- "qty",
- "currency",
- "period"
- ],
- "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": {
- "enum": [
- "automatic",
- "invoice"
- ],
- "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": {
- "enum": [
- "Subscription Period",
- "month",
- "year",
- "User",
- "Custom unit"
- ],
- "type": "string"
- },
- "fees_attributes": {
- "description": "Fee table rows. On update, an item without `id` adds a fee; 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 fee.",
- "type": "boolean"
- },
- "attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-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"
- },
- "id": {
- "description": "ID of an existing fee to update or remove. Omit to add a new fee.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "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": {
- "enum": [
- "USD",
- "EUR",
- "GBP",
- "CAD",
- "AUD",
- "SGD",
- "ILS",
- "JPY",
- "CHF",
- "HKD"
- ],
- "type": "string"
- },
- "fees_include_fee_increase_upon_renewal": {
- "type": "boolean"
- },
- "fees_include_fee_increase_upon_renewal_fee": {
- "type": "number"
- },
- "fees_include_fee_increase_upon_renewal_type": {
- "enum": [
- "will",
- "may"
- ],
- "type": "string"
- },
- "fees_inclusive_of_taxes": {
- "type": "boolean"
- },
- "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": {
- "enum": [
- "Subscription Period",
- "month",
- "year",
- "User"
- ],
- "type": "string"
- },
- "include_free_trial": {
- "type": "boolean"
- },
- "include_max_users": {
- "type": "boolean"
- },
- "include_pilot_period": {
- "type": "boolean"
- },
- "include_pilot_period_duration_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_pilot_period_duration_type": {
- "enum": [
- "day",
- "week",
- "month"
- ],
- "type": "string"
- },
- "include_pilot_period_include_fees": {
- "type": "boolean"
- },
- "include_pilot_period_include_fees_amount": {
- "type": "number"
- },
- "include_pilot_period_include_modifications": {
- "type": "boolean"
- },
- "include_pilot_period_include_modifications_description": {
- "type": "string"
- },
- "include_product_support": {
- "type": "boolean"
- },
- "include_product_support_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_product_support_description": {
- "type": "string"
- },
- "include_product_support_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_professional_services": {
- "type": "boolean"
- },
- "include_professional_services_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_professional_services_custom_name": {
- "type": "string"
- },
- "include_professional_services_description": {
- "type": "string"
- },
- "include_professional_services_end_date": {
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "include_professional_services_fees_description": {
- "type": "string"
- },
- "include_professional_services_include_end_date": {
- "type": "boolean"
- },
- "include_professional_services_include_fees_description": {
- "type": "boolean"
- },
- "include_professional_services_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_sla": {
- "type": "boolean"
- },
- "include_sla_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_sla_description": {
- "type": "string"
- },
- "include_sla_include_response_time": {
- "type": "boolean"
- },
- "include_sla_include_response_time_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_sla_include_response_time_credit": {
- "type": "number"
- },
- "include_sla_include_response_time_duration": {
- "enum": [
- "hour",
- "day",
- "week",
- "month",
- "hours"
- ],
- "type": "string"
- },
- "include_sla_include_response_time_support_channel": {
- "type": "string"
- },
- "include_sla_include_target_uptime": {
- "type": "boolean"
- },
- "include_sla_maintenance_notice": {
- "type": "boolean"
- },
- "include_sla_maintenance_window": {
- "type": "boolean"
- },
- "include_sla_maintenance_window_type": {
- "enum": [
- "standard",
- "none"
- ],
- "type": "string"
- },
- "include_sla_standard_maintenance_notice_qty": {
- "type": "number"
- },
- "include_sla_standard_maintenance_notice_unit": {
- "enum": [
- "hour",
- "day",
- "week",
- "month"
- ],
- "type": "string"
- },
- "include_sla_standard_maintenance_window_end_time": {
- "type": "string"
- },
- "include_sla_standard_maintenance_window_friday": {
- "type": "boolean"
- },
- "include_sla_standard_maintenance_window_monday": {
- "type": "boolean"
- },
- "include_sla_standard_maintenance_window_saturday": {
- "type": "boolean"
- },
- "include_sla_standard_maintenance_window_start_time": {
- "type": "string"
- },
- "include_sla_standard_maintenance_window_sunday": {
- "type": "boolean"
- },
- "include_sla_standard_maintenance_window_thursday": {
- "type": "boolean"
- },
- "include_sla_standard_maintenance_window_time_zone": {
- "type": "string"
- },
- "include_sla_standard_maintenance_window_tuesday": {
- "type": "boolean"
- },
- "include_sla_standard_maintenance_window_wednesday": {
- "type": "boolean"
- },
- "include_sla_standard_target_uptime": {
- "type": "number"
- },
- "include_sla_type": {
- "enum": [
- "description",
- "standard",
- "attachment"
- ],
- "type": "string"
- },
- "include_subscription_start_date": {
- "type": "boolean"
- },
- "include_subscription_start_date_date": {
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "include_usage_review": {
- "type": "boolean"
- },
- "include_usage_review_val": {
- "type": "string"
- },
- "include_use_limitations": {
- "type": "boolean"
- },
- "include_use_limitations_val": {
- "type": "string"
- },
- "invoice_period": {
- "enum": [
- "monthly",
- "quarterly",
- "semiannually",
- "annually",
- "Custom unit",
- "Monthly",
- "Quarterly",
- "Semiannually",
- "Annually"
- ],
- "type": "string"
- },
- "invoice_period_custom_unit": {
- "type": "string"
- },
- "max_consumption": {
- "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": {
- "enum": [
- "signature",
- "date",
- "other"
- ],
- "type": "string"
- },
- "payment_period": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "payment_period_timeframe": {
- "enum": [
- "Customer's receipt of invoice",
- "date of invoice"
- ],
- "type": "string"
- },
- "payment_period_unit": {
- "enum": [
- "day(s)",
- "week(s)",
- "month(s)",
- "marketplace_acceptance"
- ],
- "type": "string"
- },
- "payment_process_automatic_frequency": {
- "enum": [
- "monthly",
- "quarterly",
- "semiannually",
- "annually"
- ],
- "type": "string"
- },
- "payment_process_type": {
- "enum": [
- "automatic",
- "invoice",
- "custom",
- "marketplace_acceptance"
- ],
- "type": "string"
- },
- "payment_process_type_custom_val": {
- "type": "string"
- },
- "payment_process_type_invoice_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "payment_process_type_invoice_custom_unit": {
- "type": "string"
- },
- "payment_process_type_invoice_duration": {
- "enum": [
- "day",
- "week",
- "month",
- "year",
- "day(s)",
- "week(s)",
- "month(s)",
- "year(s)"
- ],
- "type": "string"
- },
- "payment_process_type_invoice_duration_start": {
- "enum": [
- "Customer's receipt of invoice",
- "date of invoice"
- ],
- "type": "string"
- },
- "payment_process_type_invoice_type": {
- "enum": [
- "monthly",
- "quarterly",
- "semiannually",
- "annually",
- "Custom unit"
- ],
- "type": "string"
- },
- "pilot_period_stripe_product_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-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": {
- "enum": [
- "days",
- "subscription_end"
- ],
- "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": {
- "enum": [
- "effective_date",
- "date"
- ],
- "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-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-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-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": {
- "enum": [
- "signature",
- "date"
- ],
- "type": "string"
- },
- "general_cap_amount": {
- "type": "number"
- },
- "general_cap_amount_type": {
- "enum": [
- "preceding",
- "base",
- "period"
- ],
- "type": "string"
- },
- "general_cap_period_currency": {
- "type": "number"
- },
- "general_cap_period_qty": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "general_cap_preceding_amount": {
- "type": "number"
- },
- "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": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_dpa": {
- "type": "boolean"
- },
- "include_dpa_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_dpa_location": {
- "type": "string"
- },
- "include_dpa_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_increased_cap_amount": {
- "type": "boolean"
- },
- "include_increased_claims": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_confidentiality": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_confidentiality_negligence": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_privsec": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_privsec_negligence": {
- "type": "boolean"
- },
- "include_increased_claims_include_other": {
- "type": "boolean"
- },
- "include_increased_claims_indemnification_obligation": {
- "type": "boolean"
- },
- "include_increased_claims_negligence": {
- "type": "boolean"
- },
- "include_increased_claims_other": {
- "type": "string"
- },
- "include_provider_insurance_min": {
- "type": "boolean"
- },
- "include_provider_insurance_min_add_customer_com_gen_liability": {
- "type": "boolean"
- },
- "include_provider_insurance_min_add_customer_cyber_liability": {
- "type": "boolean"
- },
- "include_provider_insurance_min_add_customer_errors_omissions": {
- "type": "boolean"
- },
- "include_provider_insurance_min_auto_liability_aggregate": {
- "type": "number"
- },
- "include_provider_insurance_min_auto_liability_minimum": {
- "type": "number"
- },
- "include_provider_insurance_min_cyber_liability_aggregate": {
- "type": "number"
- },
- "include_provider_insurance_min_cyber_liability_minimum": {
- "type": "number"
- },
- "include_provider_insurance_min_employer_liability_aggregate": {
- "type": "number"
- },
- "include_provider_insurance_min_employer_liability_minimum": {
- "type": "number"
- },
- "include_provider_insurance_min_general_liability_aggregate": {
- "type": "number"
- },
- "include_provider_insurance_min_general_liability_minimum": {
- "type": "number"
- },
- "include_provider_insurance_min_include_add_customer": {
- "type": "boolean"
- },
- "include_provider_insurance_min_include_auto_liability": {
- "type": "boolean"
- },
- "include_provider_insurance_min_include_cyber_liability": {
- "type": "boolean"
- },
- "include_provider_insurance_min_include_employer_liability": {
- "type": "boolean"
- },
- "include_provider_insurance_min_include_general_liability": {
- "type": "boolean"
- },
- "include_provider_insurance_min_include_workers_comp": {
- "type": "boolean"
- },
- "include_publicity_rights": {
- "type": "boolean"
- },
- "include_publicity_rights_type": {
- "enum": [
- "public",
- "non-public"
- ],
- "type": "string"
- },
- "include_security_policy": {
- "type": "boolean"
- },
- "include_security_policy_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_security_policy_fedramp_auth": {
- "type": "boolean"
- },
- "include_security_policy_hitrust": {
- "type": "boolean"
- },
- "include_security_policy_include_annual_maintenance": {
- "type": "boolean"
- },
- "include_security_policy_include_other": {
- "type": "boolean"
- },
- "include_security_policy_include_other_val": {
- "type": "string"
- },
- "include_security_policy_iso27001": {
- "type": "boolean"
- },
- "include_security_policy_location": {
- "type": "string"
- },
- "include_security_policy_pci1": {
- "type": "boolean"
- },
- "include_security_policy_pci2": {
- "type": "boolean"
- },
- "include_security_policy_penetration_testing": {
- "type": "boolean"
- },
- "include_security_policy_soc2_type1": {
- "type": "boolean"
- },
- "include_security_policy_soc2_type2": {
- "type": "boolean"
- },
- "include_security_policy_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_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": {
- "enum": [
- "qty",
- "currency",
- "period"
- ],
- "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": {
- "description": "Fee table rows. On update, an item without `id` adds a fee; 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 fee.",
- "type": "boolean"
- },
- "cost": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "description": {
- "type": "string"
- },
- "fee_type": {
- "type": "string"
- },
- "id": {
- "description": "ID of an existing fee to update or remove. Omit to add a new fee.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "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": {
- "enum": [
- "hours",
- "days",
- "weeks",
- "months"
- ],
- "type": "string"
- },
- "include_deliverables_resubmission_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_deliverables_resubmission_unit": {
- "enum": [
- "hours",
- "days",
- "weeks",
- "months"
- ],
- "type": "string"
- },
- "include_fees_other": {
- "type": "boolean"
- },
- "include_fees_other_val": {
- "type": "string"
- },
- "include_fees_table": {
- "type": "boolean"
- },
- "include_fees_table_total": {
- "type": "boolean"
- },
- "include_fees_travel": {
- "type": "boolean"
- },
- "include_fees_travel_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_fees_travel_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_fees_travel_val": {
- "type": "string"
- },
- "include_third_party_customer": {
- "type": "boolean"
- },
- "include_third_party_include_description": {
- "type": "boolean"
- },
- "include_third_party_include_description_val": {
- "type": "string"
- },
- "include_third_party_materials": {
- "type": "boolean"
- },
- "include_third_party_provider": {
- "type": "boolean"
- },
- "include_time_of_assignment": {
- "type": "boolean"
- },
- "include_time_of_assignment_type": {
- "enum": [
- "created",
- "paid"
- ],
- "type": "string"
- },
- "invoice_period_description": {
- "type": "string"
- },
- "negotiations_allowed": {
- "description": "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": {
- "enum": [
- "receipt",
- "invoice",
- "Customer's receipt of invoice",
- "date of invoice"
- ],
- "type": "string"
- },
- "payment_period_type": {
- "enum": [
- "standard",
- "other"
- ],
- "type": "string"
- },
- "payment_period_unit": {
- "enum": [
- "day(s)",
- "week(s)",
- "month(s)",
- "quarter(s)",
- "year(s)"
- ],
- "type": "string"
- },
- "services_description": {
- "type": "string"
- },
- "sow_date": {
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "sow_date_type": {
- "enum": [
- "signature",
- "date"
- ],
- "type": "string"
- },
- "sow_term_amount": {
- "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": {
- "enum": [
- "deliverables",
- "period",
- "date"
- ],
- "type": "string"
- },
- "sow_term_unit": {
- "enum": [
- "month(s)",
- "quarter(s)",
- "year(s)"
- ],
- "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-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": {
- "enum": [
- "signature",
- "date"
- ],
- "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": {
- "enum": [
- "default_language",
- "description"
- ],
- "type": "string"
- },
- "include_fees_unit": {
- "enum": [
- "month",
- "quarter",
- "year",
- "Term"
- ],
- "type": "string"
- },
- "include_program_appear_as_customer_private": {
- "type": "boolean"
- },
- "include_program_appear_as_customer_public": {
- "type": "boolean"
- },
- "include_program_case_study": {
- "type": "boolean"
- },
- "include_program_develop_functionality": {
- "type": "boolean"
- },
- "include_program_develop_functionality_val": {
- "type": "string"
- },
- "include_program_discount": {
- "type": "boolean"
- },
- "include_program_discount_amount": {
- "type": "number"
- },
- "include_program_discount_unit": {
- "enum": [
- "U.S. Dollars",
- "percent"
- ],
- "type": "string"
- },
- "include_program_participation_feedback": {
- "type": "boolean"
- },
- "include_program_participation_feedback_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_program_participation_feedback_unit": {
- "enum": [
- "month",
- "quarter",
- "year",
- "Term"
- ],
- "type": "string"
- },
- "include_program_partner_other": {
- "type": "boolean"
- },
- "include_program_partner_other_val": {
- "type": "string"
- },
- "include_program_provider_other": {
- "type": "boolean"
- },
- "include_program_provider_other_val": {
- "type": "string"
- },
- "include_program_reference": {
- "type": "boolean"
- },
- "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": {
- "enum": [
- "day(s)",
- "week(s)",
- "month(s)",
- "quarter(s)",
- "year(s)"
- ],
- "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": {
- "enum": [
- "stripe",
- "link"
- ],
- "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-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": {
- "enum": [
- "signature",
- "date"
- ],
- "type": "string"
- },
- "general_cap_amount": {
- "type": "number"
- },
- "general_cap_amount_type": {
- "enum": [
- "preceding",
- "base",
- "period"
- ],
- "type": "string"
- },
- "general_cap_period_currency": {
- "type": "number"
- },
- "general_cap_period_qty": {
- "type": "number"
- },
- "general_cap_preceding_amount": {
- "type": "number"
- },
- "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": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_increased_cap_amount": {
- "type": "boolean"
- },
- "include_increased_claims": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_confidentiality": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_confidentiality_negligence": {
- "type": "boolean"
- },
- "include_increased_claims_include_other": {
- "type": "boolean"
- },
- "include_increased_claims_indemnification_obligation": {
- "type": "boolean"
- },
- "include_increased_claims_negligence": {
- "type": "boolean"
- },
- "include_increased_claims_other": {
- "type": "string"
- },
- "include_increased_claims_restrictions": {
- "type": "boolean"
- },
- "include_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": {
- "enum": [
- "qty",
- "currency",
- "period"
- ],
- "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": {
- "enum": [
- "automatic",
- "manual"
- ],
- "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": {
- "enum": [
- "automatic",
- "invoice"
- ],
- "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": {
- "enum": [
- "Subscription Period",
- "month",
- "year",
- "Custom unit"
- ],
- "type": "string"
- },
- "fees_attributes": {
- "description": "Fee table rows. On update, an item without `id` adds a fee; 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 fee.",
- "type": "boolean"
- },
- "attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-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"
- },
- "id": {
- "description": "ID of an existing fee to update or remove. Omit to add a new fee.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "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": {
- "enum": [
- "USD",
- "EUR",
- "GBP",
- "CAD",
- "AUD",
- "SGD",
- "ILS",
- "JPY",
- "CHF",
- "HKD"
- ],
- "type": "string"
- },
- "fees_include_fee_increase_upon_renewal": {
- "type": "boolean"
- },
- "fees_include_fee_increase_upon_renewal_fee": {
- "type": "number"
- },
- "fees_include_fee_increase_upon_renewal_type": {
- "enum": [
- "will",
- "may"
- ],
- "type": "string"
- },
- "fees_inclusive_of_taxes": {
- "type": "boolean"
- },
- "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": {
- "enum": [
- "day",
- "week",
- "month"
- ],
- "type": "string"
- },
- "include_pilot_period_include_fees": {
- "type": "boolean"
- },
- "include_pilot_period_include_fees_amount": {
- "type": "number"
- },
- "include_pilot_period_include_modifications": {
- "type": "boolean"
- },
- "include_pilot_period_include_modifications_description": {
- "type": "string"
- },
- "include_services": {
- "type": "boolean"
- },
- "include_services_description": {
- "type": "string"
- },
- "negotiations_allowed": {
- "description": "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": {
- "enum": [
- "signature",
- "date",
- "other"
- ],
- "type": "string"
- },
- "payment_process_automatic_frequency": {
- "enum": [
- "monthly",
- "quarterly",
- "semiannually",
- "annually"
- ],
- "type": "string"
- },
- "payment_process_type": {
- "enum": [
- "automatic",
- "invoice",
- "custom"
- ],
- "type": "string"
- },
- "payment_process_type_custom_val": {
- "type": "string"
- },
- "payment_process_type_invoice_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "payment_process_type_invoice_custom_unit": {
- "type": "string"
- },
- "payment_process_type_invoice_duration": {
- "enum": [
- "day",
- "week",
- "month",
- "year",
- "day(s)",
- "week(s)",
- "month(s)",
- "year(s)"
- ],
- "type": "string"
- },
- "payment_process_type_invoice_duration_start": {
- "enum": [
- "Customer's receipt of invoice",
- "date of invoice"
- ],
- "type": "string"
- },
- "payment_process_type_invoice_type": {
- "enum": [
- "monthly",
- "quarterly",
- "semiannually",
- "annually",
- "Custom unit"
- ],
- "type": "string"
- },
- "permitted_uses_include_custom": {
- "type": "boolean"
- },
- "permitted_uses_include_custom_description": {
- "type": "string"
- },
- "permitted_uses_include_customers_affiliates": {
- "type": "boolean"
- },
- "permitted_uses_include_internal_business": {
- "type": "boolean"
- },
- "pilot_period_stripe_product_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-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": {
- "enum": [
- "days",
- "subscription_end"
- ],
- "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": {
- "enum": [
- "day",
- "week",
- "month",
- "year"
- ],
- "type": "string"
- },
- "warranty_period_description_duration_start": {
- "enum": [
- "initial delivery of the Software",
- "delivery of the Software and each subsequent Update",
- "the Order Date"
- ],
- "type": "string"
- },
- "warranty_period_type": {
- "enum": [
- "description",
- "none"
- ],
- "type": "string"
- }
- },
- "type": "object"
- }
- },
- "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-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": {
- "enum": [
- "signature",
- "date"
- ],
- "type": "string"
- },
- "fees_type": {
- "enum": [
- "free",
- "pilot_period_fees"
- ],
- "type": "string"
- },
- "general_cap_amount": {
- "type": "number"
- },
- "general_cap_amount_type": {
- "enum": [
- "preceding",
- "base",
- "period"
- ],
- "type": "string"
- },
- "general_cap_period_currency": {
- "type": "number"
- },
- "general_cap_period_qty": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "general_cap_preceding_amount": {
- "type": "number"
- },
- "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": {
- "enum": [
- "description",
- "attachment",
- "standard"
- ],
- "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": {
- "enum": [
- "monthly",
- "quarterly",
- "annually",
- "once_per_period"
- ],
- "type": "string"
- },
- "payment_process_invoice_days": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "payment_process_invoice_from": {
- "enum": [
- "receipt",
- "date"
- ],
- "type": "string"
- },
- "payment_process_invoice_timeframe": {
- "enum": [
- "days",
- "weeks",
- "months",
- "quarters",
- "years"
- ],
- "type": "string"
- },
- "payment_process_type": {
- "enum": [
- "automatic",
- "invoice"
- ],
- "type": "string"
- },
- "pilot_period_description": {
- "type": "string"
- },
- "pilot_period_fees_description": {
- "type": "string"
- },
- "product_description": {
- "type": "string"
- },
- "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-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": {
- "enum": [
- "signature",
- "date"
- ],
- "type": "string"
- },
- "general_cap_amount_currency_val": {
- "type": "number"
- },
- "general_cap_amount_either_currency": {
- "type": "number"
- },
- "general_cap_amount_either_multiple": {
- "type": "number"
- },
- "general_cap_amount_multiple_val": {
- "type": "number"
- },
- "general_cap_amount_type": {
- "enum": [
- "multiple",
- "currency",
- "either",
- "base"
- ],
- "type": "string"
- },
- "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": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_increased_cap_amount": {
- "type": "boolean"
- },
- "include_increased_cap_amount_currency": {
- "type": "number"
- },
- "include_increased_cap_amount_either_currency": {
- "type": "number"
- },
- "include_increased_cap_amount_either_multiple": {},
- "include_increased_cap_amount_multiple": {},
- "include_increased_cap_amount_type": {
- "enum": [
- "multiple",
- "currency",
- "either"
- ],
- "type": "string"
- },
- "include_increased_claims": {
- "type": "boolean"
- },
- "include_increased_claims_include_confidentiality": {
- "type": "boolean"
- },
- "include_increased_claims_include_confidentiality_misconduct": {
- "type": "boolean"
- },
- "include_increased_claims_include_covered_claims": {
- "type": "boolean"
- },
- "include_increased_claims_include_misconduct": {
- "type": "boolean"
- },
- "include_increased_claims_include_other": {
- "type": "boolean"
- },
- "include_increased_claims_include_other_val": {
- "type": "string"
- },
- "include_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": {
- "enum": [
- "month(s)",
- "quarter(s)",
- "year(s)"
- ],
- "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": {
- "enum": [
- "date",
- "effective date"
- ],
- "type": "string"
- },
- "include_obligations_company_brand": {
- "type": "boolean"
- },
- "include_obligations_company_promotion": {
- "type": "boolean"
- },
- "include_obligations_company_promotion_include_activities": {
- "type": "boolean"
- },
- "include_obligations_company_promotion_include_activities_val": {
- "type": "string"
- },
- "include_obligations_company_promotion_include_materials": {
- "type": "boolean"
- },
- "include_obligations_company_promotion_include_materials_val": {
- "type": "string"
- },
- "include_obligations_company_referral": {
- "type": "boolean"
- },
- "include_obligations_company_referral_include_criteria": {
- "type": "boolean"
- },
- "include_obligations_company_referral_include_criteria_val": {
- "type": "string"
- },
- "include_obligations_company_referral_include_pay_sch": {
- "type": "boolean"
- },
- "include_obligations_company_referral_include_pay_sch_amount": {
- "type": "number"
- },
- "include_obligations_company_referral_include_pay_sch_custom": {
- "type": "string"
- },
- "include_obligations_company_referral_include_pay_sch_unit": {
- "enum": [
- "U.S. Dollars",
- "percent"
- ],
- "type": "string"
- },
- "include_obligations_company_sponsorship": {
- "type": "boolean"
- },
- "include_obligations_company_sponsorship_include_benefits": {
- "type": "boolean"
- },
- "include_obligations_company_sponsorship_include_benefits_val": {
- "type": "string"
- },
- "include_obligations_company_sponsorship_include_payments": {
- "type": "boolean"
- },
- "include_obligations_company_sponsorship_include_payments_amount": {
- "type": "number"
- },
- "include_obligations_company_sponsorship_include_payments_unit": {
- "enum": [
- "U.S. Dollars",
- "percent"
- ],
- "type": "string"
- },
- "include_obligations_partner_brand": {
- "type": "boolean"
- },
- "include_obligations_partner_promotion": {
- "type": "boolean"
- },
- "include_obligations_partner_promotion_include_activities": {
- "type": "boolean"
- },
- "include_obligations_partner_promotion_include_activities_val": {
- "type": "string"
- },
- "include_obligations_partner_promotion_include_materials": {
- "type": "boolean"
- },
- "include_obligations_partner_promotion_include_materials_val": {
- "type": "string"
- },
- "include_obligations_partner_referral": {
- "type": "boolean"
- },
- "include_obligations_partner_referral_include_criteria": {
- "type": "boolean"
- },
- "include_obligations_partner_referral_include_criteria_val": {
- "type": "string"
- },
- "include_obligations_partner_referral_include_pay_sch": {
- "type": "boolean"
- },
- "include_obligations_partner_referral_include_pay_sch_amount": {
- "type": "number"
- },
- "include_obligations_partner_referral_include_pay_sch_custom": {
- "type": "string"
- },
- "include_obligations_partner_referral_include_pay_sch_unit": {
- "enum": [
- "U.S. Dollars",
- "percent"
- ],
- "type": "string"
- },
- "include_obligations_partner_sponsorship": {
- "type": "boolean"
- },
- "include_obligations_partner_sponsorship_include_benefits": {
- "type": "boolean"
- },
- "include_obligations_partner_sponsorship_include_benefits_val": {
- "type": "string"
- },
- "include_obligations_partner_sponsorship_include_payments": {
- "type": "boolean"
- },
- "include_obligations_partner_sponsorship_include_payments_amount": {
- "type": "number"
- },
- "include_obligations_partner_sponsorship_include_payments_unit": {
- "enum": [
- "U.S. Dollars",
- "percent"
- ],
- "type": "string"
- },
- "include_payment_process": {
- "type": "boolean"
- },
- "include_payment_process_company": {
- "type": "boolean"
- },
- "include_payment_process_company_include_address": {
- "type": "boolean"
- },
- "include_payment_process_company_include_address_city": {
- "type": "string"
- },
- "include_payment_process_company_include_address_country": {
- "type": "string"
- },
- "include_payment_process_company_include_address_state": {
- "type": "string"
- },
- "include_payment_process_company_include_address_street_address": {
- "type": "string"
- },
- "include_payment_process_company_include_address_zipcode": {
- "type": "string"
- },
- "include_payment_process_company_include_email": {
- "type": "boolean"
- },
- "include_payment_process_company_include_email_val": {
- "format": "email",
- "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
- "type": "string"
- },
- "include_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-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": {
- "enum": [
- "receipt",
- "date"
- ],
- "type": "string"
- },
- "include_payment_schedule_specified_unit": {
- "enum": [
- "day(s)",
- "week(s)",
- "month(s)",
- "quarter(s)",
- "year(s)"
- ],
- "type": "string"
- },
- "include_payment_schedule_type": {
- "enum": [
- "specified",
- "custom"
- ],
- "type": "string"
- },
- "negotiations_allowed": {
- "description": "Whether counterparties can propose changes to agreements created from this template.",
- "type": "boolean"
- },
- "territory_type": {
- "enum": [
- "worldwide",
- "custom"
- ],
- "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": {
- "enum": [
- "hours",
- "business days",
- "calendar days"
- ],
- "type": "string"
- },
- "breach_notification_val": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "business_associate_relationship_type": {
- "enum": [
- "provider",
- "company"
- ],
- "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-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": {
- "enum": [
- "signature",
- "date"
- ],
- "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": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "confidentiality_type": {
- "enum": [
- "mutual",
- "nda",
- "provider",
- "custom"
- ],
- "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-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": {
- "enum": [
- "month",
- "year",
- "quarter"
- ],
- "type": "string"
- },
- "include_fees_include_amount": {
- "type": "boolean"
- },
- "include_fees_include_other": {
- "type": "boolean"
- },
- "include_fees_other": {
- "type": "string"
- },
- "include_functionality": {
- "type": "boolean"
- },
- "include_functionality_val": {
- "type": "string"
- },
- "include_launch_date": {
- "type": "boolean"
- },
- "include_launch_date_custom": {
- "type": "string"
- },
- "include_launch_date_date": {
- "format": "date-time",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$",
- "type": "string"
- },
- "include_launch_date_type": {
- "enum": [
- "date",
- "custom"
- ],
- "type": "string"
- },
- "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-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": {
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "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": {
+ "enum": [
+ "stripe",
+ "link"
+ ],
+ "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-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": {
+ "enum": [
+ "AWS",
+ "GCP",
+ "Azure"
+ ],
+ "type": "string"
+ },
+ "effective_date_type": {
+ "enum": [
+ "signature",
+ "date",
+ "marketplace_acceptance"
+ ],
+ "type": "string"
+ },
+ "general_cap_amount": {
+ "type": "number"
+ },
+ "general_cap_amount_type": {
+ "enum": [
+ "preceding",
+ "base",
+ "period"
+ ],
+ "type": "string"
+ },
+ "general_cap_period_currency": {
+ "type": "number"
+ },
+ "general_cap_period_qty": {
+ "type": "number"
+ },
+ "general_cap_preceding_amount": {
+ "type": "number"
+ },
+ "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": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "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": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_increased_cap_amount": {
+ "type": "boolean"
+ },
+ "include_increased_claims": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_confidentiality": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_confidentiality_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_privsec": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_privsec_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_other": {
+ "type": "boolean"
+ },
+ "include_increased_claims_indemnification_obligation": {
+ "type": "boolean"
+ },
+ "include_increased_claims_other": {
+ "type": "string"
+ },
+ "include_insurance_minimums": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_add_customer": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_add_customer_com_gen_liability": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_add_customer_cyber_liability": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_add_customer_errors_omissions": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_additional_information": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_additional_information_text": {
+ "type": "string"
+ },
+ "include_insurance_minimums_cyber_liability_aggregate": {
+ "type": "number"
+ },
+ "include_insurance_minimums_cyber_liability_minimum": {
+ "type": "number"
+ },
+ "include_insurance_minimums_employer_liability_aggregate": {
+ "type": "number"
+ },
+ "include_insurance_minimums_employer_liability_minimum": {
+ "type": "number"
+ },
+ "include_insurance_minimums_general_liability_aggregate": {
+ "type": "number"
+ },
+ "include_insurance_minimums_general_liability_minimum": {
+ "type": "number"
+ },
+ "include_insurance_minimums_include_cyber_liability": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_include_employer_liability": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_include_general_liability": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_include_workers_compensation": {
+ "type": "boolean"
+ },
+ "include_publicity_rights": {
+ "type": "boolean"
+ },
+ "include_publicity_rights_type": {
+ "enum": [
+ "public",
+ "non-public"
+ ],
+ "type": "string"
+ },
+ "include_security_policy": {
+ "type": "boolean"
+ },
+ "include_security_policy_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_security_policy_fedramp_auth": {
+ "type": "boolean"
+ },
+ "include_security_policy_hipaa": {
+ "type": "boolean"
+ },
+ "include_security_policy_hitrust": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_annual_maintenance": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_location": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_other": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_reasonable_efforts": {
+ "type": "boolean"
+ },
+ "include_security_policy_iso27001": {
+ "type": "boolean"
+ },
+ "include_security_policy_location": {
+ "type": "string"
+ },
+ "include_security_policy_other": {
+ "type": "string"
+ },
+ "include_security_policy_pci1": {
+ "type": "boolean"
+ },
+ "include_security_policy_pci2": {
+ "type": "boolean"
+ },
+ "include_security_policy_penetration_testing": {
+ "type": "boolean"
+ },
+ "include_security_policy_soc2": {
+ "type": "boolean"
+ },
+ "include_security_policy_soc2_type2": {
+ "type": "boolean"
+ },
+ "include_security_policy_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_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": {
+ "type": "number"
+ },
+ "increased_cap_amount_qty": {
+ "type": "number"
+ },
+ "increased_cap_amount_type": {
+ "enum": [
+ "qty",
+ "currency",
+ "period"
+ ],
+ "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": {
+ "enum": [
+ "automatic",
+ "invoice"
+ ],
+ "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": {
+ "enum": [
+ "Subscription Period",
+ "month",
+ "year",
+ "User",
+ "Custom unit"
+ ],
+ "type": "string"
+ },
+ "fees_attributes": {
+ "description": "Fee table rows. On update, an item without `id` adds a fee; 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 fee.",
+ "type": "boolean"
+ },
+ "attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-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"
+ },
+ "id": {
+ "description": "ID of an existing fee to update or remove. Omit to add a new fee.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "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": {
+ "enum": [
+ "USD",
+ "EUR",
+ "GBP",
+ "CAD",
+ "AUD",
+ "SGD",
+ "ILS",
+ "JPY",
+ "CHF",
+ "HKD"
+ ],
+ "type": "string"
+ },
+ "fees_include_fee_increase_upon_renewal": {
+ "type": "boolean"
+ },
+ "fees_include_fee_increase_upon_renewal_fee": {
+ "type": "number"
+ },
+ "fees_include_fee_increase_upon_renewal_type": {
+ "enum": [
+ "will",
+ "may"
+ ],
+ "type": "string"
+ },
+ "fees_inclusive_of_taxes": {
+ "type": "boolean"
+ },
+ "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": {
+ "enum": [
+ "Subscription Period",
+ "month",
+ "year",
+ "User"
+ ],
+ "type": "string"
+ },
+ "include_free_trial": {
+ "type": "boolean"
+ },
+ "include_max_users": {
+ "type": "boolean"
+ },
+ "include_pilot_period": {
+ "type": "boolean"
+ },
+ "include_pilot_period_duration_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_pilot_period_duration_type": {
+ "enum": [
+ "day",
+ "week",
+ "month"
+ ],
+ "type": "string"
+ },
+ "include_pilot_period_include_fees": {
+ "type": "boolean"
+ },
+ "include_pilot_period_include_fees_amount": {
+ "type": "number"
+ },
+ "include_pilot_period_include_modifications": {
+ "type": "boolean"
+ },
+ "include_pilot_period_include_modifications_description": {
+ "type": "string"
+ },
+ "include_product_support": {
+ "type": "boolean"
+ },
+ "include_product_support_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_product_support_description": {
+ "type": "string"
+ },
+ "include_product_support_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_professional_services": {
+ "type": "boolean"
+ },
+ "include_professional_services_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_professional_services_custom_name": {
+ "type": "string"
+ },
+ "include_professional_services_description": {
+ "type": "string"
+ },
+ "include_professional_services_end_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "include_professional_services_fees_description": {
+ "type": "string"
+ },
+ "include_professional_services_include_end_date": {
+ "type": "boolean"
+ },
+ "include_professional_services_include_fees_description": {
+ "type": "boolean"
+ },
+ "include_professional_services_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_sla": {
+ "type": "boolean"
+ },
+ "include_sla_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_sla_description": {
+ "type": "string"
+ },
+ "include_sla_include_response_time": {
+ "type": "boolean"
+ },
+ "include_sla_include_response_time_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_sla_include_response_time_credit": {
+ "type": "number"
+ },
+ "include_sla_include_response_time_duration": {
+ "enum": [
+ "hour",
+ "day",
+ "week",
+ "month",
+ "hours"
+ ],
+ "type": "string"
+ },
+ "include_sla_include_response_time_support_channel": {
+ "type": "string"
+ },
+ "include_sla_include_target_uptime": {
+ "type": "boolean"
+ },
+ "include_sla_maintenance_notice": {
+ "type": "boolean"
+ },
+ "include_sla_maintenance_window": {
+ "type": "boolean"
+ },
+ "include_sla_maintenance_window_type": {
+ "enum": [
+ "standard",
+ "none"
+ ],
+ "type": "string"
+ },
+ "include_sla_standard_maintenance_notice_qty": {
+ "type": "number"
+ },
+ "include_sla_standard_maintenance_notice_unit": {
+ "enum": [
+ "hour",
+ "day",
+ "week",
+ "month"
+ ],
+ "type": "string"
+ },
+ "include_sla_standard_maintenance_window_end_time": {
+ "type": "string"
+ },
+ "include_sla_standard_maintenance_window_friday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_monday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_saturday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_start_time": {
+ "type": "string"
+ },
+ "include_sla_standard_maintenance_window_sunday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_thursday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_time_zone": {
+ "type": "string"
+ },
+ "include_sla_standard_maintenance_window_tuesday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_wednesday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_target_uptime": {
+ "type": "number"
+ },
+ "include_sla_type": {
+ "enum": [
+ "description",
+ "standard",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_subscription_start_date": {
+ "type": "boolean"
+ },
+ "include_subscription_start_date_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "include_usage_review": {
+ "type": "boolean"
+ },
+ "include_usage_review_val": {
+ "type": "string"
+ },
+ "include_use_limitations": {
+ "type": "boolean"
+ },
+ "include_use_limitations_val": {
+ "type": "string"
+ },
+ "invoice_period": {
+ "enum": [
+ "monthly",
+ "quarterly",
+ "semiannually",
+ "annually",
+ "Custom unit",
+ "Monthly",
+ "Quarterly",
+ "Semiannually",
+ "Annually"
+ ],
+ "type": "string"
+ },
+ "invoice_period_custom_unit": {
+ "type": "string"
+ },
+ "max_consumption": {
+ "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": {
+ "enum": [
+ "signature",
+ "date",
+ "other"
+ ],
+ "type": "string"
+ },
+ "payment_period": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "payment_period_timeframe": {
+ "enum": [
+ "Customer's receipt of invoice",
+ "date of invoice"
+ ],
+ "type": "string"
+ },
+ "payment_period_unit": {
+ "enum": [
+ "day(s)",
+ "week(s)",
+ "month(s)",
+ "marketplace_acceptance"
+ ],
+ "type": "string"
+ },
+ "payment_process_automatic_frequency": {
+ "enum": [
+ "monthly",
+ "quarterly",
+ "semiannually",
+ "annually"
+ ],
+ "type": "string"
+ },
+ "payment_process_type": {
+ "enum": [
+ "automatic",
+ "invoice",
+ "custom",
+ "marketplace_acceptance"
+ ],
+ "type": "string"
+ },
+ "payment_process_type_custom_val": {
+ "type": "string"
+ },
+ "payment_process_type_invoice_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "payment_process_type_invoice_custom_unit": {
+ "type": "string"
+ },
+ "payment_process_type_invoice_duration": {
+ "enum": [
+ "day",
+ "week",
+ "month",
+ "year",
+ "day(s)",
+ "week(s)",
+ "month(s)",
+ "year(s)"
+ ],
+ "type": "string"
+ },
+ "payment_process_type_invoice_duration_start": {
+ "enum": [
+ "Customer's receipt of invoice",
+ "date of invoice"
+ ],
+ "type": "string"
+ },
+ "payment_process_type_invoice_type": {
+ "enum": [
+ "monthly",
+ "quarterly",
+ "semiannually",
+ "annually",
+ "Custom unit"
+ ],
+ "type": "string"
+ },
+ "pilot_period_stripe_product_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-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": {
+ "enum": [
+ "days",
+ "subscription_end"
+ ],
+ "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": {
+ "enum": [
+ "effective_date",
+ "date"
+ ],
+ "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-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-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-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": {
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "type": "string"
+ },
+ "general_cap_amount": {
+ "type": "number"
+ },
+ "general_cap_amount_type": {
+ "enum": [
+ "preceding",
+ "base",
+ "period"
+ ],
+ "type": "string"
+ },
+ "general_cap_period_currency": {
+ "type": "number"
+ },
+ "general_cap_period_qty": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "general_cap_preceding_amount": {
+ "type": "number"
+ },
+ "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": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_dpa": {
+ "type": "boolean"
+ },
+ "include_dpa_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_dpa_location": {
+ "type": "string"
+ },
+ "include_dpa_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_increased_cap_amount": {
+ "type": "boolean"
+ },
+ "include_increased_claims": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_confidentiality": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_confidentiality_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_privsec": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_privsec_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_other": {
+ "type": "boolean"
+ },
+ "include_increased_claims_indemnification_obligation": {
+ "type": "boolean"
+ },
+ "include_increased_claims_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_other": {
+ "type": "string"
+ },
+ "include_provider_insurance_min": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_add_customer_com_gen_liability": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_add_customer_cyber_liability": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_add_customer_errors_omissions": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_auto_liability_aggregate": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_auto_liability_minimum": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_cyber_liability_aggregate": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_cyber_liability_minimum": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_employer_liability_aggregate": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_employer_liability_minimum": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_general_liability_aggregate": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_general_liability_minimum": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_include_add_customer": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_include_auto_liability": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_include_cyber_liability": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_include_employer_liability": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_include_general_liability": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_include_workers_comp": {
+ "type": "boolean"
+ },
+ "include_publicity_rights": {
+ "type": "boolean"
+ },
+ "include_publicity_rights_type": {
+ "enum": [
+ "public",
+ "non-public"
+ ],
+ "type": "string"
+ },
+ "include_security_policy": {
+ "type": "boolean"
+ },
+ "include_security_policy_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_security_policy_fedramp_auth": {
+ "type": "boolean"
+ },
+ "include_security_policy_hitrust": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_annual_maintenance": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_other": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_other_val": {
+ "type": "string"
+ },
+ "include_security_policy_iso27001": {
+ "type": "boolean"
+ },
+ "include_security_policy_location": {
+ "type": "string"
+ },
+ "include_security_policy_pci1": {
+ "type": "boolean"
+ },
+ "include_security_policy_pci2": {
+ "type": "boolean"
+ },
+ "include_security_policy_penetration_testing": {
+ "type": "boolean"
+ },
+ "include_security_policy_soc2_type1": {
+ "type": "boolean"
+ },
+ "include_security_policy_soc2_type2": {
+ "type": "boolean"
+ },
+ "include_security_policy_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_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": {
+ "enum": [
+ "qty",
+ "currency",
+ "period"
+ ],
+ "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 recipient's role on agreements from this template: `Customer` (the default) or `Provider`. Send it with `sender_role`; the two must be one `Provider` and one `Customer`.",
+ "type": "string"
+ },
+ "sender_last_to_sign": {
+ "description": "When true, the sender signs after the recipient.",
+ "type": "boolean"
+ },
+ "sender_role": {
+ "description": "Your company's role on agreements from this template: `Provider` (the default) or `Customer` when you hire the recipient to provide the services. Send it with `recipient_role`; the two must be one `Provider` and one `Customer`.",
+ "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": {
+ "description": "Fee table rows. On update, an item without `id` adds a fee; 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 fee.",
+ "type": "boolean"
+ },
+ "cost": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "description": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "id": {
+ "description": "ID of an existing fee to update or remove. Omit to add a new fee.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "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": {
+ "enum": [
+ "hours",
+ "days",
+ "weeks",
+ "months"
+ ],
+ "type": "string"
+ },
+ "include_deliverables_resubmission_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_deliverables_resubmission_unit": {
+ "enum": [
+ "hours",
+ "days",
+ "weeks",
+ "months"
+ ],
+ "type": "string"
+ },
+ "include_fees_other": {
+ "type": "boolean"
+ },
+ "include_fees_other_val": {
+ "type": "string"
+ },
+ "include_fees_table": {
+ "type": "boolean"
+ },
+ "include_fees_table_total": {
+ "type": "boolean"
+ },
+ "include_fees_travel": {
+ "type": "boolean"
+ },
+ "include_fees_travel_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_fees_travel_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_fees_travel_val": {
+ "type": "string"
+ },
+ "include_third_party_customer": {
+ "type": "boolean"
+ },
+ "include_third_party_include_description": {
+ "type": "boolean"
+ },
+ "include_third_party_include_description_val": {
+ "type": "string"
+ },
+ "include_third_party_materials": {
+ "type": "boolean"
+ },
+ "include_third_party_provider": {
+ "type": "boolean"
+ },
+ "include_time_of_assignment": {
+ "type": "boolean"
+ },
+ "include_time_of_assignment_type": {
+ "enum": [
+ "created",
+ "paid"
+ ],
+ "type": "string"
+ },
+ "invoice_period_description": {
+ "type": "string"
+ },
+ "negotiations_allowed": {
+ "description": "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": {
+ "enum": [
+ "receipt",
+ "invoice",
+ "Customer's receipt of invoice",
+ "date of invoice"
+ ],
+ "type": "string"
+ },
+ "payment_period_type": {
+ "enum": [
+ "standard",
+ "other"
+ ],
+ "type": "string"
+ },
+ "payment_period_unit": {
+ "enum": [
+ "day(s)",
+ "week(s)",
+ "month(s)",
+ "quarter(s)",
+ "year(s)"
+ ],
+ "type": "string"
+ },
+ "services_description": {
+ "type": "string"
+ },
+ "sow_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "sow_date_type": {
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "type": "string"
+ },
+ "sow_term_amount": {
+ "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": {
+ "enum": [
+ "deliverables",
+ "period",
+ "date"
+ ],
+ "type": "string"
+ },
+ "sow_term_unit": {
+ "enum": [
+ "month(s)",
+ "quarter(s)",
+ "year(s)"
+ ],
+ "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-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": {
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "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": {
+ "enum": [
+ "default_language",
+ "description"
+ ],
+ "type": "string"
+ },
+ "include_fees_unit": {
+ "enum": [
+ "month",
+ "quarter",
+ "year",
+ "Term"
+ ],
+ "type": "string"
+ },
+ "include_program_appear_as_customer_private": {
+ "type": "boolean"
+ },
+ "include_program_appear_as_customer_public": {
+ "type": "boolean"
+ },
+ "include_program_case_study": {
+ "type": "boolean"
+ },
+ "include_program_develop_functionality": {
+ "type": "boolean"
+ },
+ "include_program_develop_functionality_val": {
+ "type": "string"
+ },
+ "include_program_discount": {
+ "type": "boolean"
+ },
+ "include_program_discount_amount": {
+ "type": "number"
+ },
+ "include_program_discount_unit": {
+ "enum": [
+ "U.S. Dollars",
+ "percent"
+ ],
+ "type": "string"
+ },
+ "include_program_participation_feedback": {
+ "type": "boolean"
+ },
+ "include_program_participation_feedback_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_program_participation_feedback_unit": {
+ "enum": [
+ "month",
+ "quarter",
+ "year",
+ "Term"
+ ],
+ "type": "string"
+ },
+ "include_program_partner_other": {
+ "type": "boolean"
+ },
+ "include_program_partner_other_val": {
+ "type": "string"
+ },
+ "include_program_provider_other": {
+ "type": "boolean"
+ },
+ "include_program_provider_other_val": {
+ "type": "string"
+ },
+ "include_program_reference": {
+ "type": "boolean"
+ },
+ "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": {
+ "enum": [
+ "day(s)",
+ "week(s)",
+ "month(s)",
+ "quarter(s)",
+ "year(s)"
+ ],
+ "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": {
+ "enum": [
+ "stripe",
+ "link"
+ ],
+ "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-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": {
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "type": "string"
+ },
+ "general_cap_amount": {
+ "type": "number"
+ },
+ "general_cap_amount_type": {
+ "enum": [
+ "preceding",
+ "base",
+ "period"
+ ],
+ "type": "string"
+ },
+ "general_cap_period_currency": {
+ "type": "number"
+ },
+ "general_cap_period_qty": {
+ "type": "number"
+ },
+ "general_cap_preceding_amount": {
+ "type": "number"
+ },
+ "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": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_increased_cap_amount": {
+ "type": "boolean"
+ },
+ "include_increased_claims": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_confidentiality": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_confidentiality_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_other": {
+ "type": "boolean"
+ },
+ "include_increased_claims_indemnification_obligation": {
+ "type": "boolean"
+ },
+ "include_increased_claims_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_other": {
+ "type": "string"
+ },
+ "include_increased_claims_restrictions": {
+ "type": "boolean"
+ },
+ "include_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": {
+ "enum": [
+ "qty",
+ "currency",
+ "period"
+ ],
+ "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": {
+ "enum": [
+ "automatic",
+ "manual"
+ ],
+ "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": {
+ "enum": [
+ "automatic",
+ "invoice"
+ ],
+ "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": {
+ "enum": [
+ "Subscription Period",
+ "month",
+ "year",
+ "Custom unit"
+ ],
+ "type": "string"
+ },
+ "fees_attributes": {
+ "description": "Fee table rows. On update, an item without `id` adds a fee; 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 fee.",
+ "type": "boolean"
+ },
+ "attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-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"
+ },
+ "id": {
+ "description": "ID of an existing fee to update or remove. Omit to add a new fee.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "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": {
+ "enum": [
+ "USD",
+ "EUR",
+ "GBP",
+ "CAD",
+ "AUD",
+ "SGD",
+ "ILS",
+ "JPY",
+ "CHF",
+ "HKD"
+ ],
+ "type": "string"
+ },
+ "fees_include_fee_increase_upon_renewal": {
+ "type": "boolean"
+ },
+ "fees_include_fee_increase_upon_renewal_fee": {
+ "type": "number"
+ },
+ "fees_include_fee_increase_upon_renewal_type": {
+ "enum": [
+ "will",
+ "may"
+ ],
+ "type": "string"
+ },
+ "fees_inclusive_of_taxes": {
+ "type": "boolean"
+ },
+ "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": {
+ "enum": [
+ "day",
+ "week",
+ "month"
+ ],
+ "type": "string"
+ },
+ "include_pilot_period_include_fees": {
+ "type": "boolean"
+ },
+ "include_pilot_period_include_fees_amount": {
+ "type": "number"
+ },
+ "include_pilot_period_include_modifications": {
+ "type": "boolean"
+ },
+ "include_pilot_period_include_modifications_description": {
+ "type": "string"
+ },
+ "include_services": {
+ "type": "boolean"
+ },
+ "include_services_description": {
+ "type": "string"
+ },
+ "negotiations_allowed": {
+ "description": "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": {
+ "enum": [
+ "signature",
+ "date",
+ "other"
+ ],
+ "type": "string"
+ },
+ "payment_process_automatic_frequency": {
+ "enum": [
+ "monthly",
+ "quarterly",
+ "semiannually",
+ "annually"
+ ],
+ "type": "string"
+ },
+ "payment_process_type": {
+ "enum": [
+ "automatic",
+ "invoice",
+ "custom"
+ ],
+ "type": "string"
+ },
+ "payment_process_type_custom_val": {
+ "type": "string"
+ },
+ "payment_process_type_invoice_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "payment_process_type_invoice_custom_unit": {
+ "type": "string"
+ },
+ "payment_process_type_invoice_duration": {
+ "enum": [
+ "day",
+ "week",
+ "month",
+ "year",
+ "day(s)",
+ "week(s)",
+ "month(s)",
+ "year(s)"
+ ],
+ "type": "string"
+ },
+ "payment_process_type_invoice_duration_start": {
+ "enum": [
+ "Customer's receipt of invoice",
+ "date of invoice"
+ ],
+ "type": "string"
+ },
+ "payment_process_type_invoice_type": {
+ "enum": [
+ "monthly",
+ "quarterly",
+ "semiannually",
+ "annually",
+ "Custom unit"
+ ],
+ "type": "string"
+ },
+ "permitted_uses_include_custom": {
+ "type": "boolean"
+ },
+ "permitted_uses_include_custom_description": {
+ "type": "string"
+ },
+ "permitted_uses_include_customers_affiliates": {
+ "type": "boolean"
+ },
+ "permitted_uses_include_internal_business": {
+ "type": "boolean"
+ },
+ "pilot_period_stripe_product_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-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": {
+ "enum": [
+ "days",
+ "subscription_end"
+ ],
+ "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": {
+ "enum": [
+ "day",
+ "week",
+ "month",
+ "year"
+ ],
+ "type": "string"
+ },
+ "warranty_period_description_duration_start": {
+ "enum": [
+ "initial delivery of the Software",
+ "delivery of the Software and each subsequent Update",
+ "the Order Date"
+ ],
+ "type": "string"
+ },
+ "warranty_period_type": {
+ "enum": [
+ "description",
+ "none"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ }
+ },
+ "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-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": {
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "type": "string"
+ },
+ "fees_type": {
+ "enum": [
+ "free",
+ "pilot_period_fees"
+ ],
+ "type": "string"
+ },
+ "general_cap_amount": {
+ "type": "number"
+ },
+ "general_cap_amount_type": {
+ "enum": [
+ "preceding",
+ "base",
+ "period"
+ ],
+ "type": "string"
+ },
+ "general_cap_period_currency": {
+ "type": "number"
+ },
+ "general_cap_period_qty": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "general_cap_preceding_amount": {
+ "type": "number"
+ },
+ "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": {
+ "enum": [
+ "description",
+ "attachment",
+ "standard"
+ ],
+ "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": {
+ "enum": [
+ "monthly",
+ "quarterly",
+ "annually",
+ "once_per_period"
+ ],
+ "type": "string"
+ },
+ "payment_process_invoice_days": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "payment_process_invoice_from": {
+ "enum": [
+ "receipt",
+ "date"
+ ],
+ "type": "string"
+ },
+ "payment_process_invoice_timeframe": {
+ "enum": [
+ "days",
+ "weeks",
+ "months",
+ "quarters",
+ "years"
+ ],
+ "type": "string"
+ },
+ "payment_process_type": {
+ "enum": [
+ "automatic",
+ "invoice"
+ ],
+ "type": "string"
+ },
+ "pilot_period_description": {
+ "type": "string"
+ },
+ "pilot_period_fees_description": {
+ "type": "string"
+ },
+ "product_description": {
+ "type": "string"
+ },
+ "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-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": {
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "type": "string"
+ },
+ "general_cap_amount_currency_val": {
+ "type": "number"
+ },
+ "general_cap_amount_either_currency": {
+ "type": "number"
+ },
+ "general_cap_amount_either_multiple": {
+ "type": "number"
+ },
+ "general_cap_amount_multiple_val": {
+ "type": "number"
+ },
+ "general_cap_amount_type": {
+ "enum": [
+ "multiple",
+ "currency",
+ "either",
+ "base"
+ ],
+ "type": "string"
+ },
+ "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": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_increased_cap_amount": {
+ "type": "boolean"
+ },
+ "include_increased_cap_amount_currency": {
+ "type": "number"
+ },
+ "include_increased_cap_amount_either_currency": {
+ "type": "number"
+ },
+ "include_increased_cap_amount_either_multiple": {},
+ "include_increased_cap_amount_multiple": {},
+ "include_increased_cap_amount_type": {
+ "enum": [
+ "multiple",
+ "currency",
+ "either"
+ ],
+ "type": "string"
+ },
+ "include_increased_claims": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_confidentiality": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_confidentiality_misconduct": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_covered_claims": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_misconduct": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_other": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_other_val": {
+ "type": "string"
+ },
+ "include_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": {
+ "enum": [
+ "month(s)",
+ "quarter(s)",
+ "year(s)"
+ ],
+ "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": {
+ "enum": [
+ "date",
+ "effective date"
+ ],
+ "type": "string"
+ },
+ "include_obligations_company_brand": {
+ "type": "boolean"
+ },
+ "include_obligations_company_promotion": {
+ "type": "boolean"
+ },
+ "include_obligations_company_promotion_include_activities": {
+ "type": "boolean"
+ },
+ "include_obligations_company_promotion_include_activities_val": {
+ "type": "string"
+ },
+ "include_obligations_company_promotion_include_materials": {
+ "type": "boolean"
+ },
+ "include_obligations_company_promotion_include_materials_val": {
+ "type": "string"
+ },
+ "include_obligations_company_referral": {
+ "type": "boolean"
+ },
+ "include_obligations_company_referral_include_criteria": {
+ "type": "boolean"
+ },
+ "include_obligations_company_referral_include_criteria_val": {
+ "type": "string"
+ },
+ "include_obligations_company_referral_include_pay_sch": {
+ "type": "boolean"
+ },
+ "include_obligations_company_referral_include_pay_sch_amount": {
+ "type": "number"
+ },
+ "include_obligations_company_referral_include_pay_sch_custom": {
+ "type": "string"
+ },
+ "include_obligations_company_referral_include_pay_sch_unit": {
+ "enum": [
+ "U.S. Dollars",
+ "percent"
+ ],
+ "type": "string"
+ },
+ "include_obligations_company_sponsorship": {
+ "type": "boolean"
+ },
+ "include_obligations_company_sponsorship_include_benefits": {
+ "type": "boolean"
+ },
+ "include_obligations_company_sponsorship_include_benefits_val": {
+ "type": "string"
+ },
+ "include_obligations_company_sponsorship_include_payments": {
+ "type": "boolean"
+ },
+ "include_obligations_company_sponsorship_include_payments_amount": {
+ "type": "number"
+ },
+ "include_obligations_company_sponsorship_include_payments_unit": {
+ "enum": [
+ "U.S. Dollars",
+ "percent"
+ ],
+ "type": "string"
+ },
+ "include_obligations_partner_brand": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_promotion": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_promotion_include_activities": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_promotion_include_activities_val": {
+ "type": "string"
+ },
+ "include_obligations_partner_promotion_include_materials": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_promotion_include_materials_val": {
+ "type": "string"
+ },
+ "include_obligations_partner_referral": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_referral_include_criteria": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_referral_include_criteria_val": {
+ "type": "string"
+ },
+ "include_obligations_partner_referral_include_pay_sch": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_referral_include_pay_sch_amount": {
+ "type": "number"
+ },
+ "include_obligations_partner_referral_include_pay_sch_custom": {
+ "type": "string"
+ },
+ "include_obligations_partner_referral_include_pay_sch_unit": {
+ "enum": [
+ "U.S. Dollars",
+ "percent"
+ ],
+ "type": "string"
+ },
+ "include_obligations_partner_sponsorship": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_sponsorship_include_benefits": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_sponsorship_include_benefits_val": {
+ "type": "string"
+ },
+ "include_obligations_partner_sponsorship_include_payments": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_sponsorship_include_payments_amount": {
+ "type": "number"
+ },
+ "include_obligations_partner_sponsorship_include_payments_unit": {
+ "enum": [
+ "U.S. Dollars",
+ "percent"
+ ],
+ "type": "string"
+ },
+ "include_payment_process": {
+ "type": "boolean"
+ },
+ "include_payment_process_company": {
+ "type": "boolean"
+ },
+ "include_payment_process_company_include_address": {
+ "type": "boolean"
+ },
+ "include_payment_process_company_include_address_city": {
+ "type": "string"
+ },
+ "include_payment_process_company_include_address_country": {
+ "type": "string"
+ },
+ "include_payment_process_company_include_address_state": {
+ "type": "string"
+ },
+ "include_payment_process_company_include_address_street_address": {
+ "type": "string"
+ },
+ "include_payment_process_company_include_address_zipcode": {
+ "type": "string"
+ },
+ "include_payment_process_company_include_email": {
+ "type": "boolean"
+ },
+ "include_payment_process_company_include_email_val": {
+ "format": "email",
+ "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "include_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-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": {
+ "enum": [
+ "receipt",
+ "date"
+ ],
+ "type": "string"
+ },
+ "include_payment_schedule_specified_unit": {
+ "enum": [
+ "day(s)",
+ "week(s)",
+ "month(s)",
+ "quarter(s)",
+ "year(s)"
+ ],
+ "type": "string"
+ },
+ "include_payment_schedule_type": {
+ "enum": [
+ "specified",
+ "custom"
+ ],
+ "type": "string"
+ },
+ "negotiations_allowed": {
+ "description": "Whether counterparties can propose changes to agreements created from this template.",
+ "type": "boolean"
+ },
+ "territory_type": {
+ "enum": [
+ "worldwide",
+ "custom"
+ ],
+ "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": {
+ "enum": [
+ "hours",
+ "business days",
+ "calendar days"
+ ],
+ "type": "string"
+ },
+ "breach_notification_val": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "business_associate_relationship_type": {
+ "enum": [
+ "provider",
+ "company"
+ ],
+ "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-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": {
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "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": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "confidentiality_type": {
+ "enum": [
+ "mutual",
+ "nda",
+ "provider",
+ "custom"
+ ],
+ "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-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": {
+ "enum": [
+ "month",
+ "year",
+ "quarter"
+ ],
+ "type": "string"
+ },
+ "include_fees_include_amount": {
+ "type": "boolean"
+ },
+ "include_fees_include_other": {
+ "type": "boolean"
+ },
+ "include_fees_other": {
+ "type": "string"
+ },
+ "include_functionality": {
+ "type": "boolean"
+ },
+ "include_functionality_val": {
+ "type": "string"
+ },
+ "include_launch_date": {
+ "type": "boolean"
+ },
+ "include_launch_date_custom": {
+ "type": "string"
+ },
+ "include_launch_date_date": {
+ "format": "date-time",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$",
+ "type": "string"
+ },
+ "include_launch_date_type": {
+ "enum": [
+ "date",
+ "custom"
+ ],
+ "type": "string"
+ },
+ "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": {
- "enum": [
- "signature",
- "date"
- ],
- "type": "string"
- },
- "framework_terms_type": {
- "type": "string"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "parent_agreement_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "underlying_agreement_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "underlying_agreement_type": {
- "type": "string"
- },
- "underlying_agreement_val": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "baa_attributes": {
- "additionalProperties": false,
- "description": "Override baa terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "aggregation_limitations_permitted": {
- "type": "boolean"
- },
- "aggregation_limitations_permitted_val": {
- "type": "string"
- },
- "breach_notification_unit": {
- "enum": [
- "hours",
- "business days",
- "calendar days"
- ],
- "type": "string"
- },
- "breach_notification_val": {
- "type": "number"
- },
- "business_associate_relationship_type": {
- "enum": [
- "provider",
- "company"
- ],
- "type": "string"
- },
- "deidentification_limitations_include_purpose": {
- "type": "boolean"
- },
- "deidentification_limitations_include_requirements": {
- "type": "boolean"
- },
- "deidentification_limitations_permitted": {
- "type": "boolean"
- },
- "deidentification_limitations_purpose_val": {
- "type": "string"
- },
- "deidentification_limitations_requirements_val": {
- "type": "string"
- },
- "designated_record_set_provider_maintains": {
- "type": "boolean"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_aggregation_limitations": {
- "type": "boolean"
- },
- "include_deidentification_limitations": {
- "type": "boolean"
- },
- "include_limitations": {
- "type": "boolean"
- },
- "include_offshore_limitations": {
- "type": "boolean"
- },
- "include_subcontract_limitations": {
- "type": "boolean"
- },
- "offshore_limitations_permitted": {
- "type": "boolean"
- },
- "offshore_limitations_permitted_val": {
- "type": "string"
- },
- "subcontract_limitations_include_notice": {
- "type": "boolean"
- },
- "subcontract_limitations_include_permission": {
- "type": "boolean"
- },
- "subcontract_limitations_notice_val": {
- "type": "string"
- },
- "subcontract_limitations_permission_val": {
- "type": "string"
- },
- "subcontract_limitations_permitted": {
- "type": "boolean"
- },
- "underlying_agreement_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "underlying_agreement_type": {
- "enum": [
- "internal",
- "external",
- "none"
- ],
- "type": "string"
- },
- "underlying_agreement_val": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "billing_email": {
- "description": "Email of the billing contact. Used when include_billing_info is true.",
- "format": "email",
- "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
- "type": "string"
- },
- "billing_name": {
- "description": "Name of the billing contact. Used when include_billing_info is true.",
- "type": "string"
- },
- "billing_workflow_type": {
- "description": "The type of billing workflow. Use \"link\" to provide a payment_link_url, or \"stripe\" for Stripe-managed billing.",
- "enum": [
- "link",
- "stripe"
- ],
- "type": "string"
- },
- "chosen_courts_country": {
- "description": "The country in which disputes will be resolved.",
- "type": "string"
- },
- "chosen_courts_region": {
- "description": "The state or region in which disputes will be resolved.",
- "type": "string"
- },
- "csa_attributes": {
- "additionalProperties": false,
- "description": "Override csa terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "customer_description": {
- "type": "string"
- },
- "effective_date": {
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "effective_date_marketplace": {
- "enum": [
- "AWS",
- "GCP",
- "Azure"
- ],
- "type": "string"
- },
- "effective_date_type": {
- "enum": [
- "signature",
- "date",
- "marketplace_acceptance"
- ],
- "type": "string"
- },
- "general_cap_amount": {
- "type": "number"
- },
- "general_cap_amount_type": {
- "enum": [
- "preceding",
- "base",
- "period"
- ],
- "type": "string"
- },
- "general_cap_period_currency": {
- "type": "number"
- },
- "general_cap_period_qty": {
- "type": "number"
- },
- "general_cap_preceding_amount": {
- "type": "number"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_acceptable_use_policy": {
- "type": "boolean"
- },
- "include_acceptable_use_policy_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_acceptable_use_policy_location": {
- "type": "string"
- },
- "include_acceptable_use_policy_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_additional_warranties": {
- "type": "boolean"
- },
- "include_additional_warranties_by_customer": {
- "type": "string"
- },
- "include_additional_warranties_by_provider": {
- "type": "string"
- },
- "include_additional_warranties_include_by_customer": {
- "type": "boolean"
- },
- "include_additional_warranties_include_by_provider": {
- "type": "boolean"
- },
- "include_ai_addendum": {
- "type": "boolean"
- },
- "include_ai_addendum_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_covered_claims": {
- "type": "boolean"
- },
- "include_covered_claims_customer_claims": {
- "type": "string"
- },
- "include_covered_claims_include_customer_claims": {
- "type": "boolean"
- },
- "include_covered_claims_include_provider_claims": {
- "type": "boolean"
- },
- "include_covered_claims_provider_claims": {
- "type": "string"
- },
- "include_dpa": {
- "type": "boolean"
- },
- "include_dpa_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_dpa_location": {
- "type": "string"
- },
- "include_dpa_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_increased_cap_amount": {
- "type": "boolean"
- },
- "include_increased_claims": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_confidentiality": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_confidentiality_negligence": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_privsec": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_privsec_negligence": {
- "type": "boolean"
- },
- "include_increased_claims_include_other": {
- "type": "boolean"
- },
- "include_increased_claims_indemnification_obligation": {
- "type": "boolean"
- },
- "include_increased_claims_other": {
- "type": "string"
- },
- "include_insurance_minimums": {
- "type": "boolean"
- },
- "include_insurance_minimums_add_customer": {
- "type": "boolean"
- },
- "include_insurance_minimums_add_customer_com_gen_liability": {
- "type": "boolean"
- },
- "include_insurance_minimums_add_customer_cyber_liability": {
- "type": "boolean"
- },
- "include_insurance_minimums_add_customer_errors_omissions": {
- "type": "boolean"
- },
- "include_insurance_minimums_additional_information": {
- "type": "boolean"
- },
- "include_insurance_minimums_additional_information_text": {
- "type": "string"
- },
- "include_insurance_minimums_cyber_liability_aggregate": {
- "type": "number"
- },
- "include_insurance_minimums_cyber_liability_minimum": {
- "type": "number"
- },
- "include_insurance_minimums_employer_liability_aggregate": {
- "type": "number"
- },
- "include_insurance_minimums_employer_liability_minimum": {
- "type": "number"
- },
- "include_insurance_minimums_general_liability_aggregate": {
- "type": "number"
- },
- "include_insurance_minimums_general_liability_minimum": {
- "type": "number"
- },
- "include_insurance_minimums_include_cyber_liability": {
- "type": "boolean"
- },
- "include_insurance_minimums_include_employer_liability": {
- "type": "boolean"
- },
- "include_insurance_minimums_include_general_liability": {
- "type": "boolean"
- },
- "include_insurance_minimums_include_workers_compensation": {
- "type": "boolean"
- },
- "include_publicity_rights": {
- "type": "boolean"
- },
- "include_publicity_rights_type": {
- "enum": [
- "public",
- "non-public"
- ],
- "type": "string"
- },
- "include_security_policy": {
- "type": "boolean"
- },
- "include_security_policy_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_security_policy_fedramp_auth": {
- "type": "boolean"
- },
- "include_security_policy_hipaa": {
- "type": "boolean"
- },
- "include_security_policy_hitrust": {
- "type": "boolean"
- },
- "include_security_policy_include_annual_maintenance": {
- "type": "boolean"
- },
- "include_security_policy_include_location": {
- "type": "boolean"
- },
- "include_security_policy_include_other": {
- "type": "boolean"
- },
- "include_security_policy_include_reasonable_efforts": {
- "type": "boolean"
- },
- "include_security_policy_iso27001": {
- "type": "boolean"
- },
- "include_security_policy_location": {
- "type": "string"
- },
- "include_security_policy_other": {
- "type": "string"
- },
- "include_security_policy_pci1": {
- "type": "boolean"
- },
- "include_security_policy_pci2": {
- "type": "boolean"
- },
- "include_security_policy_penetration_testing": {
- "type": "boolean"
- },
- "include_security_policy_soc2": {
- "type": "boolean"
- },
- "include_security_policy_soc2_type2": {
- "type": "boolean"
- },
- "include_security_policy_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_supercap": {
- "description": "CSA 3.0 renamed `include_increased_cap_amount` to `include_supercap`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_increased_cap_amount`. Sending the other spelling returns a 422.",
- "type": "boolean"
- },
- "include_uncapped_claims": {
- "description": "CSA 3.0 renamed `include_unlimited_claims` to `include_uncapped_claims`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims`. Sending the other spelling returns a 422.",
- "type": "boolean"
- },
- "include_uncapped_claims_breach_of_confidentiality": {
- "description": "CSA 3.0 renamed `include_unlimited_claims_breach_of_confidentiality` to `include_uncapped_claims_breach_of_confidentiality`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_breach_of_confidentiality`. Sending the other spelling returns a 422.",
- "type": "boolean"
- },
- "include_uncapped_claims_breach_of_confidentiality_negligence": {
- "description": "CSA 3.0 renamed `include_unlimited_claims_breach_of_confidentiality_negligence` to `include_uncapped_claims_breach_of_confidentiality_negligence`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_breach_of_confidentiality_negligence`. Sending the other spelling returns a 422.",
- "type": "boolean"
- },
- "include_uncapped_claims_breach_of_privsec": {
- "description": "CSA 3.0 renamed `include_unlimited_claims_breach_of_privsec` to `include_uncapped_claims_breach_of_privsec`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_breach_of_privsec`. Sending the other spelling returns a 422.",
- "type": "boolean"
- },
- "include_uncapped_claims_breach_of_privsec_negligence": {
- "description": "CSA 3.0 renamed `include_unlimited_claims_breach_of_privsec_negligence` to `include_uncapped_claims_breach_of_privsec_negligence`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_breach_of_privsec_negligence`. Sending the other spelling returns a 422.",
- "type": "boolean"
- },
- "include_uncapped_claims_include_other": {
- "description": "CSA 3.0 renamed `include_unlimited_claims_include_other` to `include_uncapped_claims_include_other`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_include_other`. Sending the other spelling returns a 422.",
- "type": "boolean"
- },
- "include_uncapped_claims_indemnification_obligation": {
- "description": "CSA 3.0 renamed `include_unlimited_claims_indemnification_obligation` to `include_uncapped_claims_indemnification_obligation`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_indemnification_obligation`. Sending the other spelling returns a 422.",
- "type": "boolean"
- },
- "include_uncapped_claims_other": {
- "description": "CSA 3.0 renamed `include_unlimited_claims_other` to `include_uncapped_claims_other`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_other`. Sending the other spelling returns a 422.",
- "type": "boolean"
- },
- "include_unlimited_claims": {
- "type": "boolean"
- },
- "include_unlimited_claims_breach_of_confidentiality": {
- "type": "boolean"
- },
- "include_unlimited_claims_breach_of_confidentiality_negligence": {
- "type": "boolean"
- },
- "include_unlimited_claims_breach_of_privsec": {
- "type": "boolean"
- },
- "include_unlimited_claims_breach_of_privsec_negligence": {
- "type": "boolean"
- },
- "include_unlimited_claims_include_other": {
- "type": "boolean"
- },
- "include_unlimited_claims_indemnification_obligation": {
- "type": "boolean"
- },
- "include_unlimited_claims_other": {
- "type": "string"
- },
- "increased_cap_amount_currency": {
- "type": "number"
- },
- "increased_cap_amount_period_currency": {
- "type": "number"
- },
- "increased_cap_amount_period_qty": {
- "type": "number"
- },
- "increased_cap_amount_qty": {
- "type": "number"
- },
- "increased_cap_amount_type": {
- "enum": [
- "qty",
- "currency",
- "period"
- ],
- "type": "string"
- },
- "provider": {
- "type": "string"
- },
- "supercap_currency": {
- "description": "CSA 3.0 renamed `increased_cap_amount_currency` to `supercap_currency`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `increased_cap_amount_currency`. Sending the other spelling returns a 422.",
- "type": "number"
- },
- "supercap_period_currency": {
- "description": "CSA 3.0 renamed `increased_cap_amount_period_currency` to `supercap_period_currency`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `increased_cap_amount_period_currency`. Sending the other spelling returns a 422.",
- "type": "number"
- },
- "supercap_period_qty": {
- "description": "CSA 3.0 renamed `increased_cap_amount_period_qty` to `supercap_period_qty`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `increased_cap_amount_period_qty`. Sending the other spelling returns a 422.",
- "type": "number"
- },
- "supercap_qty": {
- "description": "CSA 3.0 renamed `increased_cap_amount_qty` to `supercap_qty`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `increased_cap_amount_qty`. Sending the other spelling returns a 422.",
- "type": "number"
- },
- "supercap_type": {
- "description": "CSA 3.0 renamed `increased_cap_amount_type` to `supercap_type`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `increased_cap_amount_type`. Sending the other spelling returns a 422.",
- "type": "number"
- }
- },
- "type": "object"
- },
- "csa_order_form_attributes": {
- "additionalProperties": false,
- "description": "Override csa order form terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "additional_changes": {
- "type": "string"
- },
- "additional_parameters_or_limitations": {
- "type": "string"
- },
- "affiliates_as_users": {
- "type": "boolean"
- },
- "cloud_service_description": {
- "type": "string"
- },
- "consumption_units": {
- "type": "string"
- },
- "fee_amount": {
- "type": "number"
- },
- "fee_custom_unit": {
- "type": "string"
- },
- "fee_period": {
- "enum": [
- "Subscription Period",
- "month",
- "year",
- "User",
- "Custom unit"
- ],
- "type": "string"
- },
- "fees_attributes": {
- "additionalProperties": {
- "anyOf": [
- {
- "additionalProperties": false,
- "description": "Fees::Flat (fee_type \"flat\"). A fixed recurring fee, e.g. a platform subscription. Set type to \"Fees::Flat\" or fee_type to \"flat\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "Fixed amount in the order form's fees_currency, charged per fee_period. A plain amount, not cents: 20 means 20.00.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"flat\". Alternative to type.",
- "enum": [
- "flat"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Flat\". Optional when fee_type is set.",
- "enum": [
- "Fees::Flat"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Discount (fee_type \"discount\"). A discount, as a fixed amount or a percentage, applied forever, once, or for a number of months. Set type to \"Fees::Discount\" or fee_type to \"discount\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "Discount size: an amount in fees_currency when discount_type is fixed_amount (a plain amount, not cents: 20 means 20.00), or a percentage (e.g. 10 for 10%) when it is percentage.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "discount_duration_amount": {
- "description": "Number of months the discount applies. Required when discount_duration_type is multiple_months.",
- "type": "number"
- },
- "discount_duration_type": {
- "description": "How long the discount applies. multiple_months also needs discount_duration_amount.",
- "enum": [
- "forever",
- "once",
- "multiple_months"
- ],
- "type": "string"
- },
- "discount_type": {
- "description": "Whether cost is a currency amount or a percentage.",
- "enum": [
- "fixed_amount",
- "percentage"
- ],
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"discount\". Alternative to type.",
- "enum": [
- "discount"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Discount\". Optional when fee_type is set.",
- "enum": [
- "Fees::Discount"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Cost (fee_type \"cost\"). A per-unit fee: price per unit times quantity, e.g. seats. Set type to \"Fees::Cost\" or fee_type to \"cost\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "Price per unit in fees_currency. The row total is quantity x cost. A plain amount, not cents: 20 means 20.00.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"cost\". Alternative to type.",
- "enum": [
- "cost"
- ],
- "type": "string"
- },
- "quantity": {
- "description": "Number of units.",
- "type": "number"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Cost\". Optional when fee_type is set.",
- "enum": [
- "Fees::Cost"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Attachment (fee_type \"attachment\"). A fee described in an uploaded attachment instead of in the table. Set type to \"Fees::Attachment\" or fee_type to \"attachment\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "attachment_id": {
- "description": "ID of an attachment uploaded with upload-attachment.",
- "type": "string"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"attachment\". Alternative to type.",
- "enum": [
- "attachment"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Attachment\". Optional when fee_type is set.",
- "enum": [
- "Fees::Attachment"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Graduated (fee_type \"graduated\"). Tiered pricing, with the price set per tier in graduated_fee_tiers_attributes. Set type to \"Fees::Graduated\" or fee_type to \"graduated\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"graduated\". Alternative to type.",
- "enum": [
- "graduated"
- ],
- "type": "string"
- },
- "graduated_fee_tiers_attributes": {
- "additionalProperties": {
- "additionalProperties": false,
- "properties": {
- "flat_price": {
- "type": "number"
- },
- "price_per_unit": {
- "type": "string"
- },
- "upper_limit": {
- "type": "number"
- }
- },
- "type": "object"
- },
- "description": "Graduated fee tiers. Use string keys such as \"0\", \"1\".",
- "propertyNames": {
- "type": "string"
- },
- "type": "object"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Graduated\". Optional when fee_type is set.",
- "enum": [
- "Fees::Graduated"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Included (fee_type \"included\"). An item included at no charge. Set type to \"Fees::Included\" or fee_type to \"included\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"included\". Alternative to type.",
- "enum": [
- "included"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Included\". Optional when fee_type is set.",
- "enum": [
- "Fees::Included"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Metered (fee_type \"metered\"). Usage-based pricing, billed per unit used. Set type to \"Fees::Metered\" or fee_type to \"metered\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "Price per unit of usage in fees_currency. A plain amount, not cents: 20 means 20.00.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"metered\". Alternative to type.",
- "enum": [
- "metered"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Metered\". Optional when fee_type is set.",
- "enum": [
- "Fees::Metered"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::OneTime (fee_type \"one_time\"). A one-time charge, such as a setup fee. Set type to \"Fees::OneTime\" or fee_type to \"one_time\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "One-time amount in fees_currency, charged once rather than per fee_period. A plain amount, not cents: 20 means 20.00.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"one_time\". Alternative to type.",
- "enum": [
- "one_time"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::OneTime\". Optional when fee_type is set.",
- "enum": [
- "Fees::OneTime"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Text (fee_type \"text\"). A fee term described in free text. Set type to \"Fees::Text\" or fee_type to \"text\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"text\". Alternative to type.",
- "enum": [
- "text"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Text\". Optional when fee_type is set.",
- "enum": [
- "Fees::Text"
- ],
- "type": "string"
- }
- },
- "type": "object"
- }
- ]
- },
- "description": "Fee table rows, keyed by string index (\"0\", \"1\", ...). Replaces the template's fees when provided. Each row sets type or fee_type to pick the fee class. Amounts are in the order form's fees_currency and, for recurring fees, are charged per fee_period.",
- "examples": [
- {
- "0": {
- "cost": 2000,
- "description": "Platform subscription",
- "type": "Fees::Flat"
- }
- },
- {
- "0": {
- "cost": 50,
- "description": "Seats",
- "fee_type": "cost",
- "quantity": 10
- },
- "1": {
- "cost": 10,
- "description": "Launch discount",
- "discount_duration_amount": 3,
- "discount_duration_type": "multiple_months",
- "discount_type": "percentage",
- "fee_type": "discount"
- }
- }
- ],
- "propertyNames": {
- "type": "string"
- },
- "type": "object"
- },
- "fees_currency": {
- "enum": [
- "USD",
- "EUR",
- "GBP",
- "CAD",
- "AUD",
- "SGD",
- "ILS",
- "JPY",
- "CHF",
- "HKD"
- ],
- "type": "string"
- },
- "fees_include_fee_increase_upon_renewal": {
- "type": "boolean"
- },
- "fees_include_fee_increase_upon_renewal_fee": {
- "type": "number"
- },
- "fees_include_fee_increase_upon_renewal_type": {
- "enum": [
- "will",
- "may"
- ],
- "type": "string"
- },
- "fees_inclusive_of_taxes": {
- "type": "boolean"
- },
- "framework_terms_type": {
- "enum": [
- "new",
- "existing",
- "description"
- ],
- "type": "string"
- },
- "free_trial_days": {
- "type": "number"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_additional_changes": {
- "type": "boolean"
- },
- "include_additional_parameters_or_limitations": {
- "type": "boolean"
- },
- "include_consumption": {
- "type": "boolean"
- },
- "include_fees": {
- "type": "boolean"
- },
- "include_fees_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_fees_include_attachment": {
- "type": "boolean"
- },
- "include_fees_other": {
- "type": "boolean"
- },
- "include_fees_other_val": {
- "type": "string"
- },
- "include_fees_table": {
- "type": "boolean"
- },
- "include_fees_table_period": {
- "enum": [
- "Subscription Period",
- "month",
- "year",
- "User"
- ],
- "type": "string"
- },
- "include_free_trial": {
- "type": "boolean"
- },
- "include_max_users": {
- "type": "boolean"
- },
- "include_pilot_period": {
- "type": "boolean"
- },
- "include_pilot_period_duration_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_pilot_period_duration_type": {
- "enum": [
- "day",
- "week",
- "month"
- ],
- "type": "string"
- },
- "include_pilot_period_include_fees": {
- "type": "boolean"
- },
- "include_pilot_period_include_fees_amount": {
- "type": "number"
- },
- "include_pilot_period_include_modifications": {
- "type": "boolean"
- },
- "include_pilot_period_include_modifications_description": {
- "type": "string"
- },
- "include_product_support": {
- "type": "boolean"
- },
- "include_product_support_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_product_support_description": {
- "type": "string"
- },
- "include_product_support_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_professional_services": {
- "type": "boolean"
- },
- "include_professional_services_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_professional_services_custom_name": {
- "type": "string"
- },
- "include_professional_services_description": {
- "type": "string"
- },
- "include_professional_services_end_date": {
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "include_professional_services_fees_description": {
- "type": "string"
- },
- "include_professional_services_include_end_date": {
- "type": "boolean"
- },
- "include_professional_services_include_fees_description": {
- "type": "boolean"
- },
- "include_professional_services_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_sla": {
- "type": "boolean"
- },
- "include_sla_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_sla_description": {
- "type": "string"
- },
- "include_sla_include_response_time": {
- "type": "boolean"
- },
- "include_sla_include_response_time_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_sla_include_response_time_credit": {
- "type": "number"
- },
- "include_sla_include_response_time_duration": {
- "enum": [
- "hour",
- "day",
- "week",
- "month",
- "hours"
- ],
- "type": "string"
- },
- "include_sla_include_response_time_support_channel": {
- "type": "string"
- },
- "include_sla_include_target_uptime": {
- "type": "boolean"
- },
- "include_sla_maintenance_notice": {
- "type": "boolean"
- },
- "include_sla_maintenance_window": {
- "type": "boolean"
- },
- "include_sla_maintenance_window_type": {
- "enum": [
- "standard",
- "none"
- ],
- "type": "string"
- },
- "include_sla_standard_maintenance_notice_qty": {
- "type": "number"
- },
- "include_sla_standard_maintenance_notice_unit": {
- "enum": [
- "hour",
- "day",
- "week",
- "month"
- ],
- "type": "string"
- },
- "include_sla_standard_maintenance_window_end_time": {
- "type": "string"
- },
- "include_sla_standard_maintenance_window_friday": {
- "type": "boolean"
- },
- "include_sla_standard_maintenance_window_monday": {
- "type": "boolean"
- },
- "include_sla_standard_maintenance_window_saturday": {
- "type": "boolean"
- },
- "include_sla_standard_maintenance_window_start_time": {
- "type": "string"
- },
- "include_sla_standard_maintenance_window_sunday": {
- "type": "boolean"
- },
- "include_sla_standard_maintenance_window_thursday": {
- "type": "boolean"
- },
- "include_sla_standard_maintenance_window_time_zone": {
- "type": "string"
- },
- "include_sla_standard_maintenance_window_tuesday": {
- "type": "boolean"
- },
- "include_sla_standard_maintenance_window_wednesday": {
- "type": "boolean"
- },
- "include_sla_standard_target_uptime": {
- "type": "number"
- },
- "include_sla_type": {
- "enum": [
- "description",
- "standard",
- "attachment"
- ],
- "type": "string"
- },
- "include_subscription_start_date": {
- "type": "boolean"
- },
- "include_subscription_start_date_date": {
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "include_usage_review": {
- "type": "boolean"
- },
- "include_usage_review_val": {
- "type": "string"
- },
- "include_use_limitations": {
- "type": "boolean"
- },
- "include_use_limitations_val": {
- "type": "string"
- },
- "invoice_period": {
- "enum": [
- "monthly",
- "quarterly",
- "semiannually",
- "annually",
- "Custom unit",
- "Monthly",
- "Quarterly",
- "Semiannually",
- "Annually"
- ],
- "type": "string"
- },
- "invoice_period_custom_unit": {
- "type": "string"
- },
- "max_consumption": {
- "type": "number"
- },
- "max_users": {
- "type": "number"
- },
- "negotiations_allowed": {
- "description": "When true, the recipient can propose changes to the order form, even when the agreement-level `negotiations_allowed` is false. This only covers the order form.",
- "type": "boolean"
- },
- "order_date_date": {
- "type": "string"
- },
- "order_date_other": {
- "type": "string"
- },
- "order_date_type": {
- "enum": [
- "signature",
- "date",
- "other"
- ],
- "type": "string"
- },
- "payment_period": {
- "type": "number"
- },
- "payment_period_timeframe": {
- "enum": [
- "Customer's receipt of invoice",
- "date of invoice"
- ],
- "type": "string"
- },
- "payment_period_unit": {
- "enum": [
- "day(s)",
- "week(s)",
- "month(s)",
- "marketplace_acceptance"
- ],
- "type": "string"
- },
- "payment_process_automatic_frequency": {
- "enum": [
- "monthly",
- "quarterly",
- "semiannually",
- "annually"
- ],
- "type": "string"
- },
- "payment_process_type": {
- "enum": [
- "automatic",
- "invoice",
- "custom",
- "marketplace_acceptance"
- ],
- "type": "string"
- },
- "payment_process_type_custom_val": {
- "type": "string"
- },
- "payment_process_type_invoice_amount": {
- "type": "number"
- },
- "payment_process_type_invoice_custom_unit": {
- "type": "string"
- },
- "payment_process_type_invoice_duration": {
- "enum": [
- "day",
- "week",
- "month",
- "year",
- "day(s)",
- "week(s)",
- "month(s)",
- "year(s)"
- ],
- "type": "string"
- },
- "payment_process_type_invoice_duration_start": {
- "enum": [
- "Customer's receipt of invoice",
- "date of invoice"
- ],
- "type": "string"
- },
- "payment_process_type_invoice_type": {
- "enum": [
- "monthly",
- "quarterly",
- "semiannually",
- "annually",
- "Custom unit"
- ],
- "type": "string"
- },
- "pilot_period_stripe_product_id": {
- "type": "string"
- },
- "service_credits_attributes": {
- "additionalProperties": {
- "additionalProperties": false,
- "properties": {
- "credit": {
- "type": "number"
- },
- "max": {
- "type": "number"
- },
- "min": {
- "type": "number"
- }
- },
- "type": "object"
- },
- "description": "Service credits. Use string keys such as \"0\", \"1\".",
- "propertyNames": {
- "type": "string"
- },
- "type": "object"
- },
- "subscription_auto_renew": {
- "enum": [
- "days",
- "subscription_end"
- ],
- "type": "string"
- },
- "subscription_period": {
- "type": "number"
- },
- "subscription_period_unit": {
- "type": "string"
- },
- "subscription_renewal_notice_days": {
- "type": "number"
- },
- "subscription_start_date": {
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "subscription_start_date_type": {
- "enum": [
- "effective_date",
- "date"
- ],
- "type": "string"
- },
- "underlying_agreement_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "use_limitations_attributes": {
- "additionalProperties": {
- "additionalProperties": false,
- "properties": {
- "amount": {
- "type": "number"
- },
- "limitation_type": {
- "type": "string"
- },
- "unit": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "description": "Use limitations. Use string keys such as \"0\", \"1\".",
- "propertyNames": {
- "type": "string"
- },
- "type": "object"
- }
- },
- "type": "object"
- },
- "custom_field_values": {
- "description": "Values for a custom template's fields, keyed by the field keys defined in the template's YAML definition. Only used when template_id is a custom template. Template defaults fill any fields you omit; a required field with no default and no submitted value returns a 400 naming the field. Values are validated against the field's input type: select and radio values must be one of the field's options, multiselect values are an array of selections each of which must be one of the field's options, number and currency values must be numeric, date values must be YYYY-MM-DD, and email values must be valid addresses. An invalid value returns a 400 naming the field."
- },
- "design_partner_attributes": {
- "additionalProperties": false,
- "description": "Override design partner terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "customer_description": {
- "type": "string"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_fees": {
- "type": "boolean"
- },
- "include_fees_amount": {
- "type": "number"
- },
- "include_fees_description": {
- "type": "string"
- },
- "include_fees_pay_by_amount": {
- "type": "string"
- },
- "include_fees_type": {
- "enum": [
- "default_language",
- "description"
- ],
- "type": "string"
- },
- "include_fees_unit": {
- "enum": [
- "month",
- "quarter",
- "year",
- "Term"
- ],
- "type": "string"
- },
- "include_program_appear_as_customer_private": {
- "type": "boolean"
- },
- "include_program_appear_as_customer_public": {
- "type": "boolean"
- },
- "include_program_case_study": {
- "type": "boolean"
- },
- "include_program_develop_functionality": {
- "type": "boolean"
- },
- "include_program_develop_functionality_val": {
- "type": "string"
- },
- "include_program_discount": {
- "type": "boolean"
- },
- "include_program_discount_amount": {
- "type": "number"
- },
- "include_program_discount_unit": {
- "enum": [
- "U.S. Dollars",
- "percent"
- ],
- "type": "string"
- },
- "include_program_participation_feedback": {
- "type": "boolean"
- },
- "include_program_participation_feedback_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_program_participation_feedback_unit": {
- "enum": [
- "month",
- "quarter",
- "year",
- "Term"
- ],
- "type": "string"
- },
- "include_program_partner_other": {
- "type": "boolean"
- },
- "include_program_partner_other_val": {
- "type": "string"
- },
- "include_program_provider_other": {
- "type": "boolean"
- },
- "include_program_provider_other_val": {
- "type": "string"
- },
- "include_program_reference": {
- "type": "boolean"
- },
- "product_description": {
- "type": "string"
- },
- "term_amount": {
- "type": "number"
- },
- "term_unit": {
- "enum": [
- "day(s)",
- "week(s)",
- "month(s)",
- "quarter(s)",
- "year(s)"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- "district_or_county": {
- "description": "The district or county for dispute resolution.",
- "type": "string"
- },
- "dpa_attributes": {
- "additionalProperties": false,
- "description": "Override dpa terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "approved_subprocessor_type": {
- "description": "`internal` lists approved subprocessors in the agreement (`subprocessors_attributes`); `external` points to a list published elsewhere.",
- "enum": [
- "internal",
- "external"
- ],
- "type": "string"
- },
- "cloud_service_product_name": {
- "type": "string"
- },
- "competent_supervisory_authority": {
- "type": "string"
- },
- "customer_description": {
- "type": "string"
- },
- "data_exporter_address_city": {
- "type": "string"
- },
- "data_exporter_address_country": {
- "type": "string"
- },
- "data_exporter_address_state": {
- "type": "string"
- },
- "data_exporter_address_street_address": {
- "type": "string"
- },
- "data_exporter_address_zipcode": {
- "type": "string"
- },
- "data_exporter_contact_details": {
- "type": "string"
- },
- "data_exporter_contact_name": {
- "type": "string"
- },
- "data_exporter_contact_position": {
- "type": "string"
- },
- "data_exporter_role": {
- "description": "Role of the data exporter. Overwritten to `Controller` when the agreement is created from a template.",
- "enum": [
- "Controller",
- "Processor"
- ],
- "type": "string"
- },
- "data_importer_address": {
- "type": "string"
- },
- "data_importer_address_city": {
- "type": "string"
- },
- "data_importer_address_country": {
- "type": "string"
- },
- "data_importer_address_state": {
- "type": "string"
- },
- "data_importer_address_street_address": {
- "type": "string"
- },
- "data_importer_address_zipcode": {
- "type": "string"
- },
- "data_importer_contact_details": {
- "type": "string"
- },
- "data_importer_contact_name": {
- "type": "string"
- },
- "data_importer_contact_position": {
- "type": "string"
- },
- "duration_of_processing": {
- "type": "string"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_covered_claim": {
- "type": "boolean"
- },
- "include_covered_claim_external_val": {
- "type": "string"
- },
- "include_covered_claim_internal_val": {
- "type": "string"
- },
- "include_covered_claim_type": {
- "description": "Which covered-claim text applies: `internal` uses `include_covered_claim_internal_val`, `external` uses `include_covered_claim_external_val`. Required when `include_covered_claim` is true.",
- "enum": [
- "internal",
- "external"
- ],
- "type": "string"
- },
- "include_data_subjects_custom": {
- "type": "boolean"
- },
- "include_data_subjects_custom_val": {
- "type": "string"
- },
- "include_data_subjects_employees": {
- "type": "boolean"
- },
- "include_data_subjects_end_users": {
- "type": "boolean"
- },
- "include_external_subprocessor_location": {
- "type": "string"
- },
- "include_frequency_of_transfer_continuous": {
- "type": "boolean"
- },
- "include_frequency_of_transfer_custom": {
- "type": "boolean"
- },
- "include_frequency_of_transfer_custom_val": {
- "type": "string"
- },
- "include_governing_country_eu": {
- "type": "boolean"
- },
- "include_governing_country_eu_val": {
- "type": "string"
- },
- "include_governing_country_uk": {
- "type": "boolean"
- },
- "include_governing_country_uk_val": {
- "type": "string"
- },
- "include_governing_law": {
- "type": "boolean"
- },
- "include_governing_law_country": {
- "type": "string"
- },
- "include_governing_law_state": {
- "type": "string"
- },
- "include_increased_claim_amount": {
- "description": "Legacy field. Stored but not shown on the DPA; use the `include_liability_cap*` fields instead.",
- "type": "boolean"
- },
- "include_increased_claim_amount_currency": {
- "description": "Legacy field. Stored but not shown on the DPA; use the `include_liability_cap*` fields instead."
- },
- "include_increased_claim_amount_qty": {
- "description": "Legacy field. Stored but not shown on the DPA; use the `include_liability_cap*` fields instead."
- },
- "include_increased_claim_amount_type": {
- "description": "Legacy field. Stored but not shown on the DPA; use the `include_liability_cap*` fields instead.",
- "type": "string"
- },
- "include_liability_cap": {
- "type": "boolean"
- },
- "include_liability_cap_amount_constant_external": {
- "type": "string"
- },
- "include_liability_cap_amount_constant_internal": {
- "type": "string"
- },
- "include_liability_cap_amount_currency_external": {
- "description": "Currency amount. Numbers and numeric strings (commas allowed) are both accepted."
- },
- "include_liability_cap_amount_currency_internal": {
- "description": "Currency amount. Numbers and numeric strings (commas allowed) are both accepted."
- },
- "include_liability_cap_csa_type": {
- "description": "Which liability cap values apply: the `_internal` or `_external` amount fields. Required when `include_liability_cap` is true.",
- "enum": [
- "internal",
- "external"
- ],
- "type": "string"
- },
- "include_personal_data_biographic_info": {
- "type": "boolean"
- },
- "include_personal_data_contact_info": {
- "type": "boolean"
- },
- "include_personal_data_custom": {
- "type": "boolean"
- },
- "include_personal_data_custom_val": {
- "type": "string"
- },
- "include_personal_data_employment_info": {
- "type": "boolean"
- },
- "include_personal_data_financial_info": {
- "type": "boolean"
- },
- "include_personal_data_location": {
- "type": "boolean"
- },
- "include_personal_data_name": {
- "type": "boolean"
- },
- "include_personal_data_transactional_info": {
- "type": "boolean"
- },
- "include_personal_data_user_activity_info": {
- "type": "boolean"
- },
- "include_processing_purpose_custom": {
- "type": "boolean"
- },
- "include_processing_purpose_custom_val": {
- "type": "string"
- },
- "include_processing_purpose_erasing": {
- "type": "boolean"
- },
- "include_processing_purpose_holding": {
- "type": "boolean"
- },
- "include_processing_purpose_protecting": {
- "type": "boolean"
- },
- "include_processing_purpose_receiving": {
- "type": "boolean"
- },
- "include_processing_purpose_returning": {
- "type": "boolean"
- },
- "include_processing_purpose_sharing": {
- "type": "boolean"
- },
- "include_processing_purpose_updating": {
- "type": "boolean"
- },
- "include_processing_purpose_using": {
- "type": "boolean"
- },
- "include_provider_security_contact_address": {
- "type": "boolean"
- },
- "include_provider_security_contact_address_city": {
- "type": "string"
- },
- "include_provider_security_contact_address_country": {
- "type": "string"
- },
- "include_provider_security_contact_address_state": {
- "type": "string"
- },
- "include_provider_security_contact_address_street_address": {
- "type": "string"
- },
- "include_provider_security_contact_address_zipcode": {
- "type": "string"
- },
- "include_provider_security_contact_email": {
- "type": "boolean"
- },
- "include_provider_security_contact_email_val": {
- "format": "email",
- "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
- "type": "string"
- },
- "include_security_measures_accountability": {
- "type": "boolean"
- },
- "include_security_measures_accountability_val": {
- "type": "string"
- },
- "include_security_measures_certification_or_assurance": {
- "type": "boolean"
- },
- "include_security_measures_certification_or_assurance_val": {
- "type": "string"
- },
- "include_security_measures_confidentiality_integrity": {
- "type": "boolean"
- },
- "include_security_measures_confidentiality_integrity_val": {
- "type": "string"
- },
- "include_security_measures_data_at_rest": {
- "type": "boolean"
- },
- "include_security_measures_data_at_rest_val": {
- "type": "string"
- },
- "include_security_measures_data_minimization": {
- "type": "boolean"
- },
- "include_security_measures_data_minimization_val": {
- "type": "string"
- },
- "include_security_measures_data_quality": {
- "type": "boolean"
- },
- "include_security_measures_data_quality_val": {
- "type": "string"
- },
- "include_security_measures_data_retention": {
- "type": "boolean"
- },
- "include_security_measures_data_retention_val": {
- "type": "string"
- },
- "include_security_measures_data_transmission": {
- "type": "boolean"
- },
- "include_security_measures_data_transmission_val": {
- "type": "string"
- },
- "include_security_measures_event_logging": {
- "type": "boolean"
- },
- "include_security_measures_event_logging_val": {
- "type": "string"
- },
- "include_security_measures_identity_auth": {
- "type": "boolean"
- },
- "include_security_measures_identity_auth_val": {
- "type": "string"
- },
- "include_security_measures_it_security_governance": {
- "type": "boolean"
- },
- "include_security_measures_it_security_governance_val": {
- "type": "string"
- },
- "include_security_measures_physical_security": {
- "type": "boolean"
- },
- "include_security_measures_physical_security_val": {
- "type": "string"
- },
- "include_security_measures_portability_and_erasure": {
- "type": "boolean"
- },
- "include_security_measures_portability_and_erasure_val": {
- "type": "string"
- },
- "include_security_measures_pseudonym_encryption": {
- "type": "boolean"
- },
- "include_security_measures_pseudonym_encryption_val": {
- "type": "string"
- },
- "include_security_measures_restore_data_access": {
- "type": "boolean"
- },
- "include_security_measures_restore_data_access_val": {
- "type": "string"
- },
- "include_security_measures_security_policy": {
- "type": "boolean"
- },
- "include_security_measures_system_configuration": {
- "type": "boolean"
- },
- "include_security_measures_system_configuration_val": {
- "type": "string"
- },
- "include_security_measures_testing_assessment": {
- "type": "boolean"
- },
- "include_security_measures_testing_assessment_val": {
- "type": "string"
- },
- "include_security_policy": {
- "type": "boolean"
- },
- "include_security_policy_fedramp_auth": {
- "type": "boolean"
- },
- "include_security_policy_hipaa": {
- "type": "boolean"
- },
- "include_security_policy_hitrust": {
- "type": "boolean"
- },
- "include_security_policy_include_other": {
- "type": "boolean"
- },
- "include_security_policy_iso27001": {
- "type": "boolean"
- },
- "include_security_policy_other": {
- "type": "string"
- },
- "include_security_policy_pci1": {
- "type": "boolean"
- },
- "include_security_policy_pci2": {
- "type": "boolean"
- },
- "include_security_policy_penetration_testing": {
- "type": "boolean"
- },
- "include_security_policy_soc2": {
- "type": "boolean"
- },
- "include_security_policy_soc2_type2": {
- "type": "boolean"
- },
- "include_sensitive_data_restrictions_custom": {
- "type": "boolean"
- },
- "include_sensitive_data_restrictions_custom_val": {
- "type": "string"
- },
- "include_sensitive_data_restrictions_security_policy": {
- "type": "boolean"
- },
- "include_service_provider_relationship": {
- "type": "boolean"
- },
- "include_special_category_data": {
- "type": "boolean"
- },
- "provider": {
- "type": "string"
- },
- "security_policy_available_at": {
- "type": "string"
- },
- "security_policy_type": {
- "description": "Where the Security Policy is defined. For `external`, set `security_policy_available_at`.",
- "enum": [
- "defined in agreement",
- "provider service",
- "external"
- ],
- "type": "string"
- },
- "subprocessors_attributes": {
- "additionalProperties": {
- "additionalProperties": false,
- "properties": {
- "_destroy": {
- "description": "Set to true with `id` to remove that subprocessor.",
- "type": "boolean"
- },
- "country": {
- "type": "string"
- },
- "id": {
- "description": "ID of an existing subprocessor to update or remove. Omit to add a new subprocessor.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "name": {
- "type": "string"
- },
- "processing_task": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "description": "Subprocessors, keyed by string index such as \"0\", \"1\". On create these are added to the template's subprocessors. On a draft update, an entry without `id` adds a new subprocessor; pass `id` to change one and `id` with `_destroy: true` to remove one.",
- "propertyNames": {
- "type": "string"
- },
- "type": "object"
- },
- "underlying_agreement_id": {
- "description": "ID of the CSA this DPA supplements when `underlying_agreement_type` is `internal`.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "underlying_agreement_type": {
- "description": "`internal` links a CSA in Common Paper (`underlying_agreement_id`); `external` describes another agreement in `underlying_agreement_val` (required). Omit for none.",
- "enum": [
- "internal",
- "external"
- ],
- "type": "string"
- },
- "underlying_agreement_val": {
- "description": "Description of the agreement this DPA supplements. Required when `underlying_agreement_type` is `external`.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "framework_terms_description": {
- "description": "Custom framework terms description. Only used when framework_terms_type is \"description\".",
- "type": "string"
- },
- "framework_terms_type": {
- "description": "How framework terms are specified. Use \"new\" for standard terms or \"description\" to provide a custom framework_terms_description.",
- "enum": [
- "new",
- "description"
- ],
- "type": "string"
- },
- "governing_law_country": {
- "description": "The country whose laws govern the agreement.",
- "type": "string"
- },
- "governing_law_region": {
- "description": "The state or region whose laws govern the agreement.",
- "type": "string"
- },
- "include_automated_payment_reminders": {
- "description": "When true, automatically sends payment reminder emails.",
- "type": "boolean"
- },
- "include_billing_info": {
- "description": "When true, billing contact information (billing_name, billing_email) is included.",
- "type": "boolean"
- },
- "include_billing_workflow": {
- "description": "When true, enables a billing workflow after signing.",
- "type": "boolean"
- },
- "include_expiration_date": {
- "description": "Expiration date in YYYY-MM-DD format. Use when include_expiration_type is \"date\".",
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "include_expiration_days": {
- "description": "Number of days until the agreement expires. Use when include_expiration_type is \"days\".",
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_expiration_type": {
- "description": "How to set expiration: \"none\" (default), \"days\" (use include_expiration_days), or \"date\" (use include_expiration_date).",
- "enum": [
- "none",
- "days",
- "date"
- ],
- "type": "string"
- },
- "include_terms": {
- "description": "When true, the standard terms are included with the agreement.",
- "type": "boolean"
- },
- "loi_attributes": {
- "additionalProperties": false,
- "description": "Override loi terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "confidentiality_custom": {
- "type": "string"
- },
- "confidentiality_mutual_include_loi": {
- "type": "boolean"
- },
- "confidentiality_nda_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "confidentiality_nda_description": {
- "type": "string"
- },
- "confidentiality_nda_include_loi": {
- "type": "boolean"
- },
- "confidentiality_nda_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "confidentiality_type": {
- "enum": [
- "mutual",
- "nda",
- "provider",
- "custom"
- ],
- "type": "string"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_custom_details": {
- "type": "boolean"
- },
- "include_custom_details_val": {
- "type": "string"
- },
- "include_fees": {
- "type": "boolean"
- },
- "include_fees_amount": {
- "type": "number"
- },
- "include_fees_amount_duration": {
- "enum": [
- "month",
- "year",
- "quarter"
- ],
- "type": "string"
- },
- "include_fees_include_amount": {
- "type": "boolean"
- },
- "include_fees_include_other": {
- "type": "boolean"
- },
- "include_fees_other": {
- "type": "string"
- },
- "include_functionality": {
- "type": "boolean"
- },
- "include_functionality_val": {
- "type": "string"
- },
- "include_launch_date": {
- "type": "boolean"
- },
- "include_launch_date_custom": {
- "type": "string"
- },
- "include_launch_date_date": {
- "format": "date-time",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$",
- "type": "string"
- },
- "include_launch_date_type": {
- "enum": [
- "date",
- "custom"
- ],
- "type": "string"
- },
- "product_name": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "manual_send": {
- "description": "When true, the agreement is marked as manually sent outside the platform.",
- "type": "boolean"
- },
- "message": {
- "type": "string"
- },
- "negotiations_allowed": {
- "description": "When true, the recipient can propose changes to the legal terms. For agreement types without separate business terms, that covers every term. CSA order forms, PSA statements of work, partnership business terms and software license order forms have their own `negotiations_allowed` flag.",
- "type": "boolean"
- },
- "partnership_attributes": {
- "additionalProperties": false,
- "description": "Override partnership terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "effective_date": {
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "effective_date_type": {
- "enum": [
- "signature",
- "date"
- ],
- "type": "string"
- },
- "general_cap_amount_currency_val": {
- "type": "number"
- },
- "general_cap_amount_either_currency": {
- "type": "number"
- },
- "general_cap_amount_either_multiple": {
- "type": "number"
- },
- "general_cap_amount_multiple_val": {
- "type": "number"
- },
- "general_cap_amount_type": {
- "enum": [
- "multiple",
- "currency",
- "either",
- "base"
- ],
- "type": "string"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_additional_warranties": {
- "type": "boolean"
- },
- "include_additional_warranties_include_company": {
- "type": "boolean"
- },
- "include_additional_warranties_include_company_val": {
- "type": "string"
- },
- "include_additional_warranties_include_partner": {
- "type": "boolean"
- },
- "include_additional_warranties_include_partner_val": {
- "type": "string"
- },
- "include_brand_guidelines": {
- "type": "boolean"
- },
- "include_brand_guidelines_include_company": {
- "type": "boolean"
- },
- "include_brand_guidelines_include_company_val": {
- "type": "string"
- },
- "include_brand_guidelines_include_partner": {
- "type": "boolean"
- },
- "include_brand_guidelines_include_partner_val": {
- "type": "string"
- },
- "include_covered_claims": {
- "type": "boolean"
- },
- "include_covered_claims_company_claims": {
- "type": "string"
- },
- "include_covered_claims_include_company_claims": {
- "type": "boolean"
- },
- "include_covered_claims_include_partner_claims": {
- "type": "boolean"
- },
- "include_covered_claims_partner_claims": {
- "type": "string"
- },
- "include_dpa": {
- "type": "boolean"
- },
- "include_dpa_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_dpa_location": {
- "type": "string"
- },
- "include_dpa_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_increased_cap_amount": {
- "type": "boolean"
- },
- "include_increased_cap_amount_currency": {
- "type": "number"
- },
- "include_increased_cap_amount_either_currency": {
- "type": "number"
- },
- "include_increased_cap_amount_either_multiple": {
- "type": "string"
- },
- "include_increased_cap_amount_multiple": {
- "type": "string"
- },
- "include_increased_cap_amount_type": {
- "enum": [
- "multiple",
- "currency",
- "either"
- ],
- "type": "string"
- },
- "include_increased_claims": {
- "type": "boolean"
- },
- "include_increased_claims_include_confidentiality": {
- "type": "boolean"
- },
- "include_increased_claims_include_confidentiality_misconduct": {
- "type": "boolean"
- },
- "include_increased_claims_include_covered_claims": {
- "type": "boolean"
- },
- "include_increased_claims_include_misconduct": {
- "type": "boolean"
- },
- "include_increased_claims_include_other": {
- "type": "boolean"
- },
- "include_increased_claims_include_other_val": {
- "type": "string"
- },
- "include_unlimited_claims": {
- "type": "boolean"
- },
- "include_unlimited_claims_confidentiality": {
- "type": "boolean"
- },
- "include_unlimited_claims_confidentiality_misconduct": {
- "type": "boolean"
- },
- "include_unlimited_claims_covered_claims": {
- "type": "boolean"
- },
- "include_unlimited_claims_misconduct": {
- "type": "boolean"
- },
- "include_unlimited_claims_other": {
- "type": "boolean"
- },
- "include_unlimited_claims_other_val": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "partnership_business_terms_attributes": {
- "additionalProperties": false,
- "description": "Override partnership business terms terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "end_date_after_effective_date_amount": {
- "type": "number"
- },
- "end_date_after_effective_date_unit": {
- "enum": [
- "month(s)",
- "quarter(s)",
- "year(s)"
- ],
- "type": "string"
- },
- "end_date_date": {
- "type": "string"
- },
- "end_date_type": {
- "enum": [
- "date",
- "effective date"
- ],
- "type": "string"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_obligations_company_brand": {
- "type": "boolean"
- },
- "include_obligations_company_promotion": {
- "type": "boolean"
- },
- "include_obligations_company_promotion_include_activities": {
- "type": "boolean"
- },
- "include_obligations_company_promotion_include_activities_val": {
- "type": "string"
- },
- "include_obligations_company_promotion_include_materials": {
- "type": "boolean"
- },
- "include_obligations_company_promotion_include_materials_val": {
- "type": "string"
- },
- "include_obligations_company_referral": {
- "type": "boolean"
- },
- "include_obligations_company_referral_include_criteria": {
- "type": "boolean"
- },
- "include_obligations_company_referral_include_criteria_val": {
- "type": "string"
- },
- "include_obligations_company_referral_include_pay_sch": {
- "type": "boolean"
- },
- "include_obligations_company_referral_include_pay_sch_amount": {
- "type": "number"
- },
- "include_obligations_company_referral_include_pay_sch_custom": {
- "type": "string"
- },
- "include_obligations_company_referral_include_pay_sch_unit": {
- "enum": [
- "U.S. Dollars",
- "percent"
- ],
- "type": "string"
- },
- "include_obligations_company_sponsorship": {
- "type": "boolean"
- },
- "include_obligations_company_sponsorship_include_benefits": {
- "type": "boolean"
- },
- "include_obligations_company_sponsorship_include_benefits_val": {
- "type": "string"
- },
- "include_obligations_company_sponsorship_include_payments": {
- "type": "boolean"
- },
- "include_obligations_company_sponsorship_include_payments_amount": {
- "type": "number"
- },
- "include_obligations_company_sponsorship_include_payments_unit": {
- "enum": [
- "U.S. Dollars",
- "percent"
- ],
- "type": "string"
- },
- "include_obligations_partner_brand": {
- "type": "boolean"
- },
- "include_obligations_partner_promotion": {
- "type": "boolean"
- },
- "include_obligations_partner_promotion_include_activities": {
- "type": "boolean"
- },
- "include_obligations_partner_promotion_include_activities_val": {
- "type": "string"
- },
- "include_obligations_partner_promotion_include_materials": {
- "type": "boolean"
- },
- "include_obligations_partner_promotion_include_materials_val": {
- "type": "string"
- },
- "include_obligations_partner_referral": {
- "type": "boolean"
- },
- "include_obligations_partner_referral_include_criteria": {
- "type": "boolean"
- },
- "include_obligations_partner_referral_include_criteria_val": {
- "type": "string"
- },
- "include_obligations_partner_referral_include_pay_sch": {
- "type": "boolean"
- },
- "include_obligations_partner_referral_include_pay_sch_amount": {
- "type": "number"
- },
- "include_obligations_partner_referral_include_pay_sch_custom": {
- "type": "string"
- },
- "include_obligations_partner_referral_include_pay_sch_unit": {
- "enum": [
- "U.S. Dollars",
- "percent"
- ],
- "type": "string"
- },
- "include_obligations_partner_sponsorship": {
- "type": "boolean"
- },
- "include_obligations_partner_sponsorship_include_benefits": {
- "type": "boolean"
- },
- "include_obligations_partner_sponsorship_include_benefits_val": {
- "type": "string"
- },
- "include_obligations_partner_sponsorship_include_payments": {
- "type": "boolean"
- },
- "include_obligations_partner_sponsorship_include_payments_amount": {
- "type": "number"
- },
- "include_obligations_partner_sponsorship_include_payments_unit": {
- "enum": [
- "U.S. Dollars",
- "percent"
- ],
- "type": "string"
- },
- "include_payment_process": {
- "type": "boolean"
- },
- "include_payment_process_company": {
- "type": "boolean"
- },
- "include_payment_process_company_include_address": {
- "type": "boolean"
- },
- "include_payment_process_company_include_address_city": {
- "type": "string"
- },
- "include_payment_process_company_include_address_country": {
- "type": "string"
- },
- "include_payment_process_company_include_address_state": {
- "type": "string"
- },
- "include_payment_process_company_include_address_street_address": {
- "type": "string"
- },
- "include_payment_process_company_include_address_zipcode": {
- "type": "string"
- },
- "include_payment_process_company_include_email": {
- "type": "boolean"
- },
- "include_payment_process_company_include_email_val": {
- "type": "string"
- },
- "include_payment_process_partner": {
- "type": "boolean"
- },
- "include_payment_process_partner_include_address": {
- "type": "boolean"
- },
- "include_payment_process_partner_include_address_city": {
- "type": "string"
- },
- "include_payment_process_partner_include_address_country": {
- "type": "string"
- },
- "include_payment_process_partner_include_address_state": {
- "type": "string"
- },
- "include_payment_process_partner_include_address_street_address": {
- "type": "string"
- },
- "include_payment_process_partner_include_address_zipcode": {
- "type": "string"
- },
- "include_payment_process_partner_include_email": {
- "type": "boolean"
- },
- "include_payment_process_partner_include_email_val": {
- "type": "string"
- },
- "include_payment_schedule": {
- "type": "boolean"
- },
- "include_payment_schedule_custom": {
- "type": "string"
- },
- "include_payment_schedule_specified_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_payment_schedule_specified_timeframe": {
- "enum": [
- "receipt",
- "date"
- ],
- "type": "string"
- },
- "include_payment_schedule_specified_unit": {
- "enum": [
- "day(s)",
- "week(s)",
- "month(s)",
- "quarter(s)",
- "year(s)"
- ],
- "type": "string"
- },
- "include_payment_schedule_type": {
- "enum": [
- "specified",
- "custom"
- ],
- "type": "string"
- },
- "negotiations_allowed": {
- "description": "When true, the recipient can propose changes to the business terms, even when the agreement-level `negotiations_allowed` is false. This only covers the business terms.",
- "type": "boolean"
- },
- "territory_type": {
- "enum": [
- "worldwide",
- "custom"
- ],
- "type": "string"
- },
- "territory_type_val": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "payment_link_url": {
- "description": "A payment URL shown to the recipient after signing. Requires include_billing_workflow to be true and billing_workflow_type to be \"link\".",
- "type": "string"
- },
- "pilot_attributes": {
- "additionalProperties": false,
- "description": "Override pilot terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "fees_type": {
- "enum": [
- "free",
- "pilot_period_fees"
- ],
- "type": "string"
- },
- "general_cap_amount": {
- "type": "number"
- },
- "general_cap_amount_type": {
- "enum": [
- "preceding",
- "base",
- "period"
- ],
- "type": "string"
- },
- "general_cap_period_currency": {
- "type": "number"
- },
- "general_cap_period_qty": {
- "type": "number"
- },
- "general_cap_preceding_amount": {
- "type": "number"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_dpa": {
- "type": "boolean"
- },
- "include_dpa_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_dpa_location": {
- "type": "string"
- },
- "include_dpa_type": {
- "enum": [
- "description",
- "attachment",
- "standard"
- ],
- "type": "string"
- },
- "include_payment_process": {
- "type": "boolean"
- },
- "include_technical_support": {
- "type": "boolean"
- },
- "payment_process_automatic_frequency": {
- "enum": [
- "monthly",
- "quarterly",
- "annually",
- "once_per_period"
- ],
- "type": "string"
- },
- "payment_process_invoice_days": {
- "type": "number"
- },
- "payment_process_invoice_from": {
- "enum": [
- "receipt",
- "date"
- ],
- "type": "string"
- },
- "payment_process_invoice_timeframe": {
- "enum": [
- "days",
- "weeks",
- "months",
- "quarters",
- "years"
- ],
- "type": "string"
- },
- "payment_process_type": {
- "enum": [
- "automatic",
- "invoice"
- ],
- "type": "string"
- },
- "pilot_period_description": {
- "type": "string"
- },
- "pilot_period_fees_description": {
- "type": "string"
- },
- "product_description": {
- "type": "string"
- },
- "technical_support_description": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "psa_attributes": {
- "additionalProperties": false,
- "description": "Override psa terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "additional_changes": {
- "type": "string"
- },
- "customer_description": {
- "type": "string"
- },
- "effective_date": {
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "effective_date_type": {
- "enum": [
- "signature",
- "date"
- ],
- "type": "string"
- },
- "general_cap_amount": {
- "type": "number"
- },
- "general_cap_amount_type": {
- "enum": [
- "preceding",
- "base",
- "period"
- ],
- "type": "string"
- },
- "general_cap_period_currency": {
- "type": "number"
- },
- "general_cap_period_qty": {
- "type": "number"
- },
- "general_cap_preceding_amount": {
- "type": "number"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_additional_changes": {
- "type": "boolean"
- },
- "include_additional_warranties": {
- "type": "boolean"
- },
- "include_additional_warranties_by_customer": {
- "type": "string"
- },
- "include_additional_warranties_by_provider": {
- "type": "string"
- },
- "include_additional_warranties_include_by_customer": {
- "type": "boolean"
- },
- "include_additional_warranties_include_by_provider": {
- "type": "boolean"
- },
- "include_covered_claims": {
- "type": "boolean"
- },
- "include_covered_claims_customer_claims": {
- "type": "string"
- },
- "include_covered_claims_include_customer_claims": {
- "type": "boolean"
- },
- "include_covered_claims_include_provider_claims": {
- "type": "boolean"
- },
- "include_covered_claims_provider_claims": {
- "type": "string"
- },
- "include_customer_insurance_min": {
- "type": "boolean"
- },
- "include_customer_insurance_min_add_provider_com_gen_liability": {
- "type": "boolean"
- },
- "include_customer_insurance_min_add_provider_cyber_liability": {
- "type": "boolean"
- },
- "include_customer_insurance_min_add_provider_errors_omissions": {
- "type": "boolean"
- },
- "include_customer_insurance_min_auto_liability_aggregate": {
- "type": "number"
- },
- "include_customer_insurance_min_auto_liability_minimum": {
- "type": "number"
- },
- "include_customer_insurance_min_cyber_liability_aggregate": {
- "type": "number"
- },
- "include_customer_insurance_min_cyber_liability_minimum": {
- "type": "number"
- },
- "include_customer_insurance_min_employer_liability_aggregate": {
- "type": "number"
- },
- "include_customer_insurance_min_employer_liability_minimum": {
- "type": "number"
- },
- "include_customer_insurance_min_general_liability_aggregate": {
- "type": "number"
- },
- "include_customer_insurance_min_general_liability_minimum": {
- "type": "number"
- },
- "include_customer_insurance_min_include_add_provider": {
- "type": "boolean"
- },
- "include_customer_insurance_min_include_auto_liability": {
- "type": "boolean"
- },
- "include_customer_insurance_min_include_cyber_liability": {
- "type": "boolean"
- },
- "include_customer_insurance_min_include_employer_liability": {
- "type": "boolean"
- },
- "include_customer_insurance_min_include_general_liability": {
- "type": "boolean"
- },
- "include_customer_insurance_min_include_workers_comp": {
- "type": "boolean"
- },
- "include_customer_policies": {
- "type": "boolean"
- },
- "include_customer_policies_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_customer_policies_location": {
- "type": "string"
- },
- "include_customer_policies_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_dpa": {
- "type": "boolean"
- },
- "include_dpa_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_dpa_location": {
- "type": "string"
- },
- "include_dpa_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_increased_cap_amount": {
- "type": "boolean"
- },
- "include_increased_claims": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_confidentiality": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_confidentiality_negligence": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_privsec": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_privsec_negligence": {
- "type": "boolean"
- },
- "include_increased_claims_include_other": {
- "type": "boolean"
- },
- "include_increased_claims_indemnification_obligation": {
- "type": "boolean"
- },
- "include_increased_claims_negligence": {
- "type": "boolean"
- },
- "include_increased_claims_other": {
- "type": "string"
- },
- "include_provider_insurance_min": {
- "type": "boolean"
- },
- "include_provider_insurance_min_add_customer_com_gen_liability": {
- "type": "boolean"
- },
- "include_provider_insurance_min_add_customer_cyber_liability": {
- "type": "boolean"
- },
- "include_provider_insurance_min_add_customer_errors_omissions": {
- "type": "boolean"
- },
- "include_provider_insurance_min_auto_liability_aggregate": {
- "type": "number"
- },
- "include_provider_insurance_min_auto_liability_minimum": {
- "type": "number"
- },
- "include_provider_insurance_min_cyber_liability_aggregate": {
- "type": "number"
- },
- "include_provider_insurance_min_cyber_liability_minimum": {
- "type": "number"
- },
- "include_provider_insurance_min_employer_liability_aggregate": {
- "type": "number"
- },
- "include_provider_insurance_min_employer_liability_minimum": {
- "type": "number"
- },
- "include_provider_insurance_min_general_liability_aggregate": {
- "type": "number"
- },
- "include_provider_insurance_min_general_liability_minimum": {
- "type": "number"
- },
- "include_provider_insurance_min_include_add_customer": {
- "type": "boolean"
- },
- "include_provider_insurance_min_include_auto_liability": {
- "type": "boolean"
- },
- "include_provider_insurance_min_include_cyber_liability": {
- "type": "boolean"
- },
- "include_provider_insurance_min_include_employer_liability": {
- "type": "boolean"
- },
- "include_provider_insurance_min_include_general_liability": {
- "type": "boolean"
- },
- "include_provider_insurance_min_include_workers_comp": {
- "type": "boolean"
- },
- "include_publicity_rights": {
- "type": "boolean"
- },
- "include_publicity_rights_type": {
- "enum": [
- "public",
- "non-public"
- ],
- "type": "string"
- },
- "include_security_policy": {
- "type": "boolean"
- },
- "include_security_policy_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_security_policy_fedramp_auth": {
- "type": "boolean"
- },
- "include_security_policy_hitrust": {
- "type": "boolean"
- },
- "include_security_policy_include_annual_maintenance": {
- "type": "boolean"
- },
- "include_security_policy_include_other": {
- "type": "boolean"
- },
- "include_security_policy_include_other_val": {
- "type": "string"
- },
- "include_security_policy_iso27001": {
- "type": "boolean"
- },
- "include_security_policy_location": {
- "type": "string"
- },
- "include_security_policy_pci1": {
- "type": "boolean"
- },
- "include_security_policy_pci2": {
- "type": "boolean"
- },
- "include_security_policy_penetration_testing": {
- "type": "boolean"
- },
- "include_security_policy_soc2_type1": {
- "type": "boolean"
- },
- "include_security_policy_soc2_type2": {
- "type": "boolean"
- },
- "include_security_policy_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_unlimited_claims": {
- "type": "boolean"
- },
- "include_unlimited_claims_breach_of_confidentiality": {
- "type": "boolean"
- },
- "include_unlimited_claims_breach_of_confidentiality_negligence": {
- "type": "boolean"
- },
- "include_unlimited_claims_breach_of_privsec": {
- "type": "boolean"
- },
- "include_unlimited_claims_breach_of_privsec_negligence": {
- "type": "boolean"
- },
- "include_unlimited_claims_include_other": {
- "type": "boolean"
- },
- "include_unlimited_claims_indemnification_obligation": {
- "type": "boolean"
- },
- "include_unlimited_claims_negligence": {
- "type": "boolean"
- },
- "include_unlimited_claims_other": {
- "type": "string"
- },
- "increased_cap_amount_currency": {
- "type": "number"
- },
- "increased_cap_amount_period_currency": {
- "type": "number"
- },
- "increased_cap_amount_period_qty": {
- "type": "number"
- },
- "increased_cap_amount_qty": {
- "type": "number"
- },
- "increased_cap_amount_type": {
- "enum": [
- "qty",
- "currency",
- "period"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- "psa_statement_of_work_attributes": {
- "additionalProperties": false,
- "description": "Override psa statement of work terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "additional_changes": {
- "type": "string"
- },
- "cost": {
- "type": "number"
- },
- "description": {
- "type": "string"
- },
- "fee_type": {
- "type": "string"
- },
- "fees_attributes": {
- "additionalProperties": {
- "anyOf": [
- {
- "additionalProperties": false,
- "description": "Fees::Flat (fee_type \"flat\"). A fixed recurring fee, e.g. a platform subscription. Set type to \"Fees::Flat\" or fee_type to \"flat\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "Fixed amount in the order form's fees_currency, charged per fee_period. A plain amount, not cents: 20 means 20.00.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"flat\". Alternative to type.",
- "enum": [
- "flat"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Flat\". Optional when fee_type is set.",
- "enum": [
- "Fees::Flat"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Discount (fee_type \"discount\"). A discount, as a fixed amount or a percentage, applied forever, once, or for a number of months. Set type to \"Fees::Discount\" or fee_type to \"discount\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "Discount size: an amount in fees_currency when discount_type is fixed_amount (a plain amount, not cents: 20 means 20.00), or a percentage (e.g. 10 for 10%) when it is percentage.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "discount_duration_amount": {
- "description": "Number of months the discount applies. Required when discount_duration_type is multiple_months.",
- "type": "number"
- },
- "discount_duration_type": {
- "description": "How long the discount applies. multiple_months also needs discount_duration_amount.",
- "enum": [
- "forever",
- "once",
- "multiple_months"
- ],
- "type": "string"
- },
- "discount_type": {
- "description": "Whether cost is a currency amount or a percentage.",
- "enum": [
- "fixed_amount",
- "percentage"
- ],
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"discount\". Alternative to type.",
- "enum": [
- "discount"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Discount\". Optional when fee_type is set.",
- "enum": [
- "Fees::Discount"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Cost (fee_type \"cost\"). A per-unit fee: price per unit times quantity, e.g. seats. Set type to \"Fees::Cost\" or fee_type to \"cost\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "Price per unit in fees_currency. The row total is quantity x cost. A plain amount, not cents: 20 means 20.00.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"cost\". Alternative to type.",
- "enum": [
- "cost"
- ],
- "type": "string"
- },
- "quantity": {
- "description": "Number of units.",
- "type": "number"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Cost\". Optional when fee_type is set.",
- "enum": [
- "Fees::Cost"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Attachment (fee_type \"attachment\"). A fee described in an uploaded attachment instead of in the table. Set type to \"Fees::Attachment\" or fee_type to \"attachment\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "attachment_id": {
- "description": "ID of an attachment uploaded with upload-attachment.",
- "type": "string"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"attachment\". Alternative to type.",
- "enum": [
- "attachment"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Attachment\". Optional when fee_type is set.",
- "enum": [
- "Fees::Attachment"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Graduated (fee_type \"graduated\"). Tiered pricing, with the price set per tier in graduated_fee_tiers_attributes. Set type to \"Fees::Graduated\" or fee_type to \"graduated\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"graduated\". Alternative to type.",
- "enum": [
- "graduated"
- ],
- "type": "string"
- },
- "graduated_fee_tiers_attributes": {
- "additionalProperties": {
- "additionalProperties": false,
- "properties": {
- "flat_price": {
- "type": "number"
- },
- "price_per_unit": {
- "type": "string"
- },
- "upper_limit": {
- "type": "number"
- }
- },
- "type": "object"
- },
- "description": "Graduated fee tiers. Use string keys such as \"0\", \"1\".",
- "propertyNames": {
- "type": "string"
- },
- "type": "object"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Graduated\". Optional when fee_type is set.",
- "enum": [
- "Fees::Graduated"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Included (fee_type \"included\"). An item included at no charge. Set type to \"Fees::Included\" or fee_type to \"included\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"included\". Alternative to type.",
- "enum": [
- "included"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Included\". Optional when fee_type is set.",
- "enum": [
- "Fees::Included"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Metered (fee_type \"metered\"). Usage-based pricing, billed per unit used. Set type to \"Fees::Metered\" or fee_type to \"metered\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "Price per unit of usage in fees_currency. A plain amount, not cents: 20 means 20.00.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"metered\". Alternative to type.",
- "enum": [
- "metered"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Metered\". Optional when fee_type is set.",
- "enum": [
- "Fees::Metered"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::OneTime (fee_type \"one_time\"). A one-time charge, such as a setup fee. Set type to \"Fees::OneTime\" or fee_type to \"one_time\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "One-time amount in fees_currency, charged once rather than per fee_period. A plain amount, not cents: 20 means 20.00.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"one_time\". Alternative to type.",
- "enum": [
- "one_time"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::OneTime\". Optional when fee_type is set.",
- "enum": [
- "Fees::OneTime"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Text (fee_type \"text\"). A fee term described in free text. Set type to \"Fees::Text\" or fee_type to \"text\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"text\". Alternative to type.",
- "enum": [
- "text"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Text\". Optional when fee_type is set.",
- "enum": [
- "Fees::Text"
- ],
- "type": "string"
- }
- },
- "type": "object"
- }
- ]
- },
- "description": "Fee line items. Use string keys such as \"0\", \"1\". Replaces template fees when provided.",
- "propertyNames": {
- "type": "string"
- },
- "type": "object"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_additional_changes": {
- "type": "boolean"
- },
- "include_customer_obligation": {
- "type": "boolean"
- },
- "include_customer_obligation_val": {
- "type": "string"
- },
- "include_deliverables": {
- "type": "boolean"
- },
- "include_deliverables_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_deliverables_description": {
- "type": "string"
- },
- "include_deliverables_include_acceptance": {
- "type": "boolean"
- },
- "include_deliverables_include_attachment": {
- "type": "boolean"
- },
- "include_deliverables_include_draft_deliverables": {
- "type": "boolean"
- },
- "include_deliverables_rejection_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_deliverables_rejection_unit": {
- "enum": [
- "hours",
- "days",
- "weeks",
- "months"
- ],
- "type": "string"
- },
- "include_deliverables_resubmission_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_deliverables_resubmission_unit": {
- "enum": [
- "hours",
- "days",
- "weeks",
- "months"
- ],
- "type": "string"
- },
- "include_fees_other": {
- "type": "boolean"
- },
- "include_fees_other_val": {
- "type": "string"
- },
- "include_fees_table": {
- "type": "boolean"
- },
- "include_fees_table_total": {
- "type": "boolean"
- },
- "include_fees_travel": {
- "type": "boolean"
- },
- "include_fees_travel_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_fees_travel_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_fees_travel_val": {
- "type": "string"
- },
- "include_third_party_customer": {
- "type": "boolean"
- },
- "include_third_party_include_description": {
- "type": "boolean"
- },
- "include_third_party_include_description_val": {
- "type": "string"
- },
- "include_third_party_materials": {
- "type": "boolean"
- },
- "include_third_party_provider": {
- "type": "boolean"
- },
- "include_time_of_assignment": {
- "type": "boolean"
- },
- "include_time_of_assignment_type": {
- "enum": [
- "created",
- "paid"
- ],
- "type": "string"
- },
- "invoice_period_description": {
- "type": "string"
- },
- "negotiations_allowed": {
- "description": "When true, the recipient can propose changes to the statement of work, even when the agreement-level `negotiations_allowed` is false. This only covers the statement of work.",
- "type": "boolean"
- },
- "payment_period": {
- "type": "number"
- },
- "payment_period_other": {
- "type": "string"
- },
- "payment_period_timeframe": {
- "enum": [
- "receipt",
- "invoice",
- "Customer's receipt of invoice",
- "date of invoice"
- ],
- "type": "string"
- },
- "payment_period_type": {
- "enum": [
- "standard",
- "other"
- ],
- "type": "string"
- },
- "payment_period_unit": {
- "enum": [
- "day(s)",
- "week(s)",
- "month(s)",
- "quarter(s)",
- "year(s)"
- ],
- "type": "string"
- },
- "quantity": {
- "type": "number"
- },
- "services_description": {
- "type": "string"
- },
- "sow_date": {
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "sow_date_type": {
- "enum": [
- "signature",
- "date"
- ],
- "type": "string"
- },
- "sow_term_amount": {
- "type": "number"
- },
- "sow_term_date": {
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "sow_term_type": {
- "enum": [
- "deliverables",
- "period",
- "date"
- ],
- "type": "string"
- },
- "sow_term_unit": {
- "enum": [
- "month(s)",
- "quarter(s)",
- "year(s)"
- ],
- "type": "string"
- },
- "type": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "recipient_email": {
- "format": "email",
- "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-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_last_to_sign": {
- "description": "When true, your signer signs after the recipient.",
- "type": "boolean"
- },
- "sender_notice_email_address": {
- "description": "Email address for legal notices to the sender.",
- "format": "email",
- "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-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": {
- "enum": [
- "signature",
- "date"
- ],
- "type": "string"
- },
- "general_cap_amount": {
- "type": "number"
- },
- "general_cap_amount_type": {
- "enum": [
- "preceding",
- "base",
- "period"
- ],
- "type": "string"
- },
- "general_cap_period_currency": {
- "type": "number"
- },
- "general_cap_period_qty": {
- "type": "number"
- },
- "general_cap_preceding_amount": {
- "type": "number"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_additional_warranties": {
- "type": "boolean"
- },
- "include_additional_warranties_by_customer": {
- "type": "string"
- },
- "include_additional_warranties_by_provider": {
- "type": "string"
- },
- "include_additional_warranties_include_by_customer": {
- "type": "boolean"
- },
- "include_additional_warranties_include_by_provider": {
- "type": "boolean"
- },
- "include_ai_addendum": {
- "type": "boolean"
- },
- "include_ai_addendum_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_covered_claims": {
- "type": "boolean"
- },
- "include_covered_claims_customer_claims": {
- "type": "string"
- },
- "include_covered_claims_include_customer_claims": {
- "type": "boolean"
- },
- "include_covered_claims_include_provider_claims": {
- "type": "boolean"
- },
- "include_covered_claims_provider_claims": {
- "type": "string"
- },
- "include_dpa": {
- "type": "boolean"
- },
- "include_dpa_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_dpa_location": {
- "type": "string"
- },
- "include_dpa_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_increased_cap_amount": {
- "type": "boolean"
- },
- "include_increased_claims": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_confidentiality": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_confidentiality_negligence": {
- "type": "boolean"
- },
- "include_increased_claims_include_other": {
- "type": "boolean"
- },
- "include_increased_claims_indemnification_obligation": {
- "type": "boolean"
- },
- "include_increased_claims_negligence": {
- "type": "boolean"
- },
- "include_increased_claims_other": {
- "type": "string"
- },
- "include_increased_claims_restrictions": {
- "type": "boolean"
- },
- "include_unlimited_claims": {
- "type": "boolean"
- },
- "include_unlimited_claims_breach_of_confidentiality": {
- "type": "boolean"
- },
- "include_unlimited_claims_breach_of_confidentiality_negligence": {
- "type": "boolean"
- },
- "include_unlimited_claims_include_other": {
- "type": "boolean"
- },
- "include_unlimited_claims_indemnification_obligation": {
- "type": "boolean"
- },
- "include_unlimited_claims_license_or_restrictions": {
- "type": "boolean"
- },
- "include_unlimited_claims_negligence": {
- "type": "boolean"
- },
- "include_unlimited_claims_other": {
- "type": "string"
- },
- "increased_cap_amount_currency": {
- "type": "number"
- },
- "increased_cap_amount_period_currency": {
- "type": "number"
- },
- "increased_cap_amount_period_qty": {
- "type": "number"
- },
- "increased_cap_amount_qty": {
- "type": "number"
- },
- "increased_cap_amount_type": {
- "enum": [
- "qty",
- "currency",
- "period"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- "software_license_order_form_attributes": {
- "additionalProperties": false,
- "description": "Override software license order form terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "additional_changes": {
- "type": "string"
- },
- "deletion_procedure_include_custom": {
- "type": "boolean"
- },
- "deletion_procedure_include_custom_description": {
- "type": "string"
- },
- "deletion_procedure_include_customer_disable": {
- "type": "boolean"
- },
- "deletion_procedure_include_customer_proof": {
- "type": "boolean"
- },
- "deletion_procedure_include_provider_disable": {
- "type": "boolean"
- },
- "fee_custom_unit": {
- "type": "string"
- },
- "fee_period": {
- "enum": [
- "Subscription Period",
- "month",
- "year",
- "Custom unit"
- ],
- "type": "string"
- },
- "fees_attributes": {
- "additionalProperties": {
- "anyOf": [
- {
- "additionalProperties": false,
- "description": "Fees::Flat (fee_type \"flat\"). A fixed recurring fee, e.g. a platform subscription. Set type to \"Fees::Flat\" or fee_type to \"flat\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "Fixed amount in the order form's fees_currency, charged per fee_period. A plain amount, not cents: 20 means 20.00.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"flat\". Alternative to type.",
- "enum": [
- "flat"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Flat\". Optional when fee_type is set.",
- "enum": [
- "Fees::Flat"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Discount (fee_type \"discount\"). A discount, as a fixed amount or a percentage, applied forever, once, or for a number of months. Set type to \"Fees::Discount\" or fee_type to \"discount\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "Discount size: an amount in fees_currency when discount_type is fixed_amount (a plain amount, not cents: 20 means 20.00), or a percentage (e.g. 10 for 10%) when it is percentage.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "discount_duration_amount": {
- "description": "Number of months the discount applies. Required when discount_duration_type is multiple_months.",
- "type": "number"
- },
- "discount_duration_type": {
- "description": "How long the discount applies. multiple_months also needs discount_duration_amount.",
- "enum": [
- "forever",
- "once",
- "multiple_months"
- ],
- "type": "string"
- },
- "discount_type": {
- "description": "Whether cost is a currency amount or a percentage.",
- "enum": [
- "fixed_amount",
- "percentage"
- ],
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"discount\". Alternative to type.",
- "enum": [
- "discount"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Discount\". Optional when fee_type is set.",
- "enum": [
- "Fees::Discount"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Cost (fee_type \"cost\"). A per-unit fee: price per unit times quantity, e.g. seats. Set type to \"Fees::Cost\" or fee_type to \"cost\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "Price per unit in fees_currency. The row total is quantity x cost. A plain amount, not cents: 20 means 20.00.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"cost\". Alternative to type.",
- "enum": [
- "cost"
- ],
- "type": "string"
- },
- "quantity": {
- "description": "Number of units.",
- "type": "number"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Cost\". Optional when fee_type is set.",
- "enum": [
- "Fees::Cost"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Attachment (fee_type \"attachment\"). A fee described in an uploaded attachment instead of in the table. Set type to \"Fees::Attachment\" or fee_type to \"attachment\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "attachment_id": {
- "description": "ID of an attachment uploaded with upload-attachment.",
- "type": "string"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"attachment\". Alternative to type.",
- "enum": [
- "attachment"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Attachment\". Optional when fee_type is set.",
- "enum": [
- "Fees::Attachment"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Graduated (fee_type \"graduated\"). Tiered pricing, with the price set per tier in graduated_fee_tiers_attributes. Set type to \"Fees::Graduated\" or fee_type to \"graduated\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"graduated\". Alternative to type.",
- "enum": [
- "graduated"
- ],
- "type": "string"
- },
- "graduated_fee_tiers_attributes": {
- "additionalProperties": {
- "additionalProperties": false,
- "properties": {
- "flat_price": {
- "type": "number"
- },
- "price_per_unit": {
- "type": "string"
- },
- "upper_limit": {
- "type": "number"
- }
- },
- "type": "object"
- },
- "description": "Graduated fee tiers. Use string keys such as \"0\", \"1\".",
- "propertyNames": {
- "type": "string"
- },
- "type": "object"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Graduated\". Optional when fee_type is set.",
- "enum": [
- "Fees::Graduated"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Included (fee_type \"included\"). An item included at no charge. Set type to \"Fees::Included\" or fee_type to \"included\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"included\". Alternative to type.",
- "enum": [
- "included"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Included\". Optional when fee_type is set.",
- "enum": [
- "Fees::Included"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Metered (fee_type \"metered\"). Usage-based pricing, billed per unit used. Set type to \"Fees::Metered\" or fee_type to \"metered\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "Price per unit of usage in fees_currency. A plain amount, not cents: 20 means 20.00.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"metered\". Alternative to type.",
- "enum": [
- "metered"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Metered\". Optional when fee_type is set.",
- "enum": [
- "Fees::Metered"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::OneTime (fee_type \"one_time\"). A one-time charge, such as a setup fee. Set type to \"Fees::OneTime\" or fee_type to \"one_time\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "One-time amount in fees_currency, charged once rather than per fee_period. A plain amount, not cents: 20 means 20.00.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"one_time\". Alternative to type.",
- "enum": [
- "one_time"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::OneTime\". Optional when fee_type is set.",
- "enum": [
- "Fees::OneTime"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Text (fee_type \"text\"). A fee term described in free text. Set type to \"Fees::Text\" or fee_type to \"text\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"text\". Alternative to type.",
- "enum": [
- "text"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Text\". Optional when fee_type is set.",
- "enum": [
- "Fees::Text"
- ],
- "type": "string"
- }
- },
- "type": "object"
- }
- ]
- },
- "description": "Fee line items. Use string keys such as \"0\", \"1\". Replaces template fees when provided.",
- "propertyNames": {
- "type": "string"
- },
- "type": "object"
- },
- "fees_currency": {
- "enum": [
- "USD",
- "EUR",
- "GBP",
- "CAD",
- "AUD",
- "SGD",
- "ILS",
- "JPY",
- "CHF",
- "HKD"
- ],
- "type": "string"
- },
- "fees_include_fee_increase_upon_renewal": {
- "type": "boolean"
- },
- "fees_include_fee_increase_upon_renewal_fee": {
- "type": "number"
- },
- "fees_include_fee_increase_upon_renewal_type": {
- "enum": [
- "will",
- "may"
- ],
- "type": "string"
- },
- "fees_inclusive_of_taxes": {
- "type": "boolean"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_additional_changes": {
- "type": "boolean"
- },
- "include_license_compliance_verification": {
- "type": "boolean"
- },
- "include_license_compliance_verification_description": {
- "type": "string"
- },
- "include_license_limits": {
- "type": "boolean"
- },
- "include_license_limits_description": {
- "type": "string"
- },
- "include_payment_process_include_billing_email": {
- "type": "boolean"
- },
- "include_pilot_period": {
- "type": "boolean"
- },
- "include_pilot_period_duration_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_pilot_period_duration_type": {
- "enum": [
- "day",
- "week",
- "month"
- ],
- "type": "string"
- },
- "include_pilot_period_include_fees": {
- "type": "boolean"
- },
- "include_pilot_period_include_fees_amount": {
- "type": "number"
- },
- "include_pilot_period_include_modifications": {
- "type": "boolean"
- },
- "include_pilot_period_include_modifications_description": {
- "type": "string"
- },
- "include_services": {
- "type": "boolean"
- },
- "include_services_description": {
- "type": "string"
- },
- "negotiations_allowed": {
- "description": "When true, the recipient can propose changes to the order form, even when the agreement-level `negotiations_allowed` is false. This only covers the order form.",
- "type": "boolean"
- },
- "order_date_date": {
- "type": "string"
- },
- "order_date_type": {
- "enum": [
- "signature",
- "date",
- "other"
- ],
- "type": "string"
- },
- "payment_process_automatic_frequency": {
- "enum": [
- "monthly",
- "quarterly",
- "semiannually",
- "annually"
- ],
- "type": "string"
- },
- "payment_process_type": {
- "enum": [
- "automatic",
- "invoice",
- "custom"
- ],
- "type": "string"
- },
- "payment_process_type_custom_val": {
- "type": "string"
- },
- "payment_process_type_invoice_amount": {
- "type": "number"
- },
- "payment_process_type_invoice_custom_unit": {
- "type": "string"
- },
- "payment_process_type_invoice_duration": {
- "enum": [
- "day",
- "week",
- "month",
- "year",
- "day(s)",
- "week(s)",
- "month(s)",
- "year(s)"
- ],
- "type": "string"
- },
- "payment_process_type_invoice_duration_start": {
- "enum": [
- "Customer's receipt of invoice",
- "date of invoice"
- ],
- "type": "string"
- },
- "payment_process_type_invoice_type": {
- "enum": [
- "monthly",
- "quarterly",
- "semiannually",
- "annually",
- "Custom unit"
- ],
- "type": "string"
- },
- "permitted_uses_include_custom": {
- "type": "boolean"
- },
- "permitted_uses_include_custom_description": {
- "type": "string"
- },
- "permitted_uses_include_customers_affiliates": {
- "type": "boolean"
- },
- "permitted_uses_include_internal_business": {
- "type": "boolean"
- },
- "pilot_period_stripe_product_id": {
- "type": "string"
- },
- "software_description": {
- "type": "string"
- },
- "subscription_auto_renew": {
- "enum": [
- "days",
- "subscription_end"
- ],
- "type": "string"
- },
- "subscription_period": {
- "type": "number"
- },
- "subscription_period_unit": {
- "type": "string"
- },
- "subscription_renewal_notice_days": {
- "type": "number"
- },
- "warranty_period_description_amount": {
- "type": "number"
- },
- "warranty_period_description_duration": {
- "enum": [
- "day",
- "week",
- "month",
- "year"
- ],
- "type": "string"
- },
- "warranty_period_description_duration_start": {
- "enum": [
- "initial delivery of the Software",
- "delivery of the Software and each subsequent Update",
- "the Order Date"
- ],
- "type": "string"
- },
- "warranty_period_type": {
- "enum": [
- "description",
- "none"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- "test_agreement": {
- "description": "When true, marks the agreement as a test. Test agreements do not count against your monthly limit.",
- "type": "boolean"
- }
- },
- "required": [
- "recipient_name",
- "recipient_email"
- ],
- "type": "object"
- },
- "cc_users": {
- "items": {
- "format": "email",
- "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-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": {
- "enum": [
- "signature",
- "date"
- ],
- "type": "string"
- },
- "framework_terms_type": {
- "type": "string"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "parent_agreement_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "underlying_agreement_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "underlying_agreement_type": {
- "type": "string"
- },
- "underlying_agreement_val": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "baa_attributes": {
- "additionalProperties": false,
- "description": "Override baa terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "aggregation_limitations_permitted": {
- "type": "boolean"
- },
- "aggregation_limitations_permitted_val": {
- "type": "string"
- },
- "breach_notification_unit": {
- "enum": [
- "hours",
- "business days",
- "calendar days"
- ],
- "type": "string"
- },
- "breach_notification_val": {
- "type": "number"
- },
- "business_associate_relationship_type": {
- "enum": [
- "provider",
- "company"
- ],
- "type": "string"
- },
- "deidentification_limitations_include_purpose": {
- "type": "boolean"
- },
- "deidentification_limitations_include_requirements": {
- "type": "boolean"
- },
- "deidentification_limitations_permitted": {
- "type": "boolean"
- },
- "deidentification_limitations_purpose_val": {
- "type": "string"
- },
- "deidentification_limitations_requirements_val": {
- "type": "string"
- },
- "designated_record_set_provider_maintains": {
- "type": "boolean"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_aggregation_limitations": {
- "type": "boolean"
- },
- "include_deidentification_limitations": {
- "type": "boolean"
- },
- "include_limitations": {
- "type": "boolean"
- },
- "include_offshore_limitations": {
- "type": "boolean"
- },
- "include_subcontract_limitations": {
- "type": "boolean"
- },
- "offshore_limitations_permitted": {
- "type": "boolean"
- },
- "offshore_limitations_permitted_val": {
- "type": "string"
- },
- "subcontract_limitations_include_notice": {
- "type": "boolean"
- },
- "subcontract_limitations_include_permission": {
- "type": "boolean"
- },
- "subcontract_limitations_notice_val": {
- "type": "string"
- },
- "subcontract_limitations_permission_val": {
- "type": "string"
- },
- "subcontract_limitations_permitted": {
- "type": "boolean"
- },
- "underlying_agreement_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "underlying_agreement_type": {
- "enum": [
- "internal",
- "external",
- "none"
- ],
- "type": "string"
- },
- "underlying_agreement_val": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "billing_email": {
- "description": "Email of the billing contact. Used when include_billing_info is true.",
- "format": "email",
- "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
- "type": "string"
- },
- "billing_name": {
- "description": "Name of the billing contact. Used when include_billing_info is true.",
- "type": "string"
- },
- "billing_workflow_type": {
- "description": "The type of billing workflow. Use \"link\" to provide a payment_link_url, or \"stripe\" for Stripe-managed billing.",
- "enum": [
- "link",
- "stripe"
- ],
- "type": "string"
- },
- "chosen_courts_country": {
- "description": "The country in which disputes will be resolved.",
- "type": "string"
- },
- "chosen_courts_region": {
- "description": "The state or region in which disputes will be resolved.",
- "type": "string"
- },
- "csa_attributes": {
- "additionalProperties": false,
- "description": "Override csa terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "customer_description": {
- "type": "string"
- },
- "effective_date": {
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "effective_date_marketplace": {
- "enum": [
- "AWS",
- "GCP",
- "Azure"
- ],
- "type": "string"
- },
- "effective_date_type": {
- "enum": [
- "signature",
- "date",
- "marketplace_acceptance"
- ],
- "type": "string"
- },
- "general_cap_amount": {
- "type": "number"
- },
- "general_cap_amount_type": {
- "enum": [
- "preceding",
- "base",
- "period"
- ],
- "type": "string"
- },
- "general_cap_period_currency": {
- "type": "number"
- },
- "general_cap_period_qty": {
- "type": "number"
- },
- "general_cap_preceding_amount": {
- "type": "number"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_acceptable_use_policy": {
- "type": "boolean"
- },
- "include_acceptable_use_policy_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_acceptable_use_policy_location": {
- "type": "string"
- },
- "include_acceptable_use_policy_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_additional_warranties": {
- "type": "boolean"
- },
- "include_additional_warranties_by_customer": {
- "type": "string"
- },
- "include_additional_warranties_by_provider": {
- "type": "string"
- },
- "include_additional_warranties_include_by_customer": {
- "type": "boolean"
- },
- "include_additional_warranties_include_by_provider": {
- "type": "boolean"
- },
- "include_ai_addendum": {
- "type": "boolean"
- },
- "include_ai_addendum_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_covered_claims": {
- "type": "boolean"
- },
- "include_covered_claims_customer_claims": {
- "type": "string"
- },
- "include_covered_claims_include_customer_claims": {
- "type": "boolean"
- },
- "include_covered_claims_include_provider_claims": {
- "type": "boolean"
- },
- "include_covered_claims_provider_claims": {
- "type": "string"
- },
- "include_dpa": {
- "type": "boolean"
- },
- "include_dpa_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_dpa_location": {
- "type": "string"
- },
- "include_dpa_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_increased_cap_amount": {
- "type": "boolean"
- },
- "include_increased_claims": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_confidentiality": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_confidentiality_negligence": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_privsec": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_privsec_negligence": {
- "type": "boolean"
- },
- "include_increased_claims_include_other": {
- "type": "boolean"
- },
- "include_increased_claims_indemnification_obligation": {
- "type": "boolean"
- },
- "include_increased_claims_other": {
- "type": "string"
- },
- "include_insurance_minimums": {
- "type": "boolean"
- },
- "include_insurance_minimums_add_customer": {
- "type": "boolean"
- },
- "include_insurance_minimums_add_customer_com_gen_liability": {
- "type": "boolean"
- },
- "include_insurance_minimums_add_customer_cyber_liability": {
- "type": "boolean"
- },
- "include_insurance_minimums_add_customer_errors_omissions": {
- "type": "boolean"
- },
- "include_insurance_minimums_additional_information": {
- "type": "boolean"
- },
- "include_insurance_minimums_additional_information_text": {
- "type": "string"
- },
- "include_insurance_minimums_cyber_liability_aggregate": {
- "type": "number"
- },
- "include_insurance_minimums_cyber_liability_minimum": {
- "type": "number"
- },
- "include_insurance_minimums_employer_liability_aggregate": {
- "type": "number"
- },
- "include_insurance_minimums_employer_liability_minimum": {
- "type": "number"
- },
- "include_insurance_minimums_general_liability_aggregate": {
- "type": "number"
- },
- "include_insurance_minimums_general_liability_minimum": {
- "type": "number"
- },
- "include_insurance_minimums_include_cyber_liability": {
- "type": "boolean"
- },
- "include_insurance_minimums_include_employer_liability": {
- "type": "boolean"
- },
- "include_insurance_minimums_include_general_liability": {
- "type": "boolean"
- },
- "include_insurance_minimums_include_workers_compensation": {
- "type": "boolean"
- },
- "include_publicity_rights": {
- "type": "boolean"
- },
- "include_publicity_rights_type": {
- "enum": [
- "public",
- "non-public"
- ],
- "type": "string"
- },
- "include_security_policy": {
- "type": "boolean"
- },
- "include_security_policy_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_security_policy_fedramp_auth": {
- "type": "boolean"
- },
- "include_security_policy_hipaa": {
- "type": "boolean"
- },
- "include_security_policy_hitrust": {
- "type": "boolean"
- },
- "include_security_policy_include_annual_maintenance": {
- "type": "boolean"
- },
- "include_security_policy_include_location": {
- "type": "boolean"
- },
- "include_security_policy_include_other": {
- "type": "boolean"
- },
- "include_security_policy_include_reasonable_efforts": {
- "type": "boolean"
- },
- "include_security_policy_iso27001": {
- "type": "boolean"
- },
- "include_security_policy_location": {
- "type": "string"
- },
- "include_security_policy_other": {
- "type": "string"
- },
- "include_security_policy_pci1": {
- "type": "boolean"
- },
- "include_security_policy_pci2": {
- "type": "boolean"
- },
- "include_security_policy_penetration_testing": {
- "type": "boolean"
- },
- "include_security_policy_soc2": {
- "type": "boolean"
- },
- "include_security_policy_soc2_type2": {
- "type": "boolean"
- },
- "include_security_policy_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_supercap": {
- "description": "CSA 3.0 renamed `include_increased_cap_amount` to `include_supercap`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_increased_cap_amount`. Sending the other spelling returns a 422.",
- "type": "boolean"
- },
- "include_uncapped_claims": {
- "description": "CSA 3.0 renamed `include_unlimited_claims` to `include_uncapped_claims`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims`. Sending the other spelling returns a 422.",
- "type": "boolean"
- },
- "include_uncapped_claims_breach_of_confidentiality": {
- "description": "CSA 3.0 renamed `include_unlimited_claims_breach_of_confidentiality` to `include_uncapped_claims_breach_of_confidentiality`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_breach_of_confidentiality`. Sending the other spelling returns a 422.",
- "type": "boolean"
- },
- "include_uncapped_claims_breach_of_confidentiality_negligence": {
- "description": "CSA 3.0 renamed `include_unlimited_claims_breach_of_confidentiality_negligence` to `include_uncapped_claims_breach_of_confidentiality_negligence`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_breach_of_confidentiality_negligence`. Sending the other spelling returns a 422.",
- "type": "boolean"
- },
- "include_uncapped_claims_breach_of_privsec": {
- "description": "CSA 3.0 renamed `include_unlimited_claims_breach_of_privsec` to `include_uncapped_claims_breach_of_privsec`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_breach_of_privsec`. Sending the other spelling returns a 422.",
- "type": "boolean"
- },
- "include_uncapped_claims_breach_of_privsec_negligence": {
- "description": "CSA 3.0 renamed `include_unlimited_claims_breach_of_privsec_negligence` to `include_uncapped_claims_breach_of_privsec_negligence`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_breach_of_privsec_negligence`. Sending the other spelling returns a 422.",
- "type": "boolean"
- },
- "include_uncapped_claims_include_other": {
- "description": "CSA 3.0 renamed `include_unlimited_claims_include_other` to `include_uncapped_claims_include_other`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_include_other`. Sending the other spelling returns a 422.",
- "type": "boolean"
- },
- "include_uncapped_claims_indemnification_obligation": {
- "description": "CSA 3.0 renamed `include_unlimited_claims_indemnification_obligation` to `include_uncapped_claims_indemnification_obligation`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_indemnification_obligation`. Sending the other spelling returns a 422.",
- "type": "boolean"
- },
- "include_uncapped_claims_other": {
- "description": "CSA 3.0 renamed `include_unlimited_claims_other` to `include_uncapped_claims_other`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_other`. Sending the other spelling returns a 422.",
- "type": "boolean"
- },
- "include_unlimited_claims": {
- "type": "boolean"
- },
- "include_unlimited_claims_breach_of_confidentiality": {
- "type": "boolean"
- },
- "include_unlimited_claims_breach_of_confidentiality_negligence": {
- "type": "boolean"
- },
- "include_unlimited_claims_breach_of_privsec": {
- "type": "boolean"
- },
- "include_unlimited_claims_breach_of_privsec_negligence": {
- "type": "boolean"
- },
- "include_unlimited_claims_include_other": {
- "type": "boolean"
- },
- "include_unlimited_claims_indemnification_obligation": {
- "type": "boolean"
- },
- "include_unlimited_claims_other": {
- "type": "string"
- },
- "increased_cap_amount_currency": {
- "type": "number"
- },
- "increased_cap_amount_period_currency": {
- "type": "number"
- },
- "increased_cap_amount_period_qty": {
- "type": "number"
- },
- "increased_cap_amount_qty": {
- "type": "number"
- },
- "increased_cap_amount_type": {
- "enum": [
- "qty",
- "currency",
- "period"
- ],
- "type": "string"
- },
- "provider": {
- "type": "string"
- },
- "supercap_currency": {
- "description": "CSA 3.0 renamed `increased_cap_amount_currency` to `supercap_currency`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `increased_cap_amount_currency`. Sending the other spelling returns a 422.",
- "type": "number"
- },
- "supercap_period_currency": {
- "description": "CSA 3.0 renamed `increased_cap_amount_period_currency` to `supercap_period_currency`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `increased_cap_amount_period_currency`. Sending the other spelling returns a 422.",
- "type": "number"
- },
- "supercap_period_qty": {
- "description": "CSA 3.0 renamed `increased_cap_amount_period_qty` to `supercap_period_qty`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `increased_cap_amount_period_qty`. Sending the other spelling returns a 422.",
- "type": "number"
- },
- "supercap_qty": {
- "description": "CSA 3.0 renamed `increased_cap_amount_qty` to `supercap_qty`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `increased_cap_amount_qty`. Sending the other spelling returns a 422.",
- "type": "number"
- },
- "supercap_type": {
- "description": "CSA 3.0 renamed `increased_cap_amount_type` to `supercap_type`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `increased_cap_amount_type`. Sending the other spelling returns a 422.",
- "type": "number"
- }
- },
- "type": "object"
- },
- "csa_order_form_attributes": {
- "additionalProperties": false,
- "description": "Override csa order form terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "additional_changes": {
- "type": "string"
- },
- "additional_parameters_or_limitations": {
- "type": "string"
- },
- "affiliates_as_users": {
- "type": "boolean"
- },
- "cloud_service_description": {
- "type": "string"
- },
- "consumption_units": {
- "type": "string"
- },
- "fee_amount": {
- "type": "number"
- },
- "fee_custom_unit": {
- "type": "string"
- },
- "fee_period": {
- "enum": [
- "Subscription Period",
- "month",
- "year",
- "User",
- "Custom unit"
- ],
- "type": "string"
- },
- "fees_attributes": {
- "additionalProperties": {
- "anyOf": [
- {
- "additionalProperties": false,
- "description": "Fees::Flat (fee_type \"flat\"). A fixed recurring fee, e.g. a platform subscription. Set type to \"Fees::Flat\" or fee_type to \"flat\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "Fixed amount in the order form's fees_currency, charged per fee_period. A plain amount, not cents: 20 means 20.00.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"flat\". Alternative to type.",
- "enum": [
- "flat"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Flat\". Optional when fee_type is set.",
- "enum": [
- "Fees::Flat"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Discount (fee_type \"discount\"). A discount, as a fixed amount or a percentage, applied forever, once, or for a number of months. Set type to \"Fees::Discount\" or fee_type to \"discount\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "Discount size: an amount in fees_currency when discount_type is fixed_amount (a plain amount, not cents: 20 means 20.00), or a percentage (e.g. 10 for 10%) when it is percentage.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "discount_duration_amount": {
- "description": "Number of months the discount applies. Required when discount_duration_type is multiple_months.",
- "type": "number"
- },
- "discount_duration_type": {
- "description": "How long the discount applies. multiple_months also needs discount_duration_amount.",
- "enum": [
- "forever",
- "once",
- "multiple_months"
- ],
- "type": "string"
- },
- "discount_type": {
- "description": "Whether cost is a currency amount or a percentage.",
- "enum": [
- "fixed_amount",
- "percentage"
- ],
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"discount\". Alternative to type.",
- "enum": [
- "discount"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Discount\". Optional when fee_type is set.",
- "enum": [
- "Fees::Discount"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Cost (fee_type \"cost\"). A per-unit fee: price per unit times quantity, e.g. seats. Set type to \"Fees::Cost\" or fee_type to \"cost\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "Price per unit in fees_currency. The row total is quantity x cost. A plain amount, not cents: 20 means 20.00.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"cost\". Alternative to type.",
- "enum": [
- "cost"
- ],
- "type": "string"
- },
- "quantity": {
- "description": "Number of units.",
- "type": "number"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Cost\". Optional when fee_type is set.",
- "enum": [
- "Fees::Cost"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Attachment (fee_type \"attachment\"). A fee described in an uploaded attachment instead of in the table. Set type to \"Fees::Attachment\" or fee_type to \"attachment\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "attachment_id": {
- "description": "ID of an attachment uploaded with upload-attachment.",
- "type": "string"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"attachment\". Alternative to type.",
- "enum": [
- "attachment"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Attachment\". Optional when fee_type is set.",
- "enum": [
- "Fees::Attachment"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Graduated (fee_type \"graduated\"). Tiered pricing, with the price set per tier in graduated_fee_tiers_attributes. Set type to \"Fees::Graduated\" or fee_type to \"graduated\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"graduated\". Alternative to type.",
- "enum": [
- "graduated"
- ],
- "type": "string"
- },
- "graduated_fee_tiers_attributes": {
- "additionalProperties": {
- "additionalProperties": false,
- "properties": {
- "flat_price": {
- "type": "number"
- },
- "price_per_unit": {
- "type": "string"
- },
- "upper_limit": {
- "type": "number"
- }
- },
- "type": "object"
- },
- "description": "Graduated fee tiers. Use string keys such as \"0\", \"1\".",
- "propertyNames": {
- "type": "string"
- },
- "type": "object"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Graduated\". Optional when fee_type is set.",
- "enum": [
- "Fees::Graduated"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Included (fee_type \"included\"). An item included at no charge. Set type to \"Fees::Included\" or fee_type to \"included\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"included\". Alternative to type.",
- "enum": [
- "included"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Included\". Optional when fee_type is set.",
- "enum": [
- "Fees::Included"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Metered (fee_type \"metered\"). Usage-based pricing, billed per unit used. Set type to \"Fees::Metered\" or fee_type to \"metered\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "Price per unit of usage in fees_currency. A plain amount, not cents: 20 means 20.00.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"metered\". Alternative to type.",
- "enum": [
- "metered"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Metered\". Optional when fee_type is set.",
- "enum": [
- "Fees::Metered"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::OneTime (fee_type \"one_time\"). A one-time charge, such as a setup fee. Set type to \"Fees::OneTime\" or fee_type to \"one_time\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "One-time amount in fees_currency, charged once rather than per fee_period. A plain amount, not cents: 20 means 20.00.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"one_time\". Alternative to type.",
- "enum": [
- "one_time"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::OneTime\". Optional when fee_type is set.",
- "enum": [
- "Fees::OneTime"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Text (fee_type \"text\"). A fee term described in free text. Set type to \"Fees::Text\" or fee_type to \"text\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"text\". Alternative to type.",
- "enum": [
- "text"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Text\". Optional when fee_type is set.",
- "enum": [
- "Fees::Text"
- ],
- "type": "string"
- }
- },
- "type": "object"
- }
- ]
- },
- "description": "Fee table rows, keyed by string index (\"0\", \"1\", ...). Replaces the template's fees when provided. Each row sets type or fee_type to pick the fee class. Amounts are in the order form's fees_currency and, for recurring fees, are charged per fee_period.",
- "examples": [
- {
- "0": {
- "cost": 2000,
- "description": "Platform subscription",
- "type": "Fees::Flat"
- }
- },
- {
- "0": {
- "cost": 50,
- "description": "Seats",
- "fee_type": "cost",
- "quantity": 10
- },
- "1": {
- "cost": 10,
- "description": "Launch discount",
- "discount_duration_amount": 3,
- "discount_duration_type": "multiple_months",
- "discount_type": "percentage",
- "fee_type": "discount"
- }
- }
- ],
- "propertyNames": {
- "type": "string"
- },
- "type": "object"
- },
- "fees_currency": {
- "enum": [
- "USD",
- "EUR",
- "GBP",
- "CAD",
- "AUD",
- "SGD",
- "ILS",
- "JPY",
- "CHF",
- "HKD"
- ],
- "type": "string"
- },
- "fees_include_fee_increase_upon_renewal": {
- "type": "boolean"
- },
- "fees_include_fee_increase_upon_renewal_fee": {
- "type": "number"
- },
- "fees_include_fee_increase_upon_renewal_type": {
- "enum": [
- "will",
- "may"
- ],
- "type": "string"
- },
- "fees_inclusive_of_taxes": {
- "type": "boolean"
- },
- "framework_terms_type": {
- "enum": [
- "new",
- "existing",
- "description"
- ],
- "type": "string"
- },
- "free_trial_days": {
- "type": "number"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_additional_changes": {
- "type": "boolean"
- },
- "include_additional_parameters_or_limitations": {
- "type": "boolean"
- },
- "include_consumption": {
- "type": "boolean"
- },
- "include_fees": {
- "type": "boolean"
- },
- "include_fees_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_fees_include_attachment": {
- "type": "boolean"
- },
- "include_fees_other": {
- "type": "boolean"
- },
- "include_fees_other_val": {
- "type": "string"
- },
- "include_fees_table": {
- "type": "boolean"
- },
- "include_fees_table_period": {
- "enum": [
- "Subscription Period",
- "month",
- "year",
- "User"
- ],
- "type": "string"
- },
- "include_free_trial": {
- "type": "boolean"
- },
- "include_max_users": {
- "type": "boolean"
- },
- "include_pilot_period": {
- "type": "boolean"
- },
- "include_pilot_period_duration_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_pilot_period_duration_type": {
- "enum": [
- "day",
- "week",
- "month"
- ],
- "type": "string"
- },
- "include_pilot_period_include_fees": {
- "type": "boolean"
- },
- "include_pilot_period_include_fees_amount": {
- "type": "number"
- },
- "include_pilot_period_include_modifications": {
- "type": "boolean"
- },
- "include_pilot_period_include_modifications_description": {
- "type": "string"
- },
- "include_product_support": {
- "type": "boolean"
- },
- "include_product_support_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_product_support_description": {
- "type": "string"
- },
- "include_product_support_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_professional_services": {
- "type": "boolean"
- },
- "include_professional_services_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_professional_services_custom_name": {
- "type": "string"
- },
- "include_professional_services_description": {
- "type": "string"
- },
- "include_professional_services_end_date": {
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "include_professional_services_fees_description": {
- "type": "string"
- },
- "include_professional_services_include_end_date": {
- "type": "boolean"
- },
- "include_professional_services_include_fees_description": {
- "type": "boolean"
- },
- "include_professional_services_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_sla": {
- "type": "boolean"
- },
- "include_sla_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_sla_description": {
- "type": "string"
- },
- "include_sla_include_response_time": {
- "type": "boolean"
- },
- "include_sla_include_response_time_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_sla_include_response_time_credit": {
- "type": "number"
- },
- "include_sla_include_response_time_duration": {
- "enum": [
- "hour",
- "day",
- "week",
- "month",
- "hours"
- ],
- "type": "string"
- },
- "include_sla_include_response_time_support_channel": {
- "type": "string"
- },
- "include_sla_include_target_uptime": {
- "type": "boolean"
- },
- "include_sla_maintenance_notice": {
- "type": "boolean"
- },
- "include_sla_maintenance_window": {
- "type": "boolean"
- },
- "include_sla_maintenance_window_type": {
- "enum": [
- "standard",
- "none"
- ],
- "type": "string"
- },
- "include_sla_standard_maintenance_notice_qty": {
- "type": "number"
- },
- "include_sla_standard_maintenance_notice_unit": {
- "enum": [
- "hour",
- "day",
- "week",
- "month"
- ],
- "type": "string"
- },
- "include_sla_standard_maintenance_window_end_time": {
- "type": "string"
- },
- "include_sla_standard_maintenance_window_friday": {
- "type": "boolean"
- },
- "include_sla_standard_maintenance_window_monday": {
- "type": "boolean"
- },
- "include_sla_standard_maintenance_window_saturday": {
- "type": "boolean"
- },
- "include_sla_standard_maintenance_window_start_time": {
- "type": "string"
- },
- "include_sla_standard_maintenance_window_sunday": {
- "type": "boolean"
- },
- "include_sla_standard_maintenance_window_thursday": {
- "type": "boolean"
- },
- "include_sla_standard_maintenance_window_time_zone": {
- "type": "string"
- },
- "include_sla_standard_maintenance_window_tuesday": {
- "type": "boolean"
- },
- "include_sla_standard_maintenance_window_wednesday": {
- "type": "boolean"
- },
- "include_sla_standard_target_uptime": {
- "type": "number"
- },
- "include_sla_type": {
- "enum": [
- "description",
- "standard",
- "attachment"
- ],
- "type": "string"
- },
- "include_subscription_start_date": {
- "type": "boolean"
- },
- "include_subscription_start_date_date": {
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "include_usage_review": {
- "type": "boolean"
- },
- "include_usage_review_val": {
- "type": "string"
- },
- "include_use_limitations": {
- "type": "boolean"
- },
- "include_use_limitations_val": {
- "type": "string"
- },
- "invoice_period": {
- "enum": [
- "monthly",
- "quarterly",
- "semiannually",
- "annually",
- "Custom unit",
- "Monthly",
- "Quarterly",
- "Semiannually",
- "Annually"
- ],
- "type": "string"
- },
- "invoice_period_custom_unit": {
- "type": "string"
- },
- "max_consumption": {
- "type": "number"
- },
- "max_users": {
- "type": "number"
- },
- "negotiations_allowed": {
- "description": "When true, the recipient can propose changes to the order form, even when the agreement-level `negotiations_allowed` is false. This only covers the order form.",
- "type": "boolean"
- },
- "order_date_date": {
- "type": "string"
- },
- "order_date_other": {
- "type": "string"
- },
- "order_date_type": {
- "enum": [
- "signature",
- "date",
- "other"
- ],
- "type": "string"
- },
- "payment_period": {
- "type": "number"
- },
- "payment_period_timeframe": {
- "enum": [
- "Customer's receipt of invoice",
- "date of invoice"
- ],
- "type": "string"
- },
- "payment_period_unit": {
- "enum": [
- "day(s)",
- "week(s)",
- "month(s)",
- "marketplace_acceptance"
- ],
- "type": "string"
- },
- "payment_process_automatic_frequency": {
- "enum": [
- "monthly",
- "quarterly",
- "semiannually",
- "annually"
- ],
- "type": "string"
- },
- "payment_process_type": {
- "enum": [
- "automatic",
- "invoice",
- "custom",
- "marketplace_acceptance"
- ],
- "type": "string"
- },
- "payment_process_type_custom_val": {
- "type": "string"
- },
- "payment_process_type_invoice_amount": {
- "type": "number"
- },
- "payment_process_type_invoice_custom_unit": {
- "type": "string"
- },
- "payment_process_type_invoice_duration": {
- "enum": [
- "day",
- "week",
- "month",
- "year",
- "day(s)",
- "week(s)",
- "month(s)",
- "year(s)"
- ],
- "type": "string"
- },
- "payment_process_type_invoice_duration_start": {
- "enum": [
- "Customer's receipt of invoice",
- "date of invoice"
- ],
- "type": "string"
- },
- "payment_process_type_invoice_type": {
- "enum": [
- "monthly",
- "quarterly",
- "semiannually",
- "annually",
- "Custom unit"
- ],
- "type": "string"
- },
- "pilot_period_stripe_product_id": {
- "type": "string"
- },
- "service_credits_attributes": {
- "additionalProperties": {
- "additionalProperties": false,
- "properties": {
- "credit": {
- "type": "number"
- },
- "max": {
- "type": "number"
- },
- "min": {
- "type": "number"
- }
- },
- "type": "object"
- },
- "description": "Service credits. Use string keys such as \"0\", \"1\".",
- "propertyNames": {
- "type": "string"
- },
- "type": "object"
- },
- "subscription_auto_renew": {
- "enum": [
- "days",
- "subscription_end"
- ],
- "type": "string"
- },
- "subscription_period": {
- "type": "number"
- },
- "subscription_period_unit": {
- "type": "string"
- },
- "subscription_renewal_notice_days": {
- "type": "number"
- },
- "subscription_start_date": {
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "subscription_start_date_type": {
- "enum": [
- "effective_date",
- "date"
- ],
- "type": "string"
- },
- "underlying_agreement_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "use_limitations_attributes": {
- "additionalProperties": {
- "additionalProperties": false,
- "properties": {
- "amount": {
- "type": "number"
- },
- "limitation_type": {
- "type": "string"
- },
- "unit": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "description": "Use limitations. Use string keys such as \"0\", \"1\".",
- "propertyNames": {
- "type": "string"
- },
- "type": "object"
- }
- },
- "type": "object"
- },
- "custom_field_values": {
- "description": "Values for a custom template's fields, keyed by the field keys defined in the template's YAML definition. Only used when template_id is a custom template. Template defaults fill any fields you omit; a required field with no default and no submitted value returns a 400 naming the field. Values are validated against the field's input type: select and radio values must be one of the field's options, multiselect values are an array of selections each of which must be one of the field's options, number and currency values must be numeric, date values must be YYYY-MM-DD, and email values must be valid addresses. An invalid value returns a 400 naming the field."
- },
- "design_partner_attributes": {
- "additionalProperties": false,
- "description": "Override design partner terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "customer_description": {
- "type": "string"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_fees": {
- "type": "boolean"
- },
- "include_fees_amount": {
- "type": "number"
- },
- "include_fees_description": {
- "type": "string"
- },
- "include_fees_pay_by_amount": {
- "type": "string"
- },
- "include_fees_type": {
- "enum": [
- "default_language",
- "description"
- ],
- "type": "string"
- },
- "include_fees_unit": {
- "enum": [
- "month",
- "quarter",
- "year",
- "Term"
- ],
- "type": "string"
- },
- "include_program_appear_as_customer_private": {
- "type": "boolean"
- },
- "include_program_appear_as_customer_public": {
- "type": "boolean"
- },
- "include_program_case_study": {
- "type": "boolean"
- },
- "include_program_develop_functionality": {
- "type": "boolean"
- },
- "include_program_develop_functionality_val": {
- "type": "string"
- },
- "include_program_discount": {
- "type": "boolean"
- },
- "include_program_discount_amount": {
- "type": "number"
- },
- "include_program_discount_unit": {
- "enum": [
- "U.S. Dollars",
- "percent"
- ],
- "type": "string"
- },
- "include_program_participation_feedback": {
- "type": "boolean"
- },
- "include_program_participation_feedback_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_program_participation_feedback_unit": {
- "enum": [
- "month",
- "quarter",
- "year",
- "Term"
- ],
- "type": "string"
- },
- "include_program_partner_other": {
- "type": "boolean"
- },
- "include_program_partner_other_val": {
- "type": "string"
- },
- "include_program_provider_other": {
- "type": "boolean"
- },
- "include_program_provider_other_val": {
- "type": "string"
- },
- "include_program_reference": {
- "type": "boolean"
- },
- "product_description": {
- "type": "string"
- },
- "term_amount": {
- "type": "number"
- },
- "term_unit": {
- "enum": [
- "day(s)",
- "week(s)",
- "month(s)",
- "quarter(s)",
- "year(s)"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- "district_or_county": {
- "description": "The district or county for dispute resolution.",
- "type": "string"
- },
- "dpa_attributes": {
- "additionalProperties": false,
- "description": "Override dpa terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "approved_subprocessor_type": {
- "description": "`internal` lists approved subprocessors in the agreement (`subprocessors_attributes`); `external` points to a list published elsewhere.",
- "enum": [
- "internal",
- "external"
- ],
- "type": "string"
- },
- "cloud_service_product_name": {
- "type": "string"
- },
- "competent_supervisory_authority": {
- "type": "string"
- },
- "customer_description": {
- "type": "string"
- },
- "data_exporter_address_city": {
- "type": "string"
- },
- "data_exporter_address_country": {
- "type": "string"
- },
- "data_exporter_address_state": {
- "type": "string"
- },
- "data_exporter_address_street_address": {
- "type": "string"
- },
- "data_exporter_address_zipcode": {
- "type": "string"
- },
- "data_exporter_contact_details": {
- "type": "string"
- },
- "data_exporter_contact_name": {
- "type": "string"
- },
- "data_exporter_contact_position": {
- "type": "string"
- },
- "data_exporter_role": {
- "description": "Role of the data exporter. Overwritten to `Controller` when the agreement is created from a template.",
- "enum": [
- "Controller",
- "Processor"
- ],
- "type": "string"
- },
- "data_importer_address": {
- "type": "string"
- },
- "data_importer_address_city": {
- "type": "string"
- },
- "data_importer_address_country": {
- "type": "string"
- },
- "data_importer_address_state": {
- "type": "string"
- },
- "data_importer_address_street_address": {
- "type": "string"
- },
- "data_importer_address_zipcode": {
- "type": "string"
- },
- "data_importer_contact_details": {
- "type": "string"
- },
- "data_importer_contact_name": {
- "type": "string"
- },
- "data_importer_contact_position": {
- "type": "string"
- },
- "duration_of_processing": {
- "type": "string"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_covered_claim": {
- "type": "boolean"
- },
- "include_covered_claim_external_val": {
- "type": "string"
- },
- "include_covered_claim_internal_val": {
- "type": "string"
- },
- "include_covered_claim_type": {
- "description": "Which covered-claim text applies: `internal` uses `include_covered_claim_internal_val`, `external` uses `include_covered_claim_external_val`. Required when `include_covered_claim` is true.",
- "enum": [
- "internal",
- "external"
- ],
- "type": "string"
- },
- "include_data_subjects_custom": {
- "type": "boolean"
- },
- "include_data_subjects_custom_val": {
- "type": "string"
- },
- "include_data_subjects_employees": {
- "type": "boolean"
- },
- "include_data_subjects_end_users": {
- "type": "boolean"
- },
- "include_external_subprocessor_location": {
- "type": "string"
- },
- "include_frequency_of_transfer_continuous": {
- "type": "boolean"
- },
- "include_frequency_of_transfer_custom": {
- "type": "boolean"
- },
- "include_frequency_of_transfer_custom_val": {
- "type": "string"
- },
- "include_governing_country_eu": {
- "type": "boolean"
- },
- "include_governing_country_eu_val": {
- "type": "string"
- },
- "include_governing_country_uk": {
- "type": "boolean"
- },
- "include_governing_country_uk_val": {
- "type": "string"
- },
- "include_governing_law": {
- "type": "boolean"
- },
- "include_governing_law_country": {
- "type": "string"
- },
- "include_governing_law_state": {
- "type": "string"
- },
- "include_increased_claim_amount": {
- "description": "Legacy field. Stored but not shown on the DPA; use the `include_liability_cap*` fields instead.",
- "type": "boolean"
- },
- "include_increased_claim_amount_currency": {
- "description": "Legacy field. Stored but not shown on the DPA; use the `include_liability_cap*` fields instead."
- },
- "include_increased_claim_amount_qty": {
- "description": "Legacy field. Stored but not shown on the DPA; use the `include_liability_cap*` fields instead."
- },
- "include_increased_claim_amount_type": {
- "description": "Legacy field. Stored but not shown on the DPA; use the `include_liability_cap*` fields instead.",
- "type": "string"
- },
- "include_liability_cap": {
- "type": "boolean"
- },
- "include_liability_cap_amount_constant_external": {
- "type": "string"
- },
- "include_liability_cap_amount_constant_internal": {
- "type": "string"
- },
- "include_liability_cap_amount_currency_external": {
- "description": "Currency amount. Numbers and numeric strings (commas allowed) are both accepted."
- },
- "include_liability_cap_amount_currency_internal": {
- "description": "Currency amount. Numbers and numeric strings (commas allowed) are both accepted."
- },
- "include_liability_cap_csa_type": {
- "description": "Which liability cap values apply: the `_internal` or `_external` amount fields. Required when `include_liability_cap` is true.",
- "enum": [
- "internal",
- "external"
- ],
- "type": "string"
- },
- "include_personal_data_biographic_info": {
- "type": "boolean"
- },
- "include_personal_data_contact_info": {
- "type": "boolean"
- },
- "include_personal_data_custom": {
- "type": "boolean"
- },
- "include_personal_data_custom_val": {
- "type": "string"
- },
- "include_personal_data_employment_info": {
- "type": "boolean"
- },
- "include_personal_data_financial_info": {
- "type": "boolean"
- },
- "include_personal_data_location": {
- "type": "boolean"
- },
- "include_personal_data_name": {
- "type": "boolean"
- },
- "include_personal_data_transactional_info": {
- "type": "boolean"
- },
- "include_personal_data_user_activity_info": {
- "type": "boolean"
- },
- "include_processing_purpose_custom": {
- "type": "boolean"
- },
- "include_processing_purpose_custom_val": {
- "type": "string"
- },
- "include_processing_purpose_erasing": {
- "type": "boolean"
- },
- "include_processing_purpose_holding": {
- "type": "boolean"
- },
- "include_processing_purpose_protecting": {
- "type": "boolean"
- },
- "include_processing_purpose_receiving": {
- "type": "boolean"
- },
- "include_processing_purpose_returning": {
- "type": "boolean"
- },
- "include_processing_purpose_sharing": {
- "type": "boolean"
- },
- "include_processing_purpose_updating": {
- "type": "boolean"
- },
- "include_processing_purpose_using": {
- "type": "boolean"
- },
- "include_provider_security_contact_address": {
- "type": "boolean"
- },
- "include_provider_security_contact_address_city": {
- "type": "string"
- },
- "include_provider_security_contact_address_country": {
- "type": "string"
- },
- "include_provider_security_contact_address_state": {
- "type": "string"
- },
- "include_provider_security_contact_address_street_address": {
- "type": "string"
- },
- "include_provider_security_contact_address_zipcode": {
- "type": "string"
- },
- "include_provider_security_contact_email": {
- "type": "boolean"
- },
- "include_provider_security_contact_email_val": {
- "format": "email",
- "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
- "type": "string"
- },
- "include_security_measures_accountability": {
- "type": "boolean"
- },
- "include_security_measures_accountability_val": {
- "type": "string"
- },
- "include_security_measures_certification_or_assurance": {
- "type": "boolean"
- },
- "include_security_measures_certification_or_assurance_val": {
- "type": "string"
- },
- "include_security_measures_confidentiality_integrity": {
- "type": "boolean"
- },
- "include_security_measures_confidentiality_integrity_val": {
- "type": "string"
- },
- "include_security_measures_data_at_rest": {
- "type": "boolean"
- },
- "include_security_measures_data_at_rest_val": {
- "type": "string"
- },
- "include_security_measures_data_minimization": {
- "type": "boolean"
- },
- "include_security_measures_data_minimization_val": {
- "type": "string"
- },
- "include_security_measures_data_quality": {
- "type": "boolean"
- },
- "include_security_measures_data_quality_val": {
- "type": "string"
- },
- "include_security_measures_data_retention": {
- "type": "boolean"
- },
- "include_security_measures_data_retention_val": {
- "type": "string"
- },
- "include_security_measures_data_transmission": {
- "type": "boolean"
- },
- "include_security_measures_data_transmission_val": {
- "type": "string"
- },
- "include_security_measures_event_logging": {
- "type": "boolean"
- },
- "include_security_measures_event_logging_val": {
- "type": "string"
- },
- "include_security_measures_identity_auth": {
- "type": "boolean"
- },
- "include_security_measures_identity_auth_val": {
- "type": "string"
- },
- "include_security_measures_it_security_governance": {
- "type": "boolean"
- },
- "include_security_measures_it_security_governance_val": {
- "type": "string"
- },
- "include_security_measures_physical_security": {
- "type": "boolean"
- },
- "include_security_measures_physical_security_val": {
- "type": "string"
- },
- "include_security_measures_portability_and_erasure": {
- "type": "boolean"
- },
- "include_security_measures_portability_and_erasure_val": {
- "type": "string"
- },
- "include_security_measures_pseudonym_encryption": {
- "type": "boolean"
- },
- "include_security_measures_pseudonym_encryption_val": {
- "type": "string"
- },
- "include_security_measures_restore_data_access": {
- "type": "boolean"
- },
- "include_security_measures_restore_data_access_val": {
- "type": "string"
- },
- "include_security_measures_security_policy": {
- "type": "boolean"
- },
- "include_security_measures_system_configuration": {
- "type": "boolean"
- },
- "include_security_measures_system_configuration_val": {
- "type": "string"
- },
- "include_security_measures_testing_assessment": {
- "type": "boolean"
- },
- "include_security_measures_testing_assessment_val": {
- "type": "string"
- },
- "include_security_policy": {
- "type": "boolean"
- },
- "include_security_policy_fedramp_auth": {
- "type": "boolean"
- },
- "include_security_policy_hipaa": {
- "type": "boolean"
- },
- "include_security_policy_hitrust": {
- "type": "boolean"
- },
- "include_security_policy_include_other": {
- "type": "boolean"
- },
- "include_security_policy_iso27001": {
- "type": "boolean"
- },
- "include_security_policy_other": {
- "type": "string"
- },
- "include_security_policy_pci1": {
- "type": "boolean"
- },
- "include_security_policy_pci2": {
- "type": "boolean"
- },
- "include_security_policy_penetration_testing": {
- "type": "boolean"
- },
- "include_security_policy_soc2": {
- "type": "boolean"
- },
- "include_security_policy_soc2_type2": {
- "type": "boolean"
- },
- "include_sensitive_data_restrictions_custom": {
- "type": "boolean"
- },
- "include_sensitive_data_restrictions_custom_val": {
- "type": "string"
- },
- "include_sensitive_data_restrictions_security_policy": {
- "type": "boolean"
- },
- "include_service_provider_relationship": {
- "type": "boolean"
- },
- "include_special_category_data": {
- "type": "boolean"
- },
- "provider": {
- "type": "string"
- },
- "security_policy_available_at": {
- "type": "string"
- },
- "security_policy_type": {
- "description": "Where the Security Policy is defined. For `external`, set `security_policy_available_at`.",
- "enum": [
- "defined in agreement",
- "provider service",
- "external"
- ],
- "type": "string"
- },
- "subprocessors_attributes": {
- "additionalProperties": {
- "additionalProperties": false,
- "properties": {
- "_destroy": {
- "description": "Set to true with `id` to remove that subprocessor.",
- "type": "boolean"
- },
- "country": {
- "type": "string"
- },
- "id": {
- "description": "ID of an existing subprocessor to update or remove. Omit to add a new subprocessor.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "name": {
- "type": "string"
- },
- "processing_task": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "description": "Subprocessors, keyed by string index such as \"0\", \"1\". On create these are added to the template's subprocessors. On a draft update, an entry without `id` adds a new subprocessor; pass `id` to change one and `id` with `_destroy: true` to remove one.",
- "propertyNames": {
- "type": "string"
- },
- "type": "object"
- },
- "underlying_agreement_id": {
- "description": "ID of the CSA this DPA supplements when `underlying_agreement_type` is `internal`.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "underlying_agreement_type": {
- "description": "`internal` links a CSA in Common Paper (`underlying_agreement_id`); `external` describes another agreement in `underlying_agreement_val` (required). Omit for none.",
- "enum": [
- "internal",
- "external"
- ],
- "type": "string"
- },
- "underlying_agreement_val": {
- "description": "Description of the agreement this DPA supplements. Required when `underlying_agreement_type` is `external`.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "framework_terms_description": {
- "description": "Custom framework terms description. Only used when framework_terms_type is \"description\".",
- "type": "string"
- },
- "framework_terms_type": {
- "description": "How framework terms are specified. Use \"new\" for standard terms or \"description\" to provide a custom framework_terms_description.",
- "enum": [
- "new",
- "description"
- ],
- "type": "string"
- },
- "governing_law_country": {
- "description": "The country whose laws govern the agreement.",
- "type": "string"
- },
- "governing_law_region": {
- "description": "The state or region whose laws govern the agreement.",
- "type": "string"
- },
- "include_automated_payment_reminders": {
- "description": "When true, automatically sends payment reminder emails.",
- "type": "boolean"
- },
- "include_billing_info": {
- "description": "When true, billing contact information (billing_name, billing_email) is included.",
- "type": "boolean"
- },
- "include_billing_workflow": {
- "description": "When true, enables a billing workflow after signing.",
- "type": "boolean"
- },
- "include_expiration_date": {
- "description": "Expiration date in YYYY-MM-DD format. Use when include_expiration_type is \"date\".",
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "include_expiration_days": {
- "description": "Number of days until the agreement expires. Use when include_expiration_type is \"days\".",
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_expiration_type": {
- "description": "How to set expiration: \"none\" (default), \"days\" (use include_expiration_days), or \"date\" (use include_expiration_date).",
- "enum": [
- "none",
- "days",
- "date"
- ],
- "type": "string"
- },
- "include_terms": {
- "description": "When true, the standard terms are included with the agreement.",
- "type": "boolean"
- },
- "loi_attributes": {
- "additionalProperties": false,
- "description": "Override loi terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "confidentiality_custom": {
- "type": "string"
- },
- "confidentiality_mutual_include_loi": {
- "type": "boolean"
- },
- "confidentiality_nda_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "confidentiality_nda_description": {
- "type": "string"
- },
- "confidentiality_nda_include_loi": {
- "type": "boolean"
- },
- "confidentiality_nda_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "confidentiality_type": {
- "enum": [
- "mutual",
- "nda",
- "provider",
- "custom"
- ],
- "type": "string"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_custom_details": {
- "type": "boolean"
- },
- "include_custom_details_val": {
- "type": "string"
- },
- "include_fees": {
- "type": "boolean"
- },
- "include_fees_amount": {
- "type": "number"
- },
- "include_fees_amount_duration": {
- "enum": [
- "month",
- "year",
- "quarter"
- ],
- "type": "string"
- },
- "include_fees_include_amount": {
- "type": "boolean"
- },
- "include_fees_include_other": {
- "type": "boolean"
- },
- "include_fees_other": {
- "type": "string"
- },
- "include_functionality": {
- "type": "boolean"
- },
- "include_functionality_val": {
- "type": "string"
- },
- "include_launch_date": {
- "type": "boolean"
- },
- "include_launch_date_custom": {
- "type": "string"
- },
- "include_launch_date_date": {
- "format": "date-time",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$",
- "type": "string"
- },
- "include_launch_date_type": {
- "enum": [
- "date",
- "custom"
- ],
- "type": "string"
- },
- "product_name": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "manual_send": {
- "description": "When true, the agreement is marked as manually sent outside the platform.",
- "type": "boolean"
- },
- "message": {
- "type": "string"
- },
- "negotiations_allowed": {
- "description": "When true, the recipient can propose changes to the legal terms. For agreement types without separate business terms, that covers every term. CSA order forms, PSA statements of work, partnership business terms and software license order forms have their own `negotiations_allowed` flag.",
- "type": "boolean"
- },
- "partnership_attributes": {
- "additionalProperties": false,
- "description": "Override partnership terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "effective_date": {
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "effective_date_type": {
- "enum": [
- "signature",
- "date"
- ],
- "type": "string"
- },
- "general_cap_amount_currency_val": {
- "type": "number"
- },
- "general_cap_amount_either_currency": {
- "type": "number"
- },
- "general_cap_amount_either_multiple": {
- "type": "number"
- },
- "general_cap_amount_multiple_val": {
- "type": "number"
- },
- "general_cap_amount_type": {
- "enum": [
- "multiple",
- "currency",
- "either",
- "base"
- ],
- "type": "string"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_additional_warranties": {
- "type": "boolean"
- },
- "include_additional_warranties_include_company": {
- "type": "boolean"
- },
- "include_additional_warranties_include_company_val": {
- "type": "string"
- },
- "include_additional_warranties_include_partner": {
- "type": "boolean"
- },
- "include_additional_warranties_include_partner_val": {
- "type": "string"
- },
- "include_brand_guidelines": {
- "type": "boolean"
- },
- "include_brand_guidelines_include_company": {
- "type": "boolean"
- },
- "include_brand_guidelines_include_company_val": {
- "type": "string"
- },
- "include_brand_guidelines_include_partner": {
- "type": "boolean"
- },
- "include_brand_guidelines_include_partner_val": {
- "type": "string"
- },
- "include_covered_claims": {
- "type": "boolean"
- },
- "include_covered_claims_company_claims": {
- "type": "string"
- },
- "include_covered_claims_include_company_claims": {
- "type": "boolean"
- },
- "include_covered_claims_include_partner_claims": {
- "type": "boolean"
- },
- "include_covered_claims_partner_claims": {
- "type": "string"
- },
- "include_dpa": {
- "type": "boolean"
- },
- "include_dpa_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_dpa_location": {
- "type": "string"
- },
- "include_dpa_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_increased_cap_amount": {
- "type": "boolean"
- },
- "include_increased_cap_amount_currency": {
- "type": "number"
- },
- "include_increased_cap_amount_either_currency": {
- "type": "number"
- },
- "include_increased_cap_amount_either_multiple": {
- "type": "string"
- },
- "include_increased_cap_amount_multiple": {
- "type": "string"
- },
- "include_increased_cap_amount_type": {
- "enum": [
- "multiple",
- "currency",
- "either"
- ],
- "type": "string"
- },
- "include_increased_claims": {
- "type": "boolean"
- },
- "include_increased_claims_include_confidentiality": {
- "type": "boolean"
- },
- "include_increased_claims_include_confidentiality_misconduct": {
- "type": "boolean"
- },
- "include_increased_claims_include_covered_claims": {
- "type": "boolean"
- },
- "include_increased_claims_include_misconduct": {
- "type": "boolean"
- },
- "include_increased_claims_include_other": {
- "type": "boolean"
- },
- "include_increased_claims_include_other_val": {
- "type": "string"
- },
- "include_unlimited_claims": {
- "type": "boolean"
- },
- "include_unlimited_claims_confidentiality": {
- "type": "boolean"
- },
- "include_unlimited_claims_confidentiality_misconduct": {
- "type": "boolean"
- },
- "include_unlimited_claims_covered_claims": {
- "type": "boolean"
- },
- "include_unlimited_claims_misconduct": {
- "type": "boolean"
- },
- "include_unlimited_claims_other": {
- "type": "boolean"
- },
- "include_unlimited_claims_other_val": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "partnership_business_terms_attributes": {
- "additionalProperties": false,
- "description": "Override partnership business terms terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "end_date_after_effective_date_amount": {
- "type": "number"
- },
- "end_date_after_effective_date_unit": {
- "enum": [
- "month(s)",
- "quarter(s)",
- "year(s)"
- ],
- "type": "string"
- },
- "end_date_date": {
- "type": "string"
- },
- "end_date_type": {
- "enum": [
- "date",
- "effective date"
- ],
- "type": "string"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_obligations_company_brand": {
- "type": "boolean"
- },
- "include_obligations_company_promotion": {
- "type": "boolean"
- },
- "include_obligations_company_promotion_include_activities": {
- "type": "boolean"
- },
- "include_obligations_company_promotion_include_activities_val": {
- "type": "string"
- },
- "include_obligations_company_promotion_include_materials": {
- "type": "boolean"
- },
- "include_obligations_company_promotion_include_materials_val": {
- "type": "string"
- },
- "include_obligations_company_referral": {
- "type": "boolean"
- },
- "include_obligations_company_referral_include_criteria": {
- "type": "boolean"
- },
- "include_obligations_company_referral_include_criteria_val": {
- "type": "string"
- },
- "include_obligations_company_referral_include_pay_sch": {
- "type": "boolean"
- },
- "include_obligations_company_referral_include_pay_sch_amount": {
- "type": "number"
- },
- "include_obligations_company_referral_include_pay_sch_custom": {
- "type": "string"
- },
- "include_obligations_company_referral_include_pay_sch_unit": {
- "enum": [
- "U.S. Dollars",
- "percent"
- ],
- "type": "string"
- },
- "include_obligations_company_sponsorship": {
- "type": "boolean"
- },
- "include_obligations_company_sponsorship_include_benefits": {
- "type": "boolean"
- },
- "include_obligations_company_sponsorship_include_benefits_val": {
- "type": "string"
- },
- "include_obligations_company_sponsorship_include_payments": {
- "type": "boolean"
- },
- "include_obligations_company_sponsorship_include_payments_amount": {
- "type": "number"
- },
- "include_obligations_company_sponsorship_include_payments_unit": {
- "enum": [
- "U.S. Dollars",
- "percent"
- ],
- "type": "string"
- },
- "include_obligations_partner_brand": {
- "type": "boolean"
- },
- "include_obligations_partner_promotion": {
- "type": "boolean"
- },
- "include_obligations_partner_promotion_include_activities": {
- "type": "boolean"
- },
- "include_obligations_partner_promotion_include_activities_val": {
- "type": "string"
- },
- "include_obligations_partner_promotion_include_materials": {
- "type": "boolean"
- },
- "include_obligations_partner_promotion_include_materials_val": {
- "type": "string"
- },
- "include_obligations_partner_referral": {
- "type": "boolean"
- },
- "include_obligations_partner_referral_include_criteria": {
- "type": "boolean"
- },
- "include_obligations_partner_referral_include_criteria_val": {
- "type": "string"
- },
- "include_obligations_partner_referral_include_pay_sch": {
- "type": "boolean"
- },
- "include_obligations_partner_referral_include_pay_sch_amount": {
- "type": "number"
- },
- "include_obligations_partner_referral_include_pay_sch_custom": {
- "type": "string"
- },
- "include_obligations_partner_referral_include_pay_sch_unit": {
- "enum": [
- "U.S. Dollars",
- "percent"
- ],
- "type": "string"
- },
- "include_obligations_partner_sponsorship": {
- "type": "boolean"
- },
- "include_obligations_partner_sponsorship_include_benefits": {
- "type": "boolean"
- },
- "include_obligations_partner_sponsorship_include_benefits_val": {
- "type": "string"
- },
- "include_obligations_partner_sponsorship_include_payments": {
- "type": "boolean"
- },
- "include_obligations_partner_sponsorship_include_payments_amount": {
- "type": "number"
- },
- "include_obligations_partner_sponsorship_include_payments_unit": {
- "enum": [
- "U.S. Dollars",
- "percent"
- ],
- "type": "string"
- },
- "include_payment_process": {
- "type": "boolean"
- },
- "include_payment_process_company": {
- "type": "boolean"
- },
- "include_payment_process_company_include_address": {
- "type": "boolean"
- },
- "include_payment_process_company_include_address_city": {
- "type": "string"
- },
- "include_payment_process_company_include_address_country": {
- "type": "string"
- },
- "include_payment_process_company_include_address_state": {
- "type": "string"
- },
- "include_payment_process_company_include_address_street_address": {
- "type": "string"
- },
- "include_payment_process_company_include_address_zipcode": {
- "type": "string"
- },
- "include_payment_process_company_include_email": {
- "type": "boolean"
- },
- "include_payment_process_company_include_email_val": {
- "type": "string"
- },
- "include_payment_process_partner": {
- "type": "boolean"
- },
- "include_payment_process_partner_include_address": {
- "type": "boolean"
- },
- "include_payment_process_partner_include_address_city": {
- "type": "string"
- },
- "include_payment_process_partner_include_address_country": {
- "type": "string"
- },
- "include_payment_process_partner_include_address_state": {
- "type": "string"
- },
- "include_payment_process_partner_include_address_street_address": {
- "type": "string"
- },
- "include_payment_process_partner_include_address_zipcode": {
- "type": "string"
- },
- "include_payment_process_partner_include_email": {
- "type": "boolean"
- },
- "include_payment_process_partner_include_email_val": {
- "type": "string"
- },
- "include_payment_schedule": {
- "type": "boolean"
- },
- "include_payment_schedule_custom": {
- "type": "string"
- },
- "include_payment_schedule_specified_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_payment_schedule_specified_timeframe": {
- "enum": [
- "receipt",
- "date"
- ],
- "type": "string"
- },
- "include_payment_schedule_specified_unit": {
- "enum": [
- "day(s)",
- "week(s)",
- "month(s)",
- "quarter(s)",
- "year(s)"
- ],
- "type": "string"
- },
- "include_payment_schedule_type": {
- "enum": [
- "specified",
- "custom"
- ],
- "type": "string"
- },
- "negotiations_allowed": {
- "description": "When true, the recipient can propose changes to the business terms, even when the agreement-level `negotiations_allowed` is false. This only covers the business terms.",
- "type": "boolean"
- },
- "territory_type": {
- "enum": [
- "worldwide",
- "custom"
- ],
- "type": "string"
- },
- "territory_type_val": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "payment_link_url": {
- "description": "A payment URL shown to the recipient after signing. Requires include_billing_workflow to be true and billing_workflow_type to be \"link\".",
- "type": "string"
- },
- "pilot_attributes": {
- "additionalProperties": false,
- "description": "Override pilot terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "fees_type": {
- "enum": [
- "free",
- "pilot_period_fees"
- ],
- "type": "string"
- },
- "general_cap_amount": {
- "type": "number"
- },
- "general_cap_amount_type": {
- "enum": [
- "preceding",
- "base",
- "period"
- ],
- "type": "string"
- },
- "general_cap_period_currency": {
- "type": "number"
- },
- "general_cap_period_qty": {
- "type": "number"
- },
- "general_cap_preceding_amount": {
- "type": "number"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_dpa": {
- "type": "boolean"
- },
- "include_dpa_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_dpa_location": {
- "type": "string"
- },
- "include_dpa_type": {
- "enum": [
- "description",
- "attachment",
- "standard"
- ],
- "type": "string"
- },
- "include_payment_process": {
- "type": "boolean"
- },
- "include_technical_support": {
- "type": "boolean"
- },
- "payment_process_automatic_frequency": {
- "enum": [
- "monthly",
- "quarterly",
- "annually",
- "once_per_period"
- ],
- "type": "string"
- },
- "payment_process_invoice_days": {
- "type": "number"
- },
- "payment_process_invoice_from": {
- "enum": [
- "receipt",
- "date"
- ],
- "type": "string"
- },
- "payment_process_invoice_timeframe": {
- "enum": [
- "days",
- "weeks",
- "months",
- "quarters",
- "years"
- ],
- "type": "string"
- },
- "payment_process_type": {
- "enum": [
- "automatic",
- "invoice"
- ],
- "type": "string"
- },
- "pilot_period_description": {
- "type": "string"
- },
- "pilot_period_fees_description": {
- "type": "string"
- },
- "product_description": {
- "type": "string"
- },
- "technical_support_description": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "psa_attributes": {
- "additionalProperties": false,
- "description": "Override psa terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "additional_changes": {
- "type": "string"
- },
- "customer_description": {
- "type": "string"
- },
- "effective_date": {
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "effective_date_type": {
- "enum": [
- "signature",
- "date"
- ],
- "type": "string"
- },
- "general_cap_amount": {
- "type": "number"
- },
- "general_cap_amount_type": {
- "enum": [
- "preceding",
- "base",
- "period"
- ],
- "type": "string"
- },
- "general_cap_period_currency": {
- "type": "number"
- },
- "general_cap_period_qty": {
- "type": "number"
- },
- "general_cap_preceding_amount": {
- "type": "number"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_additional_changes": {
- "type": "boolean"
- },
- "include_additional_warranties": {
- "type": "boolean"
- },
- "include_additional_warranties_by_customer": {
- "type": "string"
- },
- "include_additional_warranties_by_provider": {
- "type": "string"
- },
- "include_additional_warranties_include_by_customer": {
- "type": "boolean"
- },
- "include_additional_warranties_include_by_provider": {
- "type": "boolean"
- },
- "include_covered_claims": {
- "type": "boolean"
- },
- "include_covered_claims_customer_claims": {
- "type": "string"
- },
- "include_covered_claims_include_customer_claims": {
- "type": "boolean"
- },
- "include_covered_claims_include_provider_claims": {
- "type": "boolean"
- },
- "include_covered_claims_provider_claims": {
- "type": "string"
- },
- "include_customer_insurance_min": {
- "type": "boolean"
- },
- "include_customer_insurance_min_add_provider_com_gen_liability": {
- "type": "boolean"
- },
- "include_customer_insurance_min_add_provider_cyber_liability": {
- "type": "boolean"
- },
- "include_customer_insurance_min_add_provider_errors_omissions": {
- "type": "boolean"
- },
- "include_customer_insurance_min_auto_liability_aggregate": {
- "type": "number"
- },
- "include_customer_insurance_min_auto_liability_minimum": {
- "type": "number"
- },
- "include_customer_insurance_min_cyber_liability_aggregate": {
- "type": "number"
- },
- "include_customer_insurance_min_cyber_liability_minimum": {
- "type": "number"
- },
- "include_customer_insurance_min_employer_liability_aggregate": {
- "type": "number"
- },
- "include_customer_insurance_min_employer_liability_minimum": {
- "type": "number"
- },
- "include_customer_insurance_min_general_liability_aggregate": {
- "type": "number"
- },
- "include_customer_insurance_min_general_liability_minimum": {
- "type": "number"
- },
- "include_customer_insurance_min_include_add_provider": {
- "type": "boolean"
- },
- "include_customer_insurance_min_include_auto_liability": {
- "type": "boolean"
- },
- "include_customer_insurance_min_include_cyber_liability": {
- "type": "boolean"
- },
- "include_customer_insurance_min_include_employer_liability": {
- "type": "boolean"
- },
- "include_customer_insurance_min_include_general_liability": {
- "type": "boolean"
- },
- "include_customer_insurance_min_include_workers_comp": {
- "type": "boolean"
- },
- "include_customer_policies": {
- "type": "boolean"
- },
- "include_customer_policies_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_customer_policies_location": {
- "type": "string"
- },
- "include_customer_policies_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_dpa": {
- "type": "boolean"
- },
- "include_dpa_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_dpa_location": {
- "type": "string"
- },
- "include_dpa_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_increased_cap_amount": {
- "type": "boolean"
- },
- "include_increased_claims": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_confidentiality": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_confidentiality_negligence": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_privsec": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_privsec_negligence": {
- "type": "boolean"
- },
- "include_increased_claims_include_other": {
- "type": "boolean"
- },
- "include_increased_claims_indemnification_obligation": {
- "type": "boolean"
- },
- "include_increased_claims_negligence": {
- "type": "boolean"
- },
- "include_increased_claims_other": {
- "type": "string"
- },
- "include_provider_insurance_min": {
- "type": "boolean"
- },
- "include_provider_insurance_min_add_customer_com_gen_liability": {
- "type": "boolean"
- },
- "include_provider_insurance_min_add_customer_cyber_liability": {
- "type": "boolean"
- },
- "include_provider_insurance_min_add_customer_errors_omissions": {
- "type": "boolean"
- },
- "include_provider_insurance_min_auto_liability_aggregate": {
- "type": "number"
- },
- "include_provider_insurance_min_auto_liability_minimum": {
- "type": "number"
- },
- "include_provider_insurance_min_cyber_liability_aggregate": {
- "type": "number"
- },
- "include_provider_insurance_min_cyber_liability_minimum": {
- "type": "number"
- },
- "include_provider_insurance_min_employer_liability_aggregate": {
- "type": "number"
- },
- "include_provider_insurance_min_employer_liability_minimum": {
- "type": "number"
- },
- "include_provider_insurance_min_general_liability_aggregate": {
- "type": "number"
- },
- "include_provider_insurance_min_general_liability_minimum": {
- "type": "number"
- },
- "include_provider_insurance_min_include_add_customer": {
- "type": "boolean"
- },
- "include_provider_insurance_min_include_auto_liability": {
- "type": "boolean"
- },
- "include_provider_insurance_min_include_cyber_liability": {
- "type": "boolean"
- },
- "include_provider_insurance_min_include_employer_liability": {
- "type": "boolean"
- },
- "include_provider_insurance_min_include_general_liability": {
- "type": "boolean"
- },
- "include_provider_insurance_min_include_workers_comp": {
- "type": "boolean"
- },
- "include_publicity_rights": {
- "type": "boolean"
- },
- "include_publicity_rights_type": {
- "enum": [
- "public",
- "non-public"
- ],
- "type": "string"
- },
- "include_security_policy": {
- "type": "boolean"
- },
- "include_security_policy_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_security_policy_fedramp_auth": {
- "type": "boolean"
- },
- "include_security_policy_hitrust": {
- "type": "boolean"
- },
- "include_security_policy_include_annual_maintenance": {
- "type": "boolean"
- },
- "include_security_policy_include_other": {
- "type": "boolean"
- },
- "include_security_policy_include_other_val": {
- "type": "string"
- },
- "include_security_policy_iso27001": {
- "type": "boolean"
- },
- "include_security_policy_location": {
- "type": "string"
- },
- "include_security_policy_pci1": {
- "type": "boolean"
- },
- "include_security_policy_pci2": {
- "type": "boolean"
- },
- "include_security_policy_penetration_testing": {
- "type": "boolean"
- },
- "include_security_policy_soc2_type1": {
- "type": "boolean"
- },
- "include_security_policy_soc2_type2": {
- "type": "boolean"
- },
- "include_security_policy_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_unlimited_claims": {
- "type": "boolean"
- },
- "include_unlimited_claims_breach_of_confidentiality": {
- "type": "boolean"
- },
- "include_unlimited_claims_breach_of_confidentiality_negligence": {
- "type": "boolean"
- },
- "include_unlimited_claims_breach_of_privsec": {
- "type": "boolean"
- },
- "include_unlimited_claims_breach_of_privsec_negligence": {
- "type": "boolean"
- },
- "include_unlimited_claims_include_other": {
- "type": "boolean"
- },
- "include_unlimited_claims_indemnification_obligation": {
- "type": "boolean"
- },
- "include_unlimited_claims_negligence": {
- "type": "boolean"
- },
- "include_unlimited_claims_other": {
- "type": "string"
- },
- "increased_cap_amount_currency": {
- "type": "number"
- },
- "increased_cap_amount_period_currency": {
- "type": "number"
- },
- "increased_cap_amount_period_qty": {
- "type": "number"
- },
- "increased_cap_amount_qty": {
- "type": "number"
- },
- "increased_cap_amount_type": {
- "enum": [
- "qty",
- "currency",
- "period"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- "psa_statement_of_work_attributes": {
- "additionalProperties": false,
- "description": "Override psa statement of work terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "additional_changes": {
- "type": "string"
- },
- "cost": {
- "type": "number"
- },
- "description": {
- "type": "string"
- },
- "fee_type": {
- "type": "string"
- },
- "fees_attributes": {
- "additionalProperties": {
- "anyOf": [
- {
- "additionalProperties": false,
- "description": "Fees::Flat (fee_type \"flat\"). A fixed recurring fee, e.g. a platform subscription. Set type to \"Fees::Flat\" or fee_type to \"flat\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "Fixed amount in the order form's fees_currency, charged per fee_period. A plain amount, not cents: 20 means 20.00.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"flat\". Alternative to type.",
- "enum": [
- "flat"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Flat\". Optional when fee_type is set.",
- "enum": [
- "Fees::Flat"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Discount (fee_type \"discount\"). A discount, as a fixed amount or a percentage, applied forever, once, or for a number of months. Set type to \"Fees::Discount\" or fee_type to \"discount\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "Discount size: an amount in fees_currency when discount_type is fixed_amount (a plain amount, not cents: 20 means 20.00), or a percentage (e.g. 10 for 10%) when it is percentage.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "discount_duration_amount": {
- "description": "Number of months the discount applies. Required when discount_duration_type is multiple_months.",
- "type": "number"
- },
- "discount_duration_type": {
- "description": "How long the discount applies. multiple_months also needs discount_duration_amount.",
- "enum": [
- "forever",
- "once",
- "multiple_months"
- ],
- "type": "string"
- },
- "discount_type": {
- "description": "Whether cost is a currency amount or a percentage.",
- "enum": [
- "fixed_amount",
- "percentage"
- ],
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"discount\". Alternative to type.",
- "enum": [
- "discount"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Discount\". Optional when fee_type is set.",
- "enum": [
- "Fees::Discount"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Cost (fee_type \"cost\"). A per-unit fee: price per unit times quantity, e.g. seats. Set type to \"Fees::Cost\" or fee_type to \"cost\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "Price per unit in fees_currency. The row total is quantity x cost. A plain amount, not cents: 20 means 20.00.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"cost\". Alternative to type.",
- "enum": [
- "cost"
- ],
- "type": "string"
- },
- "quantity": {
- "description": "Number of units.",
- "type": "number"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Cost\". Optional when fee_type is set.",
- "enum": [
- "Fees::Cost"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Attachment (fee_type \"attachment\"). A fee described in an uploaded attachment instead of in the table. Set type to \"Fees::Attachment\" or fee_type to \"attachment\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "attachment_id": {
- "description": "ID of an attachment uploaded with upload-attachment.",
- "type": "string"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"attachment\". Alternative to type.",
- "enum": [
- "attachment"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Attachment\". Optional when fee_type is set.",
- "enum": [
- "Fees::Attachment"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Graduated (fee_type \"graduated\"). Tiered pricing, with the price set per tier in graduated_fee_tiers_attributes. Set type to \"Fees::Graduated\" or fee_type to \"graduated\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"graduated\". Alternative to type.",
- "enum": [
- "graduated"
- ],
- "type": "string"
- },
- "graduated_fee_tiers_attributes": {
- "additionalProperties": {
- "additionalProperties": false,
- "properties": {
- "flat_price": {
- "type": "number"
- },
- "price_per_unit": {
- "type": "string"
- },
- "upper_limit": {
- "type": "number"
- }
- },
- "type": "object"
- },
- "description": "Graduated fee tiers. Use string keys such as \"0\", \"1\".",
- "propertyNames": {
- "type": "string"
- },
- "type": "object"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Graduated\". Optional when fee_type is set.",
- "enum": [
- "Fees::Graduated"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Included (fee_type \"included\"). An item included at no charge. Set type to \"Fees::Included\" or fee_type to \"included\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"included\". Alternative to type.",
- "enum": [
- "included"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Included\". Optional when fee_type is set.",
- "enum": [
- "Fees::Included"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Metered (fee_type \"metered\"). Usage-based pricing, billed per unit used. Set type to \"Fees::Metered\" or fee_type to \"metered\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "Price per unit of usage in fees_currency. A plain amount, not cents: 20 means 20.00.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"metered\". Alternative to type.",
- "enum": [
- "metered"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Metered\". Optional when fee_type is set.",
- "enum": [
- "Fees::Metered"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::OneTime (fee_type \"one_time\"). A one-time charge, such as a setup fee. Set type to \"Fees::OneTime\" or fee_type to \"one_time\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "One-time amount in fees_currency, charged once rather than per fee_period. A plain amount, not cents: 20 means 20.00.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"one_time\". Alternative to type.",
- "enum": [
- "one_time"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::OneTime\". Optional when fee_type is set.",
- "enum": [
- "Fees::OneTime"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Text (fee_type \"text\"). A fee term described in free text. Set type to \"Fees::Text\" or fee_type to \"text\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"text\". Alternative to type.",
- "enum": [
- "text"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Text\". Optional when fee_type is set.",
- "enum": [
- "Fees::Text"
- ],
- "type": "string"
- }
- },
- "type": "object"
- }
- ]
- },
- "description": "Fee line items. Use string keys such as \"0\", \"1\". Replaces template fees when provided.",
- "propertyNames": {
- "type": "string"
- },
- "type": "object"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_additional_changes": {
- "type": "boolean"
- },
- "include_customer_obligation": {
- "type": "boolean"
- },
- "include_customer_obligation_val": {
- "type": "string"
- },
- "include_deliverables": {
- "type": "boolean"
- },
- "include_deliverables_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_deliverables_description": {
- "type": "string"
- },
- "include_deliverables_include_acceptance": {
- "type": "boolean"
- },
- "include_deliverables_include_attachment": {
- "type": "boolean"
- },
- "include_deliverables_include_draft_deliverables": {
- "type": "boolean"
- },
- "include_deliverables_rejection_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_deliverables_rejection_unit": {
- "enum": [
- "hours",
- "days",
- "weeks",
- "months"
- ],
- "type": "string"
- },
- "include_deliverables_resubmission_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_deliverables_resubmission_unit": {
- "enum": [
- "hours",
- "days",
- "weeks",
- "months"
- ],
- "type": "string"
- },
- "include_fees_other": {
- "type": "boolean"
- },
- "include_fees_other_val": {
- "type": "string"
- },
- "include_fees_table": {
- "type": "boolean"
- },
- "include_fees_table_total": {
- "type": "boolean"
- },
- "include_fees_travel": {
- "type": "boolean"
- },
- "include_fees_travel_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_fees_travel_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_fees_travel_val": {
- "type": "string"
- },
- "include_third_party_customer": {
- "type": "boolean"
- },
- "include_third_party_include_description": {
- "type": "boolean"
- },
- "include_third_party_include_description_val": {
- "type": "string"
- },
- "include_third_party_materials": {
- "type": "boolean"
- },
- "include_third_party_provider": {
- "type": "boolean"
- },
- "include_time_of_assignment": {
- "type": "boolean"
- },
- "include_time_of_assignment_type": {
- "enum": [
- "created",
- "paid"
- ],
- "type": "string"
- },
- "invoice_period_description": {
- "type": "string"
- },
- "negotiations_allowed": {
- "description": "When true, the recipient can propose changes to the statement of work, even when the agreement-level `negotiations_allowed` is false. This only covers the statement of work.",
- "type": "boolean"
- },
- "payment_period": {
- "type": "number"
- },
- "payment_period_other": {
- "type": "string"
- },
- "payment_period_timeframe": {
- "enum": [
- "receipt",
- "invoice",
- "Customer's receipt of invoice",
- "date of invoice"
- ],
- "type": "string"
- },
- "payment_period_type": {
- "enum": [
- "standard",
- "other"
- ],
- "type": "string"
- },
- "payment_period_unit": {
- "enum": [
- "day(s)",
- "week(s)",
- "month(s)",
- "quarter(s)",
- "year(s)"
- ],
- "type": "string"
- },
- "quantity": {
- "type": "number"
- },
- "services_description": {
- "type": "string"
- },
- "sow_date": {
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "sow_date_type": {
- "enum": [
- "signature",
- "date"
- ],
- "type": "string"
- },
- "sow_term_amount": {
- "type": "number"
- },
- "sow_term_date": {
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "sow_term_type": {
- "enum": [
- "deliverables",
- "period",
- "date"
- ],
- "type": "string"
- },
- "sow_term_unit": {
- "enum": [
- "month(s)",
- "quarter(s)",
- "year(s)"
- ],
- "type": "string"
- },
- "type": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "recipient_email": {
- "format": "email",
- "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-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_last_to_sign": {
- "description": "When true, your signer signs after the recipient.",
- "type": "boolean"
- },
- "sender_notice_email_address": {
- "description": "Email address for legal notices to the sender.",
- "format": "email",
- "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-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": {
- "enum": [
- "signature",
- "date"
- ],
- "type": "string"
- },
- "general_cap_amount": {
- "type": "number"
- },
- "general_cap_amount_type": {
- "enum": [
- "preceding",
- "base",
- "period"
- ],
- "type": "string"
- },
- "general_cap_period_currency": {
- "type": "number"
- },
- "general_cap_period_qty": {
- "type": "number"
- },
- "general_cap_preceding_amount": {
- "type": "number"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_additional_warranties": {
- "type": "boolean"
- },
- "include_additional_warranties_by_customer": {
- "type": "string"
- },
- "include_additional_warranties_by_provider": {
- "type": "string"
- },
- "include_additional_warranties_include_by_customer": {
- "type": "boolean"
- },
- "include_additional_warranties_include_by_provider": {
- "type": "boolean"
- },
- "include_ai_addendum": {
- "type": "boolean"
- },
- "include_ai_addendum_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_covered_claims": {
- "type": "boolean"
- },
- "include_covered_claims_customer_claims": {
- "type": "string"
- },
- "include_covered_claims_include_customer_claims": {
- "type": "boolean"
- },
- "include_covered_claims_include_provider_claims": {
- "type": "boolean"
- },
- "include_covered_claims_provider_claims": {
- "type": "string"
- },
- "include_dpa": {
- "type": "boolean"
- },
- "include_dpa_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_dpa_location": {
- "type": "string"
- },
- "include_dpa_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_increased_cap_amount": {
- "type": "boolean"
- },
- "include_increased_claims": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_confidentiality": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_confidentiality_negligence": {
- "type": "boolean"
- },
- "include_increased_claims_include_other": {
- "type": "boolean"
- },
- "include_increased_claims_indemnification_obligation": {
- "type": "boolean"
- },
- "include_increased_claims_negligence": {
- "type": "boolean"
- },
- "include_increased_claims_other": {
- "type": "string"
- },
- "include_increased_claims_restrictions": {
- "type": "boolean"
- },
- "include_unlimited_claims": {
- "type": "boolean"
- },
- "include_unlimited_claims_breach_of_confidentiality": {
- "type": "boolean"
- },
- "include_unlimited_claims_breach_of_confidentiality_negligence": {
- "type": "boolean"
- },
- "include_unlimited_claims_include_other": {
- "type": "boolean"
- },
- "include_unlimited_claims_indemnification_obligation": {
- "type": "boolean"
- },
- "include_unlimited_claims_license_or_restrictions": {
- "type": "boolean"
- },
- "include_unlimited_claims_negligence": {
- "type": "boolean"
- },
- "include_unlimited_claims_other": {
- "type": "string"
- },
- "increased_cap_amount_currency": {
- "type": "number"
- },
- "increased_cap_amount_period_currency": {
- "type": "number"
- },
- "increased_cap_amount_period_qty": {
- "type": "number"
- },
- "increased_cap_amount_qty": {
- "type": "number"
- },
- "increased_cap_amount_type": {
- "enum": [
- "qty",
- "currency",
- "period"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- "software_license_order_form_attributes": {
- "additionalProperties": false,
- "description": "Override software license order form terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "additional_changes": {
- "type": "string"
- },
- "deletion_procedure_include_custom": {
- "type": "boolean"
- },
- "deletion_procedure_include_custom_description": {
- "type": "string"
- },
- "deletion_procedure_include_customer_disable": {
- "type": "boolean"
- },
- "deletion_procedure_include_customer_proof": {
- "type": "boolean"
- },
- "deletion_procedure_include_provider_disable": {
- "type": "boolean"
- },
- "fee_custom_unit": {
- "type": "string"
- },
- "fee_period": {
- "enum": [
- "Subscription Period",
- "month",
- "year",
- "Custom unit"
- ],
- "type": "string"
- },
- "fees_attributes": {
- "additionalProperties": {
- "anyOf": [
- {
- "additionalProperties": false,
- "description": "Fees::Flat (fee_type \"flat\"). A fixed recurring fee, e.g. a platform subscription. Set type to \"Fees::Flat\" or fee_type to \"flat\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "Fixed amount in the order form's fees_currency, charged per fee_period. A plain amount, not cents: 20 means 20.00.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"flat\". Alternative to type.",
- "enum": [
- "flat"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Flat\". Optional when fee_type is set.",
- "enum": [
- "Fees::Flat"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Discount (fee_type \"discount\"). A discount, as a fixed amount or a percentage, applied forever, once, or for a number of months. Set type to \"Fees::Discount\" or fee_type to \"discount\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "Discount size: an amount in fees_currency when discount_type is fixed_amount (a plain amount, not cents: 20 means 20.00), or a percentage (e.g. 10 for 10%) when it is percentage.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "discount_duration_amount": {
- "description": "Number of months the discount applies. Required when discount_duration_type is multiple_months.",
- "type": "number"
- },
- "discount_duration_type": {
- "description": "How long the discount applies. multiple_months also needs discount_duration_amount.",
- "enum": [
- "forever",
- "once",
- "multiple_months"
- ],
- "type": "string"
- },
- "discount_type": {
- "description": "Whether cost is a currency amount or a percentage.",
- "enum": [
- "fixed_amount",
- "percentage"
- ],
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"discount\". Alternative to type.",
- "enum": [
- "discount"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Discount\". Optional when fee_type is set.",
- "enum": [
- "Fees::Discount"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Cost (fee_type \"cost\"). A per-unit fee: price per unit times quantity, e.g. seats. Set type to \"Fees::Cost\" or fee_type to \"cost\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "Price per unit in fees_currency. The row total is quantity x cost. A plain amount, not cents: 20 means 20.00.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"cost\". Alternative to type.",
- "enum": [
- "cost"
- ],
- "type": "string"
- },
- "quantity": {
- "description": "Number of units.",
- "type": "number"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Cost\". Optional when fee_type is set.",
- "enum": [
- "Fees::Cost"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Attachment (fee_type \"attachment\"). A fee described in an uploaded attachment instead of in the table. Set type to \"Fees::Attachment\" or fee_type to \"attachment\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "attachment_id": {
- "description": "ID of an attachment uploaded with upload-attachment.",
- "type": "string"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"attachment\". Alternative to type.",
- "enum": [
- "attachment"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Attachment\". Optional when fee_type is set.",
- "enum": [
- "Fees::Attachment"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Graduated (fee_type \"graduated\"). Tiered pricing, with the price set per tier in graduated_fee_tiers_attributes. Set type to \"Fees::Graduated\" or fee_type to \"graduated\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"graduated\". Alternative to type.",
- "enum": [
- "graduated"
- ],
- "type": "string"
- },
- "graduated_fee_tiers_attributes": {
- "additionalProperties": {
- "additionalProperties": false,
- "properties": {
- "flat_price": {
- "type": "number"
- },
- "price_per_unit": {
- "type": "string"
- },
- "upper_limit": {
- "type": "number"
- }
- },
- "type": "object"
- },
- "description": "Graduated fee tiers. Use string keys such as \"0\", \"1\".",
- "propertyNames": {
- "type": "string"
- },
- "type": "object"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Graduated\". Optional when fee_type is set.",
- "enum": [
- "Fees::Graduated"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Included (fee_type \"included\"). An item included at no charge. Set type to \"Fees::Included\" or fee_type to \"included\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"included\". Alternative to type.",
- "enum": [
- "included"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Included\". Optional when fee_type is set.",
- "enum": [
- "Fees::Included"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Metered (fee_type \"metered\"). Usage-based pricing, billed per unit used. Set type to \"Fees::Metered\" or fee_type to \"metered\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "Price per unit of usage in fees_currency. A plain amount, not cents: 20 means 20.00.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"metered\". Alternative to type.",
- "enum": [
- "metered"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Metered\". Optional when fee_type is set.",
- "enum": [
- "Fees::Metered"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::OneTime (fee_type \"one_time\"). A one-time charge, such as a setup fee. Set type to \"Fees::OneTime\" or fee_type to \"one_time\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "One-time amount in fees_currency, charged once rather than per fee_period. A plain amount, not cents: 20 means 20.00.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"one_time\". Alternative to type.",
- "enum": [
- "one_time"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::OneTime\". Optional when fee_type is set.",
- "enum": [
- "Fees::OneTime"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Text (fee_type \"text\"). A fee term described in free text. Set type to \"Fees::Text\" or fee_type to \"text\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"text\". Alternative to type.",
- "enum": [
- "text"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Text\". Optional when fee_type is set.",
- "enum": [
- "Fees::Text"
- ],
- "type": "string"
- }
- },
- "type": "object"
- }
- ]
- },
- "description": "Fee line items. Use string keys such as \"0\", \"1\". Replaces template fees when provided.",
- "propertyNames": {
- "type": "string"
- },
- "type": "object"
- },
- "fees_currency": {
- "enum": [
- "USD",
- "EUR",
- "GBP",
- "CAD",
- "AUD",
- "SGD",
- "ILS",
- "JPY",
- "CHF",
- "HKD"
- ],
- "type": "string"
- },
- "fees_include_fee_increase_upon_renewal": {
- "type": "boolean"
- },
- "fees_include_fee_increase_upon_renewal_fee": {
- "type": "number"
- },
- "fees_include_fee_increase_upon_renewal_type": {
- "enum": [
- "will",
- "may"
- ],
- "type": "string"
- },
- "fees_inclusive_of_taxes": {
- "type": "boolean"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_additional_changes": {
- "type": "boolean"
- },
- "include_license_compliance_verification": {
- "type": "boolean"
- },
- "include_license_compliance_verification_description": {
- "type": "string"
- },
- "include_license_limits": {
- "type": "boolean"
- },
- "include_license_limits_description": {
- "type": "string"
- },
- "include_payment_process_include_billing_email": {
- "type": "boolean"
- },
- "include_pilot_period": {
- "type": "boolean"
- },
- "include_pilot_period_duration_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_pilot_period_duration_type": {
- "enum": [
- "day",
- "week",
- "month"
- ],
- "type": "string"
- },
- "include_pilot_period_include_fees": {
- "type": "boolean"
- },
- "include_pilot_period_include_fees_amount": {
- "type": "number"
- },
- "include_pilot_period_include_modifications": {
- "type": "boolean"
- },
- "include_pilot_period_include_modifications_description": {
- "type": "string"
- },
- "include_services": {
- "type": "boolean"
- },
- "include_services_description": {
- "type": "string"
- },
- "negotiations_allowed": {
- "description": "When true, the recipient can propose changes to the order form, even when the agreement-level `negotiations_allowed` is false. This only covers the order form.",
- "type": "boolean"
- },
- "order_date_date": {
- "type": "string"
- },
- "order_date_type": {
- "enum": [
- "signature",
- "date",
- "other"
- ],
- "type": "string"
- },
- "payment_process_automatic_frequency": {
- "enum": [
- "monthly",
- "quarterly",
- "semiannually",
- "annually"
- ],
- "type": "string"
- },
- "payment_process_type": {
- "enum": [
- "automatic",
- "invoice",
- "custom"
- ],
- "type": "string"
- },
- "payment_process_type_custom_val": {
- "type": "string"
- },
- "payment_process_type_invoice_amount": {
- "type": "number"
- },
- "payment_process_type_invoice_custom_unit": {
- "type": "string"
- },
- "payment_process_type_invoice_duration": {
- "enum": [
- "day",
- "week",
- "month",
- "year",
- "day(s)",
- "week(s)",
- "month(s)",
- "year(s)"
- ],
- "type": "string"
- },
- "payment_process_type_invoice_duration_start": {
- "enum": [
- "Customer's receipt of invoice",
- "date of invoice"
- ],
- "type": "string"
- },
- "payment_process_type_invoice_type": {
- "enum": [
- "monthly",
- "quarterly",
- "semiannually",
- "annually",
- "Custom unit"
- ],
- "type": "string"
- },
- "permitted_uses_include_custom": {
- "type": "boolean"
- },
- "permitted_uses_include_custom_description": {
- "type": "string"
- },
- "permitted_uses_include_customers_affiliates": {
- "type": "boolean"
- },
- "permitted_uses_include_internal_business": {
- "type": "boolean"
- },
- "pilot_period_stripe_product_id": {
- "type": "string"
- },
- "software_description": {
- "type": "string"
- },
- "subscription_auto_renew": {
- "enum": [
- "days",
- "subscription_end"
- ],
- "type": "string"
- },
- "subscription_period": {
- "type": "number"
- },
- "subscription_period_unit": {
- "type": "string"
- },
- "subscription_renewal_notice_days": {
- "type": "number"
- },
- "warranty_period_description_amount": {
- "type": "number"
- },
- "warranty_period_description_duration": {
- "enum": [
- "day",
- "week",
- "month",
- "year"
- ],
- "type": "string"
- },
- "warranty_period_description_duration_start": {
- "enum": [
- "initial delivery of the Software",
- "delivery of the Software and each subsequent Update",
- "the Order Date"
- ],
- "type": "string"
- },
- "warranty_period_type": {
- "enum": [
- "description",
- "none"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- "test_agreement": {
- "description": "When true, marks the agreement as a test. Test agreements do not count against your monthly limit.",
- "type": "boolean"
- }
- },
- "required": [
- "recipient_name",
- "recipient_email"
- ],
- "type": "object"
- },
- "cc_users": {
- "items": {
- "format": "email",
- "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
- "type": "string"
- },
- "type": "array"
- },
- "draft": {
- "description": "When true, the agreement is saved as a draft and not sent to the recipient. Use POST /v1/agreements/{id}/send to send a draft agreement later.",
- "type": "boolean"
- },
- "owner_email": {
- "description": "Email address of the agreement owner (sender).",
- "type": "string"
- },
- "signer_id": {
- "description": "User id of the signer from the owner's organization.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "template_id": {
- "description": "UUID of a template from `GET /v1/templates`. Accepts both Common Paper standard templates and uploaded PDF templates (`type` `uploaded_template`).",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- }
- },
- "required": [
- "template_id",
- "owner_email",
- "signer_id",
- "agreement"
- ],
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "agreement": {
- "additionalProperties": {},
- "properties": {
- "amendment_attributes": {
- "additionalProperties": false,
- "description": "Override amendment terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "amended_terms_attributes": {
- "additionalProperties": {
- "additionalProperties": false,
- "properties": {
- "description": {
- "type": "string"
- },
- "term": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "description": "Amended terms. Use string keys such as \"0\", \"1\".",
- "propertyNames": {
- "type": "string"
- },
- "type": "object"
- },
- "amendment_date": {
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "amendment_date_type": {
- "enum": [
- "signature",
- "date"
- ],
- "type": "string"
- },
- "framework_terms_type": {
- "type": "string"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "parent_agreement_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "underlying_agreement_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "underlying_agreement_type": {
- "type": "string"
- },
- "underlying_agreement_val": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "baa_attributes": {
- "additionalProperties": false,
- "description": "Override baa terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "aggregation_limitations_permitted": {
- "type": "boolean"
- },
- "aggregation_limitations_permitted_val": {
- "type": "string"
- },
- "breach_notification_unit": {
- "enum": [
- "hours",
- "business days",
- "calendar days"
- ],
- "type": "string"
- },
- "breach_notification_val": {
- "type": "number"
- },
- "business_associate_relationship_type": {
- "enum": [
- "provider",
- "company"
- ],
- "type": "string"
- },
- "deidentification_limitations_include_purpose": {
- "type": "boolean"
- },
- "deidentification_limitations_include_requirements": {
- "type": "boolean"
- },
- "deidentification_limitations_permitted": {
- "type": "boolean"
- },
- "deidentification_limitations_purpose_val": {
- "type": "string"
- },
- "deidentification_limitations_requirements_val": {
- "type": "string"
- },
- "designated_record_set_provider_maintains": {
- "type": "boolean"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_aggregation_limitations": {
- "type": "boolean"
- },
- "include_deidentification_limitations": {
- "type": "boolean"
- },
- "include_limitations": {
- "type": "boolean"
- },
- "include_offshore_limitations": {
- "type": "boolean"
- },
- "include_subcontract_limitations": {
- "type": "boolean"
- },
- "offshore_limitations_permitted": {
- "type": "boolean"
- },
- "offshore_limitations_permitted_val": {
- "type": "string"
- },
- "subcontract_limitations_include_notice": {
- "type": "boolean"
- },
- "subcontract_limitations_include_permission": {
- "type": "boolean"
- },
- "subcontract_limitations_notice_val": {
- "type": "string"
- },
- "subcontract_limitations_permission_val": {
- "type": "string"
- },
- "subcontract_limitations_permitted": {
- "type": "boolean"
- },
- "underlying_agreement_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "underlying_agreement_type": {
- "enum": [
- "internal",
- "external",
- "none"
- ],
- "type": "string"
- },
- "underlying_agreement_val": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "billing_email": {
- "description": "Email of the billing contact. Used when include_billing_info is true.",
- "format": "email",
- "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
- "type": "string"
- },
- "billing_name": {
- "description": "Name of the billing contact. Used when include_billing_info is true.",
- "type": "string"
- },
- "billing_workflow_type": {
- "description": "The type of billing workflow. Use \"link\" to provide a payment_link_url, or \"stripe\" for Stripe-managed billing.",
- "enum": [
- "link",
- "stripe"
- ],
- "type": "string"
- },
- "chosen_courts_country": {
- "description": "The country in which disputes will be resolved.",
- "type": "string"
- },
- "chosen_courts_region": {
- "description": "The state or region in which disputes will be resolved.",
- "type": "string"
- },
- "csa_attributes": {
- "additionalProperties": false,
- "description": "Override csa terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "customer_description": {
- "type": "string"
- },
- "effective_date": {
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "effective_date_marketplace": {
- "enum": [
- "AWS",
- "GCP",
- "Azure"
- ],
- "type": "string"
- },
- "effective_date_type": {
- "enum": [
- "signature",
- "date",
- "marketplace_acceptance"
- ],
- "type": "string"
- },
- "general_cap_amount": {
- "type": "number"
- },
- "general_cap_amount_type": {
- "enum": [
- "preceding",
- "base",
- "period"
- ],
- "type": "string"
- },
- "general_cap_period_currency": {
- "type": "number"
- },
- "general_cap_period_qty": {
- "type": "number"
- },
- "general_cap_preceding_amount": {
- "type": "number"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_acceptable_use_policy": {
- "type": "boolean"
- },
- "include_acceptable_use_policy_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_acceptable_use_policy_location": {
- "type": "string"
- },
- "include_acceptable_use_policy_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_additional_warranties": {
- "type": "boolean"
- },
- "include_additional_warranties_by_customer": {
- "type": "string"
- },
- "include_additional_warranties_by_provider": {
- "type": "string"
- },
- "include_additional_warranties_include_by_customer": {
- "type": "boolean"
- },
- "include_additional_warranties_include_by_provider": {
- "type": "boolean"
- },
- "include_ai_addendum": {
- "type": "boolean"
- },
- "include_ai_addendum_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_covered_claims": {
- "type": "boolean"
- },
- "include_covered_claims_customer_claims": {
- "type": "string"
- },
- "include_covered_claims_include_customer_claims": {
- "type": "boolean"
- },
- "include_covered_claims_include_provider_claims": {
- "type": "boolean"
- },
- "include_covered_claims_provider_claims": {
- "type": "string"
- },
- "include_dpa": {
- "type": "boolean"
- },
- "include_dpa_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_dpa_location": {
- "type": "string"
- },
- "include_dpa_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_increased_cap_amount": {
- "type": "boolean"
- },
- "include_increased_claims": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_confidentiality": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_confidentiality_negligence": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_privsec": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_privsec_negligence": {
- "type": "boolean"
- },
- "include_increased_claims_include_other": {
- "type": "boolean"
- },
- "include_increased_claims_indemnification_obligation": {
- "type": "boolean"
- },
- "include_increased_claims_other": {
- "type": "string"
- },
- "include_insurance_minimums": {
- "type": "boolean"
- },
- "include_insurance_minimums_add_customer": {
- "type": "boolean"
- },
- "include_insurance_minimums_add_customer_com_gen_liability": {
- "type": "boolean"
- },
- "include_insurance_minimums_add_customer_cyber_liability": {
- "type": "boolean"
- },
- "include_insurance_minimums_add_customer_errors_omissions": {
- "type": "boolean"
- },
- "include_insurance_minimums_additional_information": {
- "type": "boolean"
- },
- "include_insurance_minimums_additional_information_text": {
- "type": "string"
- },
- "include_insurance_minimums_cyber_liability_aggregate": {
- "type": "number"
- },
- "include_insurance_minimums_cyber_liability_minimum": {
- "type": "number"
- },
- "include_insurance_minimums_employer_liability_aggregate": {
- "type": "number"
- },
- "include_insurance_minimums_employer_liability_minimum": {
- "type": "number"
- },
- "include_insurance_minimums_general_liability_aggregate": {
- "type": "number"
- },
- "include_insurance_minimums_general_liability_minimum": {
- "type": "number"
- },
- "include_insurance_minimums_include_cyber_liability": {
- "type": "boolean"
- },
- "include_insurance_minimums_include_employer_liability": {
- "type": "boolean"
- },
- "include_insurance_minimums_include_general_liability": {
- "type": "boolean"
- },
- "include_insurance_minimums_include_workers_compensation": {
- "type": "boolean"
- },
- "include_publicity_rights": {
- "type": "boolean"
- },
- "include_publicity_rights_type": {
- "enum": [
- "public",
- "non-public"
- ],
- "type": "string"
- },
- "include_security_policy": {
- "type": "boolean"
- },
- "include_security_policy_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_security_policy_fedramp_auth": {
- "type": "boolean"
- },
- "include_security_policy_hipaa": {
- "type": "boolean"
- },
- "include_security_policy_hitrust": {
- "type": "boolean"
- },
- "include_security_policy_include_annual_maintenance": {
- "type": "boolean"
- },
- "include_security_policy_include_location": {
- "type": "boolean"
- },
- "include_security_policy_include_other": {
- "type": "boolean"
- },
- "include_security_policy_include_reasonable_efforts": {
- "type": "boolean"
- },
- "include_security_policy_iso27001": {
- "type": "boolean"
- },
- "include_security_policy_location": {
- "type": "string"
- },
- "include_security_policy_other": {
- "type": "string"
- },
- "include_security_policy_pci1": {
- "type": "boolean"
- },
- "include_security_policy_pci2": {
- "type": "boolean"
- },
- "include_security_policy_penetration_testing": {
- "type": "boolean"
- },
- "include_security_policy_soc2": {
- "type": "boolean"
- },
- "include_security_policy_soc2_type2": {
- "type": "boolean"
- },
- "include_security_policy_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_supercap": {
- "description": "CSA 3.0 renamed `include_increased_cap_amount` to `include_supercap`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_increased_cap_amount`. Sending the other spelling returns a 422.",
- "type": "boolean"
- },
- "include_uncapped_claims": {
- "description": "CSA 3.0 renamed `include_unlimited_claims` to `include_uncapped_claims`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims`. Sending the other spelling returns a 422.",
- "type": "boolean"
- },
- "include_uncapped_claims_breach_of_confidentiality": {
- "description": "CSA 3.0 renamed `include_unlimited_claims_breach_of_confidentiality` to `include_uncapped_claims_breach_of_confidentiality`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_breach_of_confidentiality`. Sending the other spelling returns a 422.",
- "type": "boolean"
- },
- "include_uncapped_claims_breach_of_confidentiality_negligence": {
- "description": "CSA 3.0 renamed `include_unlimited_claims_breach_of_confidentiality_negligence` to `include_uncapped_claims_breach_of_confidentiality_negligence`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_breach_of_confidentiality_negligence`. Sending the other spelling returns a 422.",
- "type": "boolean"
- },
- "include_uncapped_claims_breach_of_privsec": {
- "description": "CSA 3.0 renamed `include_unlimited_claims_breach_of_privsec` to `include_uncapped_claims_breach_of_privsec`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_breach_of_privsec`. Sending the other spelling returns a 422.",
- "type": "boolean"
- },
- "include_uncapped_claims_breach_of_privsec_negligence": {
- "description": "CSA 3.0 renamed `include_unlimited_claims_breach_of_privsec_negligence` to `include_uncapped_claims_breach_of_privsec_negligence`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_breach_of_privsec_negligence`. Sending the other spelling returns a 422.",
- "type": "boolean"
- },
- "include_uncapped_claims_include_other": {
- "description": "CSA 3.0 renamed `include_unlimited_claims_include_other` to `include_uncapped_claims_include_other`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_include_other`. Sending the other spelling returns a 422.",
- "type": "boolean"
- },
- "include_uncapped_claims_indemnification_obligation": {
- "description": "CSA 3.0 renamed `include_unlimited_claims_indemnification_obligation` to `include_uncapped_claims_indemnification_obligation`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_indemnification_obligation`. Sending the other spelling returns a 422.",
- "type": "boolean"
- },
- "include_uncapped_claims_other": {
- "description": "CSA 3.0 renamed `include_unlimited_claims_other` to `include_uncapped_claims_other`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_other`. Sending the other spelling returns a 422.",
- "type": "boolean"
- },
- "include_unlimited_claims": {
- "type": "boolean"
- },
- "include_unlimited_claims_breach_of_confidentiality": {
- "type": "boolean"
- },
- "include_unlimited_claims_breach_of_confidentiality_negligence": {
- "type": "boolean"
- },
- "include_unlimited_claims_breach_of_privsec": {
- "type": "boolean"
- },
- "include_unlimited_claims_breach_of_privsec_negligence": {
- "type": "boolean"
- },
- "include_unlimited_claims_include_other": {
- "type": "boolean"
- },
- "include_unlimited_claims_indemnification_obligation": {
- "type": "boolean"
- },
- "include_unlimited_claims_other": {
- "type": "string"
- },
- "increased_cap_amount_currency": {
- "type": "number"
- },
- "increased_cap_amount_period_currency": {
- "type": "number"
- },
- "increased_cap_amount_period_qty": {
- "type": "number"
- },
- "increased_cap_amount_qty": {
- "type": "number"
- },
- "increased_cap_amount_type": {
- "enum": [
- "qty",
- "currency",
- "period"
- ],
- "type": "string"
- },
- "provider": {
- "type": "string"
- },
- "supercap_currency": {
- "description": "CSA 3.0 renamed `increased_cap_amount_currency` to `supercap_currency`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `increased_cap_amount_currency`. Sending the other spelling returns a 422.",
- "type": "number"
- },
- "supercap_period_currency": {
- "description": "CSA 3.0 renamed `increased_cap_amount_period_currency` to `supercap_period_currency`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `increased_cap_amount_period_currency`. Sending the other spelling returns a 422.",
- "type": "number"
- },
- "supercap_period_qty": {
- "description": "CSA 3.0 renamed `increased_cap_amount_period_qty` to `supercap_period_qty`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `increased_cap_amount_period_qty`. Sending the other spelling returns a 422.",
- "type": "number"
- },
- "supercap_qty": {
- "description": "CSA 3.0 renamed `increased_cap_amount_qty` to `supercap_qty`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `increased_cap_amount_qty`. Sending the other spelling returns a 422.",
- "type": "number"
- },
- "supercap_type": {
- "description": "CSA 3.0 renamed `increased_cap_amount_type` to `supercap_type`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `increased_cap_amount_type`. Sending the other spelling returns a 422.",
- "type": "number"
- }
- },
- "type": "object"
- },
- "csa_order_form_attributes": {
- "additionalProperties": false,
- "description": "Override csa order form terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "additional_changes": {
- "type": "string"
- },
- "additional_parameters_or_limitations": {
- "type": "string"
- },
- "affiliates_as_users": {
- "type": "boolean"
- },
- "cloud_service_description": {
- "type": "string"
- },
- "consumption_units": {
- "type": "string"
- },
- "fee_amount": {
- "type": "number"
- },
- "fee_custom_unit": {
- "type": "string"
- },
- "fee_period": {
- "enum": [
- "Subscription Period",
- "month",
- "year",
- "User",
- "Custom unit"
- ],
- "type": "string"
- },
- "fees_attributes": {
- "additionalProperties": {
- "anyOf": [
- {
- "additionalProperties": false,
- "description": "Fees::Flat (fee_type \"flat\"). A fixed recurring fee, e.g. a platform subscription. Set type to \"Fees::Flat\" or fee_type to \"flat\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "Fixed amount in the order form's fees_currency, charged per fee_period. A plain amount, not cents: 20 means 20.00.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"flat\". Alternative to type.",
- "enum": [
- "flat"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Flat\". Optional when fee_type is set.",
- "enum": [
- "Fees::Flat"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Discount (fee_type \"discount\"). A discount, as a fixed amount or a percentage, applied forever, once, or for a number of months. Set type to \"Fees::Discount\" or fee_type to \"discount\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "Discount size: an amount in fees_currency when discount_type is fixed_amount (a plain amount, not cents: 20 means 20.00), or a percentage (e.g. 10 for 10%) when it is percentage.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "discount_duration_amount": {
- "description": "Number of months the discount applies. Required when discount_duration_type is multiple_months.",
- "type": "number"
- },
- "discount_duration_type": {
- "description": "How long the discount applies. multiple_months also needs discount_duration_amount.",
- "enum": [
- "forever",
- "once",
- "multiple_months"
- ],
- "type": "string"
- },
- "discount_type": {
- "description": "Whether cost is a currency amount or a percentage.",
- "enum": [
- "fixed_amount",
- "percentage"
- ],
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"discount\". Alternative to type.",
- "enum": [
- "discount"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Discount\". Optional when fee_type is set.",
- "enum": [
- "Fees::Discount"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Cost (fee_type \"cost\"). A per-unit fee: price per unit times quantity, e.g. seats. Set type to \"Fees::Cost\" or fee_type to \"cost\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "Price per unit in fees_currency. The row total is quantity x cost. A plain amount, not cents: 20 means 20.00.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"cost\". Alternative to type.",
- "enum": [
- "cost"
- ],
- "type": "string"
- },
- "quantity": {
- "description": "Number of units.",
- "type": "number"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Cost\". Optional when fee_type is set.",
- "enum": [
- "Fees::Cost"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Attachment (fee_type \"attachment\"). A fee described in an uploaded attachment instead of in the table. Set type to \"Fees::Attachment\" or fee_type to \"attachment\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "attachment_id": {
- "description": "ID of an attachment uploaded with upload-attachment.",
- "type": "string"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"attachment\". Alternative to type.",
- "enum": [
- "attachment"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Attachment\". Optional when fee_type is set.",
- "enum": [
- "Fees::Attachment"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Graduated (fee_type \"graduated\"). Tiered pricing, with the price set per tier in graduated_fee_tiers_attributes. Set type to \"Fees::Graduated\" or fee_type to \"graduated\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"graduated\". Alternative to type.",
- "enum": [
- "graduated"
- ],
- "type": "string"
- },
- "graduated_fee_tiers_attributes": {
- "additionalProperties": {
- "additionalProperties": false,
- "properties": {
- "flat_price": {
- "type": "number"
- },
- "price_per_unit": {
- "type": "string"
- },
- "upper_limit": {
- "type": "number"
- }
- },
- "type": "object"
- },
- "description": "Graduated fee tiers. Use string keys such as \"0\", \"1\".",
- "propertyNames": {
- "type": "string"
- },
- "type": "object"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Graduated\". Optional when fee_type is set.",
- "enum": [
- "Fees::Graduated"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Included (fee_type \"included\"). An item included at no charge. Set type to \"Fees::Included\" or fee_type to \"included\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"included\". Alternative to type.",
- "enum": [
- "included"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Included\". Optional when fee_type is set.",
- "enum": [
- "Fees::Included"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Metered (fee_type \"metered\"). Usage-based pricing, billed per unit used. Set type to \"Fees::Metered\" or fee_type to \"metered\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "Price per unit of usage in fees_currency. A plain amount, not cents: 20 means 20.00.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"metered\". Alternative to type.",
- "enum": [
- "metered"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Metered\". Optional when fee_type is set.",
- "enum": [
- "Fees::Metered"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::OneTime (fee_type \"one_time\"). A one-time charge, such as a setup fee. Set type to \"Fees::OneTime\" or fee_type to \"one_time\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "One-time amount in fees_currency, charged once rather than per fee_period. A plain amount, not cents: 20 means 20.00.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"one_time\". Alternative to type.",
- "enum": [
- "one_time"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::OneTime\". Optional when fee_type is set.",
- "enum": [
- "Fees::OneTime"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Text (fee_type \"text\"). A fee term described in free text. Set type to \"Fees::Text\" or fee_type to \"text\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"text\". Alternative to type.",
- "enum": [
- "text"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Text\". Optional when fee_type is set.",
- "enum": [
- "Fees::Text"
- ],
- "type": "string"
- }
- },
- "type": "object"
- }
- ]
- },
- "description": "Fee table rows, keyed by string index (\"0\", \"1\", ...). Replaces the template's fees when provided. Each row sets type or fee_type to pick the fee class. Amounts are in the order form's fees_currency and, for recurring fees, are charged per fee_period.",
- "examples": [
- {
- "0": {
- "cost": 2000,
- "description": "Platform subscription",
- "type": "Fees::Flat"
- }
- },
- {
- "0": {
- "cost": 50,
- "description": "Seats",
- "fee_type": "cost",
- "quantity": 10
- },
- "1": {
- "cost": 10,
- "description": "Launch discount",
- "discount_duration_amount": 3,
- "discount_duration_type": "multiple_months",
- "discount_type": "percentage",
- "fee_type": "discount"
- }
- }
- ],
- "propertyNames": {
- "type": "string"
- },
- "type": "object"
- },
- "fees_currency": {
- "enum": [
- "USD",
- "EUR",
- "GBP",
- "CAD",
- "AUD",
- "SGD",
- "ILS",
- "JPY",
- "CHF",
- "HKD"
- ],
- "type": "string"
- },
- "fees_include_fee_increase_upon_renewal": {
- "type": "boolean"
- },
- "fees_include_fee_increase_upon_renewal_fee": {
- "type": "number"
- },
- "fees_include_fee_increase_upon_renewal_type": {
- "enum": [
- "will",
- "may"
- ],
- "type": "string"
- },
- "fees_inclusive_of_taxes": {
- "type": "boolean"
- },
- "framework_terms_type": {
- "enum": [
- "new",
- "existing",
- "description"
- ],
- "type": "string"
- },
- "free_trial_days": {
- "type": "number"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_additional_changes": {
- "type": "boolean"
- },
- "include_additional_parameters_or_limitations": {
- "type": "boolean"
- },
- "include_consumption": {
- "type": "boolean"
- },
- "include_fees": {
- "type": "boolean"
- },
- "include_fees_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_fees_include_attachment": {
- "type": "boolean"
- },
- "include_fees_other": {
- "type": "boolean"
- },
- "include_fees_other_val": {
- "type": "string"
- },
- "include_fees_table": {
- "type": "boolean"
- },
- "include_fees_table_period": {
- "enum": [
- "Subscription Period",
- "month",
- "year",
- "User"
- ],
- "type": "string"
- },
- "include_free_trial": {
- "type": "boolean"
- },
- "include_max_users": {
- "type": "boolean"
- },
- "include_pilot_period": {
- "type": "boolean"
- },
- "include_pilot_period_duration_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_pilot_period_duration_type": {
- "enum": [
- "day",
- "week",
- "month"
- ],
- "type": "string"
- },
- "include_pilot_period_include_fees": {
- "type": "boolean"
- },
- "include_pilot_period_include_fees_amount": {
- "type": "number"
- },
- "include_pilot_period_include_modifications": {
- "type": "boolean"
- },
- "include_pilot_period_include_modifications_description": {
- "type": "string"
- },
- "include_product_support": {
- "type": "boolean"
- },
- "include_product_support_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_product_support_description": {
- "type": "string"
- },
- "include_product_support_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_professional_services": {
- "type": "boolean"
- },
- "include_professional_services_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_professional_services_custom_name": {
- "type": "string"
- },
- "include_professional_services_description": {
- "type": "string"
- },
- "include_professional_services_end_date": {
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "include_professional_services_fees_description": {
- "type": "string"
- },
- "include_professional_services_include_end_date": {
- "type": "boolean"
- },
- "include_professional_services_include_fees_description": {
- "type": "boolean"
- },
- "include_professional_services_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_sla": {
- "type": "boolean"
- },
- "include_sla_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_sla_description": {
- "type": "string"
- },
- "include_sla_include_response_time": {
- "type": "boolean"
- },
- "include_sla_include_response_time_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_sla_include_response_time_credit": {
- "type": "number"
- },
- "include_sla_include_response_time_duration": {
- "enum": [
- "hour",
- "day",
- "week",
- "month",
- "hours"
- ],
- "type": "string"
- },
- "include_sla_include_response_time_support_channel": {
- "type": "string"
- },
- "include_sla_include_target_uptime": {
- "type": "boolean"
- },
- "include_sla_maintenance_notice": {
- "type": "boolean"
- },
- "include_sla_maintenance_window": {
- "type": "boolean"
- },
- "include_sla_maintenance_window_type": {
- "enum": [
- "standard",
- "none"
- ],
- "type": "string"
- },
- "include_sla_standard_maintenance_notice_qty": {
- "type": "number"
- },
- "include_sla_standard_maintenance_notice_unit": {
- "enum": [
- "hour",
- "day",
- "week",
- "month"
- ],
- "type": "string"
- },
- "include_sla_standard_maintenance_window_end_time": {
- "type": "string"
- },
- "include_sla_standard_maintenance_window_friday": {
- "type": "boolean"
- },
- "include_sla_standard_maintenance_window_monday": {
- "type": "boolean"
- },
- "include_sla_standard_maintenance_window_saturday": {
- "type": "boolean"
- },
- "include_sla_standard_maintenance_window_start_time": {
- "type": "string"
- },
- "include_sla_standard_maintenance_window_sunday": {
- "type": "boolean"
- },
- "include_sla_standard_maintenance_window_thursday": {
- "type": "boolean"
- },
- "include_sla_standard_maintenance_window_time_zone": {
- "type": "string"
- },
- "include_sla_standard_maintenance_window_tuesday": {
- "type": "boolean"
- },
- "include_sla_standard_maintenance_window_wednesday": {
- "type": "boolean"
- },
- "include_sla_standard_target_uptime": {
- "type": "number"
- },
- "include_sla_type": {
- "enum": [
- "description",
- "standard",
- "attachment"
- ],
- "type": "string"
- },
- "include_subscription_start_date": {
- "type": "boolean"
- },
- "include_subscription_start_date_date": {
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "include_usage_review": {
- "type": "boolean"
- },
- "include_usage_review_val": {
- "type": "string"
- },
- "include_use_limitations": {
- "type": "boolean"
- },
- "include_use_limitations_val": {
- "type": "string"
- },
- "invoice_period": {
- "enum": [
- "monthly",
- "quarterly",
- "semiannually",
- "annually",
- "Custom unit",
- "Monthly",
- "Quarterly",
- "Semiannually",
- "Annually"
- ],
- "type": "string"
- },
- "invoice_period_custom_unit": {
- "type": "string"
- },
- "max_consumption": {
- "type": "number"
- },
- "max_users": {
- "type": "number"
- },
- "negotiations_allowed": {
- "description": "When true, the recipient can propose changes to the order form, even when the agreement-level `negotiations_allowed` is false. This only covers the order form.",
- "type": "boolean"
- },
- "order_date_date": {
- "type": "string"
- },
- "order_date_other": {
- "type": "string"
- },
- "order_date_type": {
- "enum": [
- "signature",
- "date",
- "other"
- ],
- "type": "string"
- },
- "payment_period": {
- "type": "number"
- },
- "payment_period_timeframe": {
- "enum": [
- "Customer's receipt of invoice",
- "date of invoice"
- ],
- "type": "string"
- },
- "payment_period_unit": {
- "enum": [
- "day(s)",
- "week(s)",
- "month(s)",
- "marketplace_acceptance"
- ],
- "type": "string"
- },
- "payment_process_automatic_frequency": {
- "enum": [
- "monthly",
- "quarterly",
- "semiannually",
- "annually"
- ],
- "type": "string"
- },
- "payment_process_type": {
- "enum": [
- "automatic",
- "invoice",
- "custom",
- "marketplace_acceptance"
- ],
- "type": "string"
- },
- "payment_process_type_custom_val": {
- "type": "string"
- },
- "payment_process_type_invoice_amount": {
- "type": "number"
- },
- "payment_process_type_invoice_custom_unit": {
- "type": "string"
- },
- "payment_process_type_invoice_duration": {
- "enum": [
- "day",
- "week",
- "month",
- "year",
- "day(s)",
- "week(s)",
- "month(s)",
- "year(s)"
- ],
- "type": "string"
- },
- "payment_process_type_invoice_duration_start": {
- "enum": [
- "Customer's receipt of invoice",
- "date of invoice"
- ],
- "type": "string"
- },
- "payment_process_type_invoice_type": {
- "enum": [
- "monthly",
- "quarterly",
- "semiannually",
- "annually",
- "Custom unit"
- ],
- "type": "string"
- },
- "pilot_period_stripe_product_id": {
- "type": "string"
- },
- "service_credits_attributes": {
- "additionalProperties": {
- "additionalProperties": false,
- "properties": {
- "credit": {
- "type": "number"
- },
- "max": {
- "type": "number"
- },
- "min": {
- "type": "number"
- }
- },
- "type": "object"
- },
- "description": "Service credits. Use string keys such as \"0\", \"1\".",
- "propertyNames": {
- "type": "string"
- },
- "type": "object"
- },
- "subscription_auto_renew": {
- "enum": [
- "days",
- "subscription_end"
- ],
- "type": "string"
- },
- "subscription_period": {
- "type": "number"
- },
- "subscription_period_unit": {
- "type": "string"
- },
- "subscription_renewal_notice_days": {
- "type": "number"
- },
- "subscription_start_date": {
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "subscription_start_date_type": {
- "enum": [
- "effective_date",
- "date"
- ],
- "type": "string"
- },
- "underlying_agreement_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "use_limitations_attributes": {
- "additionalProperties": {
- "additionalProperties": false,
- "properties": {
- "amount": {
- "type": "number"
- },
- "limitation_type": {
- "type": "string"
- },
- "unit": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "description": "Use limitations. Use string keys such as \"0\", \"1\".",
- "propertyNames": {
- "type": "string"
- },
- "type": "object"
- }
- },
- "type": "object"
- },
- "custom_field_values": {
- "description": "Values for a custom template's fields, keyed by the field keys defined in the template's YAML definition. Only used when template_id is a custom template. Template defaults fill any fields you omit; a required field with no default and no submitted value returns a 400 naming the field. Values are validated against the field's input type: select and radio values must be one of the field's options, multiselect values are an array of selections each of which must be one of the field's options, number and currency values must be numeric, date values must be YYYY-MM-DD, and email values must be valid addresses. An invalid value returns a 400 naming the field."
- },
- "design_partner_attributes": {
- "additionalProperties": false,
- "description": "Override design partner terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "customer_description": {
- "type": "string"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_fees": {
- "type": "boolean"
- },
- "include_fees_amount": {
- "type": "number"
- },
- "include_fees_description": {
- "type": "string"
- },
- "include_fees_pay_by_amount": {
- "type": "string"
- },
- "include_fees_type": {
- "enum": [
- "default_language",
- "description"
- ],
- "type": "string"
- },
- "include_fees_unit": {
- "enum": [
- "month",
- "quarter",
- "year",
- "Term"
- ],
- "type": "string"
- },
- "include_program_appear_as_customer_private": {
- "type": "boolean"
- },
- "include_program_appear_as_customer_public": {
- "type": "boolean"
- },
- "include_program_case_study": {
- "type": "boolean"
- },
- "include_program_develop_functionality": {
- "type": "boolean"
- },
- "include_program_develop_functionality_val": {
- "type": "string"
- },
- "include_program_discount": {
- "type": "boolean"
- },
- "include_program_discount_amount": {
- "type": "number"
- },
- "include_program_discount_unit": {
- "enum": [
- "U.S. Dollars",
- "percent"
- ],
- "type": "string"
- },
- "include_program_participation_feedback": {
- "type": "boolean"
- },
- "include_program_participation_feedback_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_program_participation_feedback_unit": {
- "enum": [
- "month",
- "quarter",
- "year",
- "Term"
- ],
- "type": "string"
- },
- "include_program_partner_other": {
- "type": "boolean"
- },
- "include_program_partner_other_val": {
- "type": "string"
- },
- "include_program_provider_other": {
- "type": "boolean"
- },
- "include_program_provider_other_val": {
- "type": "string"
- },
- "include_program_reference": {
- "type": "boolean"
- },
- "product_description": {
- "type": "string"
- },
- "term_amount": {
- "type": "number"
- },
- "term_unit": {
- "enum": [
- "day(s)",
- "week(s)",
- "month(s)",
- "quarter(s)",
- "year(s)"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- "district_or_county": {
- "description": "The district or county for dispute resolution.",
- "type": "string"
- },
- "dpa_attributes": {
- "additionalProperties": false,
- "description": "Override dpa terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "approved_subprocessor_type": {
- "description": "`internal` lists approved subprocessors in the agreement (`subprocessors_attributes`); `external` points to a list published elsewhere.",
- "enum": [
- "internal",
- "external"
- ],
- "type": "string"
- },
- "cloud_service_product_name": {
- "type": "string"
- },
- "competent_supervisory_authority": {
- "type": "string"
- },
- "customer_description": {
- "type": "string"
- },
- "data_exporter_address_city": {
- "type": "string"
- },
- "data_exporter_address_country": {
- "type": "string"
- },
- "data_exporter_address_state": {
- "type": "string"
- },
- "data_exporter_address_street_address": {
- "type": "string"
- },
- "data_exporter_address_zipcode": {
- "type": "string"
- },
- "data_exporter_contact_details": {
- "type": "string"
- },
- "data_exporter_contact_name": {
- "type": "string"
- },
- "data_exporter_contact_position": {
- "type": "string"
- },
- "data_exporter_role": {
- "description": "Role of the data exporter. Overwritten to `Controller` when the agreement is created from a template.",
- "enum": [
- "Controller",
- "Processor"
- ],
- "type": "string"
- },
- "data_importer_address": {
- "type": "string"
- },
- "data_importer_address_city": {
- "type": "string"
- },
- "data_importer_address_country": {
- "type": "string"
- },
- "data_importer_address_state": {
- "type": "string"
- },
- "data_importer_address_street_address": {
- "type": "string"
- },
- "data_importer_address_zipcode": {
- "type": "string"
- },
- "data_importer_contact_details": {
- "type": "string"
- },
- "data_importer_contact_name": {
- "type": "string"
- },
- "data_importer_contact_position": {
- "type": "string"
- },
- "duration_of_processing": {
- "type": "string"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_covered_claim": {
- "type": "boolean"
- },
- "include_covered_claim_external_val": {
- "type": "string"
- },
- "include_covered_claim_internal_val": {
- "type": "string"
- },
- "include_covered_claim_type": {
- "description": "Which covered-claim text applies: `internal` uses `include_covered_claim_internal_val`, `external` uses `include_covered_claim_external_val`. Required when `include_covered_claim` is true.",
- "enum": [
- "internal",
- "external"
- ],
- "type": "string"
- },
- "include_data_subjects_custom": {
- "type": "boolean"
- },
- "include_data_subjects_custom_val": {
- "type": "string"
- },
- "include_data_subjects_employees": {
- "type": "boolean"
- },
- "include_data_subjects_end_users": {
- "type": "boolean"
- },
- "include_external_subprocessor_location": {
- "type": "string"
- },
- "include_frequency_of_transfer_continuous": {
- "type": "boolean"
- },
- "include_frequency_of_transfer_custom": {
- "type": "boolean"
- },
- "include_frequency_of_transfer_custom_val": {
- "type": "string"
- },
- "include_governing_country_eu": {
- "type": "boolean"
- },
- "include_governing_country_eu_val": {
- "type": "string"
- },
- "include_governing_country_uk": {
- "type": "boolean"
- },
- "include_governing_country_uk_val": {
- "type": "string"
- },
- "include_governing_law": {
- "type": "boolean"
- },
- "include_governing_law_country": {
- "type": "string"
- },
- "include_governing_law_state": {
- "type": "string"
- },
- "include_increased_claim_amount": {
- "description": "Legacy field. Stored but not shown on the DPA; use the `include_liability_cap*` fields instead.",
- "type": "boolean"
- },
- "include_increased_claim_amount_currency": {
- "description": "Legacy field. Stored but not shown on the DPA; use the `include_liability_cap*` fields instead."
- },
- "include_increased_claim_amount_qty": {
- "description": "Legacy field. Stored but not shown on the DPA; use the `include_liability_cap*` fields instead."
- },
- "include_increased_claim_amount_type": {
- "description": "Legacy field. Stored but not shown on the DPA; use the `include_liability_cap*` fields instead.",
- "type": "string"
- },
- "include_liability_cap": {
- "type": "boolean"
- },
- "include_liability_cap_amount_constant_external": {
- "type": "string"
- },
- "include_liability_cap_amount_constant_internal": {
- "type": "string"
- },
- "include_liability_cap_amount_currency_external": {
- "description": "Currency amount. Numbers and numeric strings (commas allowed) are both accepted."
- },
- "include_liability_cap_amount_currency_internal": {
- "description": "Currency amount. Numbers and numeric strings (commas allowed) are both accepted."
- },
- "include_liability_cap_csa_type": {
- "description": "Which liability cap values apply: the `_internal` or `_external` amount fields. Required when `include_liability_cap` is true.",
- "enum": [
- "internal",
- "external"
- ],
- "type": "string"
- },
- "include_personal_data_biographic_info": {
- "type": "boolean"
- },
- "include_personal_data_contact_info": {
- "type": "boolean"
- },
- "include_personal_data_custom": {
- "type": "boolean"
- },
- "include_personal_data_custom_val": {
- "type": "string"
- },
- "include_personal_data_employment_info": {
- "type": "boolean"
- },
- "include_personal_data_financial_info": {
- "type": "boolean"
- },
- "include_personal_data_location": {
- "type": "boolean"
- },
- "include_personal_data_name": {
- "type": "boolean"
- },
- "include_personal_data_transactional_info": {
- "type": "boolean"
- },
- "include_personal_data_user_activity_info": {
- "type": "boolean"
- },
- "include_processing_purpose_custom": {
- "type": "boolean"
- },
- "include_processing_purpose_custom_val": {
- "type": "string"
- },
- "include_processing_purpose_erasing": {
- "type": "boolean"
- },
- "include_processing_purpose_holding": {
- "type": "boolean"
- },
- "include_processing_purpose_protecting": {
- "type": "boolean"
- },
- "include_processing_purpose_receiving": {
- "type": "boolean"
- },
- "include_processing_purpose_returning": {
- "type": "boolean"
- },
- "include_processing_purpose_sharing": {
- "type": "boolean"
- },
- "include_processing_purpose_updating": {
- "type": "boolean"
- },
- "include_processing_purpose_using": {
- "type": "boolean"
- },
- "include_provider_security_contact_address": {
- "type": "boolean"
- },
- "include_provider_security_contact_address_city": {
- "type": "string"
- },
- "include_provider_security_contact_address_country": {
- "type": "string"
- },
- "include_provider_security_contact_address_state": {
- "type": "string"
- },
- "include_provider_security_contact_address_street_address": {
- "type": "string"
- },
- "include_provider_security_contact_address_zipcode": {
- "type": "string"
- },
- "include_provider_security_contact_email": {
- "type": "boolean"
- },
- "include_provider_security_contact_email_val": {
- "format": "email",
- "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
- "type": "string"
- },
- "include_security_measures_accountability": {
- "type": "boolean"
- },
- "include_security_measures_accountability_val": {
- "type": "string"
- },
- "include_security_measures_certification_or_assurance": {
- "type": "boolean"
- },
- "include_security_measures_certification_or_assurance_val": {
- "type": "string"
- },
- "include_security_measures_confidentiality_integrity": {
- "type": "boolean"
- },
- "include_security_measures_confidentiality_integrity_val": {
- "type": "string"
- },
- "include_security_measures_data_at_rest": {
- "type": "boolean"
- },
- "include_security_measures_data_at_rest_val": {
- "type": "string"
- },
- "include_security_measures_data_minimization": {
- "type": "boolean"
- },
- "include_security_measures_data_minimization_val": {
- "type": "string"
- },
- "include_security_measures_data_quality": {
- "type": "boolean"
- },
- "include_security_measures_data_quality_val": {
- "type": "string"
- },
- "include_security_measures_data_retention": {
- "type": "boolean"
- },
- "include_security_measures_data_retention_val": {
- "type": "string"
- },
- "include_security_measures_data_transmission": {
- "type": "boolean"
- },
- "include_security_measures_data_transmission_val": {
- "type": "string"
- },
- "include_security_measures_event_logging": {
- "type": "boolean"
- },
- "include_security_measures_event_logging_val": {
- "type": "string"
- },
- "include_security_measures_identity_auth": {
- "type": "boolean"
- },
- "include_security_measures_identity_auth_val": {
- "type": "string"
- },
- "include_security_measures_it_security_governance": {
- "type": "boolean"
- },
- "include_security_measures_it_security_governance_val": {
- "type": "string"
- },
- "include_security_measures_physical_security": {
- "type": "boolean"
- },
- "include_security_measures_physical_security_val": {
- "type": "string"
- },
- "include_security_measures_portability_and_erasure": {
- "type": "boolean"
- },
- "include_security_measures_portability_and_erasure_val": {
- "type": "string"
- },
- "include_security_measures_pseudonym_encryption": {
- "type": "boolean"
- },
- "include_security_measures_pseudonym_encryption_val": {
- "type": "string"
- },
- "include_security_measures_restore_data_access": {
- "type": "boolean"
- },
- "include_security_measures_restore_data_access_val": {
- "type": "string"
- },
- "include_security_measures_security_policy": {
- "type": "boolean"
- },
- "include_security_measures_system_configuration": {
- "type": "boolean"
- },
- "include_security_measures_system_configuration_val": {
- "type": "string"
- },
- "include_security_measures_testing_assessment": {
- "type": "boolean"
- },
- "include_security_measures_testing_assessment_val": {
- "type": "string"
- },
- "include_security_policy": {
- "type": "boolean"
- },
- "include_security_policy_fedramp_auth": {
- "type": "boolean"
- },
- "include_security_policy_hipaa": {
- "type": "boolean"
- },
- "include_security_policy_hitrust": {
- "type": "boolean"
- },
- "include_security_policy_include_other": {
- "type": "boolean"
- },
- "include_security_policy_iso27001": {
- "type": "boolean"
- },
- "include_security_policy_other": {
- "type": "string"
- },
- "include_security_policy_pci1": {
- "type": "boolean"
- },
- "include_security_policy_pci2": {
- "type": "boolean"
- },
- "include_security_policy_penetration_testing": {
- "type": "boolean"
- },
- "include_security_policy_soc2": {
- "type": "boolean"
- },
- "include_security_policy_soc2_type2": {
- "type": "boolean"
- },
- "include_sensitive_data_restrictions_custom": {
- "type": "boolean"
- },
- "include_sensitive_data_restrictions_custom_val": {
- "type": "string"
- },
- "include_sensitive_data_restrictions_security_policy": {
- "type": "boolean"
- },
- "include_service_provider_relationship": {
- "type": "boolean"
- },
- "include_special_category_data": {
- "type": "boolean"
- },
- "provider": {
- "type": "string"
- },
- "security_policy_available_at": {
- "type": "string"
- },
- "security_policy_type": {
- "description": "Where the Security Policy is defined. For `external`, set `security_policy_available_at`.",
- "enum": [
- "defined in agreement",
- "provider service",
- "external"
- ],
- "type": "string"
- },
- "subprocessors_attributes": {
- "additionalProperties": {
- "additionalProperties": false,
- "properties": {
- "_destroy": {
- "description": "Set to true with `id` to remove that subprocessor.",
- "type": "boolean"
- },
- "country": {
- "type": "string"
- },
- "id": {
- "description": "ID of an existing subprocessor to update or remove. Omit to add a new subprocessor.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "name": {
- "type": "string"
- },
- "processing_task": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "description": "Subprocessors, keyed by string index such as \"0\", \"1\". On create these are added to the template's subprocessors. On a draft update, an entry without `id` adds a new subprocessor; pass `id` to change one and `id` with `_destroy: true` to remove one.",
- "propertyNames": {
- "type": "string"
- },
- "type": "object"
- },
- "underlying_agreement_id": {
- "description": "ID of the CSA this DPA supplements when `underlying_agreement_type` is `internal`.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "underlying_agreement_type": {
- "description": "`internal` links a CSA in Common Paper (`underlying_agreement_id`); `external` describes another agreement in `underlying_agreement_val` (required). Omit for none.",
- "enum": [
- "internal",
- "external"
- ],
- "type": "string"
- },
- "underlying_agreement_val": {
- "description": "Description of the agreement this DPA supplements. Required when `underlying_agreement_type` is `external`.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "framework_terms_description": {
- "description": "Custom framework terms description. Only used when framework_terms_type is \"description\".",
- "type": "string"
- },
- "framework_terms_type": {
- "description": "How framework terms are specified. Use \"new\" for standard terms or \"description\" to provide a custom framework_terms_description.",
- "enum": [
- "new",
- "description"
- ],
- "type": "string"
- },
- "governing_law_country": {
- "description": "The country whose laws govern the agreement.",
- "type": "string"
- },
- "governing_law_region": {
- "description": "The state or region whose laws govern the agreement.",
- "type": "string"
- },
- "include_automated_payment_reminders": {
- "description": "When true, automatically sends payment reminder emails.",
- "type": "boolean"
- },
- "include_billing_info": {
- "description": "When true, billing contact information (billing_name, billing_email) is included.",
- "type": "boolean"
- },
- "include_billing_workflow": {
- "description": "When true, enables a billing workflow after signing.",
- "type": "boolean"
- },
- "include_expiration_date": {
- "description": "Expiration date in YYYY-MM-DD format. Use when include_expiration_type is \"date\".",
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "include_expiration_days": {
- "description": "Number of days until the agreement expires. Use when include_expiration_type is \"days\".",
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_expiration_type": {
- "description": "How to set expiration: \"none\" (default), \"days\" (use include_expiration_days), or \"date\" (use include_expiration_date).",
- "enum": [
- "none",
- "days",
- "date"
- ],
- "type": "string"
- },
- "include_terms": {
- "description": "When true, the standard terms are included with the agreement.",
- "type": "boolean"
- },
- "loi_attributes": {
- "additionalProperties": false,
- "description": "Override loi terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "confidentiality_custom": {
- "type": "string"
- },
- "confidentiality_mutual_include_loi": {
- "type": "boolean"
- },
- "confidentiality_nda_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "confidentiality_nda_description": {
- "type": "string"
- },
- "confidentiality_nda_include_loi": {
- "type": "boolean"
- },
- "confidentiality_nda_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "confidentiality_type": {
- "enum": [
- "mutual",
- "nda",
- "provider",
- "custom"
- ],
- "type": "string"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_custom_details": {
- "type": "boolean"
- },
- "include_custom_details_val": {
- "type": "string"
- },
- "include_fees": {
- "type": "boolean"
- },
- "include_fees_amount": {
- "type": "number"
- },
- "include_fees_amount_duration": {
- "enum": [
- "month",
- "year",
- "quarter"
- ],
- "type": "string"
- },
- "include_fees_include_amount": {
- "type": "boolean"
- },
- "include_fees_include_other": {
- "type": "boolean"
- },
- "include_fees_other": {
- "type": "string"
- },
- "include_functionality": {
- "type": "boolean"
- },
- "include_functionality_val": {
- "type": "string"
- },
- "include_launch_date": {
- "type": "boolean"
- },
- "include_launch_date_custom": {
- "type": "string"
- },
- "include_launch_date_date": {
- "format": "date-time",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$",
- "type": "string"
- },
- "include_launch_date_type": {
- "enum": [
- "date",
- "custom"
- ],
- "type": "string"
- },
- "product_name": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "manual_send": {
- "description": "When true, the agreement is marked as manually sent outside the platform.",
- "type": "boolean"
- },
- "message": {
- "type": "string"
- },
- "negotiations_allowed": {
- "description": "When true, the recipient can propose changes to the legal terms. For agreement types without separate business terms, that covers every term. CSA order forms, PSA statements of work, partnership business terms and software license order forms have their own `negotiations_allowed` flag.",
- "type": "boolean"
- },
- "partnership_attributes": {
- "additionalProperties": false,
- "description": "Override partnership terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "effective_date": {
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "effective_date_type": {
- "enum": [
- "signature",
- "date"
- ],
- "type": "string"
- },
- "general_cap_amount_currency_val": {
- "type": "number"
- },
- "general_cap_amount_either_currency": {
- "type": "number"
- },
- "general_cap_amount_either_multiple": {
- "type": "number"
- },
- "general_cap_amount_multiple_val": {
- "type": "number"
- },
- "general_cap_amount_type": {
- "enum": [
- "multiple",
- "currency",
- "either",
- "base"
- ],
- "type": "string"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_additional_warranties": {
- "type": "boolean"
- },
- "include_additional_warranties_include_company": {
- "type": "boolean"
- },
- "include_additional_warranties_include_company_val": {
- "type": "string"
- },
- "include_additional_warranties_include_partner": {
- "type": "boolean"
- },
- "include_additional_warranties_include_partner_val": {
- "type": "string"
- },
- "include_brand_guidelines": {
- "type": "boolean"
- },
- "include_brand_guidelines_include_company": {
- "type": "boolean"
- },
- "include_brand_guidelines_include_company_val": {
- "type": "string"
- },
- "include_brand_guidelines_include_partner": {
- "type": "boolean"
- },
- "include_brand_guidelines_include_partner_val": {
- "type": "string"
- },
- "include_covered_claims": {
- "type": "boolean"
- },
- "include_covered_claims_company_claims": {
- "type": "string"
- },
- "include_covered_claims_include_company_claims": {
- "type": "boolean"
- },
- "include_covered_claims_include_partner_claims": {
- "type": "boolean"
- },
- "include_covered_claims_partner_claims": {
- "type": "string"
- },
- "include_dpa": {
- "type": "boolean"
- },
- "include_dpa_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_dpa_location": {
- "type": "string"
- },
- "include_dpa_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_increased_cap_amount": {
- "type": "boolean"
- },
- "include_increased_cap_amount_currency": {
- "type": "number"
- },
- "include_increased_cap_amount_either_currency": {
- "type": "number"
- },
- "include_increased_cap_amount_either_multiple": {
- "type": "string"
- },
- "include_increased_cap_amount_multiple": {
- "type": "string"
- },
- "include_increased_cap_amount_type": {
- "enum": [
- "multiple",
- "currency",
- "either"
- ],
- "type": "string"
- },
- "include_increased_claims": {
- "type": "boolean"
- },
- "include_increased_claims_include_confidentiality": {
- "type": "boolean"
- },
- "include_increased_claims_include_confidentiality_misconduct": {
- "type": "boolean"
- },
- "include_increased_claims_include_covered_claims": {
- "type": "boolean"
- },
- "include_increased_claims_include_misconduct": {
- "type": "boolean"
- },
- "include_increased_claims_include_other": {
- "type": "boolean"
- },
- "include_increased_claims_include_other_val": {
- "type": "string"
- },
- "include_unlimited_claims": {
- "type": "boolean"
- },
- "include_unlimited_claims_confidentiality": {
- "type": "boolean"
- },
- "include_unlimited_claims_confidentiality_misconduct": {
- "type": "boolean"
- },
- "include_unlimited_claims_covered_claims": {
- "type": "boolean"
- },
- "include_unlimited_claims_misconduct": {
- "type": "boolean"
- },
- "include_unlimited_claims_other": {
- "type": "boolean"
- },
- "include_unlimited_claims_other_val": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "partnership_business_terms_attributes": {
- "additionalProperties": false,
- "description": "Override partnership business terms terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "end_date_after_effective_date_amount": {
- "type": "number"
- },
- "end_date_after_effective_date_unit": {
- "enum": [
- "month(s)",
- "quarter(s)",
- "year(s)"
- ],
- "type": "string"
- },
- "end_date_date": {
- "type": "string"
- },
- "end_date_type": {
- "enum": [
- "date",
- "effective date"
- ],
- "type": "string"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_obligations_company_brand": {
- "type": "boolean"
- },
- "include_obligations_company_promotion": {
- "type": "boolean"
- },
- "include_obligations_company_promotion_include_activities": {
- "type": "boolean"
- },
- "include_obligations_company_promotion_include_activities_val": {
- "type": "string"
- },
- "include_obligations_company_promotion_include_materials": {
- "type": "boolean"
- },
- "include_obligations_company_promotion_include_materials_val": {
- "type": "string"
- },
- "include_obligations_company_referral": {
- "type": "boolean"
- },
- "include_obligations_company_referral_include_criteria": {
- "type": "boolean"
- },
- "include_obligations_company_referral_include_criteria_val": {
- "type": "string"
- },
- "include_obligations_company_referral_include_pay_sch": {
- "type": "boolean"
- },
- "include_obligations_company_referral_include_pay_sch_amount": {
- "type": "number"
- },
- "include_obligations_company_referral_include_pay_sch_custom": {
- "type": "string"
- },
- "include_obligations_company_referral_include_pay_sch_unit": {
- "enum": [
- "U.S. Dollars",
- "percent"
- ],
- "type": "string"
- },
- "include_obligations_company_sponsorship": {
- "type": "boolean"
- },
- "include_obligations_company_sponsorship_include_benefits": {
- "type": "boolean"
- },
- "include_obligations_company_sponsorship_include_benefits_val": {
- "type": "string"
- },
- "include_obligations_company_sponsorship_include_payments": {
- "type": "boolean"
- },
- "include_obligations_company_sponsorship_include_payments_amount": {
- "type": "number"
- },
- "include_obligations_company_sponsorship_include_payments_unit": {
- "enum": [
- "U.S. Dollars",
- "percent"
- ],
- "type": "string"
- },
- "include_obligations_partner_brand": {
- "type": "boolean"
- },
- "include_obligations_partner_promotion": {
- "type": "boolean"
- },
- "include_obligations_partner_promotion_include_activities": {
- "type": "boolean"
- },
- "include_obligations_partner_promotion_include_activities_val": {
- "type": "string"
- },
- "include_obligations_partner_promotion_include_materials": {
- "type": "boolean"
- },
- "include_obligations_partner_promotion_include_materials_val": {
- "type": "string"
- },
- "include_obligations_partner_referral": {
- "type": "boolean"
- },
- "include_obligations_partner_referral_include_criteria": {
- "type": "boolean"
- },
- "include_obligations_partner_referral_include_criteria_val": {
- "type": "string"
- },
- "include_obligations_partner_referral_include_pay_sch": {
- "type": "boolean"
- },
- "include_obligations_partner_referral_include_pay_sch_amount": {
- "type": "number"
- },
- "include_obligations_partner_referral_include_pay_sch_custom": {
- "type": "string"
- },
- "include_obligations_partner_referral_include_pay_sch_unit": {
- "enum": [
- "U.S. Dollars",
- "percent"
- ],
- "type": "string"
- },
- "include_obligations_partner_sponsorship": {
- "type": "boolean"
- },
- "include_obligations_partner_sponsorship_include_benefits": {
- "type": "boolean"
- },
- "include_obligations_partner_sponsorship_include_benefits_val": {
- "type": "string"
- },
- "include_obligations_partner_sponsorship_include_payments": {
- "type": "boolean"
- },
- "include_obligations_partner_sponsorship_include_payments_amount": {
- "type": "number"
- },
- "include_obligations_partner_sponsorship_include_payments_unit": {
- "enum": [
- "U.S. Dollars",
- "percent"
- ],
- "type": "string"
- },
- "include_payment_process": {
- "type": "boolean"
- },
- "include_payment_process_company": {
- "type": "boolean"
- },
- "include_payment_process_company_include_address": {
- "type": "boolean"
- },
- "include_payment_process_company_include_address_city": {
- "type": "string"
- },
- "include_payment_process_company_include_address_country": {
- "type": "string"
- },
- "include_payment_process_company_include_address_state": {
- "type": "string"
- },
- "include_payment_process_company_include_address_street_address": {
- "type": "string"
- },
- "include_payment_process_company_include_address_zipcode": {
- "type": "string"
- },
- "include_payment_process_company_include_email": {
- "type": "boolean"
- },
- "include_payment_process_company_include_email_val": {
- "type": "string"
- },
- "include_payment_process_partner": {
- "type": "boolean"
- },
- "include_payment_process_partner_include_address": {
- "type": "boolean"
- },
- "include_payment_process_partner_include_address_city": {
- "type": "string"
- },
- "include_payment_process_partner_include_address_country": {
- "type": "string"
- },
- "include_payment_process_partner_include_address_state": {
- "type": "string"
- },
- "include_payment_process_partner_include_address_street_address": {
- "type": "string"
- },
- "include_payment_process_partner_include_address_zipcode": {
- "type": "string"
- },
- "include_payment_process_partner_include_email": {
- "type": "boolean"
- },
- "include_payment_process_partner_include_email_val": {
- "type": "string"
- },
- "include_payment_schedule": {
- "type": "boolean"
- },
- "include_payment_schedule_custom": {
- "type": "string"
- },
- "include_payment_schedule_specified_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_payment_schedule_specified_timeframe": {
- "enum": [
- "receipt",
- "date"
- ],
- "type": "string"
- },
- "include_payment_schedule_specified_unit": {
- "enum": [
- "day(s)",
- "week(s)",
- "month(s)",
- "quarter(s)",
- "year(s)"
- ],
- "type": "string"
- },
- "include_payment_schedule_type": {
- "enum": [
- "specified",
- "custom"
- ],
- "type": "string"
- },
- "negotiations_allowed": {
- "description": "When true, the recipient can propose changes to the business terms, even when the agreement-level `negotiations_allowed` is false. This only covers the business terms.",
- "type": "boolean"
- },
- "territory_type": {
- "enum": [
- "worldwide",
- "custom"
- ],
- "type": "string"
- },
- "territory_type_val": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "payment_link_url": {
- "description": "A payment URL shown to the recipient after signing. Requires include_billing_workflow to be true and billing_workflow_type to be \"link\".",
- "type": "string"
- },
- "pilot_attributes": {
- "additionalProperties": false,
- "description": "Override pilot terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "fees_type": {
- "enum": [
- "free",
- "pilot_period_fees"
- ],
- "type": "string"
- },
- "general_cap_amount": {
- "type": "number"
- },
- "general_cap_amount_type": {
- "enum": [
- "preceding",
- "base",
- "period"
- ],
- "type": "string"
- },
- "general_cap_period_currency": {
- "type": "number"
- },
- "general_cap_period_qty": {
- "type": "number"
- },
- "general_cap_preceding_amount": {
- "type": "number"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_dpa": {
- "type": "boolean"
- },
- "include_dpa_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_dpa_location": {
- "type": "string"
- },
- "include_dpa_type": {
- "enum": [
- "description",
- "attachment",
- "standard"
- ],
- "type": "string"
- },
- "include_payment_process": {
- "type": "boolean"
- },
- "include_technical_support": {
- "type": "boolean"
- },
- "payment_process_automatic_frequency": {
- "enum": [
- "monthly",
- "quarterly",
- "annually",
- "once_per_period"
- ],
- "type": "string"
- },
- "payment_process_invoice_days": {
- "type": "number"
- },
- "payment_process_invoice_from": {
- "enum": [
- "receipt",
- "date"
- ],
- "type": "string"
- },
- "payment_process_invoice_timeframe": {
- "enum": [
- "days",
- "weeks",
- "months",
- "quarters",
- "years"
- ],
- "type": "string"
- },
- "payment_process_type": {
- "enum": [
- "automatic",
- "invoice"
- ],
- "type": "string"
- },
- "pilot_period_description": {
- "type": "string"
- },
- "pilot_period_fees_description": {
- "type": "string"
- },
- "product_description": {
- "type": "string"
- },
- "technical_support_description": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "psa_attributes": {
- "additionalProperties": false,
- "description": "Override psa terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "additional_changes": {
- "type": "string"
- },
- "customer_description": {
- "type": "string"
- },
- "effective_date": {
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "effective_date_type": {
- "enum": [
- "signature",
- "date"
- ],
- "type": "string"
- },
- "general_cap_amount": {
- "type": "number"
- },
- "general_cap_amount_type": {
- "enum": [
- "preceding",
- "base",
- "period"
- ],
- "type": "string"
- },
- "general_cap_period_currency": {
- "type": "number"
- },
- "general_cap_period_qty": {
- "type": "number"
- },
- "general_cap_preceding_amount": {
- "type": "number"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_additional_changes": {
- "type": "boolean"
- },
- "include_additional_warranties": {
- "type": "boolean"
- },
- "include_additional_warranties_by_customer": {
- "type": "string"
- },
- "include_additional_warranties_by_provider": {
- "type": "string"
- },
- "include_additional_warranties_include_by_customer": {
- "type": "boolean"
- },
- "include_additional_warranties_include_by_provider": {
- "type": "boolean"
- },
- "include_covered_claims": {
- "type": "boolean"
- },
- "include_covered_claims_customer_claims": {
- "type": "string"
- },
- "include_covered_claims_include_customer_claims": {
- "type": "boolean"
- },
- "include_covered_claims_include_provider_claims": {
- "type": "boolean"
- },
- "include_covered_claims_provider_claims": {
- "type": "string"
- },
- "include_customer_insurance_min": {
- "type": "boolean"
- },
- "include_customer_insurance_min_add_provider_com_gen_liability": {
- "type": "boolean"
- },
- "include_customer_insurance_min_add_provider_cyber_liability": {
- "type": "boolean"
- },
- "include_customer_insurance_min_add_provider_errors_omissions": {
- "type": "boolean"
- },
- "include_customer_insurance_min_auto_liability_aggregate": {
- "type": "number"
- },
- "include_customer_insurance_min_auto_liability_minimum": {
- "type": "number"
- },
- "include_customer_insurance_min_cyber_liability_aggregate": {
- "type": "number"
- },
- "include_customer_insurance_min_cyber_liability_minimum": {
- "type": "number"
- },
- "include_customer_insurance_min_employer_liability_aggregate": {
- "type": "number"
- },
- "include_customer_insurance_min_employer_liability_minimum": {
- "type": "number"
- },
- "include_customer_insurance_min_general_liability_aggregate": {
- "type": "number"
- },
- "include_customer_insurance_min_general_liability_minimum": {
- "type": "number"
- },
- "include_customer_insurance_min_include_add_provider": {
- "type": "boolean"
- },
- "include_customer_insurance_min_include_auto_liability": {
- "type": "boolean"
- },
- "include_customer_insurance_min_include_cyber_liability": {
- "type": "boolean"
- },
- "include_customer_insurance_min_include_employer_liability": {
- "type": "boolean"
- },
- "include_customer_insurance_min_include_general_liability": {
- "type": "boolean"
- },
- "include_customer_insurance_min_include_workers_comp": {
- "type": "boolean"
- },
- "include_customer_policies": {
- "type": "boolean"
- },
- "include_customer_policies_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_customer_policies_location": {
- "type": "string"
- },
- "include_customer_policies_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_dpa": {
- "type": "boolean"
- },
- "include_dpa_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_dpa_location": {
- "type": "string"
- },
- "include_dpa_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_increased_cap_amount": {
- "type": "boolean"
- },
- "include_increased_claims": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_confidentiality": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_confidentiality_negligence": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_privsec": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_privsec_negligence": {
- "type": "boolean"
- },
- "include_increased_claims_include_other": {
- "type": "boolean"
- },
- "include_increased_claims_indemnification_obligation": {
- "type": "boolean"
- },
- "include_increased_claims_negligence": {
- "type": "boolean"
- },
- "include_increased_claims_other": {
- "type": "string"
- },
- "include_provider_insurance_min": {
- "type": "boolean"
- },
- "include_provider_insurance_min_add_customer_com_gen_liability": {
- "type": "boolean"
- },
- "include_provider_insurance_min_add_customer_cyber_liability": {
- "type": "boolean"
- },
- "include_provider_insurance_min_add_customer_errors_omissions": {
- "type": "boolean"
- },
- "include_provider_insurance_min_auto_liability_aggregate": {
- "type": "number"
- },
- "include_provider_insurance_min_auto_liability_minimum": {
- "type": "number"
- },
- "include_provider_insurance_min_cyber_liability_aggregate": {
- "type": "number"
- },
- "include_provider_insurance_min_cyber_liability_minimum": {
- "type": "number"
- },
- "include_provider_insurance_min_employer_liability_aggregate": {
- "type": "number"
- },
- "include_provider_insurance_min_employer_liability_minimum": {
- "type": "number"
- },
- "include_provider_insurance_min_general_liability_aggregate": {
- "type": "number"
- },
- "include_provider_insurance_min_general_liability_minimum": {
- "type": "number"
- },
- "include_provider_insurance_min_include_add_customer": {
- "type": "boolean"
- },
- "include_provider_insurance_min_include_auto_liability": {
- "type": "boolean"
- },
- "include_provider_insurance_min_include_cyber_liability": {
- "type": "boolean"
- },
- "include_provider_insurance_min_include_employer_liability": {
- "type": "boolean"
- },
- "include_provider_insurance_min_include_general_liability": {
- "type": "boolean"
- },
- "include_provider_insurance_min_include_workers_comp": {
- "type": "boolean"
- },
- "include_publicity_rights": {
- "type": "boolean"
- },
- "include_publicity_rights_type": {
- "enum": [
- "public",
- "non-public"
- ],
- "type": "string"
- },
- "include_security_policy": {
- "type": "boolean"
- },
- "include_security_policy_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_security_policy_fedramp_auth": {
- "type": "boolean"
- },
- "include_security_policy_hitrust": {
- "type": "boolean"
- },
- "include_security_policy_include_annual_maintenance": {
- "type": "boolean"
- },
- "include_security_policy_include_other": {
- "type": "boolean"
- },
- "include_security_policy_include_other_val": {
- "type": "string"
- },
- "include_security_policy_iso27001": {
- "type": "boolean"
- },
- "include_security_policy_location": {
- "type": "string"
- },
- "include_security_policy_pci1": {
- "type": "boolean"
- },
- "include_security_policy_pci2": {
- "type": "boolean"
- },
- "include_security_policy_penetration_testing": {
- "type": "boolean"
- },
- "include_security_policy_soc2_type1": {
- "type": "boolean"
- },
- "include_security_policy_soc2_type2": {
- "type": "boolean"
- },
- "include_security_policy_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_unlimited_claims": {
- "type": "boolean"
- },
- "include_unlimited_claims_breach_of_confidentiality": {
- "type": "boolean"
- },
- "include_unlimited_claims_breach_of_confidentiality_negligence": {
- "type": "boolean"
- },
- "include_unlimited_claims_breach_of_privsec": {
- "type": "boolean"
- },
- "include_unlimited_claims_breach_of_privsec_negligence": {
- "type": "boolean"
- },
- "include_unlimited_claims_include_other": {
- "type": "boolean"
- },
- "include_unlimited_claims_indemnification_obligation": {
- "type": "boolean"
- },
- "include_unlimited_claims_negligence": {
- "type": "boolean"
- },
- "include_unlimited_claims_other": {
- "type": "string"
- },
- "increased_cap_amount_currency": {
- "type": "number"
- },
- "increased_cap_amount_period_currency": {
- "type": "number"
- },
- "increased_cap_amount_period_qty": {
- "type": "number"
- },
- "increased_cap_amount_qty": {
- "type": "number"
- },
- "increased_cap_amount_type": {
- "enum": [
- "qty",
- "currency",
- "period"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- "psa_statement_of_work_attributes": {
- "additionalProperties": false,
- "description": "Override psa statement of work terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "additional_changes": {
- "type": "string"
- },
- "cost": {
- "type": "number"
- },
- "description": {
- "type": "string"
- },
- "fee_type": {
- "type": "string"
- },
- "fees_attributes": {
- "additionalProperties": {
- "anyOf": [
- {
- "additionalProperties": false,
- "description": "Fees::Flat (fee_type \"flat\"). A fixed recurring fee, e.g. a platform subscription. Set type to \"Fees::Flat\" or fee_type to \"flat\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "Fixed amount in the order form's fees_currency, charged per fee_period. A plain amount, not cents: 20 means 20.00.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"flat\". Alternative to type.",
- "enum": [
- "flat"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Flat\". Optional when fee_type is set.",
- "enum": [
- "Fees::Flat"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Discount (fee_type \"discount\"). A discount, as a fixed amount or a percentage, applied forever, once, or for a number of months. Set type to \"Fees::Discount\" or fee_type to \"discount\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "Discount size: an amount in fees_currency when discount_type is fixed_amount (a plain amount, not cents: 20 means 20.00), or a percentage (e.g. 10 for 10%) when it is percentage.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "discount_duration_amount": {
- "description": "Number of months the discount applies. Required when discount_duration_type is multiple_months.",
- "type": "number"
- },
- "discount_duration_type": {
- "description": "How long the discount applies. multiple_months also needs discount_duration_amount.",
- "enum": [
- "forever",
- "once",
- "multiple_months"
- ],
- "type": "string"
- },
- "discount_type": {
- "description": "Whether cost is a currency amount or a percentage.",
- "enum": [
- "fixed_amount",
- "percentage"
- ],
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"discount\". Alternative to type.",
- "enum": [
- "discount"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Discount\". Optional when fee_type is set.",
- "enum": [
- "Fees::Discount"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Cost (fee_type \"cost\"). A per-unit fee: price per unit times quantity, e.g. seats. Set type to \"Fees::Cost\" or fee_type to \"cost\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "Price per unit in fees_currency. The row total is quantity x cost. A plain amount, not cents: 20 means 20.00.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"cost\". Alternative to type.",
- "enum": [
- "cost"
- ],
- "type": "string"
- },
- "quantity": {
- "description": "Number of units.",
- "type": "number"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Cost\". Optional when fee_type is set.",
- "enum": [
- "Fees::Cost"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Attachment (fee_type \"attachment\"). A fee described in an uploaded attachment instead of in the table. Set type to \"Fees::Attachment\" or fee_type to \"attachment\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "attachment_id": {
- "description": "ID of an attachment uploaded with upload-attachment.",
- "type": "string"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"attachment\". Alternative to type.",
- "enum": [
- "attachment"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Attachment\". Optional when fee_type is set.",
- "enum": [
- "Fees::Attachment"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Graduated (fee_type \"graduated\"). Tiered pricing, with the price set per tier in graduated_fee_tiers_attributes. Set type to \"Fees::Graduated\" or fee_type to \"graduated\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"graduated\". Alternative to type.",
- "enum": [
- "graduated"
- ],
- "type": "string"
- },
- "graduated_fee_tiers_attributes": {
- "additionalProperties": {
- "additionalProperties": false,
- "properties": {
- "flat_price": {
- "type": "number"
- },
- "price_per_unit": {
- "type": "string"
- },
- "upper_limit": {
- "type": "number"
- }
- },
- "type": "object"
- },
- "description": "Graduated fee tiers. Use string keys such as \"0\", \"1\".",
- "propertyNames": {
- "type": "string"
- },
- "type": "object"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Graduated\". Optional when fee_type is set.",
- "enum": [
- "Fees::Graduated"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Included (fee_type \"included\"). An item included at no charge. Set type to \"Fees::Included\" or fee_type to \"included\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"included\". Alternative to type.",
- "enum": [
- "included"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Included\". Optional when fee_type is set.",
- "enum": [
- "Fees::Included"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Metered (fee_type \"metered\"). Usage-based pricing, billed per unit used. Set type to \"Fees::Metered\" or fee_type to \"metered\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "Price per unit of usage in fees_currency. A plain amount, not cents: 20 means 20.00.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"metered\". Alternative to type.",
- "enum": [
- "metered"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Metered\". Optional when fee_type is set.",
- "enum": [
- "Fees::Metered"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::OneTime (fee_type \"one_time\"). A one-time charge, such as a setup fee. Set type to \"Fees::OneTime\" or fee_type to \"one_time\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "One-time amount in fees_currency, charged once rather than per fee_period. A plain amount, not cents: 20 means 20.00.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"one_time\". Alternative to type.",
- "enum": [
- "one_time"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::OneTime\". Optional when fee_type is set.",
- "enum": [
- "Fees::OneTime"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Text (fee_type \"text\"). A fee term described in free text. Set type to \"Fees::Text\" or fee_type to \"text\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"text\". Alternative to type.",
- "enum": [
- "text"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Text\". Optional when fee_type is set.",
- "enum": [
- "Fees::Text"
- ],
- "type": "string"
- }
- },
- "type": "object"
- }
- ]
- },
- "description": "Fee line items. Use string keys such as \"0\", \"1\". Replaces template fees when provided.",
- "propertyNames": {
- "type": "string"
- },
- "type": "object"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_additional_changes": {
- "type": "boolean"
- },
- "include_customer_obligation": {
- "type": "boolean"
- },
- "include_customer_obligation_val": {
- "type": "string"
- },
- "include_deliverables": {
- "type": "boolean"
- },
- "include_deliverables_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_deliverables_description": {
- "type": "string"
- },
- "include_deliverables_include_acceptance": {
- "type": "boolean"
- },
- "include_deliverables_include_attachment": {
- "type": "boolean"
- },
- "include_deliverables_include_draft_deliverables": {
- "type": "boolean"
- },
- "include_deliverables_rejection_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_deliverables_rejection_unit": {
- "enum": [
- "hours",
- "days",
- "weeks",
- "months"
- ],
- "type": "string"
- },
- "include_deliverables_resubmission_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_deliverables_resubmission_unit": {
- "enum": [
- "hours",
- "days",
- "weeks",
- "months"
- ],
- "type": "string"
- },
- "include_fees_other": {
- "type": "boolean"
- },
- "include_fees_other_val": {
- "type": "string"
- },
- "include_fees_table": {
- "type": "boolean"
- },
- "include_fees_table_total": {
- "type": "boolean"
- },
- "include_fees_travel": {
- "type": "boolean"
- },
- "include_fees_travel_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_fees_travel_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_fees_travel_val": {
- "type": "string"
- },
- "include_third_party_customer": {
- "type": "boolean"
- },
- "include_third_party_include_description": {
- "type": "boolean"
- },
- "include_third_party_include_description_val": {
- "type": "string"
- },
- "include_third_party_materials": {
- "type": "boolean"
- },
- "include_third_party_provider": {
- "type": "boolean"
- },
- "include_time_of_assignment": {
- "type": "boolean"
- },
- "include_time_of_assignment_type": {
- "enum": [
- "created",
- "paid"
- ],
- "type": "string"
- },
- "invoice_period_description": {
- "type": "string"
- },
- "negotiations_allowed": {
- "description": "When true, the recipient can propose changes to the statement of work, even when the agreement-level `negotiations_allowed` is false. This only covers the statement of work.",
- "type": "boolean"
- },
- "payment_period": {
- "type": "number"
- },
- "payment_period_other": {
- "type": "string"
- },
- "payment_period_timeframe": {
- "enum": [
- "receipt",
- "invoice",
- "Customer's receipt of invoice",
- "date of invoice"
- ],
- "type": "string"
- },
- "payment_period_type": {
- "enum": [
- "standard",
- "other"
- ],
- "type": "string"
- },
- "payment_period_unit": {
- "enum": [
- "day(s)",
- "week(s)",
- "month(s)",
- "quarter(s)",
- "year(s)"
- ],
- "type": "string"
- },
- "quantity": {
- "type": "number"
- },
- "services_description": {
- "type": "string"
- },
- "sow_date": {
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "sow_date_type": {
- "enum": [
- "signature",
- "date"
- ],
- "type": "string"
- },
- "sow_term_amount": {
- "type": "number"
- },
- "sow_term_date": {
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "sow_term_type": {
- "enum": [
- "deliverables",
- "period",
- "date"
- ],
- "type": "string"
- },
- "sow_term_unit": {
- "enum": [
- "month(s)",
- "quarter(s)",
- "year(s)"
- ],
- "type": "string"
- },
- "type": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "recipient_email": {
- "format": "email",
- "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-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_last_to_sign": {
- "description": "When true, your signer signs after the recipient.",
- "type": "boolean"
- },
- "sender_notice_email_address": {
- "description": "Email address for legal notices to the sender.",
- "format": "email",
- "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-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": {
- "enum": [
- "signature",
- "date"
- ],
- "type": "string"
- },
- "general_cap_amount": {
- "type": "number"
- },
- "general_cap_amount_type": {
- "enum": [
- "preceding",
- "base",
- "period"
- ],
- "type": "string"
- },
- "general_cap_period_currency": {
- "type": "number"
- },
- "general_cap_period_qty": {
- "type": "number"
- },
- "general_cap_preceding_amount": {
- "type": "number"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_additional_warranties": {
- "type": "boolean"
- },
- "include_additional_warranties_by_customer": {
- "type": "string"
- },
- "include_additional_warranties_by_provider": {
- "type": "string"
- },
- "include_additional_warranties_include_by_customer": {
- "type": "boolean"
- },
- "include_additional_warranties_include_by_provider": {
- "type": "boolean"
- },
- "include_ai_addendum": {
- "type": "boolean"
- },
- "include_ai_addendum_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_covered_claims": {
- "type": "boolean"
- },
- "include_covered_claims_customer_claims": {
- "type": "string"
- },
- "include_covered_claims_include_customer_claims": {
- "type": "boolean"
- },
- "include_covered_claims_include_provider_claims": {
- "type": "boolean"
- },
- "include_covered_claims_provider_claims": {
- "type": "string"
- },
- "include_dpa": {
- "type": "boolean"
- },
- "include_dpa_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_dpa_location": {
- "type": "string"
- },
- "include_dpa_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_increased_cap_amount": {
- "type": "boolean"
- },
- "include_increased_claims": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_confidentiality": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_confidentiality_negligence": {
- "type": "boolean"
- },
- "include_increased_claims_include_other": {
- "type": "boolean"
- },
- "include_increased_claims_indemnification_obligation": {
- "type": "boolean"
- },
- "include_increased_claims_negligence": {
- "type": "boolean"
- },
- "include_increased_claims_other": {
- "type": "string"
- },
- "include_increased_claims_restrictions": {
- "type": "boolean"
- },
- "include_unlimited_claims": {
- "type": "boolean"
- },
- "include_unlimited_claims_breach_of_confidentiality": {
- "type": "boolean"
- },
- "include_unlimited_claims_breach_of_confidentiality_negligence": {
- "type": "boolean"
- },
- "include_unlimited_claims_include_other": {
- "type": "boolean"
- },
- "include_unlimited_claims_indemnification_obligation": {
- "type": "boolean"
- },
- "include_unlimited_claims_license_or_restrictions": {
- "type": "boolean"
- },
- "include_unlimited_claims_negligence": {
- "type": "boolean"
- },
- "include_unlimited_claims_other": {
- "type": "string"
- },
- "increased_cap_amount_currency": {
- "type": "number"
- },
- "increased_cap_amount_period_currency": {
- "type": "number"
- },
- "increased_cap_amount_period_qty": {
- "type": "number"
- },
- "increased_cap_amount_qty": {
- "type": "number"
- },
- "increased_cap_amount_type": {
- "enum": [
- "qty",
- "currency",
- "period"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- "software_license_order_form_attributes": {
- "additionalProperties": false,
- "description": "Override software license order form terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "additional_changes": {
- "type": "string"
- },
- "deletion_procedure_include_custom": {
- "type": "boolean"
- },
- "deletion_procedure_include_custom_description": {
- "type": "string"
- },
- "deletion_procedure_include_customer_disable": {
- "type": "boolean"
- },
- "deletion_procedure_include_customer_proof": {
- "type": "boolean"
- },
- "deletion_procedure_include_provider_disable": {
- "type": "boolean"
- },
- "fee_custom_unit": {
- "type": "string"
- },
- "fee_period": {
- "enum": [
- "Subscription Period",
- "month",
- "year",
- "Custom unit"
- ],
- "type": "string"
- },
- "fees_attributes": {
- "additionalProperties": {
- "anyOf": [
- {
- "additionalProperties": false,
- "description": "Fees::Flat (fee_type \"flat\"). A fixed recurring fee, e.g. a platform subscription. Set type to \"Fees::Flat\" or fee_type to \"flat\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "Fixed amount in the order form's fees_currency, charged per fee_period. A plain amount, not cents: 20 means 20.00.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"flat\". Alternative to type.",
- "enum": [
- "flat"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Flat\". Optional when fee_type is set.",
- "enum": [
- "Fees::Flat"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Discount (fee_type \"discount\"). A discount, as a fixed amount or a percentage, applied forever, once, or for a number of months. Set type to \"Fees::Discount\" or fee_type to \"discount\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "Discount size: an amount in fees_currency when discount_type is fixed_amount (a plain amount, not cents: 20 means 20.00), or a percentage (e.g. 10 for 10%) when it is percentage.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "discount_duration_amount": {
- "description": "Number of months the discount applies. Required when discount_duration_type is multiple_months.",
- "type": "number"
- },
- "discount_duration_type": {
- "description": "How long the discount applies. multiple_months also needs discount_duration_amount.",
- "enum": [
- "forever",
- "once",
- "multiple_months"
- ],
- "type": "string"
- },
- "discount_type": {
- "description": "Whether cost is a currency amount or a percentage.",
- "enum": [
- "fixed_amount",
- "percentage"
- ],
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"discount\". Alternative to type.",
- "enum": [
- "discount"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Discount\". Optional when fee_type is set.",
- "enum": [
- "Fees::Discount"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Cost (fee_type \"cost\"). A per-unit fee: price per unit times quantity, e.g. seats. Set type to \"Fees::Cost\" or fee_type to \"cost\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "Price per unit in fees_currency. The row total is quantity x cost. A plain amount, not cents: 20 means 20.00.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"cost\". Alternative to type.",
- "enum": [
- "cost"
- ],
- "type": "string"
- },
- "quantity": {
- "description": "Number of units.",
- "type": "number"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Cost\". Optional when fee_type is set.",
- "enum": [
- "Fees::Cost"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Attachment (fee_type \"attachment\"). A fee described in an uploaded attachment instead of in the table. Set type to \"Fees::Attachment\" or fee_type to \"attachment\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "attachment_id": {
- "description": "ID of an attachment uploaded with upload-attachment.",
- "type": "string"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"attachment\". Alternative to type.",
- "enum": [
- "attachment"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Attachment\". Optional when fee_type is set.",
- "enum": [
- "Fees::Attachment"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Graduated (fee_type \"graduated\"). Tiered pricing, with the price set per tier in graduated_fee_tiers_attributes. Set type to \"Fees::Graduated\" or fee_type to \"graduated\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"graduated\". Alternative to type.",
- "enum": [
- "graduated"
- ],
- "type": "string"
- },
- "graduated_fee_tiers_attributes": {
- "additionalProperties": {
- "additionalProperties": false,
- "properties": {
- "flat_price": {
- "type": "number"
- },
- "price_per_unit": {
- "type": "string"
- },
- "upper_limit": {
- "type": "number"
- }
- },
- "type": "object"
- },
- "description": "Graduated fee tiers. Use string keys such as \"0\", \"1\".",
- "propertyNames": {
- "type": "string"
- },
- "type": "object"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Graduated\". Optional when fee_type is set.",
- "enum": [
- "Fees::Graduated"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Included (fee_type \"included\"). An item included at no charge. Set type to \"Fees::Included\" or fee_type to \"included\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"included\". Alternative to type.",
- "enum": [
- "included"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Included\". Optional when fee_type is set.",
- "enum": [
- "Fees::Included"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Metered (fee_type \"metered\"). Usage-based pricing, billed per unit used. Set type to \"Fees::Metered\" or fee_type to \"metered\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "Price per unit of usage in fees_currency. A plain amount, not cents: 20 means 20.00.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"metered\". Alternative to type.",
- "enum": [
- "metered"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Metered\". Optional when fee_type is set.",
- "enum": [
- "Fees::Metered"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::OneTime (fee_type \"one_time\"). A one-time charge, such as a setup fee. Set type to \"Fees::OneTime\" or fee_type to \"one_time\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "One-time amount in fees_currency, charged once rather than per fee_period. A plain amount, not cents: 20 means 20.00.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"one_time\". Alternative to type.",
- "enum": [
- "one_time"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::OneTime\". Optional when fee_type is set.",
- "enum": [
- "Fees::OneTime"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Text (fee_type \"text\"). A fee term described in free text. Set type to \"Fees::Text\" or fee_type to \"text\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"text\". Alternative to type.",
- "enum": [
- "text"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Text\". Optional when fee_type is set.",
- "enum": [
- "Fees::Text"
- ],
- "type": "string"
- }
- },
- "type": "object"
- }
- ]
- },
- "description": "Fee line items. Use string keys such as \"0\", \"1\". Replaces template fees when provided.",
- "propertyNames": {
- "type": "string"
- },
- "type": "object"
- },
- "fees_currency": {
- "enum": [
- "USD",
- "EUR",
- "GBP",
- "CAD",
- "AUD",
- "SGD",
- "ILS",
- "JPY",
- "CHF",
- "HKD"
- ],
- "type": "string"
- },
- "fees_include_fee_increase_upon_renewal": {
- "type": "boolean"
- },
- "fees_include_fee_increase_upon_renewal_fee": {
- "type": "number"
- },
- "fees_include_fee_increase_upon_renewal_type": {
- "enum": [
- "will",
- "may"
- ],
- "type": "string"
- },
- "fees_inclusive_of_taxes": {
- "type": "boolean"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_additional_changes": {
- "type": "boolean"
- },
- "include_license_compliance_verification": {
- "type": "boolean"
- },
- "include_license_compliance_verification_description": {
- "type": "string"
- },
- "include_license_limits": {
- "type": "boolean"
- },
- "include_license_limits_description": {
- "type": "string"
- },
- "include_payment_process_include_billing_email": {
- "type": "boolean"
- },
- "include_pilot_period": {
- "type": "boolean"
- },
- "include_pilot_period_duration_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_pilot_period_duration_type": {
- "enum": [
- "day",
- "week",
- "month"
- ],
- "type": "string"
- },
- "include_pilot_period_include_fees": {
- "type": "boolean"
- },
- "include_pilot_period_include_fees_amount": {
- "type": "number"
- },
- "include_pilot_period_include_modifications": {
- "type": "boolean"
- },
- "include_pilot_period_include_modifications_description": {
- "type": "string"
- },
- "include_services": {
- "type": "boolean"
- },
- "include_services_description": {
- "type": "string"
- },
- "negotiations_allowed": {
- "description": "When true, the recipient can propose changes to the order form, even when the agreement-level `negotiations_allowed` is false. This only covers the order form.",
- "type": "boolean"
- },
- "order_date_date": {
- "type": "string"
- },
- "order_date_type": {
- "enum": [
- "signature",
- "date",
- "other"
- ],
- "type": "string"
- },
- "payment_process_automatic_frequency": {
- "enum": [
- "monthly",
- "quarterly",
- "semiannually",
- "annually"
- ],
- "type": "string"
- },
- "payment_process_type": {
- "enum": [
- "automatic",
- "invoice",
- "custom"
- ],
- "type": "string"
- },
- "payment_process_type_custom_val": {
- "type": "string"
- },
- "payment_process_type_invoice_amount": {
- "type": "number"
- },
- "payment_process_type_invoice_custom_unit": {
- "type": "string"
- },
- "payment_process_type_invoice_duration": {
- "enum": [
- "day",
- "week",
- "month",
- "year",
- "day(s)",
- "week(s)",
- "month(s)",
- "year(s)"
- ],
- "type": "string"
- },
- "payment_process_type_invoice_duration_start": {
- "enum": [
- "Customer's receipt of invoice",
- "date of invoice"
- ],
- "type": "string"
- },
- "payment_process_type_invoice_type": {
- "enum": [
- "monthly",
- "quarterly",
- "semiannually",
- "annually",
- "Custom unit"
- ],
- "type": "string"
- },
- "permitted_uses_include_custom": {
- "type": "boolean"
- },
- "permitted_uses_include_custom_description": {
- "type": "string"
- },
- "permitted_uses_include_customers_affiliates": {
- "type": "boolean"
- },
- "permitted_uses_include_internal_business": {
- "type": "boolean"
- },
- "pilot_period_stripe_product_id": {
- "type": "string"
- },
- "software_description": {
- "type": "string"
- },
- "subscription_auto_renew": {
- "enum": [
- "days",
- "subscription_end"
- ],
- "type": "string"
- },
- "subscription_period": {
- "type": "number"
- },
- "subscription_period_unit": {
- "type": "string"
- },
- "subscription_renewal_notice_days": {
- "type": "number"
- },
- "warranty_period_description_amount": {
- "type": "number"
- },
- "warranty_period_description_duration": {
- "enum": [
- "day",
- "week",
- "month",
- "year"
- ],
- "type": "string"
- },
- "warranty_period_description_duration_start": {
- "enum": [
- "initial delivery of the Software",
- "delivery of the Software and each subsequent Update",
- "the Order Date"
- ],
- "type": "string"
- },
- "warranty_period_type": {
- "enum": [
- "description",
- "none"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- "test_agreement": {
- "description": "When true, marks the agreement as a test. Test agreements do not count against your monthly limit.",
- "type": "boolean"
- }
- },
- "required": [
- "recipient_name",
- "recipient_email"
- ],
- "type": "object"
- },
- "cc_users": {
- "items": {
- "format": "email",
- "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-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": {
- "enum": [
- "signature",
- "date"
- ],
- "type": "string"
- },
- "framework_terms_type": {
- "type": "string"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "parent_agreement_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "underlying_agreement_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "underlying_agreement_type": {
- "type": "string"
- },
- "underlying_agreement_val": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "baa_attributes": {
- "additionalProperties": false,
- "description": "Override baa terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "aggregation_limitations_permitted": {
- "type": "boolean"
- },
- "aggregation_limitations_permitted_val": {
- "type": "string"
- },
- "breach_notification_unit": {
- "enum": [
- "hours",
- "business days",
- "calendar days"
- ],
- "type": "string"
- },
- "breach_notification_val": {
- "type": "number"
- },
- "business_associate_relationship_type": {
- "enum": [
- "provider",
- "company"
- ],
- "type": "string"
- },
- "deidentification_limitations_include_purpose": {
- "type": "boolean"
- },
- "deidentification_limitations_include_requirements": {
- "type": "boolean"
- },
- "deidentification_limitations_permitted": {
- "type": "boolean"
- },
- "deidentification_limitations_purpose_val": {
- "type": "string"
- },
- "deidentification_limitations_requirements_val": {
- "type": "string"
- },
- "designated_record_set_provider_maintains": {
- "type": "boolean"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_aggregation_limitations": {
- "type": "boolean"
- },
- "include_deidentification_limitations": {
- "type": "boolean"
- },
- "include_limitations": {
- "type": "boolean"
- },
- "include_offshore_limitations": {
- "type": "boolean"
- },
- "include_subcontract_limitations": {
- "type": "boolean"
- },
- "offshore_limitations_permitted": {
- "type": "boolean"
- },
- "offshore_limitations_permitted_val": {
- "type": "string"
- },
- "subcontract_limitations_include_notice": {
- "type": "boolean"
- },
- "subcontract_limitations_include_permission": {
- "type": "boolean"
- },
- "subcontract_limitations_notice_val": {
- "type": "string"
- },
- "subcontract_limitations_permission_val": {
- "type": "string"
- },
- "subcontract_limitations_permitted": {
- "type": "boolean"
- },
- "underlying_agreement_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "underlying_agreement_type": {
- "enum": [
- "internal",
- "external",
- "none"
- ],
- "type": "string"
- },
- "underlying_agreement_val": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "billing_email": {
- "description": "Email of the billing contact. Used when include_billing_info is true.",
- "format": "email",
- "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
- "type": "string"
- },
- "billing_name": {
- "description": "Name of the billing contact. Used when include_billing_info is true.",
- "type": "string"
- },
- "billing_workflow_type": {
- "description": "The type of billing workflow. Use \"link\" to provide a payment_link_url, or \"stripe\" for Stripe-managed billing.",
- "enum": [
- "link",
- "stripe"
- ],
- "type": "string"
- },
- "chosen_courts_country": {
- "description": "The country in which disputes will be resolved.",
- "type": "string"
- },
- "chosen_courts_region": {
- "description": "The state or region in which disputes will be resolved.",
- "type": "string"
- },
- "csa_attributes": {
- "additionalProperties": false,
- "description": "Override csa terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "customer_description": {
- "type": "string"
- },
- "effective_date": {
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "effective_date_marketplace": {
- "enum": [
- "AWS",
- "GCP",
- "Azure"
- ],
- "type": "string"
- },
- "effective_date_type": {
- "enum": [
- "signature",
- "date",
- "marketplace_acceptance"
- ],
- "type": "string"
- },
- "general_cap_amount": {
- "type": "number"
- },
- "general_cap_amount_type": {
- "enum": [
- "preceding",
- "base",
- "period"
- ],
- "type": "string"
- },
- "general_cap_period_currency": {
- "type": "number"
- },
- "general_cap_period_qty": {
- "type": "number"
- },
- "general_cap_preceding_amount": {
- "type": "number"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_acceptable_use_policy": {
- "type": "boolean"
- },
- "include_acceptable_use_policy_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_acceptable_use_policy_location": {
- "type": "string"
- },
- "include_acceptable_use_policy_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_additional_warranties": {
- "type": "boolean"
- },
- "include_additional_warranties_by_customer": {
- "type": "string"
- },
- "include_additional_warranties_by_provider": {
- "type": "string"
- },
- "include_additional_warranties_include_by_customer": {
- "type": "boolean"
- },
- "include_additional_warranties_include_by_provider": {
- "type": "boolean"
- },
- "include_ai_addendum": {
- "type": "boolean"
- },
- "include_ai_addendum_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_covered_claims": {
- "type": "boolean"
- },
- "include_covered_claims_customer_claims": {
- "type": "string"
- },
- "include_covered_claims_include_customer_claims": {
- "type": "boolean"
- },
- "include_covered_claims_include_provider_claims": {
- "type": "boolean"
- },
- "include_covered_claims_provider_claims": {
- "type": "string"
- },
- "include_dpa": {
- "type": "boolean"
- },
- "include_dpa_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_dpa_location": {
- "type": "string"
- },
- "include_dpa_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_increased_cap_amount": {
- "type": "boolean"
- },
- "include_increased_claims": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_confidentiality": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_confidentiality_negligence": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_privsec": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_privsec_negligence": {
- "type": "boolean"
- },
- "include_increased_claims_include_other": {
- "type": "boolean"
- },
- "include_increased_claims_indemnification_obligation": {
- "type": "boolean"
- },
- "include_increased_claims_other": {
- "type": "string"
- },
- "include_insurance_minimums": {
- "type": "boolean"
- },
- "include_insurance_minimums_add_customer": {
- "type": "boolean"
- },
- "include_insurance_minimums_add_customer_com_gen_liability": {
- "type": "boolean"
- },
- "include_insurance_minimums_add_customer_cyber_liability": {
- "type": "boolean"
- },
- "include_insurance_minimums_add_customer_errors_omissions": {
- "type": "boolean"
- },
- "include_insurance_minimums_additional_information": {
- "type": "boolean"
- },
- "include_insurance_minimums_additional_information_text": {
- "type": "string"
- },
- "include_insurance_minimums_cyber_liability_aggregate": {
- "type": "number"
- },
- "include_insurance_minimums_cyber_liability_minimum": {
- "type": "number"
- },
- "include_insurance_minimums_employer_liability_aggregate": {
- "type": "number"
- },
- "include_insurance_minimums_employer_liability_minimum": {
- "type": "number"
- },
- "include_insurance_minimums_general_liability_aggregate": {
- "type": "number"
- },
- "include_insurance_minimums_general_liability_minimum": {
- "type": "number"
- },
- "include_insurance_minimums_include_cyber_liability": {
- "type": "boolean"
- },
- "include_insurance_minimums_include_employer_liability": {
- "type": "boolean"
- },
- "include_insurance_minimums_include_general_liability": {
- "type": "boolean"
- },
- "include_insurance_minimums_include_workers_compensation": {
- "type": "boolean"
- },
- "include_publicity_rights": {
- "type": "boolean"
- },
- "include_publicity_rights_type": {
- "enum": [
- "public",
- "non-public"
- ],
- "type": "string"
- },
- "include_security_policy": {
- "type": "boolean"
- },
- "include_security_policy_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_security_policy_fedramp_auth": {
- "type": "boolean"
- },
- "include_security_policy_hipaa": {
- "type": "boolean"
- },
- "include_security_policy_hitrust": {
- "type": "boolean"
- },
- "include_security_policy_include_annual_maintenance": {
- "type": "boolean"
- },
- "include_security_policy_include_location": {
- "type": "boolean"
- },
- "include_security_policy_include_other": {
- "type": "boolean"
- },
- "include_security_policy_include_reasonable_efforts": {
- "type": "boolean"
- },
- "include_security_policy_iso27001": {
- "type": "boolean"
- },
- "include_security_policy_location": {
- "type": "string"
- },
- "include_security_policy_other": {
- "type": "string"
- },
- "include_security_policy_pci1": {
- "type": "boolean"
- },
- "include_security_policy_pci2": {
- "type": "boolean"
- },
- "include_security_policy_penetration_testing": {
- "type": "boolean"
- },
- "include_security_policy_soc2": {
- "type": "boolean"
- },
- "include_security_policy_soc2_type2": {
- "type": "boolean"
- },
- "include_security_policy_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_supercap": {
- "description": "CSA 3.0 renamed `include_increased_cap_amount` to `include_supercap`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_increased_cap_amount`. Sending the other spelling returns a 422.",
- "type": "boolean"
- },
- "include_uncapped_claims": {
- "description": "CSA 3.0 renamed `include_unlimited_claims` to `include_uncapped_claims`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims`. Sending the other spelling returns a 422.",
- "type": "boolean"
- },
- "include_uncapped_claims_breach_of_confidentiality": {
- "description": "CSA 3.0 renamed `include_unlimited_claims_breach_of_confidentiality` to `include_uncapped_claims_breach_of_confidentiality`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_breach_of_confidentiality`. Sending the other spelling returns a 422.",
- "type": "boolean"
- },
- "include_uncapped_claims_breach_of_confidentiality_negligence": {
- "description": "CSA 3.0 renamed `include_unlimited_claims_breach_of_confidentiality_negligence` to `include_uncapped_claims_breach_of_confidentiality_negligence`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_breach_of_confidentiality_negligence`. Sending the other spelling returns a 422.",
- "type": "boolean"
- },
- "include_uncapped_claims_breach_of_privsec": {
- "description": "CSA 3.0 renamed `include_unlimited_claims_breach_of_privsec` to `include_uncapped_claims_breach_of_privsec`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_breach_of_privsec`. Sending the other spelling returns a 422.",
- "type": "boolean"
- },
- "include_uncapped_claims_breach_of_privsec_negligence": {
- "description": "CSA 3.0 renamed `include_unlimited_claims_breach_of_privsec_negligence` to `include_uncapped_claims_breach_of_privsec_negligence`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_breach_of_privsec_negligence`. Sending the other spelling returns a 422.",
- "type": "boolean"
- },
- "include_uncapped_claims_include_other": {
- "description": "CSA 3.0 renamed `include_unlimited_claims_include_other` to `include_uncapped_claims_include_other`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_include_other`. Sending the other spelling returns a 422.",
- "type": "boolean"
- },
- "include_uncapped_claims_indemnification_obligation": {
- "description": "CSA 3.0 renamed `include_unlimited_claims_indemnification_obligation` to `include_uncapped_claims_indemnification_obligation`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_indemnification_obligation`. Sending the other spelling returns a 422.",
- "type": "boolean"
- },
- "include_uncapped_claims_other": {
- "description": "CSA 3.0 renamed `include_unlimited_claims_other` to `include_uncapped_claims_other`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_other`. Sending the other spelling returns a 422.",
- "type": "boolean"
- },
- "include_unlimited_claims": {
- "type": "boolean"
- },
- "include_unlimited_claims_breach_of_confidentiality": {
- "type": "boolean"
- },
- "include_unlimited_claims_breach_of_confidentiality_negligence": {
- "type": "boolean"
- },
- "include_unlimited_claims_breach_of_privsec": {
- "type": "boolean"
- },
- "include_unlimited_claims_breach_of_privsec_negligence": {
- "type": "boolean"
- },
- "include_unlimited_claims_include_other": {
- "type": "boolean"
- },
- "include_unlimited_claims_indemnification_obligation": {
- "type": "boolean"
- },
- "include_unlimited_claims_other": {
- "type": "string"
- },
- "increased_cap_amount_currency": {
- "type": "number"
- },
- "increased_cap_amount_period_currency": {
- "type": "number"
- },
- "increased_cap_amount_period_qty": {
- "type": "number"
- },
- "increased_cap_amount_qty": {
- "type": "number"
- },
- "increased_cap_amount_type": {
- "enum": [
- "qty",
- "currency",
- "period"
- ],
- "type": "string"
- },
- "provider": {
- "type": "string"
- },
- "supercap_currency": {
- "description": "CSA 3.0 renamed `increased_cap_amount_currency` to `supercap_currency`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `increased_cap_amount_currency`. Sending the other spelling returns a 422.",
- "type": "number"
- },
- "supercap_period_currency": {
- "description": "CSA 3.0 renamed `increased_cap_amount_period_currency` to `supercap_period_currency`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `increased_cap_amount_period_currency`. Sending the other spelling returns a 422.",
- "type": "number"
- },
- "supercap_period_qty": {
- "description": "CSA 3.0 renamed `increased_cap_amount_period_qty` to `supercap_period_qty`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `increased_cap_amount_period_qty`. Sending the other spelling returns a 422.",
- "type": "number"
- },
- "supercap_qty": {
- "description": "CSA 3.0 renamed `increased_cap_amount_qty` to `supercap_qty`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `increased_cap_amount_qty`. Sending the other spelling returns a 422.",
- "type": "number"
- },
- "supercap_type": {
- "description": "CSA 3.0 renamed `increased_cap_amount_type` to `supercap_type`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `increased_cap_amount_type`. Sending the other spelling returns a 422.",
- "type": "number"
- }
- },
- "type": "object"
- },
- "csa_order_form_attributes": {
- "additionalProperties": false,
- "description": "Override csa order form terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "additional_changes": {
- "type": "string"
- },
- "additional_parameters_or_limitations": {
- "type": "string"
- },
- "affiliates_as_users": {
- "type": "boolean"
- },
- "cloud_service_description": {
- "type": "string"
- },
- "consumption_units": {
- "type": "string"
- },
- "fee_amount": {
- "type": "number"
- },
- "fee_custom_unit": {
- "type": "string"
- },
- "fee_period": {
- "enum": [
- "Subscription Period",
- "month",
- "year",
- "User",
- "Custom unit"
- ],
- "type": "string"
- },
- "fees_attributes": {
- "additionalProperties": {
- "anyOf": [
- {
- "additionalProperties": false,
- "description": "Fees::Flat (fee_type \"flat\"). A fixed recurring fee, e.g. a platform subscription. Set type to \"Fees::Flat\" or fee_type to \"flat\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "Fixed amount in the order form's fees_currency, charged per fee_period. A plain amount, not cents: 20 means 20.00.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"flat\". Alternative to type.",
- "enum": [
- "flat"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Flat\". Optional when fee_type is set.",
- "enum": [
- "Fees::Flat"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Discount (fee_type \"discount\"). A discount, as a fixed amount or a percentage, applied forever, once, or for a number of months. Set type to \"Fees::Discount\" or fee_type to \"discount\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "Discount size: an amount in fees_currency when discount_type is fixed_amount (a plain amount, not cents: 20 means 20.00), or a percentage (e.g. 10 for 10%) when it is percentage.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "discount_duration_amount": {
- "description": "Number of months the discount applies. Required when discount_duration_type is multiple_months.",
- "type": "number"
- },
- "discount_duration_type": {
- "description": "How long the discount applies. multiple_months also needs discount_duration_amount.",
- "enum": [
- "forever",
- "once",
- "multiple_months"
- ],
- "type": "string"
- },
- "discount_type": {
- "description": "Whether cost is a currency amount or a percentage.",
- "enum": [
- "fixed_amount",
- "percentage"
- ],
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"discount\". Alternative to type.",
- "enum": [
- "discount"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Discount\". Optional when fee_type is set.",
- "enum": [
- "Fees::Discount"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Cost (fee_type \"cost\"). A per-unit fee: price per unit times quantity, e.g. seats. Set type to \"Fees::Cost\" or fee_type to \"cost\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "Price per unit in fees_currency. The row total is quantity x cost. A plain amount, not cents: 20 means 20.00.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"cost\". Alternative to type.",
- "enum": [
- "cost"
- ],
- "type": "string"
- },
- "quantity": {
- "description": "Number of units.",
- "type": "number"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Cost\". Optional when fee_type is set.",
- "enum": [
- "Fees::Cost"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Attachment (fee_type \"attachment\"). A fee described in an uploaded attachment instead of in the table. Set type to \"Fees::Attachment\" or fee_type to \"attachment\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "attachment_id": {
- "description": "ID of an attachment uploaded with upload-attachment.",
- "type": "string"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"attachment\". Alternative to type.",
- "enum": [
- "attachment"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Attachment\". Optional when fee_type is set.",
- "enum": [
- "Fees::Attachment"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Graduated (fee_type \"graduated\"). Tiered pricing, with the price set per tier in graduated_fee_tiers_attributes. Set type to \"Fees::Graduated\" or fee_type to \"graduated\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"graduated\". Alternative to type.",
- "enum": [
- "graduated"
- ],
- "type": "string"
- },
- "graduated_fee_tiers_attributes": {
- "additionalProperties": {
- "additionalProperties": false,
- "properties": {
- "flat_price": {
- "type": "number"
- },
- "price_per_unit": {
- "type": "string"
- },
- "upper_limit": {
- "type": "number"
- }
- },
- "type": "object"
- },
- "description": "Graduated fee tiers. Use string keys such as \"0\", \"1\".",
- "propertyNames": {
- "type": "string"
- },
- "type": "object"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Graduated\". Optional when fee_type is set.",
- "enum": [
- "Fees::Graduated"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Included (fee_type \"included\"). An item included at no charge. Set type to \"Fees::Included\" or fee_type to \"included\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"included\". Alternative to type.",
- "enum": [
- "included"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Included\". Optional when fee_type is set.",
- "enum": [
- "Fees::Included"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Metered (fee_type \"metered\"). Usage-based pricing, billed per unit used. Set type to \"Fees::Metered\" or fee_type to \"metered\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "Price per unit of usage in fees_currency. A plain amount, not cents: 20 means 20.00.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"metered\". Alternative to type.",
- "enum": [
- "metered"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Metered\". Optional when fee_type is set.",
- "enum": [
- "Fees::Metered"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::OneTime (fee_type \"one_time\"). A one-time charge, such as a setup fee. Set type to \"Fees::OneTime\" or fee_type to \"one_time\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "One-time amount in fees_currency, charged once rather than per fee_period. A plain amount, not cents: 20 means 20.00.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"one_time\". Alternative to type.",
- "enum": [
- "one_time"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::OneTime\". Optional when fee_type is set.",
- "enum": [
- "Fees::OneTime"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Text (fee_type \"text\"). A fee term described in free text. Set type to \"Fees::Text\" or fee_type to \"text\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"text\". Alternative to type.",
- "enum": [
- "text"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Text\". Optional when fee_type is set.",
- "enum": [
- "Fees::Text"
- ],
- "type": "string"
- }
- },
- "type": "object"
- }
- ]
- },
- "description": "Fee table rows, keyed by string index (\"0\", \"1\", ...). Replaces the template's fees when provided. Each row sets type or fee_type to pick the fee class. Amounts are in the order form's fees_currency and, for recurring fees, are charged per fee_period.",
- "examples": [
- {
- "0": {
- "cost": 2000,
- "description": "Platform subscription",
- "type": "Fees::Flat"
- }
- },
- {
- "0": {
- "cost": 50,
- "description": "Seats",
- "fee_type": "cost",
- "quantity": 10
- },
- "1": {
- "cost": 10,
- "description": "Launch discount",
- "discount_duration_amount": 3,
- "discount_duration_type": "multiple_months",
- "discount_type": "percentage",
- "fee_type": "discount"
- }
- }
- ],
- "propertyNames": {
- "type": "string"
- },
- "type": "object"
- },
- "fees_currency": {
- "enum": [
- "USD",
- "EUR",
- "GBP",
- "CAD",
- "AUD",
- "SGD",
- "ILS",
- "JPY",
- "CHF",
- "HKD"
- ],
- "type": "string"
- },
- "fees_include_fee_increase_upon_renewal": {
- "type": "boolean"
- },
- "fees_include_fee_increase_upon_renewal_fee": {
- "type": "number"
- },
- "fees_include_fee_increase_upon_renewal_type": {
- "enum": [
- "will",
- "may"
- ],
- "type": "string"
- },
- "fees_inclusive_of_taxes": {
- "type": "boolean"
- },
- "framework_terms_type": {
- "enum": [
- "new",
- "existing",
- "description"
- ],
- "type": "string"
- },
- "free_trial_days": {
- "type": "number"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_additional_changes": {
- "type": "boolean"
- },
- "include_additional_parameters_or_limitations": {
- "type": "boolean"
- },
- "include_consumption": {
- "type": "boolean"
- },
- "include_fees": {
- "type": "boolean"
- },
- "include_fees_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_fees_include_attachment": {
- "type": "boolean"
- },
- "include_fees_other": {
- "type": "boolean"
- },
- "include_fees_other_val": {
- "type": "string"
- },
- "include_fees_table": {
- "type": "boolean"
- },
- "include_fees_table_period": {
- "enum": [
- "Subscription Period",
- "month",
- "year",
- "User"
- ],
- "type": "string"
- },
- "include_free_trial": {
- "type": "boolean"
- },
- "include_max_users": {
- "type": "boolean"
- },
- "include_pilot_period": {
- "type": "boolean"
- },
- "include_pilot_period_duration_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_pilot_period_duration_type": {
- "enum": [
- "day",
- "week",
- "month"
- ],
- "type": "string"
- },
- "include_pilot_period_include_fees": {
- "type": "boolean"
- },
- "include_pilot_period_include_fees_amount": {
- "type": "number"
- },
- "include_pilot_period_include_modifications": {
- "type": "boolean"
- },
- "include_pilot_period_include_modifications_description": {
- "type": "string"
- },
- "include_product_support": {
- "type": "boolean"
- },
- "include_product_support_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_product_support_description": {
- "type": "string"
- },
- "include_product_support_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_professional_services": {
- "type": "boolean"
- },
- "include_professional_services_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_professional_services_custom_name": {
- "type": "string"
- },
- "include_professional_services_description": {
- "type": "string"
- },
- "include_professional_services_end_date": {
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "include_professional_services_fees_description": {
- "type": "string"
- },
- "include_professional_services_include_end_date": {
- "type": "boolean"
- },
- "include_professional_services_include_fees_description": {
- "type": "boolean"
- },
- "include_professional_services_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_sla": {
- "type": "boolean"
- },
- "include_sla_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_sla_description": {
- "type": "string"
- },
- "include_sla_include_response_time": {
- "type": "boolean"
- },
- "include_sla_include_response_time_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_sla_include_response_time_credit": {
- "type": "number"
- },
- "include_sla_include_response_time_duration": {
- "enum": [
- "hour",
- "day",
- "week",
- "month",
- "hours"
- ],
- "type": "string"
- },
- "include_sla_include_response_time_support_channel": {
- "type": "string"
- },
- "include_sla_include_target_uptime": {
- "type": "boolean"
- },
- "include_sla_maintenance_notice": {
- "type": "boolean"
- },
- "include_sla_maintenance_window": {
- "type": "boolean"
- },
- "include_sla_maintenance_window_type": {
- "enum": [
- "standard",
- "none"
- ],
- "type": "string"
- },
- "include_sla_standard_maintenance_notice_qty": {
- "type": "number"
- },
- "include_sla_standard_maintenance_notice_unit": {
- "enum": [
- "hour",
- "day",
- "week",
- "month"
- ],
- "type": "string"
- },
- "include_sla_standard_maintenance_window_end_time": {
- "type": "string"
- },
- "include_sla_standard_maintenance_window_friday": {
- "type": "boolean"
- },
- "include_sla_standard_maintenance_window_monday": {
- "type": "boolean"
- },
- "include_sla_standard_maintenance_window_saturday": {
- "type": "boolean"
- },
- "include_sla_standard_maintenance_window_start_time": {
- "type": "string"
- },
- "include_sla_standard_maintenance_window_sunday": {
- "type": "boolean"
- },
- "include_sla_standard_maintenance_window_thursday": {
- "type": "boolean"
- },
- "include_sla_standard_maintenance_window_time_zone": {
- "type": "string"
- },
- "include_sla_standard_maintenance_window_tuesday": {
- "type": "boolean"
- },
- "include_sla_standard_maintenance_window_wednesday": {
- "type": "boolean"
- },
- "include_sla_standard_target_uptime": {
- "type": "number"
- },
- "include_sla_type": {
- "enum": [
- "description",
- "standard",
- "attachment"
- ],
- "type": "string"
- },
- "include_subscription_start_date": {
- "type": "boolean"
- },
- "include_subscription_start_date_date": {
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "include_usage_review": {
- "type": "boolean"
- },
- "include_usage_review_val": {
- "type": "string"
- },
- "include_use_limitations": {
- "type": "boolean"
- },
- "include_use_limitations_val": {
- "type": "string"
- },
- "invoice_period": {
- "enum": [
- "monthly",
- "quarterly",
- "semiannually",
- "annually",
- "Custom unit",
- "Monthly",
- "Quarterly",
- "Semiannually",
- "Annually"
- ],
- "type": "string"
- },
- "invoice_period_custom_unit": {
- "type": "string"
- },
- "max_consumption": {
- "type": "number"
- },
- "max_users": {
- "type": "number"
- },
- "negotiations_allowed": {
- "description": "When true, the recipient can propose changes to the order form, even when the agreement-level `negotiations_allowed` is false. This only covers the order form.",
- "type": "boolean"
- },
- "order_date_date": {
- "type": "string"
- },
- "order_date_other": {
- "type": "string"
- },
- "order_date_type": {
- "enum": [
- "signature",
- "date",
- "other"
- ],
- "type": "string"
- },
- "payment_period": {
- "type": "number"
- },
- "payment_period_timeframe": {
- "enum": [
- "Customer's receipt of invoice",
- "date of invoice"
- ],
- "type": "string"
- },
- "payment_period_unit": {
- "enum": [
- "day(s)",
- "week(s)",
- "month(s)",
- "marketplace_acceptance"
- ],
- "type": "string"
- },
- "payment_process_automatic_frequency": {
- "enum": [
- "monthly",
- "quarterly",
- "semiannually",
- "annually"
- ],
- "type": "string"
- },
- "payment_process_type": {
- "enum": [
- "automatic",
- "invoice",
- "custom",
- "marketplace_acceptance"
- ],
- "type": "string"
- },
- "payment_process_type_custom_val": {
- "type": "string"
- },
- "payment_process_type_invoice_amount": {
- "type": "number"
- },
- "payment_process_type_invoice_custom_unit": {
- "type": "string"
- },
- "payment_process_type_invoice_duration": {
- "enum": [
- "day",
- "week",
- "month",
- "year",
- "day(s)",
- "week(s)",
- "month(s)",
- "year(s)"
- ],
- "type": "string"
- },
- "payment_process_type_invoice_duration_start": {
- "enum": [
- "Customer's receipt of invoice",
- "date of invoice"
- ],
- "type": "string"
- },
- "payment_process_type_invoice_type": {
- "enum": [
- "monthly",
- "quarterly",
- "semiannually",
- "annually",
- "Custom unit"
- ],
- "type": "string"
- },
- "pilot_period_stripe_product_id": {
- "type": "string"
- },
- "service_credits_attributes": {
- "additionalProperties": {
- "additionalProperties": false,
- "properties": {
- "credit": {
- "type": "number"
- },
- "max": {
- "type": "number"
- },
- "min": {
- "type": "number"
- }
- },
- "type": "object"
- },
- "description": "Service credits. Use string keys such as \"0\", \"1\".",
- "propertyNames": {
- "type": "string"
- },
- "type": "object"
- },
- "subscription_auto_renew": {
- "enum": [
- "days",
- "subscription_end"
- ],
- "type": "string"
- },
- "subscription_period": {
- "type": "number"
- },
- "subscription_period_unit": {
- "type": "string"
- },
- "subscription_renewal_notice_days": {
- "type": "number"
- },
- "subscription_start_date": {
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "subscription_start_date_type": {
- "enum": [
- "effective_date",
- "date"
- ],
- "type": "string"
- },
- "underlying_agreement_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "use_limitations_attributes": {
- "additionalProperties": {
- "additionalProperties": false,
- "properties": {
- "amount": {
- "type": "number"
- },
- "limitation_type": {
- "type": "string"
- },
- "unit": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "description": "Use limitations. Use string keys such as \"0\", \"1\".",
- "propertyNames": {
- "type": "string"
- },
- "type": "object"
- }
- },
- "type": "object"
- },
- "custom_field_values": {
- "description": "Values for a custom template's fields, keyed by the field keys defined in the template's YAML definition. Only used when template_id is a custom template. Template defaults fill any fields you omit; a required field with no default and no submitted value returns a 400 naming the field. Values are validated against the field's input type: select and radio values must be one of the field's options, multiselect values are an array of selections each of which must be one of the field's options, number and currency values must be numeric, date values must be YYYY-MM-DD, and email values must be valid addresses. An invalid value returns a 400 naming the field."
- },
- "design_partner_attributes": {
- "additionalProperties": false,
- "description": "Override design partner terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "customer_description": {
- "type": "string"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_fees": {
- "type": "boolean"
- },
- "include_fees_amount": {
- "type": "number"
- },
- "include_fees_description": {
- "type": "string"
- },
- "include_fees_pay_by_amount": {
- "type": "string"
- },
- "include_fees_type": {
- "enum": [
- "default_language",
- "description"
- ],
- "type": "string"
- },
- "include_fees_unit": {
- "enum": [
- "month",
- "quarter",
- "year",
- "Term"
- ],
- "type": "string"
- },
- "include_program_appear_as_customer_private": {
- "type": "boolean"
- },
- "include_program_appear_as_customer_public": {
- "type": "boolean"
- },
- "include_program_case_study": {
- "type": "boolean"
- },
- "include_program_develop_functionality": {
- "type": "boolean"
- },
- "include_program_develop_functionality_val": {
- "type": "string"
- },
- "include_program_discount": {
- "type": "boolean"
- },
- "include_program_discount_amount": {
- "type": "number"
- },
- "include_program_discount_unit": {
- "enum": [
- "U.S. Dollars",
- "percent"
- ],
- "type": "string"
- },
- "include_program_participation_feedback": {
- "type": "boolean"
- },
- "include_program_participation_feedback_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_program_participation_feedback_unit": {
- "enum": [
- "month",
- "quarter",
- "year",
- "Term"
- ],
- "type": "string"
- },
- "include_program_partner_other": {
- "type": "boolean"
- },
- "include_program_partner_other_val": {
- "type": "string"
- },
- "include_program_provider_other": {
- "type": "boolean"
- },
- "include_program_provider_other_val": {
- "type": "string"
- },
- "include_program_reference": {
- "type": "boolean"
- },
- "product_description": {
- "type": "string"
- },
- "term_amount": {
- "type": "number"
- },
- "term_unit": {
- "enum": [
- "day(s)",
- "week(s)",
- "month(s)",
- "quarter(s)",
- "year(s)"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- "district_or_county": {
- "description": "The district or county for dispute resolution.",
- "type": "string"
- },
- "dpa_attributes": {
- "additionalProperties": false,
- "description": "Override dpa terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "approved_subprocessor_type": {
- "description": "`internal` lists approved subprocessors in the agreement (`subprocessors_attributes`); `external` points to a list published elsewhere.",
- "enum": [
- "internal",
- "external"
- ],
- "type": "string"
- },
- "cloud_service_product_name": {
- "type": "string"
- },
- "competent_supervisory_authority": {
- "type": "string"
- },
- "customer_description": {
- "type": "string"
- },
- "data_exporter_address_city": {
- "type": "string"
- },
- "data_exporter_address_country": {
- "type": "string"
- },
- "data_exporter_address_state": {
- "type": "string"
- },
- "data_exporter_address_street_address": {
- "type": "string"
- },
- "data_exporter_address_zipcode": {
- "type": "string"
- },
- "data_exporter_contact_details": {
- "type": "string"
- },
- "data_exporter_contact_name": {
- "type": "string"
- },
- "data_exporter_contact_position": {
- "type": "string"
- },
- "data_exporter_role": {
- "description": "Role of the data exporter. Overwritten to `Controller` when the agreement is created from a template.",
- "enum": [
- "Controller",
- "Processor"
- ],
- "type": "string"
- },
- "data_importer_address": {
- "type": "string"
- },
- "data_importer_address_city": {
- "type": "string"
- },
- "data_importer_address_country": {
- "type": "string"
- },
- "data_importer_address_state": {
- "type": "string"
- },
- "data_importer_address_street_address": {
- "type": "string"
- },
- "data_importer_address_zipcode": {
- "type": "string"
- },
- "data_importer_contact_details": {
- "type": "string"
- },
- "data_importer_contact_name": {
- "type": "string"
- },
- "data_importer_contact_position": {
- "type": "string"
- },
- "duration_of_processing": {
- "type": "string"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_covered_claim": {
- "type": "boolean"
- },
- "include_covered_claim_external_val": {
- "type": "string"
- },
- "include_covered_claim_internal_val": {
- "type": "string"
- },
- "include_covered_claim_type": {
- "description": "Which covered-claim text applies: `internal` uses `include_covered_claim_internal_val`, `external` uses `include_covered_claim_external_val`. Required when `include_covered_claim` is true.",
- "enum": [
- "internal",
- "external"
- ],
- "type": "string"
- },
- "include_data_subjects_custom": {
- "type": "boolean"
- },
- "include_data_subjects_custom_val": {
- "type": "string"
- },
- "include_data_subjects_employees": {
- "type": "boolean"
- },
- "include_data_subjects_end_users": {
- "type": "boolean"
- },
- "include_external_subprocessor_location": {
- "type": "string"
- },
- "include_frequency_of_transfer_continuous": {
- "type": "boolean"
- },
- "include_frequency_of_transfer_custom": {
- "type": "boolean"
- },
- "include_frequency_of_transfer_custom_val": {
- "type": "string"
- },
- "include_governing_country_eu": {
- "type": "boolean"
- },
- "include_governing_country_eu_val": {
- "type": "string"
- },
- "include_governing_country_uk": {
- "type": "boolean"
- },
- "include_governing_country_uk_val": {
- "type": "string"
- },
- "include_governing_law": {
- "type": "boolean"
- },
- "include_governing_law_country": {
- "type": "string"
- },
- "include_governing_law_state": {
- "type": "string"
- },
- "include_increased_claim_amount": {
- "description": "Legacy field. Stored but not shown on the DPA; use the `include_liability_cap*` fields instead.",
- "type": "boolean"
- },
- "include_increased_claim_amount_currency": {
- "description": "Legacy field. Stored but not shown on the DPA; use the `include_liability_cap*` fields instead."
- },
- "include_increased_claim_amount_qty": {
- "description": "Legacy field. Stored but not shown on the DPA; use the `include_liability_cap*` fields instead."
- },
- "include_increased_claim_amount_type": {
- "description": "Legacy field. Stored but not shown on the DPA; use the `include_liability_cap*` fields instead.",
- "type": "string"
- },
- "include_liability_cap": {
- "type": "boolean"
- },
- "include_liability_cap_amount_constant_external": {
- "type": "string"
- },
- "include_liability_cap_amount_constant_internal": {
- "type": "string"
- },
- "include_liability_cap_amount_currency_external": {
- "description": "Currency amount. Numbers and numeric strings (commas allowed) are both accepted."
- },
- "include_liability_cap_amount_currency_internal": {
- "description": "Currency amount. Numbers and numeric strings (commas allowed) are both accepted."
- },
- "include_liability_cap_csa_type": {
- "description": "Which liability cap values apply: the `_internal` or `_external` amount fields. Required when `include_liability_cap` is true.",
- "enum": [
- "internal",
- "external"
- ],
- "type": "string"
- },
- "include_personal_data_biographic_info": {
- "type": "boolean"
- },
- "include_personal_data_contact_info": {
- "type": "boolean"
- },
- "include_personal_data_custom": {
- "type": "boolean"
- },
- "include_personal_data_custom_val": {
- "type": "string"
- },
- "include_personal_data_employment_info": {
- "type": "boolean"
- },
- "include_personal_data_financial_info": {
- "type": "boolean"
- },
- "include_personal_data_location": {
- "type": "boolean"
- },
- "include_personal_data_name": {
- "type": "boolean"
- },
- "include_personal_data_transactional_info": {
- "type": "boolean"
- },
- "include_personal_data_user_activity_info": {
- "type": "boolean"
- },
- "include_processing_purpose_custom": {
- "type": "boolean"
- },
- "include_processing_purpose_custom_val": {
- "type": "string"
- },
- "include_processing_purpose_erasing": {
- "type": "boolean"
- },
- "include_processing_purpose_holding": {
- "type": "boolean"
- },
- "include_processing_purpose_protecting": {
- "type": "boolean"
- },
- "include_processing_purpose_receiving": {
- "type": "boolean"
- },
- "include_processing_purpose_returning": {
- "type": "boolean"
- },
- "include_processing_purpose_sharing": {
- "type": "boolean"
- },
- "include_processing_purpose_updating": {
- "type": "boolean"
- },
- "include_processing_purpose_using": {
- "type": "boolean"
- },
- "include_provider_security_contact_address": {
- "type": "boolean"
- },
- "include_provider_security_contact_address_city": {
- "type": "string"
- },
- "include_provider_security_contact_address_country": {
- "type": "string"
- },
- "include_provider_security_contact_address_state": {
- "type": "string"
- },
- "include_provider_security_contact_address_street_address": {
- "type": "string"
- },
- "include_provider_security_contact_address_zipcode": {
- "type": "string"
- },
- "include_provider_security_contact_email": {
- "type": "boolean"
- },
- "include_provider_security_contact_email_val": {
- "format": "email",
- "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
- "type": "string"
- },
- "include_security_measures_accountability": {
- "type": "boolean"
- },
- "include_security_measures_accountability_val": {
- "type": "string"
- },
- "include_security_measures_certification_or_assurance": {
- "type": "boolean"
- },
- "include_security_measures_certification_or_assurance_val": {
- "type": "string"
- },
- "include_security_measures_confidentiality_integrity": {
- "type": "boolean"
- },
- "include_security_measures_confidentiality_integrity_val": {
- "type": "string"
- },
- "include_security_measures_data_at_rest": {
- "type": "boolean"
- },
- "include_security_measures_data_at_rest_val": {
- "type": "string"
- },
- "include_security_measures_data_minimization": {
- "type": "boolean"
- },
- "include_security_measures_data_minimization_val": {
- "type": "string"
- },
- "include_security_measures_data_quality": {
- "type": "boolean"
- },
- "include_security_measures_data_quality_val": {
- "type": "string"
- },
- "include_security_measures_data_retention": {
- "type": "boolean"
- },
- "include_security_measures_data_retention_val": {
- "type": "string"
- },
- "include_security_measures_data_transmission": {
- "type": "boolean"
- },
- "include_security_measures_data_transmission_val": {
- "type": "string"
- },
- "include_security_measures_event_logging": {
- "type": "boolean"
- },
- "include_security_measures_event_logging_val": {
- "type": "string"
- },
- "include_security_measures_identity_auth": {
- "type": "boolean"
- },
- "include_security_measures_identity_auth_val": {
- "type": "string"
- },
- "include_security_measures_it_security_governance": {
- "type": "boolean"
- },
- "include_security_measures_it_security_governance_val": {
- "type": "string"
- },
- "include_security_measures_physical_security": {
- "type": "boolean"
- },
- "include_security_measures_physical_security_val": {
- "type": "string"
- },
- "include_security_measures_portability_and_erasure": {
- "type": "boolean"
- },
- "include_security_measures_portability_and_erasure_val": {
- "type": "string"
- },
- "include_security_measures_pseudonym_encryption": {
- "type": "boolean"
- },
- "include_security_measures_pseudonym_encryption_val": {
- "type": "string"
- },
- "include_security_measures_restore_data_access": {
- "type": "boolean"
- },
- "include_security_measures_restore_data_access_val": {
- "type": "string"
- },
- "include_security_measures_security_policy": {
- "type": "boolean"
- },
- "include_security_measures_system_configuration": {
- "type": "boolean"
- },
- "include_security_measures_system_configuration_val": {
- "type": "string"
- },
- "include_security_measures_testing_assessment": {
- "type": "boolean"
- },
- "include_security_measures_testing_assessment_val": {
- "type": "string"
- },
- "include_security_policy": {
- "type": "boolean"
- },
- "include_security_policy_fedramp_auth": {
- "type": "boolean"
- },
- "include_security_policy_hipaa": {
- "type": "boolean"
- },
- "include_security_policy_hitrust": {
- "type": "boolean"
- },
- "include_security_policy_include_other": {
- "type": "boolean"
- },
- "include_security_policy_iso27001": {
- "type": "boolean"
- },
- "include_security_policy_other": {
- "type": "string"
- },
- "include_security_policy_pci1": {
- "type": "boolean"
- },
- "include_security_policy_pci2": {
- "type": "boolean"
- },
- "include_security_policy_penetration_testing": {
- "type": "boolean"
- },
- "include_security_policy_soc2": {
- "type": "boolean"
- },
- "include_security_policy_soc2_type2": {
- "type": "boolean"
- },
- "include_sensitive_data_restrictions_custom": {
- "type": "boolean"
- },
- "include_sensitive_data_restrictions_custom_val": {
- "type": "string"
- },
- "include_sensitive_data_restrictions_security_policy": {
- "type": "boolean"
- },
- "include_service_provider_relationship": {
- "type": "boolean"
- },
- "include_special_category_data": {
- "type": "boolean"
- },
- "provider": {
- "type": "string"
- },
- "security_policy_available_at": {
- "type": "string"
- },
- "security_policy_type": {
- "description": "Where the Security Policy is defined. For `external`, set `security_policy_available_at`.",
- "enum": [
- "defined in agreement",
- "provider service",
- "external"
- ],
- "type": "string"
- },
- "subprocessors_attributes": {
- "additionalProperties": {
- "additionalProperties": false,
- "properties": {
- "_destroy": {
- "description": "Set to true with `id` to remove that subprocessor.",
- "type": "boolean"
- },
- "country": {
- "type": "string"
- },
- "id": {
- "description": "ID of an existing subprocessor to update or remove. Omit to add a new subprocessor.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "name": {
- "type": "string"
- },
- "processing_task": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "description": "Subprocessors, keyed by string index such as \"0\", \"1\". On create these are added to the template's subprocessors. On a draft update, an entry without `id` adds a new subprocessor; pass `id` to change one and `id` with `_destroy: true` to remove one.",
- "propertyNames": {
- "type": "string"
- },
- "type": "object"
- },
- "underlying_agreement_id": {
- "description": "ID of the CSA this DPA supplements when `underlying_agreement_type` is `internal`.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "underlying_agreement_type": {
- "description": "`internal` links a CSA in Common Paper (`underlying_agreement_id`); `external` describes another agreement in `underlying_agreement_val` (required). Omit for none.",
- "enum": [
- "internal",
- "external"
- ],
- "type": "string"
- },
- "underlying_agreement_val": {
- "description": "Description of the agreement this DPA supplements. Required when `underlying_agreement_type` is `external`.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "framework_terms_description": {
- "description": "Custom framework terms description. Only used when framework_terms_type is \"description\".",
- "type": "string"
- },
- "framework_terms_type": {
- "description": "How framework terms are specified. Use \"new\" for standard terms or \"description\" to provide a custom framework_terms_description.",
- "enum": [
- "new",
- "description"
- ],
- "type": "string"
- },
- "governing_law_country": {
- "description": "The country whose laws govern the agreement.",
- "type": "string"
- },
- "governing_law_region": {
- "description": "The state or region whose laws govern the agreement.",
- "type": "string"
- },
- "include_automated_payment_reminders": {
- "description": "When true, automatically sends payment reminder emails.",
- "type": "boolean"
- },
- "include_billing_info": {
- "description": "When true, billing contact information (billing_name, billing_email) is included.",
- "type": "boolean"
- },
- "include_billing_workflow": {
- "description": "When true, enables a billing workflow after signing.",
- "type": "boolean"
- },
- "include_expiration_date": {
- "description": "Expiration date in YYYY-MM-DD format. Use when include_expiration_type is \"date\".",
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "include_expiration_days": {
- "description": "Number of days until the agreement expires. Use when include_expiration_type is \"days\".",
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_expiration_type": {
- "description": "How to set expiration: \"none\" (default), \"days\" (use include_expiration_days), or \"date\" (use include_expiration_date).",
- "enum": [
- "none",
- "days",
- "date"
- ],
- "type": "string"
- },
- "include_terms": {
- "description": "When true, the standard terms are included with the agreement.",
- "type": "boolean"
- },
- "loi_attributes": {
- "additionalProperties": false,
- "description": "Override loi terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "confidentiality_custom": {
- "type": "string"
- },
- "confidentiality_mutual_include_loi": {
- "type": "boolean"
- },
- "confidentiality_nda_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "confidentiality_nda_description": {
- "type": "string"
- },
- "confidentiality_nda_include_loi": {
- "type": "boolean"
- },
- "confidentiality_nda_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "confidentiality_type": {
- "enum": [
- "mutual",
- "nda",
- "provider",
- "custom"
- ],
- "type": "string"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_custom_details": {
- "type": "boolean"
- },
- "include_custom_details_val": {
- "type": "string"
- },
- "include_fees": {
- "type": "boolean"
- },
- "include_fees_amount": {
- "type": "number"
- },
- "include_fees_amount_duration": {
- "enum": [
- "month",
- "year",
- "quarter"
- ],
- "type": "string"
- },
- "include_fees_include_amount": {
- "type": "boolean"
- },
- "include_fees_include_other": {
- "type": "boolean"
- },
- "include_fees_other": {
- "type": "string"
- },
- "include_functionality": {
- "type": "boolean"
- },
- "include_functionality_val": {
- "type": "string"
- },
- "include_launch_date": {
- "type": "boolean"
- },
- "include_launch_date_custom": {
- "type": "string"
- },
- "include_launch_date_date": {
- "format": "date-time",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$",
- "type": "string"
- },
- "include_launch_date_type": {
- "enum": [
- "date",
- "custom"
- ],
- "type": "string"
- },
- "product_name": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "manual_send": {
- "description": "When true, the agreement is marked as manually sent outside the platform.",
- "type": "boolean"
- },
- "message": {
- "type": "string"
- },
- "negotiations_allowed": {
- "description": "When true, the recipient can propose changes to the legal terms. For agreement types without separate business terms, that covers every term. CSA order forms, PSA statements of work, partnership business terms and software license order forms have their own `negotiations_allowed` flag.",
- "type": "boolean"
- },
- "partnership_attributes": {
- "additionalProperties": false,
- "description": "Override partnership terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "effective_date": {
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "effective_date_type": {
- "enum": [
- "signature",
- "date"
- ],
- "type": "string"
- },
- "general_cap_amount_currency_val": {
- "type": "number"
- },
- "general_cap_amount_either_currency": {
- "type": "number"
- },
- "general_cap_amount_either_multiple": {
- "type": "number"
- },
- "general_cap_amount_multiple_val": {
- "type": "number"
- },
- "general_cap_amount_type": {
- "enum": [
- "multiple",
- "currency",
- "either",
- "base"
- ],
- "type": "string"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_additional_warranties": {
- "type": "boolean"
- },
- "include_additional_warranties_include_company": {
- "type": "boolean"
- },
- "include_additional_warranties_include_company_val": {
- "type": "string"
- },
- "include_additional_warranties_include_partner": {
- "type": "boolean"
- },
- "include_additional_warranties_include_partner_val": {
- "type": "string"
- },
- "include_brand_guidelines": {
- "type": "boolean"
- },
- "include_brand_guidelines_include_company": {
- "type": "boolean"
- },
- "include_brand_guidelines_include_company_val": {
- "type": "string"
- },
- "include_brand_guidelines_include_partner": {
- "type": "boolean"
- },
- "include_brand_guidelines_include_partner_val": {
- "type": "string"
- },
- "include_covered_claims": {
- "type": "boolean"
- },
- "include_covered_claims_company_claims": {
- "type": "string"
- },
- "include_covered_claims_include_company_claims": {
- "type": "boolean"
- },
- "include_covered_claims_include_partner_claims": {
- "type": "boolean"
- },
- "include_covered_claims_partner_claims": {
- "type": "string"
- },
- "include_dpa": {
- "type": "boolean"
- },
- "include_dpa_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_dpa_location": {
- "type": "string"
- },
- "include_dpa_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_increased_cap_amount": {
- "type": "boolean"
- },
- "include_increased_cap_amount_currency": {
- "type": "number"
- },
- "include_increased_cap_amount_either_currency": {
- "type": "number"
- },
- "include_increased_cap_amount_either_multiple": {
- "type": "string"
- },
- "include_increased_cap_amount_multiple": {
- "type": "string"
- },
- "include_increased_cap_amount_type": {
- "enum": [
- "multiple",
- "currency",
- "either"
- ],
- "type": "string"
- },
- "include_increased_claims": {
- "type": "boolean"
- },
- "include_increased_claims_include_confidentiality": {
- "type": "boolean"
- },
- "include_increased_claims_include_confidentiality_misconduct": {
- "type": "boolean"
- },
- "include_increased_claims_include_covered_claims": {
- "type": "boolean"
- },
- "include_increased_claims_include_misconduct": {
- "type": "boolean"
- },
- "include_increased_claims_include_other": {
- "type": "boolean"
- },
- "include_increased_claims_include_other_val": {
- "type": "string"
- },
- "include_unlimited_claims": {
- "type": "boolean"
- },
- "include_unlimited_claims_confidentiality": {
- "type": "boolean"
- },
- "include_unlimited_claims_confidentiality_misconduct": {
- "type": "boolean"
- },
- "include_unlimited_claims_covered_claims": {
- "type": "boolean"
- },
- "include_unlimited_claims_misconduct": {
- "type": "boolean"
- },
- "include_unlimited_claims_other": {
- "type": "boolean"
- },
- "include_unlimited_claims_other_val": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "partnership_business_terms_attributes": {
- "additionalProperties": false,
- "description": "Override partnership business terms terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "end_date_after_effective_date_amount": {
- "type": "number"
- },
- "end_date_after_effective_date_unit": {
- "enum": [
- "month(s)",
- "quarter(s)",
- "year(s)"
- ],
- "type": "string"
- },
- "end_date_date": {
- "type": "string"
- },
- "end_date_type": {
- "enum": [
- "date",
- "effective date"
- ],
- "type": "string"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_obligations_company_brand": {
- "type": "boolean"
- },
- "include_obligations_company_promotion": {
- "type": "boolean"
- },
- "include_obligations_company_promotion_include_activities": {
- "type": "boolean"
- },
- "include_obligations_company_promotion_include_activities_val": {
- "type": "string"
- },
- "include_obligations_company_promotion_include_materials": {
- "type": "boolean"
- },
- "include_obligations_company_promotion_include_materials_val": {
- "type": "string"
- },
- "include_obligations_company_referral": {
- "type": "boolean"
- },
- "include_obligations_company_referral_include_criteria": {
- "type": "boolean"
- },
- "include_obligations_company_referral_include_criteria_val": {
- "type": "string"
- },
- "include_obligations_company_referral_include_pay_sch": {
- "type": "boolean"
- },
- "include_obligations_company_referral_include_pay_sch_amount": {
- "type": "number"
- },
- "include_obligations_company_referral_include_pay_sch_custom": {
- "type": "string"
- },
- "include_obligations_company_referral_include_pay_sch_unit": {
- "enum": [
- "U.S. Dollars",
- "percent"
- ],
- "type": "string"
- },
- "include_obligations_company_sponsorship": {
- "type": "boolean"
- },
- "include_obligations_company_sponsorship_include_benefits": {
- "type": "boolean"
- },
- "include_obligations_company_sponsorship_include_benefits_val": {
- "type": "string"
- },
- "include_obligations_company_sponsorship_include_payments": {
- "type": "boolean"
- },
- "include_obligations_company_sponsorship_include_payments_amount": {
- "type": "number"
- },
- "include_obligations_company_sponsorship_include_payments_unit": {
- "enum": [
- "U.S. Dollars",
- "percent"
- ],
- "type": "string"
- },
- "include_obligations_partner_brand": {
- "type": "boolean"
- },
- "include_obligations_partner_promotion": {
- "type": "boolean"
- },
- "include_obligations_partner_promotion_include_activities": {
- "type": "boolean"
- },
- "include_obligations_partner_promotion_include_activities_val": {
- "type": "string"
- },
- "include_obligations_partner_promotion_include_materials": {
- "type": "boolean"
- },
- "include_obligations_partner_promotion_include_materials_val": {
- "type": "string"
- },
- "include_obligations_partner_referral": {
- "type": "boolean"
- },
- "include_obligations_partner_referral_include_criteria": {
- "type": "boolean"
- },
- "include_obligations_partner_referral_include_criteria_val": {
- "type": "string"
- },
- "include_obligations_partner_referral_include_pay_sch": {
- "type": "boolean"
- },
- "include_obligations_partner_referral_include_pay_sch_amount": {
- "type": "number"
- },
- "include_obligations_partner_referral_include_pay_sch_custom": {
- "type": "string"
- },
- "include_obligations_partner_referral_include_pay_sch_unit": {
- "enum": [
- "U.S. Dollars",
- "percent"
- ],
- "type": "string"
- },
- "include_obligations_partner_sponsorship": {
- "type": "boolean"
- },
- "include_obligations_partner_sponsorship_include_benefits": {
- "type": "boolean"
- },
- "include_obligations_partner_sponsorship_include_benefits_val": {
- "type": "string"
- },
- "include_obligations_partner_sponsorship_include_payments": {
- "type": "boolean"
- },
- "include_obligations_partner_sponsorship_include_payments_amount": {
- "type": "number"
- },
- "include_obligations_partner_sponsorship_include_payments_unit": {
- "enum": [
- "U.S. Dollars",
- "percent"
- ],
- "type": "string"
- },
- "include_payment_process": {
- "type": "boolean"
- },
- "include_payment_process_company": {
- "type": "boolean"
- },
- "include_payment_process_company_include_address": {
- "type": "boolean"
- },
- "include_payment_process_company_include_address_city": {
- "type": "string"
- },
- "include_payment_process_company_include_address_country": {
- "type": "string"
- },
- "include_payment_process_company_include_address_state": {
- "type": "string"
- },
- "include_payment_process_company_include_address_street_address": {
- "type": "string"
- },
- "include_payment_process_company_include_address_zipcode": {
- "type": "string"
- },
- "include_payment_process_company_include_email": {
- "type": "boolean"
- },
- "include_payment_process_company_include_email_val": {
- "type": "string"
- },
- "include_payment_process_partner": {
- "type": "boolean"
- },
- "include_payment_process_partner_include_address": {
- "type": "boolean"
- },
- "include_payment_process_partner_include_address_city": {
- "type": "string"
- },
- "include_payment_process_partner_include_address_country": {
- "type": "string"
- },
- "include_payment_process_partner_include_address_state": {
- "type": "string"
- },
- "include_payment_process_partner_include_address_street_address": {
- "type": "string"
- },
- "include_payment_process_partner_include_address_zipcode": {
- "type": "string"
- },
- "include_payment_process_partner_include_email": {
- "type": "boolean"
- },
- "include_payment_process_partner_include_email_val": {
- "type": "string"
- },
- "include_payment_schedule": {
- "type": "boolean"
- },
- "include_payment_schedule_custom": {
- "type": "string"
- },
- "include_payment_schedule_specified_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_payment_schedule_specified_timeframe": {
- "enum": [
- "receipt",
- "date"
- ],
- "type": "string"
- },
- "include_payment_schedule_specified_unit": {
- "enum": [
- "day(s)",
- "week(s)",
- "month(s)",
- "quarter(s)",
- "year(s)"
- ],
- "type": "string"
- },
- "include_payment_schedule_type": {
- "enum": [
- "specified",
- "custom"
- ],
- "type": "string"
- },
- "negotiations_allowed": {
- "description": "When true, the recipient can propose changes to the business terms, even when the agreement-level `negotiations_allowed` is false. This only covers the business terms.",
- "type": "boolean"
- },
- "territory_type": {
- "enum": [
- "worldwide",
- "custom"
- ],
- "type": "string"
- },
- "territory_type_val": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "payment_link_url": {
- "description": "A payment URL shown to the recipient after signing. Requires include_billing_workflow to be true and billing_workflow_type to be \"link\".",
- "type": "string"
- },
- "pilot_attributes": {
- "additionalProperties": false,
- "description": "Override pilot terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "fees_type": {
- "enum": [
- "free",
- "pilot_period_fees"
- ],
- "type": "string"
- },
- "general_cap_amount": {
- "type": "number"
- },
- "general_cap_amount_type": {
- "enum": [
- "preceding",
- "base",
- "period"
- ],
- "type": "string"
- },
- "general_cap_period_currency": {
- "type": "number"
- },
- "general_cap_period_qty": {
- "type": "number"
- },
- "general_cap_preceding_amount": {
- "type": "number"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_dpa": {
- "type": "boolean"
- },
- "include_dpa_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_dpa_location": {
- "type": "string"
- },
- "include_dpa_type": {
- "enum": [
- "description",
- "attachment",
- "standard"
- ],
- "type": "string"
- },
- "include_payment_process": {
- "type": "boolean"
- },
- "include_technical_support": {
- "type": "boolean"
- },
- "payment_process_automatic_frequency": {
- "enum": [
- "monthly",
- "quarterly",
- "annually",
- "once_per_period"
- ],
- "type": "string"
- },
- "payment_process_invoice_days": {
- "type": "number"
- },
- "payment_process_invoice_from": {
- "enum": [
- "receipt",
- "date"
- ],
- "type": "string"
- },
- "payment_process_invoice_timeframe": {
- "enum": [
- "days",
- "weeks",
- "months",
- "quarters",
- "years"
- ],
- "type": "string"
- },
- "payment_process_type": {
- "enum": [
- "automatic",
- "invoice"
- ],
- "type": "string"
- },
- "pilot_period_description": {
- "type": "string"
- },
- "pilot_period_fees_description": {
- "type": "string"
- },
- "product_description": {
- "type": "string"
- },
- "technical_support_description": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "psa_attributes": {
- "additionalProperties": false,
- "description": "Override psa terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "additional_changes": {
- "type": "string"
- },
- "customer_description": {
- "type": "string"
- },
- "effective_date": {
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "effective_date_type": {
- "enum": [
- "signature",
- "date"
- ],
- "type": "string"
- },
- "general_cap_amount": {
- "type": "number"
- },
- "general_cap_amount_type": {
- "enum": [
- "preceding",
- "base",
- "period"
- ],
- "type": "string"
- },
- "general_cap_period_currency": {
- "type": "number"
- },
- "general_cap_period_qty": {
- "type": "number"
- },
- "general_cap_preceding_amount": {
- "type": "number"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_additional_changes": {
- "type": "boolean"
- },
- "include_additional_warranties": {
- "type": "boolean"
- },
- "include_additional_warranties_by_customer": {
- "type": "string"
- },
- "include_additional_warranties_by_provider": {
- "type": "string"
- },
- "include_additional_warranties_include_by_customer": {
- "type": "boolean"
- },
- "include_additional_warranties_include_by_provider": {
- "type": "boolean"
- },
- "include_covered_claims": {
- "type": "boolean"
- },
- "include_covered_claims_customer_claims": {
- "type": "string"
- },
- "include_covered_claims_include_customer_claims": {
- "type": "boolean"
- },
- "include_covered_claims_include_provider_claims": {
- "type": "boolean"
- },
- "include_covered_claims_provider_claims": {
- "type": "string"
- },
- "include_customer_insurance_min": {
- "type": "boolean"
- },
- "include_customer_insurance_min_add_provider_com_gen_liability": {
- "type": "boolean"
- },
- "include_customer_insurance_min_add_provider_cyber_liability": {
- "type": "boolean"
- },
- "include_customer_insurance_min_add_provider_errors_omissions": {
- "type": "boolean"
- },
- "include_customer_insurance_min_auto_liability_aggregate": {
- "type": "number"
- },
- "include_customer_insurance_min_auto_liability_minimum": {
- "type": "number"
- },
- "include_customer_insurance_min_cyber_liability_aggregate": {
- "type": "number"
- },
- "include_customer_insurance_min_cyber_liability_minimum": {
- "type": "number"
- },
- "include_customer_insurance_min_employer_liability_aggregate": {
- "type": "number"
- },
- "include_customer_insurance_min_employer_liability_minimum": {
- "type": "number"
- },
- "include_customer_insurance_min_general_liability_aggregate": {
- "type": "number"
- },
- "include_customer_insurance_min_general_liability_minimum": {
- "type": "number"
- },
- "include_customer_insurance_min_include_add_provider": {
- "type": "boolean"
- },
- "include_customer_insurance_min_include_auto_liability": {
- "type": "boolean"
- },
- "include_customer_insurance_min_include_cyber_liability": {
- "type": "boolean"
- },
- "include_customer_insurance_min_include_employer_liability": {
- "type": "boolean"
- },
- "include_customer_insurance_min_include_general_liability": {
- "type": "boolean"
- },
- "include_customer_insurance_min_include_workers_comp": {
- "type": "boolean"
- },
- "include_customer_policies": {
- "type": "boolean"
- },
- "include_customer_policies_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_customer_policies_location": {
- "type": "string"
- },
- "include_customer_policies_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_dpa": {
- "type": "boolean"
- },
- "include_dpa_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_dpa_location": {
- "type": "string"
- },
- "include_dpa_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_increased_cap_amount": {
- "type": "boolean"
- },
- "include_increased_claims": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_confidentiality": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_confidentiality_negligence": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_privsec": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_privsec_negligence": {
- "type": "boolean"
- },
- "include_increased_claims_include_other": {
- "type": "boolean"
- },
- "include_increased_claims_indemnification_obligation": {
- "type": "boolean"
- },
- "include_increased_claims_negligence": {
- "type": "boolean"
- },
- "include_increased_claims_other": {
- "type": "string"
- },
- "include_provider_insurance_min": {
- "type": "boolean"
- },
- "include_provider_insurance_min_add_customer_com_gen_liability": {
- "type": "boolean"
- },
- "include_provider_insurance_min_add_customer_cyber_liability": {
- "type": "boolean"
- },
- "include_provider_insurance_min_add_customer_errors_omissions": {
- "type": "boolean"
- },
- "include_provider_insurance_min_auto_liability_aggregate": {
- "type": "number"
- },
- "include_provider_insurance_min_auto_liability_minimum": {
- "type": "number"
- },
- "include_provider_insurance_min_cyber_liability_aggregate": {
- "type": "number"
- },
- "include_provider_insurance_min_cyber_liability_minimum": {
- "type": "number"
- },
- "include_provider_insurance_min_employer_liability_aggregate": {
- "type": "number"
- },
- "include_provider_insurance_min_employer_liability_minimum": {
- "type": "number"
- },
- "include_provider_insurance_min_general_liability_aggregate": {
- "type": "number"
- },
- "include_provider_insurance_min_general_liability_minimum": {
- "type": "number"
- },
- "include_provider_insurance_min_include_add_customer": {
- "type": "boolean"
- },
- "include_provider_insurance_min_include_auto_liability": {
- "type": "boolean"
- },
- "include_provider_insurance_min_include_cyber_liability": {
- "type": "boolean"
- },
- "include_provider_insurance_min_include_employer_liability": {
- "type": "boolean"
- },
- "include_provider_insurance_min_include_general_liability": {
- "type": "boolean"
- },
- "include_provider_insurance_min_include_workers_comp": {
- "type": "boolean"
- },
- "include_publicity_rights": {
- "type": "boolean"
- },
- "include_publicity_rights_type": {
- "enum": [
- "public",
- "non-public"
- ],
- "type": "string"
- },
- "include_security_policy": {
- "type": "boolean"
- },
- "include_security_policy_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_security_policy_fedramp_auth": {
- "type": "boolean"
- },
- "include_security_policy_hitrust": {
- "type": "boolean"
- },
- "include_security_policy_include_annual_maintenance": {
- "type": "boolean"
- },
- "include_security_policy_include_other": {
- "type": "boolean"
- },
- "include_security_policy_include_other_val": {
- "type": "string"
- },
- "include_security_policy_iso27001": {
- "type": "boolean"
- },
- "include_security_policy_location": {
- "type": "string"
- },
- "include_security_policy_pci1": {
- "type": "boolean"
- },
- "include_security_policy_pci2": {
- "type": "boolean"
- },
- "include_security_policy_penetration_testing": {
- "type": "boolean"
- },
- "include_security_policy_soc2_type1": {
- "type": "boolean"
- },
- "include_security_policy_soc2_type2": {
- "type": "boolean"
- },
- "include_security_policy_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_unlimited_claims": {
- "type": "boolean"
- },
- "include_unlimited_claims_breach_of_confidentiality": {
- "type": "boolean"
- },
- "include_unlimited_claims_breach_of_confidentiality_negligence": {
- "type": "boolean"
- },
- "include_unlimited_claims_breach_of_privsec": {
- "type": "boolean"
- },
- "include_unlimited_claims_breach_of_privsec_negligence": {
- "type": "boolean"
- },
- "include_unlimited_claims_include_other": {
- "type": "boolean"
- },
- "include_unlimited_claims_indemnification_obligation": {
- "type": "boolean"
- },
- "include_unlimited_claims_negligence": {
- "type": "boolean"
- },
- "include_unlimited_claims_other": {
- "type": "string"
- },
- "increased_cap_amount_currency": {
- "type": "number"
- },
- "increased_cap_amount_period_currency": {
- "type": "number"
- },
- "increased_cap_amount_period_qty": {
- "type": "number"
- },
- "increased_cap_amount_qty": {
- "type": "number"
- },
- "increased_cap_amount_type": {
- "enum": [
- "qty",
- "currency",
- "period"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- "psa_statement_of_work_attributes": {
- "additionalProperties": false,
- "description": "Override psa statement of work terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "additional_changes": {
- "type": "string"
- },
- "cost": {
- "type": "number"
- },
- "description": {
- "type": "string"
- },
- "fee_type": {
- "type": "string"
- },
- "fees_attributes": {
- "additionalProperties": {
- "anyOf": [
- {
- "additionalProperties": false,
- "description": "Fees::Flat (fee_type \"flat\"). A fixed recurring fee, e.g. a platform subscription. Set type to \"Fees::Flat\" or fee_type to \"flat\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "Fixed amount in the order form's fees_currency, charged per fee_period. A plain amount, not cents: 20 means 20.00.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"flat\". Alternative to type.",
- "enum": [
- "flat"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Flat\". Optional when fee_type is set.",
- "enum": [
- "Fees::Flat"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Discount (fee_type \"discount\"). A discount, as a fixed amount or a percentage, applied forever, once, or for a number of months. Set type to \"Fees::Discount\" or fee_type to \"discount\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "Discount size: an amount in fees_currency when discount_type is fixed_amount (a plain amount, not cents: 20 means 20.00), or a percentage (e.g. 10 for 10%) when it is percentage.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "discount_duration_amount": {
- "description": "Number of months the discount applies. Required when discount_duration_type is multiple_months.",
- "type": "number"
- },
- "discount_duration_type": {
- "description": "How long the discount applies. multiple_months also needs discount_duration_amount.",
- "enum": [
- "forever",
- "once",
- "multiple_months"
- ],
- "type": "string"
- },
- "discount_type": {
- "description": "Whether cost is a currency amount or a percentage.",
- "enum": [
- "fixed_amount",
- "percentage"
- ],
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"discount\". Alternative to type.",
- "enum": [
- "discount"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Discount\". Optional when fee_type is set.",
- "enum": [
- "Fees::Discount"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Cost (fee_type \"cost\"). A per-unit fee: price per unit times quantity, e.g. seats. Set type to \"Fees::Cost\" or fee_type to \"cost\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "Price per unit in fees_currency. The row total is quantity x cost. A plain amount, not cents: 20 means 20.00.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"cost\". Alternative to type.",
- "enum": [
- "cost"
- ],
- "type": "string"
- },
- "quantity": {
- "description": "Number of units.",
- "type": "number"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Cost\". Optional when fee_type is set.",
- "enum": [
- "Fees::Cost"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Attachment (fee_type \"attachment\"). A fee described in an uploaded attachment instead of in the table. Set type to \"Fees::Attachment\" or fee_type to \"attachment\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "attachment_id": {
- "description": "ID of an attachment uploaded with upload-attachment.",
- "type": "string"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"attachment\". Alternative to type.",
- "enum": [
- "attachment"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Attachment\". Optional when fee_type is set.",
- "enum": [
- "Fees::Attachment"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Graduated (fee_type \"graduated\"). Tiered pricing, with the price set per tier in graduated_fee_tiers_attributes. Set type to \"Fees::Graduated\" or fee_type to \"graduated\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"graduated\". Alternative to type.",
- "enum": [
- "graduated"
- ],
- "type": "string"
- },
- "graduated_fee_tiers_attributes": {
- "additionalProperties": {
- "additionalProperties": false,
- "properties": {
- "flat_price": {
- "type": "number"
- },
- "price_per_unit": {
- "type": "string"
- },
- "upper_limit": {
- "type": "number"
- }
- },
- "type": "object"
- },
- "description": "Graduated fee tiers. Use string keys such as \"0\", \"1\".",
- "propertyNames": {
- "type": "string"
- },
- "type": "object"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Graduated\". Optional when fee_type is set.",
- "enum": [
- "Fees::Graduated"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Included (fee_type \"included\"). An item included at no charge. Set type to \"Fees::Included\" or fee_type to \"included\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"included\". Alternative to type.",
- "enum": [
- "included"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Included\". Optional when fee_type is set.",
- "enum": [
- "Fees::Included"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Metered (fee_type \"metered\"). Usage-based pricing, billed per unit used. Set type to \"Fees::Metered\" or fee_type to \"metered\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "Price per unit of usage in fees_currency. A plain amount, not cents: 20 means 20.00.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"metered\". Alternative to type.",
- "enum": [
- "metered"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Metered\". Optional when fee_type is set.",
- "enum": [
- "Fees::Metered"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::OneTime (fee_type \"one_time\"). A one-time charge, such as a setup fee. Set type to \"Fees::OneTime\" or fee_type to \"one_time\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "One-time amount in fees_currency, charged once rather than per fee_period. A plain amount, not cents: 20 means 20.00.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"one_time\". Alternative to type.",
- "enum": [
- "one_time"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::OneTime\". Optional when fee_type is set.",
- "enum": [
- "Fees::OneTime"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Text (fee_type \"text\"). A fee term described in free text. Set type to \"Fees::Text\" or fee_type to \"text\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"text\". Alternative to type.",
- "enum": [
- "text"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Text\". Optional when fee_type is set.",
- "enum": [
- "Fees::Text"
- ],
- "type": "string"
- }
- },
- "type": "object"
- }
- ]
- },
- "description": "Fee line items. Use string keys such as \"0\", \"1\". Replaces template fees when provided.",
- "propertyNames": {
- "type": "string"
- },
- "type": "object"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_additional_changes": {
- "type": "boolean"
- },
- "include_customer_obligation": {
- "type": "boolean"
- },
- "include_customer_obligation_val": {
- "type": "string"
- },
- "include_deliverables": {
- "type": "boolean"
- },
- "include_deliverables_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_deliverables_description": {
- "type": "string"
- },
- "include_deliverables_include_acceptance": {
- "type": "boolean"
- },
- "include_deliverables_include_attachment": {
- "type": "boolean"
- },
- "include_deliverables_include_draft_deliverables": {
- "type": "boolean"
- },
- "include_deliverables_rejection_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_deliverables_rejection_unit": {
- "enum": [
- "hours",
- "days",
- "weeks",
- "months"
- ],
- "type": "string"
- },
- "include_deliverables_resubmission_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_deliverables_resubmission_unit": {
- "enum": [
- "hours",
- "days",
- "weeks",
- "months"
- ],
- "type": "string"
- },
- "include_fees_other": {
- "type": "boolean"
- },
- "include_fees_other_val": {
- "type": "string"
- },
- "include_fees_table": {
- "type": "boolean"
- },
- "include_fees_table_total": {
- "type": "boolean"
- },
- "include_fees_travel": {
- "type": "boolean"
- },
- "include_fees_travel_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_fees_travel_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_fees_travel_val": {
- "type": "string"
- },
- "include_third_party_customer": {
- "type": "boolean"
- },
- "include_third_party_include_description": {
- "type": "boolean"
- },
- "include_third_party_include_description_val": {
- "type": "string"
- },
- "include_third_party_materials": {
- "type": "boolean"
- },
- "include_third_party_provider": {
- "type": "boolean"
- },
- "include_time_of_assignment": {
- "type": "boolean"
- },
- "include_time_of_assignment_type": {
- "enum": [
- "created",
- "paid"
- ],
- "type": "string"
- },
- "invoice_period_description": {
- "type": "string"
- },
- "negotiations_allowed": {
- "description": "When true, the recipient can propose changes to the statement of work, even when the agreement-level `negotiations_allowed` is false. This only covers the statement of work.",
- "type": "boolean"
- },
- "payment_period": {
- "type": "number"
- },
- "payment_period_other": {
- "type": "string"
- },
- "payment_period_timeframe": {
- "enum": [
- "receipt",
- "invoice",
- "Customer's receipt of invoice",
- "date of invoice"
- ],
- "type": "string"
- },
- "payment_period_type": {
- "enum": [
- "standard",
- "other"
- ],
- "type": "string"
- },
- "payment_period_unit": {
- "enum": [
- "day(s)",
- "week(s)",
- "month(s)",
- "quarter(s)",
- "year(s)"
- ],
- "type": "string"
- },
- "quantity": {
- "type": "number"
- },
- "services_description": {
- "type": "string"
- },
- "sow_date": {
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "sow_date_type": {
- "enum": [
- "signature",
- "date"
- ],
- "type": "string"
- },
- "sow_term_amount": {
- "type": "number"
- },
- "sow_term_date": {
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "sow_term_type": {
- "enum": [
- "deliverables",
- "period",
- "date"
- ],
- "type": "string"
- },
- "sow_term_unit": {
- "enum": [
- "month(s)",
- "quarter(s)",
- "year(s)"
- ],
- "type": "string"
- },
- "type": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "recipient_email": {
- "format": "email",
- "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-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_last_to_sign": {
- "description": "When true, your signer signs after the recipient.",
- "type": "boolean"
- },
- "sender_notice_email_address": {
- "description": "Email address for legal notices to the sender.",
- "format": "email",
- "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-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": {
- "enum": [
- "signature",
- "date"
- ],
- "type": "string"
- },
- "general_cap_amount": {
- "type": "number"
- },
- "general_cap_amount_type": {
- "enum": [
- "preceding",
- "base",
- "period"
- ],
- "type": "string"
- },
- "general_cap_period_currency": {
- "type": "number"
- },
- "general_cap_period_qty": {
- "type": "number"
- },
- "general_cap_preceding_amount": {
- "type": "number"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_additional_warranties": {
- "type": "boolean"
- },
- "include_additional_warranties_by_customer": {
- "type": "string"
- },
- "include_additional_warranties_by_provider": {
- "type": "string"
- },
- "include_additional_warranties_include_by_customer": {
- "type": "boolean"
- },
- "include_additional_warranties_include_by_provider": {
- "type": "boolean"
- },
- "include_ai_addendum": {
- "type": "boolean"
- },
- "include_ai_addendum_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_covered_claims": {
- "type": "boolean"
- },
- "include_covered_claims_customer_claims": {
- "type": "string"
- },
- "include_covered_claims_include_customer_claims": {
- "type": "boolean"
- },
- "include_covered_claims_include_provider_claims": {
- "type": "boolean"
- },
- "include_covered_claims_provider_claims": {
- "type": "string"
- },
- "include_dpa": {
- "type": "boolean"
- },
- "include_dpa_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_dpa_location": {
- "type": "string"
- },
- "include_dpa_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_increased_cap_amount": {
- "type": "boolean"
- },
- "include_increased_claims": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_confidentiality": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_confidentiality_negligence": {
- "type": "boolean"
- },
- "include_increased_claims_include_other": {
- "type": "boolean"
- },
- "include_increased_claims_indemnification_obligation": {
- "type": "boolean"
- },
- "include_increased_claims_negligence": {
- "type": "boolean"
- },
- "include_increased_claims_other": {
- "type": "string"
- },
- "include_increased_claims_restrictions": {
- "type": "boolean"
- },
- "include_unlimited_claims": {
- "type": "boolean"
- },
- "include_unlimited_claims_breach_of_confidentiality": {
- "type": "boolean"
- },
- "include_unlimited_claims_breach_of_confidentiality_negligence": {
- "type": "boolean"
- },
- "include_unlimited_claims_include_other": {
- "type": "boolean"
- },
- "include_unlimited_claims_indemnification_obligation": {
- "type": "boolean"
- },
- "include_unlimited_claims_license_or_restrictions": {
- "type": "boolean"
- },
- "include_unlimited_claims_negligence": {
- "type": "boolean"
- },
- "include_unlimited_claims_other": {
- "type": "string"
- },
- "increased_cap_amount_currency": {
- "type": "number"
- },
- "increased_cap_amount_period_currency": {
- "type": "number"
- },
- "increased_cap_amount_period_qty": {
- "type": "number"
- },
- "increased_cap_amount_qty": {
- "type": "number"
- },
- "increased_cap_amount_type": {
- "enum": [
- "qty",
- "currency",
- "period"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- "software_license_order_form_attributes": {
- "additionalProperties": false,
- "description": "Override software license order form terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "additional_changes": {
- "type": "string"
- },
- "deletion_procedure_include_custom": {
- "type": "boolean"
- },
- "deletion_procedure_include_custom_description": {
- "type": "string"
- },
- "deletion_procedure_include_customer_disable": {
- "type": "boolean"
- },
- "deletion_procedure_include_customer_proof": {
- "type": "boolean"
- },
- "deletion_procedure_include_provider_disable": {
- "type": "boolean"
- },
- "fee_custom_unit": {
- "type": "string"
- },
- "fee_period": {
- "enum": [
- "Subscription Period",
- "month",
- "year",
- "Custom unit"
- ],
- "type": "string"
- },
- "fees_attributes": {
- "additionalProperties": {
- "anyOf": [
- {
- "additionalProperties": false,
- "description": "Fees::Flat (fee_type \"flat\"). A fixed recurring fee, e.g. a platform subscription. Set type to \"Fees::Flat\" or fee_type to \"flat\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "Fixed amount in the order form's fees_currency, charged per fee_period. A plain amount, not cents: 20 means 20.00.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"flat\". Alternative to type.",
- "enum": [
- "flat"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Flat\". Optional when fee_type is set.",
- "enum": [
- "Fees::Flat"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Discount (fee_type \"discount\"). A discount, as a fixed amount or a percentage, applied forever, once, or for a number of months. Set type to \"Fees::Discount\" or fee_type to \"discount\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "Discount size: an amount in fees_currency when discount_type is fixed_amount (a plain amount, not cents: 20 means 20.00), or a percentage (e.g. 10 for 10%) when it is percentage.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "discount_duration_amount": {
- "description": "Number of months the discount applies. Required when discount_duration_type is multiple_months.",
- "type": "number"
- },
- "discount_duration_type": {
- "description": "How long the discount applies. multiple_months also needs discount_duration_amount.",
- "enum": [
- "forever",
- "once",
- "multiple_months"
- ],
- "type": "string"
- },
- "discount_type": {
- "description": "Whether cost is a currency amount or a percentage.",
- "enum": [
- "fixed_amount",
- "percentage"
- ],
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"discount\". Alternative to type.",
- "enum": [
- "discount"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Discount\". Optional when fee_type is set.",
- "enum": [
- "Fees::Discount"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Cost (fee_type \"cost\"). A per-unit fee: price per unit times quantity, e.g. seats. Set type to \"Fees::Cost\" or fee_type to \"cost\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "Price per unit in fees_currency. The row total is quantity x cost. A plain amount, not cents: 20 means 20.00.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"cost\". Alternative to type.",
- "enum": [
- "cost"
- ],
- "type": "string"
- },
- "quantity": {
- "description": "Number of units.",
- "type": "number"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Cost\". Optional when fee_type is set.",
- "enum": [
- "Fees::Cost"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Attachment (fee_type \"attachment\"). A fee described in an uploaded attachment instead of in the table. Set type to \"Fees::Attachment\" or fee_type to \"attachment\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "attachment_id": {
- "description": "ID of an attachment uploaded with upload-attachment.",
- "type": "string"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"attachment\". Alternative to type.",
- "enum": [
- "attachment"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Attachment\". Optional when fee_type is set.",
- "enum": [
- "Fees::Attachment"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Graduated (fee_type \"graduated\"). Tiered pricing, with the price set per tier in graduated_fee_tiers_attributes. Set type to \"Fees::Graduated\" or fee_type to \"graduated\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"graduated\". Alternative to type.",
- "enum": [
- "graduated"
- ],
- "type": "string"
- },
- "graduated_fee_tiers_attributes": {
- "additionalProperties": {
- "additionalProperties": false,
- "properties": {
- "flat_price": {
- "type": "number"
- },
- "price_per_unit": {
- "type": "string"
- },
- "upper_limit": {
- "type": "number"
- }
- },
- "type": "object"
- },
- "description": "Graduated fee tiers. Use string keys such as \"0\", \"1\".",
- "propertyNames": {
- "type": "string"
- },
- "type": "object"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Graduated\". Optional when fee_type is set.",
- "enum": [
- "Fees::Graduated"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Included (fee_type \"included\"). An item included at no charge. Set type to \"Fees::Included\" or fee_type to \"included\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"included\". Alternative to type.",
- "enum": [
- "included"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Included\". Optional when fee_type is set.",
- "enum": [
- "Fees::Included"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Metered (fee_type \"metered\"). Usage-based pricing, billed per unit used. Set type to \"Fees::Metered\" or fee_type to \"metered\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "Price per unit of usage in fees_currency. A plain amount, not cents: 20 means 20.00.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"metered\". Alternative to type.",
- "enum": [
- "metered"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Metered\". Optional when fee_type is set.",
- "enum": [
- "Fees::Metered"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::OneTime (fee_type \"one_time\"). A one-time charge, such as a setup fee. Set type to \"Fees::OneTime\" or fee_type to \"one_time\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "cost": {
- "description": "One-time amount in fees_currency, charged once rather than per fee_period. A plain amount, not cents: 20 means 20.00.",
- "type": "number"
- },
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"one_time\". Alternative to type.",
- "enum": [
- "one_time"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::OneTime\". Optional when fee_type is set.",
- "enum": [
- "Fees::OneTime"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Fees::Text (fee_type \"text\"). A fee term described in free text. Set type to \"Fees::Text\" or fee_type to \"text\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
- "properties": {
- "description": {
- "description": "Line item label shown in the fee table.",
- "type": "string"
- },
- "fee_type": {
- "description": "Fee class as a short name: \"text\". Alternative to type.",
- "enum": [
- "text"
- ],
- "type": "string"
- },
- "stripe_product_id": {
- "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
- "type": "string"
- },
- "type": {
- "description": "Fee class: \"Fees::Text\". Optional when fee_type is set.",
- "enum": [
- "Fees::Text"
- ],
- "type": "string"
- }
- },
- "type": "object"
- }
- ]
- },
- "description": "Fee line items. Use string keys such as \"0\", \"1\". Replaces template fees when provided.",
- "propertyNames": {
- "type": "string"
- },
- "type": "object"
- },
- "fees_currency": {
- "enum": [
- "USD",
- "EUR",
- "GBP",
- "CAD",
- "AUD",
- "SGD",
- "ILS",
- "JPY",
- "CHF",
- "HKD"
- ],
- "type": "string"
- },
- "fees_include_fee_increase_upon_renewal": {
- "type": "boolean"
- },
- "fees_include_fee_increase_upon_renewal_fee": {
- "type": "number"
- },
- "fees_include_fee_increase_upon_renewal_type": {
- "enum": [
- "will",
- "may"
- ],
- "type": "string"
- },
- "fees_inclusive_of_taxes": {
- "type": "boolean"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_additional_changes": {
- "type": "boolean"
- },
- "include_license_compliance_verification": {
- "type": "boolean"
- },
- "include_license_compliance_verification_description": {
- "type": "string"
- },
- "include_license_limits": {
- "type": "boolean"
- },
- "include_license_limits_description": {
- "type": "string"
- },
- "include_payment_process_include_billing_email": {
- "type": "boolean"
- },
- "include_pilot_period": {
- "type": "boolean"
- },
- "include_pilot_period_duration_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_pilot_period_duration_type": {
- "enum": [
- "day",
- "week",
- "month"
- ],
- "type": "string"
- },
- "include_pilot_period_include_fees": {
- "type": "boolean"
- },
- "include_pilot_period_include_fees_amount": {
- "type": "number"
- },
- "include_pilot_period_include_modifications": {
- "type": "boolean"
- },
- "include_pilot_period_include_modifications_description": {
- "type": "string"
- },
- "include_services": {
- "type": "boolean"
- },
- "include_services_description": {
- "type": "string"
- },
- "negotiations_allowed": {
- "description": "When true, the recipient can propose changes to the order form, even when the agreement-level `negotiations_allowed` is false. This only covers the order form.",
- "type": "boolean"
- },
- "order_date_date": {
- "type": "string"
- },
- "order_date_type": {
- "enum": [
- "signature",
- "date",
- "other"
- ],
- "type": "string"
- },
- "payment_process_automatic_frequency": {
- "enum": [
- "monthly",
- "quarterly",
- "semiannually",
- "annually"
- ],
- "type": "string"
- },
- "payment_process_type": {
- "enum": [
- "automatic",
- "invoice",
- "custom"
- ],
- "type": "string"
- },
- "payment_process_type_custom_val": {
- "type": "string"
- },
- "payment_process_type_invoice_amount": {
- "type": "number"
- },
- "payment_process_type_invoice_custom_unit": {
- "type": "string"
- },
- "payment_process_type_invoice_duration": {
- "enum": [
- "day",
- "week",
- "month",
- "year",
- "day(s)",
- "week(s)",
- "month(s)",
- "year(s)"
- ],
- "type": "string"
- },
- "payment_process_type_invoice_duration_start": {
- "enum": [
- "Customer's receipt of invoice",
- "date of invoice"
- ],
- "type": "string"
- },
- "payment_process_type_invoice_type": {
- "enum": [
- "monthly",
- "quarterly",
- "semiannually",
- "annually",
- "Custom unit"
- ],
- "type": "string"
- },
- "permitted_uses_include_custom": {
- "type": "boolean"
- },
- "permitted_uses_include_custom_description": {
- "type": "string"
- },
- "permitted_uses_include_customers_affiliates": {
- "type": "boolean"
- },
- "permitted_uses_include_internal_business": {
- "type": "boolean"
- },
- "pilot_period_stripe_product_id": {
- "type": "string"
- },
- "software_description": {
- "type": "string"
- },
- "subscription_auto_renew": {
- "enum": [
- "days",
- "subscription_end"
- ],
- "type": "string"
- },
- "subscription_period": {
- "type": "number"
- },
- "subscription_period_unit": {
- "type": "string"
- },
- "subscription_renewal_notice_days": {
- "type": "number"
- },
- "warranty_period_description_amount": {
- "type": "number"
- },
- "warranty_period_description_duration": {
- "enum": [
- "day",
- "week",
- "month",
- "year"
- ],
- "type": "string"
- },
- "warranty_period_description_duration_start": {
- "enum": [
- "initial delivery of the Software",
- "delivery of the Software and each subsequent Update",
- "the Order Date"
- ],
- "type": "string"
- },
- "warranty_period_type": {
- "enum": [
- "description",
- "none"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- "test_agreement": {
- "description": "When true, marks the agreement as a test. Test agreements do not count against your monthly limit.",
- "type": "boolean"
- }
- },
- "required": [
- "recipient_name",
- "recipient_email"
- ],
- "type": "object"
- },
- "cc_users": {
- "items": {
- "format": "email",
- "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
- "type": "string"
- },
- "type": "array"
- },
- "draft": {
- "description": "When true, the agreement is saved as a draft and not sent to the recipient. Use POST /v1/agreements/{id}/send to send a draft agreement later.",
- "type": "boolean"
- },
- "owner_id": {
- "description": "User id of the agreement owner (sender).",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "signer_id": {
- "description": "User id of the signer from the owner's organization.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "template_id": {
- "description": "UUID of a template from `GET /v1/templates`. Accepts both Common Paper standard templates and uploaded PDF templates (`type` `uploaded_template`).",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- }
- },
- "required": [
- "template_id",
- "owner_id",
- "signer_id",
- "agreement"
- ],
- "type": "object"
- }
-]New value: +[
+ {
+ "additionalProperties": false,
+ "properties": {
+ "agreement": {
+ "additionalProperties": {},
+ "properties": {
+ "amendment_attributes": {
+ "additionalProperties": false,
+ "description": "Override amendment terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "amended_terms_attributes": {
+ "additionalProperties": {
+ "additionalProperties": false,
+ "properties": {
+ "description": {
+ "type": "string"
+ },
+ "term": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "description": "Amended terms. Use string keys such as \"0\", \"1\".",
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+ },
+ "amendment_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "amendment_date_type": {
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "type": "string"
+ },
+ "framework_terms_type": {
+ "type": "string"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "parent_agreement_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "underlying_agreement_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "underlying_agreement_type": {
+ "type": "string"
+ },
+ "underlying_agreement_val": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "baa_attributes": {
+ "additionalProperties": false,
+ "description": "Override baa terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "aggregation_limitations_permitted": {
+ "type": "boolean"
+ },
+ "aggregation_limitations_permitted_val": {
+ "type": "string"
+ },
+ "breach_notification_unit": {
+ "enum": [
+ "hours",
+ "business days",
+ "calendar days"
+ ],
+ "type": "string"
+ },
+ "breach_notification_val": {
+ "type": "number"
+ },
+ "business_associate_relationship_type": {
+ "enum": [
+ "provider",
+ "company"
+ ],
+ "type": "string"
+ },
+ "deidentification_limitations_include_purpose": {
+ "type": "boolean"
+ },
+ "deidentification_limitations_include_requirements": {
+ "type": "boolean"
+ },
+ "deidentification_limitations_permitted": {
+ "type": "boolean"
+ },
+ "deidentification_limitations_purpose_val": {
+ "type": "string"
+ },
+ "deidentification_limitations_requirements_val": {
+ "type": "string"
+ },
+ "designated_record_set_provider_maintains": {
+ "type": "boolean"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_aggregation_limitations": {
+ "type": "boolean"
+ },
+ "include_deidentification_limitations": {
+ "type": "boolean"
+ },
+ "include_limitations": {
+ "type": "boolean"
+ },
+ "include_offshore_limitations": {
+ "type": "boolean"
+ },
+ "include_subcontract_limitations": {
+ "type": "boolean"
+ },
+ "offshore_limitations_permitted": {
+ "type": "boolean"
+ },
+ "offshore_limitations_permitted_val": {
+ "type": "string"
+ },
+ "subcontract_limitations_include_notice": {
+ "type": "boolean"
+ },
+ "subcontract_limitations_include_permission": {
+ "type": "boolean"
+ },
+ "subcontract_limitations_notice_val": {
+ "type": "string"
+ },
+ "subcontract_limitations_permission_val": {
+ "type": "string"
+ },
+ "subcontract_limitations_permitted": {
+ "type": "boolean"
+ },
+ "underlying_agreement_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "underlying_agreement_type": {
+ "enum": [
+ "internal",
+ "external",
+ "none"
+ ],
+ "type": "string"
+ },
+ "underlying_agreement_val": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "billing_email": {
+ "description": "Email of the billing contact. Used when include_billing_info is true.",
+ "format": "email",
+ "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "billing_name": {
+ "description": "Name of the billing contact. Used when include_billing_info is true.",
+ "type": "string"
+ },
+ "billing_workflow_type": {
+ "description": "The type of billing workflow. Use \"link\" to provide a payment_link_url, or \"stripe\" for Stripe-managed billing.",
+ "enum": [
+ "link",
+ "stripe"
+ ],
+ "type": "string"
+ },
+ "chosen_courts_country": {
+ "description": "The country in which disputes will be resolved.",
+ "type": "string"
+ },
+ "chosen_courts_region": {
+ "description": "The state or region in which disputes will be resolved.",
+ "type": "string"
+ },
+ "csa_attributes": {
+ "additionalProperties": false,
+ "description": "Override csa terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "customer_description": {
+ "type": "string"
+ },
+ "effective_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "effective_date_marketplace": {
+ "enum": [
+ "AWS",
+ "GCP",
+ "Azure"
+ ],
+ "type": "string"
+ },
+ "effective_date_type": {
+ "enum": [
+ "signature",
+ "date",
+ "marketplace_acceptance"
+ ],
+ "type": "string"
+ },
+ "general_cap_amount": {
+ "type": "number"
+ },
+ "general_cap_amount_type": {
+ "enum": [
+ "preceding",
+ "base",
+ "period"
+ ],
+ "type": "string"
+ },
+ "general_cap_period_currency": {
+ "type": "number"
+ },
+ "general_cap_period_qty": {
+ "type": "number"
+ },
+ "general_cap_preceding_amount": {
+ "type": "number"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_acceptable_use_policy": {
+ "type": "boolean"
+ },
+ "include_acceptable_use_policy_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_acceptable_use_policy_location": {
+ "type": "string"
+ },
+ "include_acceptable_use_policy_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_additional_warranties": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_by_customer": {
+ "type": "string"
+ },
+ "include_additional_warranties_by_provider": {
+ "type": "string"
+ },
+ "include_additional_warranties_include_by_customer": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_include_by_provider": {
+ "type": "boolean"
+ },
+ "include_ai_addendum": {
+ "type": "boolean"
+ },
+ "include_ai_addendum_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_covered_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_customer_claims": {
+ "type": "string"
+ },
+ "include_covered_claims_include_customer_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_include_provider_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_provider_claims": {
+ "type": "string"
+ },
+ "include_dpa": {
+ "type": "boolean"
+ },
+ "include_dpa_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_dpa_location": {
+ "type": "string"
+ },
+ "include_dpa_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_increased_cap_amount": {
+ "type": "boolean"
+ },
+ "include_increased_claims": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_confidentiality": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_confidentiality_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_privsec": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_privsec_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_other": {
+ "type": "boolean"
+ },
+ "include_increased_claims_indemnification_obligation": {
+ "type": "boolean"
+ },
+ "include_increased_claims_other": {
+ "type": "string"
+ },
+ "include_insurance_minimums": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_add_customer": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_add_customer_com_gen_liability": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_add_customer_cyber_liability": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_add_customer_errors_omissions": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_additional_information": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_additional_information_text": {
+ "type": "string"
+ },
+ "include_insurance_minimums_cyber_liability_aggregate": {
+ "type": "number"
+ },
+ "include_insurance_minimums_cyber_liability_minimum": {
+ "type": "number"
+ },
+ "include_insurance_minimums_employer_liability_aggregate": {
+ "type": "number"
+ },
+ "include_insurance_minimums_employer_liability_minimum": {
+ "type": "number"
+ },
+ "include_insurance_minimums_general_liability_aggregate": {
+ "type": "number"
+ },
+ "include_insurance_minimums_general_liability_minimum": {
+ "type": "number"
+ },
+ "include_insurance_minimums_include_cyber_liability": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_include_employer_liability": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_include_general_liability": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_include_workers_compensation": {
+ "type": "boolean"
+ },
+ "include_publicity_rights": {
+ "type": "boolean"
+ },
+ "include_publicity_rights_type": {
+ "enum": [
+ "public",
+ "non-public"
+ ],
+ "type": "string"
+ },
+ "include_security_policy": {
+ "type": "boolean"
+ },
+ "include_security_policy_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_security_policy_fedramp_auth": {
+ "type": "boolean"
+ },
+ "include_security_policy_hipaa": {
+ "type": "boolean"
+ },
+ "include_security_policy_hitrust": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_annual_maintenance": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_location": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_other": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_reasonable_efforts": {
+ "type": "boolean"
+ },
+ "include_security_policy_iso27001": {
+ "type": "boolean"
+ },
+ "include_security_policy_location": {
+ "type": "string"
+ },
+ "include_security_policy_other": {
+ "type": "string"
+ },
+ "include_security_policy_pci1": {
+ "type": "boolean"
+ },
+ "include_security_policy_pci2": {
+ "type": "boolean"
+ },
+ "include_security_policy_penetration_testing": {
+ "type": "boolean"
+ },
+ "include_security_policy_soc2": {
+ "type": "boolean"
+ },
+ "include_security_policy_soc2_type2": {
+ "type": "boolean"
+ },
+ "include_security_policy_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_supercap": {
+ "description": "CSA 3.0 renamed `include_increased_cap_amount` to `include_supercap`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_increased_cap_amount`. Sending the other spelling returns a 422.",
+ "type": "boolean"
+ },
+ "include_uncapped_claims": {
+ "description": "CSA 3.0 renamed `include_unlimited_claims` to `include_uncapped_claims`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims`. Sending the other spelling returns a 422.",
+ "type": "boolean"
+ },
+ "include_uncapped_claims_breach_of_confidentiality": {
+ "description": "CSA 3.0 renamed `include_unlimited_claims_breach_of_confidentiality` to `include_uncapped_claims_breach_of_confidentiality`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_breach_of_confidentiality`. Sending the other spelling returns a 422.",
+ "type": "boolean"
+ },
+ "include_uncapped_claims_breach_of_confidentiality_negligence": {
+ "description": "CSA 3.0 renamed `include_unlimited_claims_breach_of_confidentiality_negligence` to `include_uncapped_claims_breach_of_confidentiality_negligence`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_breach_of_confidentiality_negligence`. Sending the other spelling returns a 422.",
+ "type": "boolean"
+ },
+ "include_uncapped_claims_breach_of_privsec": {
+ "description": "CSA 3.0 renamed `include_unlimited_claims_breach_of_privsec` to `include_uncapped_claims_breach_of_privsec`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_breach_of_privsec`. Sending the other spelling returns a 422.",
+ "type": "boolean"
+ },
+ "include_uncapped_claims_breach_of_privsec_negligence": {
+ "description": "CSA 3.0 renamed `include_unlimited_claims_breach_of_privsec_negligence` to `include_uncapped_claims_breach_of_privsec_negligence`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_breach_of_privsec_negligence`. Sending the other spelling returns a 422.",
+ "type": "boolean"
+ },
+ "include_uncapped_claims_include_other": {
+ "description": "CSA 3.0 renamed `include_unlimited_claims_include_other` to `include_uncapped_claims_include_other`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_include_other`. Sending the other spelling returns a 422.",
+ "type": "boolean"
+ },
+ "include_uncapped_claims_indemnification_obligation": {
+ "description": "CSA 3.0 renamed `include_unlimited_claims_indemnification_obligation` to `include_uncapped_claims_indemnification_obligation`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_indemnification_obligation`. Sending the other spelling returns a 422.",
+ "type": "boolean"
+ },
+ "include_uncapped_claims_other": {
+ "description": "CSA 3.0 renamed `include_unlimited_claims_other` to `include_uncapped_claims_other`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_other`. Sending the other spelling returns a 422.",
+ "type": "boolean"
+ },
+ "include_unlimited_claims": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_confidentiality": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_confidentiality_negligence": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_privsec": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_privsec_negligence": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_include_other": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_indemnification_obligation": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_other": {
+ "type": "string"
+ },
+ "increased_cap_amount_currency": {
+ "type": "number"
+ },
+ "increased_cap_amount_period_currency": {
+ "type": "number"
+ },
+ "increased_cap_amount_period_qty": {
+ "type": "number"
+ },
+ "increased_cap_amount_qty": {
+ "type": "number"
+ },
+ "increased_cap_amount_type": {
+ "enum": [
+ "qty",
+ "currency",
+ "period"
+ ],
+ "type": "string"
+ },
+ "provider": {
+ "type": "string"
+ },
+ "supercap_currency": {
+ "description": "CSA 3.0 renamed `increased_cap_amount_currency` to `supercap_currency`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `increased_cap_amount_currency`. Sending the other spelling returns a 422.",
+ "type": "number"
+ },
+ "supercap_period_currency": {
+ "description": "CSA 3.0 renamed `increased_cap_amount_period_currency` to `supercap_period_currency`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `increased_cap_amount_period_currency`. Sending the other spelling returns a 422.",
+ "type": "number"
+ },
+ "supercap_period_qty": {
+ "description": "CSA 3.0 renamed `increased_cap_amount_period_qty` to `supercap_period_qty`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `increased_cap_amount_period_qty`. Sending the other spelling returns a 422.",
+ "type": "number"
+ },
+ "supercap_qty": {
+ "description": "CSA 3.0 renamed `increased_cap_amount_qty` to `supercap_qty`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `increased_cap_amount_qty`. Sending the other spelling returns a 422.",
+ "type": "number"
+ },
+ "supercap_type": {
+ "description": "CSA 3.0 renamed `increased_cap_amount_type` to `supercap_type`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `increased_cap_amount_type`. Sending the other spelling returns a 422.",
+ "type": "number"
+ }
+ },
+ "type": "object"
+ },
+ "csa_order_form_attributes": {
+ "additionalProperties": false,
+ "description": "Override csa order form terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "additional_changes": {
+ "type": "string"
+ },
+ "additional_parameters_or_limitations": {
+ "type": "string"
+ },
+ "affiliates_as_users": {
+ "type": "boolean"
+ },
+ "cloud_service_description": {
+ "type": "string"
+ },
+ "consumption_units": {
+ "type": "string"
+ },
+ "fee_amount": {
+ "type": "number"
+ },
+ "fee_custom_unit": {
+ "type": "string"
+ },
+ "fee_period": {
+ "enum": [
+ "Subscription Period",
+ "month",
+ "year",
+ "User",
+ "Custom unit"
+ ],
+ "type": "string"
+ },
+ "fees_attributes": {
+ "additionalProperties": {
+ "anyOf": [
+ {
+ "additionalProperties": false,
+ "description": "Fees::Flat (fee_type \"flat\"). A fixed recurring fee, e.g. a platform subscription. Set type to \"Fees::Flat\" or fee_type to \"flat\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Fixed amount in the order form's fees_currency, charged per fee_period. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"flat\". Alternative to type.",
+ "enum": [
+ "flat"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Flat\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Flat"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Discount (fee_type \"discount\"). A discount, as a fixed amount or a percentage, applied forever, once, or for a number of months. Set type to \"Fees::Discount\" or fee_type to \"discount\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Discount size: an amount in fees_currency when discount_type is fixed_amount (a plain amount, not cents: 20 means 20.00), or a percentage (e.g. 10 for 10%) when it is percentage.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "discount_duration_amount": {
+ "description": "Number of months the discount applies. Required when discount_duration_type is multiple_months.",
+ "type": "number"
+ },
+ "discount_duration_type": {
+ "description": "How long the discount applies. multiple_months also needs discount_duration_amount.",
+ "enum": [
+ "forever",
+ "once",
+ "multiple_months"
+ ],
+ "type": "string"
+ },
+ "discount_type": {
+ "description": "Whether cost is a currency amount or a percentage.",
+ "enum": [
+ "fixed_amount",
+ "percentage"
+ ],
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"discount\". Alternative to type.",
+ "enum": [
+ "discount"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Discount\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Discount"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Cost (fee_type \"cost\"). A per-unit fee: price per unit times quantity, e.g. seats. Set type to \"Fees::Cost\" or fee_type to \"cost\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Price per unit in fees_currency. The row total is quantity x cost. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"cost\". Alternative to type.",
+ "enum": [
+ "cost"
+ ],
+ "type": "string"
+ },
+ "quantity": {
+ "description": "Number of units.",
+ "type": "number"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Cost\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Cost"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Attachment (fee_type \"attachment\"). A fee described in an uploaded attachment instead of in the table. Set type to \"Fees::Attachment\" or fee_type to \"attachment\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "attachment_id": {
+ "description": "ID of an attachment uploaded with upload-attachment.",
+ "type": "string"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"attachment\". Alternative to type.",
+ "enum": [
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Attachment\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Attachment"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Graduated (fee_type \"graduated\"). Tiered pricing, with the price set per tier in graduated_fee_tiers_attributes. Set type to \"Fees::Graduated\" or fee_type to \"graduated\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"graduated\". Alternative to type.",
+ "enum": [
+ "graduated"
+ ],
+ "type": "string"
+ },
+ "graduated_fee_tiers_attributes": {
+ "additionalProperties": {
+ "additionalProperties": false,
+ "properties": {
+ "flat_price": {
+ "type": "number"
+ },
+ "price_per_unit": {
+ "type": "string"
+ },
+ "upper_limit": {
+ "type": "number"
+ }
+ },
+ "type": "object"
+ },
+ "description": "Graduated fee tiers. Use string keys such as \"0\", \"1\".",
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Graduated\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Graduated"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Included (fee_type \"included\"). An item included at no charge. Set type to \"Fees::Included\" or fee_type to \"included\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"included\". Alternative to type.",
+ "enum": [
+ "included"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Included\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Included"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Metered (fee_type \"metered\"). Usage-based pricing, billed per unit used. Set type to \"Fees::Metered\" or fee_type to \"metered\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Price per unit of usage in fees_currency. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"metered\". Alternative to type.",
+ "enum": [
+ "metered"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Metered\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Metered"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::OneTime (fee_type \"one_time\"). A one-time charge, such as a setup fee. Set type to \"Fees::OneTime\" or fee_type to \"one_time\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "One-time amount in fees_currency, charged once rather than per fee_period. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"one_time\". Alternative to type.",
+ "enum": [
+ "one_time"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::OneTime\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::OneTime"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Text (fee_type \"text\"). A fee term described in free text. Set type to \"Fees::Text\" or fee_type to \"text\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"text\". Alternative to type.",
+ "enum": [
+ "text"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Text\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Text"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ }
+ ]
+ },
+ "description": "Fee table rows, keyed by string index (\"0\", \"1\", ...). Replaces the template's fees when provided. Each row sets type or fee_type to pick the fee class. Amounts are in the order form's fees_currency and, for recurring fees, are charged per fee_period.",
+ "examples": [
+ {
+ "0": {
+ "cost": 2000,
+ "description": "Platform subscription",
+ "type": "Fees::Flat"
+ }
+ },
+ {
+ "0": {
+ "cost": 50,
+ "description": "Seats",
+ "fee_type": "cost",
+ "quantity": 10
+ },
+ "1": {
+ "cost": 10,
+ "description": "Launch discount",
+ "discount_duration_amount": 3,
+ "discount_duration_type": "multiple_months",
+ "discount_type": "percentage",
+ "fee_type": "discount"
+ }
+ }
+ ],
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+ },
+ "fees_currency": {
+ "enum": [
+ "USD",
+ "EUR",
+ "GBP",
+ "CAD",
+ "AUD",
+ "SGD",
+ "ILS",
+ "JPY",
+ "CHF",
+ "HKD"
+ ],
+ "type": "string"
+ },
+ "fees_include_fee_increase_upon_renewal": {
+ "type": "boolean"
+ },
+ "fees_include_fee_increase_upon_renewal_fee": {
+ "type": "number"
+ },
+ "fees_include_fee_increase_upon_renewal_type": {
+ "enum": [
+ "will",
+ "may"
+ ],
+ "type": "string"
+ },
+ "fees_inclusive_of_taxes": {
+ "type": "boolean"
+ },
+ "framework_terms_type": {
+ "enum": [
+ "new",
+ "existing",
+ "description"
+ ],
+ "type": "string"
+ },
+ "free_trial_days": {
+ "type": "number"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_additional_changes": {
+ "type": "boolean"
+ },
+ "include_additional_parameters_or_limitations": {
+ "type": "boolean"
+ },
+ "include_consumption": {
+ "type": "boolean"
+ },
+ "include_fees": {
+ "type": "boolean"
+ },
+ "include_fees_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_fees_include_attachment": {
+ "type": "boolean"
+ },
+ "include_fees_other": {
+ "type": "boolean"
+ },
+ "include_fees_other_val": {
+ "type": "string"
+ },
+ "include_fees_table": {
+ "type": "boolean"
+ },
+ "include_fees_table_period": {
+ "enum": [
+ "Subscription Period",
+ "month",
+ "year",
+ "User"
+ ],
+ "type": "string"
+ },
+ "include_free_trial": {
+ "type": "boolean"
+ },
+ "include_max_users": {
+ "type": "boolean"
+ },
+ "include_pilot_period": {
+ "type": "boolean"
+ },
+ "include_pilot_period_duration_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_pilot_period_duration_type": {
+ "enum": [
+ "day",
+ "week",
+ "month"
+ ],
+ "type": "string"
+ },
+ "include_pilot_period_include_fees": {
+ "type": "boolean"
+ },
+ "include_pilot_period_include_fees_amount": {
+ "type": "number"
+ },
+ "include_pilot_period_include_modifications": {
+ "type": "boolean"
+ },
+ "include_pilot_period_include_modifications_description": {
+ "type": "string"
+ },
+ "include_product_support": {
+ "type": "boolean"
+ },
+ "include_product_support_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_product_support_description": {
+ "type": "string"
+ },
+ "include_product_support_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_professional_services": {
+ "type": "boolean"
+ },
+ "include_professional_services_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_professional_services_custom_name": {
+ "type": "string"
+ },
+ "include_professional_services_description": {
+ "type": "string"
+ },
+ "include_professional_services_end_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "include_professional_services_fees_description": {
+ "type": "string"
+ },
+ "include_professional_services_include_end_date": {
+ "type": "boolean"
+ },
+ "include_professional_services_include_fees_description": {
+ "type": "boolean"
+ },
+ "include_professional_services_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_sla": {
+ "type": "boolean"
+ },
+ "include_sla_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_sla_description": {
+ "type": "string"
+ },
+ "include_sla_include_response_time": {
+ "type": "boolean"
+ },
+ "include_sla_include_response_time_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_sla_include_response_time_credit": {
+ "type": "number"
+ },
+ "include_sla_include_response_time_duration": {
+ "enum": [
+ "hour",
+ "day",
+ "week",
+ "month",
+ "hours"
+ ],
+ "type": "string"
+ },
+ "include_sla_include_response_time_support_channel": {
+ "type": "string"
+ },
+ "include_sla_include_target_uptime": {
+ "type": "boolean"
+ },
+ "include_sla_maintenance_notice": {
+ "type": "boolean"
+ },
+ "include_sla_maintenance_window": {
+ "type": "boolean"
+ },
+ "include_sla_maintenance_window_type": {
+ "enum": [
+ "standard",
+ "none"
+ ],
+ "type": "string"
+ },
+ "include_sla_standard_maintenance_notice_qty": {
+ "type": "number"
+ },
+ "include_sla_standard_maintenance_notice_unit": {
+ "enum": [
+ "hour",
+ "day",
+ "week",
+ "month"
+ ],
+ "type": "string"
+ },
+ "include_sla_standard_maintenance_window_end_time": {
+ "type": "string"
+ },
+ "include_sla_standard_maintenance_window_friday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_monday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_saturday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_start_time": {
+ "type": "string"
+ },
+ "include_sla_standard_maintenance_window_sunday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_thursday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_time_zone": {
+ "type": "string"
+ },
+ "include_sla_standard_maintenance_window_tuesday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_wednesday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_target_uptime": {
+ "type": "number"
+ },
+ "include_sla_type": {
+ "enum": [
+ "description",
+ "standard",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_subscription_start_date": {
+ "type": "boolean"
+ },
+ "include_subscription_start_date_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "include_usage_review": {
+ "type": "boolean"
+ },
+ "include_usage_review_val": {
+ "type": "string"
+ },
+ "include_use_limitations": {
+ "type": "boolean"
+ },
+ "include_use_limitations_val": {
+ "type": "string"
+ },
+ "invoice_period": {
+ "enum": [
+ "monthly",
+ "quarterly",
+ "semiannually",
+ "annually",
+ "Custom unit",
+ "Monthly",
+ "Quarterly",
+ "Semiannually",
+ "Annually"
+ ],
+ "type": "string"
+ },
+ "invoice_period_custom_unit": {
+ "type": "string"
+ },
+ "max_consumption": {
+ "type": "number"
+ },
+ "max_users": {
+ "type": "number"
+ },
+ "negotiations_allowed": {
+ "description": "When true, the recipient can propose changes to the order form, even when the agreement-level `negotiations_allowed` is false. This only covers the order form.",
+ "type": "boolean"
+ },
+ "order_date_date": {
+ "type": "string"
+ },
+ "order_date_other": {
+ "type": "string"
+ },
+ "order_date_type": {
+ "enum": [
+ "signature",
+ "date",
+ "other"
+ ],
+ "type": "string"
+ },
+ "payment_period": {
+ "type": "number"
+ },
+ "payment_period_timeframe": {
+ "enum": [
+ "Customer's receipt of invoice",
+ "date of invoice"
+ ],
+ "type": "string"
+ },
+ "payment_period_unit": {
+ "enum": [
+ "day(s)",
+ "week(s)",
+ "month(s)",
+ "marketplace_acceptance"
+ ],
+ "type": "string"
+ },
+ "payment_process_automatic_frequency": {
+ "enum": [
+ "monthly",
+ "quarterly",
+ "semiannually",
+ "annually"
+ ],
+ "type": "string"
+ },
+ "payment_process_type": {
+ "enum": [
+ "automatic",
+ "invoice",
+ "custom",
+ "marketplace_acceptance"
+ ],
+ "type": "string"
+ },
+ "payment_process_type_custom_val": {
+ "type": "string"
+ },
+ "payment_process_type_invoice_amount": {
+ "type": "number"
+ },
+ "payment_process_type_invoice_custom_unit": {
+ "type": "string"
+ },
+ "payment_process_type_invoice_duration": {
+ "enum": [
+ "day",
+ "week",
+ "month",
+ "year",
+ "day(s)",
+ "week(s)",
+ "month(s)",
+ "year(s)"
+ ],
+ "type": "string"
+ },
+ "payment_process_type_invoice_duration_start": {
+ "enum": [
+ "Customer's receipt of invoice",
+ "date of invoice"
+ ],
+ "type": "string"
+ },
+ "payment_process_type_invoice_type": {
+ "enum": [
+ "monthly",
+ "quarterly",
+ "semiannually",
+ "annually",
+ "Custom unit"
+ ],
+ "type": "string"
+ },
+ "pilot_period_stripe_product_id": {
+ "type": "string"
+ },
+ "service_credits_attributes": {
+ "additionalProperties": {
+ "additionalProperties": false,
+ "properties": {
+ "credit": {
+ "type": "number"
+ },
+ "max": {
+ "type": "number"
+ },
+ "min": {
+ "type": "number"
+ }
+ },
+ "type": "object"
+ },
+ "description": "Service credits. Use string keys such as \"0\", \"1\".",
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+ },
+ "subscription_auto_renew": {
+ "enum": [
+ "days",
+ "subscription_end"
+ ],
+ "type": "string"
+ },
+ "subscription_period": {
+ "type": "number"
+ },
+ "subscription_period_unit": {
+ "type": "string"
+ },
+ "subscription_renewal_notice_days": {
+ "type": "number"
+ },
+ "subscription_start_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "subscription_start_date_type": {
+ "enum": [
+ "effective_date",
+ "date"
+ ],
+ "type": "string"
+ },
+ "underlying_agreement_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "use_limitations_attributes": {
+ "additionalProperties": {
+ "additionalProperties": false,
+ "properties": {
+ "amount": {
+ "type": "number"
+ },
+ "limitation_type": {
+ "type": "string"
+ },
+ "unit": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "description": "Use limitations. Use string keys such as \"0\", \"1\".",
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+ }
+ },
+ "type": "object"
+ },
+ "custom_field_values": {
+ "description": "Values for a custom template's fields, keyed by the field keys defined in the template's YAML definition. Only used when template_id is a custom template. Template defaults fill any fields you omit; a required field with no default and no submitted value returns a 400 naming the field. Values are validated against the field's input type: select and radio values must be one of the field's options, multiselect values are an array of selections each of which must be one of the field's options, number and currency values must be numeric, date values must be YYYY-MM-DD, and email values must be valid addresses. An invalid value returns a 400 naming the field."
+ },
+ "design_partner_attributes": {
+ "additionalProperties": false,
+ "description": "Override design partner terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "customer_description": {
+ "type": "string"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_fees": {
+ "type": "boolean"
+ },
+ "include_fees_amount": {
+ "type": "number"
+ },
+ "include_fees_description": {
+ "type": "string"
+ },
+ "include_fees_pay_by_amount": {
+ "type": "string"
+ },
+ "include_fees_type": {
+ "enum": [
+ "default_language",
+ "description"
+ ],
+ "type": "string"
+ },
+ "include_fees_unit": {
+ "enum": [
+ "month",
+ "quarter",
+ "year",
+ "Term"
+ ],
+ "type": "string"
+ },
+ "include_program_appear_as_customer_private": {
+ "type": "boolean"
+ },
+ "include_program_appear_as_customer_public": {
+ "type": "boolean"
+ },
+ "include_program_case_study": {
+ "type": "boolean"
+ },
+ "include_program_develop_functionality": {
+ "type": "boolean"
+ },
+ "include_program_develop_functionality_val": {
+ "type": "string"
+ },
+ "include_program_discount": {
+ "type": "boolean"
+ },
+ "include_program_discount_amount": {
+ "type": "number"
+ },
+ "include_program_discount_unit": {
+ "enum": [
+ "U.S. Dollars",
+ "percent"
+ ],
+ "type": "string"
+ },
+ "include_program_participation_feedback": {
+ "type": "boolean"
+ },
+ "include_program_participation_feedback_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_program_participation_feedback_unit": {
+ "enum": [
+ "month",
+ "quarter",
+ "year",
+ "Term"
+ ],
+ "type": "string"
+ },
+ "include_program_partner_other": {
+ "type": "boolean"
+ },
+ "include_program_partner_other_val": {
+ "type": "string"
+ },
+ "include_program_provider_other": {
+ "type": "boolean"
+ },
+ "include_program_provider_other_val": {
+ "type": "string"
+ },
+ "include_program_reference": {
+ "type": "boolean"
+ },
+ "product_description": {
+ "type": "string"
+ },
+ "term_amount": {
+ "type": "number"
+ },
+ "term_unit": {
+ "enum": [
+ "day(s)",
+ "week(s)",
+ "month(s)",
+ "quarter(s)",
+ "year(s)"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "district_or_county": {
+ "description": "The district or county for dispute resolution.",
+ "type": "string"
+ },
+ "dpa_attributes": {
+ "additionalProperties": false,
+ "description": "Override dpa terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "approved_subprocessor_type": {
+ "description": "`internal` lists approved subprocessors in the agreement (`subprocessors_attributes`); `external` points to a list published elsewhere.",
+ "enum": [
+ "internal",
+ "external"
+ ],
+ "type": "string"
+ },
+ "cloud_service_product_name": {
+ "type": "string"
+ },
+ "competent_supervisory_authority": {
+ "type": "string"
+ },
+ "customer_description": {
+ "type": "string"
+ },
+ "data_exporter_address_city": {
+ "type": "string"
+ },
+ "data_exporter_address_country": {
+ "type": "string"
+ },
+ "data_exporter_address_state": {
+ "type": "string"
+ },
+ "data_exporter_address_street_address": {
+ "type": "string"
+ },
+ "data_exporter_address_zipcode": {
+ "type": "string"
+ },
+ "data_exporter_contact_details": {
+ "type": "string"
+ },
+ "data_exporter_contact_name": {
+ "type": "string"
+ },
+ "data_exporter_contact_position": {
+ "type": "string"
+ },
+ "data_exporter_role": {
+ "description": "Role of the data exporter. Overwritten to `Controller` when the agreement is created from a template.",
+ "enum": [
+ "Controller",
+ "Processor"
+ ],
+ "type": "string"
+ },
+ "data_importer_address": {
+ "type": "string"
+ },
+ "data_importer_address_city": {
+ "type": "string"
+ },
+ "data_importer_address_country": {
+ "type": "string"
+ },
+ "data_importer_address_state": {
+ "type": "string"
+ },
+ "data_importer_address_street_address": {
+ "type": "string"
+ },
+ "data_importer_address_zipcode": {
+ "type": "string"
+ },
+ "data_importer_contact_details": {
+ "type": "string"
+ },
+ "data_importer_contact_name": {
+ "type": "string"
+ },
+ "data_importer_contact_position": {
+ "type": "string"
+ },
+ "duration_of_processing": {
+ "type": "string"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_covered_claim": {
+ "type": "boolean"
+ },
+ "include_covered_claim_external_val": {
+ "type": "string"
+ },
+ "include_covered_claim_internal_val": {
+ "type": "string"
+ },
+ "include_covered_claim_type": {
+ "description": "Which covered-claim text applies: `internal` uses `include_covered_claim_internal_val`, `external` uses `include_covered_claim_external_val`. Required when `include_covered_claim` is true.",
+ "enum": [
+ "internal",
+ "external"
+ ],
+ "type": "string"
+ },
+ "include_data_subjects_custom": {
+ "type": "boolean"
+ },
+ "include_data_subjects_custom_val": {
+ "type": "string"
+ },
+ "include_data_subjects_employees": {
+ "type": "boolean"
+ },
+ "include_data_subjects_end_users": {
+ "type": "boolean"
+ },
+ "include_external_subprocessor_location": {
+ "type": "string"
+ },
+ "include_frequency_of_transfer_continuous": {
+ "type": "boolean"
+ },
+ "include_frequency_of_transfer_custom": {
+ "type": "boolean"
+ },
+ "include_frequency_of_transfer_custom_val": {
+ "type": "string"
+ },
+ "include_governing_country_eu": {
+ "type": "boolean"
+ },
+ "include_governing_country_eu_val": {
+ "type": "string"
+ },
+ "include_governing_country_uk": {
+ "type": "boolean"
+ },
+ "include_governing_country_uk_val": {
+ "type": "string"
+ },
+ "include_governing_law": {
+ "type": "boolean"
+ },
+ "include_governing_law_country": {
+ "type": "string"
+ },
+ "include_governing_law_state": {
+ "type": "string"
+ },
+ "include_increased_claim_amount": {
+ "description": "Legacy field. Stored but not shown on the DPA; use the `include_liability_cap*` fields instead.",
+ "type": "boolean"
+ },
+ "include_increased_claim_amount_currency": {
+ "description": "Legacy field. Stored but not shown on the DPA; use the `include_liability_cap*` fields instead."
+ },
+ "include_increased_claim_amount_qty": {
+ "description": "Legacy field. Stored but not shown on the DPA; use the `include_liability_cap*` fields instead."
+ },
+ "include_increased_claim_amount_type": {
+ "description": "Legacy field. Stored but not shown on the DPA; use the `include_liability_cap*` fields instead.",
+ "type": "string"
+ },
+ "include_liability_cap": {
+ "type": "boolean"
+ },
+ "include_liability_cap_amount_constant_external": {
+ "type": "string"
+ },
+ "include_liability_cap_amount_constant_internal": {
+ "type": "string"
+ },
+ "include_liability_cap_amount_currency_external": {
+ "description": "Currency amount. Numbers and numeric strings (commas allowed) are both accepted."
+ },
+ "include_liability_cap_amount_currency_internal": {
+ "description": "Currency amount. Numbers and numeric strings (commas allowed) are both accepted."
+ },
+ "include_liability_cap_csa_type": {
+ "description": "Which liability cap values apply: the `_internal` or `_external` amount fields. Required when `include_liability_cap` is true.",
+ "enum": [
+ "internal",
+ "external"
+ ],
+ "type": "string"
+ },
+ "include_personal_data_biographic_info": {
+ "type": "boolean"
+ },
+ "include_personal_data_contact_info": {
+ "type": "boolean"
+ },
+ "include_personal_data_custom": {
+ "type": "boolean"
+ },
+ "include_personal_data_custom_val": {
+ "type": "string"
+ },
+ "include_personal_data_employment_info": {
+ "type": "boolean"
+ },
+ "include_personal_data_financial_info": {
+ "type": "boolean"
+ },
+ "include_personal_data_location": {
+ "type": "boolean"
+ },
+ "include_personal_data_name": {
+ "type": "boolean"
+ },
+ "include_personal_data_transactional_info": {
+ "type": "boolean"
+ },
+ "include_personal_data_user_activity_info": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_custom": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_custom_val": {
+ "type": "string"
+ },
+ "include_processing_purpose_erasing": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_holding": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_protecting": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_receiving": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_returning": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_sharing": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_updating": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_using": {
+ "type": "boolean"
+ },
+ "include_provider_security_contact_address": {
+ "type": "boolean"
+ },
+ "include_provider_security_contact_address_city": {
+ "type": "string"
+ },
+ "include_provider_security_contact_address_country": {
+ "type": "string"
+ },
+ "include_provider_security_contact_address_state": {
+ "type": "string"
+ },
+ "include_provider_security_contact_address_street_address": {
+ "type": "string"
+ },
+ "include_provider_security_contact_address_zipcode": {
+ "type": "string"
+ },
+ "include_provider_security_contact_email": {
+ "type": "boolean"
+ },
+ "include_provider_security_contact_email_val": {
+ "format": "email",
+ "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "include_security_measures_accountability": {
+ "type": "boolean"
+ },
+ "include_security_measures_accountability_val": {
+ "type": "string"
+ },
+ "include_security_measures_certification_or_assurance": {
+ "type": "boolean"
+ },
+ "include_security_measures_certification_or_assurance_val": {
+ "type": "string"
+ },
+ "include_security_measures_confidentiality_integrity": {
+ "type": "boolean"
+ },
+ "include_security_measures_confidentiality_integrity_val": {
+ "type": "string"
+ },
+ "include_security_measures_data_at_rest": {
+ "type": "boolean"
+ },
+ "include_security_measures_data_at_rest_val": {
+ "type": "string"
+ },
+ "include_security_measures_data_minimization": {
+ "type": "boolean"
+ },
+ "include_security_measures_data_minimization_val": {
+ "type": "string"
+ },
+ "include_security_measures_data_quality": {
+ "type": "boolean"
+ },
+ "include_security_measures_data_quality_val": {
+ "type": "string"
+ },
+ "include_security_measures_data_retention": {
+ "type": "boolean"
+ },
+ "include_security_measures_data_retention_val": {
+ "type": "string"
+ },
+ "include_security_measures_data_transmission": {
+ "type": "boolean"
+ },
+ "include_security_measures_data_transmission_val": {
+ "type": "string"
+ },
+ "include_security_measures_event_logging": {
+ "type": "boolean"
+ },
+ "include_security_measures_event_logging_val": {
+ "type": "string"
+ },
+ "include_security_measures_identity_auth": {
+ "type": "boolean"
+ },
+ "include_security_measures_identity_auth_val": {
+ "type": "string"
+ },
+ "include_security_measures_it_security_governance": {
+ "type": "boolean"
+ },
+ "include_security_measures_it_security_governance_val": {
+ "type": "string"
+ },
+ "include_security_measures_physical_security": {
+ "type": "boolean"
+ },
+ "include_security_measures_physical_security_val": {
+ "type": "string"
+ },
+ "include_security_measures_portability_and_erasure": {
+ "type": "boolean"
+ },
+ "include_security_measures_portability_and_erasure_val": {
+ "type": "string"
+ },
+ "include_security_measures_pseudonym_encryption": {
+ "type": "boolean"
+ },
+ "include_security_measures_pseudonym_encryption_val": {
+ "type": "string"
+ },
+ "include_security_measures_restore_data_access": {
+ "type": "boolean"
+ },
+ "include_security_measures_restore_data_access_val": {
+ "type": "string"
+ },
+ "include_security_measures_security_policy": {
+ "type": "boolean"
+ },
+ "include_security_measures_system_configuration": {
+ "type": "boolean"
+ },
+ "include_security_measures_system_configuration_val": {
+ "type": "string"
+ },
+ "include_security_measures_testing_assessment": {
+ "type": "boolean"
+ },
+ "include_security_measures_testing_assessment_val": {
+ "type": "string"
+ },
+ "include_security_policy": {
+ "type": "boolean"
+ },
+ "include_security_policy_fedramp_auth": {
+ "type": "boolean"
+ },
+ "include_security_policy_hipaa": {
+ "type": "boolean"
+ },
+ "include_security_policy_hitrust": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_other": {
+ "type": "boolean"
+ },
+ "include_security_policy_iso27001": {
+ "type": "boolean"
+ },
+ "include_security_policy_other": {
+ "type": "string"
+ },
+ "include_security_policy_pci1": {
+ "type": "boolean"
+ },
+ "include_security_policy_pci2": {
+ "type": "boolean"
+ },
+ "include_security_policy_penetration_testing": {
+ "type": "boolean"
+ },
+ "include_security_policy_soc2": {
+ "type": "boolean"
+ },
+ "include_security_policy_soc2_type2": {
+ "type": "boolean"
+ },
+ "include_sensitive_data_restrictions_custom": {
+ "type": "boolean"
+ },
+ "include_sensitive_data_restrictions_custom_val": {
+ "type": "string"
+ },
+ "include_sensitive_data_restrictions_security_policy": {
+ "type": "boolean"
+ },
+ "include_service_provider_relationship": {
+ "type": "boolean"
+ },
+ "include_special_category_data": {
+ "type": "boolean"
+ },
+ "provider": {
+ "type": "string"
+ },
+ "security_policy_available_at": {
+ "type": "string"
+ },
+ "security_policy_type": {
+ "description": "Where the Security Policy is defined. For `external`, set `security_policy_available_at`.",
+ "enum": [
+ "defined in agreement",
+ "provider service",
+ "external"
+ ],
+ "type": "string"
+ },
+ "subprocessors_attributes": {
+ "additionalProperties": {
+ "additionalProperties": false,
+ "properties": {
+ "_destroy": {
+ "description": "Set to true with `id` to remove that subprocessor.",
+ "type": "boolean"
+ },
+ "country": {
+ "type": "string"
+ },
+ "id": {
+ "description": "ID of an existing subprocessor to update or remove. Omit to add a new subprocessor.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "processing_task": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "description": "Subprocessors, keyed by string index such as \"0\", \"1\". On create these are added to the template's subprocessors. On a draft update, an entry without `id` adds a new subprocessor; pass `id` to change one and `id` with `_destroy: true` to remove one.",
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+ },
+ "underlying_agreement_id": {
+ "description": "ID of the CSA this DPA supplements when `underlying_agreement_type` is `internal`.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "underlying_agreement_type": {
+ "description": "`internal` links a CSA in Common Paper (`underlying_agreement_id`); `external` describes another agreement in `underlying_agreement_val` (required). Omit for none.",
+ "enum": [
+ "internal",
+ "external"
+ ],
+ "type": "string"
+ },
+ "underlying_agreement_val": {
+ "description": "Description of the agreement this DPA supplements. Required when `underlying_agreement_type` is `external`.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "framework_terms_description": {
+ "description": "Custom framework terms description. Only used when framework_terms_type is \"description\".",
+ "type": "string"
+ },
+ "framework_terms_type": {
+ "description": "How framework terms are specified. Use \"new\" for standard terms or \"description\" to provide a custom framework_terms_description.",
+ "enum": [
+ "new",
+ "description"
+ ],
+ "type": "string"
+ },
+ "governing_law_country": {
+ "description": "The country whose laws govern the agreement.",
+ "type": "string"
+ },
+ "governing_law_region": {
+ "description": "The state or region whose laws govern the agreement.",
+ "type": "string"
+ },
+ "include_automated_payment_reminders": {
+ "description": "When true, automatically sends payment reminder emails.",
+ "type": "boolean"
+ },
+ "include_billing_info": {
+ "description": "When true, billing contact information (billing_name, billing_email) is included.",
+ "type": "boolean"
+ },
+ "include_billing_workflow": {
+ "description": "When true, enables a billing workflow after signing.",
+ "type": "boolean"
+ },
+ "include_expiration_date": {
+ "description": "Expiration date in YYYY-MM-DD format. Use when include_expiration_type is \"date\".",
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "include_expiration_days": {
+ "description": "Number of days until the agreement expires. Use when include_expiration_type is \"days\".",
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_expiration_type": {
+ "description": "How to set expiration: \"none\" (default), \"days\" (use include_expiration_days), or \"date\" (use include_expiration_date).",
+ "enum": [
+ "none",
+ "days",
+ "date"
+ ],
+ "type": "string"
+ },
+ "include_terms": {
+ "description": "When true, the standard terms are included with the agreement.",
+ "type": "boolean"
+ },
+ "loi_attributes": {
+ "additionalProperties": false,
+ "description": "Override loi terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "confidentiality_custom": {
+ "type": "string"
+ },
+ "confidentiality_mutual_include_loi": {
+ "type": "boolean"
+ },
+ "confidentiality_nda_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "confidentiality_nda_description": {
+ "type": "string"
+ },
+ "confidentiality_nda_include_loi": {
+ "type": "boolean"
+ },
+ "confidentiality_nda_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "confidentiality_type": {
+ "enum": [
+ "mutual",
+ "nda",
+ "provider",
+ "custom"
+ ],
+ "type": "string"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_custom_details": {
+ "type": "boolean"
+ },
+ "include_custom_details_val": {
+ "type": "string"
+ },
+ "include_fees": {
+ "type": "boolean"
+ },
+ "include_fees_amount": {
+ "type": "number"
+ },
+ "include_fees_amount_duration": {
+ "enum": [
+ "month",
+ "year",
+ "quarter"
+ ],
+ "type": "string"
+ },
+ "include_fees_include_amount": {
+ "type": "boolean"
+ },
+ "include_fees_include_other": {
+ "type": "boolean"
+ },
+ "include_fees_other": {
+ "type": "string"
+ },
+ "include_functionality": {
+ "type": "boolean"
+ },
+ "include_functionality_val": {
+ "type": "string"
+ },
+ "include_launch_date": {
+ "type": "boolean"
+ },
+ "include_launch_date_custom": {
+ "type": "string"
+ },
+ "include_launch_date_date": {
+ "format": "date-time",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$",
+ "type": "string"
+ },
+ "include_launch_date_type": {
+ "enum": [
+ "date",
+ "custom"
+ ],
+ "type": "string"
+ },
+ "product_name": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "manual_send": {
+ "description": "When true, the agreement is marked as manually sent outside the platform.",
+ "type": "boolean"
+ },
+ "message": {
+ "type": "string"
+ },
+ "negotiations_allowed": {
+ "description": "When true, the recipient can propose changes to the legal terms. For agreement types without separate business terms, that covers every term. CSA order forms, PSA statements of work, partnership business terms and software license order forms have their own `negotiations_allowed` flag.",
+ "type": "boolean"
+ },
+ "partnership_attributes": {
+ "additionalProperties": false,
+ "description": "Override partnership terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "effective_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "effective_date_type": {
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "type": "string"
+ },
+ "general_cap_amount_currency_val": {
+ "type": "number"
+ },
+ "general_cap_amount_either_currency": {
+ "type": "number"
+ },
+ "general_cap_amount_either_multiple": {
+ "type": "number"
+ },
+ "general_cap_amount_multiple_val": {
+ "type": "number"
+ },
+ "general_cap_amount_type": {
+ "enum": [
+ "multiple",
+ "currency",
+ "either",
+ "base"
+ ],
+ "type": "string"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_additional_warranties": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_include_company": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_include_company_val": {
+ "type": "string"
+ },
+ "include_additional_warranties_include_partner": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_include_partner_val": {
+ "type": "string"
+ },
+ "include_brand_guidelines": {
+ "type": "boolean"
+ },
+ "include_brand_guidelines_include_company": {
+ "type": "boolean"
+ },
+ "include_brand_guidelines_include_company_val": {
+ "type": "string"
+ },
+ "include_brand_guidelines_include_partner": {
+ "type": "boolean"
+ },
+ "include_brand_guidelines_include_partner_val": {
+ "type": "string"
+ },
+ "include_covered_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_company_claims": {
+ "type": "string"
+ },
+ "include_covered_claims_include_company_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_include_partner_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_partner_claims": {
+ "type": "string"
+ },
+ "include_dpa": {
+ "type": "boolean"
+ },
+ "include_dpa_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_dpa_location": {
+ "type": "string"
+ },
+ "include_dpa_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_increased_cap_amount": {
+ "type": "boolean"
+ },
+ "include_increased_cap_amount_currency": {
+ "type": "number"
+ },
+ "include_increased_cap_amount_either_currency": {
+ "type": "number"
+ },
+ "include_increased_cap_amount_either_multiple": {
+ "type": "string"
+ },
+ "include_increased_cap_amount_multiple": {
+ "type": "string"
+ },
+ "include_increased_cap_amount_type": {
+ "enum": [
+ "multiple",
+ "currency",
+ "either"
+ ],
+ "type": "string"
+ },
+ "include_increased_claims": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_confidentiality": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_confidentiality_misconduct": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_covered_claims": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_misconduct": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_other": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_other_val": {
+ "type": "string"
+ },
+ "include_unlimited_claims": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_confidentiality": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_confidentiality_misconduct": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_covered_claims": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_misconduct": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_other": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_other_val": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "partnership_business_terms_attributes": {
+ "additionalProperties": false,
+ "description": "Override partnership business terms terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "end_date_after_effective_date_amount": {
+ "type": "number"
+ },
+ "end_date_after_effective_date_unit": {
+ "enum": [
+ "month(s)",
+ "quarter(s)",
+ "year(s)"
+ ],
+ "type": "string"
+ },
+ "end_date_date": {
+ "type": "string"
+ },
+ "end_date_type": {
+ "enum": [
+ "date",
+ "effective date"
+ ],
+ "type": "string"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_obligations_company_brand": {
+ "type": "boolean"
+ },
+ "include_obligations_company_promotion": {
+ "type": "boolean"
+ },
+ "include_obligations_company_promotion_include_activities": {
+ "type": "boolean"
+ },
+ "include_obligations_company_promotion_include_activities_val": {
+ "type": "string"
+ },
+ "include_obligations_company_promotion_include_materials": {
+ "type": "boolean"
+ },
+ "include_obligations_company_promotion_include_materials_val": {
+ "type": "string"
+ },
+ "include_obligations_company_referral": {
+ "type": "boolean"
+ },
+ "include_obligations_company_referral_include_criteria": {
+ "type": "boolean"
+ },
+ "include_obligations_company_referral_include_criteria_val": {
+ "type": "string"
+ },
+ "include_obligations_company_referral_include_pay_sch": {
+ "type": "boolean"
+ },
+ "include_obligations_company_referral_include_pay_sch_amount": {
+ "type": "number"
+ },
+ "include_obligations_company_referral_include_pay_sch_custom": {
+ "type": "string"
+ },
+ "include_obligations_company_referral_include_pay_sch_unit": {
+ "enum": [
+ "U.S. Dollars",
+ "percent"
+ ],
+ "type": "string"
+ },
+ "include_obligations_company_sponsorship": {
+ "type": "boolean"
+ },
+ "include_obligations_company_sponsorship_include_benefits": {
+ "type": "boolean"
+ },
+ "include_obligations_company_sponsorship_include_benefits_val": {
+ "type": "string"
+ },
+ "include_obligations_company_sponsorship_include_payments": {
+ "type": "boolean"
+ },
+ "include_obligations_company_sponsorship_include_payments_amount": {
+ "type": "number"
+ },
+ "include_obligations_company_sponsorship_include_payments_unit": {
+ "enum": [
+ "U.S. Dollars",
+ "percent"
+ ],
+ "type": "string"
+ },
+ "include_obligations_partner_brand": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_promotion": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_promotion_include_activities": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_promotion_include_activities_val": {
+ "type": "string"
+ },
+ "include_obligations_partner_promotion_include_materials": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_promotion_include_materials_val": {
+ "type": "string"
+ },
+ "include_obligations_partner_referral": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_referral_include_criteria": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_referral_include_criteria_val": {
+ "type": "string"
+ },
+ "include_obligations_partner_referral_include_pay_sch": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_referral_include_pay_sch_amount": {
+ "type": "number"
+ },
+ "include_obligations_partner_referral_include_pay_sch_custom": {
+ "type": "string"
+ },
+ "include_obligations_partner_referral_include_pay_sch_unit": {
+ "enum": [
+ "U.S. Dollars",
+ "percent"
+ ],
+ "type": "string"
+ },
+ "include_obligations_partner_sponsorship": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_sponsorship_include_benefits": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_sponsorship_include_benefits_val": {
+ "type": "string"
+ },
+ "include_obligations_partner_sponsorship_include_payments": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_sponsorship_include_payments_amount": {
+ "type": "number"
+ },
+ "include_obligations_partner_sponsorship_include_payments_unit": {
+ "enum": [
+ "U.S. Dollars",
+ "percent"
+ ],
+ "type": "string"
+ },
+ "include_payment_process": {
+ "type": "boolean"
+ },
+ "include_payment_process_company": {
+ "type": "boolean"
+ },
+ "include_payment_process_company_include_address": {
+ "type": "boolean"
+ },
+ "include_payment_process_company_include_address_city": {
+ "type": "string"
+ },
+ "include_payment_process_company_include_address_country": {
+ "type": "string"
+ },
+ "include_payment_process_company_include_address_state": {
+ "type": "string"
+ },
+ "include_payment_process_company_include_address_street_address": {
+ "type": "string"
+ },
+ "include_payment_process_company_include_address_zipcode": {
+ "type": "string"
+ },
+ "include_payment_process_company_include_email": {
+ "type": "boolean"
+ },
+ "include_payment_process_company_include_email_val": {
+ "type": "string"
+ },
+ "include_payment_process_partner": {
+ "type": "boolean"
+ },
+ "include_payment_process_partner_include_address": {
+ "type": "boolean"
+ },
+ "include_payment_process_partner_include_address_city": {
+ "type": "string"
+ },
+ "include_payment_process_partner_include_address_country": {
+ "type": "string"
+ },
+ "include_payment_process_partner_include_address_state": {
+ "type": "string"
+ },
+ "include_payment_process_partner_include_address_street_address": {
+ "type": "string"
+ },
+ "include_payment_process_partner_include_address_zipcode": {
+ "type": "string"
+ },
+ "include_payment_process_partner_include_email": {
+ "type": "boolean"
+ },
+ "include_payment_process_partner_include_email_val": {
+ "type": "string"
+ },
+ "include_payment_schedule": {
+ "type": "boolean"
+ },
+ "include_payment_schedule_custom": {
+ "type": "string"
+ },
+ "include_payment_schedule_specified_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_payment_schedule_specified_timeframe": {
+ "enum": [
+ "receipt",
+ "date"
+ ],
+ "type": "string"
+ },
+ "include_payment_schedule_specified_unit": {
+ "enum": [
+ "day(s)",
+ "week(s)",
+ "month(s)",
+ "quarter(s)",
+ "year(s)"
+ ],
+ "type": "string"
+ },
+ "include_payment_schedule_type": {
+ "enum": [
+ "specified",
+ "custom"
+ ],
+ "type": "string"
+ },
+ "negotiations_allowed": {
+ "description": "When true, the recipient can propose changes to the business terms, even when the agreement-level `negotiations_allowed` is false. This only covers the business terms.",
+ "type": "boolean"
+ },
+ "territory_type": {
+ "enum": [
+ "worldwide",
+ "custom"
+ ],
+ "type": "string"
+ },
+ "territory_type_val": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "payment_link_url": {
+ "description": "A payment URL shown to the recipient after signing. Requires include_billing_workflow to be true and billing_workflow_type to be \"link\".",
+ "type": "string"
+ },
+ "pilot_attributes": {
+ "additionalProperties": false,
+ "description": "Override pilot terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "fees_type": {
+ "enum": [
+ "free",
+ "pilot_period_fees"
+ ],
+ "type": "string"
+ },
+ "general_cap_amount": {
+ "type": "number"
+ },
+ "general_cap_amount_type": {
+ "enum": [
+ "preceding",
+ "base",
+ "period"
+ ],
+ "type": "string"
+ },
+ "general_cap_period_currency": {
+ "type": "number"
+ },
+ "general_cap_period_qty": {
+ "type": "number"
+ },
+ "general_cap_preceding_amount": {
+ "type": "number"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_dpa": {
+ "type": "boolean"
+ },
+ "include_dpa_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_dpa_location": {
+ "type": "string"
+ },
+ "include_dpa_type": {
+ "enum": [
+ "description",
+ "attachment",
+ "standard"
+ ],
+ "type": "string"
+ },
+ "include_payment_process": {
+ "type": "boolean"
+ },
+ "include_technical_support": {
+ "type": "boolean"
+ },
+ "payment_process_automatic_frequency": {
+ "enum": [
+ "monthly",
+ "quarterly",
+ "annually",
+ "once_per_period"
+ ],
+ "type": "string"
+ },
+ "payment_process_invoice_days": {
+ "type": "number"
+ },
+ "payment_process_invoice_from": {
+ "enum": [
+ "receipt",
+ "date"
+ ],
+ "type": "string"
+ },
+ "payment_process_invoice_timeframe": {
+ "enum": [
+ "days",
+ "weeks",
+ "months",
+ "quarters",
+ "years"
+ ],
+ "type": "string"
+ },
+ "payment_process_type": {
+ "enum": [
+ "automatic",
+ "invoice"
+ ],
+ "type": "string"
+ },
+ "pilot_period_description": {
+ "type": "string"
+ },
+ "pilot_period_fees_description": {
+ "type": "string"
+ },
+ "product_description": {
+ "type": "string"
+ },
+ "technical_support_description": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "psa_attributes": {
+ "additionalProperties": false,
+ "description": "Override psa terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "additional_changes": {
+ "type": "string"
+ },
+ "customer_description": {
+ "type": "string"
+ },
+ "effective_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "effective_date_type": {
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "type": "string"
+ },
+ "general_cap_amount": {
+ "type": "number"
+ },
+ "general_cap_amount_type": {
+ "enum": [
+ "preceding",
+ "base",
+ "period"
+ ],
+ "type": "string"
+ },
+ "general_cap_period_currency": {
+ "type": "number"
+ },
+ "general_cap_period_qty": {
+ "type": "number"
+ },
+ "general_cap_preceding_amount": {
+ "type": "number"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_additional_changes": {
+ "type": "boolean"
+ },
+ "include_additional_warranties": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_by_customer": {
+ "type": "string"
+ },
+ "include_additional_warranties_by_provider": {
+ "type": "string"
+ },
+ "include_additional_warranties_include_by_customer": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_include_by_provider": {
+ "type": "boolean"
+ },
+ "include_covered_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_customer_claims": {
+ "type": "string"
+ },
+ "include_covered_claims_include_customer_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_include_provider_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_provider_claims": {
+ "type": "string"
+ },
+ "include_customer_insurance_min": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_add_provider_com_gen_liability": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_add_provider_cyber_liability": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_add_provider_errors_omissions": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_auto_liability_aggregate": {
+ "type": "number"
+ },
+ "include_customer_insurance_min_auto_liability_minimum": {
+ "type": "number"
+ },
+ "include_customer_insurance_min_cyber_liability_aggregate": {
+ "type": "number"
+ },
+ "include_customer_insurance_min_cyber_liability_minimum": {
+ "type": "number"
+ },
+ "include_customer_insurance_min_employer_liability_aggregate": {
+ "type": "number"
+ },
+ "include_customer_insurance_min_employer_liability_minimum": {
+ "type": "number"
+ },
+ "include_customer_insurance_min_general_liability_aggregate": {
+ "type": "number"
+ },
+ "include_customer_insurance_min_general_liability_minimum": {
+ "type": "number"
+ },
+ "include_customer_insurance_min_include_add_provider": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_include_auto_liability": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_include_cyber_liability": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_include_employer_liability": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_include_general_liability": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_include_workers_comp": {
+ "type": "boolean"
+ },
+ "include_customer_policies": {
+ "type": "boolean"
+ },
+ "include_customer_policies_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_customer_policies_location": {
+ "type": "string"
+ },
+ "include_customer_policies_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_dpa": {
+ "type": "boolean"
+ },
+ "include_dpa_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_dpa_location": {
+ "type": "string"
+ },
+ "include_dpa_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_increased_cap_amount": {
+ "type": "boolean"
+ },
+ "include_increased_claims": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_confidentiality": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_confidentiality_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_privsec": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_privsec_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_other": {
+ "type": "boolean"
+ },
+ "include_increased_claims_indemnification_obligation": {
+ "type": "boolean"
+ },
+ "include_increased_claims_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_other": {
+ "type": "string"
+ },
+ "include_provider_insurance_min": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_add_customer_com_gen_liability": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_add_customer_cyber_liability": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_add_customer_errors_omissions": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_auto_liability_aggregate": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_auto_liability_minimum": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_cyber_liability_aggregate": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_cyber_liability_minimum": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_employer_liability_aggregate": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_employer_liability_minimum": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_general_liability_aggregate": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_general_liability_minimum": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_include_add_customer": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_include_auto_liability": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_include_cyber_liability": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_include_employer_liability": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_include_general_liability": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_include_workers_comp": {
+ "type": "boolean"
+ },
+ "include_publicity_rights": {
+ "type": "boolean"
+ },
+ "include_publicity_rights_type": {
+ "enum": [
+ "public",
+ "non-public"
+ ],
+ "type": "string"
+ },
+ "include_security_policy": {
+ "type": "boolean"
+ },
+ "include_security_policy_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_security_policy_fedramp_auth": {
+ "type": "boolean"
+ },
+ "include_security_policy_hitrust": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_annual_maintenance": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_other": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_other_val": {
+ "type": "string"
+ },
+ "include_security_policy_iso27001": {
+ "type": "boolean"
+ },
+ "include_security_policy_location": {
+ "type": "string"
+ },
+ "include_security_policy_pci1": {
+ "type": "boolean"
+ },
+ "include_security_policy_pci2": {
+ "type": "boolean"
+ },
+ "include_security_policy_penetration_testing": {
+ "type": "boolean"
+ },
+ "include_security_policy_soc2_type1": {
+ "type": "boolean"
+ },
+ "include_security_policy_soc2_type2": {
+ "type": "boolean"
+ },
+ "include_security_policy_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_unlimited_claims": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_confidentiality": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_confidentiality_negligence": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_privsec": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_privsec_negligence": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_include_other": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_indemnification_obligation": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_negligence": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_other": {
+ "type": "string"
+ },
+ "increased_cap_amount_currency": {
+ "type": "number"
+ },
+ "increased_cap_amount_period_currency": {
+ "type": "number"
+ },
+ "increased_cap_amount_period_qty": {
+ "type": "number"
+ },
+ "increased_cap_amount_qty": {
+ "type": "number"
+ },
+ "increased_cap_amount_type": {
+ "enum": [
+ "qty",
+ "currency",
+ "period"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "psa_statement_of_work_attributes": {
+ "additionalProperties": false,
+ "description": "Override psa statement of work terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "additional_changes": {
+ "type": "string"
+ },
+ "cost": {
+ "type": "number"
+ },
+ "description": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "fees_attributes": {
+ "additionalProperties": {
+ "anyOf": [
+ {
+ "additionalProperties": false,
+ "description": "Fees::Flat (fee_type \"flat\"). A fixed recurring fee, e.g. a platform subscription. Set type to \"Fees::Flat\" or fee_type to \"flat\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Fixed amount in the order form's fees_currency, charged per fee_period. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"flat\". Alternative to type.",
+ "enum": [
+ "flat"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Flat\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Flat"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Discount (fee_type \"discount\"). A discount, as a fixed amount or a percentage, applied forever, once, or for a number of months. Set type to \"Fees::Discount\" or fee_type to \"discount\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Discount size: an amount in fees_currency when discount_type is fixed_amount (a plain amount, not cents: 20 means 20.00), or a percentage (e.g. 10 for 10%) when it is percentage.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "discount_duration_amount": {
+ "description": "Number of months the discount applies. Required when discount_duration_type is multiple_months.",
+ "type": "number"
+ },
+ "discount_duration_type": {
+ "description": "How long the discount applies. multiple_months also needs discount_duration_amount.",
+ "enum": [
+ "forever",
+ "once",
+ "multiple_months"
+ ],
+ "type": "string"
+ },
+ "discount_type": {
+ "description": "Whether cost is a currency amount or a percentage.",
+ "enum": [
+ "fixed_amount",
+ "percentage"
+ ],
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"discount\". Alternative to type.",
+ "enum": [
+ "discount"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Discount\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Discount"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Cost (fee_type \"cost\"). A per-unit fee: price per unit times quantity, e.g. seats. Set type to \"Fees::Cost\" or fee_type to \"cost\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Price per unit in fees_currency. The row total is quantity x cost. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"cost\". Alternative to type.",
+ "enum": [
+ "cost"
+ ],
+ "type": "string"
+ },
+ "quantity": {
+ "description": "Number of units.",
+ "type": "number"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Cost\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Cost"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Attachment (fee_type \"attachment\"). A fee described in an uploaded attachment instead of in the table. Set type to \"Fees::Attachment\" or fee_type to \"attachment\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "attachment_id": {
+ "description": "ID of an attachment uploaded with upload-attachment.",
+ "type": "string"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"attachment\". Alternative to type.",
+ "enum": [
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Attachment\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Attachment"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Graduated (fee_type \"graduated\"). Tiered pricing, with the price set per tier in graduated_fee_tiers_attributes. Set type to \"Fees::Graduated\" or fee_type to \"graduated\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"graduated\". Alternative to type.",
+ "enum": [
+ "graduated"
+ ],
+ "type": "string"
+ },
+ "graduated_fee_tiers_attributes": {
+ "additionalProperties": {
+ "additionalProperties": false,
+ "properties": {
+ "flat_price": {
+ "type": "number"
+ },
+ "price_per_unit": {
+ "type": "string"
+ },
+ "upper_limit": {
+ "type": "number"
+ }
+ },
+ "type": "object"
+ },
+ "description": "Graduated fee tiers. Use string keys such as \"0\", \"1\".",
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Graduated\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Graduated"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Included (fee_type \"included\"). An item included at no charge. Set type to \"Fees::Included\" or fee_type to \"included\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"included\". Alternative to type.",
+ "enum": [
+ "included"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Included\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Included"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Metered (fee_type \"metered\"). Usage-based pricing, billed per unit used. Set type to \"Fees::Metered\" or fee_type to \"metered\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Price per unit of usage in fees_currency. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"metered\". Alternative to type.",
+ "enum": [
+ "metered"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Metered\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Metered"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::OneTime (fee_type \"one_time\"). A one-time charge, such as a setup fee. Set type to \"Fees::OneTime\" or fee_type to \"one_time\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "One-time amount in fees_currency, charged once rather than per fee_period. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"one_time\". Alternative to type.",
+ "enum": [
+ "one_time"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::OneTime\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::OneTime"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Text (fee_type \"text\"). A fee term described in free text. Set type to \"Fees::Text\" or fee_type to \"text\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"text\". Alternative to type.",
+ "enum": [
+ "text"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Text\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Text"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ }
+ ]
+ },
+ "description": "Fee line items. Use string keys such as \"0\", \"1\". Replaces template fees when provided.",
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_additional_changes": {
+ "type": "boolean"
+ },
+ "include_customer_obligation": {
+ "type": "boolean"
+ },
+ "include_customer_obligation_val": {
+ "type": "string"
+ },
+ "include_deliverables": {
+ "type": "boolean"
+ },
+ "include_deliverables_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_deliverables_description": {
+ "type": "string"
+ },
+ "include_deliverables_include_acceptance": {
+ "type": "boolean"
+ },
+ "include_deliverables_include_attachment": {
+ "type": "boolean"
+ },
+ "include_deliverables_include_draft_deliverables": {
+ "type": "boolean"
+ },
+ "include_deliverables_rejection_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_deliverables_rejection_unit": {
+ "enum": [
+ "hours",
+ "days",
+ "weeks",
+ "months"
+ ],
+ "type": "string"
+ },
+ "include_deliverables_resubmission_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_deliverables_resubmission_unit": {
+ "enum": [
+ "hours",
+ "days",
+ "weeks",
+ "months"
+ ],
+ "type": "string"
+ },
+ "include_fees_other": {
+ "type": "boolean"
+ },
+ "include_fees_other_val": {
+ "type": "string"
+ },
+ "include_fees_table": {
+ "type": "boolean"
+ },
+ "include_fees_table_total": {
+ "type": "boolean"
+ },
+ "include_fees_travel": {
+ "type": "boolean"
+ },
+ "include_fees_travel_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_fees_travel_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_fees_travel_val": {
+ "type": "string"
+ },
+ "include_third_party_customer": {
+ "type": "boolean"
+ },
+ "include_third_party_include_description": {
+ "type": "boolean"
+ },
+ "include_third_party_include_description_val": {
+ "type": "string"
+ },
+ "include_third_party_materials": {
+ "type": "boolean"
+ },
+ "include_third_party_provider": {
+ "type": "boolean"
+ },
+ "include_time_of_assignment": {
+ "type": "boolean"
+ },
+ "include_time_of_assignment_type": {
+ "enum": [
+ "created",
+ "paid"
+ ],
+ "type": "string"
+ },
+ "invoice_period_description": {
+ "type": "string"
+ },
+ "negotiations_allowed": {
+ "description": "When true, the recipient can propose changes to the statement of work, even when the agreement-level `negotiations_allowed` is false. This only covers the statement of work.",
+ "type": "boolean"
+ },
+ "payment_period": {
+ "type": "number"
+ },
+ "payment_period_other": {
+ "type": "string"
+ },
+ "payment_period_timeframe": {
+ "enum": [
+ "receipt",
+ "invoice",
+ "Customer's receipt of invoice",
+ "date of invoice"
+ ],
+ "type": "string"
+ },
+ "payment_period_type": {
+ "enum": [
+ "standard",
+ "other"
+ ],
+ "type": "string"
+ },
+ "payment_period_unit": {
+ "enum": [
+ "day(s)",
+ "week(s)",
+ "month(s)",
+ "quarter(s)",
+ "year(s)"
+ ],
+ "type": "string"
+ },
+ "quantity": {
+ "type": "number"
+ },
+ "services_description": {
+ "type": "string"
+ },
+ "sow_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "sow_date_type": {
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "type": "string"
+ },
+ "sow_term_amount": {
+ "type": "number"
+ },
+ "sow_term_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "sow_term_type": {
+ "enum": [
+ "deliverables",
+ "period",
+ "date"
+ ],
+ "type": "string"
+ },
+ "sow_term_unit": {
+ "enum": [
+ "month(s)",
+ "quarter(s)",
+ "year(s)"
+ ],
+ "type": "string"
+ },
+ "type": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "recipient_email": {
+ "format": "email",
+ "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "recipient_name": {
+ "type": "string"
+ },
+ "recipient_notice_email_address": {
+ "description": "Email address for legal notices to the recipient.",
+ "format": "email",
+ "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "recipient_organization": {
+ "type": "string"
+ },
+ "sender_last_to_sign": {
+ "description": "When true, your signer signs after the recipient.",
+ "type": "boolean"
+ },
+ "sender_notice_email_address": {
+ "description": "Email address for legal notices to the sender.",
+ "format": "email",
+ "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "software_license_attributes": {
+ "additionalProperties": false,
+ "description": "Override software license terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "effective_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "effective_date_type": {
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "type": "string"
+ },
+ "general_cap_amount": {
+ "type": "number"
+ },
+ "general_cap_amount_type": {
+ "enum": [
+ "preceding",
+ "base",
+ "period"
+ ],
+ "type": "string"
+ },
+ "general_cap_period_currency": {
+ "type": "number"
+ },
+ "general_cap_period_qty": {
+ "type": "number"
+ },
+ "general_cap_preceding_amount": {
+ "type": "number"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_additional_warranties": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_by_customer": {
+ "type": "string"
+ },
+ "include_additional_warranties_by_provider": {
+ "type": "string"
+ },
+ "include_additional_warranties_include_by_customer": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_include_by_provider": {
+ "type": "boolean"
+ },
+ "include_ai_addendum": {
+ "type": "boolean"
+ },
+ "include_ai_addendum_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_covered_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_customer_claims": {
+ "type": "string"
+ },
+ "include_covered_claims_include_customer_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_include_provider_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_provider_claims": {
+ "type": "string"
+ },
+ "include_dpa": {
+ "type": "boolean"
+ },
+ "include_dpa_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_dpa_location": {
+ "type": "string"
+ },
+ "include_dpa_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_increased_cap_amount": {
+ "type": "boolean"
+ },
+ "include_increased_claims": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_confidentiality": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_confidentiality_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_other": {
+ "type": "boolean"
+ },
+ "include_increased_claims_indemnification_obligation": {
+ "type": "boolean"
+ },
+ "include_increased_claims_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_other": {
+ "type": "string"
+ },
+ "include_increased_claims_restrictions": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_confidentiality": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_confidentiality_negligence": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_include_other": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_indemnification_obligation": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_license_or_restrictions": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_negligence": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_other": {
+ "type": "string"
+ },
+ "increased_cap_amount_currency": {
+ "type": "number"
+ },
+ "increased_cap_amount_period_currency": {
+ "type": "number"
+ },
+ "increased_cap_amount_period_qty": {
+ "type": "number"
+ },
+ "increased_cap_amount_qty": {
+ "type": "number"
+ },
+ "increased_cap_amount_type": {
+ "enum": [
+ "qty",
+ "currency",
+ "period"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "software_license_order_form_attributes": {
+ "additionalProperties": false,
+ "description": "Override software license order form terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "additional_changes": {
+ "type": "string"
+ },
+ "deletion_procedure_include_custom": {
+ "type": "boolean"
+ },
+ "deletion_procedure_include_custom_description": {
+ "type": "string"
+ },
+ "deletion_procedure_include_customer_disable": {
+ "type": "boolean"
+ },
+ "deletion_procedure_include_customer_proof": {
+ "type": "boolean"
+ },
+ "deletion_procedure_include_provider_disable": {
+ "type": "boolean"
+ },
+ "fee_custom_unit": {
+ "type": "string"
+ },
+ "fee_period": {
+ "enum": [
+ "Subscription Period",
+ "month",
+ "year",
+ "Custom unit"
+ ],
+ "type": "string"
+ },
+ "fees_attributes": {
+ "additionalProperties": {
+ "anyOf": [
+ {
+ "additionalProperties": false,
+ "description": "Fees::Flat (fee_type \"flat\"). A fixed recurring fee, e.g. a platform subscription. Set type to \"Fees::Flat\" or fee_type to \"flat\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Fixed amount in the order form's fees_currency, charged per fee_period. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"flat\". Alternative to type.",
+ "enum": [
+ "flat"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Flat\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Flat"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Discount (fee_type \"discount\"). A discount, as a fixed amount or a percentage, applied forever, once, or for a number of months. Set type to \"Fees::Discount\" or fee_type to \"discount\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Discount size: an amount in fees_currency when discount_type is fixed_amount (a plain amount, not cents: 20 means 20.00), or a percentage (e.g. 10 for 10%) when it is percentage.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "discount_duration_amount": {
+ "description": "Number of months the discount applies. Required when discount_duration_type is multiple_months.",
+ "type": "number"
+ },
+ "discount_duration_type": {
+ "description": "How long the discount applies. multiple_months also needs discount_duration_amount.",
+ "enum": [
+ "forever",
+ "once",
+ "multiple_months"
+ ],
+ "type": "string"
+ },
+ "discount_type": {
+ "description": "Whether cost is a currency amount or a percentage.",
+ "enum": [
+ "fixed_amount",
+ "percentage"
+ ],
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"discount\". Alternative to type.",
+ "enum": [
+ "discount"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Discount\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Discount"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Cost (fee_type \"cost\"). A per-unit fee: price per unit times quantity, e.g. seats. Set type to \"Fees::Cost\" or fee_type to \"cost\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Price per unit in fees_currency. The row total is quantity x cost. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"cost\". Alternative to type.",
+ "enum": [
+ "cost"
+ ],
+ "type": "string"
+ },
+ "quantity": {
+ "description": "Number of units.",
+ "type": "number"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Cost\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Cost"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Attachment (fee_type \"attachment\"). A fee described in an uploaded attachment instead of in the table. Set type to \"Fees::Attachment\" or fee_type to \"attachment\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "attachment_id": {
+ "description": "ID of an attachment uploaded with upload-attachment.",
+ "type": "string"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"attachment\". Alternative to type.",
+ "enum": [
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Attachment\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Attachment"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Graduated (fee_type \"graduated\"). Tiered pricing, with the price set per tier in graduated_fee_tiers_attributes. Set type to \"Fees::Graduated\" or fee_type to \"graduated\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"graduated\". Alternative to type.",
+ "enum": [
+ "graduated"
+ ],
+ "type": "string"
+ },
+ "graduated_fee_tiers_attributes": {
+ "additionalProperties": {
+ "additionalProperties": false,
+ "properties": {
+ "flat_price": {
+ "type": "number"
+ },
+ "price_per_unit": {
+ "type": "string"
+ },
+ "upper_limit": {
+ "type": "number"
+ }
+ },
+ "type": "object"
+ },
+ "description": "Graduated fee tiers. Use string keys such as \"0\", \"1\".",
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Graduated\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Graduated"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Included (fee_type \"included\"). An item included at no charge. Set type to \"Fees::Included\" or fee_type to \"included\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"included\". Alternative to type.",
+ "enum": [
+ "included"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Included\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Included"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Metered (fee_type \"metered\"). Usage-based pricing, billed per unit used. Set type to \"Fees::Metered\" or fee_type to \"metered\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Price per unit of usage in fees_currency. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"metered\". Alternative to type.",
+ "enum": [
+ "metered"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Metered\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Metered"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::OneTime (fee_type \"one_time\"). A one-time charge, such as a setup fee. Set type to \"Fees::OneTime\" or fee_type to \"one_time\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "One-time amount in fees_currency, charged once rather than per fee_period. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"one_time\". Alternative to type.",
+ "enum": [
+ "one_time"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::OneTime\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::OneTime"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Text (fee_type \"text\"). A fee term described in free text. Set type to \"Fees::Text\" or fee_type to \"text\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"text\". Alternative to type.",
+ "enum": [
+ "text"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Text\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Text"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ }
+ ]
+ },
+ "description": "Fee line items. Use string keys such as \"0\", \"1\". Replaces template fees when provided.",
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+ },
+ "fees_currency": {
+ "enum": [
+ "USD",
+ "EUR",
+ "GBP",
+ "CAD",
+ "AUD",
+ "SGD",
+ "ILS",
+ "JPY",
+ "CHF",
+ "HKD"
+ ],
+ "type": "string"
+ },
+ "fees_include_fee_increase_upon_renewal": {
+ "type": "boolean"
+ },
+ "fees_include_fee_increase_upon_renewal_fee": {
+ "type": "number"
+ },
+ "fees_include_fee_increase_upon_renewal_type": {
+ "enum": [
+ "will",
+ "may"
+ ],
+ "type": "string"
+ },
+ "fees_inclusive_of_taxes": {
+ "type": "boolean"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_additional_changes": {
+ "type": "boolean"
+ },
+ "include_license_compliance_verification": {
+ "type": "boolean"
+ },
+ "include_license_compliance_verification_description": {
+ "type": "string"
+ },
+ "include_license_limits": {
+ "type": "boolean"
+ },
+ "include_license_limits_description": {
+ "type": "string"
+ },
+ "include_payment_process_include_billing_email": {
+ "type": "boolean"
+ },
+ "include_pilot_period": {
+ "type": "boolean"
+ },
+ "include_pilot_period_duration_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_pilot_period_duration_type": {
+ "enum": [
+ "day",
+ "week",
+ "month"
+ ],
+ "type": "string"
+ },
+ "include_pilot_period_include_fees": {
+ "type": "boolean"
+ },
+ "include_pilot_period_include_fees_amount": {
+ "type": "number"
+ },
+ "include_pilot_period_include_modifications": {
+ "type": "boolean"
+ },
+ "include_pilot_period_include_modifications_description": {
+ "type": "string"
+ },
+ "include_services": {
+ "type": "boolean"
+ },
+ "include_services_description": {
+ "type": "string"
+ },
+ "negotiations_allowed": {
+ "description": "When true, the recipient can propose changes to the order form, even when the agreement-level `negotiations_allowed` is false. This only covers the order form.",
+ "type": "boolean"
+ },
+ "order_date_date": {
+ "type": "string"
+ },
+ "order_date_type": {
+ "enum": [
+ "signature",
+ "date",
+ "other"
+ ],
+ "type": "string"
+ },
+ "payment_process_automatic_frequency": {
+ "enum": [
+ "monthly",
+ "quarterly",
+ "semiannually",
+ "annually"
+ ],
+ "type": "string"
+ },
+ "payment_process_type": {
+ "enum": [
+ "automatic",
+ "invoice",
+ "custom"
+ ],
+ "type": "string"
+ },
+ "payment_process_type_custom_val": {
+ "type": "string"
+ },
+ "payment_process_type_invoice_amount": {
+ "type": "number"
+ },
+ "payment_process_type_invoice_custom_unit": {
+ "type": "string"
+ },
+ "payment_process_type_invoice_duration": {
+ "enum": [
+ "day",
+ "week",
+ "month",
+ "year",
+ "day(s)",
+ "week(s)",
+ "month(s)",
+ "year(s)"
+ ],
+ "type": "string"
+ },
+ "payment_process_type_invoice_duration_start": {
+ "enum": [
+ "Customer's receipt of invoice",
+ "date of invoice"
+ ],
+ "type": "string"
+ },
+ "payment_process_type_invoice_type": {
+ "enum": [
+ "monthly",
+ "quarterly",
+ "semiannually",
+ "annually",
+ "Custom unit"
+ ],
+ "type": "string"
+ },
+ "permitted_uses_include_custom": {
+ "type": "boolean"
+ },
+ "permitted_uses_include_custom_description": {
+ "type": "string"
+ },
+ "permitted_uses_include_customers_affiliates": {
+ "type": "boolean"
+ },
+ "permitted_uses_include_internal_business": {
+ "type": "boolean"
+ },
+ "pilot_period_stripe_product_id": {
+ "type": "string"
+ },
+ "software_description": {
+ "type": "string"
+ },
+ "subscription_auto_renew": {
+ "enum": [
+ "days",
+ "subscription_end"
+ ],
+ "type": "string"
+ },
+ "subscription_period": {
+ "type": "number"
+ },
+ "subscription_period_unit": {
+ "type": "string"
+ },
+ "subscription_renewal_notice_days": {
+ "type": "number"
+ },
+ "warranty_period_description_amount": {
+ "type": "number"
+ },
+ "warranty_period_description_duration": {
+ "enum": [
+ "day",
+ "week",
+ "month",
+ "year"
+ ],
+ "type": "string"
+ },
+ "warranty_period_description_duration_start": {
+ "enum": [
+ "initial delivery of the Software",
+ "delivery of the Software and each subsequent Update",
+ "the Order Date"
+ ],
+ "type": "string"
+ },
+ "warranty_period_type": {
+ "enum": [
+ "description",
+ "none"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "test_agreement": {
+ "description": "When true, marks the agreement as a test. Test agreements do not count against your monthly limit.",
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "recipient_name",
+ "recipient_email"
+ ],
+ "type": "object"
+ },
+ "cc_users": {
+ "items": {
+ "format": "email",
+ "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "draft": {
+ "description": "When true, the agreement is saved as a draft and not sent to the recipient. Use POST /v1/agreements/{id}/send to send a draft agreement later.",
+ "type": "boolean"
+ },
+ "owner_email": {
+ "description": "Email address of the agreement owner (sender).",
+ "type": "string"
+ },
+ "signer_email": {
+ "description": "Email address of the signer from the owner's organization.",
+ "format": "email",
+ "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "template_id": {
+ "description": "UUID of a template from `GET /v1/templates`. Accepts both Common Paper standard templates and uploaded PDF templates (`type` `uploaded_template`).",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ }
+ },
+ "required": [
+ "template_id",
+ "owner_email",
+ "signer_email",
+ "agreement"
+ ],
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "agreement": {
+ "additionalProperties": {},
+ "properties": {
+ "amendment_attributes": {
+ "additionalProperties": false,
+ "description": "Override amendment terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "amended_terms_attributes": {
+ "additionalProperties": {
+ "additionalProperties": false,
+ "properties": {
+ "description": {
+ "type": "string"
+ },
+ "term": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "description": "Amended terms. Use string keys such as \"0\", \"1\".",
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+ },
+ "amendment_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "amendment_date_type": {
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "type": "string"
+ },
+ "framework_terms_type": {
+ "type": "string"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "parent_agreement_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "underlying_agreement_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "underlying_agreement_type": {
+ "type": "string"
+ },
+ "underlying_agreement_val": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "baa_attributes": {
+ "additionalProperties": false,
+ "description": "Override baa terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "aggregation_limitations_permitted": {
+ "type": "boolean"
+ },
+ "aggregation_limitations_permitted_val": {
+ "type": "string"
+ },
+ "breach_notification_unit": {
+ "enum": [
+ "hours",
+ "business days",
+ "calendar days"
+ ],
+ "type": "string"
+ },
+ "breach_notification_val": {
+ "type": "number"
+ },
+ "business_associate_relationship_type": {
+ "enum": [
+ "provider",
+ "company"
+ ],
+ "type": "string"
+ },
+ "deidentification_limitations_include_purpose": {
+ "type": "boolean"
+ },
+ "deidentification_limitations_include_requirements": {
+ "type": "boolean"
+ },
+ "deidentification_limitations_permitted": {
+ "type": "boolean"
+ },
+ "deidentification_limitations_purpose_val": {
+ "type": "string"
+ },
+ "deidentification_limitations_requirements_val": {
+ "type": "string"
+ },
+ "designated_record_set_provider_maintains": {
+ "type": "boolean"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_aggregation_limitations": {
+ "type": "boolean"
+ },
+ "include_deidentification_limitations": {
+ "type": "boolean"
+ },
+ "include_limitations": {
+ "type": "boolean"
+ },
+ "include_offshore_limitations": {
+ "type": "boolean"
+ },
+ "include_subcontract_limitations": {
+ "type": "boolean"
+ },
+ "offshore_limitations_permitted": {
+ "type": "boolean"
+ },
+ "offshore_limitations_permitted_val": {
+ "type": "string"
+ },
+ "subcontract_limitations_include_notice": {
+ "type": "boolean"
+ },
+ "subcontract_limitations_include_permission": {
+ "type": "boolean"
+ },
+ "subcontract_limitations_notice_val": {
+ "type": "string"
+ },
+ "subcontract_limitations_permission_val": {
+ "type": "string"
+ },
+ "subcontract_limitations_permitted": {
+ "type": "boolean"
+ },
+ "underlying_agreement_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "underlying_agreement_type": {
+ "enum": [
+ "internal",
+ "external",
+ "none"
+ ],
+ "type": "string"
+ },
+ "underlying_agreement_val": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "billing_email": {
+ "description": "Email of the billing contact. Used when include_billing_info is true.",
+ "format": "email",
+ "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "billing_name": {
+ "description": "Name of the billing contact. Used when include_billing_info is true.",
+ "type": "string"
+ },
+ "billing_workflow_type": {
+ "description": "The type of billing workflow. Use \"link\" to provide a payment_link_url, or \"stripe\" for Stripe-managed billing.",
+ "enum": [
+ "link",
+ "stripe"
+ ],
+ "type": "string"
+ },
+ "chosen_courts_country": {
+ "description": "The country in which disputes will be resolved.",
+ "type": "string"
+ },
+ "chosen_courts_region": {
+ "description": "The state or region in which disputes will be resolved.",
+ "type": "string"
+ },
+ "csa_attributes": {
+ "additionalProperties": false,
+ "description": "Override csa terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "customer_description": {
+ "type": "string"
+ },
+ "effective_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "effective_date_marketplace": {
+ "enum": [
+ "AWS",
+ "GCP",
+ "Azure"
+ ],
+ "type": "string"
+ },
+ "effective_date_type": {
+ "enum": [
+ "signature",
+ "date",
+ "marketplace_acceptance"
+ ],
+ "type": "string"
+ },
+ "general_cap_amount": {
+ "type": "number"
+ },
+ "general_cap_amount_type": {
+ "enum": [
+ "preceding",
+ "base",
+ "period"
+ ],
+ "type": "string"
+ },
+ "general_cap_period_currency": {
+ "type": "number"
+ },
+ "general_cap_period_qty": {
+ "type": "number"
+ },
+ "general_cap_preceding_amount": {
+ "type": "number"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_acceptable_use_policy": {
+ "type": "boolean"
+ },
+ "include_acceptable_use_policy_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_acceptable_use_policy_location": {
+ "type": "string"
+ },
+ "include_acceptable_use_policy_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_additional_warranties": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_by_customer": {
+ "type": "string"
+ },
+ "include_additional_warranties_by_provider": {
+ "type": "string"
+ },
+ "include_additional_warranties_include_by_customer": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_include_by_provider": {
+ "type": "boolean"
+ },
+ "include_ai_addendum": {
+ "type": "boolean"
+ },
+ "include_ai_addendum_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_covered_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_customer_claims": {
+ "type": "string"
+ },
+ "include_covered_claims_include_customer_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_include_provider_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_provider_claims": {
+ "type": "string"
+ },
+ "include_dpa": {
+ "type": "boolean"
+ },
+ "include_dpa_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_dpa_location": {
+ "type": "string"
+ },
+ "include_dpa_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_increased_cap_amount": {
+ "type": "boolean"
+ },
+ "include_increased_claims": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_confidentiality": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_confidentiality_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_privsec": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_privsec_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_other": {
+ "type": "boolean"
+ },
+ "include_increased_claims_indemnification_obligation": {
+ "type": "boolean"
+ },
+ "include_increased_claims_other": {
+ "type": "string"
+ },
+ "include_insurance_minimums": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_add_customer": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_add_customer_com_gen_liability": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_add_customer_cyber_liability": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_add_customer_errors_omissions": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_additional_information": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_additional_information_text": {
+ "type": "string"
+ },
+ "include_insurance_minimums_cyber_liability_aggregate": {
+ "type": "number"
+ },
+ "include_insurance_minimums_cyber_liability_minimum": {
+ "type": "number"
+ },
+ "include_insurance_minimums_employer_liability_aggregate": {
+ "type": "number"
+ },
+ "include_insurance_minimums_employer_liability_minimum": {
+ "type": "number"
+ },
+ "include_insurance_minimums_general_liability_aggregate": {
+ "type": "number"
+ },
+ "include_insurance_minimums_general_liability_minimum": {
+ "type": "number"
+ },
+ "include_insurance_minimums_include_cyber_liability": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_include_employer_liability": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_include_general_liability": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_include_workers_compensation": {
+ "type": "boolean"
+ },
+ "include_publicity_rights": {
+ "type": "boolean"
+ },
+ "include_publicity_rights_type": {
+ "enum": [
+ "public",
+ "non-public"
+ ],
+ "type": "string"
+ },
+ "include_security_policy": {
+ "type": "boolean"
+ },
+ "include_security_policy_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_security_policy_fedramp_auth": {
+ "type": "boolean"
+ },
+ "include_security_policy_hipaa": {
+ "type": "boolean"
+ },
+ "include_security_policy_hitrust": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_annual_maintenance": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_location": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_other": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_reasonable_efforts": {
+ "type": "boolean"
+ },
+ "include_security_policy_iso27001": {
+ "type": "boolean"
+ },
+ "include_security_policy_location": {
+ "type": "string"
+ },
+ "include_security_policy_other": {
+ "type": "string"
+ },
+ "include_security_policy_pci1": {
+ "type": "boolean"
+ },
+ "include_security_policy_pci2": {
+ "type": "boolean"
+ },
+ "include_security_policy_penetration_testing": {
+ "type": "boolean"
+ },
+ "include_security_policy_soc2": {
+ "type": "boolean"
+ },
+ "include_security_policy_soc2_type2": {
+ "type": "boolean"
+ },
+ "include_security_policy_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_supercap": {
+ "description": "CSA 3.0 renamed `include_increased_cap_amount` to `include_supercap`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_increased_cap_amount`. Sending the other spelling returns a 422.",
+ "type": "boolean"
+ },
+ "include_uncapped_claims": {
+ "description": "CSA 3.0 renamed `include_unlimited_claims` to `include_uncapped_claims`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims`. Sending the other spelling returns a 422.",
+ "type": "boolean"
+ },
+ "include_uncapped_claims_breach_of_confidentiality": {
+ "description": "CSA 3.0 renamed `include_unlimited_claims_breach_of_confidentiality` to `include_uncapped_claims_breach_of_confidentiality`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_breach_of_confidentiality`. Sending the other spelling returns a 422.",
+ "type": "boolean"
+ },
+ "include_uncapped_claims_breach_of_confidentiality_negligence": {
+ "description": "CSA 3.0 renamed `include_unlimited_claims_breach_of_confidentiality_negligence` to `include_uncapped_claims_breach_of_confidentiality_negligence`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_breach_of_confidentiality_negligence`. Sending the other spelling returns a 422.",
+ "type": "boolean"
+ },
+ "include_uncapped_claims_breach_of_privsec": {
+ "description": "CSA 3.0 renamed `include_unlimited_claims_breach_of_privsec` to `include_uncapped_claims_breach_of_privsec`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_breach_of_privsec`. Sending the other spelling returns a 422.",
+ "type": "boolean"
+ },
+ "include_uncapped_claims_breach_of_privsec_negligence": {
+ "description": "CSA 3.0 renamed `include_unlimited_claims_breach_of_privsec_negligence` to `include_uncapped_claims_breach_of_privsec_negligence`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_breach_of_privsec_negligence`. Sending the other spelling returns a 422.",
+ "type": "boolean"
+ },
+ "include_uncapped_claims_include_other": {
+ "description": "CSA 3.0 renamed `include_unlimited_claims_include_other` to `include_uncapped_claims_include_other`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_include_other`. Sending the other spelling returns a 422.",
+ "type": "boolean"
+ },
+ "include_uncapped_claims_indemnification_obligation": {
+ "description": "CSA 3.0 renamed `include_unlimited_claims_indemnification_obligation` to `include_uncapped_claims_indemnification_obligation`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_indemnification_obligation`. Sending the other spelling returns a 422.",
+ "type": "boolean"
+ },
+ "include_uncapped_claims_other": {
+ "description": "CSA 3.0 renamed `include_unlimited_claims_other` to `include_uncapped_claims_other`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_other`. Sending the other spelling returns a 422.",
+ "type": "boolean"
+ },
+ "include_unlimited_claims": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_confidentiality": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_confidentiality_negligence": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_privsec": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_privsec_negligence": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_include_other": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_indemnification_obligation": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_other": {
+ "type": "string"
+ },
+ "increased_cap_amount_currency": {
+ "type": "number"
+ },
+ "increased_cap_amount_period_currency": {
+ "type": "number"
+ },
+ "increased_cap_amount_period_qty": {
+ "type": "number"
+ },
+ "increased_cap_amount_qty": {
+ "type": "number"
+ },
+ "increased_cap_amount_type": {
+ "enum": [
+ "qty",
+ "currency",
+ "period"
+ ],
+ "type": "string"
+ },
+ "provider": {
+ "type": "string"
+ },
+ "supercap_currency": {
+ "description": "CSA 3.0 renamed `increased_cap_amount_currency` to `supercap_currency`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `increased_cap_amount_currency`. Sending the other spelling returns a 422.",
+ "type": "number"
+ },
+ "supercap_period_currency": {
+ "description": "CSA 3.0 renamed `increased_cap_amount_period_currency` to `supercap_period_currency`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `increased_cap_amount_period_currency`. Sending the other spelling returns a 422.",
+ "type": "number"
+ },
+ "supercap_period_qty": {
+ "description": "CSA 3.0 renamed `increased_cap_amount_period_qty` to `supercap_period_qty`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `increased_cap_amount_period_qty`. Sending the other spelling returns a 422.",
+ "type": "number"
+ },
+ "supercap_qty": {
+ "description": "CSA 3.0 renamed `increased_cap_amount_qty` to `supercap_qty`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `increased_cap_amount_qty`. Sending the other spelling returns a 422.",
+ "type": "number"
+ },
+ "supercap_type": {
+ "description": "CSA 3.0 renamed `increased_cap_amount_type` to `supercap_type`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `increased_cap_amount_type`. Sending the other spelling returns a 422.",
+ "type": "number"
+ }
+ },
+ "type": "object"
+ },
+ "csa_order_form_attributes": {
+ "additionalProperties": false,
+ "description": "Override csa order form terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "additional_changes": {
+ "type": "string"
+ },
+ "additional_parameters_or_limitations": {
+ "type": "string"
+ },
+ "affiliates_as_users": {
+ "type": "boolean"
+ },
+ "cloud_service_description": {
+ "type": "string"
+ },
+ "consumption_units": {
+ "type": "string"
+ },
+ "fee_amount": {
+ "type": "number"
+ },
+ "fee_custom_unit": {
+ "type": "string"
+ },
+ "fee_period": {
+ "enum": [
+ "Subscription Period",
+ "month",
+ "year",
+ "User",
+ "Custom unit"
+ ],
+ "type": "string"
+ },
+ "fees_attributes": {
+ "additionalProperties": {
+ "anyOf": [
+ {
+ "additionalProperties": false,
+ "description": "Fees::Flat (fee_type \"flat\"). A fixed recurring fee, e.g. a platform subscription. Set type to \"Fees::Flat\" or fee_type to \"flat\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Fixed amount in the order form's fees_currency, charged per fee_period. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"flat\". Alternative to type.",
+ "enum": [
+ "flat"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Flat\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Flat"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Discount (fee_type \"discount\"). A discount, as a fixed amount or a percentage, applied forever, once, or for a number of months. Set type to \"Fees::Discount\" or fee_type to \"discount\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Discount size: an amount in fees_currency when discount_type is fixed_amount (a plain amount, not cents: 20 means 20.00), or a percentage (e.g. 10 for 10%) when it is percentage.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "discount_duration_amount": {
+ "description": "Number of months the discount applies. Required when discount_duration_type is multiple_months.",
+ "type": "number"
+ },
+ "discount_duration_type": {
+ "description": "How long the discount applies. multiple_months also needs discount_duration_amount.",
+ "enum": [
+ "forever",
+ "once",
+ "multiple_months"
+ ],
+ "type": "string"
+ },
+ "discount_type": {
+ "description": "Whether cost is a currency amount or a percentage.",
+ "enum": [
+ "fixed_amount",
+ "percentage"
+ ],
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"discount\". Alternative to type.",
+ "enum": [
+ "discount"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Discount\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Discount"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Cost (fee_type \"cost\"). A per-unit fee: price per unit times quantity, e.g. seats. Set type to \"Fees::Cost\" or fee_type to \"cost\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Price per unit in fees_currency. The row total is quantity x cost. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"cost\". Alternative to type.",
+ "enum": [
+ "cost"
+ ],
+ "type": "string"
+ },
+ "quantity": {
+ "description": "Number of units.",
+ "type": "number"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Cost\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Cost"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Attachment (fee_type \"attachment\"). A fee described in an uploaded attachment instead of in the table. Set type to \"Fees::Attachment\" or fee_type to \"attachment\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "attachment_id": {
+ "description": "ID of an attachment uploaded with upload-attachment.",
+ "type": "string"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"attachment\". Alternative to type.",
+ "enum": [
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Attachment\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Attachment"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Graduated (fee_type \"graduated\"). Tiered pricing, with the price set per tier in graduated_fee_tiers_attributes. Set type to \"Fees::Graduated\" or fee_type to \"graduated\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"graduated\". Alternative to type.",
+ "enum": [
+ "graduated"
+ ],
+ "type": "string"
+ },
+ "graduated_fee_tiers_attributes": {
+ "additionalProperties": {
+ "additionalProperties": false,
+ "properties": {
+ "flat_price": {
+ "type": "number"
+ },
+ "price_per_unit": {
+ "type": "string"
+ },
+ "upper_limit": {
+ "type": "number"
+ }
+ },
+ "type": "object"
+ },
+ "description": "Graduated fee tiers. Use string keys such as \"0\", \"1\".",
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Graduated\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Graduated"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Included (fee_type \"included\"). An item included at no charge. Set type to \"Fees::Included\" or fee_type to \"included\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"included\". Alternative to type.",
+ "enum": [
+ "included"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Included\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Included"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Metered (fee_type \"metered\"). Usage-based pricing, billed per unit used. Set type to \"Fees::Metered\" or fee_type to \"metered\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Price per unit of usage in fees_currency. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"metered\". Alternative to type.",
+ "enum": [
+ "metered"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Metered\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Metered"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::OneTime (fee_type \"one_time\"). A one-time charge, such as a setup fee. Set type to \"Fees::OneTime\" or fee_type to \"one_time\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "One-time amount in fees_currency, charged once rather than per fee_period. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"one_time\". Alternative to type.",
+ "enum": [
+ "one_time"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::OneTime\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::OneTime"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Text (fee_type \"text\"). A fee term described in free text. Set type to \"Fees::Text\" or fee_type to \"text\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"text\". Alternative to type.",
+ "enum": [
+ "text"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Text\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Text"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ }
+ ]
+ },
+ "description": "Fee table rows, keyed by string index (\"0\", \"1\", ...). Replaces the template's fees when provided. Each row sets type or fee_type to pick the fee class. Amounts are in the order form's fees_currency and, for recurring fees, are charged per fee_period.",
+ "examples": [
+ {
+ "0": {
+ "cost": 2000,
+ "description": "Platform subscription",
+ "type": "Fees::Flat"
+ }
+ },
+ {
+ "0": {
+ "cost": 50,
+ "description": "Seats",
+ "fee_type": "cost",
+ "quantity": 10
+ },
+ "1": {
+ "cost": 10,
+ "description": "Launch discount",
+ "discount_duration_amount": 3,
+ "discount_duration_type": "multiple_months",
+ "discount_type": "percentage",
+ "fee_type": "discount"
+ }
+ }
+ ],
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+ },
+ "fees_currency": {
+ "enum": [
+ "USD",
+ "EUR",
+ "GBP",
+ "CAD",
+ "AUD",
+ "SGD",
+ "ILS",
+ "JPY",
+ "CHF",
+ "HKD"
+ ],
+ "type": "string"
+ },
+ "fees_include_fee_increase_upon_renewal": {
+ "type": "boolean"
+ },
+ "fees_include_fee_increase_upon_renewal_fee": {
+ "type": "number"
+ },
+ "fees_include_fee_increase_upon_renewal_type": {
+ "enum": [
+ "will",
+ "may"
+ ],
+ "type": "string"
+ },
+ "fees_inclusive_of_taxes": {
+ "type": "boolean"
+ },
+ "framework_terms_type": {
+ "enum": [
+ "new",
+ "existing",
+ "description"
+ ],
+ "type": "string"
+ },
+ "free_trial_days": {
+ "type": "number"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_additional_changes": {
+ "type": "boolean"
+ },
+ "include_additional_parameters_or_limitations": {
+ "type": "boolean"
+ },
+ "include_consumption": {
+ "type": "boolean"
+ },
+ "include_fees": {
+ "type": "boolean"
+ },
+ "include_fees_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_fees_include_attachment": {
+ "type": "boolean"
+ },
+ "include_fees_other": {
+ "type": "boolean"
+ },
+ "include_fees_other_val": {
+ "type": "string"
+ },
+ "include_fees_table": {
+ "type": "boolean"
+ },
+ "include_fees_table_period": {
+ "enum": [
+ "Subscription Period",
+ "month",
+ "year",
+ "User"
+ ],
+ "type": "string"
+ },
+ "include_free_trial": {
+ "type": "boolean"
+ },
+ "include_max_users": {
+ "type": "boolean"
+ },
+ "include_pilot_period": {
+ "type": "boolean"
+ },
+ "include_pilot_period_duration_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_pilot_period_duration_type": {
+ "enum": [
+ "day",
+ "week",
+ "month"
+ ],
+ "type": "string"
+ },
+ "include_pilot_period_include_fees": {
+ "type": "boolean"
+ },
+ "include_pilot_period_include_fees_amount": {
+ "type": "number"
+ },
+ "include_pilot_period_include_modifications": {
+ "type": "boolean"
+ },
+ "include_pilot_period_include_modifications_description": {
+ "type": "string"
+ },
+ "include_product_support": {
+ "type": "boolean"
+ },
+ "include_product_support_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_product_support_description": {
+ "type": "string"
+ },
+ "include_product_support_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_professional_services": {
+ "type": "boolean"
+ },
+ "include_professional_services_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_professional_services_custom_name": {
+ "type": "string"
+ },
+ "include_professional_services_description": {
+ "type": "string"
+ },
+ "include_professional_services_end_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "include_professional_services_fees_description": {
+ "type": "string"
+ },
+ "include_professional_services_include_end_date": {
+ "type": "boolean"
+ },
+ "include_professional_services_include_fees_description": {
+ "type": "boolean"
+ },
+ "include_professional_services_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_sla": {
+ "type": "boolean"
+ },
+ "include_sla_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_sla_description": {
+ "type": "string"
+ },
+ "include_sla_include_response_time": {
+ "type": "boolean"
+ },
+ "include_sla_include_response_time_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_sla_include_response_time_credit": {
+ "type": "number"
+ },
+ "include_sla_include_response_time_duration": {
+ "enum": [
+ "hour",
+ "day",
+ "week",
+ "month",
+ "hours"
+ ],
+ "type": "string"
+ },
+ "include_sla_include_response_time_support_channel": {
+ "type": "string"
+ },
+ "include_sla_include_target_uptime": {
+ "type": "boolean"
+ },
+ "include_sla_maintenance_notice": {
+ "type": "boolean"
+ },
+ "include_sla_maintenance_window": {
+ "type": "boolean"
+ },
+ "include_sla_maintenance_window_type": {
+ "enum": [
+ "standard",
+ "none"
+ ],
+ "type": "string"
+ },
+ "include_sla_standard_maintenance_notice_qty": {
+ "type": "number"
+ },
+ "include_sla_standard_maintenance_notice_unit": {
+ "enum": [
+ "hour",
+ "day",
+ "week",
+ "month"
+ ],
+ "type": "string"
+ },
+ "include_sla_standard_maintenance_window_end_time": {
+ "type": "string"
+ },
+ "include_sla_standard_maintenance_window_friday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_monday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_saturday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_start_time": {
+ "type": "string"
+ },
+ "include_sla_standard_maintenance_window_sunday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_thursday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_time_zone": {
+ "type": "string"
+ },
+ "include_sla_standard_maintenance_window_tuesday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_wednesday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_target_uptime": {
+ "type": "number"
+ },
+ "include_sla_type": {
+ "enum": [
+ "description",
+ "standard",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_subscription_start_date": {
+ "type": "boolean"
+ },
+ "include_subscription_start_date_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "include_usage_review": {
+ "type": "boolean"
+ },
+ "include_usage_review_val": {
+ "type": "string"
+ },
+ "include_use_limitations": {
+ "type": "boolean"
+ },
+ "include_use_limitations_val": {
+ "type": "string"
+ },
+ "invoice_period": {
+ "enum": [
+ "monthly",
+ "quarterly",
+ "semiannually",
+ "annually",
+ "Custom unit",
+ "Monthly",
+ "Quarterly",
+ "Semiannually",
+ "Annually"
+ ],
+ "type": "string"
+ },
+ "invoice_period_custom_unit": {
+ "type": "string"
+ },
+ "max_consumption": {
+ "type": "number"
+ },
+ "max_users": {
+ "type": "number"
+ },
+ "negotiations_allowed": {
+ "description": "When true, the recipient can propose changes to the order form, even when the agreement-level `negotiations_allowed` is false. This only covers the order form.",
+ "type": "boolean"
+ },
+ "order_date_date": {
+ "type": "string"
+ },
+ "order_date_other": {
+ "type": "string"
+ },
+ "order_date_type": {
+ "enum": [
+ "signature",
+ "date",
+ "other"
+ ],
+ "type": "string"
+ },
+ "payment_period": {
+ "type": "number"
+ },
+ "payment_period_timeframe": {
+ "enum": [
+ "Customer's receipt of invoice",
+ "date of invoice"
+ ],
+ "type": "string"
+ },
+ "payment_period_unit": {
+ "enum": [
+ "day(s)",
+ "week(s)",
+ "month(s)",
+ "marketplace_acceptance"
+ ],
+ "type": "string"
+ },
+ "payment_process_automatic_frequency": {
+ "enum": [
+ "monthly",
+ "quarterly",
+ "semiannually",
+ "annually"
+ ],
+ "type": "string"
+ },
+ "payment_process_type": {
+ "enum": [
+ "automatic",
+ "invoice",
+ "custom",
+ "marketplace_acceptance"
+ ],
+ "type": "string"
+ },
+ "payment_process_type_custom_val": {
+ "type": "string"
+ },
+ "payment_process_type_invoice_amount": {
+ "type": "number"
+ },
+ "payment_process_type_invoice_custom_unit": {
+ "type": "string"
+ },
+ "payment_process_type_invoice_duration": {
+ "enum": [
+ "day",
+ "week",
+ "month",
+ "year",
+ "day(s)",
+ "week(s)",
+ "month(s)",
+ "year(s)"
+ ],
+ "type": "string"
+ },
+ "payment_process_type_invoice_duration_start": {
+ "enum": [
+ "Customer's receipt of invoice",
+ "date of invoice"
+ ],
+ "type": "string"
+ },
+ "payment_process_type_invoice_type": {
+ "enum": [
+ "monthly",
+ "quarterly",
+ "semiannually",
+ "annually",
+ "Custom unit"
+ ],
+ "type": "string"
+ },
+ "pilot_period_stripe_product_id": {
+ "type": "string"
+ },
+ "service_credits_attributes": {
+ "additionalProperties": {
+ "additionalProperties": false,
+ "properties": {
+ "credit": {
+ "type": "number"
+ },
+ "max": {
+ "type": "number"
+ },
+ "min": {
+ "type": "number"
+ }
+ },
+ "type": "object"
+ },
+ "description": "Service credits. Use string keys such as \"0\", \"1\".",
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+ },
+ "subscription_auto_renew": {
+ "enum": [
+ "days",
+ "subscription_end"
+ ],
+ "type": "string"
+ },
+ "subscription_period": {
+ "type": "number"
+ },
+ "subscription_period_unit": {
+ "type": "string"
+ },
+ "subscription_renewal_notice_days": {
+ "type": "number"
+ },
+ "subscription_start_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "subscription_start_date_type": {
+ "enum": [
+ "effective_date",
+ "date"
+ ],
+ "type": "string"
+ },
+ "underlying_agreement_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "use_limitations_attributes": {
+ "additionalProperties": {
+ "additionalProperties": false,
+ "properties": {
+ "amount": {
+ "type": "number"
+ },
+ "limitation_type": {
+ "type": "string"
+ },
+ "unit": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "description": "Use limitations. Use string keys such as \"0\", \"1\".",
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+ }
+ },
+ "type": "object"
+ },
+ "custom_field_values": {
+ "description": "Values for a custom template's fields, keyed by the field keys defined in the template's YAML definition. Only used when template_id is a custom template. Template defaults fill any fields you omit; a required field with no default and no submitted value returns a 400 naming the field. Values are validated against the field's input type: select and radio values must be one of the field's options, multiselect values are an array of selections each of which must be one of the field's options, number and currency values must be numeric, date values must be YYYY-MM-DD, and email values must be valid addresses. An invalid value returns a 400 naming the field."
+ },
+ "design_partner_attributes": {
+ "additionalProperties": false,
+ "description": "Override design partner terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "customer_description": {
+ "type": "string"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_fees": {
+ "type": "boolean"
+ },
+ "include_fees_amount": {
+ "type": "number"
+ },
+ "include_fees_description": {
+ "type": "string"
+ },
+ "include_fees_pay_by_amount": {
+ "type": "string"
+ },
+ "include_fees_type": {
+ "enum": [
+ "default_language",
+ "description"
+ ],
+ "type": "string"
+ },
+ "include_fees_unit": {
+ "enum": [
+ "month",
+ "quarter",
+ "year",
+ "Term"
+ ],
+ "type": "string"
+ },
+ "include_program_appear_as_customer_private": {
+ "type": "boolean"
+ },
+ "include_program_appear_as_customer_public": {
+ "type": "boolean"
+ },
+ "include_program_case_study": {
+ "type": "boolean"
+ },
+ "include_program_develop_functionality": {
+ "type": "boolean"
+ },
+ "include_program_develop_functionality_val": {
+ "type": "string"
+ },
+ "include_program_discount": {
+ "type": "boolean"
+ },
+ "include_program_discount_amount": {
+ "type": "number"
+ },
+ "include_program_discount_unit": {
+ "enum": [
+ "U.S. Dollars",
+ "percent"
+ ],
+ "type": "string"
+ },
+ "include_program_participation_feedback": {
+ "type": "boolean"
+ },
+ "include_program_participation_feedback_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_program_participation_feedback_unit": {
+ "enum": [
+ "month",
+ "quarter",
+ "year",
+ "Term"
+ ],
+ "type": "string"
+ },
+ "include_program_partner_other": {
+ "type": "boolean"
+ },
+ "include_program_partner_other_val": {
+ "type": "string"
+ },
+ "include_program_provider_other": {
+ "type": "boolean"
+ },
+ "include_program_provider_other_val": {
+ "type": "string"
+ },
+ "include_program_reference": {
+ "type": "boolean"
+ },
+ "product_description": {
+ "type": "string"
+ },
+ "term_amount": {
+ "type": "number"
+ },
+ "term_unit": {
+ "enum": [
+ "day(s)",
+ "week(s)",
+ "month(s)",
+ "quarter(s)",
+ "year(s)"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "district_or_county": {
+ "description": "The district or county for dispute resolution.",
+ "type": "string"
+ },
+ "dpa_attributes": {
+ "additionalProperties": false,
+ "description": "Override dpa terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "approved_subprocessor_type": {
+ "description": "`internal` lists approved subprocessors in the agreement (`subprocessors_attributes`); `external` points to a list published elsewhere.",
+ "enum": [
+ "internal",
+ "external"
+ ],
+ "type": "string"
+ },
+ "cloud_service_product_name": {
+ "type": "string"
+ },
+ "competent_supervisory_authority": {
+ "type": "string"
+ },
+ "customer_description": {
+ "type": "string"
+ },
+ "data_exporter_address_city": {
+ "type": "string"
+ },
+ "data_exporter_address_country": {
+ "type": "string"
+ },
+ "data_exporter_address_state": {
+ "type": "string"
+ },
+ "data_exporter_address_street_address": {
+ "type": "string"
+ },
+ "data_exporter_address_zipcode": {
+ "type": "string"
+ },
+ "data_exporter_contact_details": {
+ "type": "string"
+ },
+ "data_exporter_contact_name": {
+ "type": "string"
+ },
+ "data_exporter_contact_position": {
+ "type": "string"
+ },
+ "data_exporter_role": {
+ "description": "Role of the data exporter. Overwritten to `Controller` when the agreement is created from a template.",
+ "enum": [
+ "Controller",
+ "Processor"
+ ],
+ "type": "string"
+ },
+ "data_importer_address": {
+ "type": "string"
+ },
+ "data_importer_address_city": {
+ "type": "string"
+ },
+ "data_importer_address_country": {
+ "type": "string"
+ },
+ "data_importer_address_state": {
+ "type": "string"
+ },
+ "data_importer_address_street_address": {
+ "type": "string"
+ },
+ "data_importer_address_zipcode": {
+ "type": "string"
+ },
+ "data_importer_contact_details": {
+ "type": "string"
+ },
+ "data_importer_contact_name": {
+ "type": "string"
+ },
+ "data_importer_contact_position": {
+ "type": "string"
+ },
+ "duration_of_processing": {
+ "type": "string"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_covered_claim": {
+ "type": "boolean"
+ },
+ "include_covered_claim_external_val": {
+ "type": "string"
+ },
+ "include_covered_claim_internal_val": {
+ "type": "string"
+ },
+ "include_covered_claim_type": {
+ "description": "Which covered-claim text applies: `internal` uses `include_covered_claim_internal_val`, `external` uses `include_covered_claim_external_val`. Required when `include_covered_claim` is true.",
+ "enum": [
+ "internal",
+ "external"
+ ],
+ "type": "string"
+ },
+ "include_data_subjects_custom": {
+ "type": "boolean"
+ },
+ "include_data_subjects_custom_val": {
+ "type": "string"
+ },
+ "include_data_subjects_employees": {
+ "type": "boolean"
+ },
+ "include_data_subjects_end_users": {
+ "type": "boolean"
+ },
+ "include_external_subprocessor_location": {
+ "type": "string"
+ },
+ "include_frequency_of_transfer_continuous": {
+ "type": "boolean"
+ },
+ "include_frequency_of_transfer_custom": {
+ "type": "boolean"
+ },
+ "include_frequency_of_transfer_custom_val": {
+ "type": "string"
+ },
+ "include_governing_country_eu": {
+ "type": "boolean"
+ },
+ "include_governing_country_eu_val": {
+ "type": "string"
+ },
+ "include_governing_country_uk": {
+ "type": "boolean"
+ },
+ "include_governing_country_uk_val": {
+ "type": "string"
+ },
+ "include_governing_law": {
+ "type": "boolean"
+ },
+ "include_governing_law_country": {
+ "type": "string"
+ },
+ "include_governing_law_state": {
+ "type": "string"
+ },
+ "include_increased_claim_amount": {
+ "description": "Legacy field. Stored but not shown on the DPA; use the `include_liability_cap*` fields instead.",
+ "type": "boolean"
+ },
+ "include_increased_claim_amount_currency": {
+ "description": "Legacy field. Stored but not shown on the DPA; use the `include_liability_cap*` fields instead."
+ },
+ "include_increased_claim_amount_qty": {
+ "description": "Legacy field. Stored but not shown on the DPA; use the `include_liability_cap*` fields instead."
+ },
+ "include_increased_claim_amount_type": {
+ "description": "Legacy field. Stored but not shown on the DPA; use the `include_liability_cap*` fields instead.",
+ "type": "string"
+ },
+ "include_liability_cap": {
+ "type": "boolean"
+ },
+ "include_liability_cap_amount_constant_external": {
+ "type": "string"
+ },
+ "include_liability_cap_amount_constant_internal": {
+ "type": "string"
+ },
+ "include_liability_cap_amount_currency_external": {
+ "description": "Currency amount. Numbers and numeric strings (commas allowed) are both accepted."
+ },
+ "include_liability_cap_amount_currency_internal": {
+ "description": "Currency amount. Numbers and numeric strings (commas allowed) are both accepted."
+ },
+ "include_liability_cap_csa_type": {
+ "description": "Which liability cap values apply: the `_internal` or `_external` amount fields. Required when `include_liability_cap` is true.",
+ "enum": [
+ "internal",
+ "external"
+ ],
+ "type": "string"
+ },
+ "include_personal_data_biographic_info": {
+ "type": "boolean"
+ },
+ "include_personal_data_contact_info": {
+ "type": "boolean"
+ },
+ "include_personal_data_custom": {
+ "type": "boolean"
+ },
+ "include_personal_data_custom_val": {
+ "type": "string"
+ },
+ "include_personal_data_employment_info": {
+ "type": "boolean"
+ },
+ "include_personal_data_financial_info": {
+ "type": "boolean"
+ },
+ "include_personal_data_location": {
+ "type": "boolean"
+ },
+ "include_personal_data_name": {
+ "type": "boolean"
+ },
+ "include_personal_data_transactional_info": {
+ "type": "boolean"
+ },
+ "include_personal_data_user_activity_info": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_custom": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_custom_val": {
+ "type": "string"
+ },
+ "include_processing_purpose_erasing": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_holding": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_protecting": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_receiving": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_returning": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_sharing": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_updating": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_using": {
+ "type": "boolean"
+ },
+ "include_provider_security_contact_address": {
+ "type": "boolean"
+ },
+ "include_provider_security_contact_address_city": {
+ "type": "string"
+ },
+ "include_provider_security_contact_address_country": {
+ "type": "string"
+ },
+ "include_provider_security_contact_address_state": {
+ "type": "string"
+ },
+ "include_provider_security_contact_address_street_address": {
+ "type": "string"
+ },
+ "include_provider_security_contact_address_zipcode": {
+ "type": "string"
+ },
+ "include_provider_security_contact_email": {
+ "type": "boolean"
+ },
+ "include_provider_security_contact_email_val": {
+ "format": "email",
+ "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "include_security_measures_accountability": {
+ "type": "boolean"
+ },
+ "include_security_measures_accountability_val": {
+ "type": "string"
+ },
+ "include_security_measures_certification_or_assurance": {
+ "type": "boolean"
+ },
+ "include_security_measures_certification_or_assurance_val": {
+ "type": "string"
+ },
+ "include_security_measures_confidentiality_integrity": {
+ "type": "boolean"
+ },
+ "include_security_measures_confidentiality_integrity_val": {
+ "type": "string"
+ },
+ "include_security_measures_data_at_rest": {
+ "type": "boolean"
+ },
+ "include_security_measures_data_at_rest_val": {
+ "type": "string"
+ },
+ "include_security_measures_data_minimization": {
+ "type": "boolean"
+ },
+ "include_security_measures_data_minimization_val": {
+ "type": "string"
+ },
+ "include_security_measures_data_quality": {
+ "type": "boolean"
+ },
+ "include_security_measures_data_quality_val": {
+ "type": "string"
+ },
+ "include_security_measures_data_retention": {
+ "type": "boolean"
+ },
+ "include_security_measures_data_retention_val": {
+ "type": "string"
+ },
+ "include_security_measures_data_transmission": {
+ "type": "boolean"
+ },
+ "include_security_measures_data_transmission_val": {
+ "type": "string"
+ },
+ "include_security_measures_event_logging": {
+ "type": "boolean"
+ },
+ "include_security_measures_event_logging_val": {
+ "type": "string"
+ },
+ "include_security_measures_identity_auth": {
+ "type": "boolean"
+ },
+ "include_security_measures_identity_auth_val": {
+ "type": "string"
+ },
+ "include_security_measures_it_security_governance": {
+ "type": "boolean"
+ },
+ "include_security_measures_it_security_governance_val": {
+ "type": "string"
+ },
+ "include_security_measures_physical_security": {
+ "type": "boolean"
+ },
+ "include_security_measures_physical_security_val": {
+ "type": "string"
+ },
+ "include_security_measures_portability_and_erasure": {
+ "type": "boolean"
+ },
+ "include_security_measures_portability_and_erasure_val": {
+ "type": "string"
+ },
+ "include_security_measures_pseudonym_encryption": {
+ "type": "boolean"
+ },
+ "include_security_measures_pseudonym_encryption_val": {
+ "type": "string"
+ },
+ "include_security_measures_restore_data_access": {
+ "type": "boolean"
+ },
+ "include_security_measures_restore_data_access_val": {
+ "type": "string"
+ },
+ "include_security_measures_security_policy": {
+ "type": "boolean"
+ },
+ "include_security_measures_system_configuration": {
+ "type": "boolean"
+ },
+ "include_security_measures_system_configuration_val": {
+ "type": "string"
+ },
+ "include_security_measures_testing_assessment": {
+ "type": "boolean"
+ },
+ "include_security_measures_testing_assessment_val": {
+ "type": "string"
+ },
+ "include_security_policy": {
+ "type": "boolean"
+ },
+ "include_security_policy_fedramp_auth": {
+ "type": "boolean"
+ },
+ "include_security_policy_hipaa": {
+ "type": "boolean"
+ },
+ "include_security_policy_hitrust": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_other": {
+ "type": "boolean"
+ },
+ "include_security_policy_iso27001": {
+ "type": "boolean"
+ },
+ "include_security_policy_other": {
+ "type": "string"
+ },
+ "include_security_policy_pci1": {
+ "type": "boolean"
+ },
+ "include_security_policy_pci2": {
+ "type": "boolean"
+ },
+ "include_security_policy_penetration_testing": {
+ "type": "boolean"
+ },
+ "include_security_policy_soc2": {
+ "type": "boolean"
+ },
+ "include_security_policy_soc2_type2": {
+ "type": "boolean"
+ },
+ "include_sensitive_data_restrictions_custom": {
+ "type": "boolean"
+ },
+ "include_sensitive_data_restrictions_custom_val": {
+ "type": "string"
+ },
+ "include_sensitive_data_restrictions_security_policy": {
+ "type": "boolean"
+ },
+ "include_service_provider_relationship": {
+ "type": "boolean"
+ },
+ "include_special_category_data": {
+ "type": "boolean"
+ },
+ "provider": {
+ "type": "string"
+ },
+ "security_policy_available_at": {
+ "type": "string"
+ },
+ "security_policy_type": {
+ "description": "Where the Security Policy is defined. For `external`, set `security_policy_available_at`.",
+ "enum": [
+ "defined in agreement",
+ "provider service",
+ "external"
+ ],
+ "type": "string"
+ },
+ "subprocessors_attributes": {
+ "additionalProperties": {
+ "additionalProperties": false,
+ "properties": {
+ "_destroy": {
+ "description": "Set to true with `id` to remove that subprocessor.",
+ "type": "boolean"
+ },
+ "country": {
+ "type": "string"
+ },
+ "id": {
+ "description": "ID of an existing subprocessor to update or remove. Omit to add a new subprocessor.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "processing_task": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "description": "Subprocessors, keyed by string index such as \"0\", \"1\". On create these are added to the template's subprocessors. On a draft update, an entry without `id` adds a new subprocessor; pass `id` to change one and `id` with `_destroy: true` to remove one.",
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+ },
+ "underlying_agreement_id": {
+ "description": "ID of the CSA this DPA supplements when `underlying_agreement_type` is `internal`.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "underlying_agreement_type": {
+ "description": "`internal` links a CSA in Common Paper (`underlying_agreement_id`); `external` describes another agreement in `underlying_agreement_val` (required). Omit for none.",
+ "enum": [
+ "internal",
+ "external"
+ ],
+ "type": "string"
+ },
+ "underlying_agreement_val": {
+ "description": "Description of the agreement this DPA supplements. Required when `underlying_agreement_type` is `external`.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "framework_terms_description": {
+ "description": "Custom framework terms description. Only used when framework_terms_type is \"description\".",
+ "type": "string"
+ },
+ "framework_terms_type": {
+ "description": "How framework terms are specified. Use \"new\" for standard terms or \"description\" to provide a custom framework_terms_description.",
+ "enum": [
+ "new",
+ "description"
+ ],
+ "type": "string"
+ },
+ "governing_law_country": {
+ "description": "The country whose laws govern the agreement.",
+ "type": "string"
+ },
+ "governing_law_region": {
+ "description": "The state or region whose laws govern the agreement.",
+ "type": "string"
+ },
+ "include_automated_payment_reminders": {
+ "description": "When true, automatically sends payment reminder emails.",
+ "type": "boolean"
+ },
+ "include_billing_info": {
+ "description": "When true, billing contact information (billing_name, billing_email) is included.",
+ "type": "boolean"
+ },
+ "include_billing_workflow": {
+ "description": "When true, enables a billing workflow after signing.",
+ "type": "boolean"
+ },
+ "include_expiration_date": {
+ "description": "Expiration date in YYYY-MM-DD format. Use when include_expiration_type is \"date\".",
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "include_expiration_days": {
+ "description": "Number of days until the agreement expires. Use when include_expiration_type is \"days\".",
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_expiration_type": {
+ "description": "How to set expiration: \"none\" (default), \"days\" (use include_expiration_days), or \"date\" (use include_expiration_date).",
+ "enum": [
+ "none",
+ "days",
+ "date"
+ ],
+ "type": "string"
+ },
+ "include_terms": {
+ "description": "When true, the standard terms are included with the agreement.",
+ "type": "boolean"
+ },
+ "loi_attributes": {
+ "additionalProperties": false,
+ "description": "Override loi terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "confidentiality_custom": {
+ "type": "string"
+ },
+ "confidentiality_mutual_include_loi": {
+ "type": "boolean"
+ },
+ "confidentiality_nda_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "confidentiality_nda_description": {
+ "type": "string"
+ },
+ "confidentiality_nda_include_loi": {
+ "type": "boolean"
+ },
+ "confidentiality_nda_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "confidentiality_type": {
+ "enum": [
+ "mutual",
+ "nda",
+ "provider",
+ "custom"
+ ],
+ "type": "string"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_custom_details": {
+ "type": "boolean"
+ },
+ "include_custom_details_val": {
+ "type": "string"
+ },
+ "include_fees": {
+ "type": "boolean"
+ },
+ "include_fees_amount": {
+ "type": "number"
+ },
+ "include_fees_amount_duration": {
+ "enum": [
+ "month",
+ "year",
+ "quarter"
+ ],
+ "type": "string"
+ },
+ "include_fees_include_amount": {
+ "type": "boolean"
+ },
+ "include_fees_include_other": {
+ "type": "boolean"
+ },
+ "include_fees_other": {
+ "type": "string"
+ },
+ "include_functionality": {
+ "type": "boolean"
+ },
+ "include_functionality_val": {
+ "type": "string"
+ },
+ "include_launch_date": {
+ "type": "boolean"
+ },
+ "include_launch_date_custom": {
+ "type": "string"
+ },
+ "include_launch_date_date": {
+ "format": "date-time",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$",
+ "type": "string"
+ },
+ "include_launch_date_type": {
+ "enum": [
+ "date",
+ "custom"
+ ],
+ "type": "string"
+ },
+ "product_name": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "manual_send": {
+ "description": "When true, the agreement is marked as manually sent outside the platform.",
+ "type": "boolean"
+ },
+ "message": {
+ "type": "string"
+ },
+ "negotiations_allowed": {
+ "description": "When true, the recipient can propose changes to the legal terms. For agreement types without separate business terms, that covers every term. CSA order forms, PSA statements of work, partnership business terms and software license order forms have their own `negotiations_allowed` flag.",
+ "type": "boolean"
+ },
+ "partnership_attributes": {
+ "additionalProperties": false,
+ "description": "Override partnership terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "effective_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "effective_date_type": {
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "type": "string"
+ },
+ "general_cap_amount_currency_val": {
+ "type": "number"
+ },
+ "general_cap_amount_either_currency": {
+ "type": "number"
+ },
+ "general_cap_amount_either_multiple": {
+ "type": "number"
+ },
+ "general_cap_amount_multiple_val": {
+ "type": "number"
+ },
+ "general_cap_amount_type": {
+ "enum": [
+ "multiple",
+ "currency",
+ "either",
+ "base"
+ ],
+ "type": "string"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_additional_warranties": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_include_company": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_include_company_val": {
+ "type": "string"
+ },
+ "include_additional_warranties_include_partner": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_include_partner_val": {
+ "type": "string"
+ },
+ "include_brand_guidelines": {
+ "type": "boolean"
+ },
+ "include_brand_guidelines_include_company": {
+ "type": "boolean"
+ },
+ "include_brand_guidelines_include_company_val": {
+ "type": "string"
+ },
+ "include_brand_guidelines_include_partner": {
+ "type": "boolean"
+ },
+ "include_brand_guidelines_include_partner_val": {
+ "type": "string"
+ },
+ "include_covered_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_company_claims": {
+ "type": "string"
+ },
+ "include_covered_claims_include_company_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_include_partner_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_partner_claims": {
+ "type": "string"
+ },
+ "include_dpa": {
+ "type": "boolean"
+ },
+ "include_dpa_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_dpa_location": {
+ "type": "string"
+ },
+ "include_dpa_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_increased_cap_amount": {
+ "type": "boolean"
+ },
+ "include_increased_cap_amount_currency": {
+ "type": "number"
+ },
+ "include_increased_cap_amount_either_currency": {
+ "type": "number"
+ },
+ "include_increased_cap_amount_either_multiple": {
+ "type": "string"
+ },
+ "include_increased_cap_amount_multiple": {
+ "type": "string"
+ },
+ "include_increased_cap_amount_type": {
+ "enum": [
+ "multiple",
+ "currency",
+ "either"
+ ],
+ "type": "string"
+ },
+ "include_increased_claims": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_confidentiality": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_confidentiality_misconduct": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_covered_claims": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_misconduct": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_other": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_other_val": {
+ "type": "string"
+ },
+ "include_unlimited_claims": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_confidentiality": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_confidentiality_misconduct": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_covered_claims": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_misconduct": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_other": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_other_val": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "partnership_business_terms_attributes": {
+ "additionalProperties": false,
+ "description": "Override partnership business terms terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "end_date_after_effective_date_amount": {
+ "type": "number"
+ },
+ "end_date_after_effective_date_unit": {
+ "enum": [
+ "month(s)",
+ "quarter(s)",
+ "year(s)"
+ ],
+ "type": "string"
+ },
+ "end_date_date": {
+ "type": "string"
+ },
+ "end_date_type": {
+ "enum": [
+ "date",
+ "effective date"
+ ],
+ "type": "string"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_obligations_company_brand": {
+ "type": "boolean"
+ },
+ "include_obligations_company_promotion": {
+ "type": "boolean"
+ },
+ "include_obligations_company_promotion_include_activities": {
+ "type": "boolean"
+ },
+ "include_obligations_company_promotion_include_activities_val": {
+ "type": "string"
+ },
+ "include_obligations_company_promotion_include_materials": {
+ "type": "boolean"
+ },
+ "include_obligations_company_promotion_include_materials_val": {
+ "type": "string"
+ },
+ "include_obligations_company_referral": {
+ "type": "boolean"
+ },
+ "include_obligations_company_referral_include_criteria": {
+ "type": "boolean"
+ },
+ "include_obligations_company_referral_include_criteria_val": {
+ "type": "string"
+ },
+ "include_obligations_company_referral_include_pay_sch": {
+ "type": "boolean"
+ },
+ "include_obligations_company_referral_include_pay_sch_amount": {
+ "type": "number"
+ },
+ "include_obligations_company_referral_include_pay_sch_custom": {
+ "type": "string"
+ },
+ "include_obligations_company_referral_include_pay_sch_unit": {
+ "enum": [
+ "U.S. Dollars",
+ "percent"
+ ],
+ "type": "string"
+ },
+ "include_obligations_company_sponsorship": {
+ "type": "boolean"
+ },
+ "include_obligations_company_sponsorship_include_benefits": {
+ "type": "boolean"
+ },
+ "include_obligations_company_sponsorship_include_benefits_val": {
+ "type": "string"
+ },
+ "include_obligations_company_sponsorship_include_payments": {
+ "type": "boolean"
+ },
+ "include_obligations_company_sponsorship_include_payments_amount": {
+ "type": "number"
+ },
+ "include_obligations_company_sponsorship_include_payments_unit": {
+ "enum": [
+ "U.S. Dollars",
+ "percent"
+ ],
+ "type": "string"
+ },
+ "include_obligations_partner_brand": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_promotion": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_promotion_include_activities": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_promotion_include_activities_val": {
+ "type": "string"
+ },
+ "include_obligations_partner_promotion_include_materials": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_promotion_include_materials_val": {
+ "type": "string"
+ },
+ "include_obligations_partner_referral": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_referral_include_criteria": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_referral_include_criteria_val": {
+ "type": "string"
+ },
+ "include_obligations_partner_referral_include_pay_sch": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_referral_include_pay_sch_amount": {
+ "type": "number"
+ },
+ "include_obligations_partner_referral_include_pay_sch_custom": {
+ "type": "string"
+ },
+ "include_obligations_partner_referral_include_pay_sch_unit": {
+ "enum": [
+ "U.S. Dollars",
+ "percent"
+ ],
+ "type": "string"
+ },
+ "include_obligations_partner_sponsorship": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_sponsorship_include_benefits": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_sponsorship_include_benefits_val": {
+ "type": "string"
+ },
+ "include_obligations_partner_sponsorship_include_payments": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_sponsorship_include_payments_amount": {
+ "type": "number"
+ },
+ "include_obligations_partner_sponsorship_include_payments_unit": {
+ "enum": [
+ "U.S. Dollars",
+ "percent"
+ ],
+ "type": "string"
+ },
+ "include_payment_process": {
+ "type": "boolean"
+ },
+ "include_payment_process_company": {
+ "type": "boolean"
+ },
+ "include_payment_process_company_include_address": {
+ "type": "boolean"
+ },
+ "include_payment_process_company_include_address_city": {
+ "type": "string"
+ },
+ "include_payment_process_company_include_address_country": {
+ "type": "string"
+ },
+ "include_payment_process_company_include_address_state": {
+ "type": "string"
+ },
+ "include_payment_process_company_include_address_street_address": {
+ "type": "string"
+ },
+ "include_payment_process_company_include_address_zipcode": {
+ "type": "string"
+ },
+ "include_payment_process_company_include_email": {
+ "type": "boolean"
+ },
+ "include_payment_process_company_include_email_val": {
+ "type": "string"
+ },
+ "include_payment_process_partner": {
+ "type": "boolean"
+ },
+ "include_payment_process_partner_include_address": {
+ "type": "boolean"
+ },
+ "include_payment_process_partner_include_address_city": {
+ "type": "string"
+ },
+ "include_payment_process_partner_include_address_country": {
+ "type": "string"
+ },
+ "include_payment_process_partner_include_address_state": {
+ "type": "string"
+ },
+ "include_payment_process_partner_include_address_street_address": {
+ "type": "string"
+ },
+ "include_payment_process_partner_include_address_zipcode": {
+ "type": "string"
+ },
+ "include_payment_process_partner_include_email": {
+ "type": "boolean"
+ },
+ "include_payment_process_partner_include_email_val": {
+ "type": "string"
+ },
+ "include_payment_schedule": {
+ "type": "boolean"
+ },
+ "include_payment_schedule_custom": {
+ "type": "string"
+ },
+ "include_payment_schedule_specified_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_payment_schedule_specified_timeframe": {
+ "enum": [
+ "receipt",
+ "date"
+ ],
+ "type": "string"
+ },
+ "include_payment_schedule_specified_unit": {
+ "enum": [
+ "day(s)",
+ "week(s)",
+ "month(s)",
+ "quarter(s)",
+ "year(s)"
+ ],
+ "type": "string"
+ },
+ "include_payment_schedule_type": {
+ "enum": [
+ "specified",
+ "custom"
+ ],
+ "type": "string"
+ },
+ "negotiations_allowed": {
+ "description": "When true, the recipient can propose changes to the business terms, even when the agreement-level `negotiations_allowed` is false. This only covers the business terms.",
+ "type": "boolean"
+ },
+ "territory_type": {
+ "enum": [
+ "worldwide",
+ "custom"
+ ],
+ "type": "string"
+ },
+ "territory_type_val": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "payment_link_url": {
+ "description": "A payment URL shown to the recipient after signing. Requires include_billing_workflow to be true and billing_workflow_type to be \"link\".",
+ "type": "string"
+ },
+ "pilot_attributes": {
+ "additionalProperties": false,
+ "description": "Override pilot terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "fees_type": {
+ "enum": [
+ "free",
+ "pilot_period_fees"
+ ],
+ "type": "string"
+ },
+ "general_cap_amount": {
+ "type": "number"
+ },
+ "general_cap_amount_type": {
+ "enum": [
+ "preceding",
+ "base",
+ "period"
+ ],
+ "type": "string"
+ },
+ "general_cap_period_currency": {
+ "type": "number"
+ },
+ "general_cap_period_qty": {
+ "type": "number"
+ },
+ "general_cap_preceding_amount": {
+ "type": "number"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_dpa": {
+ "type": "boolean"
+ },
+ "include_dpa_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_dpa_location": {
+ "type": "string"
+ },
+ "include_dpa_type": {
+ "enum": [
+ "description",
+ "attachment",
+ "standard"
+ ],
+ "type": "string"
+ },
+ "include_payment_process": {
+ "type": "boolean"
+ },
+ "include_technical_support": {
+ "type": "boolean"
+ },
+ "payment_process_automatic_frequency": {
+ "enum": [
+ "monthly",
+ "quarterly",
+ "annually",
+ "once_per_period"
+ ],
+ "type": "string"
+ },
+ "payment_process_invoice_days": {
+ "type": "number"
+ },
+ "payment_process_invoice_from": {
+ "enum": [
+ "receipt",
+ "date"
+ ],
+ "type": "string"
+ },
+ "payment_process_invoice_timeframe": {
+ "enum": [
+ "days",
+ "weeks",
+ "months",
+ "quarters",
+ "years"
+ ],
+ "type": "string"
+ },
+ "payment_process_type": {
+ "enum": [
+ "automatic",
+ "invoice"
+ ],
+ "type": "string"
+ },
+ "pilot_period_description": {
+ "type": "string"
+ },
+ "pilot_period_fees_description": {
+ "type": "string"
+ },
+ "product_description": {
+ "type": "string"
+ },
+ "technical_support_description": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "psa_attributes": {
+ "additionalProperties": false,
+ "description": "Override psa terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "additional_changes": {
+ "type": "string"
+ },
+ "customer_description": {
+ "type": "string"
+ },
+ "effective_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "effective_date_type": {
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "type": "string"
+ },
+ "general_cap_amount": {
+ "type": "number"
+ },
+ "general_cap_amount_type": {
+ "enum": [
+ "preceding",
+ "base",
+ "period"
+ ],
+ "type": "string"
+ },
+ "general_cap_period_currency": {
+ "type": "number"
+ },
+ "general_cap_period_qty": {
+ "type": "number"
+ },
+ "general_cap_preceding_amount": {
+ "type": "number"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_additional_changes": {
+ "type": "boolean"
+ },
+ "include_additional_warranties": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_by_customer": {
+ "type": "string"
+ },
+ "include_additional_warranties_by_provider": {
+ "type": "string"
+ },
+ "include_additional_warranties_include_by_customer": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_include_by_provider": {
+ "type": "boolean"
+ },
+ "include_covered_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_customer_claims": {
+ "type": "string"
+ },
+ "include_covered_claims_include_customer_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_include_provider_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_provider_claims": {
+ "type": "string"
+ },
+ "include_customer_insurance_min": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_add_provider_com_gen_liability": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_add_provider_cyber_liability": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_add_provider_errors_omissions": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_auto_liability_aggregate": {
+ "type": "number"
+ },
+ "include_customer_insurance_min_auto_liability_minimum": {
+ "type": "number"
+ },
+ "include_customer_insurance_min_cyber_liability_aggregate": {
+ "type": "number"
+ },
+ "include_customer_insurance_min_cyber_liability_minimum": {
+ "type": "number"
+ },
+ "include_customer_insurance_min_employer_liability_aggregate": {
+ "type": "number"
+ },
+ "include_customer_insurance_min_employer_liability_minimum": {
+ "type": "number"
+ },
+ "include_customer_insurance_min_general_liability_aggregate": {
+ "type": "number"
+ },
+ "include_customer_insurance_min_general_liability_minimum": {
+ "type": "number"
+ },
+ "include_customer_insurance_min_include_add_provider": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_include_auto_liability": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_include_cyber_liability": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_include_employer_liability": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_include_general_liability": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_include_workers_comp": {
+ "type": "boolean"
+ },
+ "include_customer_policies": {
+ "type": "boolean"
+ },
+ "include_customer_policies_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_customer_policies_location": {
+ "type": "string"
+ },
+ "include_customer_policies_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_dpa": {
+ "type": "boolean"
+ },
+ "include_dpa_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_dpa_location": {
+ "type": "string"
+ },
+ "include_dpa_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_increased_cap_amount": {
+ "type": "boolean"
+ },
+ "include_increased_claims": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_confidentiality": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_confidentiality_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_privsec": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_privsec_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_other": {
+ "type": "boolean"
+ },
+ "include_increased_claims_indemnification_obligation": {
+ "type": "boolean"
+ },
+ "include_increased_claims_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_other": {
+ "type": "string"
+ },
+ "include_provider_insurance_min": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_add_customer_com_gen_liability": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_add_customer_cyber_liability": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_add_customer_errors_omissions": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_auto_liability_aggregate": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_auto_liability_minimum": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_cyber_liability_aggregate": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_cyber_liability_minimum": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_employer_liability_aggregate": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_employer_liability_minimum": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_general_liability_aggregate": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_general_liability_minimum": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_include_add_customer": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_include_auto_liability": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_include_cyber_liability": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_include_employer_liability": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_include_general_liability": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_include_workers_comp": {
+ "type": "boolean"
+ },
+ "include_publicity_rights": {
+ "type": "boolean"
+ },
+ "include_publicity_rights_type": {
+ "enum": [
+ "public",
+ "non-public"
+ ],
+ "type": "string"
+ },
+ "include_security_policy": {
+ "type": "boolean"
+ },
+ "include_security_policy_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_security_policy_fedramp_auth": {
+ "type": "boolean"
+ },
+ "include_security_policy_hitrust": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_annual_maintenance": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_other": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_other_val": {
+ "type": "string"
+ },
+ "include_security_policy_iso27001": {
+ "type": "boolean"
+ },
+ "include_security_policy_location": {
+ "type": "string"
+ },
+ "include_security_policy_pci1": {
+ "type": "boolean"
+ },
+ "include_security_policy_pci2": {
+ "type": "boolean"
+ },
+ "include_security_policy_penetration_testing": {
+ "type": "boolean"
+ },
+ "include_security_policy_soc2_type1": {
+ "type": "boolean"
+ },
+ "include_security_policy_soc2_type2": {
+ "type": "boolean"
+ },
+ "include_security_policy_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_unlimited_claims": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_confidentiality": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_confidentiality_negligence": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_privsec": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_privsec_negligence": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_include_other": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_indemnification_obligation": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_negligence": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_other": {
+ "type": "string"
+ },
+ "increased_cap_amount_currency": {
+ "type": "number"
+ },
+ "increased_cap_amount_period_currency": {
+ "type": "number"
+ },
+ "increased_cap_amount_period_qty": {
+ "type": "number"
+ },
+ "increased_cap_amount_qty": {
+ "type": "number"
+ },
+ "increased_cap_amount_type": {
+ "enum": [
+ "qty",
+ "currency",
+ "period"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "psa_statement_of_work_attributes": {
+ "additionalProperties": false,
+ "description": "Override psa statement of work terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "additional_changes": {
+ "type": "string"
+ },
+ "cost": {
+ "type": "number"
+ },
+ "description": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "fees_attributes": {
+ "additionalProperties": {
+ "anyOf": [
+ {
+ "additionalProperties": false,
+ "description": "Fees::Flat (fee_type \"flat\"). A fixed recurring fee, e.g. a platform subscription. Set type to \"Fees::Flat\" or fee_type to \"flat\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Fixed amount in the order form's fees_currency, charged per fee_period. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"flat\". Alternative to type.",
+ "enum": [
+ "flat"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Flat\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Flat"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Discount (fee_type \"discount\"). A discount, as a fixed amount or a percentage, applied forever, once, or for a number of months. Set type to \"Fees::Discount\" or fee_type to \"discount\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Discount size: an amount in fees_currency when discount_type is fixed_amount (a plain amount, not cents: 20 means 20.00), or a percentage (e.g. 10 for 10%) when it is percentage.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "discount_duration_amount": {
+ "description": "Number of months the discount applies. Required when discount_duration_type is multiple_months.",
+ "type": "number"
+ },
+ "discount_duration_type": {
+ "description": "How long the discount applies. multiple_months also needs discount_duration_amount.",
+ "enum": [
+ "forever",
+ "once",
+ "multiple_months"
+ ],
+ "type": "string"
+ },
+ "discount_type": {
+ "description": "Whether cost is a currency amount or a percentage.",
+ "enum": [
+ "fixed_amount",
+ "percentage"
+ ],
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"discount\". Alternative to type.",
+ "enum": [
+ "discount"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Discount\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Discount"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Cost (fee_type \"cost\"). A per-unit fee: price per unit times quantity, e.g. seats. Set type to \"Fees::Cost\" or fee_type to \"cost\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Price per unit in fees_currency. The row total is quantity x cost. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"cost\". Alternative to type.",
+ "enum": [
+ "cost"
+ ],
+ "type": "string"
+ },
+ "quantity": {
+ "description": "Number of units.",
+ "type": "number"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Cost\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Cost"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Attachment (fee_type \"attachment\"). A fee described in an uploaded attachment instead of in the table. Set type to \"Fees::Attachment\" or fee_type to \"attachment\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "attachment_id": {
+ "description": "ID of an attachment uploaded with upload-attachment.",
+ "type": "string"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"attachment\". Alternative to type.",
+ "enum": [
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Attachment\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Attachment"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Graduated (fee_type \"graduated\"). Tiered pricing, with the price set per tier in graduated_fee_tiers_attributes. Set type to \"Fees::Graduated\" or fee_type to \"graduated\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"graduated\". Alternative to type.",
+ "enum": [
+ "graduated"
+ ],
+ "type": "string"
+ },
+ "graduated_fee_tiers_attributes": {
+ "additionalProperties": {
+ "additionalProperties": false,
+ "properties": {
+ "flat_price": {
+ "type": "number"
+ },
+ "price_per_unit": {
+ "type": "string"
+ },
+ "upper_limit": {
+ "type": "number"
+ }
+ },
+ "type": "object"
+ },
+ "description": "Graduated fee tiers. Use string keys such as \"0\", \"1\".",
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Graduated\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Graduated"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Included (fee_type \"included\"). An item included at no charge. Set type to \"Fees::Included\" or fee_type to \"included\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"included\". Alternative to type.",
+ "enum": [
+ "included"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Included\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Included"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Metered (fee_type \"metered\"). Usage-based pricing, billed per unit used. Set type to \"Fees::Metered\" or fee_type to \"metered\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Price per unit of usage in fees_currency. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"metered\". Alternative to type.",
+ "enum": [
+ "metered"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Metered\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Metered"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::OneTime (fee_type \"one_time\"). A one-time charge, such as a setup fee. Set type to \"Fees::OneTime\" or fee_type to \"one_time\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "One-time amount in fees_currency, charged once rather than per fee_period. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"one_time\". Alternative to type.",
+ "enum": [
+ "one_time"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::OneTime\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::OneTime"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Text (fee_type \"text\"). A fee term described in free text. Set type to \"Fees::Text\" or fee_type to \"text\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"text\". Alternative to type.",
+ "enum": [
+ "text"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Text\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Text"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ }
+ ]
+ },
+ "description": "Fee line items. Use string keys such as \"0\", \"1\". Replaces template fees when provided.",
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_additional_changes": {
+ "type": "boolean"
+ },
+ "include_customer_obligation": {
+ "type": "boolean"
+ },
+ "include_customer_obligation_val": {
+ "type": "string"
+ },
+ "include_deliverables": {
+ "type": "boolean"
+ },
+ "include_deliverables_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_deliverables_description": {
+ "type": "string"
+ },
+ "include_deliverables_include_acceptance": {
+ "type": "boolean"
+ },
+ "include_deliverables_include_attachment": {
+ "type": "boolean"
+ },
+ "include_deliverables_include_draft_deliverables": {
+ "type": "boolean"
+ },
+ "include_deliverables_rejection_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_deliverables_rejection_unit": {
+ "enum": [
+ "hours",
+ "days",
+ "weeks",
+ "months"
+ ],
+ "type": "string"
+ },
+ "include_deliverables_resubmission_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_deliverables_resubmission_unit": {
+ "enum": [
+ "hours",
+ "days",
+ "weeks",
+ "months"
+ ],
+ "type": "string"
+ },
+ "include_fees_other": {
+ "type": "boolean"
+ },
+ "include_fees_other_val": {
+ "type": "string"
+ },
+ "include_fees_table": {
+ "type": "boolean"
+ },
+ "include_fees_table_total": {
+ "type": "boolean"
+ },
+ "include_fees_travel": {
+ "type": "boolean"
+ },
+ "include_fees_travel_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_fees_travel_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_fees_travel_val": {
+ "type": "string"
+ },
+ "include_third_party_customer": {
+ "type": "boolean"
+ },
+ "include_third_party_include_description": {
+ "type": "boolean"
+ },
+ "include_third_party_include_description_val": {
+ "type": "string"
+ },
+ "include_third_party_materials": {
+ "type": "boolean"
+ },
+ "include_third_party_provider": {
+ "type": "boolean"
+ },
+ "include_time_of_assignment": {
+ "type": "boolean"
+ },
+ "include_time_of_assignment_type": {
+ "enum": [
+ "created",
+ "paid"
+ ],
+ "type": "string"
+ },
+ "invoice_period_description": {
+ "type": "string"
+ },
+ "negotiations_allowed": {
+ "description": "When true, the recipient can propose changes to the statement of work, even when the agreement-level `negotiations_allowed` is false. This only covers the statement of work.",
+ "type": "boolean"
+ },
+ "payment_period": {
+ "type": "number"
+ },
+ "payment_period_other": {
+ "type": "string"
+ },
+ "payment_period_timeframe": {
+ "enum": [
+ "receipt",
+ "invoice",
+ "Customer's receipt of invoice",
+ "date of invoice"
+ ],
+ "type": "string"
+ },
+ "payment_period_type": {
+ "enum": [
+ "standard",
+ "other"
+ ],
+ "type": "string"
+ },
+ "payment_period_unit": {
+ "enum": [
+ "day(s)",
+ "week(s)",
+ "month(s)",
+ "quarter(s)",
+ "year(s)"
+ ],
+ "type": "string"
+ },
+ "quantity": {
+ "type": "number"
+ },
+ "services_description": {
+ "type": "string"
+ },
+ "sow_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "sow_date_type": {
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "type": "string"
+ },
+ "sow_term_amount": {
+ "type": "number"
+ },
+ "sow_term_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "sow_term_type": {
+ "enum": [
+ "deliverables",
+ "period",
+ "date"
+ ],
+ "type": "string"
+ },
+ "sow_term_unit": {
+ "enum": [
+ "month(s)",
+ "quarter(s)",
+ "year(s)"
+ ],
+ "type": "string"
+ },
+ "type": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "recipient_email": {
+ "format": "email",
+ "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "recipient_name": {
+ "type": "string"
+ },
+ "recipient_notice_email_address": {
+ "description": "Email address for legal notices to the recipient.",
+ "format": "email",
+ "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "recipient_organization": {
+ "type": "string"
+ },
+ "sender_last_to_sign": {
+ "description": "When true, your signer signs after the recipient.",
+ "type": "boolean"
+ },
+ "sender_notice_email_address": {
+ "description": "Email address for legal notices to the sender.",
+ "format": "email",
+ "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "software_license_attributes": {
+ "additionalProperties": false,
+ "description": "Override software license terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "effective_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "effective_date_type": {
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "type": "string"
+ },
+ "general_cap_amount": {
+ "type": "number"
+ },
+ "general_cap_amount_type": {
+ "enum": [
+ "preceding",
+ "base",
+ "period"
+ ],
+ "type": "string"
+ },
+ "general_cap_period_currency": {
+ "type": "number"
+ },
+ "general_cap_period_qty": {
+ "type": "number"
+ },
+ "general_cap_preceding_amount": {
+ "type": "number"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_additional_warranties": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_by_customer": {
+ "type": "string"
+ },
+ "include_additional_warranties_by_provider": {
+ "type": "string"
+ },
+ "include_additional_warranties_include_by_customer": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_include_by_provider": {
+ "type": "boolean"
+ },
+ "include_ai_addendum": {
+ "type": "boolean"
+ },
+ "include_ai_addendum_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_covered_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_customer_claims": {
+ "type": "string"
+ },
+ "include_covered_claims_include_customer_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_include_provider_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_provider_claims": {
+ "type": "string"
+ },
+ "include_dpa": {
+ "type": "boolean"
+ },
+ "include_dpa_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_dpa_location": {
+ "type": "string"
+ },
+ "include_dpa_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_increased_cap_amount": {
+ "type": "boolean"
+ },
+ "include_increased_claims": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_confidentiality": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_confidentiality_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_other": {
+ "type": "boolean"
+ },
+ "include_increased_claims_indemnification_obligation": {
+ "type": "boolean"
+ },
+ "include_increased_claims_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_other": {
+ "type": "string"
+ },
+ "include_increased_claims_restrictions": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_confidentiality": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_confidentiality_negligence": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_include_other": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_indemnification_obligation": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_license_or_restrictions": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_negligence": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_other": {
+ "type": "string"
+ },
+ "increased_cap_amount_currency": {
+ "type": "number"
+ },
+ "increased_cap_amount_period_currency": {
+ "type": "number"
+ },
+ "increased_cap_amount_period_qty": {
+ "type": "number"
+ },
+ "increased_cap_amount_qty": {
+ "type": "number"
+ },
+ "increased_cap_amount_type": {
+ "enum": [
+ "qty",
+ "currency",
+ "period"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "software_license_order_form_attributes": {
+ "additionalProperties": false,
+ "description": "Override software license order form terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "additional_changes": {
+ "type": "string"
+ },
+ "deletion_procedure_include_custom": {
+ "type": "boolean"
+ },
+ "deletion_procedure_include_custom_description": {
+ "type": "string"
+ },
+ "deletion_procedure_include_customer_disable": {
+ "type": "boolean"
+ },
+ "deletion_procedure_include_customer_proof": {
+ "type": "boolean"
+ },
+ "deletion_procedure_include_provider_disable": {
+ "type": "boolean"
+ },
+ "fee_custom_unit": {
+ "type": "string"
+ },
+ "fee_period": {
+ "enum": [
+ "Subscription Period",
+ "month",
+ "year",
+ "Custom unit"
+ ],
+ "type": "string"
+ },
+ "fees_attributes": {
+ "additionalProperties": {
+ "anyOf": [
+ {
+ "additionalProperties": false,
+ "description": "Fees::Flat (fee_type \"flat\"). A fixed recurring fee, e.g. a platform subscription. Set type to \"Fees::Flat\" or fee_type to \"flat\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Fixed amount in the order form's fees_currency, charged per fee_period. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"flat\". Alternative to type.",
+ "enum": [
+ "flat"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Flat\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Flat"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Discount (fee_type \"discount\"). A discount, as a fixed amount or a percentage, applied forever, once, or for a number of months. Set type to \"Fees::Discount\" or fee_type to \"discount\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Discount size: an amount in fees_currency when discount_type is fixed_amount (a plain amount, not cents: 20 means 20.00), or a percentage (e.g. 10 for 10%) when it is percentage.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "discount_duration_amount": {
+ "description": "Number of months the discount applies. Required when discount_duration_type is multiple_months.",
+ "type": "number"
+ },
+ "discount_duration_type": {
+ "description": "How long the discount applies. multiple_months also needs discount_duration_amount.",
+ "enum": [
+ "forever",
+ "once",
+ "multiple_months"
+ ],
+ "type": "string"
+ },
+ "discount_type": {
+ "description": "Whether cost is a currency amount or a percentage.",
+ "enum": [
+ "fixed_amount",
+ "percentage"
+ ],
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"discount\". Alternative to type.",
+ "enum": [
+ "discount"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Discount\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Discount"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Cost (fee_type \"cost\"). A per-unit fee: price per unit times quantity, e.g. seats. Set type to \"Fees::Cost\" or fee_type to \"cost\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Price per unit in fees_currency. The row total is quantity x cost. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"cost\". Alternative to type.",
+ "enum": [
+ "cost"
+ ],
+ "type": "string"
+ },
+ "quantity": {
+ "description": "Number of units.",
+ "type": "number"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Cost\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Cost"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Attachment (fee_type \"attachment\"). A fee described in an uploaded attachment instead of in the table. Set type to \"Fees::Attachment\" or fee_type to \"attachment\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "attachment_id": {
+ "description": "ID of an attachment uploaded with upload-attachment.",
+ "type": "string"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"attachment\". Alternative to type.",
+ "enum": [
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Attachment\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Attachment"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Graduated (fee_type \"graduated\"). Tiered pricing, with the price set per tier in graduated_fee_tiers_attributes. Set type to \"Fees::Graduated\" or fee_type to \"graduated\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"graduated\". Alternative to type.",
+ "enum": [
+ "graduated"
+ ],
+ "type": "string"
+ },
+ "graduated_fee_tiers_attributes": {
+ "additionalProperties": {
+ "additionalProperties": false,
+ "properties": {
+ "flat_price": {
+ "type": "number"
+ },
+ "price_per_unit": {
+ "type": "string"
+ },
+ "upper_limit": {
+ "type": "number"
+ }
+ },
+ "type": "object"
+ },
+ "description": "Graduated fee tiers. Use string keys such as \"0\", \"1\".",
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Graduated\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Graduated"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Included (fee_type \"included\"). An item included at no charge. Set type to \"Fees::Included\" or fee_type to \"included\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"included\". Alternative to type.",
+ "enum": [
+ "included"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Included\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Included"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Metered (fee_type \"metered\"). Usage-based pricing, billed per unit used. Set type to \"Fees::Metered\" or fee_type to \"metered\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Price per unit of usage in fees_currency. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"metered\". Alternative to type.",
+ "enum": [
+ "metered"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Metered\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Metered"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::OneTime (fee_type \"one_time\"). A one-time charge, such as a setup fee. Set type to \"Fees::OneTime\" or fee_type to \"one_time\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "One-time amount in fees_currency, charged once rather than per fee_period. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"one_time\". Alternative to type.",
+ "enum": [
+ "one_time"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::OneTime\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::OneTime"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Text (fee_type \"text\"). A fee term described in free text. Set type to \"Fees::Text\" or fee_type to \"text\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"text\". Alternative to type.",
+ "enum": [
+ "text"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Text\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Text"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ }
+ ]
+ },
+ "description": "Fee line items. Use string keys such as \"0\", \"1\". Replaces template fees when provided.",
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+ },
+ "fees_currency": {
+ "enum": [
+ "USD",
+ "EUR",
+ "GBP",
+ "CAD",
+ "AUD",
+ "SGD",
+ "ILS",
+ "JPY",
+ "CHF",
+ "HKD"
+ ],
+ "type": "string"
+ },
+ "fees_include_fee_increase_upon_renewal": {
+ "type": "boolean"
+ },
+ "fees_include_fee_increase_upon_renewal_fee": {
+ "type": "number"
+ },
+ "fees_include_fee_increase_upon_renewal_type": {
+ "enum": [
+ "will",
+ "may"
+ ],
+ "type": "string"
+ },
+ "fees_inclusive_of_taxes": {
+ "type": "boolean"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_additional_changes": {
+ "type": "boolean"
+ },
+ "include_license_compliance_verification": {
+ "type": "boolean"
+ },
+ "include_license_compliance_verification_description": {
+ "type": "string"
+ },
+ "include_license_limits": {
+ "type": "boolean"
+ },
+ "include_license_limits_description": {
+ "type": "string"
+ },
+ "include_payment_process_include_billing_email": {
+ "type": "boolean"
+ },
+ "include_pilot_period": {
+ "type": "boolean"
+ },
+ "include_pilot_period_duration_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_pilot_period_duration_type": {
+ "enum": [
+ "day",
+ "week",
+ "month"
+ ],
+ "type": "string"
+ },
+ "include_pilot_period_include_fees": {
+ "type": "boolean"
+ },
+ "include_pilot_period_include_fees_amount": {
+ "type": "number"
+ },
+ "include_pilot_period_include_modifications": {
+ "type": "boolean"
+ },
+ "include_pilot_period_include_modifications_description": {
+ "type": "string"
+ },
+ "include_services": {
+ "type": "boolean"
+ },
+ "include_services_description": {
+ "type": "string"
+ },
+ "negotiations_allowed": {
+ "description": "When true, the recipient can propose changes to the order form, even when the agreement-level `negotiations_allowed` is false. This only covers the order form.",
+ "type": "boolean"
+ },
+ "order_date_date": {
+ "type": "string"
+ },
+ "order_date_type": {
+ "enum": [
+ "signature",
+ "date",
+ "other"
+ ],
+ "type": "string"
+ },
+ "payment_process_automatic_frequency": {
+ "enum": [
+ "monthly",
+ "quarterly",
+ "semiannually",
+ "annually"
+ ],
+ "type": "string"
+ },
+ "payment_process_type": {
+ "enum": [
+ "automatic",
+ "invoice",
+ "custom"
+ ],
+ "type": "string"
+ },
+ "payment_process_type_custom_val": {
+ "type": "string"
+ },
+ "payment_process_type_invoice_amount": {
+ "type": "number"
+ },
+ "payment_process_type_invoice_custom_unit": {
+ "type": "string"
+ },
+ "payment_process_type_invoice_duration": {
+ "enum": [
+ "day",
+ "week",
+ "month",
+ "year",
+ "day(s)",
+ "week(s)",
+ "month(s)",
+ "year(s)"
+ ],
+ "type": "string"
+ },
+ "payment_process_type_invoice_duration_start": {
+ "enum": [
+ "Customer's receipt of invoice",
+ "date of invoice"
+ ],
+ "type": "string"
+ },
+ "payment_process_type_invoice_type": {
+ "enum": [
+ "monthly",
+ "quarterly",
+ "semiannually",
+ "annually",
+ "Custom unit"
+ ],
+ "type": "string"
+ },
+ "permitted_uses_include_custom": {
+ "type": "boolean"
+ },
+ "permitted_uses_include_custom_description": {
+ "type": "string"
+ },
+ "permitted_uses_include_customers_affiliates": {
+ "type": "boolean"
+ },
+ "permitted_uses_include_internal_business": {
+ "type": "boolean"
+ },
+ "pilot_period_stripe_product_id": {
+ "type": "string"
+ },
+ "software_description": {
+ "type": "string"
+ },
+ "subscription_auto_renew": {
+ "enum": [
+ "days",
+ "subscription_end"
+ ],
+ "type": "string"
+ },
+ "subscription_period": {
+ "type": "number"
+ },
+ "subscription_period_unit": {
+ "type": "string"
+ },
+ "subscription_renewal_notice_days": {
+ "type": "number"
+ },
+ "warranty_period_description_amount": {
+ "type": "number"
+ },
+ "warranty_period_description_duration": {
+ "enum": [
+ "day",
+ "week",
+ "month",
+ "year"
+ ],
+ "type": "string"
+ },
+ "warranty_period_description_duration_start": {
+ "enum": [
+ "initial delivery of the Software",
+ "delivery of the Software and each subsequent Update",
+ "the Order Date"
+ ],
+ "type": "string"
+ },
+ "warranty_period_type": {
+ "enum": [
+ "description",
+ "none"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "test_agreement": {
+ "description": "When true, marks the agreement as a test. Test agreements do not count against your monthly limit.",
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "recipient_name",
+ "recipient_email"
+ ],
+ "type": "object"
+ },
+ "cc_users": {
+ "items": {
+ "format": "email",
+ "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "draft": {
+ "description": "When true, the agreement is saved as a draft and not sent to the recipient. Use POST /v1/agreements/{id}/send to send a draft agreement later.",
+ "type": "boolean"
+ },
+ "owner_email": {
+ "description": "Email address of the agreement owner (sender).",
+ "type": "string"
+ },
+ "signer_id": {
+ "description": "User id of the signer from the owner's organization.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "template_id": {
+ "description": "UUID of a template from `GET /v1/templates`. Accepts both Common Paper standard templates and uploaded PDF templates (`type` `uploaded_template`).",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ }
+ },
+ "required": [
+ "template_id",
+ "owner_email",
+ "signer_id",
+ "agreement"
+ ],
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "agreement": {
+ "additionalProperties": {},
+ "properties": {
+ "amendment_attributes": {
+ "additionalProperties": false,
+ "description": "Override amendment terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "amended_terms_attributes": {
+ "additionalProperties": {
+ "additionalProperties": false,
+ "properties": {
+ "description": {
+ "type": "string"
+ },
+ "term": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "description": "Amended terms. Use string keys such as \"0\", \"1\".",
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+ },
+ "amendment_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "amendment_date_type": {
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "type": "string"
+ },
+ "framework_terms_type": {
+ "type": "string"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "parent_agreement_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "underlying_agreement_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "underlying_agreement_type": {
+ "type": "string"
+ },
+ "underlying_agreement_val": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "baa_attributes": {
+ "additionalProperties": false,
+ "description": "Override baa terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "aggregation_limitations_permitted": {
+ "type": "boolean"
+ },
+ "aggregation_limitations_permitted_val": {
+ "type": "string"
+ },
+ "breach_notification_unit": {
+ "enum": [
+ "hours",
+ "business days",
+ "calendar days"
+ ],
+ "type": "string"
+ },
+ "breach_notification_val": {
+ "type": "number"
+ },
+ "business_associate_relationship_type": {
+ "enum": [
+ "provider",
+ "company"
+ ],
+ "type": "string"
+ },
+ "deidentification_limitations_include_purpose": {
+ "type": "boolean"
+ },
+ "deidentification_limitations_include_requirements": {
+ "type": "boolean"
+ },
+ "deidentification_limitations_permitted": {
+ "type": "boolean"
+ },
+ "deidentification_limitations_purpose_val": {
+ "type": "string"
+ },
+ "deidentification_limitations_requirements_val": {
+ "type": "string"
+ },
+ "designated_record_set_provider_maintains": {
+ "type": "boolean"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_aggregation_limitations": {
+ "type": "boolean"
+ },
+ "include_deidentification_limitations": {
+ "type": "boolean"
+ },
+ "include_limitations": {
+ "type": "boolean"
+ },
+ "include_offshore_limitations": {
+ "type": "boolean"
+ },
+ "include_subcontract_limitations": {
+ "type": "boolean"
+ },
+ "offshore_limitations_permitted": {
+ "type": "boolean"
+ },
+ "offshore_limitations_permitted_val": {
+ "type": "string"
+ },
+ "subcontract_limitations_include_notice": {
+ "type": "boolean"
+ },
+ "subcontract_limitations_include_permission": {
+ "type": "boolean"
+ },
+ "subcontract_limitations_notice_val": {
+ "type": "string"
+ },
+ "subcontract_limitations_permission_val": {
+ "type": "string"
+ },
+ "subcontract_limitations_permitted": {
+ "type": "boolean"
+ },
+ "underlying_agreement_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "underlying_agreement_type": {
+ "enum": [
+ "internal",
+ "external",
+ "none"
+ ],
+ "type": "string"
+ },
+ "underlying_agreement_val": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "billing_email": {
+ "description": "Email of the billing contact. Used when include_billing_info is true.",
+ "format": "email",
+ "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "billing_name": {
+ "description": "Name of the billing contact. Used when include_billing_info is true.",
+ "type": "string"
+ },
+ "billing_workflow_type": {
+ "description": "The type of billing workflow. Use \"link\" to provide a payment_link_url, or \"stripe\" for Stripe-managed billing.",
+ "enum": [
+ "link",
+ "stripe"
+ ],
+ "type": "string"
+ },
+ "chosen_courts_country": {
+ "description": "The country in which disputes will be resolved.",
+ "type": "string"
+ },
+ "chosen_courts_region": {
+ "description": "The state or region in which disputes will be resolved.",
+ "type": "string"
+ },
+ "csa_attributes": {
+ "additionalProperties": false,
+ "description": "Override csa terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "customer_description": {
+ "type": "string"
+ },
+ "effective_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "effective_date_marketplace": {
+ "enum": [
+ "AWS",
+ "GCP",
+ "Azure"
+ ],
+ "type": "string"
+ },
+ "effective_date_type": {
+ "enum": [
+ "signature",
+ "date",
+ "marketplace_acceptance"
+ ],
+ "type": "string"
+ },
+ "general_cap_amount": {
+ "type": "number"
+ },
+ "general_cap_amount_type": {
+ "enum": [
+ "preceding",
+ "base",
+ "period"
+ ],
+ "type": "string"
+ },
+ "general_cap_period_currency": {
+ "type": "number"
+ },
+ "general_cap_period_qty": {
+ "type": "number"
+ },
+ "general_cap_preceding_amount": {
+ "type": "number"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_acceptable_use_policy": {
+ "type": "boolean"
+ },
+ "include_acceptable_use_policy_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_acceptable_use_policy_location": {
+ "type": "string"
+ },
+ "include_acceptable_use_policy_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_additional_warranties": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_by_customer": {
+ "type": "string"
+ },
+ "include_additional_warranties_by_provider": {
+ "type": "string"
+ },
+ "include_additional_warranties_include_by_customer": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_include_by_provider": {
+ "type": "boolean"
+ },
+ "include_ai_addendum": {
+ "type": "boolean"
+ },
+ "include_ai_addendum_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_covered_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_customer_claims": {
+ "type": "string"
+ },
+ "include_covered_claims_include_customer_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_include_provider_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_provider_claims": {
+ "type": "string"
+ },
+ "include_dpa": {
+ "type": "boolean"
+ },
+ "include_dpa_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_dpa_location": {
+ "type": "string"
+ },
+ "include_dpa_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_increased_cap_amount": {
+ "type": "boolean"
+ },
+ "include_increased_claims": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_confidentiality": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_confidentiality_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_privsec": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_privsec_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_other": {
+ "type": "boolean"
+ },
+ "include_increased_claims_indemnification_obligation": {
+ "type": "boolean"
+ },
+ "include_increased_claims_other": {
+ "type": "string"
+ },
+ "include_insurance_minimums": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_add_customer": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_add_customer_com_gen_liability": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_add_customer_cyber_liability": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_add_customer_errors_omissions": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_additional_information": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_additional_information_text": {
+ "type": "string"
+ },
+ "include_insurance_minimums_cyber_liability_aggregate": {
+ "type": "number"
+ },
+ "include_insurance_minimums_cyber_liability_minimum": {
+ "type": "number"
+ },
+ "include_insurance_minimums_employer_liability_aggregate": {
+ "type": "number"
+ },
+ "include_insurance_minimums_employer_liability_minimum": {
+ "type": "number"
+ },
+ "include_insurance_minimums_general_liability_aggregate": {
+ "type": "number"
+ },
+ "include_insurance_minimums_general_liability_minimum": {
+ "type": "number"
+ },
+ "include_insurance_minimums_include_cyber_liability": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_include_employer_liability": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_include_general_liability": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_include_workers_compensation": {
+ "type": "boolean"
+ },
+ "include_publicity_rights": {
+ "type": "boolean"
+ },
+ "include_publicity_rights_type": {
+ "enum": [
+ "public",
+ "non-public"
+ ],
+ "type": "string"
+ },
+ "include_security_policy": {
+ "type": "boolean"
+ },
+ "include_security_policy_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_security_policy_fedramp_auth": {
+ "type": "boolean"
+ },
+ "include_security_policy_hipaa": {
+ "type": "boolean"
+ },
+ "include_security_policy_hitrust": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_annual_maintenance": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_location": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_other": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_reasonable_efforts": {
+ "type": "boolean"
+ },
+ "include_security_policy_iso27001": {
+ "type": "boolean"
+ },
+ "include_security_policy_location": {
+ "type": "string"
+ },
+ "include_security_policy_other": {
+ "type": "string"
+ },
+ "include_security_policy_pci1": {
+ "type": "boolean"
+ },
+ "include_security_policy_pci2": {
+ "type": "boolean"
+ },
+ "include_security_policy_penetration_testing": {
+ "type": "boolean"
+ },
+ "include_security_policy_soc2": {
+ "type": "boolean"
+ },
+ "include_security_policy_soc2_type2": {
+ "type": "boolean"
+ },
+ "include_security_policy_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_supercap": {
+ "description": "CSA 3.0 renamed `include_increased_cap_amount` to `include_supercap`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_increased_cap_amount`. Sending the other spelling returns a 422.",
+ "type": "boolean"
+ },
+ "include_uncapped_claims": {
+ "description": "CSA 3.0 renamed `include_unlimited_claims` to `include_uncapped_claims`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims`. Sending the other spelling returns a 422.",
+ "type": "boolean"
+ },
+ "include_uncapped_claims_breach_of_confidentiality": {
+ "description": "CSA 3.0 renamed `include_unlimited_claims_breach_of_confidentiality` to `include_uncapped_claims_breach_of_confidentiality`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_breach_of_confidentiality`. Sending the other spelling returns a 422.",
+ "type": "boolean"
+ },
+ "include_uncapped_claims_breach_of_confidentiality_negligence": {
+ "description": "CSA 3.0 renamed `include_unlimited_claims_breach_of_confidentiality_negligence` to `include_uncapped_claims_breach_of_confidentiality_negligence`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_breach_of_confidentiality_negligence`. Sending the other spelling returns a 422.",
+ "type": "boolean"
+ },
+ "include_uncapped_claims_breach_of_privsec": {
+ "description": "CSA 3.0 renamed `include_unlimited_claims_breach_of_privsec` to `include_uncapped_claims_breach_of_privsec`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_breach_of_privsec`. Sending the other spelling returns a 422.",
+ "type": "boolean"
+ },
+ "include_uncapped_claims_breach_of_privsec_negligence": {
+ "description": "CSA 3.0 renamed `include_unlimited_claims_breach_of_privsec_negligence` to `include_uncapped_claims_breach_of_privsec_negligence`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_breach_of_privsec_negligence`. Sending the other spelling returns a 422.",
+ "type": "boolean"
+ },
+ "include_uncapped_claims_include_other": {
+ "description": "CSA 3.0 renamed `include_unlimited_claims_include_other` to `include_uncapped_claims_include_other`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_include_other`. Sending the other spelling returns a 422.",
+ "type": "boolean"
+ },
+ "include_uncapped_claims_indemnification_obligation": {
+ "description": "CSA 3.0 renamed `include_unlimited_claims_indemnification_obligation` to `include_uncapped_claims_indemnification_obligation`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_indemnification_obligation`. Sending the other spelling returns a 422.",
+ "type": "boolean"
+ },
+ "include_uncapped_claims_other": {
+ "description": "CSA 3.0 renamed `include_unlimited_claims_other` to `include_uncapped_claims_other`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_other`. Sending the other spelling returns a 422.",
+ "type": "boolean"
+ },
+ "include_unlimited_claims": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_confidentiality": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_confidentiality_negligence": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_privsec": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_privsec_negligence": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_include_other": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_indemnification_obligation": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_other": {
+ "type": "string"
+ },
+ "increased_cap_amount_currency": {
+ "type": "number"
+ },
+ "increased_cap_amount_period_currency": {
+ "type": "number"
+ },
+ "increased_cap_amount_period_qty": {
+ "type": "number"
+ },
+ "increased_cap_amount_qty": {
+ "type": "number"
+ },
+ "increased_cap_amount_type": {
+ "enum": [
+ "qty",
+ "currency",
+ "period"
+ ],
+ "type": "string"
+ },
+ "provider": {
+ "type": "string"
+ },
+ "supercap_currency": {
+ "description": "CSA 3.0 renamed `increased_cap_amount_currency` to `supercap_currency`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `increased_cap_amount_currency`. Sending the other spelling returns a 422.",
+ "type": "number"
+ },
+ "supercap_period_currency": {
+ "description": "CSA 3.0 renamed `increased_cap_amount_period_currency` to `supercap_period_currency`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `increased_cap_amount_period_currency`. Sending the other spelling returns a 422.",
+ "type": "number"
+ },
+ "supercap_period_qty": {
+ "description": "CSA 3.0 renamed `increased_cap_amount_period_qty` to `supercap_period_qty`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `increased_cap_amount_period_qty`. Sending the other spelling returns a 422.",
+ "type": "number"
+ },
+ "supercap_qty": {
+ "description": "CSA 3.0 renamed `increased_cap_amount_qty` to `supercap_qty`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `increased_cap_amount_qty`. Sending the other spelling returns a 422.",
+ "type": "number"
+ },
+ "supercap_type": {
+ "description": "CSA 3.0 renamed `increased_cap_amount_type` to `supercap_type`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `increased_cap_amount_type`. Sending the other spelling returns a 422.",
+ "type": "number"
+ }
+ },
+ "type": "object"
+ },
+ "csa_order_form_attributes": {
+ "additionalProperties": false,
+ "description": "Override csa order form terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "additional_changes": {
+ "type": "string"
+ },
+ "additional_parameters_or_limitations": {
+ "type": "string"
+ },
+ "affiliates_as_users": {
+ "type": "boolean"
+ },
+ "cloud_service_description": {
+ "type": "string"
+ },
+ "consumption_units": {
+ "type": "string"
+ },
+ "fee_amount": {
+ "type": "number"
+ },
+ "fee_custom_unit": {
+ "type": "string"
+ },
+ "fee_period": {
+ "enum": [
+ "Subscription Period",
+ "month",
+ "year",
+ "User",
+ "Custom unit"
+ ],
+ "type": "string"
+ },
+ "fees_attributes": {
+ "additionalProperties": {
+ "anyOf": [
+ {
+ "additionalProperties": false,
+ "description": "Fees::Flat (fee_type \"flat\"). A fixed recurring fee, e.g. a platform subscription. Set type to \"Fees::Flat\" or fee_type to \"flat\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Fixed amount in the order form's fees_currency, charged per fee_period. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"flat\". Alternative to type.",
+ "enum": [
+ "flat"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Flat\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Flat"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Discount (fee_type \"discount\"). A discount, as a fixed amount or a percentage, applied forever, once, or for a number of months. Set type to \"Fees::Discount\" or fee_type to \"discount\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Discount size: an amount in fees_currency when discount_type is fixed_amount (a plain amount, not cents: 20 means 20.00), or a percentage (e.g. 10 for 10%) when it is percentage.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "discount_duration_amount": {
+ "description": "Number of months the discount applies. Required when discount_duration_type is multiple_months.",
+ "type": "number"
+ },
+ "discount_duration_type": {
+ "description": "How long the discount applies. multiple_months also needs discount_duration_amount.",
+ "enum": [
+ "forever",
+ "once",
+ "multiple_months"
+ ],
+ "type": "string"
+ },
+ "discount_type": {
+ "description": "Whether cost is a currency amount or a percentage.",
+ "enum": [
+ "fixed_amount",
+ "percentage"
+ ],
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"discount\". Alternative to type.",
+ "enum": [
+ "discount"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Discount\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Discount"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Cost (fee_type \"cost\"). A per-unit fee: price per unit times quantity, e.g. seats. Set type to \"Fees::Cost\" or fee_type to \"cost\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Price per unit in fees_currency. The row total is quantity x cost. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"cost\". Alternative to type.",
+ "enum": [
+ "cost"
+ ],
+ "type": "string"
+ },
+ "quantity": {
+ "description": "Number of units.",
+ "type": "number"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Cost\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Cost"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Attachment (fee_type \"attachment\"). A fee described in an uploaded attachment instead of in the table. Set type to \"Fees::Attachment\" or fee_type to \"attachment\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "attachment_id": {
+ "description": "ID of an attachment uploaded with upload-attachment.",
+ "type": "string"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"attachment\". Alternative to type.",
+ "enum": [
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Attachment\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Attachment"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Graduated (fee_type \"graduated\"). Tiered pricing, with the price set per tier in graduated_fee_tiers_attributes. Set type to \"Fees::Graduated\" or fee_type to \"graduated\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"graduated\". Alternative to type.",
+ "enum": [
+ "graduated"
+ ],
+ "type": "string"
+ },
+ "graduated_fee_tiers_attributes": {
+ "additionalProperties": {
+ "additionalProperties": false,
+ "properties": {
+ "flat_price": {
+ "type": "number"
+ },
+ "price_per_unit": {
+ "type": "string"
+ },
+ "upper_limit": {
+ "type": "number"
+ }
+ },
+ "type": "object"
+ },
+ "description": "Graduated fee tiers. Use string keys such as \"0\", \"1\".",
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Graduated\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Graduated"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Included (fee_type \"included\"). An item included at no charge. Set type to \"Fees::Included\" or fee_type to \"included\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"included\". Alternative to type.",
+ "enum": [
+ "included"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Included\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Included"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Metered (fee_type \"metered\"). Usage-based pricing, billed per unit used. Set type to \"Fees::Metered\" or fee_type to \"metered\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Price per unit of usage in fees_currency. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"metered\". Alternative to type.",
+ "enum": [
+ "metered"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Metered\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Metered"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::OneTime (fee_type \"one_time\"). A one-time charge, such as a setup fee. Set type to \"Fees::OneTime\" or fee_type to \"one_time\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "One-time amount in fees_currency, charged once rather than per fee_period. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"one_time\". Alternative to type.",
+ "enum": [
+ "one_time"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::OneTime\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::OneTime"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Text (fee_type \"text\"). A fee term described in free text. Set type to \"Fees::Text\" or fee_type to \"text\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"text\". Alternative to type.",
+ "enum": [
+ "text"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Text\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Text"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ }
+ ]
+ },
+ "description": "Fee table rows, keyed by string index (\"0\", \"1\", ...). Replaces the template's fees when provided. Each row sets type or fee_type to pick the fee class. Amounts are in the order form's fees_currency and, for recurring fees, are charged per fee_period.",
+ "examples": [
+ {
+ "0": {
+ "cost": 2000,
+ "description": "Platform subscription",
+ "type": "Fees::Flat"
+ }
+ },
+ {
+ "0": {
+ "cost": 50,
+ "description": "Seats",
+ "fee_type": "cost",
+ "quantity": 10
+ },
+ "1": {
+ "cost": 10,
+ "description": "Launch discount",
+ "discount_duration_amount": 3,
+ "discount_duration_type": "multiple_months",
+ "discount_type": "percentage",
+ "fee_type": "discount"
+ }
+ }
+ ],
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+ },
+ "fees_currency": {
+ "enum": [
+ "USD",
+ "EUR",
+ "GBP",
+ "CAD",
+ "AUD",
+ "SGD",
+ "ILS",
+ "JPY",
+ "CHF",
+ "HKD"
+ ],
+ "type": "string"
+ },
+ "fees_include_fee_increase_upon_renewal": {
+ "type": "boolean"
+ },
+ "fees_include_fee_increase_upon_renewal_fee": {
+ "type": "number"
+ },
+ "fees_include_fee_increase_upon_renewal_type": {
+ "enum": [
+ "will",
+ "may"
+ ],
+ "type": "string"
+ },
+ "fees_inclusive_of_taxes": {
+ "type": "boolean"
+ },
+ "framework_terms_type": {
+ "enum": [
+ "new",
+ "existing",
+ "description"
+ ],
+ "type": "string"
+ },
+ "free_trial_days": {
+ "type": "number"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_additional_changes": {
+ "type": "boolean"
+ },
+ "include_additional_parameters_or_limitations": {
+ "type": "boolean"
+ },
+ "include_consumption": {
+ "type": "boolean"
+ },
+ "include_fees": {
+ "type": "boolean"
+ },
+ "include_fees_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_fees_include_attachment": {
+ "type": "boolean"
+ },
+ "include_fees_other": {
+ "type": "boolean"
+ },
+ "include_fees_other_val": {
+ "type": "string"
+ },
+ "include_fees_table": {
+ "type": "boolean"
+ },
+ "include_fees_table_period": {
+ "enum": [
+ "Subscription Period",
+ "month",
+ "year",
+ "User"
+ ],
+ "type": "string"
+ },
+ "include_free_trial": {
+ "type": "boolean"
+ },
+ "include_max_users": {
+ "type": "boolean"
+ },
+ "include_pilot_period": {
+ "type": "boolean"
+ },
+ "include_pilot_period_duration_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_pilot_period_duration_type": {
+ "enum": [
+ "day",
+ "week",
+ "month"
+ ],
+ "type": "string"
+ },
+ "include_pilot_period_include_fees": {
+ "type": "boolean"
+ },
+ "include_pilot_period_include_fees_amount": {
+ "type": "number"
+ },
+ "include_pilot_period_include_modifications": {
+ "type": "boolean"
+ },
+ "include_pilot_period_include_modifications_description": {
+ "type": "string"
+ },
+ "include_product_support": {
+ "type": "boolean"
+ },
+ "include_product_support_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_product_support_description": {
+ "type": "string"
+ },
+ "include_product_support_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_professional_services": {
+ "type": "boolean"
+ },
+ "include_professional_services_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_professional_services_custom_name": {
+ "type": "string"
+ },
+ "include_professional_services_description": {
+ "type": "string"
+ },
+ "include_professional_services_end_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "include_professional_services_fees_description": {
+ "type": "string"
+ },
+ "include_professional_services_include_end_date": {
+ "type": "boolean"
+ },
+ "include_professional_services_include_fees_description": {
+ "type": "boolean"
+ },
+ "include_professional_services_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_sla": {
+ "type": "boolean"
+ },
+ "include_sla_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_sla_description": {
+ "type": "string"
+ },
+ "include_sla_include_response_time": {
+ "type": "boolean"
+ },
+ "include_sla_include_response_time_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_sla_include_response_time_credit": {
+ "type": "number"
+ },
+ "include_sla_include_response_time_duration": {
+ "enum": [
+ "hour",
+ "day",
+ "week",
+ "month",
+ "hours"
+ ],
+ "type": "string"
+ },
+ "include_sla_include_response_time_support_channel": {
+ "type": "string"
+ },
+ "include_sla_include_target_uptime": {
+ "type": "boolean"
+ },
+ "include_sla_maintenance_notice": {
+ "type": "boolean"
+ },
+ "include_sla_maintenance_window": {
+ "type": "boolean"
+ },
+ "include_sla_maintenance_window_type": {
+ "enum": [
+ "standard",
+ "none"
+ ],
+ "type": "string"
+ },
+ "include_sla_standard_maintenance_notice_qty": {
+ "type": "number"
+ },
+ "include_sla_standard_maintenance_notice_unit": {
+ "enum": [
+ "hour",
+ "day",
+ "week",
+ "month"
+ ],
+ "type": "string"
+ },
+ "include_sla_standard_maintenance_window_end_time": {
+ "type": "string"
+ },
+ "include_sla_standard_maintenance_window_friday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_monday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_saturday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_start_time": {
+ "type": "string"
+ },
+ "include_sla_standard_maintenance_window_sunday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_thursday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_time_zone": {
+ "type": "string"
+ },
+ "include_sla_standard_maintenance_window_tuesday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_wednesday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_target_uptime": {
+ "type": "number"
+ },
+ "include_sla_type": {
+ "enum": [
+ "description",
+ "standard",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_subscription_start_date": {
+ "type": "boolean"
+ },
+ "include_subscription_start_date_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "include_usage_review": {
+ "type": "boolean"
+ },
+ "include_usage_review_val": {
+ "type": "string"
+ },
+ "include_use_limitations": {
+ "type": "boolean"
+ },
+ "include_use_limitations_val": {
+ "type": "string"
+ },
+ "invoice_period": {
+ "enum": [
+ "monthly",
+ "quarterly",
+ "semiannually",
+ "annually",
+ "Custom unit",
+ "Monthly",
+ "Quarterly",
+ "Semiannually",
+ "Annually"
+ ],
+ "type": "string"
+ },
+ "invoice_period_custom_unit": {
+ "type": "string"
+ },
+ "max_consumption": {
+ "type": "number"
+ },
+ "max_users": {
+ "type": "number"
+ },
+ "negotiations_allowed": {
+ "description": "When true, the recipient can propose changes to the order form, even when the agreement-level `negotiations_allowed` is false. This only covers the order form.",
+ "type": "boolean"
+ },
+ "order_date_date": {
+ "type": "string"
+ },
+ "order_date_other": {
+ "type": "string"
+ },
+ "order_date_type": {
+ "enum": [
+ "signature",
+ "date",
+ "other"
+ ],
+ "type": "string"
+ },
+ "payment_period": {
+ "type": "number"
+ },
+ "payment_period_timeframe": {
+ "enum": [
+ "Customer's receipt of invoice",
+ "date of invoice"
+ ],
+ "type": "string"
+ },
+ "payment_period_unit": {
+ "enum": [
+ "day(s)",
+ "week(s)",
+ "month(s)",
+ "marketplace_acceptance"
+ ],
+ "type": "string"
+ },
+ "payment_process_automatic_frequency": {
+ "enum": [
+ "monthly",
+ "quarterly",
+ "semiannually",
+ "annually"
+ ],
+ "type": "string"
+ },
+ "payment_process_type": {
+ "enum": [
+ "automatic",
+ "invoice",
+ "custom",
+ "marketplace_acceptance"
+ ],
+ "type": "string"
+ },
+ "payment_process_type_custom_val": {
+ "type": "string"
+ },
+ "payment_process_type_invoice_amount": {
+ "type": "number"
+ },
+ "payment_process_type_invoice_custom_unit": {
+ "type": "string"
+ },
+ "payment_process_type_invoice_duration": {
+ "enum": [
+ "day",
+ "week",
+ "month",
+ "year",
+ "day(s)",
+ "week(s)",
+ "month(s)",
+ "year(s)"
+ ],
+ "type": "string"
+ },
+ "payment_process_type_invoice_duration_start": {
+ "enum": [
+ "Customer's receipt of invoice",
+ "date of invoice"
+ ],
+ "type": "string"
+ },
+ "payment_process_type_invoice_type": {
+ "enum": [
+ "monthly",
+ "quarterly",
+ "semiannually",
+ "annually",
+ "Custom unit"
+ ],
+ "type": "string"
+ },
+ "pilot_period_stripe_product_id": {
+ "type": "string"
+ },
+ "service_credits_attributes": {
+ "additionalProperties": {
+ "additionalProperties": false,
+ "properties": {
+ "credit": {
+ "type": "number"
+ },
+ "max": {
+ "type": "number"
+ },
+ "min": {
+ "type": "number"
+ }
+ },
+ "type": "object"
+ },
+ "description": "Service credits. Use string keys such as \"0\", \"1\".",
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+ },
+ "subscription_auto_renew": {
+ "enum": [
+ "days",
+ "subscription_end"
+ ],
+ "type": "string"
+ },
+ "subscription_period": {
+ "type": "number"
+ },
+ "subscription_period_unit": {
+ "type": "string"
+ },
+ "subscription_renewal_notice_days": {
+ "type": "number"
+ },
+ "subscription_start_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "subscription_start_date_type": {
+ "enum": [
+ "effective_date",
+ "date"
+ ],
+ "type": "string"
+ },
+ "underlying_agreement_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "use_limitations_attributes": {
+ "additionalProperties": {
+ "additionalProperties": false,
+ "properties": {
+ "amount": {
+ "type": "number"
+ },
+ "limitation_type": {
+ "type": "string"
+ },
+ "unit": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "description": "Use limitations. Use string keys such as \"0\", \"1\".",
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+ }
+ },
+ "type": "object"
+ },
+ "custom_field_values": {
+ "description": "Values for a custom template's fields, keyed by the field keys defined in the template's YAML definition. Only used when template_id is a custom template. Template defaults fill any fields you omit; a required field with no default and no submitted value returns a 400 naming the field. Values are validated against the field's input type: select and radio values must be one of the field's options, multiselect values are an array of selections each of which must be one of the field's options, number and currency values must be numeric, date values must be YYYY-MM-DD, and email values must be valid addresses. An invalid value returns a 400 naming the field."
+ },
+ "design_partner_attributes": {
+ "additionalProperties": false,
+ "description": "Override design partner terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "customer_description": {
+ "type": "string"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_fees": {
+ "type": "boolean"
+ },
+ "include_fees_amount": {
+ "type": "number"
+ },
+ "include_fees_description": {
+ "type": "string"
+ },
+ "include_fees_pay_by_amount": {
+ "type": "string"
+ },
+ "include_fees_type": {
+ "enum": [
+ "default_language",
+ "description"
+ ],
+ "type": "string"
+ },
+ "include_fees_unit": {
+ "enum": [
+ "month",
+ "quarter",
+ "year",
+ "Term"
+ ],
+ "type": "string"
+ },
+ "include_program_appear_as_customer_private": {
+ "type": "boolean"
+ },
+ "include_program_appear_as_customer_public": {
+ "type": "boolean"
+ },
+ "include_program_case_study": {
+ "type": "boolean"
+ },
+ "include_program_develop_functionality": {
+ "type": "boolean"
+ },
+ "include_program_develop_functionality_val": {
+ "type": "string"
+ },
+ "include_program_discount": {
+ "type": "boolean"
+ },
+ "include_program_discount_amount": {
+ "type": "number"
+ },
+ "include_program_discount_unit": {
+ "enum": [
+ "U.S. Dollars",
+ "percent"
+ ],
+ "type": "string"
+ },
+ "include_program_participation_feedback": {
+ "type": "boolean"
+ },
+ "include_program_participation_feedback_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_program_participation_feedback_unit": {
+ "enum": [
+ "month",
+ "quarter",
+ "year",
+ "Term"
+ ],
+ "type": "string"
+ },
+ "include_program_partner_other": {
+ "type": "boolean"
+ },
+ "include_program_partner_other_val": {
+ "type": "string"
+ },
+ "include_program_provider_other": {
+ "type": "boolean"
+ },
+ "include_program_provider_other_val": {
+ "type": "string"
+ },
+ "include_program_reference": {
+ "type": "boolean"
+ },
+ "product_description": {
+ "type": "string"
+ },
+ "term_amount": {
+ "type": "number"
+ },
+ "term_unit": {
+ "enum": [
+ "day(s)",
+ "week(s)",
+ "month(s)",
+ "quarter(s)",
+ "year(s)"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "district_or_county": {
+ "description": "The district or county for dispute resolution.",
+ "type": "string"
+ },
+ "dpa_attributes": {
+ "additionalProperties": false,
+ "description": "Override dpa terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "approved_subprocessor_type": {
+ "description": "`internal` lists approved subprocessors in the agreement (`subprocessors_attributes`); `external` points to a list published elsewhere.",
+ "enum": [
+ "internal",
+ "external"
+ ],
+ "type": "string"
+ },
+ "cloud_service_product_name": {
+ "type": "string"
+ },
+ "competent_supervisory_authority": {
+ "type": "string"
+ },
+ "customer_description": {
+ "type": "string"
+ },
+ "data_exporter_address_city": {
+ "type": "string"
+ },
+ "data_exporter_address_country": {
+ "type": "string"
+ },
+ "data_exporter_address_state": {
+ "type": "string"
+ },
+ "data_exporter_address_street_address": {
+ "type": "string"
+ },
+ "data_exporter_address_zipcode": {
+ "type": "string"
+ },
+ "data_exporter_contact_details": {
+ "type": "string"
+ },
+ "data_exporter_contact_name": {
+ "type": "string"
+ },
+ "data_exporter_contact_position": {
+ "type": "string"
+ },
+ "data_exporter_role": {
+ "description": "Role of the data exporter. Overwritten to `Controller` when the agreement is created from a template.",
+ "enum": [
+ "Controller",
+ "Processor"
+ ],
+ "type": "string"
+ },
+ "data_importer_address": {
+ "type": "string"
+ },
+ "data_importer_address_city": {
+ "type": "string"
+ },
+ "data_importer_address_country": {
+ "type": "string"
+ },
+ "data_importer_address_state": {
+ "type": "string"
+ },
+ "data_importer_address_street_address": {
+ "type": "string"
+ },
+ "data_importer_address_zipcode": {
+ "type": "string"
+ },
+ "data_importer_contact_details": {
+ "type": "string"
+ },
+ "data_importer_contact_name": {
+ "type": "string"
+ },
+ "data_importer_contact_position": {
+ "type": "string"
+ },
+ "duration_of_processing": {
+ "type": "string"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_covered_claim": {
+ "type": "boolean"
+ },
+ "include_covered_claim_external_val": {
+ "type": "string"
+ },
+ "include_covered_claim_internal_val": {
+ "type": "string"
+ },
+ "include_covered_claim_type": {
+ "description": "Which covered-claim text applies: `internal` uses `include_covered_claim_internal_val`, `external` uses `include_covered_claim_external_val`. Required when `include_covered_claim` is true.",
+ "enum": [
+ "internal",
+ "external"
+ ],
+ "type": "string"
+ },
+ "include_data_subjects_custom": {
+ "type": "boolean"
+ },
+ "include_data_subjects_custom_val": {
+ "type": "string"
+ },
+ "include_data_subjects_employees": {
+ "type": "boolean"
+ },
+ "include_data_subjects_end_users": {
+ "type": "boolean"
+ },
+ "include_external_subprocessor_location": {
+ "type": "string"
+ },
+ "include_frequency_of_transfer_continuous": {
+ "type": "boolean"
+ },
+ "include_frequency_of_transfer_custom": {
+ "type": "boolean"
+ },
+ "include_frequency_of_transfer_custom_val": {
+ "type": "string"
+ },
+ "include_governing_country_eu": {
+ "type": "boolean"
+ },
+ "include_governing_country_eu_val": {
+ "type": "string"
+ },
+ "include_governing_country_uk": {
+ "type": "boolean"
+ },
+ "include_governing_country_uk_val": {
+ "type": "string"
+ },
+ "include_governing_law": {
+ "type": "boolean"
+ },
+ "include_governing_law_country": {
+ "type": "string"
+ },
+ "include_governing_law_state": {
+ "type": "string"
+ },
+ "include_increased_claim_amount": {
+ "description": "Legacy field. Stored but not shown on the DPA; use the `include_liability_cap*` fields instead.",
+ "type": "boolean"
+ },
+ "include_increased_claim_amount_currency": {
+ "description": "Legacy field. Stored but not shown on the DPA; use the `include_liability_cap*` fields instead."
+ },
+ "include_increased_claim_amount_qty": {
+ "description": "Legacy field. Stored but not shown on the DPA; use the `include_liability_cap*` fields instead."
+ },
+ "include_increased_claim_amount_type": {
+ "description": "Legacy field. Stored but not shown on the DPA; use the `include_liability_cap*` fields instead.",
+ "type": "string"
+ },
+ "include_liability_cap": {
+ "type": "boolean"
+ },
+ "include_liability_cap_amount_constant_external": {
+ "type": "string"
+ },
+ "include_liability_cap_amount_constant_internal": {
+ "type": "string"
+ },
+ "include_liability_cap_amount_currency_external": {
+ "description": "Currency amount. Numbers and numeric strings (commas allowed) are both accepted."
+ },
+ "include_liability_cap_amount_currency_internal": {
+ "description": "Currency amount. Numbers and numeric strings (commas allowed) are both accepted."
+ },
+ "include_liability_cap_csa_type": {
+ "description": "Which liability cap values apply: the `_internal` or `_external` amount fields. Required when `include_liability_cap` is true.",
+ "enum": [
+ "internal",
+ "external"
+ ],
+ "type": "string"
+ },
+ "include_personal_data_biographic_info": {
+ "type": "boolean"
+ },
+ "include_personal_data_contact_info": {
+ "type": "boolean"
+ },
+ "include_personal_data_custom": {
+ "type": "boolean"
+ },
+ "include_personal_data_custom_val": {
+ "type": "string"
+ },
+ "include_personal_data_employment_info": {
+ "type": "boolean"
+ },
+ "include_personal_data_financial_info": {
+ "type": "boolean"
+ },
+ "include_personal_data_location": {
+ "type": "boolean"
+ },
+ "include_personal_data_name": {
+ "type": "boolean"
+ },
+ "include_personal_data_transactional_info": {
+ "type": "boolean"
+ },
+ "include_personal_data_user_activity_info": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_custom": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_custom_val": {
+ "type": "string"
+ },
+ "include_processing_purpose_erasing": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_holding": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_protecting": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_receiving": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_returning": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_sharing": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_updating": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_using": {
+ "type": "boolean"
+ },
+ "include_provider_security_contact_address": {
+ "type": "boolean"
+ },
+ "include_provider_security_contact_address_city": {
+ "type": "string"
+ },
+ "include_provider_security_contact_address_country": {
+ "type": "string"
+ },
+ "include_provider_security_contact_address_state": {
+ "type": "string"
+ },
+ "include_provider_security_contact_address_street_address": {
+ "type": "string"
+ },
+ "include_provider_security_contact_address_zipcode": {
+ "type": "string"
+ },
+ "include_provider_security_contact_email": {
+ "type": "boolean"
+ },
+ "include_provider_security_contact_email_val": {
+ "format": "email",
+ "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "include_security_measures_accountability": {
+ "type": "boolean"
+ },
+ "include_security_measures_accountability_val": {
+ "type": "string"
+ },
+ "include_security_measures_certification_or_assurance": {
+ "type": "boolean"
+ },
+ "include_security_measures_certification_or_assurance_val": {
+ "type": "string"
+ },
+ "include_security_measures_confidentiality_integrity": {
+ "type": "boolean"
+ },
+ "include_security_measures_confidentiality_integrity_val": {
+ "type": "string"
+ },
+ "include_security_measures_data_at_rest": {
+ "type": "boolean"
+ },
+ "include_security_measures_data_at_rest_val": {
+ "type": "string"
+ },
+ "include_security_measures_data_minimization": {
+ "type": "boolean"
+ },
+ "include_security_measures_data_minimization_val": {
+ "type": "string"
+ },
+ "include_security_measures_data_quality": {
+ "type": "boolean"
+ },
+ "include_security_measures_data_quality_val": {
+ "type": "string"
+ },
+ "include_security_measures_data_retention": {
+ "type": "boolean"
+ },
+ "include_security_measures_data_retention_val": {
+ "type": "string"
+ },
+ "include_security_measures_data_transmission": {
+ "type": "boolean"
+ },
+ "include_security_measures_data_transmission_val": {
+ "type": "string"
+ },
+ "include_security_measures_event_logging": {
+ "type": "boolean"
+ },
+ "include_security_measures_event_logging_val": {
+ "type": "string"
+ },
+ "include_security_measures_identity_auth": {
+ "type": "boolean"
+ },
+ "include_security_measures_identity_auth_val": {
+ "type": "string"
+ },
+ "include_security_measures_it_security_governance": {
+ "type": "boolean"
+ },
+ "include_security_measures_it_security_governance_val": {
+ "type": "string"
+ },
+ "include_security_measures_physical_security": {
+ "type": "boolean"
+ },
+ "include_security_measures_physical_security_val": {
+ "type": "string"
+ },
+ "include_security_measures_portability_and_erasure": {
+ "type": "boolean"
+ },
+ "include_security_measures_portability_and_erasure_val": {
+ "type": "string"
+ },
+ "include_security_measures_pseudonym_encryption": {
+ "type": "boolean"
+ },
+ "include_security_measures_pseudonym_encryption_val": {
+ "type": "string"
+ },
+ "include_security_measures_restore_data_access": {
+ "type": "boolean"
+ },
+ "include_security_measures_restore_data_access_val": {
+ "type": "string"
+ },
+ "include_security_measures_security_policy": {
+ "type": "boolean"
+ },
+ "include_security_measures_system_configuration": {
+ "type": "boolean"
+ },
+ "include_security_measures_system_configuration_val": {
+ "type": "string"
+ },
+ "include_security_measures_testing_assessment": {
+ "type": "boolean"
+ },
+ "include_security_measures_testing_assessment_val": {
+ "type": "string"
+ },
+ "include_security_policy": {
+ "type": "boolean"
+ },
+ "include_security_policy_fedramp_auth": {
+ "type": "boolean"
+ },
+ "include_security_policy_hipaa": {
+ "type": "boolean"
+ },
+ "include_security_policy_hitrust": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_other": {
+ "type": "boolean"
+ },
+ "include_security_policy_iso27001": {
+ "type": "boolean"
+ },
+ "include_security_policy_other": {
+ "type": "string"
+ },
+ "include_security_policy_pci1": {
+ "type": "boolean"
+ },
+ "include_security_policy_pci2": {
+ "type": "boolean"
+ },
+ "include_security_policy_penetration_testing": {
+ "type": "boolean"
+ },
+ "include_security_policy_soc2": {
+ "type": "boolean"
+ },
+ "include_security_policy_soc2_type2": {
+ "type": "boolean"
+ },
+ "include_sensitive_data_restrictions_custom": {
+ "type": "boolean"
+ },
+ "include_sensitive_data_restrictions_custom_val": {
+ "type": "string"
+ },
+ "include_sensitive_data_restrictions_security_policy": {
+ "type": "boolean"
+ },
+ "include_service_provider_relationship": {
+ "type": "boolean"
+ },
+ "include_special_category_data": {
+ "type": "boolean"
+ },
+ "provider": {
+ "type": "string"
+ },
+ "security_policy_available_at": {
+ "type": "string"
+ },
+ "security_policy_type": {
+ "description": "Where the Security Policy is defined. For `external`, set `security_policy_available_at`.",
+ "enum": [
+ "defined in agreement",
+ "provider service",
+ "external"
+ ],
+ "type": "string"
+ },
+ "subprocessors_attributes": {
+ "additionalProperties": {
+ "additionalProperties": false,
+ "properties": {
+ "_destroy": {
+ "description": "Set to true with `id` to remove that subprocessor.",
+ "type": "boolean"
+ },
+ "country": {
+ "type": "string"
+ },
+ "id": {
+ "description": "ID of an existing subprocessor to update or remove. Omit to add a new subprocessor.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "processing_task": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "description": "Subprocessors, keyed by string index such as \"0\", \"1\". On create these are added to the template's subprocessors. On a draft update, an entry without `id` adds a new subprocessor; pass `id` to change one and `id` with `_destroy: true` to remove one.",
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+ },
+ "underlying_agreement_id": {
+ "description": "ID of the CSA this DPA supplements when `underlying_agreement_type` is `internal`.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "underlying_agreement_type": {
+ "description": "`internal` links a CSA in Common Paper (`underlying_agreement_id`); `external` describes another agreement in `underlying_agreement_val` (required). Omit for none.",
+ "enum": [
+ "internal",
+ "external"
+ ],
+ "type": "string"
+ },
+ "underlying_agreement_val": {
+ "description": "Description of the agreement this DPA supplements. Required when `underlying_agreement_type` is `external`.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "framework_terms_description": {
+ "description": "Custom framework terms description. Only used when framework_terms_type is \"description\".",
+ "type": "string"
+ },
+ "framework_terms_type": {
+ "description": "How framework terms are specified. Use \"new\" for standard terms or \"description\" to provide a custom framework_terms_description.",
+ "enum": [
+ "new",
+ "description"
+ ],
+ "type": "string"
+ },
+ "governing_law_country": {
+ "description": "The country whose laws govern the agreement.",
+ "type": "string"
+ },
+ "governing_law_region": {
+ "description": "The state or region whose laws govern the agreement.",
+ "type": "string"
+ },
+ "include_automated_payment_reminders": {
+ "description": "When true, automatically sends payment reminder emails.",
+ "type": "boolean"
+ },
+ "include_billing_info": {
+ "description": "When true, billing contact information (billing_name, billing_email) is included.",
+ "type": "boolean"
+ },
+ "include_billing_workflow": {
+ "description": "When true, enables a billing workflow after signing.",
+ "type": "boolean"
+ },
+ "include_expiration_date": {
+ "description": "Expiration date in YYYY-MM-DD format. Use when include_expiration_type is \"date\".",
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "include_expiration_days": {
+ "description": "Number of days until the agreement expires. Use when include_expiration_type is \"days\".",
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_expiration_type": {
+ "description": "How to set expiration: \"none\" (default), \"days\" (use include_expiration_days), or \"date\" (use include_expiration_date).",
+ "enum": [
+ "none",
+ "days",
+ "date"
+ ],
+ "type": "string"
+ },
+ "include_terms": {
+ "description": "When true, the standard terms are included with the agreement.",
+ "type": "boolean"
+ },
+ "loi_attributes": {
+ "additionalProperties": false,
+ "description": "Override loi terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "confidentiality_custom": {
+ "type": "string"
+ },
+ "confidentiality_mutual_include_loi": {
+ "type": "boolean"
+ },
+ "confidentiality_nda_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "confidentiality_nda_description": {
+ "type": "string"
+ },
+ "confidentiality_nda_include_loi": {
+ "type": "boolean"
+ },
+ "confidentiality_nda_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "confidentiality_type": {
+ "enum": [
+ "mutual",
+ "nda",
+ "provider",
+ "custom"
+ ],
+ "type": "string"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_custom_details": {
+ "type": "boolean"
+ },
+ "include_custom_details_val": {
+ "type": "string"
+ },
+ "include_fees": {
+ "type": "boolean"
+ },
+ "include_fees_amount": {
+ "type": "number"
+ },
+ "include_fees_amount_duration": {
+ "enum": [
+ "month",
+ "year",
+ "quarter"
+ ],
+ "type": "string"
+ },
+ "include_fees_include_amount": {
+ "type": "boolean"
+ },
+ "include_fees_include_other": {
+ "type": "boolean"
+ },
+ "include_fees_other": {
+ "type": "string"
+ },
+ "include_functionality": {
+ "type": "boolean"
+ },
+ "include_functionality_val": {
+ "type": "string"
+ },
+ "include_launch_date": {
+ "type": "boolean"
+ },
+ "include_launch_date_custom": {
+ "type": "string"
+ },
+ "include_launch_date_date": {
+ "format": "date-time",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$",
+ "type": "string"
+ },
+ "include_launch_date_type": {
+ "enum": [
+ "date",
+ "custom"
+ ],
+ "type": "string"
+ },
+ "product_name": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "manual_send": {
+ "description": "When true, the agreement is marked as manually sent outside the platform.",
+ "type": "boolean"
+ },
+ "message": {
+ "type": "string"
+ },
+ "negotiations_allowed": {
+ "description": "When true, the recipient can propose changes to the legal terms. For agreement types without separate business terms, that covers every term. CSA order forms, PSA statements of work, partnership business terms and software license order forms have their own `negotiations_allowed` flag.",
+ "type": "boolean"
+ },
+ "partnership_attributes": {
+ "additionalProperties": false,
+ "description": "Override partnership terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "effective_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "effective_date_type": {
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "type": "string"
+ },
+ "general_cap_amount_currency_val": {
+ "type": "number"
+ },
+ "general_cap_amount_either_currency": {
+ "type": "number"
+ },
+ "general_cap_amount_either_multiple": {
+ "type": "number"
+ },
+ "general_cap_amount_multiple_val": {
+ "type": "number"
+ },
+ "general_cap_amount_type": {
+ "enum": [
+ "multiple",
+ "currency",
+ "either",
+ "base"
+ ],
+ "type": "string"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_additional_warranties": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_include_company": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_include_company_val": {
+ "type": "string"
+ },
+ "include_additional_warranties_include_partner": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_include_partner_val": {
+ "type": "string"
+ },
+ "include_brand_guidelines": {
+ "type": "boolean"
+ },
+ "include_brand_guidelines_include_company": {
+ "type": "boolean"
+ },
+ "include_brand_guidelines_include_company_val": {
+ "type": "string"
+ },
+ "include_brand_guidelines_include_partner": {
+ "type": "boolean"
+ },
+ "include_brand_guidelines_include_partner_val": {
+ "type": "string"
+ },
+ "include_covered_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_company_claims": {
+ "type": "string"
+ },
+ "include_covered_claims_include_company_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_include_partner_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_partner_claims": {
+ "type": "string"
+ },
+ "include_dpa": {
+ "type": "boolean"
+ },
+ "include_dpa_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_dpa_location": {
+ "type": "string"
+ },
+ "include_dpa_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_increased_cap_amount": {
+ "type": "boolean"
+ },
+ "include_increased_cap_amount_currency": {
+ "type": "number"
+ },
+ "include_increased_cap_amount_either_currency": {
+ "type": "number"
+ },
+ "include_increased_cap_amount_either_multiple": {
+ "type": "string"
+ },
+ "include_increased_cap_amount_multiple": {
+ "type": "string"
+ },
+ "include_increased_cap_amount_type": {
+ "enum": [
+ "multiple",
+ "currency",
+ "either"
+ ],
+ "type": "string"
+ },
+ "include_increased_claims": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_confidentiality": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_confidentiality_misconduct": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_covered_claims": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_misconduct": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_other": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_other_val": {
+ "type": "string"
+ },
+ "include_unlimited_claims": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_confidentiality": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_confidentiality_misconduct": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_covered_claims": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_misconduct": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_other": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_other_val": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "partnership_business_terms_attributes": {
+ "additionalProperties": false,
+ "description": "Override partnership business terms terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "end_date_after_effective_date_amount": {
+ "type": "number"
+ },
+ "end_date_after_effective_date_unit": {
+ "enum": [
+ "month(s)",
+ "quarter(s)",
+ "year(s)"
+ ],
+ "type": "string"
+ },
+ "end_date_date": {
+ "type": "string"
+ },
+ "end_date_type": {
+ "enum": [
+ "date",
+ "effective date"
+ ],
+ "type": "string"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_obligations_company_brand": {
+ "type": "boolean"
+ },
+ "include_obligations_company_promotion": {
+ "type": "boolean"
+ },
+ "include_obligations_company_promotion_include_activities": {
+ "type": "boolean"
+ },
+ "include_obligations_company_promotion_include_activities_val": {
+ "type": "string"
+ },
+ "include_obligations_company_promotion_include_materials": {
+ "type": "boolean"
+ },
+ "include_obligations_company_promotion_include_materials_val": {
+ "type": "string"
+ },
+ "include_obligations_company_referral": {
+ "type": "boolean"
+ },
+ "include_obligations_company_referral_include_criteria": {
+ "type": "boolean"
+ },
+ "include_obligations_company_referral_include_criteria_val": {
+ "type": "string"
+ },
+ "include_obligations_company_referral_include_pay_sch": {
+ "type": "boolean"
+ },
+ "include_obligations_company_referral_include_pay_sch_amount": {
+ "type": "number"
+ },
+ "include_obligations_company_referral_include_pay_sch_custom": {
+ "type": "string"
+ },
+ "include_obligations_company_referral_include_pay_sch_unit": {
+ "enum": [
+ "U.S. Dollars",
+ "percent"
+ ],
+ "type": "string"
+ },
+ "include_obligations_company_sponsorship": {
+ "type": "boolean"
+ },
+ "include_obligations_company_sponsorship_include_benefits": {
+ "type": "boolean"
+ },
+ "include_obligations_company_sponsorship_include_benefits_val": {
+ "type": "string"
+ },
+ "include_obligations_company_sponsorship_include_payments": {
+ "type": "boolean"
+ },
+ "include_obligations_company_sponsorship_include_payments_amount": {
+ "type": "number"
+ },
+ "include_obligations_company_sponsorship_include_payments_unit": {
+ "enum": [
+ "U.S. Dollars",
+ "percent"
+ ],
+ "type": "string"
+ },
+ "include_obligations_partner_brand": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_promotion": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_promotion_include_activities": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_promotion_include_activities_val": {
+ "type": "string"
+ },
+ "include_obligations_partner_promotion_include_materials": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_promotion_include_materials_val": {
+ "type": "string"
+ },
+ "include_obligations_partner_referral": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_referral_include_criteria": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_referral_include_criteria_val": {
+ "type": "string"
+ },
+ "include_obligations_partner_referral_include_pay_sch": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_referral_include_pay_sch_amount": {
+ "type": "number"
+ },
+ "include_obligations_partner_referral_include_pay_sch_custom": {
+ "type": "string"
+ },
+ "include_obligations_partner_referral_include_pay_sch_unit": {
+ "enum": [
+ "U.S. Dollars",
+ "percent"
+ ],
+ "type": "string"
+ },
+ "include_obligations_partner_sponsorship": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_sponsorship_include_benefits": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_sponsorship_include_benefits_val": {
+ "type": "string"
+ },
+ "include_obligations_partner_sponsorship_include_payments": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_sponsorship_include_payments_amount": {
+ "type": "number"
+ },
+ "include_obligations_partner_sponsorship_include_payments_unit": {
+ "enum": [
+ "U.S. Dollars",
+ "percent"
+ ],
+ "type": "string"
+ },
+ "include_payment_process": {
+ "type": "boolean"
+ },
+ "include_payment_process_company": {
+ "type": "boolean"
+ },
+ "include_payment_process_company_include_address": {
+ "type": "boolean"
+ },
+ "include_payment_process_company_include_address_city": {
+ "type": "string"
+ },
+ "include_payment_process_company_include_address_country": {
+ "type": "string"
+ },
+ "include_payment_process_company_include_address_state": {
+ "type": "string"
+ },
+ "include_payment_process_company_include_address_street_address": {
+ "type": "string"
+ },
+ "include_payment_process_company_include_address_zipcode": {
+ "type": "string"
+ },
+ "include_payment_process_company_include_email": {
+ "type": "boolean"
+ },
+ "include_payment_process_company_include_email_val": {
+ "type": "string"
+ },
+ "include_payment_process_partner": {
+ "type": "boolean"
+ },
+ "include_payment_process_partner_include_address": {
+ "type": "boolean"
+ },
+ "include_payment_process_partner_include_address_city": {
+ "type": "string"
+ },
+ "include_payment_process_partner_include_address_country": {
+ "type": "string"
+ },
+ "include_payment_process_partner_include_address_state": {
+ "type": "string"
+ },
+ "include_payment_process_partner_include_address_street_address": {
+ "type": "string"
+ },
+ "include_payment_process_partner_include_address_zipcode": {
+ "type": "string"
+ },
+ "include_payment_process_partner_include_email": {
+ "type": "boolean"
+ },
+ "include_payment_process_partner_include_email_val": {
+ "type": "string"
+ },
+ "include_payment_schedule": {
+ "type": "boolean"
+ },
+ "include_payment_schedule_custom": {
+ "type": "string"
+ },
+ "include_payment_schedule_specified_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_payment_schedule_specified_timeframe": {
+ "enum": [
+ "receipt",
+ "date"
+ ],
+ "type": "string"
+ },
+ "include_payment_schedule_specified_unit": {
+ "enum": [
+ "day(s)",
+ "week(s)",
+ "month(s)",
+ "quarter(s)",
+ "year(s)"
+ ],
+ "type": "string"
+ },
+ "include_payment_schedule_type": {
+ "enum": [
+ "specified",
+ "custom"
+ ],
+ "type": "string"
+ },
+ "negotiations_allowed": {
+ "description": "When true, the recipient can propose changes to the business terms, even when the agreement-level `negotiations_allowed` is false. This only covers the business terms.",
+ "type": "boolean"
+ },
+ "territory_type": {
+ "enum": [
+ "worldwide",
+ "custom"
+ ],
+ "type": "string"
+ },
+ "territory_type_val": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "payment_link_url": {
+ "description": "A payment URL shown to the recipient after signing. Requires include_billing_workflow to be true and billing_workflow_type to be \"link\".",
+ "type": "string"
+ },
+ "pilot_attributes": {
+ "additionalProperties": false,
+ "description": "Override pilot terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "fees_type": {
+ "enum": [
+ "free",
+ "pilot_period_fees"
+ ],
+ "type": "string"
+ },
+ "general_cap_amount": {
+ "type": "number"
+ },
+ "general_cap_amount_type": {
+ "enum": [
+ "preceding",
+ "base",
+ "period"
+ ],
+ "type": "string"
+ },
+ "general_cap_period_currency": {
+ "type": "number"
+ },
+ "general_cap_period_qty": {
+ "type": "number"
+ },
+ "general_cap_preceding_amount": {
+ "type": "number"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_dpa": {
+ "type": "boolean"
+ },
+ "include_dpa_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_dpa_location": {
+ "type": "string"
+ },
+ "include_dpa_type": {
+ "enum": [
+ "description",
+ "attachment",
+ "standard"
+ ],
+ "type": "string"
+ },
+ "include_payment_process": {
+ "type": "boolean"
+ },
+ "include_technical_support": {
+ "type": "boolean"
+ },
+ "payment_process_automatic_frequency": {
+ "enum": [
+ "monthly",
+ "quarterly",
+ "annually",
+ "once_per_period"
+ ],
+ "type": "string"
+ },
+ "payment_process_invoice_days": {
+ "type": "number"
+ },
+ "payment_process_invoice_from": {
+ "enum": [
+ "receipt",
+ "date"
+ ],
+ "type": "string"
+ },
+ "payment_process_invoice_timeframe": {
+ "enum": [
+ "days",
+ "weeks",
+ "months",
+ "quarters",
+ "years"
+ ],
+ "type": "string"
+ },
+ "payment_process_type": {
+ "enum": [
+ "automatic",
+ "invoice"
+ ],
+ "type": "string"
+ },
+ "pilot_period_description": {
+ "type": "string"
+ },
+ "pilot_period_fees_description": {
+ "type": "string"
+ },
+ "product_description": {
+ "type": "string"
+ },
+ "technical_support_description": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "psa_attributes": {
+ "additionalProperties": false,
+ "description": "Override psa terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "additional_changes": {
+ "type": "string"
+ },
+ "customer_description": {
+ "type": "string"
+ },
+ "effective_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "effective_date_type": {
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "type": "string"
+ },
+ "general_cap_amount": {
+ "type": "number"
+ },
+ "general_cap_amount_type": {
+ "enum": [
+ "preceding",
+ "base",
+ "period"
+ ],
+ "type": "string"
+ },
+ "general_cap_period_currency": {
+ "type": "number"
+ },
+ "general_cap_period_qty": {
+ "type": "number"
+ },
+ "general_cap_preceding_amount": {
+ "type": "number"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_additional_changes": {
+ "type": "boolean"
+ },
+ "include_additional_warranties": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_by_customer": {
+ "type": "string"
+ },
+ "include_additional_warranties_by_provider": {
+ "type": "string"
+ },
+ "include_additional_warranties_include_by_customer": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_include_by_provider": {
+ "type": "boolean"
+ },
+ "include_covered_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_customer_claims": {
+ "type": "string"
+ },
+ "include_covered_claims_include_customer_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_include_provider_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_provider_claims": {
+ "type": "string"
+ },
+ "include_customer_insurance_min": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_add_provider_com_gen_liability": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_add_provider_cyber_liability": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_add_provider_errors_omissions": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_auto_liability_aggregate": {
+ "type": "number"
+ },
+ "include_customer_insurance_min_auto_liability_minimum": {
+ "type": "number"
+ },
+ "include_customer_insurance_min_cyber_liability_aggregate": {
+ "type": "number"
+ },
+ "include_customer_insurance_min_cyber_liability_minimum": {
+ "type": "number"
+ },
+ "include_customer_insurance_min_employer_liability_aggregate": {
+ "type": "number"
+ },
+ "include_customer_insurance_min_employer_liability_minimum": {
+ "type": "number"
+ },
+ "include_customer_insurance_min_general_liability_aggregate": {
+ "type": "number"
+ },
+ "include_customer_insurance_min_general_liability_minimum": {
+ "type": "number"
+ },
+ "include_customer_insurance_min_include_add_provider": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_include_auto_liability": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_include_cyber_liability": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_include_employer_liability": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_include_general_liability": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_include_workers_comp": {
+ "type": "boolean"
+ },
+ "include_customer_policies": {
+ "type": "boolean"
+ },
+ "include_customer_policies_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_customer_policies_location": {
+ "type": "string"
+ },
+ "include_customer_policies_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_dpa": {
+ "type": "boolean"
+ },
+ "include_dpa_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_dpa_location": {
+ "type": "string"
+ },
+ "include_dpa_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_increased_cap_amount": {
+ "type": "boolean"
+ },
+ "include_increased_claims": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_confidentiality": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_confidentiality_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_privsec": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_privsec_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_other": {
+ "type": "boolean"
+ },
+ "include_increased_claims_indemnification_obligation": {
+ "type": "boolean"
+ },
+ "include_increased_claims_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_other": {
+ "type": "string"
+ },
+ "include_provider_insurance_min": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_add_customer_com_gen_liability": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_add_customer_cyber_liability": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_add_customer_errors_omissions": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_auto_liability_aggregate": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_auto_liability_minimum": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_cyber_liability_aggregate": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_cyber_liability_minimum": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_employer_liability_aggregate": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_employer_liability_minimum": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_general_liability_aggregate": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_general_liability_minimum": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_include_add_customer": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_include_auto_liability": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_include_cyber_liability": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_include_employer_liability": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_include_general_liability": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_include_workers_comp": {
+ "type": "boolean"
+ },
+ "include_publicity_rights": {
+ "type": "boolean"
+ },
+ "include_publicity_rights_type": {
+ "enum": [
+ "public",
+ "non-public"
+ ],
+ "type": "string"
+ },
+ "include_security_policy": {
+ "type": "boolean"
+ },
+ "include_security_policy_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_security_policy_fedramp_auth": {
+ "type": "boolean"
+ },
+ "include_security_policy_hitrust": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_annual_maintenance": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_other": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_other_val": {
+ "type": "string"
+ },
+ "include_security_policy_iso27001": {
+ "type": "boolean"
+ },
+ "include_security_policy_location": {
+ "type": "string"
+ },
+ "include_security_policy_pci1": {
+ "type": "boolean"
+ },
+ "include_security_policy_pci2": {
+ "type": "boolean"
+ },
+ "include_security_policy_penetration_testing": {
+ "type": "boolean"
+ },
+ "include_security_policy_soc2_type1": {
+ "type": "boolean"
+ },
+ "include_security_policy_soc2_type2": {
+ "type": "boolean"
+ },
+ "include_security_policy_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_unlimited_claims": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_confidentiality": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_confidentiality_negligence": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_privsec": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_privsec_negligence": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_include_other": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_indemnification_obligation": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_negligence": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_other": {
+ "type": "string"
+ },
+ "increased_cap_amount_currency": {
+ "type": "number"
+ },
+ "increased_cap_amount_period_currency": {
+ "type": "number"
+ },
+ "increased_cap_amount_period_qty": {
+ "type": "number"
+ },
+ "increased_cap_amount_qty": {
+ "type": "number"
+ },
+ "increased_cap_amount_type": {
+ "enum": [
+ "qty",
+ "currency",
+ "period"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "psa_statement_of_work_attributes": {
+ "additionalProperties": false,
+ "description": "Override psa statement of work terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "additional_changes": {
+ "type": "string"
+ },
+ "cost": {
+ "type": "number"
+ },
+ "description": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "fees_attributes": {
+ "additionalProperties": {
+ "anyOf": [
+ {
+ "additionalProperties": false,
+ "description": "Fees::Flat (fee_type \"flat\"). A fixed recurring fee, e.g. a platform subscription. Set type to \"Fees::Flat\" or fee_type to \"flat\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Fixed amount in the order form's fees_currency, charged per fee_period. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"flat\". Alternative to type.",
+ "enum": [
+ "flat"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Flat\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Flat"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Discount (fee_type \"discount\"). A discount, as a fixed amount or a percentage, applied forever, once, or for a number of months. Set type to \"Fees::Discount\" or fee_type to \"discount\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Discount size: an amount in fees_currency when discount_type is fixed_amount (a plain amount, not cents: 20 means 20.00), or a percentage (e.g. 10 for 10%) when it is percentage.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "discount_duration_amount": {
+ "description": "Number of months the discount applies. Required when discount_duration_type is multiple_months.",
+ "type": "number"
+ },
+ "discount_duration_type": {
+ "description": "How long the discount applies. multiple_months also needs discount_duration_amount.",
+ "enum": [
+ "forever",
+ "once",
+ "multiple_months"
+ ],
+ "type": "string"
+ },
+ "discount_type": {
+ "description": "Whether cost is a currency amount or a percentage.",
+ "enum": [
+ "fixed_amount",
+ "percentage"
+ ],
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"discount\". Alternative to type.",
+ "enum": [
+ "discount"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Discount\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Discount"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Cost (fee_type \"cost\"). A per-unit fee: price per unit times quantity, e.g. seats. Set type to \"Fees::Cost\" or fee_type to \"cost\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Price per unit in fees_currency. The row total is quantity x cost. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"cost\". Alternative to type.",
+ "enum": [
+ "cost"
+ ],
+ "type": "string"
+ },
+ "quantity": {
+ "description": "Number of units.",
+ "type": "number"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Cost\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Cost"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Attachment (fee_type \"attachment\"). A fee described in an uploaded attachment instead of in the table. Set type to \"Fees::Attachment\" or fee_type to \"attachment\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "attachment_id": {
+ "description": "ID of an attachment uploaded with upload-attachment.",
+ "type": "string"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"attachment\". Alternative to type.",
+ "enum": [
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Attachment\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Attachment"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Graduated (fee_type \"graduated\"). Tiered pricing, with the price set per tier in graduated_fee_tiers_attributes. Set type to \"Fees::Graduated\" or fee_type to \"graduated\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"graduated\". Alternative to type.",
+ "enum": [
+ "graduated"
+ ],
+ "type": "string"
+ },
+ "graduated_fee_tiers_attributes": {
+ "additionalProperties": {
+ "additionalProperties": false,
+ "properties": {
+ "flat_price": {
+ "type": "number"
+ },
+ "price_per_unit": {
+ "type": "string"
+ },
+ "upper_limit": {
+ "type": "number"
+ }
+ },
+ "type": "object"
+ },
+ "description": "Graduated fee tiers. Use string keys such as \"0\", \"1\".",
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Graduated\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Graduated"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Included (fee_type \"included\"). An item included at no charge. Set type to \"Fees::Included\" or fee_type to \"included\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"included\". Alternative to type.",
+ "enum": [
+ "included"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Included\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Included"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Metered (fee_type \"metered\"). Usage-based pricing, billed per unit used. Set type to \"Fees::Metered\" or fee_type to \"metered\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Price per unit of usage in fees_currency. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"metered\". Alternative to type.",
+ "enum": [
+ "metered"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Metered\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Metered"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::OneTime (fee_type \"one_time\"). A one-time charge, such as a setup fee. Set type to \"Fees::OneTime\" or fee_type to \"one_time\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "One-time amount in fees_currency, charged once rather than per fee_period. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"one_time\". Alternative to type.",
+ "enum": [
+ "one_time"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::OneTime\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::OneTime"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Text (fee_type \"text\"). A fee term described in free text. Set type to \"Fees::Text\" or fee_type to \"text\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"text\". Alternative to type.",
+ "enum": [
+ "text"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Text\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Text"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ }
+ ]
+ },
+ "description": "Fee line items. Use string keys such as \"0\", \"1\". Replaces template fees when provided.",
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_additional_changes": {
+ "type": "boolean"
+ },
+ "include_customer_obligation": {
+ "type": "boolean"
+ },
+ "include_customer_obligation_val": {
+ "type": "string"
+ },
+ "include_deliverables": {
+ "type": "boolean"
+ },
+ "include_deliverables_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_deliverables_description": {
+ "type": "string"
+ },
+ "include_deliverables_include_acceptance": {
+ "type": "boolean"
+ },
+ "include_deliverables_include_attachment": {
+ "type": "boolean"
+ },
+ "include_deliverables_include_draft_deliverables": {
+ "type": "boolean"
+ },
+ "include_deliverables_rejection_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_deliverables_rejection_unit": {
+ "enum": [
+ "hours",
+ "days",
+ "weeks",
+ "months"
+ ],
+ "type": "string"
+ },
+ "include_deliverables_resubmission_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_deliverables_resubmission_unit": {
+ "enum": [
+ "hours",
+ "days",
+ "weeks",
+ "months"
+ ],
+ "type": "string"
+ },
+ "include_fees_other": {
+ "type": "boolean"
+ },
+ "include_fees_other_val": {
+ "type": "string"
+ },
+ "include_fees_table": {
+ "type": "boolean"
+ },
+ "include_fees_table_total": {
+ "type": "boolean"
+ },
+ "include_fees_travel": {
+ "type": "boolean"
+ },
+ "include_fees_travel_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_fees_travel_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_fees_travel_val": {
+ "type": "string"
+ },
+ "include_third_party_customer": {
+ "type": "boolean"
+ },
+ "include_third_party_include_description": {
+ "type": "boolean"
+ },
+ "include_third_party_include_description_val": {
+ "type": "string"
+ },
+ "include_third_party_materials": {
+ "type": "boolean"
+ },
+ "include_third_party_provider": {
+ "type": "boolean"
+ },
+ "include_time_of_assignment": {
+ "type": "boolean"
+ },
+ "include_time_of_assignment_type": {
+ "enum": [
+ "created",
+ "paid"
+ ],
+ "type": "string"
+ },
+ "invoice_period_description": {
+ "type": "string"
+ },
+ "negotiations_allowed": {
+ "description": "When true, the recipient can propose changes to the statement of work, even when the agreement-level `negotiations_allowed` is false. This only covers the statement of work.",
+ "type": "boolean"
+ },
+ "payment_period": {
+ "type": "number"
+ },
+ "payment_period_other": {
+ "type": "string"
+ },
+ "payment_period_timeframe": {
+ "enum": [
+ "receipt",
+ "invoice",
+ "Customer's receipt of invoice",
+ "date of invoice"
+ ],
+ "type": "string"
+ },
+ "payment_period_type": {
+ "enum": [
+ "standard",
+ "other"
+ ],
+ "type": "string"
+ },
+ "payment_period_unit": {
+ "enum": [
+ "day(s)",
+ "week(s)",
+ "month(s)",
+ "quarter(s)",
+ "year(s)"
+ ],
+ "type": "string"
+ },
+ "quantity": {
+ "type": "number"
+ },
+ "services_description": {
+ "type": "string"
+ },
+ "sow_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "sow_date_type": {
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "type": "string"
+ },
+ "sow_term_amount": {
+ "type": "number"
+ },
+ "sow_term_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "sow_term_type": {
+ "enum": [
+ "deliverables",
+ "period",
+ "date"
+ ],
+ "type": "string"
+ },
+ "sow_term_unit": {
+ "enum": [
+ "month(s)",
+ "quarter(s)",
+ "year(s)"
+ ],
+ "type": "string"
+ },
+ "type": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "recipient_email": {
+ "format": "email",
+ "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "recipient_name": {
+ "type": "string"
+ },
+ "recipient_notice_email_address": {
+ "description": "Email address for legal notices to the recipient.",
+ "format": "email",
+ "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "recipient_organization": {
+ "type": "string"
+ },
+ "sender_last_to_sign": {
+ "description": "When true, your signer signs after the recipient.",
+ "type": "boolean"
+ },
+ "sender_notice_email_address": {
+ "description": "Email address for legal notices to the sender.",
+ "format": "email",
+ "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "software_license_attributes": {
+ "additionalProperties": false,
+ "description": "Override software license terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "effective_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "effective_date_type": {
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "type": "string"
+ },
+ "general_cap_amount": {
+ "type": "number"
+ },
+ "general_cap_amount_type": {
+ "enum": [
+ "preceding",
+ "base",
+ "period"
+ ],
+ "type": "string"
+ },
+ "general_cap_period_currency": {
+ "type": "number"
+ },
+ "general_cap_period_qty": {
+ "type": "number"
+ },
+ "general_cap_preceding_amount": {
+ "type": "number"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_additional_warranties": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_by_customer": {
+ "type": "string"
+ },
+ "include_additional_warranties_by_provider": {
+ "type": "string"
+ },
+ "include_additional_warranties_include_by_customer": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_include_by_provider": {
+ "type": "boolean"
+ },
+ "include_ai_addendum": {
+ "type": "boolean"
+ },
+ "include_ai_addendum_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_covered_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_customer_claims": {
+ "type": "string"
+ },
+ "include_covered_claims_include_customer_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_include_provider_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_provider_claims": {
+ "type": "string"
+ },
+ "include_dpa": {
+ "type": "boolean"
+ },
+ "include_dpa_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_dpa_location": {
+ "type": "string"
+ },
+ "include_dpa_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_increased_cap_amount": {
+ "type": "boolean"
+ },
+ "include_increased_claims": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_confidentiality": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_confidentiality_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_other": {
+ "type": "boolean"
+ },
+ "include_increased_claims_indemnification_obligation": {
+ "type": "boolean"
+ },
+ "include_increased_claims_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_other": {
+ "type": "string"
+ },
+ "include_increased_claims_restrictions": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_confidentiality": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_confidentiality_negligence": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_include_other": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_indemnification_obligation": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_license_or_restrictions": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_negligence": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_other": {
+ "type": "string"
+ },
+ "increased_cap_amount_currency": {
+ "type": "number"
+ },
+ "increased_cap_amount_period_currency": {
+ "type": "number"
+ },
+ "increased_cap_amount_period_qty": {
+ "type": "number"
+ },
+ "increased_cap_amount_qty": {
+ "type": "number"
+ },
+ "increased_cap_amount_type": {
+ "enum": [
+ "qty",
+ "currency",
+ "period"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "software_license_order_form_attributes": {
+ "additionalProperties": false,
+ "description": "Override software license order form terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "additional_changes": {
+ "type": "string"
+ },
+ "deletion_procedure_include_custom": {
+ "type": "boolean"
+ },
+ "deletion_procedure_include_custom_description": {
+ "type": "string"
+ },
+ "deletion_procedure_include_customer_disable": {
+ "type": "boolean"
+ },
+ "deletion_procedure_include_customer_proof": {
+ "type": "boolean"
+ },
+ "deletion_procedure_include_provider_disable": {
+ "type": "boolean"
+ },
+ "fee_custom_unit": {
+ "type": "string"
+ },
+ "fee_period": {
+ "enum": [
+ "Subscription Period",
+ "month",
+ "year",
+ "Custom unit"
+ ],
+ "type": "string"
+ },
+ "fees_attributes": {
+ "additionalProperties": {
+ "anyOf": [
+ {
+ "additionalProperties": false,
+ "description": "Fees::Flat (fee_type \"flat\"). A fixed recurring fee, e.g. a platform subscription. Set type to \"Fees::Flat\" or fee_type to \"flat\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Fixed amount in the order form's fees_currency, charged per fee_period. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"flat\". Alternative to type.",
+ "enum": [
+ "flat"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Flat\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Flat"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Discount (fee_type \"discount\"). A discount, as a fixed amount or a percentage, applied forever, once, or for a number of months. Set type to \"Fees::Discount\" or fee_type to \"discount\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Discount size: an amount in fees_currency when discount_type is fixed_amount (a plain amount, not cents: 20 means 20.00), or a percentage (e.g. 10 for 10%) when it is percentage.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "discount_duration_amount": {
+ "description": "Number of months the discount applies. Required when discount_duration_type is multiple_months.",
+ "type": "number"
+ },
+ "discount_duration_type": {
+ "description": "How long the discount applies. multiple_months also needs discount_duration_amount.",
+ "enum": [
+ "forever",
+ "once",
+ "multiple_months"
+ ],
+ "type": "string"
+ },
+ "discount_type": {
+ "description": "Whether cost is a currency amount or a percentage.",
+ "enum": [
+ "fixed_amount",
+ "percentage"
+ ],
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"discount\". Alternative to type.",
+ "enum": [
+ "discount"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Discount\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Discount"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Cost (fee_type \"cost\"). A per-unit fee: price per unit times quantity, e.g. seats. Set type to \"Fees::Cost\" or fee_type to \"cost\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Price per unit in fees_currency. The row total is quantity x cost. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"cost\". Alternative to type.",
+ "enum": [
+ "cost"
+ ],
+ "type": "string"
+ },
+ "quantity": {
+ "description": "Number of units.",
+ "type": "number"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Cost\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Cost"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Attachment (fee_type \"attachment\"). A fee described in an uploaded attachment instead of in the table. Set type to \"Fees::Attachment\" or fee_type to \"attachment\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "attachment_id": {
+ "description": "ID of an attachment uploaded with upload-attachment.",
+ "type": "string"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"attachment\". Alternative to type.",
+ "enum": [
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Attachment\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Attachment"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Graduated (fee_type \"graduated\"). Tiered pricing, with the price set per tier in graduated_fee_tiers_attributes. Set type to \"Fees::Graduated\" or fee_type to \"graduated\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"graduated\". Alternative to type.",
+ "enum": [
+ "graduated"
+ ],
+ "type": "string"
+ },
+ "graduated_fee_tiers_attributes": {
+ "additionalProperties": {
+ "additionalProperties": false,
+ "properties": {
+ "flat_price": {
+ "type": "number"
+ },
+ "price_per_unit": {
+ "type": "string"
+ },
+ "upper_limit": {
+ "type": "number"
+ }
+ },
+ "type": "object"
+ },
+ "description": "Graduated fee tiers. Use string keys such as \"0\", \"1\".",
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Graduated\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Graduated"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Included (fee_type \"included\"). An item included at no charge. Set type to \"Fees::Included\" or fee_type to \"included\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"included\". Alternative to type.",
+ "enum": [
+ "included"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Included\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Included"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Metered (fee_type \"metered\"). Usage-based pricing, billed per unit used. Set type to \"Fees::Metered\" or fee_type to \"metered\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Price per unit of usage in fees_currency. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"metered\". Alternative to type.",
+ "enum": [
+ "metered"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Metered\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Metered"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::OneTime (fee_type \"one_time\"). A one-time charge, such as a setup fee. Set type to \"Fees::OneTime\" or fee_type to \"one_time\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "One-time amount in fees_currency, charged once rather than per fee_period. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"one_time\". Alternative to type.",
+ "enum": [
+ "one_time"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::OneTime\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::OneTime"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Text (fee_type \"text\"). A fee term described in free text. Set type to \"Fees::Text\" or fee_type to \"text\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"text\". Alternative to type.",
+ "enum": [
+ "text"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Text\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Text"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ }
+ ]
+ },
+ "description": "Fee line items. Use string keys such as \"0\", \"1\". Replaces template fees when provided.",
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+ },
+ "fees_currency": {
+ "enum": [
+ "USD",
+ "EUR",
+ "GBP",
+ "CAD",
+ "AUD",
+ "SGD",
+ "ILS",
+ "JPY",
+ "CHF",
+ "HKD"
+ ],
+ "type": "string"
+ },
+ "fees_include_fee_increase_upon_renewal": {
+ "type": "boolean"
+ },
+ "fees_include_fee_increase_upon_renewal_fee": {
+ "type": "number"
+ },
+ "fees_include_fee_increase_upon_renewal_type": {
+ "enum": [
+ "will",
+ "may"
+ ],
+ "type": "string"
+ },
+ "fees_inclusive_of_taxes": {
+ "type": "boolean"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_additional_changes": {
+ "type": "boolean"
+ },
+ "include_license_compliance_verification": {
+ "type": "boolean"
+ },
+ "include_license_compliance_verification_description": {
+ "type": "string"
+ },
+ "include_license_limits": {
+ "type": "boolean"
+ },
+ "include_license_limits_description": {
+ "type": "string"
+ },
+ "include_payment_process_include_billing_email": {
+ "type": "boolean"
+ },
+ "include_pilot_period": {
+ "type": "boolean"
+ },
+ "include_pilot_period_duration_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_pilot_period_duration_type": {
+ "enum": [
+ "day",
+ "week",
+ "month"
+ ],
+ "type": "string"
+ },
+ "include_pilot_period_include_fees": {
+ "type": "boolean"
+ },
+ "include_pilot_period_include_fees_amount": {
+ "type": "number"
+ },
+ "include_pilot_period_include_modifications": {
+ "type": "boolean"
+ },
+ "include_pilot_period_include_modifications_description": {
+ "type": "string"
+ },
+ "include_services": {
+ "type": "boolean"
+ },
+ "include_services_description": {
+ "type": "string"
+ },
+ "negotiations_allowed": {
+ "description": "When true, the recipient can propose changes to the order form, even when the agreement-level `negotiations_allowed` is false. This only covers the order form.",
+ "type": "boolean"
+ },
+ "order_date_date": {
+ "type": "string"
+ },
+ "order_date_type": {
+ "enum": [
+ "signature",
+ "date",
+ "other"
+ ],
+ "type": "string"
+ },
+ "payment_process_automatic_frequency": {
+ "enum": [
+ "monthly",
+ "quarterly",
+ "semiannually",
+ "annually"
+ ],
+ "type": "string"
+ },
+ "payment_process_type": {
+ "enum": [
+ "automatic",
+ "invoice",
+ "custom"
+ ],
+ "type": "string"
+ },
+ "payment_process_type_custom_val": {
+ "type": "string"
+ },
+ "payment_process_type_invoice_amount": {
+ "type": "number"
+ },
+ "payment_process_type_invoice_custom_unit": {
+ "type": "string"
+ },
+ "payment_process_type_invoice_duration": {
+ "enum": [
+ "day",
+ "week",
+ "month",
+ "year",
+ "day(s)",
+ "week(s)",
+ "month(s)",
+ "year(s)"
+ ],
+ "type": "string"
+ },
+ "payment_process_type_invoice_duration_start": {
+ "enum": [
+ "Customer's receipt of invoice",
+ "date of invoice"
+ ],
+ "type": "string"
+ },
+ "payment_process_type_invoice_type": {
+ "enum": [
+ "monthly",
+ "quarterly",
+ "semiannually",
+ "annually",
+ "Custom unit"
+ ],
+ "type": "string"
+ },
+ "permitted_uses_include_custom": {
+ "type": "boolean"
+ },
+ "permitted_uses_include_custom_description": {
+ "type": "string"
+ },
+ "permitted_uses_include_customers_affiliates": {
+ "type": "boolean"
+ },
+ "permitted_uses_include_internal_business": {
+ "type": "boolean"
+ },
+ "pilot_period_stripe_product_id": {
+ "type": "string"
+ },
+ "software_description": {
+ "type": "string"
+ },
+ "subscription_auto_renew": {
+ "enum": [
+ "days",
+ "subscription_end"
+ ],
+ "type": "string"
+ },
+ "subscription_period": {
+ "type": "number"
+ },
+ "subscription_period_unit": {
+ "type": "string"
+ },
+ "subscription_renewal_notice_days": {
+ "type": "number"
+ },
+ "warranty_period_description_amount": {
+ "type": "number"
+ },
+ "warranty_period_description_duration": {
+ "enum": [
+ "day",
+ "week",
+ "month",
+ "year"
+ ],
+ "type": "string"
+ },
+ "warranty_period_description_duration_start": {
+ "enum": [
+ "initial delivery of the Software",
+ "delivery of the Software and each subsequent Update",
+ "the Order Date"
+ ],
+ "type": "string"
+ },
+ "warranty_period_type": {
+ "enum": [
+ "description",
+ "none"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "test_agreement": {
+ "description": "When true, marks the agreement as a test. Test agreements do not count against your monthly limit.",
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "recipient_name",
+ "recipient_email"
+ ],
+ "type": "object"
+ },
+ "cc_users": {
+ "items": {
+ "format": "email",
+ "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "draft": {
+ "description": "When true, the agreement is saved as a draft and not sent to the recipient. Use POST /v1/agreements/{id}/send to send a draft agreement later.",
+ "type": "boolean"
+ },
+ "owner_id": {
+ "description": "User id of the agreement owner (sender).",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "signer_email": {
+ "description": "Email address of the signer from the owner's organization.",
+ "format": "email",
+ "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "template_id": {
+ "description": "UUID of a template from `GET /v1/templates`. Accepts both Common Paper standard templates and uploaded PDF templates (`type` `uploaded_template`).",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ }
+ },
+ "required": [
+ "template_id",
+ "owner_id",
+ "signer_email",
+ "agreement"
+ ],
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "agreement": {
+ "additionalProperties": {},
+ "properties": {
+ "amendment_attributes": {
+ "additionalProperties": false,
+ "description": "Override amendment terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "amended_terms_attributes": {
+ "additionalProperties": {
+ "additionalProperties": false,
+ "properties": {
+ "description": {
+ "type": "string"
+ },
+ "term": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "description": "Amended terms. Use string keys such as \"0\", \"1\".",
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+ },
+ "amendment_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "amendment_date_type": {
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "type": "string"
+ },
+ "framework_terms_type": {
+ "type": "string"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "parent_agreement_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "underlying_agreement_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "underlying_agreement_type": {
+ "type": "string"
+ },
+ "underlying_agreement_val": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "baa_attributes": {
+ "additionalProperties": false,
+ "description": "Override baa terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "aggregation_limitations_permitted": {
+ "type": "boolean"
+ },
+ "aggregation_limitations_permitted_val": {
+ "type": "string"
+ },
+ "breach_notification_unit": {
+ "enum": [
+ "hours",
+ "business days",
+ "calendar days"
+ ],
+ "type": "string"
+ },
+ "breach_notification_val": {
+ "type": "number"
+ },
+ "business_associate_relationship_type": {
+ "enum": [
+ "provider",
+ "company"
+ ],
+ "type": "string"
+ },
+ "deidentification_limitations_include_purpose": {
+ "type": "boolean"
+ },
+ "deidentification_limitations_include_requirements": {
+ "type": "boolean"
+ },
+ "deidentification_limitations_permitted": {
+ "type": "boolean"
+ },
+ "deidentification_limitations_purpose_val": {
+ "type": "string"
+ },
+ "deidentification_limitations_requirements_val": {
+ "type": "string"
+ },
+ "designated_record_set_provider_maintains": {
+ "type": "boolean"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_aggregation_limitations": {
+ "type": "boolean"
+ },
+ "include_deidentification_limitations": {
+ "type": "boolean"
+ },
+ "include_limitations": {
+ "type": "boolean"
+ },
+ "include_offshore_limitations": {
+ "type": "boolean"
+ },
+ "include_subcontract_limitations": {
+ "type": "boolean"
+ },
+ "offshore_limitations_permitted": {
+ "type": "boolean"
+ },
+ "offshore_limitations_permitted_val": {
+ "type": "string"
+ },
+ "subcontract_limitations_include_notice": {
+ "type": "boolean"
+ },
+ "subcontract_limitations_include_permission": {
+ "type": "boolean"
+ },
+ "subcontract_limitations_notice_val": {
+ "type": "string"
+ },
+ "subcontract_limitations_permission_val": {
+ "type": "string"
+ },
+ "subcontract_limitations_permitted": {
+ "type": "boolean"
+ },
+ "underlying_agreement_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "underlying_agreement_type": {
+ "enum": [
+ "internal",
+ "external",
+ "none"
+ ],
+ "type": "string"
+ },
+ "underlying_agreement_val": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "billing_email": {
+ "description": "Email of the billing contact. Used when include_billing_info is true.",
+ "format": "email",
+ "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "billing_name": {
+ "description": "Name of the billing contact. Used when include_billing_info is true.",
+ "type": "string"
+ },
+ "billing_workflow_type": {
+ "description": "The type of billing workflow. Use \"link\" to provide a payment_link_url, or \"stripe\" for Stripe-managed billing.",
+ "enum": [
+ "link",
+ "stripe"
+ ],
+ "type": "string"
+ },
+ "chosen_courts_country": {
+ "description": "The country in which disputes will be resolved.",
+ "type": "string"
+ },
+ "chosen_courts_region": {
+ "description": "The state or region in which disputes will be resolved.",
+ "type": "string"
+ },
+ "csa_attributes": {
+ "additionalProperties": false,
+ "description": "Override csa terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "customer_description": {
+ "type": "string"
+ },
+ "effective_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "effective_date_marketplace": {
+ "enum": [
+ "AWS",
+ "GCP",
+ "Azure"
+ ],
+ "type": "string"
+ },
+ "effective_date_type": {
+ "enum": [
+ "signature",
+ "date",
+ "marketplace_acceptance"
+ ],
+ "type": "string"
+ },
+ "general_cap_amount": {
+ "type": "number"
+ },
+ "general_cap_amount_type": {
+ "enum": [
+ "preceding",
+ "base",
+ "period"
+ ],
+ "type": "string"
+ },
+ "general_cap_period_currency": {
+ "type": "number"
+ },
+ "general_cap_period_qty": {
+ "type": "number"
+ },
+ "general_cap_preceding_amount": {
+ "type": "number"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_acceptable_use_policy": {
+ "type": "boolean"
+ },
+ "include_acceptable_use_policy_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_acceptable_use_policy_location": {
+ "type": "string"
+ },
+ "include_acceptable_use_policy_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_additional_warranties": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_by_customer": {
+ "type": "string"
+ },
+ "include_additional_warranties_by_provider": {
+ "type": "string"
+ },
+ "include_additional_warranties_include_by_customer": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_include_by_provider": {
+ "type": "boolean"
+ },
+ "include_ai_addendum": {
+ "type": "boolean"
+ },
+ "include_ai_addendum_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_covered_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_customer_claims": {
+ "type": "string"
+ },
+ "include_covered_claims_include_customer_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_include_provider_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_provider_claims": {
+ "type": "string"
+ },
+ "include_dpa": {
+ "type": "boolean"
+ },
+ "include_dpa_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_dpa_location": {
+ "type": "string"
+ },
+ "include_dpa_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_increased_cap_amount": {
+ "type": "boolean"
+ },
+ "include_increased_claims": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_confidentiality": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_confidentiality_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_privsec": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_privsec_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_other": {
+ "type": "boolean"
+ },
+ "include_increased_claims_indemnification_obligation": {
+ "type": "boolean"
+ },
+ "include_increased_claims_other": {
+ "type": "string"
+ },
+ "include_insurance_minimums": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_add_customer": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_add_customer_com_gen_liability": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_add_customer_cyber_liability": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_add_customer_errors_omissions": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_additional_information": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_additional_information_text": {
+ "type": "string"
+ },
+ "include_insurance_minimums_cyber_liability_aggregate": {
+ "type": "number"
+ },
+ "include_insurance_minimums_cyber_liability_minimum": {
+ "type": "number"
+ },
+ "include_insurance_minimums_employer_liability_aggregate": {
+ "type": "number"
+ },
+ "include_insurance_minimums_employer_liability_minimum": {
+ "type": "number"
+ },
+ "include_insurance_minimums_general_liability_aggregate": {
+ "type": "number"
+ },
+ "include_insurance_minimums_general_liability_minimum": {
+ "type": "number"
+ },
+ "include_insurance_minimums_include_cyber_liability": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_include_employer_liability": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_include_general_liability": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_include_workers_compensation": {
+ "type": "boolean"
+ },
+ "include_publicity_rights": {
+ "type": "boolean"
+ },
+ "include_publicity_rights_type": {
+ "enum": [
+ "public",
+ "non-public"
+ ],
+ "type": "string"
+ },
+ "include_security_policy": {
+ "type": "boolean"
+ },
+ "include_security_policy_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_security_policy_fedramp_auth": {
+ "type": "boolean"
+ },
+ "include_security_policy_hipaa": {
+ "type": "boolean"
+ },
+ "include_security_policy_hitrust": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_annual_maintenance": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_location": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_other": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_reasonable_efforts": {
+ "type": "boolean"
+ },
+ "include_security_policy_iso27001": {
+ "type": "boolean"
+ },
+ "include_security_policy_location": {
+ "type": "string"
+ },
+ "include_security_policy_other": {
+ "type": "string"
+ },
+ "include_security_policy_pci1": {
+ "type": "boolean"
+ },
+ "include_security_policy_pci2": {
+ "type": "boolean"
+ },
+ "include_security_policy_penetration_testing": {
+ "type": "boolean"
+ },
+ "include_security_policy_soc2": {
+ "type": "boolean"
+ },
+ "include_security_policy_soc2_type2": {
+ "type": "boolean"
+ },
+ "include_security_policy_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_supercap": {
+ "description": "CSA 3.0 renamed `include_increased_cap_amount` to `include_supercap`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_increased_cap_amount`. Sending the other spelling returns a 422.",
+ "type": "boolean"
+ },
+ "include_uncapped_claims": {
+ "description": "CSA 3.0 renamed `include_unlimited_claims` to `include_uncapped_claims`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims`. Sending the other spelling returns a 422.",
+ "type": "boolean"
+ },
+ "include_uncapped_claims_breach_of_confidentiality": {
+ "description": "CSA 3.0 renamed `include_unlimited_claims_breach_of_confidentiality` to `include_uncapped_claims_breach_of_confidentiality`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_breach_of_confidentiality`. Sending the other spelling returns a 422.",
+ "type": "boolean"
+ },
+ "include_uncapped_claims_breach_of_confidentiality_negligence": {
+ "description": "CSA 3.0 renamed `include_unlimited_claims_breach_of_confidentiality_negligence` to `include_uncapped_claims_breach_of_confidentiality_negligence`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_breach_of_confidentiality_negligence`. Sending the other spelling returns a 422.",
+ "type": "boolean"
+ },
+ "include_uncapped_claims_breach_of_privsec": {
+ "description": "CSA 3.0 renamed `include_unlimited_claims_breach_of_privsec` to `include_uncapped_claims_breach_of_privsec`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_breach_of_privsec`. Sending the other spelling returns a 422.",
+ "type": "boolean"
+ },
+ "include_uncapped_claims_breach_of_privsec_negligence": {
+ "description": "CSA 3.0 renamed `include_unlimited_claims_breach_of_privsec_negligence` to `include_uncapped_claims_breach_of_privsec_negligence`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_breach_of_privsec_negligence`. Sending the other spelling returns a 422.",
+ "type": "boolean"
+ },
+ "include_uncapped_claims_include_other": {
+ "description": "CSA 3.0 renamed `include_unlimited_claims_include_other` to `include_uncapped_claims_include_other`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_include_other`. Sending the other spelling returns a 422.",
+ "type": "boolean"
+ },
+ "include_uncapped_claims_indemnification_obligation": {
+ "description": "CSA 3.0 renamed `include_unlimited_claims_indemnification_obligation` to `include_uncapped_claims_indemnification_obligation`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_indemnification_obligation`. Sending the other spelling returns a 422.",
+ "type": "boolean"
+ },
+ "include_uncapped_claims_other": {
+ "description": "CSA 3.0 renamed `include_unlimited_claims_other` to `include_uncapped_claims_other`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_other`. Sending the other spelling returns a 422.",
+ "type": "boolean"
+ },
+ "include_unlimited_claims": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_confidentiality": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_confidentiality_negligence": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_privsec": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_privsec_negligence": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_include_other": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_indemnification_obligation": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_other": {
+ "type": "string"
+ },
+ "increased_cap_amount_currency": {
+ "type": "number"
+ },
+ "increased_cap_amount_period_currency": {
+ "type": "number"
+ },
+ "increased_cap_amount_period_qty": {
+ "type": "number"
+ },
+ "increased_cap_amount_qty": {
+ "type": "number"
+ },
+ "increased_cap_amount_type": {
+ "enum": [
+ "qty",
+ "currency",
+ "period"
+ ],
+ "type": "string"
+ },
+ "provider": {
+ "type": "string"
+ },
+ "supercap_currency": {
+ "description": "CSA 3.0 renamed `increased_cap_amount_currency` to `supercap_currency`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `increased_cap_amount_currency`. Sending the other spelling returns a 422.",
+ "type": "number"
+ },
+ "supercap_period_currency": {
+ "description": "CSA 3.0 renamed `increased_cap_amount_period_currency` to `supercap_period_currency`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `increased_cap_amount_period_currency`. Sending the other spelling returns a 422.",
+ "type": "number"
+ },
+ "supercap_period_qty": {
+ "description": "CSA 3.0 renamed `increased_cap_amount_period_qty` to `supercap_period_qty`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `increased_cap_amount_period_qty`. Sending the other spelling returns a 422.",
+ "type": "number"
+ },
+ "supercap_qty": {
+ "description": "CSA 3.0 renamed `increased_cap_amount_qty` to `supercap_qty`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `increased_cap_amount_qty`. Sending the other spelling returns a 422.",
+ "type": "number"
+ },
+ "supercap_type": {
+ "description": "CSA 3.0 renamed `increased_cap_amount_type` to `supercap_type`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `increased_cap_amount_type`. Sending the other spelling returns a 422.",
+ "type": "number"
+ }
+ },
+ "type": "object"
+ },
+ "csa_order_form_attributes": {
+ "additionalProperties": false,
+ "description": "Override csa order form terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "additional_changes": {
+ "type": "string"
+ },
+ "additional_parameters_or_limitations": {
+ "type": "string"
+ },
+ "affiliates_as_users": {
+ "type": "boolean"
+ },
+ "cloud_service_description": {
+ "type": "string"
+ },
+ "consumption_units": {
+ "type": "string"
+ },
+ "fee_amount": {
+ "type": "number"
+ },
+ "fee_custom_unit": {
+ "type": "string"
+ },
+ "fee_period": {
+ "enum": [
+ "Subscription Period",
+ "month",
+ "year",
+ "User",
+ "Custom unit"
+ ],
+ "type": "string"
+ },
+ "fees_attributes": {
+ "additionalProperties": {
+ "anyOf": [
+ {
+ "additionalProperties": false,
+ "description": "Fees::Flat (fee_type \"flat\"). A fixed recurring fee, e.g. a platform subscription. Set type to \"Fees::Flat\" or fee_type to \"flat\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Fixed amount in the order form's fees_currency, charged per fee_period. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"flat\". Alternative to type.",
+ "enum": [
+ "flat"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Flat\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Flat"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Discount (fee_type \"discount\"). A discount, as a fixed amount or a percentage, applied forever, once, or for a number of months. Set type to \"Fees::Discount\" or fee_type to \"discount\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Discount size: an amount in fees_currency when discount_type is fixed_amount (a plain amount, not cents: 20 means 20.00), or a percentage (e.g. 10 for 10%) when it is percentage.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "discount_duration_amount": {
+ "description": "Number of months the discount applies. Required when discount_duration_type is multiple_months.",
+ "type": "number"
+ },
+ "discount_duration_type": {
+ "description": "How long the discount applies. multiple_months also needs discount_duration_amount.",
+ "enum": [
+ "forever",
+ "once",
+ "multiple_months"
+ ],
+ "type": "string"
+ },
+ "discount_type": {
+ "description": "Whether cost is a currency amount or a percentage.",
+ "enum": [
+ "fixed_amount",
+ "percentage"
+ ],
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"discount\". Alternative to type.",
+ "enum": [
+ "discount"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Discount\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Discount"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Cost (fee_type \"cost\"). A per-unit fee: price per unit times quantity, e.g. seats. Set type to \"Fees::Cost\" or fee_type to \"cost\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Price per unit in fees_currency. The row total is quantity x cost. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"cost\". Alternative to type.",
+ "enum": [
+ "cost"
+ ],
+ "type": "string"
+ },
+ "quantity": {
+ "description": "Number of units.",
+ "type": "number"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Cost\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Cost"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Attachment (fee_type \"attachment\"). A fee described in an uploaded attachment instead of in the table. Set type to \"Fees::Attachment\" or fee_type to \"attachment\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "attachment_id": {
+ "description": "ID of an attachment uploaded with upload-attachment.",
+ "type": "string"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"attachment\". Alternative to type.",
+ "enum": [
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Attachment\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Attachment"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Graduated (fee_type \"graduated\"). Tiered pricing, with the price set per tier in graduated_fee_tiers_attributes. Set type to \"Fees::Graduated\" or fee_type to \"graduated\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"graduated\". Alternative to type.",
+ "enum": [
+ "graduated"
+ ],
+ "type": "string"
+ },
+ "graduated_fee_tiers_attributes": {
+ "additionalProperties": {
+ "additionalProperties": false,
+ "properties": {
+ "flat_price": {
+ "type": "number"
+ },
+ "price_per_unit": {
+ "type": "string"
+ },
+ "upper_limit": {
+ "type": "number"
+ }
+ },
+ "type": "object"
+ },
+ "description": "Graduated fee tiers. Use string keys such as \"0\", \"1\".",
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Graduated\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Graduated"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Included (fee_type \"included\"). An item included at no charge. Set type to \"Fees::Included\" or fee_type to \"included\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"included\". Alternative to type.",
+ "enum": [
+ "included"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Included\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Included"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Metered (fee_type \"metered\"). Usage-based pricing, billed per unit used. Set type to \"Fees::Metered\" or fee_type to \"metered\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Price per unit of usage in fees_currency. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"metered\". Alternative to type.",
+ "enum": [
+ "metered"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Metered\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Metered"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::OneTime (fee_type \"one_time\"). A one-time charge, such as a setup fee. Set type to \"Fees::OneTime\" or fee_type to \"one_time\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "One-time amount in fees_currency, charged once rather than per fee_period. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"one_time\". Alternative to type.",
+ "enum": [
+ "one_time"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::OneTime\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::OneTime"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Text (fee_type \"text\"). A fee term described in free text. Set type to \"Fees::Text\" or fee_type to \"text\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"text\". Alternative to type.",
+ "enum": [
+ "text"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Text\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Text"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ }
+ ]
+ },
+ "description": "Fee table rows, keyed by string index (\"0\", \"1\", ...). Replaces the template's fees when provided. Each row sets type or fee_type to pick the fee class. Amounts are in the order form's fees_currency and, for recurring fees, are charged per fee_period.",
+ "examples": [
+ {
+ "0": {
+ "cost": 2000,
+ "description": "Platform subscription",
+ "type": "Fees::Flat"
+ }
+ },
+ {
+ "0": {
+ "cost": 50,
+ "description": "Seats",
+ "fee_type": "cost",
+ "quantity": 10
+ },
+ "1": {
+ "cost": 10,
+ "description": "Launch discount",
+ "discount_duration_amount": 3,
+ "discount_duration_type": "multiple_months",
+ "discount_type": "percentage",
+ "fee_type": "discount"
+ }
+ }
+ ],
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+ },
+ "fees_currency": {
+ "enum": [
+ "USD",
+ "EUR",
+ "GBP",
+ "CAD",
+ "AUD",
+ "SGD",
+ "ILS",
+ "JPY",
+ "CHF",
+ "HKD"
+ ],
+ "type": "string"
+ },
+ "fees_include_fee_increase_upon_renewal": {
+ "type": "boolean"
+ },
+ "fees_include_fee_increase_upon_renewal_fee": {
+ "type": "number"
+ },
+ "fees_include_fee_increase_upon_renewal_type": {
+ "enum": [
+ "will",
+ "may"
+ ],
+ "type": "string"
+ },
+ "fees_inclusive_of_taxes": {
+ "type": "boolean"
+ },
+ "framework_terms_type": {
+ "enum": [
+ "new",
+ "existing",
+ "description"
+ ],
+ "type": "string"
+ },
+ "free_trial_days": {
+ "type": "number"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_additional_changes": {
+ "type": "boolean"
+ },
+ "include_additional_parameters_or_limitations": {
+ "type": "boolean"
+ },
+ "include_consumption": {
+ "type": "boolean"
+ },
+ "include_fees": {
+ "type": "boolean"
+ },
+ "include_fees_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_fees_include_attachment": {
+ "type": "boolean"
+ },
+ "include_fees_other": {
+ "type": "boolean"
+ },
+ "include_fees_other_val": {
+ "type": "string"
+ },
+ "include_fees_table": {
+ "type": "boolean"
+ },
+ "include_fees_table_period": {
+ "enum": [
+ "Subscription Period",
+ "month",
+ "year",
+ "User"
+ ],
+ "type": "string"
+ },
+ "include_free_trial": {
+ "type": "boolean"
+ },
+ "include_max_users": {
+ "type": "boolean"
+ },
+ "include_pilot_period": {
+ "type": "boolean"
+ },
+ "include_pilot_period_duration_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_pilot_period_duration_type": {
+ "enum": [
+ "day",
+ "week",
+ "month"
+ ],
+ "type": "string"
+ },
+ "include_pilot_period_include_fees": {
+ "type": "boolean"
+ },
+ "include_pilot_period_include_fees_amount": {
+ "type": "number"
+ },
+ "include_pilot_period_include_modifications": {
+ "type": "boolean"
+ },
+ "include_pilot_period_include_modifications_description": {
+ "type": "string"
+ },
+ "include_product_support": {
+ "type": "boolean"
+ },
+ "include_product_support_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_product_support_description": {
+ "type": "string"
+ },
+ "include_product_support_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_professional_services": {
+ "type": "boolean"
+ },
+ "include_professional_services_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_professional_services_custom_name": {
+ "type": "string"
+ },
+ "include_professional_services_description": {
+ "type": "string"
+ },
+ "include_professional_services_end_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "include_professional_services_fees_description": {
+ "type": "string"
+ },
+ "include_professional_services_include_end_date": {
+ "type": "boolean"
+ },
+ "include_professional_services_include_fees_description": {
+ "type": "boolean"
+ },
+ "include_professional_services_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_sla": {
+ "type": "boolean"
+ },
+ "include_sla_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_sla_description": {
+ "type": "string"
+ },
+ "include_sla_include_response_time": {
+ "type": "boolean"
+ },
+ "include_sla_include_response_time_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_sla_include_response_time_credit": {
+ "type": "number"
+ },
+ "include_sla_include_response_time_duration": {
+ "enum": [
+ "hour",
+ "day",
+ "week",
+ "month",
+ "hours"
+ ],
+ "type": "string"
+ },
+ "include_sla_include_response_time_support_channel": {
+ "type": "string"
+ },
+ "include_sla_include_target_uptime": {
+ "type": "boolean"
+ },
+ "include_sla_maintenance_notice": {
+ "type": "boolean"
+ },
+ "include_sla_maintenance_window": {
+ "type": "boolean"
+ },
+ "include_sla_maintenance_window_type": {
+ "enum": [
+ "standard",
+ "none"
+ ],
+ "type": "string"
+ },
+ "include_sla_standard_maintenance_notice_qty": {
+ "type": "number"
+ },
+ "include_sla_standard_maintenance_notice_unit": {
+ "enum": [
+ "hour",
+ "day",
+ "week",
+ "month"
+ ],
+ "type": "string"
+ },
+ "include_sla_standard_maintenance_window_end_time": {
+ "type": "string"
+ },
+ "include_sla_standard_maintenance_window_friday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_monday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_saturday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_start_time": {
+ "type": "string"
+ },
+ "include_sla_standard_maintenance_window_sunday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_thursday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_time_zone": {
+ "type": "string"
+ },
+ "include_sla_standard_maintenance_window_tuesday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_wednesday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_target_uptime": {
+ "type": "number"
+ },
+ "include_sla_type": {
+ "enum": [
+ "description",
+ "standard",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_subscription_start_date": {
+ "type": "boolean"
+ },
+ "include_subscription_start_date_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "include_usage_review": {
+ "type": "boolean"
+ },
+ "include_usage_review_val": {
+ "type": "string"
+ },
+ "include_use_limitations": {
+ "type": "boolean"
+ },
+ "include_use_limitations_val": {
+ "type": "string"
+ },
+ "invoice_period": {
+ "enum": [
+ "monthly",
+ "quarterly",
+ "semiannually",
+ "annually",
+ "Custom unit",
+ "Monthly",
+ "Quarterly",
+ "Semiannually",
+ "Annually"
+ ],
+ "type": "string"
+ },
+ "invoice_period_custom_unit": {
+ "type": "string"
+ },
+ "max_consumption": {
+ "type": "number"
+ },
+ "max_users": {
+ "type": "number"
+ },
+ "negotiations_allowed": {
+ "description": "When true, the recipient can propose changes to the order form, even when the agreement-level `negotiations_allowed` is false. This only covers the order form.",
+ "type": "boolean"
+ },
+ "order_date_date": {
+ "type": "string"
+ },
+ "order_date_other": {
+ "type": "string"
+ },
+ "order_date_type": {
+ "enum": [
+ "signature",
+ "date",
+ "other"
+ ],
+ "type": "string"
+ },
+ "payment_period": {
+ "type": "number"
+ },
+ "payment_period_timeframe": {
+ "enum": [
+ "Customer's receipt of invoice",
+ "date of invoice"
+ ],
+ "type": "string"
+ },
+ "payment_period_unit": {
+ "enum": [
+ "day(s)",
+ "week(s)",
+ "month(s)",
+ "marketplace_acceptance"
+ ],
+ "type": "string"
+ },
+ "payment_process_automatic_frequency": {
+ "enum": [
+ "monthly",
+ "quarterly",
+ "semiannually",
+ "annually"
+ ],
+ "type": "string"
+ },
+ "payment_process_type": {
+ "enum": [
+ "automatic",
+ "invoice",
+ "custom",
+ "marketplace_acceptance"
+ ],
+ "type": "string"
+ },
+ "payment_process_type_custom_val": {
+ "type": "string"
+ },
+ "payment_process_type_invoice_amount": {
+ "type": "number"
+ },
+ "payment_process_type_invoice_custom_unit": {
+ "type": "string"
+ },
+ "payment_process_type_invoice_duration": {
+ "enum": [
+ "day",
+ "week",
+ "month",
+ "year",
+ "day(s)",
+ "week(s)",
+ "month(s)",
+ "year(s)"
+ ],
+ "type": "string"
+ },
+ "payment_process_type_invoice_duration_start": {
+ "enum": [
+ "Customer's receipt of invoice",
+ "date of invoice"
+ ],
+ "type": "string"
+ },
+ "payment_process_type_invoice_type": {
+ "enum": [
+ "monthly",
+ "quarterly",
+ "semiannually",
+ "annually",
+ "Custom unit"
+ ],
+ "type": "string"
+ },
+ "pilot_period_stripe_product_id": {
+ "type": "string"
+ },
+ "service_credits_attributes": {
+ "additionalProperties": {
+ "additionalProperties": false,
+ "properties": {
+ "credit": {
+ "type": "number"
+ },
+ "max": {
+ "type": "number"
+ },
+ "min": {
+ "type": "number"
+ }
+ },
+ "type": "object"
+ },
+ "description": "Service credits. Use string keys such as \"0\", \"1\".",
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+ },
+ "subscription_auto_renew": {
+ "enum": [
+ "days",
+ "subscription_end"
+ ],
+ "type": "string"
+ },
+ "subscription_period": {
+ "type": "number"
+ },
+ "subscription_period_unit": {
+ "type": "string"
+ },
+ "subscription_renewal_notice_days": {
+ "type": "number"
+ },
+ "subscription_start_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "subscription_start_date_type": {
+ "enum": [
+ "effective_date",
+ "date"
+ ],
+ "type": "string"
+ },
+ "underlying_agreement_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "use_limitations_attributes": {
+ "additionalProperties": {
+ "additionalProperties": false,
+ "properties": {
+ "amount": {
+ "type": "number"
+ },
+ "limitation_type": {
+ "type": "string"
+ },
+ "unit": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "description": "Use limitations. Use string keys such as \"0\", \"1\".",
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+ }
+ },
+ "type": "object"
+ },
+ "custom_field_values": {
+ "description": "Values for a custom template's fields, keyed by the field keys defined in the template's YAML definition. Only used when template_id is a custom template. Template defaults fill any fields you omit; a required field with no default and no submitted value returns a 400 naming the field. Values are validated against the field's input type: select and radio values must be one of the field's options, multiselect values are an array of selections each of which must be one of the field's options, number and currency values must be numeric, date values must be YYYY-MM-DD, and email values must be valid addresses. An invalid value returns a 400 naming the field."
+ },
+ "design_partner_attributes": {
+ "additionalProperties": false,
+ "description": "Override design partner terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "customer_description": {
+ "type": "string"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_fees": {
+ "type": "boolean"
+ },
+ "include_fees_amount": {
+ "type": "number"
+ },
+ "include_fees_description": {
+ "type": "string"
+ },
+ "include_fees_pay_by_amount": {
+ "type": "string"
+ },
+ "include_fees_type": {
+ "enum": [
+ "default_language",
+ "description"
+ ],
+ "type": "string"
+ },
+ "include_fees_unit": {
+ "enum": [
+ "month",
+ "quarter",
+ "year",
+ "Term"
+ ],
+ "type": "string"
+ },
+ "include_program_appear_as_customer_private": {
+ "type": "boolean"
+ },
+ "include_program_appear_as_customer_public": {
+ "type": "boolean"
+ },
+ "include_program_case_study": {
+ "type": "boolean"
+ },
+ "include_program_develop_functionality": {
+ "type": "boolean"
+ },
+ "include_program_develop_functionality_val": {
+ "type": "string"
+ },
+ "include_program_discount": {
+ "type": "boolean"
+ },
+ "include_program_discount_amount": {
+ "type": "number"
+ },
+ "include_program_discount_unit": {
+ "enum": [
+ "U.S. Dollars",
+ "percent"
+ ],
+ "type": "string"
+ },
+ "include_program_participation_feedback": {
+ "type": "boolean"
+ },
+ "include_program_participation_feedback_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_program_participation_feedback_unit": {
+ "enum": [
+ "month",
+ "quarter",
+ "year",
+ "Term"
+ ],
+ "type": "string"
+ },
+ "include_program_partner_other": {
+ "type": "boolean"
+ },
+ "include_program_partner_other_val": {
+ "type": "string"
+ },
+ "include_program_provider_other": {
+ "type": "boolean"
+ },
+ "include_program_provider_other_val": {
+ "type": "string"
+ },
+ "include_program_reference": {
+ "type": "boolean"
+ },
+ "product_description": {
+ "type": "string"
+ },
+ "term_amount": {
+ "type": "number"
+ },
+ "term_unit": {
+ "enum": [
+ "day(s)",
+ "week(s)",
+ "month(s)",
+ "quarter(s)",
+ "year(s)"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "district_or_county": {
+ "description": "The district or county for dispute resolution.",
+ "type": "string"
+ },
+ "dpa_attributes": {
+ "additionalProperties": false,
+ "description": "Override dpa terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "approved_subprocessor_type": {
+ "description": "`internal` lists approved subprocessors in the agreement (`subprocessors_attributes`); `external` points to a list published elsewhere.",
+ "enum": [
+ "internal",
+ "external"
+ ],
+ "type": "string"
+ },
+ "cloud_service_product_name": {
+ "type": "string"
+ },
+ "competent_supervisory_authority": {
+ "type": "string"
+ },
+ "customer_description": {
+ "type": "string"
+ },
+ "data_exporter_address_city": {
+ "type": "string"
+ },
+ "data_exporter_address_country": {
+ "type": "string"
+ },
+ "data_exporter_address_state": {
+ "type": "string"
+ },
+ "data_exporter_address_street_address": {
+ "type": "string"
+ },
+ "data_exporter_address_zipcode": {
+ "type": "string"
+ },
+ "data_exporter_contact_details": {
+ "type": "string"
+ },
+ "data_exporter_contact_name": {
+ "type": "string"
+ },
+ "data_exporter_contact_position": {
+ "type": "string"
+ },
+ "data_exporter_role": {
+ "description": "Role of the data exporter. Overwritten to `Controller` when the agreement is created from a template.",
+ "enum": [
+ "Controller",
+ "Processor"
+ ],
+ "type": "string"
+ },
+ "data_importer_address": {
+ "type": "string"
+ },
+ "data_importer_address_city": {
+ "type": "string"
+ },
+ "data_importer_address_country": {
+ "type": "string"
+ },
+ "data_importer_address_state": {
+ "type": "string"
+ },
+ "data_importer_address_street_address": {
+ "type": "string"
+ },
+ "data_importer_address_zipcode": {
+ "type": "string"
+ },
+ "data_importer_contact_details": {
+ "type": "string"
+ },
+ "data_importer_contact_name": {
+ "type": "string"
+ },
+ "data_importer_contact_position": {
+ "type": "string"
+ },
+ "duration_of_processing": {
+ "type": "string"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_covered_claim": {
+ "type": "boolean"
+ },
+ "include_covered_claim_external_val": {
+ "type": "string"
+ },
+ "include_covered_claim_internal_val": {
+ "type": "string"
+ },
+ "include_covered_claim_type": {
+ "description": "Which covered-claim text applies: `internal` uses `include_covered_claim_internal_val`, `external` uses `include_covered_claim_external_val`. Required when `include_covered_claim` is true.",
+ "enum": [
+ "internal",
+ "external"
+ ],
+ "type": "string"
+ },
+ "include_data_subjects_custom": {
+ "type": "boolean"
+ },
+ "include_data_subjects_custom_val": {
+ "type": "string"
+ },
+ "include_data_subjects_employees": {
+ "type": "boolean"
+ },
+ "include_data_subjects_end_users": {
+ "type": "boolean"
+ },
+ "include_external_subprocessor_location": {
+ "type": "string"
+ },
+ "include_frequency_of_transfer_continuous": {
+ "type": "boolean"
+ },
+ "include_frequency_of_transfer_custom": {
+ "type": "boolean"
+ },
+ "include_frequency_of_transfer_custom_val": {
+ "type": "string"
+ },
+ "include_governing_country_eu": {
+ "type": "boolean"
+ },
+ "include_governing_country_eu_val": {
+ "type": "string"
+ },
+ "include_governing_country_uk": {
+ "type": "boolean"
+ },
+ "include_governing_country_uk_val": {
+ "type": "string"
+ },
+ "include_governing_law": {
+ "type": "boolean"
+ },
+ "include_governing_law_country": {
+ "type": "string"
+ },
+ "include_governing_law_state": {
+ "type": "string"
+ },
+ "include_increased_claim_amount": {
+ "description": "Legacy field. Stored but not shown on the DPA; use the `include_liability_cap*` fields instead.",
+ "type": "boolean"
+ },
+ "include_increased_claim_amount_currency": {
+ "description": "Legacy field. Stored but not shown on the DPA; use the `include_liability_cap*` fields instead."
+ },
+ "include_increased_claim_amount_qty": {
+ "description": "Legacy field. Stored but not shown on the DPA; use the `include_liability_cap*` fields instead."
+ },
+ "include_increased_claim_amount_type": {
+ "description": "Legacy field. Stored but not shown on the DPA; use the `include_liability_cap*` fields instead.",
+ "type": "string"
+ },
+ "include_liability_cap": {
+ "type": "boolean"
+ },
+ "include_liability_cap_amount_constant_external": {
+ "type": "string"
+ },
+ "include_liability_cap_amount_constant_internal": {
+ "type": "string"
+ },
+ "include_liability_cap_amount_currency_external": {
+ "description": "Currency amount. Numbers and numeric strings (commas allowed) are both accepted."
+ },
+ "include_liability_cap_amount_currency_internal": {
+ "description": "Currency amount. Numbers and numeric strings (commas allowed) are both accepted."
+ },
+ "include_liability_cap_csa_type": {
+ "description": "Which liability cap values apply: the `_internal` or `_external` amount fields. Required when `include_liability_cap` is true.",
+ "enum": [
+ "internal",
+ "external"
+ ],
+ "type": "string"
+ },
+ "include_personal_data_biographic_info": {
+ "type": "boolean"
+ },
+ "include_personal_data_contact_info": {
+ "type": "boolean"
+ },
+ "include_personal_data_custom": {
+ "type": "boolean"
+ },
+ "include_personal_data_custom_val": {
+ "type": "string"
+ },
+ "include_personal_data_employment_info": {
+ "type": "boolean"
+ },
+ "include_personal_data_financial_info": {
+ "type": "boolean"
+ },
+ "include_personal_data_location": {
+ "type": "boolean"
+ },
+ "include_personal_data_name": {
+ "type": "boolean"
+ },
+ "include_personal_data_transactional_info": {
+ "type": "boolean"
+ },
+ "include_personal_data_user_activity_info": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_custom": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_custom_val": {
+ "type": "string"
+ },
+ "include_processing_purpose_erasing": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_holding": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_protecting": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_receiving": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_returning": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_sharing": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_updating": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_using": {
+ "type": "boolean"
+ },
+ "include_provider_security_contact_address": {
+ "type": "boolean"
+ },
+ "include_provider_security_contact_address_city": {
+ "type": "string"
+ },
+ "include_provider_security_contact_address_country": {
+ "type": "string"
+ },
+ "include_provider_security_contact_address_state": {
+ "type": "string"
+ },
+ "include_provider_security_contact_address_street_address": {
+ "type": "string"
+ },
+ "include_provider_security_contact_address_zipcode": {
+ "type": "string"
+ },
+ "include_provider_security_contact_email": {
+ "type": "boolean"
+ },
+ "include_provider_security_contact_email_val": {
+ "format": "email",
+ "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "include_security_measures_accountability": {
+ "type": "boolean"
+ },
+ "include_security_measures_accountability_val": {
+ "type": "string"
+ },
+ "include_security_measures_certification_or_assurance": {
+ "type": "boolean"
+ },
+ "include_security_measures_certification_or_assurance_val": {
+ "type": "string"
+ },
+ "include_security_measures_confidentiality_integrity": {
+ "type": "boolean"
+ },
+ "include_security_measures_confidentiality_integrity_val": {
+ "type": "string"
+ },
+ "include_security_measures_data_at_rest": {
+ "type": "boolean"
+ },
+ "include_security_measures_data_at_rest_val": {
+ "type": "string"
+ },
+ "include_security_measures_data_minimization": {
+ "type": "boolean"
+ },
+ "include_security_measures_data_minimization_val": {
+ "type": "string"
+ },
+ "include_security_measures_data_quality": {
+ "type": "boolean"
+ },
+ "include_security_measures_data_quality_val": {
+ "type": "string"
+ },
+ "include_security_measures_data_retention": {
+ "type": "boolean"
+ },
+ "include_security_measures_data_retention_val": {
+ "type": "string"
+ },
+ "include_security_measures_data_transmission": {
+ "type": "boolean"
+ },
+ "include_security_measures_data_transmission_val": {
+ "type": "string"
+ },
+ "include_security_measures_event_logging": {
+ "type": "boolean"
+ },
+ "include_security_measures_event_logging_val": {
+ "type": "string"
+ },
+ "include_security_measures_identity_auth": {
+ "type": "boolean"
+ },
+ "include_security_measures_identity_auth_val": {
+ "type": "string"
+ },
+ "include_security_measures_it_security_governance": {
+ "type": "boolean"
+ },
+ "include_security_measures_it_security_governance_val": {
+ "type": "string"
+ },
+ "include_security_measures_physical_security": {
+ "type": "boolean"
+ },
+ "include_security_measures_physical_security_val": {
+ "type": "string"
+ },
+ "include_security_measures_portability_and_erasure": {
+ "type": "boolean"
+ },
+ "include_security_measures_portability_and_erasure_val": {
+ "type": "string"
+ },
+ "include_security_measures_pseudonym_encryption": {
+ "type": "boolean"
+ },
+ "include_security_measures_pseudonym_encryption_val": {
+ "type": "string"
+ },
+ "include_security_measures_restore_data_access": {
+ "type": "boolean"
+ },
+ "include_security_measures_restore_data_access_val": {
+ "type": "string"
+ },
+ "include_security_measures_security_policy": {
+ "type": "boolean"
+ },
+ "include_security_measures_system_configuration": {
+ "type": "boolean"
+ },
+ "include_security_measures_system_configuration_val": {
+ "type": "string"
+ },
+ "include_security_measures_testing_assessment": {
+ "type": "boolean"
+ },
+ "include_security_measures_testing_assessment_val": {
+ "type": "string"
+ },
+ "include_security_policy": {
+ "type": "boolean"
+ },
+ "include_security_policy_fedramp_auth": {
+ "type": "boolean"
+ },
+ "include_security_policy_hipaa": {
+ "type": "boolean"
+ },
+ "include_security_policy_hitrust": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_other": {
+ "type": "boolean"
+ },
+ "include_security_policy_iso27001": {
+ "type": "boolean"
+ },
+ "include_security_policy_other": {
+ "type": "string"
+ },
+ "include_security_policy_pci1": {
+ "type": "boolean"
+ },
+ "include_security_policy_pci2": {
+ "type": "boolean"
+ },
+ "include_security_policy_penetration_testing": {
+ "type": "boolean"
+ },
+ "include_security_policy_soc2": {
+ "type": "boolean"
+ },
+ "include_security_policy_soc2_type2": {
+ "type": "boolean"
+ },
+ "include_sensitive_data_restrictions_custom": {
+ "type": "boolean"
+ },
+ "include_sensitive_data_restrictions_custom_val": {
+ "type": "string"
+ },
+ "include_sensitive_data_restrictions_security_policy": {
+ "type": "boolean"
+ },
+ "include_service_provider_relationship": {
+ "type": "boolean"
+ },
+ "include_special_category_data": {
+ "type": "boolean"
+ },
+ "provider": {
+ "type": "string"
+ },
+ "security_policy_available_at": {
+ "type": "string"
+ },
+ "security_policy_type": {
+ "description": "Where the Security Policy is defined. For `external`, set `security_policy_available_at`.",
+ "enum": [
+ "defined in agreement",
+ "provider service",
+ "external"
+ ],
+ "type": "string"
+ },
+ "subprocessors_attributes": {
+ "additionalProperties": {
+ "additionalProperties": false,
+ "properties": {
+ "_destroy": {
+ "description": "Set to true with `id` to remove that subprocessor.",
+ "type": "boolean"
+ },
+ "country": {
+ "type": "string"
+ },
+ "id": {
+ "description": "ID of an existing subprocessor to update or remove. Omit to add a new subprocessor.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "processing_task": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "description": "Subprocessors, keyed by string index such as \"0\", \"1\". On create these are added to the template's subprocessors. On a draft update, an entry without `id` adds a new subprocessor; pass `id` to change one and `id` with `_destroy: true` to remove one.",
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+ },
+ "underlying_agreement_id": {
+ "description": "ID of the CSA this DPA supplements when `underlying_agreement_type` is `internal`.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "underlying_agreement_type": {
+ "description": "`internal` links a CSA in Common Paper (`underlying_agreement_id`); `external` describes another agreement in `underlying_agreement_val` (required). Omit for none.",
+ "enum": [
+ "internal",
+ "external"
+ ],
+ "type": "string"
+ },
+ "underlying_agreement_val": {
+ "description": "Description of the agreement this DPA supplements. Required when `underlying_agreement_type` is `external`.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "framework_terms_description": {
+ "description": "Custom framework terms description. Only used when framework_terms_type is \"description\".",
+ "type": "string"
+ },
+ "framework_terms_type": {
+ "description": "How framework terms are specified. Use \"new\" for standard terms or \"description\" to provide a custom framework_terms_description.",
+ "enum": [
+ "new",
+ "description"
+ ],
+ "type": "string"
+ },
+ "governing_law_country": {
+ "description": "The country whose laws govern the agreement.",
+ "type": "string"
+ },
+ "governing_law_region": {
+ "description": "The state or region whose laws govern the agreement.",
+ "type": "string"
+ },
+ "include_automated_payment_reminders": {
+ "description": "When true, automatically sends payment reminder emails.",
+ "type": "boolean"
+ },
+ "include_billing_info": {
+ "description": "When true, billing contact information (billing_name, billing_email) is included.",
+ "type": "boolean"
+ },
+ "include_billing_workflow": {
+ "description": "When true, enables a billing workflow after signing.",
+ "type": "boolean"
+ },
+ "include_expiration_date": {
+ "description": "Expiration date in YYYY-MM-DD format. Use when include_expiration_type is \"date\".",
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "include_expiration_days": {
+ "description": "Number of days until the agreement expires. Use when include_expiration_type is \"days\".",
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_expiration_type": {
+ "description": "How to set expiration: \"none\" (default), \"days\" (use include_expiration_days), or \"date\" (use include_expiration_date).",
+ "enum": [
+ "none",
+ "days",
+ "date"
+ ],
+ "type": "string"
+ },
+ "include_terms": {
+ "description": "When true, the standard terms are included with the agreement.",
+ "type": "boolean"
+ },
+ "loi_attributes": {
+ "additionalProperties": false,
+ "description": "Override loi terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "confidentiality_custom": {
+ "type": "string"
+ },
+ "confidentiality_mutual_include_loi": {
+ "type": "boolean"
+ },
+ "confidentiality_nda_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "confidentiality_nda_description": {
+ "type": "string"
+ },
+ "confidentiality_nda_include_loi": {
+ "type": "boolean"
+ },
+ "confidentiality_nda_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "confidentiality_type": {
+ "enum": [
+ "mutual",
+ "nda",
+ "provider",
+ "custom"
+ ],
+ "type": "string"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_custom_details": {
+ "type": "boolean"
+ },
+ "include_custom_details_val": {
+ "type": "string"
+ },
+ "include_fees": {
+ "type": "boolean"
+ },
+ "include_fees_amount": {
+ "type": "number"
+ },
+ "include_fees_amount_duration": {
+ "enum": [
+ "month",
+ "year",
+ "quarter"
+ ],
+ "type": "string"
+ },
+ "include_fees_include_amount": {
+ "type": "boolean"
+ },
+ "include_fees_include_other": {
+ "type": "boolean"
+ },
+ "include_fees_other": {
+ "type": "string"
+ },
+ "include_functionality": {
+ "type": "boolean"
+ },
+ "include_functionality_val": {
+ "type": "string"
+ },
+ "include_launch_date": {
+ "type": "boolean"
+ },
+ "include_launch_date_custom": {
+ "type": "string"
+ },
+ "include_launch_date_date": {
+ "format": "date-time",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$",
+ "type": "string"
+ },
+ "include_launch_date_type": {
+ "enum": [
+ "date",
+ "custom"
+ ],
+ "type": "string"
+ },
+ "product_name": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "manual_send": {
+ "description": "When true, the agreement is marked as manually sent outside the platform.",
+ "type": "boolean"
+ },
+ "message": {
+ "type": "string"
+ },
+ "negotiations_allowed": {
+ "description": "When true, the recipient can propose changes to the legal terms. For agreement types without separate business terms, that covers every term. CSA order forms, PSA statements of work, partnership business terms and software license order forms have their own `negotiations_allowed` flag.",
+ "type": "boolean"
+ },
+ "partnership_attributes": {
+ "additionalProperties": false,
+ "description": "Override partnership terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "effective_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "effective_date_type": {
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "type": "string"
+ },
+ "general_cap_amount_currency_val": {
+ "type": "number"
+ },
+ "general_cap_amount_either_currency": {
+ "type": "number"
+ },
+ "general_cap_amount_either_multiple": {
+ "type": "number"
+ },
+ "general_cap_amount_multiple_val": {
+ "type": "number"
+ },
+ "general_cap_amount_type": {
+ "enum": [
+ "multiple",
+ "currency",
+ "either",
+ "base"
+ ],
+ "type": "string"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_additional_warranties": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_include_company": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_include_company_val": {
+ "type": "string"
+ },
+ "include_additional_warranties_include_partner": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_include_partner_val": {
+ "type": "string"
+ },
+ "include_brand_guidelines": {
+ "type": "boolean"
+ },
+ "include_brand_guidelines_include_company": {
+ "type": "boolean"
+ },
+ "include_brand_guidelines_include_company_val": {
+ "type": "string"
+ },
+ "include_brand_guidelines_include_partner": {
+ "type": "boolean"
+ },
+ "include_brand_guidelines_include_partner_val": {
+ "type": "string"
+ },
+ "include_covered_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_company_claims": {
+ "type": "string"
+ },
+ "include_covered_claims_include_company_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_include_partner_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_partner_claims": {
+ "type": "string"
+ },
+ "include_dpa": {
+ "type": "boolean"
+ },
+ "include_dpa_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_dpa_location": {
+ "type": "string"
+ },
+ "include_dpa_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_increased_cap_amount": {
+ "type": "boolean"
+ },
+ "include_increased_cap_amount_currency": {
+ "type": "number"
+ },
+ "include_increased_cap_amount_either_currency": {
+ "type": "number"
+ },
+ "include_increased_cap_amount_either_multiple": {
+ "type": "string"
+ },
+ "include_increased_cap_amount_multiple": {
+ "type": "string"
+ },
+ "include_increased_cap_amount_type": {
+ "enum": [
+ "multiple",
+ "currency",
+ "either"
+ ],
+ "type": "string"
+ },
+ "include_increased_claims": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_confidentiality": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_confidentiality_misconduct": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_covered_claims": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_misconduct": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_other": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_other_val": {
+ "type": "string"
+ },
+ "include_unlimited_claims": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_confidentiality": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_confidentiality_misconduct": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_covered_claims": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_misconduct": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_other": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_other_val": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "partnership_business_terms_attributes": {
+ "additionalProperties": false,
+ "description": "Override partnership business terms terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "end_date_after_effective_date_amount": {
+ "type": "number"
+ },
+ "end_date_after_effective_date_unit": {
+ "enum": [
+ "month(s)",
+ "quarter(s)",
+ "year(s)"
+ ],
+ "type": "string"
+ },
+ "end_date_date": {
+ "type": "string"
+ },
+ "end_date_type": {
+ "enum": [
+ "date",
+ "effective date"
+ ],
+ "type": "string"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_obligations_company_brand": {
+ "type": "boolean"
+ },
+ "include_obligations_company_promotion": {
+ "type": "boolean"
+ },
+ "include_obligations_company_promotion_include_activities": {
+ "type": "boolean"
+ },
+ "include_obligations_company_promotion_include_activities_val": {
+ "type": "string"
+ },
+ "include_obligations_company_promotion_include_materials": {
+ "type": "boolean"
+ },
+ "include_obligations_company_promotion_include_materials_val": {
+ "type": "string"
+ },
+ "include_obligations_company_referral": {
+ "type": "boolean"
+ },
+ "include_obligations_company_referral_include_criteria": {
+ "type": "boolean"
+ },
+ "include_obligations_company_referral_include_criteria_val": {
+ "type": "string"
+ },
+ "include_obligations_company_referral_include_pay_sch": {
+ "type": "boolean"
+ },
+ "include_obligations_company_referral_include_pay_sch_amount": {
+ "type": "number"
+ },
+ "include_obligations_company_referral_include_pay_sch_custom": {
+ "type": "string"
+ },
+ "include_obligations_company_referral_include_pay_sch_unit": {
+ "enum": [
+ "U.S. Dollars",
+ "percent"
+ ],
+ "type": "string"
+ },
+ "include_obligations_company_sponsorship": {
+ "type": "boolean"
+ },
+ "include_obligations_company_sponsorship_include_benefits": {
+ "type": "boolean"
+ },
+ "include_obligations_company_sponsorship_include_benefits_val": {
+ "type": "string"
+ },
+ "include_obligations_company_sponsorship_include_payments": {
+ "type": "boolean"
+ },
+ "include_obligations_company_sponsorship_include_payments_amount": {
+ "type": "number"
+ },
+ "include_obligations_company_sponsorship_include_payments_unit": {
+ "enum": [
+ "U.S. Dollars",
+ "percent"
+ ],
+ "type": "string"
+ },
+ "include_obligations_partner_brand": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_promotion": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_promotion_include_activities": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_promotion_include_activities_val": {
+ "type": "string"
+ },
+ "include_obligations_partner_promotion_include_materials": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_promotion_include_materials_val": {
+ "type": "string"
+ },
+ "include_obligations_partner_referral": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_referral_include_criteria": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_referral_include_criteria_val": {
+ "type": "string"
+ },
+ "include_obligations_partner_referral_include_pay_sch": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_referral_include_pay_sch_amount": {
+ "type": "number"
+ },
+ "include_obligations_partner_referral_include_pay_sch_custom": {
+ "type": "string"
+ },
+ "include_obligations_partner_referral_include_pay_sch_unit": {
+ "enum": [
+ "U.S. Dollars",
+ "percent"
+ ],
+ "type": "string"
+ },
+ "include_obligations_partner_sponsorship": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_sponsorship_include_benefits": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_sponsorship_include_benefits_val": {
+ "type": "string"
+ },
+ "include_obligations_partner_sponsorship_include_payments": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_sponsorship_include_payments_amount": {
+ "type": "number"
+ },
+ "include_obligations_partner_sponsorship_include_payments_unit": {
+ "enum": [
+ "U.S. Dollars",
+ "percent"
+ ],
+ "type": "string"
+ },
+ "include_payment_process": {
+ "type": "boolean"
+ },
+ "include_payment_process_company": {
+ "type": "boolean"
+ },
+ "include_payment_process_company_include_address": {
+ "type": "boolean"
+ },
+ "include_payment_process_company_include_address_city": {
+ "type": "string"
+ },
+ "include_payment_process_company_include_address_country": {
+ "type": "string"
+ },
+ "include_payment_process_company_include_address_state": {
+ "type": "string"
+ },
+ "include_payment_process_company_include_address_street_address": {
+ "type": "string"
+ },
+ "include_payment_process_company_include_address_zipcode": {
+ "type": "string"
+ },
+ "include_payment_process_company_include_email": {
+ "type": "boolean"
+ },
+ "include_payment_process_company_include_email_val": {
+ "type": "string"
+ },
+ "include_payment_process_partner": {
+ "type": "boolean"
+ },
+ "include_payment_process_partner_include_address": {
+ "type": "boolean"
+ },
+ "include_payment_process_partner_include_address_city": {
+ "type": "string"
+ },
+ "include_payment_process_partner_include_address_country": {
+ "type": "string"
+ },
+ "include_payment_process_partner_include_address_state": {
+ "type": "string"
+ },
+ "include_payment_process_partner_include_address_street_address": {
+ "type": "string"
+ },
+ "include_payment_process_partner_include_address_zipcode": {
+ "type": "string"
+ },
+ "include_payment_process_partner_include_email": {
+ "type": "boolean"
+ },
+ "include_payment_process_partner_include_email_val": {
+ "type": "string"
+ },
+ "include_payment_schedule": {
+ "type": "boolean"
+ },
+ "include_payment_schedule_custom": {
+ "type": "string"
+ },
+ "include_payment_schedule_specified_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_payment_schedule_specified_timeframe": {
+ "enum": [
+ "receipt",
+ "date"
+ ],
+ "type": "string"
+ },
+ "include_payment_schedule_specified_unit": {
+ "enum": [
+ "day(s)",
+ "week(s)",
+ "month(s)",
+ "quarter(s)",
+ "year(s)"
+ ],
+ "type": "string"
+ },
+ "include_payment_schedule_type": {
+ "enum": [
+ "specified",
+ "custom"
+ ],
+ "type": "string"
+ },
+ "negotiations_allowed": {
+ "description": "When true, the recipient can propose changes to the business terms, even when the agreement-level `negotiations_allowed` is false. This only covers the business terms.",
+ "type": "boolean"
+ },
+ "territory_type": {
+ "enum": [
+ "worldwide",
+ "custom"
+ ],
+ "type": "string"
+ },
+ "territory_type_val": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "payment_link_url": {
+ "description": "A payment URL shown to the recipient after signing. Requires include_billing_workflow to be true and billing_workflow_type to be \"link\".",
+ "type": "string"
+ },
+ "pilot_attributes": {
+ "additionalProperties": false,
+ "description": "Override pilot terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "fees_type": {
+ "enum": [
+ "free",
+ "pilot_period_fees"
+ ],
+ "type": "string"
+ },
+ "general_cap_amount": {
+ "type": "number"
+ },
+ "general_cap_amount_type": {
+ "enum": [
+ "preceding",
+ "base",
+ "period"
+ ],
+ "type": "string"
+ },
+ "general_cap_period_currency": {
+ "type": "number"
+ },
+ "general_cap_period_qty": {
+ "type": "number"
+ },
+ "general_cap_preceding_amount": {
+ "type": "number"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_dpa": {
+ "type": "boolean"
+ },
+ "include_dpa_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_dpa_location": {
+ "type": "string"
+ },
+ "include_dpa_type": {
+ "enum": [
+ "description",
+ "attachment",
+ "standard"
+ ],
+ "type": "string"
+ },
+ "include_payment_process": {
+ "type": "boolean"
+ },
+ "include_technical_support": {
+ "type": "boolean"
+ },
+ "payment_process_automatic_frequency": {
+ "enum": [
+ "monthly",
+ "quarterly",
+ "annually",
+ "once_per_period"
+ ],
+ "type": "string"
+ },
+ "payment_process_invoice_days": {
+ "type": "number"
+ },
+ "payment_process_invoice_from": {
+ "enum": [
+ "receipt",
+ "date"
+ ],
+ "type": "string"
+ },
+ "payment_process_invoice_timeframe": {
+ "enum": [
+ "days",
+ "weeks",
+ "months",
+ "quarters",
+ "years"
+ ],
+ "type": "string"
+ },
+ "payment_process_type": {
+ "enum": [
+ "automatic",
+ "invoice"
+ ],
+ "type": "string"
+ },
+ "pilot_period_description": {
+ "type": "string"
+ },
+ "pilot_period_fees_description": {
+ "type": "string"
+ },
+ "product_description": {
+ "type": "string"
+ },
+ "technical_support_description": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "psa_attributes": {
+ "additionalProperties": false,
+ "description": "Override psa terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "additional_changes": {
+ "type": "string"
+ },
+ "customer_description": {
+ "type": "string"
+ },
+ "effective_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "effective_date_type": {
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "type": "string"
+ },
+ "general_cap_amount": {
+ "type": "number"
+ },
+ "general_cap_amount_type": {
+ "enum": [
+ "preceding",
+ "base",
+ "period"
+ ],
+ "type": "string"
+ },
+ "general_cap_period_currency": {
+ "type": "number"
+ },
+ "general_cap_period_qty": {
+ "type": "number"
+ },
+ "general_cap_preceding_amount": {
+ "type": "number"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_additional_changes": {
+ "type": "boolean"
+ },
+ "include_additional_warranties": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_by_customer": {
+ "type": "string"
+ },
+ "include_additional_warranties_by_provider": {
+ "type": "string"
+ },
+ "include_additional_warranties_include_by_customer": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_include_by_provider": {
+ "type": "boolean"
+ },
+ "include_covered_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_customer_claims": {
+ "type": "string"
+ },
+ "include_covered_claims_include_customer_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_include_provider_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_provider_claims": {
+ "type": "string"
+ },
+ "include_customer_insurance_min": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_add_provider_com_gen_liability": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_add_provider_cyber_liability": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_add_provider_errors_omissions": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_auto_liability_aggregate": {
+ "type": "number"
+ },
+ "include_customer_insurance_min_auto_liability_minimum": {
+ "type": "number"
+ },
+ "include_customer_insurance_min_cyber_liability_aggregate": {
+ "type": "number"
+ },
+ "include_customer_insurance_min_cyber_liability_minimum": {
+ "type": "number"
+ },
+ "include_customer_insurance_min_employer_liability_aggregate": {
+ "type": "number"
+ },
+ "include_customer_insurance_min_employer_liability_minimum": {
+ "type": "number"
+ },
+ "include_customer_insurance_min_general_liability_aggregate": {
+ "type": "number"
+ },
+ "include_customer_insurance_min_general_liability_minimum": {
+ "type": "number"
+ },
+ "include_customer_insurance_min_include_add_provider": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_include_auto_liability": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_include_cyber_liability": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_include_employer_liability": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_include_general_liability": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_include_workers_comp": {
+ "type": "boolean"
+ },
+ "include_customer_policies": {
+ "type": "boolean"
+ },
+ "include_customer_policies_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_customer_policies_location": {
+ "type": "string"
+ },
+ "include_customer_policies_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_dpa": {
+ "type": "boolean"
+ },
+ "include_dpa_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_dpa_location": {
+ "type": "string"
+ },
+ "include_dpa_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_increased_cap_amount": {
+ "type": "boolean"
+ },
+ "include_increased_claims": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_confidentiality": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_confidentiality_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_privsec": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_privsec_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_other": {
+ "type": "boolean"
+ },
+ "include_increased_claims_indemnification_obligation": {
+ "type": "boolean"
+ },
+ "include_increased_claims_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_other": {
+ "type": "string"
+ },
+ "include_provider_insurance_min": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_add_customer_com_gen_liability": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_add_customer_cyber_liability": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_add_customer_errors_omissions": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_auto_liability_aggregate": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_auto_liability_minimum": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_cyber_liability_aggregate": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_cyber_liability_minimum": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_employer_liability_aggregate": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_employer_liability_minimum": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_general_liability_aggregate": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_general_liability_minimum": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_include_add_customer": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_include_auto_liability": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_include_cyber_liability": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_include_employer_liability": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_include_general_liability": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_include_workers_comp": {
+ "type": "boolean"
+ },
+ "include_publicity_rights": {
+ "type": "boolean"
+ },
+ "include_publicity_rights_type": {
+ "enum": [
+ "public",
+ "non-public"
+ ],
+ "type": "string"
+ },
+ "include_security_policy": {
+ "type": "boolean"
+ },
+ "include_security_policy_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_security_policy_fedramp_auth": {
+ "type": "boolean"
+ },
+ "include_security_policy_hitrust": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_annual_maintenance": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_other": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_other_val": {
+ "type": "string"
+ },
+ "include_security_policy_iso27001": {
+ "type": "boolean"
+ },
+ "include_security_policy_location": {
+ "type": "string"
+ },
+ "include_security_policy_pci1": {
+ "type": "boolean"
+ },
+ "include_security_policy_pci2": {
+ "type": "boolean"
+ },
+ "include_security_policy_penetration_testing": {
+ "type": "boolean"
+ },
+ "include_security_policy_soc2_type1": {
+ "type": "boolean"
+ },
+ "include_security_policy_soc2_type2": {
+ "type": "boolean"
+ },
+ "include_security_policy_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_unlimited_claims": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_confidentiality": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_confidentiality_negligence": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_privsec": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_privsec_negligence": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_include_other": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_indemnification_obligation": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_negligence": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_other": {
+ "type": "string"
+ },
+ "increased_cap_amount_currency": {
+ "type": "number"
+ },
+ "increased_cap_amount_period_currency": {
+ "type": "number"
+ },
+ "increased_cap_amount_period_qty": {
+ "type": "number"
+ },
+ "increased_cap_amount_qty": {
+ "type": "number"
+ },
+ "increased_cap_amount_type": {
+ "enum": [
+ "qty",
+ "currency",
+ "period"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "psa_statement_of_work_attributes": {
+ "additionalProperties": false,
+ "description": "Override psa statement of work terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "additional_changes": {
+ "type": "string"
+ },
+ "cost": {
+ "type": "number"
+ },
+ "description": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "fees_attributes": {
+ "additionalProperties": {
+ "anyOf": [
+ {
+ "additionalProperties": false,
+ "description": "Fees::Flat (fee_type \"flat\"). A fixed recurring fee, e.g. a platform subscription. Set type to \"Fees::Flat\" or fee_type to \"flat\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Fixed amount in the order form's fees_currency, charged per fee_period. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"flat\". Alternative to type.",
+ "enum": [
+ "flat"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Flat\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Flat"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Discount (fee_type \"discount\"). A discount, as a fixed amount or a percentage, applied forever, once, or for a number of months. Set type to \"Fees::Discount\" or fee_type to \"discount\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Discount size: an amount in fees_currency when discount_type is fixed_amount (a plain amount, not cents: 20 means 20.00), or a percentage (e.g. 10 for 10%) when it is percentage.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "discount_duration_amount": {
+ "description": "Number of months the discount applies. Required when discount_duration_type is multiple_months.",
+ "type": "number"
+ },
+ "discount_duration_type": {
+ "description": "How long the discount applies. multiple_months also needs discount_duration_amount.",
+ "enum": [
+ "forever",
+ "once",
+ "multiple_months"
+ ],
+ "type": "string"
+ },
+ "discount_type": {
+ "description": "Whether cost is a currency amount or a percentage.",
+ "enum": [
+ "fixed_amount",
+ "percentage"
+ ],
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"discount\". Alternative to type.",
+ "enum": [
+ "discount"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Discount\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Discount"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Cost (fee_type \"cost\"). A per-unit fee: price per unit times quantity, e.g. seats. Set type to \"Fees::Cost\" or fee_type to \"cost\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Price per unit in fees_currency. The row total is quantity x cost. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"cost\". Alternative to type.",
+ "enum": [
+ "cost"
+ ],
+ "type": "string"
+ },
+ "quantity": {
+ "description": "Number of units.",
+ "type": "number"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Cost\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Cost"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Attachment (fee_type \"attachment\"). A fee described in an uploaded attachment instead of in the table. Set type to \"Fees::Attachment\" or fee_type to \"attachment\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "attachment_id": {
+ "description": "ID of an attachment uploaded with upload-attachment.",
+ "type": "string"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"attachment\". Alternative to type.",
+ "enum": [
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Attachment\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Attachment"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Graduated (fee_type \"graduated\"). Tiered pricing, with the price set per tier in graduated_fee_tiers_attributes. Set type to \"Fees::Graduated\" or fee_type to \"graduated\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"graduated\". Alternative to type.",
+ "enum": [
+ "graduated"
+ ],
+ "type": "string"
+ },
+ "graduated_fee_tiers_attributes": {
+ "additionalProperties": {
+ "additionalProperties": false,
+ "properties": {
+ "flat_price": {
+ "type": "number"
+ },
+ "price_per_unit": {
+ "type": "string"
+ },
+ "upper_limit": {
+ "type": "number"
+ }
+ },
+ "type": "object"
+ },
+ "description": "Graduated fee tiers. Use string keys such as \"0\", \"1\".",
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Graduated\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Graduated"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Included (fee_type \"included\"). An item included at no charge. Set type to \"Fees::Included\" or fee_type to \"included\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"included\". Alternative to type.",
+ "enum": [
+ "included"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Included\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Included"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Metered (fee_type \"metered\"). Usage-based pricing, billed per unit used. Set type to \"Fees::Metered\" or fee_type to \"metered\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Price per unit of usage in fees_currency. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"metered\". Alternative to type.",
+ "enum": [
+ "metered"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Metered\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Metered"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::OneTime (fee_type \"one_time\"). A one-time charge, such as a setup fee. Set type to \"Fees::OneTime\" or fee_type to \"one_time\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "One-time amount in fees_currency, charged once rather than per fee_period. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"one_time\". Alternative to type.",
+ "enum": [
+ "one_time"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::OneTime\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::OneTime"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Text (fee_type \"text\"). A fee term described in free text. Set type to \"Fees::Text\" or fee_type to \"text\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"text\". Alternative to type.",
+ "enum": [
+ "text"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Text\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Text"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ }
+ ]
+ },
+ "description": "Fee line items. Use string keys such as \"0\", \"1\". Replaces template fees when provided.",
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_additional_changes": {
+ "type": "boolean"
+ },
+ "include_customer_obligation": {
+ "type": "boolean"
+ },
+ "include_customer_obligation_val": {
+ "type": "string"
+ },
+ "include_deliverables": {
+ "type": "boolean"
+ },
+ "include_deliverables_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_deliverables_description": {
+ "type": "string"
+ },
+ "include_deliverables_include_acceptance": {
+ "type": "boolean"
+ },
+ "include_deliverables_include_attachment": {
+ "type": "boolean"
+ },
+ "include_deliverables_include_draft_deliverables": {
+ "type": "boolean"
+ },
+ "include_deliverables_rejection_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_deliverables_rejection_unit": {
+ "enum": [
+ "hours",
+ "days",
+ "weeks",
+ "months"
+ ],
+ "type": "string"
+ },
+ "include_deliverables_resubmission_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_deliverables_resubmission_unit": {
+ "enum": [
+ "hours",
+ "days",
+ "weeks",
+ "months"
+ ],
+ "type": "string"
+ },
+ "include_fees_other": {
+ "type": "boolean"
+ },
+ "include_fees_other_val": {
+ "type": "string"
+ },
+ "include_fees_table": {
+ "type": "boolean"
+ },
+ "include_fees_table_total": {
+ "type": "boolean"
+ },
+ "include_fees_travel": {
+ "type": "boolean"
+ },
+ "include_fees_travel_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_fees_travel_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_fees_travel_val": {
+ "type": "string"
+ },
+ "include_third_party_customer": {
+ "type": "boolean"
+ },
+ "include_third_party_include_description": {
+ "type": "boolean"
+ },
+ "include_third_party_include_description_val": {
+ "type": "string"
+ },
+ "include_third_party_materials": {
+ "type": "boolean"
+ },
+ "include_third_party_provider": {
+ "type": "boolean"
+ },
+ "include_time_of_assignment": {
+ "type": "boolean"
+ },
+ "include_time_of_assignment_type": {
+ "enum": [
+ "created",
+ "paid"
+ ],
+ "type": "string"
+ },
+ "invoice_period_description": {
+ "type": "string"
+ },
+ "negotiations_allowed": {
+ "description": "When true, the recipient can propose changes to the statement of work, even when the agreement-level `negotiations_allowed` is false. This only covers the statement of work.",
+ "type": "boolean"
+ },
+ "payment_period": {
+ "type": "number"
+ },
+ "payment_period_other": {
+ "type": "string"
+ },
+ "payment_period_timeframe": {
+ "enum": [
+ "receipt",
+ "invoice",
+ "Customer's receipt of invoice",
+ "date of invoice"
+ ],
+ "type": "string"
+ },
+ "payment_period_type": {
+ "enum": [
+ "standard",
+ "other"
+ ],
+ "type": "string"
+ },
+ "payment_period_unit": {
+ "enum": [
+ "day(s)",
+ "week(s)",
+ "month(s)",
+ "quarter(s)",
+ "year(s)"
+ ],
+ "type": "string"
+ },
+ "quantity": {
+ "type": "number"
+ },
+ "services_description": {
+ "type": "string"
+ },
+ "sow_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "sow_date_type": {
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "type": "string"
+ },
+ "sow_term_amount": {
+ "type": "number"
+ },
+ "sow_term_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "sow_term_type": {
+ "enum": [
+ "deliverables",
+ "period",
+ "date"
+ ],
+ "type": "string"
+ },
+ "sow_term_unit": {
+ "enum": [
+ "month(s)",
+ "quarter(s)",
+ "year(s)"
+ ],
+ "type": "string"
+ },
+ "type": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "recipient_email": {
+ "format": "email",
+ "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "recipient_name": {
+ "type": "string"
+ },
+ "recipient_notice_email_address": {
+ "description": "Email address for legal notices to the recipient.",
+ "format": "email",
+ "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "recipient_organization": {
+ "type": "string"
+ },
+ "sender_last_to_sign": {
+ "description": "When true, your signer signs after the recipient.",
+ "type": "boolean"
+ },
+ "sender_notice_email_address": {
+ "description": "Email address for legal notices to the sender.",
+ "format": "email",
+ "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "software_license_attributes": {
+ "additionalProperties": false,
+ "description": "Override software license terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "effective_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "effective_date_type": {
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "type": "string"
+ },
+ "general_cap_amount": {
+ "type": "number"
+ },
+ "general_cap_amount_type": {
+ "enum": [
+ "preceding",
+ "base",
+ "period"
+ ],
+ "type": "string"
+ },
+ "general_cap_period_currency": {
+ "type": "number"
+ },
+ "general_cap_period_qty": {
+ "type": "number"
+ },
+ "general_cap_preceding_amount": {
+ "type": "number"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_additional_warranties": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_by_customer": {
+ "type": "string"
+ },
+ "include_additional_warranties_by_provider": {
+ "type": "string"
+ },
+ "include_additional_warranties_include_by_customer": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_include_by_provider": {
+ "type": "boolean"
+ },
+ "include_ai_addendum": {
+ "type": "boolean"
+ },
+ "include_ai_addendum_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_covered_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_customer_claims": {
+ "type": "string"
+ },
+ "include_covered_claims_include_customer_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_include_provider_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_provider_claims": {
+ "type": "string"
+ },
+ "include_dpa": {
+ "type": "boolean"
+ },
+ "include_dpa_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_dpa_location": {
+ "type": "string"
+ },
+ "include_dpa_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_increased_cap_amount": {
+ "type": "boolean"
+ },
+ "include_increased_claims": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_confidentiality": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_confidentiality_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_other": {
+ "type": "boolean"
+ },
+ "include_increased_claims_indemnification_obligation": {
+ "type": "boolean"
+ },
+ "include_increased_claims_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_other": {
+ "type": "string"
+ },
+ "include_increased_claims_restrictions": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_confidentiality": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_confidentiality_negligence": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_include_other": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_indemnification_obligation": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_license_or_restrictions": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_negligence": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_other": {
+ "type": "string"
+ },
+ "increased_cap_amount_currency": {
+ "type": "number"
+ },
+ "increased_cap_amount_period_currency": {
+ "type": "number"
+ },
+ "increased_cap_amount_period_qty": {
+ "type": "number"
+ },
+ "increased_cap_amount_qty": {
+ "type": "number"
+ },
+ "increased_cap_amount_type": {
+ "enum": [
+ "qty",
+ "currency",
+ "period"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "software_license_order_form_attributes": {
+ "additionalProperties": false,
+ "description": "Override software license order form terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "additional_changes": {
+ "type": "string"
+ },
+ "deletion_procedure_include_custom": {
+ "type": "boolean"
+ },
+ "deletion_procedure_include_custom_description": {
+ "type": "string"
+ },
+ "deletion_procedure_include_customer_disable": {
+ "type": "boolean"
+ },
+ "deletion_procedure_include_customer_proof": {
+ "type": "boolean"
+ },
+ "deletion_procedure_include_provider_disable": {
+ "type": "boolean"
+ },
+ "fee_custom_unit": {
+ "type": "string"
+ },
+ "fee_period": {
+ "enum": [
+ "Subscription Period",
+ "month",
+ "year",
+ "Custom unit"
+ ],
+ "type": "string"
+ },
+ "fees_attributes": {
+ "additionalProperties": {
+ "anyOf": [
+ {
+ "additionalProperties": false,
+ "description": "Fees::Flat (fee_type \"flat\"). A fixed recurring fee, e.g. a platform subscription. Set type to \"Fees::Flat\" or fee_type to \"flat\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Fixed amount in the order form's fees_currency, charged per fee_period. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"flat\". Alternative to type.",
+ "enum": [
+ "flat"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Flat\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Flat"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Discount (fee_type \"discount\"). A discount, as a fixed amount or a percentage, applied forever, once, or for a number of months. Set type to \"Fees::Discount\" or fee_type to \"discount\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Discount size: an amount in fees_currency when discount_type is fixed_amount (a plain amount, not cents: 20 means 20.00), or a percentage (e.g. 10 for 10%) when it is percentage.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "discount_duration_amount": {
+ "description": "Number of months the discount applies. Required when discount_duration_type is multiple_months.",
+ "type": "number"
+ },
+ "discount_duration_type": {
+ "description": "How long the discount applies. multiple_months also needs discount_duration_amount.",
+ "enum": [
+ "forever",
+ "once",
+ "multiple_months"
+ ],
+ "type": "string"
+ },
+ "discount_type": {
+ "description": "Whether cost is a currency amount or a percentage.",
+ "enum": [
+ "fixed_amount",
+ "percentage"
+ ],
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"discount\". Alternative to type.",
+ "enum": [
+ "discount"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Discount\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Discount"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Cost (fee_type \"cost\"). A per-unit fee: price per unit times quantity, e.g. seats. Set type to \"Fees::Cost\" or fee_type to \"cost\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Price per unit in fees_currency. The row total is quantity x cost. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"cost\". Alternative to type.",
+ "enum": [
+ "cost"
+ ],
+ "type": "string"
+ },
+ "quantity": {
+ "description": "Number of units.",
+ "type": "number"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Cost\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Cost"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Attachment (fee_type \"attachment\"). A fee described in an uploaded attachment instead of in the table. Set type to \"Fees::Attachment\" or fee_type to \"attachment\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "attachment_id": {
+ "description": "ID of an attachment uploaded with upload-attachment.",
+ "type": "string"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"attachment\". Alternative to type.",
+ "enum": [
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Attachment\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Attachment"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Graduated (fee_type \"graduated\"). Tiered pricing, with the price set per tier in graduated_fee_tiers_attributes. Set type to \"Fees::Graduated\" or fee_type to \"graduated\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"graduated\". Alternative to type.",
+ "enum": [
+ "graduated"
+ ],
+ "type": "string"
+ },
+ "graduated_fee_tiers_attributes": {
+ "additionalProperties": {
+ "additionalProperties": false,
+ "properties": {
+ "flat_price": {
+ "type": "number"
+ },
+ "price_per_unit": {
+ "type": "string"
+ },
+ "upper_limit": {
+ "type": "number"
+ }
+ },
+ "type": "object"
+ },
+ "description": "Graduated fee tiers. Use string keys such as \"0\", \"1\".",
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Graduated\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Graduated"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Included (fee_type \"included\"). An item included at no charge. Set type to \"Fees::Included\" or fee_type to \"included\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"included\". Alternative to type.",
+ "enum": [
+ "included"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Included\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Included"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Metered (fee_type \"metered\"). Usage-based pricing, billed per unit used. Set type to \"Fees::Metered\" or fee_type to \"metered\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Price per unit of usage in fees_currency. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"metered\". Alternative to type.",
+ "enum": [
+ "metered"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Metered\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Metered"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::OneTime (fee_type \"one_time\"). A one-time charge, such as a setup fee. Set type to \"Fees::OneTime\" or fee_type to \"one_time\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "One-time amount in fees_currency, charged once rather than per fee_period. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"one_time\". Alternative to type.",
+ "enum": [
+ "one_time"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::OneTime\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::OneTime"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Text (fee_type \"text\"). A fee term described in free text. Set type to \"Fees::Text\" or fee_type to \"text\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"text\". Alternative to type.",
+ "enum": [
+ "text"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Text\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Text"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ }
+ ]
+ },
+ "description": "Fee line items. Use string keys such as \"0\", \"1\". Replaces template fees when provided.",
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+ },
+ "fees_currency": {
+ "enum": [
+ "USD",
+ "EUR",
+ "GBP",
+ "CAD",
+ "AUD",
+ "SGD",
+ "ILS",
+ "JPY",
+ "CHF",
+ "HKD"
+ ],
+ "type": "string"
+ },
+ "fees_include_fee_increase_upon_renewal": {
+ "type": "boolean"
+ },
+ "fees_include_fee_increase_upon_renewal_fee": {
+ "type": "number"
+ },
+ "fees_include_fee_increase_upon_renewal_type": {
+ "enum": [
+ "will",
+ "may"
+ ],
+ "type": "string"
+ },
+ "fees_inclusive_of_taxes": {
+ "type": "boolean"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_additional_changes": {
+ "type": "boolean"
+ },
+ "include_license_compliance_verification": {
+ "type": "boolean"
+ },
+ "include_license_compliance_verification_description": {
+ "type": "string"
+ },
+ "include_license_limits": {
+ "type": "boolean"
+ },
+ "include_license_limits_description": {
+ "type": "string"
+ },
+ "include_payment_process_include_billing_email": {
+ "type": "boolean"
+ },
+ "include_pilot_period": {
+ "type": "boolean"
+ },
+ "include_pilot_period_duration_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_pilot_period_duration_type": {
+ "enum": [
+ "day",
+ "week",
+ "month"
+ ],
+ "type": "string"
+ },
+ "include_pilot_period_include_fees": {
+ "type": "boolean"
+ },
+ "include_pilot_period_include_fees_amount": {
+ "type": "number"
+ },
+ "include_pilot_period_include_modifications": {
+ "type": "boolean"
+ },
+ "include_pilot_period_include_modifications_description": {
+ "type": "string"
+ },
+ "include_services": {
+ "type": "boolean"
+ },
+ "include_services_description": {
+ "type": "string"
+ },
+ "negotiations_allowed": {
+ "description": "When true, the recipient can propose changes to the order form, even when the agreement-level `negotiations_allowed` is false. This only covers the order form.",
+ "type": "boolean"
+ },
+ "order_date_date": {
+ "type": "string"
+ },
+ "order_date_type": {
+ "enum": [
+ "signature",
+ "date",
+ "other"
+ ],
+ "type": "string"
+ },
+ "payment_process_automatic_frequency": {
+ "enum": [
+ "monthly",
+ "quarterly",
+ "semiannually",
+ "annually"
+ ],
+ "type": "string"
+ },
+ "payment_process_type": {
+ "enum": [
+ "automatic",
+ "invoice",
+ "custom"
+ ],
+ "type": "string"
+ },
+ "payment_process_type_custom_val": {
+ "type": "string"
+ },
+ "payment_process_type_invoice_amount": {
+ "type": "number"
+ },
+ "payment_process_type_invoice_custom_unit": {
+ "type": "string"
+ },
+ "payment_process_type_invoice_duration": {
+ "enum": [
+ "day",
+ "week",
+ "month",
+ "year",
+ "day(s)",
+ "week(s)",
+ "month(s)",
+ "year(s)"
+ ],
+ "type": "string"
+ },
+ "payment_process_type_invoice_duration_start": {
+ "enum": [
+ "Customer's receipt of invoice",
+ "date of invoice"
+ ],
+ "type": "string"
+ },
+ "payment_process_type_invoice_type": {
+ "enum": [
+ "monthly",
+ "quarterly",
+ "semiannually",
+ "annually",
+ "Custom unit"
+ ],
+ "type": "string"
+ },
+ "permitted_uses_include_custom": {
+ "type": "boolean"
+ },
+ "permitted_uses_include_custom_description": {
+ "type": "string"
+ },
+ "permitted_uses_include_customers_affiliates": {
+ "type": "boolean"
+ },
+ "permitted_uses_include_internal_business": {
+ "type": "boolean"
+ },
+ "pilot_period_stripe_product_id": {
+ "type": "string"
+ },
+ "software_description": {
+ "type": "string"
+ },
+ "subscription_auto_renew": {
+ "enum": [
+ "days",
+ "subscription_end"
+ ],
+ "type": "string"
+ },
+ "subscription_period": {
+ "type": "number"
+ },
+ "subscription_period_unit": {
+ "type": "string"
+ },
+ "subscription_renewal_notice_days": {
+ "type": "number"
+ },
+ "warranty_period_description_amount": {
+ "type": "number"
+ },
+ "warranty_period_description_duration": {
+ "enum": [
+ "day",
+ "week",
+ "month",
+ "year"
+ ],
+ "type": "string"
+ },
+ "warranty_period_description_duration_start": {
+ "enum": [
+ "initial delivery of the Software",
+ "delivery of the Software and each subsequent Update",
+ "the Order Date"
+ ],
+ "type": "string"
+ },
+ "warranty_period_type": {
+ "enum": [
+ "description",
+ "none"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "test_agreement": {
+ "description": "When true, marks the agreement as a test. Test agreements do not count against your monthly limit.",
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "recipient_name",
+ "recipient_email"
+ ],
+ "type": "object"
+ },
+ "cc_users": {
+ "items": {
+ "format": "email",
+ "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "draft": {
+ "description": "When true, the agreement is saved as a draft and not sent to the recipient. Use POST /v1/agreements/{id}/send to send a draft agreement later.",
+ "type": "boolean"
+ },
+ "owner_id": {
+ "description": "User id of the agreement owner (sender).",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "signer_id": {
+ "description": "User id of the signer from the owner's organization.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "template_id": {
+ "description": "UUID of a template from `GET /v1/templates`. Accepts both Common Paper standard templates and uploaded PDF templates (`type` `uploaded_template`).",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ }
+ },
+ "required": [
+ "template_id",
+ "owner_id",
+ "signer_id",
+ "agreement"
+ ],
+ "type": "object"
+ }
+]create-custom-template1 field changedInput schema / properties / body / properties / user_email / patternPrevious value: -"^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"New value: +"^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"create-custom-template-version1 field changedInput schema / properties / body / properties / user_email / patternPrevious value: -"^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"New value: +"^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"create-custom-term_application_json1 field changedInput schema / properties / body / properties / user_email / patternPrevious value: -"^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"New value: +"^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"create-custom-term-version_application_json1 field changedInput schema / properties / body / properties / user_email / patternPrevious value: -"^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"New value: +"^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"create-invitation2 fields changedInput schema / properties / body / properties / invitation / properties / email / patternPrevious value: -"^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"New value: +"^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"Input schema / properties / body / properties / invitation / properties / inviter_email / patternPrevious value: -"^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"New value: +"^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"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": {
- "enum": [
- "signature",
- "date"
- ],
- "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.",
- "enum": [
- "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": {
- "enum": [
- "stripe",
- "link"
- ],
- "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": {
- "enum": [
- "AWS",
- "GCP",
- "Azure"
- ],
- "type": "string"
- },
- "effective_date_type": {
- "enum": [
- "signature",
- "date",
- "marketplace_acceptance"
- ],
- "type": "string"
- },
- "general_cap_amount": {
- "type": "number"
- },
- "general_cap_amount_type": {
- "enum": [
- "preceding",
- "base",
- "period"
- ],
- "type": "string"
- },
- "general_cap_period_currency": {
- "type": "number"
- },
- "general_cap_period_qty": {
- "type": "number"
- },
- "general_cap_preceding_amount": {
- "type": "number"
- },
- "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": {
- "enum": [
- "description",
- "attachment"
- ],
- "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": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_increased_cap_amount": {
- "type": "boolean"
- },
- "include_increased_claims": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_confidentiality": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_confidentiality_negligence": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_privsec": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_privsec_negligence": {
- "type": "boolean"
- },
- "include_increased_claims_include_other": {
- "type": "boolean"
- },
- "include_increased_claims_indemnification_obligation": {
- "type": "boolean"
- },
- "include_increased_claims_other": {
- "type": "string"
- },
- "include_insurance_minimums": {
- "type": "boolean"
- },
- "include_insurance_minimums_add_customer": {
- "type": "boolean"
- },
- "include_insurance_minimums_add_customer_com_gen_liability": {
- "type": "boolean"
- },
- "include_insurance_minimums_add_customer_cyber_liability": {
- "type": "boolean"
- },
- "include_insurance_minimums_add_customer_errors_omissions": {
- "type": "boolean"
- },
- "include_insurance_minimums_additional_information": {
- "type": "boolean"
- },
- "include_insurance_minimums_additional_information_text": {
- "type": "string"
- },
- "include_insurance_minimums_cyber_liability_aggregate": {
- "type": "number"
- },
- "include_insurance_minimums_cyber_liability_minimum": {
- "type": "number"
- },
- "include_insurance_minimums_employer_liability_aggregate": {
- "type": "number"
- },
- "include_insurance_minimums_employer_liability_minimum": {
- "type": "number"
- },
- "include_insurance_minimums_general_liability_aggregate": {
- "type": "number"
- },
- "include_insurance_minimums_general_liability_minimum": {
- "type": "number"
- },
- "include_insurance_minimums_include_cyber_liability": {
- "type": "boolean"
- },
- "include_insurance_minimums_include_employer_liability": {
- "type": "boolean"
- },
- "include_insurance_minimums_include_general_liability": {
- "type": "boolean"
- },
- "include_insurance_minimums_include_workers_compensation": {
- "type": "boolean"
- },
- "include_publicity_rights": {
- "type": "boolean"
- },
- "include_publicity_rights_type": {
- "enum": [
- "public",
- "non-public"
- ],
- "type": "string"
- },
- "include_security_policy": {
- "type": "boolean"
- },
- "include_security_policy_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_security_policy_fedramp_auth": {
- "type": "boolean"
- },
- "include_security_policy_hipaa": {
- "type": "boolean"
- },
- "include_security_policy_hitrust": {
- "type": "boolean"
- },
- "include_security_policy_include_annual_maintenance": {
- "type": "boolean"
- },
- "include_security_policy_include_location": {
- "type": "boolean"
- },
- "include_security_policy_include_other": {
- "type": "boolean"
- },
- "include_security_policy_include_reasonable_efforts": {
- "type": "boolean"
- },
- "include_security_policy_iso27001": {
- "type": "boolean"
- },
- "include_security_policy_location": {
- "type": "string"
- },
- "include_security_policy_other": {
- "type": "string"
- },
- "include_security_policy_pci1": {
- "type": "boolean"
- },
- "include_security_policy_pci2": {
- "type": "boolean"
- },
- "include_security_policy_penetration_testing": {
- "type": "boolean"
- },
- "include_security_policy_soc2": {
- "type": "boolean"
- },
- "include_security_policy_soc2_type2": {
- "type": "boolean"
- },
- "include_security_policy_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_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": {
- "type": "number"
- },
- "increased_cap_amount_qty": {
- "type": "number"
- },
- "increased_cap_amount_type": {
- "enum": [
- "qty",
- "currency",
- "period"
- ],
- "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": {
- "enum": [
- "automatic",
- "invoice"
- ],
- "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": {
- "enum": [
- "Subscription Period",
- "month",
- "year",
- "User",
- "Custom unit"
- ],
- "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": {
- "enum": [
- "USD",
- "EUR",
- "GBP",
- "CAD",
- "AUD",
- "SGD",
- "ILS",
- "JPY",
- "CHF",
- "HKD"
- ],
- "type": "string"
- },
- "fees_include_fee_increase_upon_renewal": {
- "type": "boolean"
- },
- "fees_include_fee_increase_upon_renewal_fee": {
- "type": "number"
- },
- "fees_include_fee_increase_upon_renewal_type": {
- "enum": [
- "will",
- "may"
- ],
- "type": "string"
- },
- "fees_inclusive_of_taxes": {
- "type": "boolean"
- },
- "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": {
- "enum": [
- "Subscription Period",
- "month",
- "year",
- "User"
- ],
- "type": "string"
- },
- "include_free_trial": {
- "type": "boolean"
- },
- "include_max_users": {
- "type": "boolean"
- },
- "include_pilot_period": {
- "type": "boolean"
- },
- "include_pilot_period_duration_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_pilot_period_duration_type": {
- "enum": [
- "day",
- "week",
- "month"
- ],
- "type": "string"
- },
- "include_pilot_period_include_fees": {
- "type": "boolean"
- },
- "include_pilot_period_include_fees_amount": {
- "type": "number"
- },
- "include_pilot_period_include_modifications": {
- "type": "boolean"
- },
- "include_pilot_period_include_modifications_description": {
- "type": "string"
- },
- "include_product_support": {
- "type": "boolean"
- },
- "include_product_support_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_product_support_description": {
- "type": "string"
- },
- "include_product_support_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_professional_services": {
- "type": "boolean"
- },
- "include_professional_services_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_professional_services_custom_name": {
- "type": "string"
- },
- "include_professional_services_description": {
- "type": "string"
- },
- "include_professional_services_end_date": {
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "include_professional_services_fees_description": {
- "type": "string"
- },
- "include_professional_services_include_end_date": {
- "type": "boolean"
- },
- "include_professional_services_include_fees_description": {
- "type": "boolean"
- },
- "include_professional_services_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_sla": {
- "type": "boolean"
- },
- "include_sla_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_sla_description": {
- "type": "string"
- },
- "include_sla_include_response_time": {
- "type": "boolean"
- },
- "include_sla_include_response_time_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_sla_include_response_time_credit": {
- "type": "number"
- },
- "include_sla_include_response_time_duration": {
- "enum": [
- "hour",
- "day",
- "week",
- "month",
- "hours"
- ],
- "type": "string"
- },
- "include_sla_include_response_time_support_channel": {
- "type": "string"
- },
- "include_sla_include_target_uptime": {
- "type": "boolean"
- },
- "include_sla_maintenance_notice": {
- "type": "boolean"
- },
- "include_sla_maintenance_window": {
- "type": "boolean"
- },
- "include_sla_maintenance_window_type": {
- "enum": [
- "standard",
- "none"
- ],
- "type": "string"
- },
- "include_sla_standard_maintenance_notice_qty": {
- "type": "number"
- },
- "include_sla_standard_maintenance_notice_unit": {
- "enum": [
- "hour",
- "day",
- "week",
- "month"
- ],
- "type": "string"
- },
- "include_sla_standard_maintenance_window_end_time": {
- "type": "string"
- },
- "include_sla_standard_maintenance_window_friday": {
- "type": "boolean"
- },
- "include_sla_standard_maintenance_window_monday": {
- "type": "boolean"
- },
- "include_sla_standard_maintenance_window_saturday": {
- "type": "boolean"
- },
- "include_sla_standard_maintenance_window_start_time": {
- "type": "string"
- },
- "include_sla_standard_maintenance_window_sunday": {
- "type": "boolean"
- },
- "include_sla_standard_maintenance_window_thursday": {
- "type": "boolean"
- },
- "include_sla_standard_maintenance_window_time_zone": {
- "type": "string"
- },
- "include_sla_standard_maintenance_window_tuesday": {
- "type": "boolean"
- },
- "include_sla_standard_maintenance_window_wednesday": {
- "type": "boolean"
- },
- "include_sla_standard_target_uptime": {
- "type": "number"
- },
- "include_sla_type": {
- "enum": [
- "description",
- "standard",
- "attachment"
- ],
- "type": "string"
- },
- "include_subscription_start_date": {
- "type": "boolean"
- },
- "include_subscription_start_date_date": {
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "include_usage_review": {
- "type": "boolean"
- },
- "include_usage_review_val": {
- "type": "string"
- },
- "include_use_limitations": {
- "type": "boolean"
- },
- "include_use_limitations_val": {
- "type": "string"
- },
- "invoice_period": {
- "enum": [
- "monthly",
- "quarterly",
- "semiannually",
- "annually",
- "Custom unit",
- "Monthly",
- "Quarterly",
- "Semiannually",
- "Annually"
- ],
- "type": "string"
- },
- "invoice_period_custom_unit": {
- "type": "string"
- },
- "max_consumption": {
- "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": {
- "enum": [
- "signature",
- "date",
- "other"
- ],
- "type": "string"
- },
- "payment_period": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "payment_period_timeframe": {
- "enum": [
- "Customer's receipt of invoice",
- "date of invoice"
- ],
- "type": "string"
- },
- "payment_period_unit": {
- "enum": [
- "day(s)",
- "week(s)",
- "month(s)",
- "marketplace_acceptance"
- ],
- "type": "string"
- },
- "payment_process_automatic_frequency": {
- "enum": [
- "monthly",
- "quarterly",
- "semiannually",
- "annually"
- ],
- "type": "string"
- },
- "payment_process_type": {
- "enum": [
- "automatic",
- "invoice",
- "custom",
- "marketplace_acceptance"
- ],
- "type": "string"
- },
- "payment_process_type_custom_val": {
- "type": "string"
- },
- "payment_process_type_invoice_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "payment_process_type_invoice_custom_unit": {
- "type": "string"
- },
- "payment_process_type_invoice_duration": {
- "enum": [
- "day",
- "week",
- "month",
- "year",
- "day(s)",
- "week(s)",
- "month(s)",
- "year(s)"
- ],
- "type": "string"
- },
- "payment_process_type_invoice_duration_start": {
- "enum": [
- "Customer's receipt of invoice",
- "date of invoice"
- ],
- "type": "string"
- },
- "payment_process_type_invoice_type": {
- "enum": [
- "monthly",
- "quarterly",
- "semiannually",
- "annually",
- "Custom unit"
- ],
- "type": "string"
- },
- "pilot_period_stripe_product_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-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": {
- "enum": [
- "days",
- "subscription_end"
- ],
- "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": {
- "enum": [
- "effective_date",
- "date"
- ],
- "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.",
- "enum": [
- "CSA"
- ],
- "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.",
- "enum": [
- "DPA"
- ],
- "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": {
- "enum": [
- "signature",
- "date"
- ],
- "type": "string"
- },
- "general_cap_amount": {
- "type": "number"
- },
- "general_cap_amount_type": {
- "enum": [
- "preceding",
- "base",
- "period"
- ],
- "type": "string"
- },
- "general_cap_period_currency": {
- "type": "number"
- },
- "general_cap_period_qty": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "general_cap_preceding_amount": {
- "type": "number"
- },
- "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": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_dpa": {
- "type": "boolean"
- },
- "include_dpa_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_dpa_location": {
- "type": "string"
- },
- "include_dpa_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_increased_cap_amount": {
- "type": "boolean"
- },
- "include_increased_claims": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_confidentiality": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_confidentiality_negligence": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_privsec": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_privsec_negligence": {
- "type": "boolean"
- },
- "include_increased_claims_include_other": {
- "type": "boolean"
- },
- "include_increased_claims_indemnification_obligation": {
- "type": "boolean"
- },
- "include_increased_claims_negligence": {
- "type": "boolean"
- },
- "include_increased_claims_other": {
- "type": "string"
- },
- "include_provider_insurance_min": {
- "type": "boolean"
- },
- "include_provider_insurance_min_add_customer_com_gen_liability": {
- "type": "boolean"
- },
- "include_provider_insurance_min_add_customer_cyber_liability": {
- "type": "boolean"
- },
- "include_provider_insurance_min_add_customer_errors_omissions": {
- "type": "boolean"
- },
- "include_provider_insurance_min_auto_liability_aggregate": {
- "type": "number"
- },
- "include_provider_insurance_min_auto_liability_minimum": {
- "type": "number"
- },
- "include_provider_insurance_min_cyber_liability_aggregate": {
- "type": "number"
- },
- "include_provider_insurance_min_cyber_liability_minimum": {
- "type": "number"
- },
- "include_provider_insurance_min_employer_liability_aggregate": {
- "type": "number"
- },
- "include_provider_insurance_min_employer_liability_minimum": {
- "type": "number"
- },
- "include_provider_insurance_min_general_liability_aggregate": {
- "type": "number"
- },
- "include_provider_insurance_min_general_liability_minimum": {
- "type": "number"
- },
- "include_provider_insurance_min_include_add_customer": {
- "type": "boolean"
- },
- "include_provider_insurance_min_include_auto_liability": {
- "type": "boolean"
- },
- "include_provider_insurance_min_include_cyber_liability": {
- "type": "boolean"
- },
- "include_provider_insurance_min_include_employer_liability": {
- "type": "boolean"
- },
- "include_provider_insurance_min_include_general_liability": {
- "type": "boolean"
- },
- "include_provider_insurance_min_include_workers_comp": {
- "type": "boolean"
- },
- "include_publicity_rights": {
- "type": "boolean"
- },
- "include_publicity_rights_type": {
- "enum": [
- "public",
- "non-public"
- ],
- "type": "string"
- },
- "include_security_policy": {
- "type": "boolean"
- },
- "include_security_policy_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_security_policy_fedramp_auth": {
- "type": "boolean"
- },
- "include_security_policy_hitrust": {
- "type": "boolean"
- },
- "include_security_policy_include_annual_maintenance": {
- "type": "boolean"
- },
- "include_security_policy_include_other": {
- "type": "boolean"
- },
- "include_security_policy_include_other_val": {
- "type": "string"
- },
- "include_security_policy_iso27001": {
- "type": "boolean"
- },
- "include_security_policy_location": {
- "type": "string"
- },
- "include_security_policy_pci1": {
- "type": "boolean"
- },
- "include_security_policy_pci2": {
- "type": "boolean"
- },
- "include_security_policy_penetration_testing": {
- "type": "boolean"
- },
- "include_security_policy_soc2_type1": {
- "type": "boolean"
- },
- "include_security_policy_soc2_type2": {
- "type": "boolean"
- },
- "include_security_policy_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_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": {
- "enum": [
- "qty",
- "currency",
- "period"
- ],
- "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": {
- "enum": [
- "hours",
- "days",
- "weeks",
- "months"
- ],
- "type": "string"
- },
- "include_deliverables_resubmission_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_deliverables_resubmission_unit": {
- "enum": [
- "hours",
- "days",
- "weeks",
- "months"
- ],
- "type": "string"
- },
- "include_fees_other": {
- "type": "boolean"
- },
- "include_fees_other_val": {
- "type": "string"
- },
- "include_fees_table": {
- "type": "boolean"
- },
- "include_fees_table_total": {
- "type": "boolean"
- },
- "include_fees_travel": {
- "type": "boolean"
- },
- "include_fees_travel_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_fees_travel_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_fees_travel_val": {
- "type": "string"
- },
- "include_third_party_customer": {
- "type": "boolean"
- },
- "include_third_party_include_description": {
- "type": "boolean"
- },
- "include_third_party_include_description_val": {
- "type": "string"
- },
- "include_third_party_materials": {
- "type": "boolean"
- },
- "include_third_party_provider": {
- "type": "boolean"
- },
- "include_time_of_assignment": {
- "type": "boolean"
- },
- "include_time_of_assignment_type": {
- "enum": [
- "created",
- "paid"
- ],
- "type": "string"
- },
- "invoice_period_description": {
- "type": "string"
- },
- "negotiations_allowed": {
- "description": "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": {
- "enum": [
- "receipt",
- "invoice",
- "Customer's receipt of invoice",
- "date of invoice"
- ],
- "type": "string"
- },
- "payment_period_type": {
- "enum": [
- "standard",
- "other"
- ],
- "type": "string"
- },
- "payment_period_unit": {
- "enum": [
- "day(s)",
- "week(s)",
- "month(s)",
- "quarter(s)",
- "year(s)"
- ],
- "type": "string"
- },
- "services_description": {
- "type": "string"
- },
- "sow_date": {
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "sow_date_type": {
- "enum": [
- "signature",
- "date"
- ],
- "type": "string"
- },
- "sow_term_amount": {
- "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": {
- "enum": [
- "deliverables",
- "period",
- "date"
- ],
- "type": "string"
- },
- "sow_term_unit": {
- "enum": [
- "month(s)",
- "quarter(s)",
- "year(s)"
- ],
- "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.",
- "enum": [
- "PSA"
- ],
- "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": {
- "enum": [
- "signature",
- "date"
- ],
- "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": {
- "enum": [
- "default_language",
- "description"
- ],
- "type": "string"
- },
- "include_fees_unit": {
- "enum": [
- "month",
- "quarter",
- "year",
- "Term"
- ],
- "type": "string"
- },
- "include_program_appear_as_customer_private": {
- "type": "boolean"
- },
- "include_program_appear_as_customer_public": {
- "type": "boolean"
- },
- "include_program_case_study": {
- "type": "boolean"
- },
- "include_program_develop_functionality": {
- "type": "boolean"
- },
- "include_program_develop_functionality_val": {
- "type": "string"
- },
- "include_program_discount": {
- "type": "boolean"
- },
- "include_program_discount_amount": {
- "type": "number"
- },
- "include_program_discount_unit": {
- "enum": [
- "U.S. Dollars",
- "percent"
- ],
- "type": "string"
- },
- "include_program_participation_feedback": {
- "type": "boolean"
- },
- "include_program_participation_feedback_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_program_participation_feedback_unit": {
- "enum": [
- "month",
- "quarter",
- "year",
- "Term"
- ],
- "type": "string"
- },
- "include_program_partner_other": {
- "type": "boolean"
- },
- "include_program_partner_other_val": {
- "type": "string"
- },
- "include_program_provider_other": {
- "type": "boolean"
- },
- "include_program_provider_other_val": {
- "type": "string"
- },
- "include_program_reference": {
- "type": "boolean"
- },
- "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": {
- "enum": [
- "day(s)",
- "week(s)",
- "month(s)",
- "quarter(s)",
- "year(s)"
- ],
- "type": "string"
- },
- "type": {
- "description": "The type of template to create.",
- "enum": [
- "Design"
- ],
- "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": {
- "enum": [
- "stripe",
- "link"
- ],
- "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": {
- "enum": [
- "signature",
- "date"
- ],
- "type": "string"
- },
- "general_cap_amount": {
- "type": "number"
- },
- "general_cap_amount_type": {
- "enum": [
- "preceding",
- "base",
- "period"
- ],
- "type": "string"
- },
- "general_cap_period_currency": {
- "type": "number"
- },
- "general_cap_period_qty": {
- "type": "number"
- },
- "general_cap_preceding_amount": {
- "type": "number"
- },
- "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": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_increased_cap_amount": {
- "type": "boolean"
- },
- "include_increased_claims": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_confidentiality": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_confidentiality_negligence": {
- "type": "boolean"
- },
- "include_increased_claims_include_other": {
- "type": "boolean"
- },
- "include_increased_claims_indemnification_obligation": {
- "type": "boolean"
- },
- "include_increased_claims_negligence": {
- "type": "boolean"
- },
- "include_increased_claims_other": {
- "type": "string"
- },
- "include_increased_claims_restrictions": {
- "type": "boolean"
- },
- "include_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": {
- "enum": [
- "qty",
- "currency",
- "period"
- ],
- "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": {
- "enum": [
- "automatic",
- "manual"
- ],
- "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": {
- "enum": [
- "automatic",
- "invoice"
- ],
- "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": {
- "enum": [
- "Subscription Period",
- "month",
- "year",
- "Custom unit"
- ],
- "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": {
- "enum": [
- "USD",
- "EUR",
- "GBP",
- "CAD",
- "AUD",
- "SGD",
- "ILS",
- "JPY",
- "CHF",
- "HKD"
- ],
- "type": "string"
- },
- "fees_include_fee_increase_upon_renewal": {
- "type": "boolean"
- },
- "fees_include_fee_increase_upon_renewal_fee": {
- "type": "number"
- },
- "fees_include_fee_increase_upon_renewal_type": {
- "enum": [
- "will",
- "may"
- ],
- "type": "string"
- },
- "fees_inclusive_of_taxes": {
- "type": "boolean"
- },
- "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": {
- "enum": [
- "day",
- "week",
- "month"
- ],
- "type": "string"
- },
- "include_pilot_period_include_fees": {
- "type": "boolean"
- },
- "include_pilot_period_include_fees_amount": {
- "type": "number"
- },
- "include_pilot_period_include_modifications": {
- "type": "boolean"
- },
- "include_pilot_period_include_modifications_description": {
- "type": "string"
- },
- "include_services": {
- "type": "boolean"
- },
- "include_services_description": {
- "type": "string"
- },
- "negotiations_allowed": {
- "description": "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": {
- "enum": [
- "signature",
- "date",
- "other"
- ],
- "type": "string"
- },
- "payment_process_automatic_frequency": {
- "enum": [
- "monthly",
- "quarterly",
- "semiannually",
- "annually"
- ],
- "type": "string"
- },
- "payment_process_type": {
- "enum": [
- "automatic",
- "invoice",
- "custom"
- ],
- "type": "string"
- },
- "payment_process_type_custom_val": {
- "type": "string"
- },
- "payment_process_type_invoice_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "payment_process_type_invoice_custom_unit": {
- "type": "string"
- },
- "payment_process_type_invoice_duration": {
- "enum": [
- "day",
- "week",
- "month",
- "year",
- "day(s)",
- "week(s)",
- "month(s)",
- "year(s)"
- ],
- "type": "string"
- },
- "payment_process_type_invoice_duration_start": {
- "enum": [
- "Customer's receipt of invoice",
- "date of invoice"
- ],
- "type": "string"
- },
- "payment_process_type_invoice_type": {
- "enum": [
- "monthly",
- "quarterly",
- "semiannually",
- "annually",
- "Custom unit"
- ],
- "type": "string"
- },
- "permitted_uses_include_custom": {
- "type": "boolean"
- },
- "permitted_uses_include_custom_description": {
- "type": "string"
- },
- "permitted_uses_include_customers_affiliates": {
- "type": "boolean"
- },
- "permitted_uses_include_internal_business": {
- "type": "boolean"
- },
- "pilot_period_stripe_product_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-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": {
- "enum": [
- "days",
- "subscription_end"
- ],
- "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": {
- "enum": [
- "day",
- "week",
- "month",
- "year"
- ],
- "type": "string"
- },
- "warranty_period_description_duration_start": {
- "enum": [
- "initial delivery of the Software",
- "delivery of the Software and each subsequent Update",
- "the Order Date"
- ],
- "type": "string"
- },
- "warranty_period_type": {
- "enum": [
- "description",
- "none"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- "type": {
- "description": "The type of template to create.",
- "enum": [
- "Software License"
- ],
- "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": {
- "enum": [
- "signature",
- "date"
- ],
- "type": "string"
- },
- "fees_type": {
- "enum": [
- "free",
- "pilot_period_fees"
- ],
- "type": "string"
- },
- "general_cap_amount": {
- "type": "number"
- },
- "general_cap_amount_type": {
- "enum": [
- "preceding",
- "base",
- "period"
- ],
- "type": "string"
- },
- "general_cap_period_currency": {
- "type": "number"
- },
- "general_cap_period_qty": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "general_cap_preceding_amount": {
- "type": "number"
- },
- "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": {
- "enum": [
- "description",
- "attachment",
- "standard"
- ],
- "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": {
- "enum": [
- "monthly",
- "quarterly",
- "annually",
- "once_per_period"
- ],
- "type": "string"
- },
- "payment_process_invoice_days": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "payment_process_invoice_from": {
- "enum": [
- "receipt",
- "date"
- ],
- "type": "string"
- },
- "payment_process_invoice_timeframe": {
- "enum": [
- "days",
- "weeks",
- "months",
- "quarters",
- "years"
- ],
- "type": "string"
- },
- "payment_process_type": {
- "enum": [
- "automatic",
- "invoice"
- ],
- "type": "string"
- },
- "pilot_period_description": {
- "type": "string"
- },
- "pilot_period_fees_description": {
- "type": "string"
- },
- "product_description": {
- "type": "string"
- },
- "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.",
- "enum": [
- "Pilot"
- ],
- "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": {
- "enum": [
- "signature",
- "date"
- ],
- "type": "string"
- },
- "general_cap_amount_currency_val": {
- "type": "number"
- },
- "general_cap_amount_either_currency": {
- "type": "number"
- },
- "general_cap_amount_either_multiple": {
- "type": "number"
- },
- "general_cap_amount_multiple_val": {
- "type": "number"
- },
- "general_cap_amount_type": {
- "enum": [
- "multiple",
- "currency",
- "either",
- "base"
- ],
- "type": "string"
- },
- "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": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_increased_cap_amount": {
- "type": "boolean"
- },
- "include_increased_cap_amount_currency": {
- "type": "number"
- },
- "include_increased_cap_amount_either_currency": {
- "type": "number"
- },
- "include_increased_cap_amount_either_multiple": {},
- "include_increased_cap_amount_multiple": {},
- "include_increased_cap_amount_type": {
- "enum": [
- "multiple",
- "currency",
- "either"
- ],
- "type": "string"
- },
- "include_increased_claims": {
- "type": "boolean"
- },
- "include_increased_claims_include_confidentiality": {
- "type": "boolean"
- },
- "include_increased_claims_include_confidentiality_misconduct": {
- "type": "boolean"
- },
- "include_increased_claims_include_covered_claims": {
- "type": "boolean"
- },
- "include_increased_claims_include_misconduct": {
- "type": "boolean"
- },
- "include_increased_claims_include_other": {
- "type": "boolean"
- },
- "include_increased_claims_include_other_val": {
- "type": "string"
- },
- "include_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": {
- "enum": [
- "month(s)",
- "quarter(s)",
- "year(s)"
- ],
- "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": {
- "enum": [
- "date",
- "effective date"
- ],
- "type": "string"
- },
- "include_obligations_company_brand": {
- "type": "boolean"
- },
- "include_obligations_company_promotion": {
- "type": "boolean"
- },
- "include_obligations_company_promotion_include_activities": {
- "type": "boolean"
- },
- "include_obligations_company_promotion_include_activities_val": {
- "type": "string"
- },
- "include_obligations_company_promotion_include_materials": {
- "type": "boolean"
- },
- "include_obligations_company_promotion_include_materials_val": {
- "type": "string"
- },
- "include_obligations_company_referral": {
- "type": "boolean"
- },
- "include_obligations_company_referral_include_criteria": {
- "type": "boolean"
- },
- "include_obligations_company_referral_include_criteria_val": {
- "type": "string"
- },
- "include_obligations_company_referral_include_pay_sch": {
- "type": "boolean"
- },
- "include_obligations_company_referral_include_pay_sch_amount": {
- "type": "number"
- },
- "include_obligations_company_referral_include_pay_sch_custom": {
- "type": "string"
- },
- "include_obligations_company_referral_include_pay_sch_unit": {
- "enum": [
- "U.S. Dollars",
- "percent"
- ],
- "type": "string"
- },
- "include_obligations_company_sponsorship": {
- "type": "boolean"
- },
- "include_obligations_company_sponsorship_include_benefits": {
- "type": "boolean"
- },
- "include_obligations_company_sponsorship_include_benefits_val": {
- "type": "string"
- },
- "include_obligations_company_sponsorship_include_payments": {
- "type": "boolean"
- },
- "include_obligations_company_sponsorship_include_payments_amount": {
- "type": "number"
- },
- "include_obligations_company_sponsorship_include_payments_unit": {
- "enum": [
- "U.S. Dollars",
- "percent"
- ],
- "type": "string"
- },
- "include_obligations_partner_brand": {
- "type": "boolean"
- },
- "include_obligations_partner_promotion": {
- "type": "boolean"
- },
- "include_obligations_partner_promotion_include_activities": {
- "type": "boolean"
- },
- "include_obligations_partner_promotion_include_activities_val": {
- "type": "string"
- },
- "include_obligations_partner_promotion_include_materials": {
- "type": "boolean"
- },
- "include_obligations_partner_promotion_include_materials_val": {
- "type": "string"
- },
- "include_obligations_partner_referral": {
- "type": "boolean"
- },
- "include_obligations_partner_referral_include_criteria": {
- "type": "boolean"
- },
- "include_obligations_partner_referral_include_criteria_val": {
- "type": "string"
- },
- "include_obligations_partner_referral_include_pay_sch": {
- "type": "boolean"
- },
- "include_obligations_partner_referral_include_pay_sch_amount": {
- "type": "number"
- },
- "include_obligations_partner_referral_include_pay_sch_custom": {
- "type": "string"
- },
- "include_obligations_partner_referral_include_pay_sch_unit": {
- "enum": [
- "U.S. Dollars",
- "percent"
- ],
- "type": "string"
- },
- "include_obligations_partner_sponsorship": {
- "type": "boolean"
- },
- "include_obligations_partner_sponsorship_include_benefits": {
- "type": "boolean"
- },
- "include_obligations_partner_sponsorship_include_benefits_val": {
- "type": "string"
- },
- "include_obligations_partner_sponsorship_include_payments": {
- "type": "boolean"
- },
- "include_obligations_partner_sponsorship_include_payments_amount": {
- "type": "number"
- },
- "include_obligations_partner_sponsorship_include_payments_unit": {
- "enum": [
- "U.S. Dollars",
- "percent"
- ],
- "type": "string"
- },
- "include_payment_process": {
- "type": "boolean"
- },
- "include_payment_process_company": {
- "type": "boolean"
- },
- "include_payment_process_company_include_address": {
- "type": "boolean"
- },
- "include_payment_process_company_include_address_city": {
- "type": "string"
- },
- "include_payment_process_company_include_address_country": {
- "type": "string"
- },
- "include_payment_process_company_include_address_state": {
- "type": "string"
- },
- "include_payment_process_company_include_address_street_address": {
- "type": "string"
- },
- "include_payment_process_company_include_address_zipcode": {
- "type": "string"
- },
- "include_payment_process_company_include_email": {
- "type": "boolean"
- },
- "include_payment_process_company_include_email_val": {
- "format": "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": {
- "enum": [
- "receipt",
- "date"
- ],
- "type": "string"
- },
- "include_payment_schedule_specified_unit": {
- "enum": [
- "day(s)",
- "week(s)",
- "month(s)",
- "quarter(s)",
- "year(s)"
- ],
- "type": "string"
- },
- "include_payment_schedule_type": {
- "enum": [
- "specified",
- "custom"
- ],
- "type": "string"
- },
- "negotiations_allowed": {
- "description": "Whether counterparties can propose changes to agreements created from this template.",
- "type": "boolean"
- },
- "territory_type": {
- "enum": [
- "worldwide",
- "custom"
- ],
- "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.",
- "enum": [
- "Partnership"
- ],
- "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": {
- "enum": [
- "hours",
- "business days",
- "calendar days"
- ],
- "type": "string"
- },
- "breach_notification_val": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "business_associate_relationship_type": {
- "enum": [
- "provider",
- "company"
- ],
- "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": {
- "enum": [
- "signature",
- "date"
- ],
- "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.",
- "enum": [
- "BAA"
- ],
- "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": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "confidentiality_type": {
- "enum": [
- "mutual",
- "nda",
- "provider",
- "custom"
- ],
- "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": {
- "enum": [
- "month",
- "year",
- "quarter"
- ],
- "type": "string"
- },
- "include_fees_include_amount": {
- "type": "boolean"
- },
- "include_fees_include_other": {
- "type": "boolean"
- },
- "include_fees_other": {
- "type": "string"
- },
- "include_functionality": {
- "type": "boolean"
- },
- "include_functionality_val": {
- "type": "string"
- },
- "include_launch_date": {
- "type": "boolean"
- },
- "include_launch_date_custom": {
- "type": "string"
- },
- "include_launch_date_date": {
- "format": "date-time",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$",
- "type": "string"
- },
- "include_launch_date_type": {
- "enum": [
- "date",
- "custom"
- ],
- "type": "string"
- },
- "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.",
- "enum": [
- "LOI"
- ],
- "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-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": {
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "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.",
+ "enum": [
+ "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": {
+ "enum": [
+ "stripe",
+ "link"
+ ],
+ "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-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": {
+ "enum": [
+ "AWS",
+ "GCP",
+ "Azure"
+ ],
+ "type": "string"
+ },
+ "effective_date_type": {
+ "enum": [
+ "signature",
+ "date",
+ "marketplace_acceptance"
+ ],
+ "type": "string"
+ },
+ "general_cap_amount": {
+ "type": "number"
+ },
+ "general_cap_amount_type": {
+ "enum": [
+ "preceding",
+ "base",
+ "period"
+ ],
+ "type": "string"
+ },
+ "general_cap_period_currency": {
+ "type": "number"
+ },
+ "general_cap_period_qty": {
+ "type": "number"
+ },
+ "general_cap_preceding_amount": {
+ "type": "number"
+ },
+ "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": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "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": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_increased_cap_amount": {
+ "type": "boolean"
+ },
+ "include_increased_claims": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_confidentiality": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_confidentiality_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_privsec": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_privsec_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_other": {
+ "type": "boolean"
+ },
+ "include_increased_claims_indemnification_obligation": {
+ "type": "boolean"
+ },
+ "include_increased_claims_other": {
+ "type": "string"
+ },
+ "include_insurance_minimums": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_add_customer": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_add_customer_com_gen_liability": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_add_customer_cyber_liability": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_add_customer_errors_omissions": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_additional_information": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_additional_information_text": {
+ "type": "string"
+ },
+ "include_insurance_minimums_cyber_liability_aggregate": {
+ "type": "number"
+ },
+ "include_insurance_minimums_cyber_liability_minimum": {
+ "type": "number"
+ },
+ "include_insurance_minimums_employer_liability_aggregate": {
+ "type": "number"
+ },
+ "include_insurance_minimums_employer_liability_minimum": {
+ "type": "number"
+ },
+ "include_insurance_minimums_general_liability_aggregate": {
+ "type": "number"
+ },
+ "include_insurance_minimums_general_liability_minimum": {
+ "type": "number"
+ },
+ "include_insurance_minimums_include_cyber_liability": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_include_employer_liability": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_include_general_liability": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_include_workers_compensation": {
+ "type": "boolean"
+ },
+ "include_publicity_rights": {
+ "type": "boolean"
+ },
+ "include_publicity_rights_type": {
+ "enum": [
+ "public",
+ "non-public"
+ ],
+ "type": "string"
+ },
+ "include_security_policy": {
+ "type": "boolean"
+ },
+ "include_security_policy_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_security_policy_fedramp_auth": {
+ "type": "boolean"
+ },
+ "include_security_policy_hipaa": {
+ "type": "boolean"
+ },
+ "include_security_policy_hitrust": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_annual_maintenance": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_location": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_other": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_reasonable_efforts": {
+ "type": "boolean"
+ },
+ "include_security_policy_iso27001": {
+ "type": "boolean"
+ },
+ "include_security_policy_location": {
+ "type": "string"
+ },
+ "include_security_policy_other": {
+ "type": "string"
+ },
+ "include_security_policy_pci1": {
+ "type": "boolean"
+ },
+ "include_security_policy_pci2": {
+ "type": "boolean"
+ },
+ "include_security_policy_penetration_testing": {
+ "type": "boolean"
+ },
+ "include_security_policy_soc2": {
+ "type": "boolean"
+ },
+ "include_security_policy_soc2_type2": {
+ "type": "boolean"
+ },
+ "include_security_policy_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_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": {
+ "type": "number"
+ },
+ "increased_cap_amount_qty": {
+ "type": "number"
+ },
+ "increased_cap_amount_type": {
+ "enum": [
+ "qty",
+ "currency",
+ "period"
+ ],
+ "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": {
+ "enum": [
+ "automatic",
+ "invoice"
+ ],
+ "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": {
+ "enum": [
+ "Subscription Period",
+ "month",
+ "year",
+ "User",
+ "Custom unit"
+ ],
+ "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": {
+ "enum": [
+ "USD",
+ "EUR",
+ "GBP",
+ "CAD",
+ "AUD",
+ "SGD",
+ "ILS",
+ "JPY",
+ "CHF",
+ "HKD"
+ ],
+ "type": "string"
+ },
+ "fees_include_fee_increase_upon_renewal": {
+ "type": "boolean"
+ },
+ "fees_include_fee_increase_upon_renewal_fee": {
+ "type": "number"
+ },
+ "fees_include_fee_increase_upon_renewal_type": {
+ "enum": [
+ "will",
+ "may"
+ ],
+ "type": "string"
+ },
+ "fees_inclusive_of_taxes": {
+ "type": "boolean"
+ },
+ "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": {
+ "enum": [
+ "Subscription Period",
+ "month",
+ "year",
+ "User"
+ ],
+ "type": "string"
+ },
+ "include_free_trial": {
+ "type": "boolean"
+ },
+ "include_max_users": {
+ "type": "boolean"
+ },
+ "include_pilot_period": {
+ "type": "boolean"
+ },
+ "include_pilot_period_duration_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_pilot_period_duration_type": {
+ "enum": [
+ "day",
+ "week",
+ "month"
+ ],
+ "type": "string"
+ },
+ "include_pilot_period_include_fees": {
+ "type": "boolean"
+ },
+ "include_pilot_period_include_fees_amount": {
+ "type": "number"
+ },
+ "include_pilot_period_include_modifications": {
+ "type": "boolean"
+ },
+ "include_pilot_period_include_modifications_description": {
+ "type": "string"
+ },
+ "include_product_support": {
+ "type": "boolean"
+ },
+ "include_product_support_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_product_support_description": {
+ "type": "string"
+ },
+ "include_product_support_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_professional_services": {
+ "type": "boolean"
+ },
+ "include_professional_services_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_professional_services_custom_name": {
+ "type": "string"
+ },
+ "include_professional_services_description": {
+ "type": "string"
+ },
+ "include_professional_services_end_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "include_professional_services_fees_description": {
+ "type": "string"
+ },
+ "include_professional_services_include_end_date": {
+ "type": "boolean"
+ },
+ "include_professional_services_include_fees_description": {
+ "type": "boolean"
+ },
+ "include_professional_services_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_sla": {
+ "type": "boolean"
+ },
+ "include_sla_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_sla_description": {
+ "type": "string"
+ },
+ "include_sla_include_response_time": {
+ "type": "boolean"
+ },
+ "include_sla_include_response_time_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_sla_include_response_time_credit": {
+ "type": "number"
+ },
+ "include_sla_include_response_time_duration": {
+ "enum": [
+ "hour",
+ "day",
+ "week",
+ "month",
+ "hours"
+ ],
+ "type": "string"
+ },
+ "include_sla_include_response_time_support_channel": {
+ "type": "string"
+ },
+ "include_sla_include_target_uptime": {
+ "type": "boolean"
+ },
+ "include_sla_maintenance_notice": {
+ "type": "boolean"
+ },
+ "include_sla_maintenance_window": {
+ "type": "boolean"
+ },
+ "include_sla_maintenance_window_type": {
+ "enum": [
+ "standard",
+ "none"
+ ],
+ "type": "string"
+ },
+ "include_sla_standard_maintenance_notice_qty": {
+ "type": "number"
+ },
+ "include_sla_standard_maintenance_notice_unit": {
+ "enum": [
+ "hour",
+ "day",
+ "week",
+ "month"
+ ],
+ "type": "string"
+ },
+ "include_sla_standard_maintenance_window_end_time": {
+ "type": "string"
+ },
+ "include_sla_standard_maintenance_window_friday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_monday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_saturday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_start_time": {
+ "type": "string"
+ },
+ "include_sla_standard_maintenance_window_sunday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_thursday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_time_zone": {
+ "type": "string"
+ },
+ "include_sla_standard_maintenance_window_tuesday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_wednesday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_target_uptime": {
+ "type": "number"
+ },
+ "include_sla_type": {
+ "enum": [
+ "description",
+ "standard",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_subscription_start_date": {
+ "type": "boolean"
+ },
+ "include_subscription_start_date_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "include_usage_review": {
+ "type": "boolean"
+ },
+ "include_usage_review_val": {
+ "type": "string"
+ },
+ "include_use_limitations": {
+ "type": "boolean"
+ },
+ "include_use_limitations_val": {
+ "type": "string"
+ },
+ "invoice_period": {
+ "enum": [
+ "monthly",
+ "quarterly",
+ "semiannually",
+ "annually",
+ "Custom unit",
+ "Monthly",
+ "Quarterly",
+ "Semiannually",
+ "Annually"
+ ],
+ "type": "string"
+ },
+ "invoice_period_custom_unit": {
+ "type": "string"
+ },
+ "max_consumption": {
+ "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": {
+ "enum": [
+ "signature",
+ "date",
+ "other"
+ ],
+ "type": "string"
+ },
+ "payment_period": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "payment_period_timeframe": {
+ "enum": [
+ "Customer's receipt of invoice",
+ "date of invoice"
+ ],
+ "type": "string"
+ },
+ "payment_period_unit": {
+ "enum": [
+ "day(s)",
+ "week(s)",
+ "month(s)",
+ "marketplace_acceptance"
+ ],
+ "type": "string"
+ },
+ "payment_process_automatic_frequency": {
+ "enum": [
+ "monthly",
+ "quarterly",
+ "semiannually",
+ "annually"
+ ],
+ "type": "string"
+ },
+ "payment_process_type": {
+ "enum": [
+ "automatic",
+ "invoice",
+ "custom",
+ "marketplace_acceptance"
+ ],
+ "type": "string"
+ },
+ "payment_process_type_custom_val": {
+ "type": "string"
+ },
+ "payment_process_type_invoice_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "payment_process_type_invoice_custom_unit": {
+ "type": "string"
+ },
+ "payment_process_type_invoice_duration": {
+ "enum": [
+ "day",
+ "week",
+ "month",
+ "year",
+ "day(s)",
+ "week(s)",
+ "month(s)",
+ "year(s)"
+ ],
+ "type": "string"
+ },
+ "payment_process_type_invoice_duration_start": {
+ "enum": [
+ "Customer's receipt of invoice",
+ "date of invoice"
+ ],
+ "type": "string"
+ },
+ "payment_process_type_invoice_type": {
+ "enum": [
+ "monthly",
+ "quarterly",
+ "semiannually",
+ "annually",
+ "Custom unit"
+ ],
+ "type": "string"
+ },
+ "pilot_period_stripe_product_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-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": {
+ "enum": [
+ "days",
+ "subscription_end"
+ ],
+ "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": {
+ "enum": [
+ "effective_date",
+ "date"
+ ],
+ "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.",
+ "enum": [
+ "CSA"
+ ],
+ "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-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-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.",
+ "enum": [
+ "DPA"
+ ],
+ "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-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": {
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "type": "string"
+ },
+ "general_cap_amount": {
+ "type": "number"
+ },
+ "general_cap_amount_type": {
+ "enum": [
+ "preceding",
+ "base",
+ "period"
+ ],
+ "type": "string"
+ },
+ "general_cap_period_currency": {
+ "type": "number"
+ },
+ "general_cap_period_qty": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "general_cap_preceding_amount": {
+ "type": "number"
+ },
+ "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": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_dpa": {
+ "type": "boolean"
+ },
+ "include_dpa_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_dpa_location": {
+ "type": "string"
+ },
+ "include_dpa_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_increased_cap_amount": {
+ "type": "boolean"
+ },
+ "include_increased_claims": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_confidentiality": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_confidentiality_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_privsec": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_privsec_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_other": {
+ "type": "boolean"
+ },
+ "include_increased_claims_indemnification_obligation": {
+ "type": "boolean"
+ },
+ "include_increased_claims_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_other": {
+ "type": "string"
+ },
+ "include_provider_insurance_min": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_add_customer_com_gen_liability": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_add_customer_cyber_liability": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_add_customer_errors_omissions": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_auto_liability_aggregate": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_auto_liability_minimum": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_cyber_liability_aggregate": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_cyber_liability_minimum": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_employer_liability_aggregate": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_employer_liability_minimum": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_general_liability_aggregate": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_general_liability_minimum": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_include_add_customer": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_include_auto_liability": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_include_cyber_liability": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_include_employer_liability": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_include_general_liability": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_include_workers_comp": {
+ "type": "boolean"
+ },
+ "include_publicity_rights": {
+ "type": "boolean"
+ },
+ "include_publicity_rights_type": {
+ "enum": [
+ "public",
+ "non-public"
+ ],
+ "type": "string"
+ },
+ "include_security_policy": {
+ "type": "boolean"
+ },
+ "include_security_policy_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_security_policy_fedramp_auth": {
+ "type": "boolean"
+ },
+ "include_security_policy_hitrust": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_annual_maintenance": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_other": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_other_val": {
+ "type": "string"
+ },
+ "include_security_policy_iso27001": {
+ "type": "boolean"
+ },
+ "include_security_policy_location": {
+ "type": "string"
+ },
+ "include_security_policy_pci1": {
+ "type": "boolean"
+ },
+ "include_security_policy_pci2": {
+ "type": "boolean"
+ },
+ "include_security_policy_penetration_testing": {
+ "type": "boolean"
+ },
+ "include_security_policy_soc2_type1": {
+ "type": "boolean"
+ },
+ "include_security_policy_soc2_type2": {
+ "type": "boolean"
+ },
+ "include_security_policy_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_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": {
+ "enum": [
+ "qty",
+ "currency",
+ "period"
+ ],
+ "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": {
+ "enum": [
+ "hours",
+ "days",
+ "weeks",
+ "months"
+ ],
+ "type": "string"
+ },
+ "include_deliverables_resubmission_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_deliverables_resubmission_unit": {
+ "enum": [
+ "hours",
+ "days",
+ "weeks",
+ "months"
+ ],
+ "type": "string"
+ },
+ "include_fees_other": {
+ "type": "boolean"
+ },
+ "include_fees_other_val": {
+ "type": "string"
+ },
+ "include_fees_table": {
+ "type": "boolean"
+ },
+ "include_fees_table_total": {
+ "type": "boolean"
+ },
+ "include_fees_travel": {
+ "type": "boolean"
+ },
+ "include_fees_travel_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_fees_travel_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_fees_travel_val": {
+ "type": "string"
+ },
+ "include_third_party_customer": {
+ "type": "boolean"
+ },
+ "include_third_party_include_description": {
+ "type": "boolean"
+ },
+ "include_third_party_include_description_val": {
+ "type": "string"
+ },
+ "include_third_party_materials": {
+ "type": "boolean"
+ },
+ "include_third_party_provider": {
+ "type": "boolean"
+ },
+ "include_time_of_assignment": {
+ "type": "boolean"
+ },
+ "include_time_of_assignment_type": {
+ "enum": [
+ "created",
+ "paid"
+ ],
+ "type": "string"
+ },
+ "invoice_period_description": {
+ "type": "string"
+ },
+ "negotiations_allowed": {
+ "description": "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": {
+ "enum": [
+ "receipt",
+ "invoice",
+ "Customer's receipt of invoice",
+ "date of invoice"
+ ],
+ "type": "string"
+ },
+ "payment_period_type": {
+ "enum": [
+ "standard",
+ "other"
+ ],
+ "type": "string"
+ },
+ "payment_period_unit": {
+ "enum": [
+ "day(s)",
+ "week(s)",
+ "month(s)",
+ "quarter(s)",
+ "year(s)"
+ ],
+ "type": "string"
+ },
+ "services_description": {
+ "type": "string"
+ },
+ "sow_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "sow_date_type": {
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "type": "string"
+ },
+ "sow_term_amount": {
+ "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": {
+ "enum": [
+ "deliverables",
+ "period",
+ "date"
+ ],
+ "type": "string"
+ },
+ "sow_term_unit": {
+ "enum": [
+ "month(s)",
+ "quarter(s)",
+ "year(s)"
+ ],
+ "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.",
+ "enum": [
+ "PSA"
+ ],
+ "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-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": {
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "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": {
+ "enum": [
+ "default_language",
+ "description"
+ ],
+ "type": "string"
+ },
+ "include_fees_unit": {
+ "enum": [
+ "month",
+ "quarter",
+ "year",
+ "Term"
+ ],
+ "type": "string"
+ },
+ "include_program_appear_as_customer_private": {
+ "type": "boolean"
+ },
+ "include_program_appear_as_customer_public": {
+ "type": "boolean"
+ },
+ "include_program_case_study": {
+ "type": "boolean"
+ },
+ "include_program_develop_functionality": {
+ "type": "boolean"
+ },
+ "include_program_develop_functionality_val": {
+ "type": "string"
+ },
+ "include_program_discount": {
+ "type": "boolean"
+ },
+ "include_program_discount_amount": {
+ "type": "number"
+ },
+ "include_program_discount_unit": {
+ "enum": [
+ "U.S. Dollars",
+ "percent"
+ ],
+ "type": "string"
+ },
+ "include_program_participation_feedback": {
+ "type": "boolean"
+ },
+ "include_program_participation_feedback_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_program_participation_feedback_unit": {
+ "enum": [
+ "month",
+ "quarter",
+ "year",
+ "Term"
+ ],
+ "type": "string"
+ },
+ "include_program_partner_other": {
+ "type": "boolean"
+ },
+ "include_program_partner_other_val": {
+ "type": "string"
+ },
+ "include_program_provider_other": {
+ "type": "boolean"
+ },
+ "include_program_provider_other_val": {
+ "type": "string"
+ },
+ "include_program_reference": {
+ "type": "boolean"
+ },
+ "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": {
+ "enum": [
+ "day(s)",
+ "week(s)",
+ "month(s)",
+ "quarter(s)",
+ "year(s)"
+ ],
+ "type": "string"
+ },
+ "type": {
+ "description": "The type of template to create.",
+ "enum": [
+ "Design"
+ ],
+ "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": {
+ "enum": [
+ "stripe",
+ "link"
+ ],
+ "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-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": {
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "type": "string"
+ },
+ "general_cap_amount": {
+ "type": "number"
+ },
+ "general_cap_amount_type": {
+ "enum": [
+ "preceding",
+ "base",
+ "period"
+ ],
+ "type": "string"
+ },
+ "general_cap_period_currency": {
+ "type": "number"
+ },
+ "general_cap_period_qty": {
+ "type": "number"
+ },
+ "general_cap_preceding_amount": {
+ "type": "number"
+ },
+ "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": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_increased_cap_amount": {
+ "type": "boolean"
+ },
+ "include_increased_claims": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_confidentiality": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_confidentiality_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_other": {
+ "type": "boolean"
+ },
+ "include_increased_claims_indemnification_obligation": {
+ "type": "boolean"
+ },
+ "include_increased_claims_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_other": {
+ "type": "string"
+ },
+ "include_increased_claims_restrictions": {
+ "type": "boolean"
+ },
+ "include_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": {
+ "enum": [
+ "qty",
+ "currency",
+ "period"
+ ],
+ "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": {
+ "enum": [
+ "automatic",
+ "manual"
+ ],
+ "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": {
+ "enum": [
+ "automatic",
+ "invoice"
+ ],
+ "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": {
+ "enum": [
+ "Subscription Period",
+ "month",
+ "year",
+ "Custom unit"
+ ],
+ "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": {
+ "enum": [
+ "USD",
+ "EUR",
+ "GBP",
+ "CAD",
+ "AUD",
+ "SGD",
+ "ILS",
+ "JPY",
+ "CHF",
+ "HKD"
+ ],
+ "type": "string"
+ },
+ "fees_include_fee_increase_upon_renewal": {
+ "type": "boolean"
+ },
+ "fees_include_fee_increase_upon_renewal_fee": {
+ "type": "number"
+ },
+ "fees_include_fee_increase_upon_renewal_type": {
+ "enum": [
+ "will",
+ "may"
+ ],
+ "type": "string"
+ },
+ "fees_inclusive_of_taxes": {
+ "type": "boolean"
+ },
+ "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": {
+ "enum": [
+ "day",
+ "week",
+ "month"
+ ],
+ "type": "string"
+ },
+ "include_pilot_period_include_fees": {
+ "type": "boolean"
+ },
+ "include_pilot_period_include_fees_amount": {
+ "type": "number"
+ },
+ "include_pilot_period_include_modifications": {
+ "type": "boolean"
+ },
+ "include_pilot_period_include_modifications_description": {
+ "type": "string"
+ },
+ "include_services": {
+ "type": "boolean"
+ },
+ "include_services_description": {
+ "type": "string"
+ },
+ "negotiations_allowed": {
+ "description": "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": {
+ "enum": [
+ "signature",
+ "date",
+ "other"
+ ],
+ "type": "string"
+ },
+ "payment_process_automatic_frequency": {
+ "enum": [
+ "monthly",
+ "quarterly",
+ "semiannually",
+ "annually"
+ ],
+ "type": "string"
+ },
+ "payment_process_type": {
+ "enum": [
+ "automatic",
+ "invoice",
+ "custom"
+ ],
+ "type": "string"
+ },
+ "payment_process_type_custom_val": {
+ "type": "string"
+ },
+ "payment_process_type_invoice_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "payment_process_type_invoice_custom_unit": {
+ "type": "string"
+ },
+ "payment_process_type_invoice_duration": {
+ "enum": [
+ "day",
+ "week",
+ "month",
+ "year",
+ "day(s)",
+ "week(s)",
+ "month(s)",
+ "year(s)"
+ ],
+ "type": "string"
+ },
+ "payment_process_type_invoice_duration_start": {
+ "enum": [
+ "Customer's receipt of invoice",
+ "date of invoice"
+ ],
+ "type": "string"
+ },
+ "payment_process_type_invoice_type": {
+ "enum": [
+ "monthly",
+ "quarterly",
+ "semiannually",
+ "annually",
+ "Custom unit"
+ ],
+ "type": "string"
+ },
+ "permitted_uses_include_custom": {
+ "type": "boolean"
+ },
+ "permitted_uses_include_custom_description": {
+ "type": "string"
+ },
+ "permitted_uses_include_customers_affiliates": {
+ "type": "boolean"
+ },
+ "permitted_uses_include_internal_business": {
+ "type": "boolean"
+ },
+ "pilot_period_stripe_product_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-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": {
+ "enum": [
+ "days",
+ "subscription_end"
+ ],
+ "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": {
+ "enum": [
+ "day",
+ "week",
+ "month",
+ "year"
+ ],
+ "type": "string"
+ },
+ "warranty_period_description_duration_start": {
+ "enum": [
+ "initial delivery of the Software",
+ "delivery of the Software and each subsequent Update",
+ "the Order Date"
+ ],
+ "type": "string"
+ },
+ "warranty_period_type": {
+ "enum": [
+ "description",
+ "none"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "type": {
+ "description": "The type of template to create.",
+ "enum": [
+ "Software License"
+ ],
+ "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-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": {
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "type": "string"
+ },
+ "fees_type": {
+ "enum": [
+ "free",
+ "pilot_period_fees"
+ ],
+ "type": "string"
+ },
+ "general_cap_amount": {
+ "type": "number"
+ },
+ "general_cap_amount_type": {
+ "enum": [
+ "preceding",
+ "base",
+ "period"
+ ],
+ "type": "string"
+ },
+ "general_cap_period_currency": {
+ "type": "number"
+ },
+ "general_cap_period_qty": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "general_cap_preceding_amount": {
+ "type": "number"
+ },
+ "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": {
+ "enum": [
+ "description",
+ "attachment",
+ "standard"
+ ],
+ "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": {
+ "enum": [
+ "monthly",
+ "quarterly",
+ "annually",
+ "once_per_period"
+ ],
+ "type": "string"
+ },
+ "payment_process_invoice_days": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "payment_process_invoice_from": {
+ "enum": [
+ "receipt",
+ "date"
+ ],
+ "type": "string"
+ },
+ "payment_process_invoice_timeframe": {
+ "enum": [
+ "days",
+ "weeks",
+ "months",
+ "quarters",
+ "years"
+ ],
+ "type": "string"
+ },
+ "payment_process_type": {
+ "enum": [
+ "automatic",
+ "invoice"
+ ],
+ "type": "string"
+ },
+ "pilot_period_description": {
+ "type": "string"
+ },
+ "pilot_period_fees_description": {
+ "type": "string"
+ },
+ "product_description": {
+ "type": "string"
+ },
+ "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.",
+ "enum": [
+ "Pilot"
+ ],
+ "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-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": {
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "type": "string"
+ },
+ "general_cap_amount_currency_val": {
+ "type": "number"
+ },
+ "general_cap_amount_either_currency": {
+ "type": "number"
+ },
+ "general_cap_amount_either_multiple": {
+ "type": "number"
+ },
+ "general_cap_amount_multiple_val": {
+ "type": "number"
+ },
+ "general_cap_amount_type": {
+ "enum": [
+ "multiple",
+ "currency",
+ "either",
+ "base"
+ ],
+ "type": "string"
+ },
+ "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": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_increased_cap_amount": {
+ "type": "boolean"
+ },
+ "include_increased_cap_amount_currency": {
+ "type": "number"
+ },
+ "include_increased_cap_amount_either_currency": {
+ "type": "number"
+ },
+ "include_increased_cap_amount_either_multiple": {},
+ "include_increased_cap_amount_multiple": {},
+ "include_increased_cap_amount_type": {
+ "enum": [
+ "multiple",
+ "currency",
+ "either"
+ ],
+ "type": "string"
+ },
+ "include_increased_claims": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_confidentiality": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_confidentiality_misconduct": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_covered_claims": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_misconduct": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_other": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_other_val": {
+ "type": "string"
+ },
+ "include_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": {
+ "enum": [
+ "month(s)",
+ "quarter(s)",
+ "year(s)"
+ ],
+ "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": {
+ "enum": [
+ "date",
+ "effective date"
+ ],
+ "type": "string"
+ },
+ "include_obligations_company_brand": {
+ "type": "boolean"
+ },
+ "include_obligations_company_promotion": {
+ "type": "boolean"
+ },
+ "include_obligations_company_promotion_include_activities": {
+ "type": "boolean"
+ },
+ "include_obligations_company_promotion_include_activities_val": {
+ "type": "string"
+ },
+ "include_obligations_company_promotion_include_materials": {
+ "type": "boolean"
+ },
+ "include_obligations_company_promotion_include_materials_val": {
+ "type": "string"
+ },
+ "include_obligations_company_referral": {
+ "type": "boolean"
+ },
+ "include_obligations_company_referral_include_criteria": {
+ "type": "boolean"
+ },
+ "include_obligations_company_referral_include_criteria_val": {
+ "type": "string"
+ },
+ "include_obligations_company_referral_include_pay_sch": {
+ "type": "boolean"
+ },
+ "include_obligations_company_referral_include_pay_sch_amount": {
+ "type": "number"
+ },
+ "include_obligations_company_referral_include_pay_sch_custom": {
+ "type": "string"
+ },
+ "include_obligations_company_referral_include_pay_sch_unit": {
+ "enum": [
+ "U.S. Dollars",
+ "percent"
+ ],
+ "type": "string"
+ },
+ "include_obligations_company_sponsorship": {
+ "type": "boolean"
+ },
+ "include_obligations_company_sponsorship_include_benefits": {
+ "type": "boolean"
+ },
+ "include_obligations_company_sponsorship_include_benefits_val": {
+ "type": "string"
+ },
+ "include_obligations_company_sponsorship_include_payments": {
+ "type": "boolean"
+ },
+ "include_obligations_company_sponsorship_include_payments_amount": {
+ "type": "number"
+ },
+ "include_obligations_company_sponsorship_include_payments_unit": {
+ "enum": [
+ "U.S. Dollars",
+ "percent"
+ ],
+ "type": "string"
+ },
+ "include_obligations_partner_brand": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_promotion": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_promotion_include_activities": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_promotion_include_activities_val": {
+ "type": "string"
+ },
+ "include_obligations_partner_promotion_include_materials": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_promotion_include_materials_val": {
+ "type": "string"
+ },
+ "include_obligations_partner_referral": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_referral_include_criteria": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_referral_include_criteria_val": {
+ "type": "string"
+ },
+ "include_obligations_partner_referral_include_pay_sch": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_referral_include_pay_sch_amount": {
+ "type": "number"
+ },
+ "include_obligations_partner_referral_include_pay_sch_custom": {
+ "type": "string"
+ },
+ "include_obligations_partner_referral_include_pay_sch_unit": {
+ "enum": [
+ "U.S. Dollars",
+ "percent"
+ ],
+ "type": "string"
+ },
+ "include_obligations_partner_sponsorship": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_sponsorship_include_benefits": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_sponsorship_include_benefits_val": {
+ "type": "string"
+ },
+ "include_obligations_partner_sponsorship_include_payments": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_sponsorship_include_payments_amount": {
+ "type": "number"
+ },
+ "include_obligations_partner_sponsorship_include_payments_unit": {
+ "enum": [
+ "U.S. Dollars",
+ "percent"
+ ],
+ "type": "string"
+ },
+ "include_payment_process": {
+ "type": "boolean"
+ },
+ "include_payment_process_company": {
+ "type": "boolean"
+ },
+ "include_payment_process_company_include_address": {
+ "type": "boolean"
+ },
+ "include_payment_process_company_include_address_city": {
+ "type": "string"
+ },
+ "include_payment_process_company_include_address_country": {
+ "type": "string"
+ },
+ "include_payment_process_company_include_address_state": {
+ "type": "string"
+ },
+ "include_payment_process_company_include_address_street_address": {
+ "type": "string"
+ },
+ "include_payment_process_company_include_address_zipcode": {
+ "type": "string"
+ },
+ "include_payment_process_company_include_email": {
+ "type": "boolean"
+ },
+ "include_payment_process_company_include_email_val": {
+ "format": "email",
+ "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "include_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-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": {
+ "enum": [
+ "receipt",
+ "date"
+ ],
+ "type": "string"
+ },
+ "include_payment_schedule_specified_unit": {
+ "enum": [
+ "day(s)",
+ "week(s)",
+ "month(s)",
+ "quarter(s)",
+ "year(s)"
+ ],
+ "type": "string"
+ },
+ "include_payment_schedule_type": {
+ "enum": [
+ "specified",
+ "custom"
+ ],
+ "type": "string"
+ },
+ "negotiations_allowed": {
+ "description": "Whether counterparties can propose changes to agreements created from this template.",
+ "type": "boolean"
+ },
+ "territory_type": {
+ "enum": [
+ "worldwide",
+ "custom"
+ ],
+ "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.",
+ "enum": [
+ "Partnership"
+ ],
+ "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": {
+ "enum": [
+ "hours",
+ "business days",
+ "calendar days"
+ ],
+ "type": "string"
+ },
+ "breach_notification_val": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "business_associate_relationship_type": {
+ "enum": [
+ "provider",
+ "company"
+ ],
+ "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-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": {
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "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.",
+ "enum": [
+ "BAA"
+ ],
+ "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": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "confidentiality_type": {
+ "enum": [
+ "mutual",
+ "nda",
+ "provider",
+ "custom"
+ ],
+ "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-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": {
+ "enum": [
+ "month",
+ "year",
+ "quarter"
+ ],
+ "type": "string"
+ },
+ "include_fees_include_amount": {
+ "type": "boolean"
+ },
+ "include_fees_include_other": {
+ "type": "boolean"
+ },
+ "include_fees_other": {
+ "type": "string"
+ },
+ "include_functionality": {
+ "type": "boolean"
+ },
+ "include_functionality_val": {
+ "type": "string"
+ },
+ "include_launch_date": {
+ "type": "boolean"
+ },
+ "include_launch_date_custom": {
+ "type": "string"
+ },
+ "include_launch_date_date": {
+ "format": "date-time",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$",
+ "type": "string"
+ },
+ "include_launch_date_type": {
+ "enum": [
+ "date",
+ "custom"
+ ],
+ "type": "string"
+ },
+ "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.",
+ "enum": [
+ "LOI"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "type"
+ ],
+ "type": "object"
+ }
+]list-agreement-history2 fields changedInput schema / properties / queryParams / properties / filter[created_at_gteq] / patternPrevious value: -"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[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))$"New value: +"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[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))$"Input schema / properties / queryParams / properties / filter[created_at_lteq] / patternPrevious value: -"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[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))$"New value: +"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[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))$"list-agreements2 fields changedInput schema / properties / queryParams / properties / filter[created_at_gteq] / patternPrevious value: -"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[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))$"New value: +"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[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))$"Input schema / properties / queryParams / properties / filter[created_at_lteq] / patternPrevious value: -"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[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))$"New value: +"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[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))$"reassign-agreement1 field changedInput schema / properties / body / properties / agreement / properties / recipient_email / patternPrevious value: -"^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"New value: +"^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"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.",
- "enum": [
- "signature",
- "date"
- ],
- "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"
- },
- "include_terms": {
- "description": "When true, the standard terms are included 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 to the legal terms. For agreement types without separate business terms, that covers every term. CSA order forms, PSA statements of work, partnership business terms and software license order forms have their own `negotiations_allowed` flag.",
- "type": "boolean"
- },
- "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.",
- "enum": [
- "signature",
- "date"
- ],
- "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"
- },
- "include_terms": {
- "description": "When true, the standard terms are included 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 to the legal terms. For agreement types without separate business terms, that covers every term. CSA order forms, PSA statements of work, partnership business terms and software license order forms have their own `negotiations_allowed` flag.",
- "type": "boolean"
- },
- "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.",
- "enum": [
- "signature",
- "date"
- ],
- "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"
- },
- "include_terms": {
- "description": "When true, the standard terms are included 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 to the legal terms. For agreement types without separate business terms, that covers every term. CSA order forms, PSA statements of work, partnership business terms and software license order forms have their own `negotiations_allowed` flag.",
- "type": "boolean"
- },
- "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.",
- "enum": [
- "signature",
- "date"
- ],
- "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"
- },
- "include_terms": {
- "description": "When true, the standard terms are included 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 to the legal terms. For agreement types without separate business terms, that covers every term. CSA order forms, PSA statements of work, partnership business terms and software license order forms have their own `negotiations_allowed` flag.",
- "type": "boolean"
- },
- "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.",
- "enum": [
- "signature",
- "date"
- ],
- "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"
- },
- "include_terms": {
- "description": "When true, the standard terms are included 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 to the legal terms. For agreement types without separate business terms, that covers every term. CSA order forms, PSA statements of work, partnership business terms and software license order forms have their own `negotiations_allowed` flag.",
- "type": "boolean"
- },
- "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.",
- "enum": [
- "signature",
- "date"
- ],
- "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"
- },
- "include_terms": {
- "description": "When true, the standard terms are included 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 to the legal terms. For agreement types without separate business terms, that covers every term. CSA order forms, PSA statements of work, partnership business terms and software license order forms have their own `negotiations_allowed` flag.",
- "type": "boolean"
- },
- "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.",
- "enum": [
- "signature",
- "date"
- ],
- "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"
- },
- "include_terms": {
- "description": "When true, the standard terms are included 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 to the legal terms. For agreement types without separate business terms, that covers every term. CSA order forms, PSA statements of work, partnership business terms and software license order forms have their own `negotiations_allowed` flag.",
- "type": "boolean"
- },
- "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.",
- "enum": [
- "signature",
- "date"
- ],
- "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"
- },
- "include_terms": {
- "description": "When true, the standard terms are included 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 to the legal terms. For agreement types without separate business terms, that covers every term. CSA order forms, PSA statements of work, partnership business terms and software license order forms have their own `negotiations_allowed` flag.",
- "type": "boolean"
- },
- "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.",
- "enum": [
- "signature",
- "date"
- ],
- "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"
- },
- "include_terms": {
- "description": "When true, the standard terms are included 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 to the legal terms. For agreement types without separate business terms, that covers every term. CSA order forms, PSA statements of work, partnership business terms and software license order forms have their own `negotiations_allowed` flag.",
- "type": "boolean"
- },
- "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.",
- "enum": [
- "signature",
- "date"
- ],
- "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"
- },
- "include_terms": {
- "description": "When true, the standard terms are included 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 to the legal terms. For agreement types without separate business terms, that covers every term. CSA order forms, PSA statements of work, partnership business terms and software license order forms have their own `negotiations_allowed` flag.",
- "type": "boolean"
- },
- "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.",
- "enum": [
- "signature",
- "date"
- ],
- "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"
- },
- "include_terms": {
- "description": "When true, the standard terms are included 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 to the legal terms. For agreement types without separate business terms, that covers every term. CSA order forms, PSA statements of work, partnership business terms and software license order forms have their own `negotiations_allowed` flag.",
- "type": "boolean"
- },
- "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.",
- "enum": [
- "signature",
- "date"
- ],
- "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"
- },
- "include_terms": {
- "description": "When true, the standard terms are included 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 to the legal terms. For agreement types without separate business terms, that covers every term. CSA order forms, PSA statements of work, partnership business terms and software license order forms have their own `negotiations_allowed` flag.",
- "type": "boolean"
- },
- "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"
- }
-]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-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-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.",
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "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"
+ },
+ "include_terms": {
+ "description": "When true, the standard terms are included 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 to the legal terms. For agreement types without separate business terms, that covers every term. CSA order forms, PSA statements of work, partnership business terms and software license order forms have their own `negotiations_allowed` flag.",
+ "type": "boolean"
+ },
+ "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-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-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-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-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-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.",
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "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"
+ },
+ "include_terms": {
+ "description": "When true, the standard terms are included 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 to the legal terms. For agreement types without separate business terms, that covers every term. CSA order forms, PSA statements of work, partnership business terms and software license order forms have their own `negotiations_allowed` flag.",
+ "type": "boolean"
+ },
+ "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-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-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-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-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-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.",
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "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"
+ },
+ "include_terms": {
+ "description": "When true, the standard terms are included 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 to the legal terms. For agreement types without separate business terms, that covers every term. CSA order forms, PSA statements of work, partnership business terms and software license order forms have their own `negotiations_allowed` flag.",
+ "type": "boolean"
+ },
+ "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-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-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-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-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-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.",
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "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"
+ },
+ "include_terms": {
+ "description": "When true, the standard terms are included 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 to the legal terms. For agreement types without separate business terms, that covers every term. CSA order forms, PSA statements of work, partnership business terms and software license order forms have their own `negotiations_allowed` flag.",
+ "type": "boolean"
+ },
+ "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-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-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-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-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-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.",
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "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"
+ },
+ "include_terms": {
+ "description": "When true, the standard terms are included 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 to the legal terms. For agreement types without separate business terms, that covers every term. CSA order forms, PSA statements of work, partnership business terms and software license order forms have their own `negotiations_allowed` flag.",
+ "type": "boolean"
+ },
+ "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-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-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-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-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-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.",
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "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"
+ },
+ "include_terms": {
+ "description": "When true, the standard terms are included 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 to the legal terms. For agreement types without separate business terms, that covers every term. CSA order forms, PSA statements of work, partnership business terms and software license order forms have their own `negotiations_allowed` flag.",
+ "type": "boolean"
+ },
+ "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-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-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-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-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-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.",
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "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"
+ },
+ "include_terms": {
+ "description": "When true, the standard terms are included 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 to the legal terms. For agreement types without separate business terms, that covers every term. CSA order forms, PSA statements of work, partnership business terms and software license order forms have their own `negotiations_allowed` flag.",
+ "type": "boolean"
+ },
+ "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-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-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-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-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-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.",
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "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"
+ },
+ "include_terms": {
+ "description": "When true, the standard terms are included 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 to the legal terms. For agreement types without separate business terms, that covers every term. CSA order forms, PSA statements of work, partnership business terms and software license order forms have their own `negotiations_allowed` flag.",
+ "type": "boolean"
+ },
+ "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-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-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-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-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-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.",
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "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"
+ },
+ "include_terms": {
+ "description": "When true, the standard terms are included 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 to the legal terms. For agreement types without separate business terms, that covers every term. CSA order forms, PSA statements of work, partnership business terms and software license order forms have their own `negotiations_allowed` flag.",
+ "type": "boolean"
+ },
+ "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-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-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-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-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-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.",
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "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"
+ },
+ "include_terms": {
+ "description": "When true, the standard terms are included 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 to the legal terms. For agreement types without separate business terms, that covers every term. CSA order forms, PSA statements of work, partnership business terms and software license order forms have their own `negotiations_allowed` flag.",
+ "type": "boolean"
+ },
+ "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-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-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-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-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-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.",
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "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"
+ },
+ "include_terms": {
+ "description": "When true, the standard terms are included 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 to the legal terms. For agreement types without separate business terms, that covers every term. CSA order forms, PSA statements of work, partnership business terms and software license order forms have their own `negotiations_allowed` flag.",
+ "type": "boolean"
+ },
+ "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-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-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-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-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-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.",
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "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"
+ },
+ "include_terms": {
+ "description": "When true, the standard terms are included 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 to the legal terms. For agreement types without separate business terms, that covers every term. CSA order forms, PSA statements of work, partnership business terms and software license order forms have their own `negotiations_allowed` flag.",
+ "type": "boolean"
+ },
+ "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-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-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-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"
+ }
+]update-organization2 fields changedInput schema / properties / body / properties / organization / properties / billing_notifications_email / patternPrevious value: -"^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"New value: +"^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"Input schema / properties / body / properties / organization / properties / notice_email_address / patternPrevious value: -"^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"New value: +"^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"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": {
- "enum": [
- "signature",
- "date"
- ],
- "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": {
- "enum": [
- "stripe",
- "link"
- ],
- "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": {
- "enum": [
- "AWS",
- "GCP",
- "Azure"
- ],
- "type": "string"
- },
- "effective_date_type": {
- "enum": [
- "signature",
- "date",
- "marketplace_acceptance"
- ],
- "type": "string"
- },
- "general_cap_amount": {
- "type": "number"
- },
- "general_cap_amount_type": {
- "enum": [
- "preceding",
- "base",
- "period"
- ],
- "type": "string"
- },
- "general_cap_period_currency": {
- "type": "number"
- },
- "general_cap_period_qty": {
- "type": "number"
- },
- "general_cap_preceding_amount": {
- "type": "number"
- },
- "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": {
- "enum": [
- "description",
- "attachment"
- ],
- "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": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_increased_cap_amount": {
- "type": "boolean"
- },
- "include_increased_claims": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_confidentiality": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_confidentiality_negligence": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_privsec": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_privsec_negligence": {
- "type": "boolean"
- },
- "include_increased_claims_include_other": {
- "type": "boolean"
- },
- "include_increased_claims_indemnification_obligation": {
- "type": "boolean"
- },
- "include_increased_claims_other": {
- "type": "string"
- },
- "include_insurance_minimums": {
- "type": "boolean"
- },
- "include_insurance_minimums_add_customer": {
- "type": "boolean"
- },
- "include_insurance_minimums_add_customer_com_gen_liability": {
- "type": "boolean"
- },
- "include_insurance_minimums_add_customer_cyber_liability": {
- "type": "boolean"
- },
- "include_insurance_minimums_add_customer_errors_omissions": {
- "type": "boolean"
- },
- "include_insurance_minimums_additional_information": {
- "type": "boolean"
- },
- "include_insurance_minimums_additional_information_text": {
- "type": "string"
- },
- "include_insurance_minimums_cyber_liability_aggregate": {
- "type": "number"
- },
- "include_insurance_minimums_cyber_liability_minimum": {
- "type": "number"
- },
- "include_insurance_minimums_employer_liability_aggregate": {
- "type": "number"
- },
- "include_insurance_minimums_employer_liability_minimum": {
- "type": "number"
- },
- "include_insurance_minimums_general_liability_aggregate": {
- "type": "number"
- },
- "include_insurance_minimums_general_liability_minimum": {
- "type": "number"
- },
- "include_insurance_minimums_include_cyber_liability": {
- "type": "boolean"
- },
- "include_insurance_minimums_include_employer_liability": {
- "type": "boolean"
- },
- "include_insurance_minimums_include_general_liability": {
- "type": "boolean"
- },
- "include_insurance_minimums_include_workers_compensation": {
- "type": "boolean"
- },
- "include_publicity_rights": {
- "type": "boolean"
- },
- "include_publicity_rights_type": {
- "enum": [
- "public",
- "non-public"
- ],
- "type": "string"
- },
- "include_security_policy": {
- "type": "boolean"
- },
- "include_security_policy_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_security_policy_fedramp_auth": {
- "type": "boolean"
- },
- "include_security_policy_hipaa": {
- "type": "boolean"
- },
- "include_security_policy_hitrust": {
- "type": "boolean"
- },
- "include_security_policy_include_annual_maintenance": {
- "type": "boolean"
- },
- "include_security_policy_include_location": {
- "type": "boolean"
- },
- "include_security_policy_include_other": {
- "type": "boolean"
- },
- "include_security_policy_include_reasonable_efforts": {
- "type": "boolean"
- },
- "include_security_policy_iso27001": {
- "type": "boolean"
- },
- "include_security_policy_location": {
- "type": "string"
- },
- "include_security_policy_other": {
- "type": "string"
- },
- "include_security_policy_pci1": {
- "type": "boolean"
- },
- "include_security_policy_pci2": {
- "type": "boolean"
- },
- "include_security_policy_penetration_testing": {
- "type": "boolean"
- },
- "include_security_policy_soc2": {
- "type": "boolean"
- },
- "include_security_policy_soc2_type2": {
- "type": "boolean"
- },
- "include_security_policy_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_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": {
- "type": "number"
- },
- "increased_cap_amount_qty": {
- "type": "number"
- },
- "increased_cap_amount_type": {
- "enum": [
- "qty",
- "currency",
- "period"
- ],
- "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": {
- "enum": [
- "automatic",
- "invoice"
- ],
- "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": {
- "enum": [
- "Subscription Period",
- "month",
- "year",
- "User",
- "Custom unit"
- ],
- "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": {
- "enum": [
- "USD",
- "EUR",
- "GBP",
- "CAD",
- "AUD",
- "SGD",
- "ILS",
- "JPY",
- "CHF",
- "HKD"
- ],
- "type": "string"
- },
- "fees_include_fee_increase_upon_renewal": {
- "type": "boolean"
- },
- "fees_include_fee_increase_upon_renewal_fee": {
- "type": "number"
- },
- "fees_include_fee_increase_upon_renewal_type": {
- "enum": [
- "will",
- "may"
- ],
- "type": "string"
- },
- "fees_inclusive_of_taxes": {
- "type": "boolean"
- },
- "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": {
- "enum": [
- "Subscription Period",
- "month",
- "year",
- "User"
- ],
- "type": "string"
- },
- "include_free_trial": {
- "type": "boolean"
- },
- "include_max_users": {
- "type": "boolean"
- },
- "include_pilot_period": {
- "type": "boolean"
- },
- "include_pilot_period_duration_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_pilot_period_duration_type": {
- "enum": [
- "day",
- "week",
- "month"
- ],
- "type": "string"
- },
- "include_pilot_period_include_fees": {
- "type": "boolean"
- },
- "include_pilot_period_include_fees_amount": {
- "type": "number"
- },
- "include_pilot_period_include_modifications": {
- "type": "boolean"
- },
- "include_pilot_period_include_modifications_description": {
- "type": "string"
- },
- "include_product_support": {
- "type": "boolean"
- },
- "include_product_support_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_product_support_description": {
- "type": "string"
- },
- "include_product_support_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_professional_services": {
- "type": "boolean"
- },
- "include_professional_services_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_professional_services_custom_name": {
- "type": "string"
- },
- "include_professional_services_description": {
- "type": "string"
- },
- "include_professional_services_end_date": {
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "include_professional_services_fees_description": {
- "type": "string"
- },
- "include_professional_services_include_end_date": {
- "type": "boolean"
- },
- "include_professional_services_include_fees_description": {
- "type": "boolean"
- },
- "include_professional_services_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_sla": {
- "type": "boolean"
- },
- "include_sla_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_sla_description": {
- "type": "string"
- },
- "include_sla_include_response_time": {
- "type": "boolean"
- },
- "include_sla_include_response_time_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_sla_include_response_time_credit": {
- "type": "number"
- },
- "include_sla_include_response_time_duration": {
- "enum": [
- "hour",
- "day",
- "week",
- "month",
- "hours"
- ],
- "type": "string"
- },
- "include_sla_include_response_time_support_channel": {
- "type": "string"
- },
- "include_sla_include_target_uptime": {
- "type": "boolean"
- },
- "include_sla_maintenance_notice": {
- "type": "boolean"
- },
- "include_sla_maintenance_window": {
- "type": "boolean"
- },
- "include_sla_maintenance_window_type": {
- "enum": [
- "standard",
- "none"
- ],
- "type": "string"
- },
- "include_sla_standard_maintenance_notice_qty": {
- "type": "number"
- },
- "include_sla_standard_maintenance_notice_unit": {
- "enum": [
- "hour",
- "day",
- "week",
- "month"
- ],
- "type": "string"
- },
- "include_sla_standard_maintenance_window_end_time": {
- "type": "string"
- },
- "include_sla_standard_maintenance_window_friday": {
- "type": "boolean"
- },
- "include_sla_standard_maintenance_window_monday": {
- "type": "boolean"
- },
- "include_sla_standard_maintenance_window_saturday": {
- "type": "boolean"
- },
- "include_sla_standard_maintenance_window_start_time": {
- "type": "string"
- },
- "include_sla_standard_maintenance_window_sunday": {
- "type": "boolean"
- },
- "include_sla_standard_maintenance_window_thursday": {
- "type": "boolean"
- },
- "include_sla_standard_maintenance_window_time_zone": {
- "type": "string"
- },
- "include_sla_standard_maintenance_window_tuesday": {
- "type": "boolean"
- },
- "include_sla_standard_maintenance_window_wednesday": {
- "type": "boolean"
- },
- "include_sla_standard_target_uptime": {
- "type": "number"
- },
- "include_sla_type": {
- "enum": [
- "description",
- "standard",
- "attachment"
- ],
- "type": "string"
- },
- "include_subscription_start_date": {
- "type": "boolean"
- },
- "include_subscription_start_date_date": {
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "include_usage_review": {
- "type": "boolean"
- },
- "include_usage_review_val": {
- "type": "string"
- },
- "include_use_limitations": {
- "type": "boolean"
- },
- "include_use_limitations_val": {
- "type": "string"
- },
- "invoice_period": {
- "enum": [
- "monthly",
- "quarterly",
- "semiannually",
- "annually",
- "Custom unit",
- "Monthly",
- "Quarterly",
- "Semiannually",
- "Annually"
- ],
- "type": "string"
- },
- "invoice_period_custom_unit": {
- "type": "string"
- },
- "max_consumption": {
- "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": {
- "enum": [
- "signature",
- "date",
- "other"
- ],
- "type": "string"
- },
- "payment_period": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "payment_period_timeframe": {
- "enum": [
- "Customer's receipt of invoice",
- "date of invoice"
- ],
- "type": "string"
- },
- "payment_period_unit": {
- "enum": [
- "day(s)",
- "week(s)",
- "month(s)",
- "marketplace_acceptance"
- ],
- "type": "string"
- },
- "payment_process_automatic_frequency": {
- "enum": [
- "monthly",
- "quarterly",
- "semiannually",
- "annually"
- ],
- "type": "string"
- },
- "payment_process_type": {
- "enum": [
- "automatic",
- "invoice",
- "custom",
- "marketplace_acceptance"
- ],
- "type": "string"
- },
- "payment_process_type_custom_val": {
- "type": "string"
- },
- "payment_process_type_invoice_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "payment_process_type_invoice_custom_unit": {
- "type": "string"
- },
- "payment_process_type_invoice_duration": {
- "enum": [
- "day",
- "week",
- "month",
- "year",
- "day(s)",
- "week(s)",
- "month(s)",
- "year(s)"
- ],
- "type": "string"
- },
- "payment_process_type_invoice_duration_start": {
- "enum": [
- "Customer's receipt of invoice",
- "date of invoice"
- ],
- "type": "string"
- },
- "payment_process_type_invoice_type": {
- "enum": [
- "monthly",
- "quarterly",
- "semiannually",
- "annually",
- "Custom unit"
- ],
- "type": "string"
- },
- "pilot_period_stripe_product_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-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": {
- "enum": [
- "days",
- "subscription_end"
- ],
- "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": {
- "enum": [
- "effective_date",
- "date"
- ],
- "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": {
- "enum": [
- "signature",
- "date"
- ],
- "type": "string"
- },
- "general_cap_amount": {
- "type": "number"
- },
- "general_cap_amount_type": {
- "enum": [
- "preceding",
- "base",
- "period"
- ],
- "type": "string"
- },
- "general_cap_period_currency": {
- "type": "number"
- },
- "general_cap_period_qty": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "general_cap_preceding_amount": {
- "type": "number"
- },
- "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": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_dpa": {
- "type": "boolean"
- },
- "include_dpa_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_dpa_location": {
- "type": "string"
- },
- "include_dpa_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_increased_cap_amount": {
- "type": "boolean"
- },
- "include_increased_claims": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_confidentiality": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_confidentiality_negligence": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_privsec": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_privsec_negligence": {
- "type": "boolean"
- },
- "include_increased_claims_include_other": {
- "type": "boolean"
- },
- "include_increased_claims_indemnification_obligation": {
- "type": "boolean"
- },
- "include_increased_claims_negligence": {
- "type": "boolean"
- },
- "include_increased_claims_other": {
- "type": "string"
- },
- "include_provider_insurance_min": {
- "type": "boolean"
- },
- "include_provider_insurance_min_add_customer_com_gen_liability": {
- "type": "boolean"
- },
- "include_provider_insurance_min_add_customer_cyber_liability": {
- "type": "boolean"
- },
- "include_provider_insurance_min_add_customer_errors_omissions": {
- "type": "boolean"
- },
- "include_provider_insurance_min_auto_liability_aggregate": {
- "type": "number"
- },
- "include_provider_insurance_min_auto_liability_minimum": {
- "type": "number"
- },
- "include_provider_insurance_min_cyber_liability_aggregate": {
- "type": "number"
- },
- "include_provider_insurance_min_cyber_liability_minimum": {
- "type": "number"
- },
- "include_provider_insurance_min_employer_liability_aggregate": {
- "type": "number"
- },
- "include_provider_insurance_min_employer_liability_minimum": {
- "type": "number"
- },
- "include_provider_insurance_min_general_liability_aggregate": {
- "type": "number"
- },
- "include_provider_insurance_min_general_liability_minimum": {
- "type": "number"
- },
- "include_provider_insurance_min_include_add_customer": {
- "type": "boolean"
- },
- "include_provider_insurance_min_include_auto_liability": {
- "type": "boolean"
- },
- "include_provider_insurance_min_include_cyber_liability": {
- "type": "boolean"
- },
- "include_provider_insurance_min_include_employer_liability": {
- "type": "boolean"
- },
- "include_provider_insurance_min_include_general_liability": {
- "type": "boolean"
- },
- "include_provider_insurance_min_include_workers_comp": {
- "type": "boolean"
- },
- "include_publicity_rights": {
- "type": "boolean"
- },
- "include_publicity_rights_type": {
- "enum": [
- "public",
- "non-public"
- ],
- "type": "string"
- },
- "include_security_policy": {
- "type": "boolean"
- },
- "include_security_policy_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_security_policy_fedramp_auth": {
- "type": "boolean"
- },
- "include_security_policy_hitrust": {
- "type": "boolean"
- },
- "include_security_policy_include_annual_maintenance": {
- "type": "boolean"
- },
- "include_security_policy_include_other": {
- "type": "boolean"
- },
- "include_security_policy_include_other_val": {
- "type": "string"
- },
- "include_security_policy_iso27001": {
- "type": "boolean"
- },
- "include_security_policy_location": {
- "type": "string"
- },
- "include_security_policy_pci1": {
- "type": "boolean"
- },
- "include_security_policy_pci2": {
- "type": "boolean"
- },
- "include_security_policy_penetration_testing": {
- "type": "boolean"
- },
- "include_security_policy_soc2_type1": {
- "type": "boolean"
- },
- "include_security_policy_soc2_type2": {
- "type": "boolean"
- },
- "include_security_policy_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_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": {
- "enum": [
- "qty",
- "currency",
- "period"
- ],
- "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": {
- "enum": [
- "hours",
- "days",
- "weeks",
- "months"
- ],
- "type": "string"
- },
- "include_deliverables_resubmission_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_deliverables_resubmission_unit": {
- "enum": [
- "hours",
- "days",
- "weeks",
- "months"
- ],
- "type": "string"
- },
- "include_fees_other": {
- "type": "boolean"
- },
- "include_fees_other_val": {
- "type": "string"
- },
- "include_fees_table": {
- "type": "boolean"
- },
- "include_fees_table_total": {
- "type": "boolean"
- },
- "include_fees_travel": {
- "type": "boolean"
- },
- "include_fees_travel_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_fees_travel_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_fees_travel_val": {
- "type": "string"
- },
- "include_third_party_customer": {
- "type": "boolean"
- },
- "include_third_party_include_description": {
- "type": "boolean"
- },
- "include_third_party_include_description_val": {
- "type": "string"
- },
- "include_third_party_materials": {
- "type": "boolean"
- },
- "include_third_party_provider": {
- "type": "boolean"
- },
- "include_time_of_assignment": {
- "type": "boolean"
- },
- "include_time_of_assignment_type": {
- "enum": [
- "created",
- "paid"
- ],
- "type": "string"
- },
- "invoice_period_description": {
- "type": "string"
- },
- "negotiations_allowed": {
- "description": "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": {
- "enum": [
- "receipt",
- "invoice",
- "Customer's receipt of invoice",
- "date of invoice"
- ],
- "type": "string"
- },
- "payment_period_type": {
- "enum": [
- "standard",
- "other"
- ],
- "type": "string"
- },
- "payment_period_unit": {
- "enum": [
- "day(s)",
- "week(s)",
- "month(s)",
- "quarter(s)",
- "year(s)"
- ],
- "type": "string"
- },
- "services_description": {
- "type": "string"
- },
- "sow_date": {
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "sow_date_type": {
- "enum": [
- "signature",
- "date"
- ],
- "type": "string"
- },
- "sow_term_amount": {
- "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": {
- "enum": [
- "deliverables",
- "period",
- "date"
- ],
- "type": "string"
- },
- "sow_term_unit": {
- "enum": [
- "month(s)",
- "quarter(s)",
- "year(s)"
- ],
- "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": {
- "enum": [
- "signature",
- "date"
- ],
- "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": {
- "enum": [
- "default_language",
- "description"
- ],
- "type": "string"
- },
- "include_fees_unit": {
- "enum": [
- "month",
- "quarter",
- "year",
- "Term"
- ],
- "type": "string"
- },
- "include_program_appear_as_customer_private": {
- "type": "boolean"
- },
- "include_program_appear_as_customer_public": {
- "type": "boolean"
- },
- "include_program_case_study": {
- "type": "boolean"
- },
- "include_program_develop_functionality": {
- "type": "boolean"
- },
- "include_program_develop_functionality_val": {
- "type": "string"
- },
- "include_program_discount": {
- "type": "boolean"
- },
- "include_program_discount_amount": {
- "type": "number"
- },
- "include_program_discount_unit": {
- "enum": [
- "U.S. Dollars",
- "percent"
- ],
- "type": "string"
- },
- "include_program_participation_feedback": {
- "type": "boolean"
- },
- "include_program_participation_feedback_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_program_participation_feedback_unit": {
- "enum": [
- "month",
- "quarter",
- "year",
- "Term"
- ],
- "type": "string"
- },
- "include_program_partner_other": {
- "type": "boolean"
- },
- "include_program_partner_other_val": {
- "type": "string"
- },
- "include_program_provider_other": {
- "type": "boolean"
- },
- "include_program_provider_other_val": {
- "type": "string"
- },
- "include_program_reference": {
- "type": "boolean"
- },
- "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": {
- "enum": [
- "day(s)",
- "week(s)",
- "month(s)",
- "quarter(s)",
- "year(s)"
- ],
- "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": {
- "enum": [
- "stripe",
- "link"
- ],
- "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": {
- "enum": [
- "signature",
- "date"
- ],
- "type": "string"
- },
- "general_cap_amount": {
- "type": "number"
- },
- "general_cap_amount_type": {
- "enum": [
- "preceding",
- "base",
- "period"
- ],
- "type": "string"
- },
- "general_cap_period_currency": {
- "type": "number"
- },
- "general_cap_period_qty": {
- "type": "number"
- },
- "general_cap_preceding_amount": {
- "type": "number"
- },
- "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": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_increased_cap_amount": {
- "type": "boolean"
- },
- "include_increased_claims": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_confidentiality": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_confidentiality_negligence": {
- "type": "boolean"
- },
- "include_increased_claims_include_other": {
- "type": "boolean"
- },
- "include_increased_claims_indemnification_obligation": {
- "type": "boolean"
- },
- "include_increased_claims_negligence": {
- "type": "boolean"
- },
- "include_increased_claims_other": {
- "type": "string"
- },
- "include_increased_claims_restrictions": {
- "type": "boolean"
- },
- "include_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": {
- "enum": [
- "qty",
- "currency",
- "period"
- ],
- "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": {
- "enum": [
- "automatic",
- "manual"
- ],
- "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": {
- "enum": [
- "automatic",
- "invoice"
- ],
- "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": {
- "enum": [
- "Subscription Period",
- "month",
- "year",
- "Custom unit"
- ],
- "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": {
- "enum": [
- "USD",
- "EUR",
- "GBP",
- "CAD",
- "AUD",
- "SGD",
- "ILS",
- "JPY",
- "CHF",
- "HKD"
- ],
- "type": "string"
- },
- "fees_include_fee_increase_upon_renewal": {
- "type": "boolean"
- },
- "fees_include_fee_increase_upon_renewal_fee": {
- "type": "number"
- },
- "fees_include_fee_increase_upon_renewal_type": {
- "enum": [
- "will",
- "may"
- ],
- "type": "string"
- },
- "fees_inclusive_of_taxes": {
- "type": "boolean"
- },
- "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": {
- "enum": [
- "day",
- "week",
- "month"
- ],
- "type": "string"
- },
- "include_pilot_period_include_fees": {
- "type": "boolean"
- },
- "include_pilot_period_include_fees_amount": {
- "type": "number"
- },
- "include_pilot_period_include_modifications": {
- "type": "boolean"
- },
- "include_pilot_period_include_modifications_description": {
- "type": "string"
- },
- "include_services": {
- "type": "boolean"
- },
- "include_services_description": {
- "type": "string"
- },
- "negotiations_allowed": {
- "description": "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": {
- "enum": [
- "signature",
- "date",
- "other"
- ],
- "type": "string"
- },
- "payment_process_automatic_frequency": {
- "enum": [
- "monthly",
- "quarterly",
- "semiannually",
- "annually"
- ],
- "type": "string"
- },
- "payment_process_type": {
- "enum": [
- "automatic",
- "invoice",
- "custom"
- ],
- "type": "string"
- },
- "payment_process_type_custom_val": {
- "type": "string"
- },
- "payment_process_type_invoice_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "payment_process_type_invoice_custom_unit": {
- "type": "string"
- },
- "payment_process_type_invoice_duration": {
- "enum": [
- "day",
- "week",
- "month",
- "year",
- "day(s)",
- "week(s)",
- "month(s)",
- "year(s)"
- ],
- "type": "string"
- },
- "payment_process_type_invoice_duration_start": {
- "enum": [
- "Customer's receipt of invoice",
- "date of invoice"
- ],
- "type": "string"
- },
- "payment_process_type_invoice_type": {
- "enum": [
- "monthly",
- "quarterly",
- "semiannually",
- "annually",
- "Custom unit"
- ],
- "type": "string"
- },
- "permitted_uses_include_custom": {
- "type": "boolean"
- },
- "permitted_uses_include_custom_description": {
- "type": "string"
- },
- "permitted_uses_include_customers_affiliates": {
- "type": "boolean"
- },
- "permitted_uses_include_internal_business": {
- "type": "boolean"
- },
- "pilot_period_stripe_product_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-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": {
- "enum": [
- "days",
- "subscription_end"
- ],
- "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": {
- "enum": [
- "day",
- "week",
- "month",
- "year"
- ],
- "type": "string"
- },
- "warranty_period_description_duration_start": {
- "enum": [
- "initial delivery of the Software",
- "delivery of the Software and each subsequent Update",
- "the Order Date"
- ],
- "type": "string"
- },
- "warranty_period_type": {
- "enum": [
- "description",
- "none"
- ],
- "type": "string"
- }
- },
- "type": "object"
- }
- },
- "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": {
- "enum": [
- "signature",
- "date"
- ],
- "type": "string"
- },
- "fees_type": {
- "enum": [
- "free",
- "pilot_period_fees"
- ],
- "type": "string"
- },
- "general_cap_amount": {
- "type": "number"
- },
- "general_cap_amount_type": {
- "enum": [
- "preceding",
- "base",
- "period"
- ],
- "type": "string"
- },
- "general_cap_period_currency": {
- "type": "number"
- },
- "general_cap_period_qty": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "general_cap_preceding_amount": {
- "type": "number"
- },
- "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": {
- "enum": [
- "description",
- "attachment",
- "standard"
- ],
- "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": {
- "enum": [
- "monthly",
- "quarterly",
- "annually",
- "once_per_period"
- ],
- "type": "string"
- },
- "payment_process_invoice_days": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "payment_process_invoice_from": {
- "enum": [
- "receipt",
- "date"
- ],
- "type": "string"
- },
- "payment_process_invoice_timeframe": {
- "enum": [
- "days",
- "weeks",
- "months",
- "quarters",
- "years"
- ],
- "type": "string"
- },
- "payment_process_type": {
- "enum": [
- "automatic",
- "invoice"
- ],
- "type": "string"
- },
- "pilot_period_description": {
- "type": "string"
- },
- "pilot_period_fees_description": {
- "type": "string"
- },
- "product_description": {
- "type": "string"
- },
- "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": {
- "enum": [
- "signature",
- "date"
- ],
- "type": "string"
- },
- "general_cap_amount_currency_val": {
- "type": "number"
- },
- "general_cap_amount_either_currency": {
- "type": "number"
- },
- "general_cap_amount_either_multiple": {
- "type": "number"
- },
- "general_cap_amount_multiple_val": {
- "type": "number"
- },
- "general_cap_amount_type": {
- "enum": [
- "multiple",
- "currency",
- "either",
- "base"
- ],
- "type": "string"
- },
- "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": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_increased_cap_amount": {
- "type": "boolean"
- },
- "include_increased_cap_amount_currency": {
- "type": "number"
- },
- "include_increased_cap_amount_either_currency": {
- "type": "number"
- },
- "include_increased_cap_amount_either_multiple": {},
- "include_increased_cap_amount_multiple": {},
- "include_increased_cap_amount_type": {
- "enum": [
- "multiple",
- "currency",
- "either"
- ],
- "type": "string"
- },
- "include_increased_claims": {
- "type": "boolean"
- },
- "include_increased_claims_include_confidentiality": {
- "type": "boolean"
- },
- "include_increased_claims_include_confidentiality_misconduct": {
- "type": "boolean"
- },
- "include_increased_claims_include_covered_claims": {
- "type": "boolean"
- },
- "include_increased_claims_include_misconduct": {
- "type": "boolean"
- },
- "include_increased_claims_include_other": {
- "type": "boolean"
- },
- "include_increased_claims_include_other_val": {
- "type": "string"
- },
- "include_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": {
- "enum": [
- "month(s)",
- "quarter(s)",
- "year(s)"
- ],
- "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": {
- "enum": [
- "date",
- "effective date"
- ],
- "type": "string"
- },
- "include_obligations_company_brand": {
- "type": "boolean"
- },
- "include_obligations_company_promotion": {
- "type": "boolean"
- },
- "include_obligations_company_promotion_include_activities": {
- "type": "boolean"
- },
- "include_obligations_company_promotion_include_activities_val": {
- "type": "string"
- },
- "include_obligations_company_promotion_include_materials": {
- "type": "boolean"
- },
- "include_obligations_company_promotion_include_materials_val": {
- "type": "string"
- },
- "include_obligations_company_referral": {
- "type": "boolean"
- },
- "include_obligations_company_referral_include_criteria": {
- "type": "boolean"
- },
- "include_obligations_company_referral_include_criteria_val": {
- "type": "string"
- },
- "include_obligations_company_referral_include_pay_sch": {
- "type": "boolean"
- },
- "include_obligations_company_referral_include_pay_sch_amount": {
- "type": "number"
- },
- "include_obligations_company_referral_include_pay_sch_custom": {
- "type": "string"
- },
- "include_obligations_company_referral_include_pay_sch_unit": {
- "enum": [
- "U.S. Dollars",
- "percent"
- ],
- "type": "string"
- },
- "include_obligations_company_sponsorship": {
- "type": "boolean"
- },
- "include_obligations_company_sponsorship_include_benefits": {
- "type": "boolean"
- },
- "include_obligations_company_sponsorship_include_benefits_val": {
- "type": "string"
- },
- "include_obligations_company_sponsorship_include_payments": {
- "type": "boolean"
- },
- "include_obligations_company_sponsorship_include_payments_amount": {
- "type": "number"
- },
- "include_obligations_company_sponsorship_include_payments_unit": {
- "enum": [
- "U.S. Dollars",
- "percent"
- ],
- "type": "string"
- },
- "include_obligations_partner_brand": {
- "type": "boolean"
- },
- "include_obligations_partner_promotion": {
- "type": "boolean"
- },
- "include_obligations_partner_promotion_include_activities": {
- "type": "boolean"
- },
- "include_obligations_partner_promotion_include_activities_val": {
- "type": "string"
- },
- "include_obligations_partner_promotion_include_materials": {
- "type": "boolean"
- },
- "include_obligations_partner_promotion_include_materials_val": {
- "type": "string"
- },
- "include_obligations_partner_referral": {
- "type": "boolean"
- },
- "include_obligations_partner_referral_include_criteria": {
- "type": "boolean"
- },
- "include_obligations_partner_referral_include_criteria_val": {
- "type": "string"
- },
- "include_obligations_partner_referral_include_pay_sch": {
- "type": "boolean"
- },
- "include_obligations_partner_referral_include_pay_sch_amount": {
- "type": "number"
- },
- "include_obligations_partner_referral_include_pay_sch_custom": {
- "type": "string"
- },
- "include_obligations_partner_referral_include_pay_sch_unit": {
- "enum": [
- "U.S. Dollars",
- "percent"
- ],
- "type": "string"
- },
- "include_obligations_partner_sponsorship": {
- "type": "boolean"
- },
- "include_obligations_partner_sponsorship_include_benefits": {
- "type": "boolean"
- },
- "include_obligations_partner_sponsorship_include_benefits_val": {
- "type": "string"
- },
- "include_obligations_partner_sponsorship_include_payments": {
- "type": "boolean"
- },
- "include_obligations_partner_sponsorship_include_payments_amount": {
- "type": "number"
- },
- "include_obligations_partner_sponsorship_include_payments_unit": {
- "enum": [
- "U.S. Dollars",
- "percent"
- ],
- "type": "string"
- },
- "include_payment_process": {
- "type": "boolean"
- },
- "include_payment_process_company": {
- "type": "boolean"
- },
- "include_payment_process_company_include_address": {
- "type": "boolean"
- },
- "include_payment_process_company_include_address_city": {
- "type": "string"
- },
- "include_payment_process_company_include_address_country": {
- "type": "string"
- },
- "include_payment_process_company_include_address_state": {
- "type": "string"
- },
- "include_payment_process_company_include_address_street_address": {
- "type": "string"
- },
- "include_payment_process_company_include_address_zipcode": {
- "type": "string"
- },
- "include_payment_process_company_include_email": {
- "type": "boolean"
- },
- "include_payment_process_company_include_email_val": {
- "format": "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": {
- "enum": [
- "receipt",
- "date"
- ],
- "type": "string"
- },
- "include_payment_schedule_specified_unit": {
- "enum": [
- "day(s)",
- "week(s)",
- "month(s)",
- "quarter(s)",
- "year(s)"
- ],
- "type": "string"
- },
- "include_payment_schedule_type": {
- "enum": [
- "specified",
- "custom"
- ],
- "type": "string"
- },
- "negotiations_allowed": {
- "description": "Whether counterparties can propose changes to agreements created from this template.",
- "type": "boolean"
- },
- "territory_type": {
- "enum": [
- "worldwide",
- "custom"
- ],
- "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": {
- "enum": [
- "hours",
- "business days",
- "calendar days"
- ],
- "type": "string"
- },
- "breach_notification_val": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "business_associate_relationship_type": {
- "enum": [
- "provider",
- "company"
- ],
- "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": {
- "enum": [
- "signature",
- "date"
- ],
- "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": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "confidentiality_type": {
- "enum": [
- "mutual",
- "nda",
- "provider",
- "custom"
- ],
- "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": {
- "enum": [
- "month",
- "year",
- "quarter"
- ],
- "type": "string"
- },
- "include_fees_include_amount": {
- "type": "boolean"
- },
- "include_fees_include_other": {
- "type": "boolean"
- },
- "include_fees_other": {
- "type": "string"
- },
- "include_functionality": {
- "type": "boolean"
- },
- "include_functionality_val": {
- "type": "string"
- },
- "include_launch_date": {
- "type": "boolean"
- },
- "include_launch_date_custom": {
- "type": "string"
- },
- "include_launch_date_date": {
- "format": "date-time",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$",
- "type": "string"
- },
- "include_launch_date_type": {
- "enum": [
- "date",
- "custom"
- ],
- "type": "string"
- },
- "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-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": {
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "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": {
+ "enum": [
+ "stripe",
+ "link"
+ ],
+ "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-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": {
+ "enum": [
+ "AWS",
+ "GCP",
+ "Azure"
+ ],
+ "type": "string"
+ },
+ "effective_date_type": {
+ "enum": [
+ "signature",
+ "date",
+ "marketplace_acceptance"
+ ],
+ "type": "string"
+ },
+ "general_cap_amount": {
+ "type": "number"
+ },
+ "general_cap_amount_type": {
+ "enum": [
+ "preceding",
+ "base",
+ "period"
+ ],
+ "type": "string"
+ },
+ "general_cap_period_currency": {
+ "type": "number"
+ },
+ "general_cap_period_qty": {
+ "type": "number"
+ },
+ "general_cap_preceding_amount": {
+ "type": "number"
+ },
+ "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": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "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": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_increased_cap_amount": {
+ "type": "boolean"
+ },
+ "include_increased_claims": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_confidentiality": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_confidentiality_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_privsec": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_privsec_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_other": {
+ "type": "boolean"
+ },
+ "include_increased_claims_indemnification_obligation": {
+ "type": "boolean"
+ },
+ "include_increased_claims_other": {
+ "type": "string"
+ },
+ "include_insurance_minimums": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_add_customer": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_add_customer_com_gen_liability": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_add_customer_cyber_liability": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_add_customer_errors_omissions": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_additional_information": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_additional_information_text": {
+ "type": "string"
+ },
+ "include_insurance_minimums_cyber_liability_aggregate": {
+ "type": "number"
+ },
+ "include_insurance_minimums_cyber_liability_minimum": {
+ "type": "number"
+ },
+ "include_insurance_minimums_employer_liability_aggregate": {
+ "type": "number"
+ },
+ "include_insurance_minimums_employer_liability_minimum": {
+ "type": "number"
+ },
+ "include_insurance_minimums_general_liability_aggregate": {
+ "type": "number"
+ },
+ "include_insurance_minimums_general_liability_minimum": {
+ "type": "number"
+ },
+ "include_insurance_minimums_include_cyber_liability": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_include_employer_liability": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_include_general_liability": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_include_workers_compensation": {
+ "type": "boolean"
+ },
+ "include_publicity_rights": {
+ "type": "boolean"
+ },
+ "include_publicity_rights_type": {
+ "enum": [
+ "public",
+ "non-public"
+ ],
+ "type": "string"
+ },
+ "include_security_policy": {
+ "type": "boolean"
+ },
+ "include_security_policy_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_security_policy_fedramp_auth": {
+ "type": "boolean"
+ },
+ "include_security_policy_hipaa": {
+ "type": "boolean"
+ },
+ "include_security_policy_hitrust": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_annual_maintenance": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_location": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_other": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_reasonable_efforts": {
+ "type": "boolean"
+ },
+ "include_security_policy_iso27001": {
+ "type": "boolean"
+ },
+ "include_security_policy_location": {
+ "type": "string"
+ },
+ "include_security_policy_other": {
+ "type": "string"
+ },
+ "include_security_policy_pci1": {
+ "type": "boolean"
+ },
+ "include_security_policy_pci2": {
+ "type": "boolean"
+ },
+ "include_security_policy_penetration_testing": {
+ "type": "boolean"
+ },
+ "include_security_policy_soc2": {
+ "type": "boolean"
+ },
+ "include_security_policy_soc2_type2": {
+ "type": "boolean"
+ },
+ "include_security_policy_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_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": {
+ "type": "number"
+ },
+ "increased_cap_amount_qty": {
+ "type": "number"
+ },
+ "increased_cap_amount_type": {
+ "enum": [
+ "qty",
+ "currency",
+ "period"
+ ],
+ "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": {
+ "enum": [
+ "automatic",
+ "invoice"
+ ],
+ "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": {
+ "enum": [
+ "Subscription Period",
+ "month",
+ "year",
+ "User",
+ "Custom unit"
+ ],
+ "type": "string"
+ },
+ "fees_attributes": {
+ "description": "Fee table rows. On update, an item without `id` adds a fee; 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 fee.",
+ "type": "boolean"
+ },
+ "attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-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"
+ },
+ "id": {
+ "description": "ID of an existing fee to update or remove. Omit to add a new fee.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "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": {
+ "enum": [
+ "USD",
+ "EUR",
+ "GBP",
+ "CAD",
+ "AUD",
+ "SGD",
+ "ILS",
+ "JPY",
+ "CHF",
+ "HKD"
+ ],
+ "type": "string"
+ },
+ "fees_include_fee_increase_upon_renewal": {
+ "type": "boolean"
+ },
+ "fees_include_fee_increase_upon_renewal_fee": {
+ "type": "number"
+ },
+ "fees_include_fee_increase_upon_renewal_type": {
+ "enum": [
+ "will",
+ "may"
+ ],
+ "type": "string"
+ },
+ "fees_inclusive_of_taxes": {
+ "type": "boolean"
+ },
+ "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": {
+ "enum": [
+ "Subscription Period",
+ "month",
+ "year",
+ "User"
+ ],
+ "type": "string"
+ },
+ "include_free_trial": {
+ "type": "boolean"
+ },
+ "include_max_users": {
+ "type": "boolean"
+ },
+ "include_pilot_period": {
+ "type": "boolean"
+ },
+ "include_pilot_period_duration_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_pilot_period_duration_type": {
+ "enum": [
+ "day",
+ "week",
+ "month"
+ ],
+ "type": "string"
+ },
+ "include_pilot_period_include_fees": {
+ "type": "boolean"
+ },
+ "include_pilot_period_include_fees_amount": {
+ "type": "number"
+ },
+ "include_pilot_period_include_modifications": {
+ "type": "boolean"
+ },
+ "include_pilot_period_include_modifications_description": {
+ "type": "string"
+ },
+ "include_product_support": {
+ "type": "boolean"
+ },
+ "include_product_support_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_product_support_description": {
+ "type": "string"
+ },
+ "include_product_support_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_professional_services": {
+ "type": "boolean"
+ },
+ "include_professional_services_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_professional_services_custom_name": {
+ "type": "string"
+ },
+ "include_professional_services_description": {
+ "type": "string"
+ },
+ "include_professional_services_end_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "include_professional_services_fees_description": {
+ "type": "string"
+ },
+ "include_professional_services_include_end_date": {
+ "type": "boolean"
+ },
+ "include_professional_services_include_fees_description": {
+ "type": "boolean"
+ },
+ "include_professional_services_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_sla": {
+ "type": "boolean"
+ },
+ "include_sla_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_sla_description": {
+ "type": "string"
+ },
+ "include_sla_include_response_time": {
+ "type": "boolean"
+ },
+ "include_sla_include_response_time_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_sla_include_response_time_credit": {
+ "type": "number"
+ },
+ "include_sla_include_response_time_duration": {
+ "enum": [
+ "hour",
+ "day",
+ "week",
+ "month",
+ "hours"
+ ],
+ "type": "string"
+ },
+ "include_sla_include_response_time_support_channel": {
+ "type": "string"
+ },
+ "include_sla_include_target_uptime": {
+ "type": "boolean"
+ },
+ "include_sla_maintenance_notice": {
+ "type": "boolean"
+ },
+ "include_sla_maintenance_window": {
+ "type": "boolean"
+ },
+ "include_sla_maintenance_window_type": {
+ "enum": [
+ "standard",
+ "none"
+ ],
+ "type": "string"
+ },
+ "include_sla_standard_maintenance_notice_qty": {
+ "type": "number"
+ },
+ "include_sla_standard_maintenance_notice_unit": {
+ "enum": [
+ "hour",
+ "day",
+ "week",
+ "month"
+ ],
+ "type": "string"
+ },
+ "include_sla_standard_maintenance_window_end_time": {
+ "type": "string"
+ },
+ "include_sla_standard_maintenance_window_friday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_monday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_saturday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_start_time": {
+ "type": "string"
+ },
+ "include_sla_standard_maintenance_window_sunday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_thursday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_time_zone": {
+ "type": "string"
+ },
+ "include_sla_standard_maintenance_window_tuesday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_wednesday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_target_uptime": {
+ "type": "number"
+ },
+ "include_sla_type": {
+ "enum": [
+ "description",
+ "standard",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_subscription_start_date": {
+ "type": "boolean"
+ },
+ "include_subscription_start_date_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "include_usage_review": {
+ "type": "boolean"
+ },
+ "include_usage_review_val": {
+ "type": "string"
+ },
+ "include_use_limitations": {
+ "type": "boolean"
+ },
+ "include_use_limitations_val": {
+ "type": "string"
+ },
+ "invoice_period": {
+ "enum": [
+ "monthly",
+ "quarterly",
+ "semiannually",
+ "annually",
+ "Custom unit",
+ "Monthly",
+ "Quarterly",
+ "Semiannually",
+ "Annually"
+ ],
+ "type": "string"
+ },
+ "invoice_period_custom_unit": {
+ "type": "string"
+ },
+ "max_consumption": {
+ "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": {
+ "enum": [
+ "signature",
+ "date",
+ "other"
+ ],
+ "type": "string"
+ },
+ "payment_period": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "payment_period_timeframe": {
+ "enum": [
+ "Customer's receipt of invoice",
+ "date of invoice"
+ ],
+ "type": "string"
+ },
+ "payment_period_unit": {
+ "enum": [
+ "day(s)",
+ "week(s)",
+ "month(s)",
+ "marketplace_acceptance"
+ ],
+ "type": "string"
+ },
+ "payment_process_automatic_frequency": {
+ "enum": [
+ "monthly",
+ "quarterly",
+ "semiannually",
+ "annually"
+ ],
+ "type": "string"
+ },
+ "payment_process_type": {
+ "enum": [
+ "automatic",
+ "invoice",
+ "custom",
+ "marketplace_acceptance"
+ ],
+ "type": "string"
+ },
+ "payment_process_type_custom_val": {
+ "type": "string"
+ },
+ "payment_process_type_invoice_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "payment_process_type_invoice_custom_unit": {
+ "type": "string"
+ },
+ "payment_process_type_invoice_duration": {
+ "enum": [
+ "day",
+ "week",
+ "month",
+ "year",
+ "day(s)",
+ "week(s)",
+ "month(s)",
+ "year(s)"
+ ],
+ "type": "string"
+ },
+ "payment_process_type_invoice_duration_start": {
+ "enum": [
+ "Customer's receipt of invoice",
+ "date of invoice"
+ ],
+ "type": "string"
+ },
+ "payment_process_type_invoice_type": {
+ "enum": [
+ "monthly",
+ "quarterly",
+ "semiannually",
+ "annually",
+ "Custom unit"
+ ],
+ "type": "string"
+ },
+ "pilot_period_stripe_product_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-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": {
+ "enum": [
+ "days",
+ "subscription_end"
+ ],
+ "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": {
+ "enum": [
+ "effective_date",
+ "date"
+ ],
+ "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-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-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-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": {
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "type": "string"
+ },
+ "general_cap_amount": {
+ "type": "number"
+ },
+ "general_cap_amount_type": {
+ "enum": [
+ "preceding",
+ "base",
+ "period"
+ ],
+ "type": "string"
+ },
+ "general_cap_period_currency": {
+ "type": "number"
+ },
+ "general_cap_period_qty": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "general_cap_preceding_amount": {
+ "type": "number"
+ },
+ "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": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_dpa": {
+ "type": "boolean"
+ },
+ "include_dpa_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_dpa_location": {
+ "type": "string"
+ },
+ "include_dpa_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_increased_cap_amount": {
+ "type": "boolean"
+ },
+ "include_increased_claims": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_confidentiality": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_confidentiality_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_privsec": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_privsec_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_other": {
+ "type": "boolean"
+ },
+ "include_increased_claims_indemnification_obligation": {
+ "type": "boolean"
+ },
+ "include_increased_claims_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_other": {
+ "type": "string"
+ },
+ "include_provider_insurance_min": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_add_customer_com_gen_liability": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_add_customer_cyber_liability": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_add_customer_errors_omissions": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_auto_liability_aggregate": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_auto_liability_minimum": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_cyber_liability_aggregate": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_cyber_liability_minimum": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_employer_liability_aggregate": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_employer_liability_minimum": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_general_liability_aggregate": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_general_liability_minimum": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_include_add_customer": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_include_auto_liability": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_include_cyber_liability": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_include_employer_liability": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_include_general_liability": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_include_workers_comp": {
+ "type": "boolean"
+ },
+ "include_publicity_rights": {
+ "type": "boolean"
+ },
+ "include_publicity_rights_type": {
+ "enum": [
+ "public",
+ "non-public"
+ ],
+ "type": "string"
+ },
+ "include_security_policy": {
+ "type": "boolean"
+ },
+ "include_security_policy_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_security_policy_fedramp_auth": {
+ "type": "boolean"
+ },
+ "include_security_policy_hitrust": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_annual_maintenance": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_other": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_other_val": {
+ "type": "string"
+ },
+ "include_security_policy_iso27001": {
+ "type": "boolean"
+ },
+ "include_security_policy_location": {
+ "type": "string"
+ },
+ "include_security_policy_pci1": {
+ "type": "boolean"
+ },
+ "include_security_policy_pci2": {
+ "type": "boolean"
+ },
+ "include_security_policy_penetration_testing": {
+ "type": "boolean"
+ },
+ "include_security_policy_soc2_type1": {
+ "type": "boolean"
+ },
+ "include_security_policy_soc2_type2": {
+ "type": "boolean"
+ },
+ "include_security_policy_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_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": {
+ "enum": [
+ "qty",
+ "currency",
+ "period"
+ ],
+ "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": {
+ "description": "Fee table rows. On update, an item without `id` adds a fee; 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 fee.",
+ "type": "boolean"
+ },
+ "cost": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "description": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "id": {
+ "description": "ID of an existing fee to update or remove. Omit to add a new fee.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "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": {
+ "enum": [
+ "hours",
+ "days",
+ "weeks",
+ "months"
+ ],
+ "type": "string"
+ },
+ "include_deliverables_resubmission_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_deliverables_resubmission_unit": {
+ "enum": [
+ "hours",
+ "days",
+ "weeks",
+ "months"
+ ],
+ "type": "string"
+ },
+ "include_fees_other": {
+ "type": "boolean"
+ },
+ "include_fees_other_val": {
+ "type": "string"
+ },
+ "include_fees_table": {
+ "type": "boolean"
+ },
+ "include_fees_table_total": {
+ "type": "boolean"
+ },
+ "include_fees_travel": {
+ "type": "boolean"
+ },
+ "include_fees_travel_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_fees_travel_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_fees_travel_val": {
+ "type": "string"
+ },
+ "include_third_party_customer": {
+ "type": "boolean"
+ },
+ "include_third_party_include_description": {
+ "type": "boolean"
+ },
+ "include_third_party_include_description_val": {
+ "type": "string"
+ },
+ "include_third_party_materials": {
+ "type": "boolean"
+ },
+ "include_third_party_provider": {
+ "type": "boolean"
+ },
+ "include_time_of_assignment": {
+ "type": "boolean"
+ },
+ "include_time_of_assignment_type": {
+ "enum": [
+ "created",
+ "paid"
+ ],
+ "type": "string"
+ },
+ "invoice_period_description": {
+ "type": "string"
+ },
+ "negotiations_allowed": {
+ "description": "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": {
+ "enum": [
+ "receipt",
+ "invoice",
+ "Customer's receipt of invoice",
+ "date of invoice"
+ ],
+ "type": "string"
+ },
+ "payment_period_type": {
+ "enum": [
+ "standard",
+ "other"
+ ],
+ "type": "string"
+ },
+ "payment_period_unit": {
+ "enum": [
+ "day(s)",
+ "week(s)",
+ "month(s)",
+ "quarter(s)",
+ "year(s)"
+ ],
+ "type": "string"
+ },
+ "services_description": {
+ "type": "string"
+ },
+ "sow_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "sow_date_type": {
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "type": "string"
+ },
+ "sow_term_amount": {
+ "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": {
+ "enum": [
+ "deliverables",
+ "period",
+ "date"
+ ],
+ "type": "string"
+ },
+ "sow_term_unit": {
+ "enum": [
+ "month(s)",
+ "quarter(s)",
+ "year(s)"
+ ],
+ "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-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": {
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "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": {
+ "enum": [
+ "default_language",
+ "description"
+ ],
+ "type": "string"
+ },
+ "include_fees_unit": {
+ "enum": [
+ "month",
+ "quarter",
+ "year",
+ "Term"
+ ],
+ "type": "string"
+ },
+ "include_program_appear_as_customer_private": {
+ "type": "boolean"
+ },
+ "include_program_appear_as_customer_public": {
+ "type": "boolean"
+ },
+ "include_program_case_study": {
+ "type": "boolean"
+ },
+ "include_program_develop_functionality": {
+ "type": "boolean"
+ },
+ "include_program_develop_functionality_val": {
+ "type": "string"
+ },
+ "include_program_discount": {
+ "type": "boolean"
+ },
+ "include_program_discount_amount": {
+ "type": "number"
+ },
+ "include_program_discount_unit": {
+ "enum": [
+ "U.S. Dollars",
+ "percent"
+ ],
+ "type": "string"
+ },
+ "include_program_participation_feedback": {
+ "type": "boolean"
+ },
+ "include_program_participation_feedback_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_program_participation_feedback_unit": {
+ "enum": [
+ "month",
+ "quarter",
+ "year",
+ "Term"
+ ],
+ "type": "string"
+ },
+ "include_program_partner_other": {
+ "type": "boolean"
+ },
+ "include_program_partner_other_val": {
+ "type": "string"
+ },
+ "include_program_provider_other": {
+ "type": "boolean"
+ },
+ "include_program_provider_other_val": {
+ "type": "string"
+ },
+ "include_program_reference": {
+ "type": "boolean"
+ },
+ "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": {
+ "enum": [
+ "day(s)",
+ "week(s)",
+ "month(s)",
+ "quarter(s)",
+ "year(s)"
+ ],
+ "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": {
+ "enum": [
+ "stripe",
+ "link"
+ ],
+ "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-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": {
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "type": "string"
+ },
+ "general_cap_amount": {
+ "type": "number"
+ },
+ "general_cap_amount_type": {
+ "enum": [
+ "preceding",
+ "base",
+ "period"
+ ],
+ "type": "string"
+ },
+ "general_cap_period_currency": {
+ "type": "number"
+ },
+ "general_cap_period_qty": {
+ "type": "number"
+ },
+ "general_cap_preceding_amount": {
+ "type": "number"
+ },
+ "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": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_increased_cap_amount": {
+ "type": "boolean"
+ },
+ "include_increased_claims": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_confidentiality": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_confidentiality_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_other": {
+ "type": "boolean"
+ },
+ "include_increased_claims_indemnification_obligation": {
+ "type": "boolean"
+ },
+ "include_increased_claims_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_other": {
+ "type": "string"
+ },
+ "include_increased_claims_restrictions": {
+ "type": "boolean"
+ },
+ "include_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": {
+ "enum": [
+ "qty",
+ "currency",
+ "period"
+ ],
+ "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": {
+ "enum": [
+ "automatic",
+ "manual"
+ ],
+ "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": {
+ "enum": [
+ "automatic",
+ "invoice"
+ ],
+ "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": {
+ "enum": [
+ "Subscription Period",
+ "month",
+ "year",
+ "Custom unit"
+ ],
+ "type": "string"
+ },
+ "fees_attributes": {
+ "description": "Fee table rows. On update, an item without `id` adds a fee; 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 fee.",
+ "type": "boolean"
+ },
+ "attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-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"
+ },
+ "id": {
+ "description": "ID of an existing fee to update or remove. Omit to add a new fee.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "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": {
+ "enum": [
+ "USD",
+ "EUR",
+ "GBP",
+ "CAD",
+ "AUD",
+ "SGD",
+ "ILS",
+ "JPY",
+ "CHF",
+ "HKD"
+ ],
+ "type": "string"
+ },
+ "fees_include_fee_increase_upon_renewal": {
+ "type": "boolean"
+ },
+ "fees_include_fee_increase_upon_renewal_fee": {
+ "type": "number"
+ },
+ "fees_include_fee_increase_upon_renewal_type": {
+ "enum": [
+ "will",
+ "may"
+ ],
+ "type": "string"
+ },
+ "fees_inclusive_of_taxes": {
+ "type": "boolean"
+ },
+ "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": {
+ "enum": [
+ "day",
+ "week",
+ "month"
+ ],
+ "type": "string"
+ },
+ "include_pilot_period_include_fees": {
+ "type": "boolean"
+ },
+ "include_pilot_period_include_fees_amount": {
+ "type": "number"
+ },
+ "include_pilot_period_include_modifications": {
+ "type": "boolean"
+ },
+ "include_pilot_period_include_modifications_description": {
+ "type": "string"
+ },
+ "include_services": {
+ "type": "boolean"
+ },
+ "include_services_description": {
+ "type": "string"
+ },
+ "negotiations_allowed": {
+ "description": "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": {
+ "enum": [
+ "signature",
+ "date",
+ "other"
+ ],
+ "type": "string"
+ },
+ "payment_process_automatic_frequency": {
+ "enum": [
+ "monthly",
+ "quarterly",
+ "semiannually",
+ "annually"
+ ],
+ "type": "string"
+ },
+ "payment_process_type": {
+ "enum": [
+ "automatic",
+ "invoice",
+ "custom"
+ ],
+ "type": "string"
+ },
+ "payment_process_type_custom_val": {
+ "type": "string"
+ },
+ "payment_process_type_invoice_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "payment_process_type_invoice_custom_unit": {
+ "type": "string"
+ },
+ "payment_process_type_invoice_duration": {
+ "enum": [
+ "day",
+ "week",
+ "month",
+ "year",
+ "day(s)",
+ "week(s)",
+ "month(s)",
+ "year(s)"
+ ],
+ "type": "string"
+ },
+ "payment_process_type_invoice_duration_start": {
+ "enum": [
+ "Customer's receipt of invoice",
+ "date of invoice"
+ ],
+ "type": "string"
+ },
+ "payment_process_type_invoice_type": {
+ "enum": [
+ "monthly",
+ "quarterly",
+ "semiannually",
+ "annually",
+ "Custom unit"
+ ],
+ "type": "string"
+ },
+ "permitted_uses_include_custom": {
+ "type": "boolean"
+ },
+ "permitted_uses_include_custom_description": {
+ "type": "string"
+ },
+ "permitted_uses_include_customers_affiliates": {
+ "type": "boolean"
+ },
+ "permitted_uses_include_internal_business": {
+ "type": "boolean"
+ },
+ "pilot_period_stripe_product_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-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": {
+ "enum": [
+ "days",
+ "subscription_end"
+ ],
+ "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": {
+ "enum": [
+ "day",
+ "week",
+ "month",
+ "year"
+ ],
+ "type": "string"
+ },
+ "warranty_period_description_duration_start": {
+ "enum": [
+ "initial delivery of the Software",
+ "delivery of the Software and each subsequent Update",
+ "the Order Date"
+ ],
+ "type": "string"
+ },
+ "warranty_period_type": {
+ "enum": [
+ "description",
+ "none"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ }
+ },
+ "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-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": {
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "type": "string"
+ },
+ "fees_type": {
+ "enum": [
+ "free",
+ "pilot_period_fees"
+ ],
+ "type": "string"
+ },
+ "general_cap_amount": {
+ "type": "number"
+ },
+ "general_cap_amount_type": {
+ "enum": [
+ "preceding",
+ "base",
+ "period"
+ ],
+ "type": "string"
+ },
+ "general_cap_period_currency": {
+ "type": "number"
+ },
+ "general_cap_period_qty": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "general_cap_preceding_amount": {
+ "type": "number"
+ },
+ "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": {
+ "enum": [
+ "description",
+ "attachment",
+ "standard"
+ ],
+ "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": {
+ "enum": [
+ "monthly",
+ "quarterly",
+ "annually",
+ "once_per_period"
+ ],
+ "type": "string"
+ },
+ "payment_process_invoice_days": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "payment_process_invoice_from": {
+ "enum": [
+ "receipt",
+ "date"
+ ],
+ "type": "string"
+ },
+ "payment_process_invoice_timeframe": {
+ "enum": [
+ "days",
+ "weeks",
+ "months",
+ "quarters",
+ "years"
+ ],
+ "type": "string"
+ },
+ "payment_process_type": {
+ "enum": [
+ "automatic",
+ "invoice"
+ ],
+ "type": "string"
+ },
+ "pilot_period_description": {
+ "type": "string"
+ },
+ "pilot_period_fees_description": {
+ "type": "string"
+ },
+ "product_description": {
+ "type": "string"
+ },
+ "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-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": {
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "type": "string"
+ },
+ "general_cap_amount_currency_val": {
+ "type": "number"
+ },
+ "general_cap_amount_either_currency": {
+ "type": "number"
+ },
+ "general_cap_amount_either_multiple": {
+ "type": "number"
+ },
+ "general_cap_amount_multiple_val": {
+ "type": "number"
+ },
+ "general_cap_amount_type": {
+ "enum": [
+ "multiple",
+ "currency",
+ "either",
+ "base"
+ ],
+ "type": "string"
+ },
+ "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": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_increased_cap_amount": {
+ "type": "boolean"
+ },
+ "include_increased_cap_amount_currency": {
+ "type": "number"
+ },
+ "include_increased_cap_amount_either_currency": {
+ "type": "number"
+ },
+ "include_increased_cap_amount_either_multiple": {},
+ "include_increased_cap_amount_multiple": {},
+ "include_increased_cap_amount_type": {
+ "enum": [
+ "multiple",
+ "currency",
+ "either"
+ ],
+ "type": "string"
+ },
+ "include_increased_claims": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_confidentiality": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_confidentiality_misconduct": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_covered_claims": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_misconduct": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_other": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_other_val": {
+ "type": "string"
+ },
+ "include_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": {
+ "enum": [
+ "month(s)",
+ "quarter(s)",
+ "year(s)"
+ ],
+ "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": {
+ "enum": [
+ "date",
+ "effective date"
+ ],
+ "type": "string"
+ },
+ "include_obligations_company_brand": {
+ "type": "boolean"
+ },
+ "include_obligations_company_promotion": {
+ "type": "boolean"
+ },
+ "include_obligations_company_promotion_include_activities": {
+ "type": "boolean"
+ },
+ "include_obligations_company_promotion_include_activities_val": {
+ "type": "string"
+ },
+ "include_obligations_company_promotion_include_materials": {
+ "type": "boolean"
+ },
+ "include_obligations_company_promotion_include_materials_val": {
+ "type": "string"
+ },
+ "include_obligations_company_referral": {
+ "type": "boolean"
+ },
+ "include_obligations_company_referral_include_criteria": {
+ "type": "boolean"
+ },
+ "include_obligations_company_referral_include_criteria_val": {
+ "type": "string"
+ },
+ "include_obligations_company_referral_include_pay_sch": {
+ "type": "boolean"
+ },
+ "include_obligations_company_referral_include_pay_sch_amount": {
+ "type": "number"
+ },
+ "include_obligations_company_referral_include_pay_sch_custom": {
+ "type": "string"
+ },
+ "include_obligations_company_referral_include_pay_sch_unit": {
+ "enum": [
+ "U.S. Dollars",
+ "percent"
+ ],
+ "type": "string"
+ },
+ "include_obligations_company_sponsorship": {
+ "type": "boolean"
+ },
+ "include_obligations_company_sponsorship_include_benefits": {
+ "type": "boolean"
+ },
+ "include_obligations_company_sponsorship_include_benefits_val": {
+ "type": "string"
+ },
+ "include_obligations_company_sponsorship_include_payments": {
+ "type": "boolean"
+ },
+ "include_obligations_company_sponsorship_include_payments_amount": {
+ "type": "number"
+ },
+ "include_obligations_company_sponsorship_include_payments_unit": {
+ "enum": [
+ "U.S. Dollars",
+ "percent"
+ ],
+ "type": "string"
+ },
+ "include_obligations_partner_brand": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_promotion": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_promotion_include_activities": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_promotion_include_activities_val": {
+ "type": "string"
+ },
+ "include_obligations_partner_promotion_include_materials": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_promotion_include_materials_val": {
+ "type": "string"
+ },
+ "include_obligations_partner_referral": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_referral_include_criteria": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_referral_include_criteria_val": {
+ "type": "string"
+ },
+ "include_obligations_partner_referral_include_pay_sch": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_referral_include_pay_sch_amount": {
+ "type": "number"
+ },
+ "include_obligations_partner_referral_include_pay_sch_custom": {
+ "type": "string"
+ },
+ "include_obligations_partner_referral_include_pay_sch_unit": {
+ "enum": [
+ "U.S. Dollars",
+ "percent"
+ ],
+ "type": "string"
+ },
+ "include_obligations_partner_sponsorship": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_sponsorship_include_benefits": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_sponsorship_include_benefits_val": {
+ "type": "string"
+ },
+ "include_obligations_partner_sponsorship_include_payments": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_sponsorship_include_payments_amount": {
+ "type": "number"
+ },
+ "include_obligations_partner_sponsorship_include_payments_unit": {
+ "enum": [
+ "U.S. Dollars",
+ "percent"
+ ],
+ "type": "string"
+ },
+ "include_payment_process": {
+ "type": "boolean"
+ },
+ "include_payment_process_company": {
+ "type": "boolean"
+ },
+ "include_payment_process_company_include_address": {
+ "type": "boolean"
+ },
+ "include_payment_process_company_include_address_city": {
+ "type": "string"
+ },
+ "include_payment_process_company_include_address_country": {
+ "type": "string"
+ },
+ "include_payment_process_company_include_address_state": {
+ "type": "string"
+ },
+ "include_payment_process_company_include_address_street_address": {
+ "type": "string"
+ },
+ "include_payment_process_company_include_address_zipcode": {
+ "type": "string"
+ },
+ "include_payment_process_company_include_email": {
+ "type": "boolean"
+ },
+ "include_payment_process_company_include_email_val": {
+ "format": "email",
+ "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "include_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-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": {
+ "enum": [
+ "receipt",
+ "date"
+ ],
+ "type": "string"
+ },
+ "include_payment_schedule_specified_unit": {
+ "enum": [
+ "day(s)",
+ "week(s)",
+ "month(s)",
+ "quarter(s)",
+ "year(s)"
+ ],
+ "type": "string"
+ },
+ "include_payment_schedule_type": {
+ "enum": [
+ "specified",
+ "custom"
+ ],
+ "type": "string"
+ },
+ "negotiations_allowed": {
+ "description": "Whether counterparties can propose changes to agreements created from this template.",
+ "type": "boolean"
+ },
+ "territory_type": {
+ "enum": [
+ "worldwide",
+ "custom"
+ ],
+ "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": {
+ "enum": [
+ "hours",
+ "business days",
+ "calendar days"
+ ],
+ "type": "string"
+ },
+ "breach_notification_val": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "business_associate_relationship_type": {
+ "enum": [
+ "provider",
+ "company"
+ ],
+ "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-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": {
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "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": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "confidentiality_type": {
+ "enum": [
+ "mutual",
+ "nda",
+ "provider",
+ "custom"
+ ],
+ "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-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": {
+ "enum": [
+ "month",
+ "year",
+ "quarter"
+ ],
+ "type": "string"
+ },
+ "include_fees_include_amount": {
+ "type": "boolean"
+ },
+ "include_fees_include_other": {
+ "type": "boolean"
+ },
+ "include_fees_other": {
+ "type": "string"
+ },
+ "include_functionality": {
+ "type": "boolean"
+ },
+ "include_functionality_val": {
+ "type": "string"
+ },
+ "include_launch_date": {
+ "type": "boolean"
+ },
+ "include_launch_date_custom": {
+ "type": "string"
+ },
+ "include_launch_date_date": {
+ "format": "date-time",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$",
+ "type": "string"
+ },
+ "include_launch_date_type": {
+ "enum": [
+ "date",
+ "custom"
+ ],
+ "type": "string"
+ },
+ "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"
+ }
+]upload-attachment_application_json1 field changedInput schema / properties / body / anyOfPrevious value: -[
- {
- "additionalProperties": false,
- "description": "MCP clients: send metadata only. Returns a curl_command to POST the local PDF bytes. Do not send pdf/base64. uploaded_by is taken from the OAuth-authenticated MCP user — do not pass it.",
- "properties": {
- "attachment": {
- "additionalProperties": {},
- "properties": {
- "description": {
- "description": "Optional description of the file",
- "type": "string"
- },
- "filename": {
- "description": "Local PDF path on the client machine (e.g. ./Cloud Service Agreement.pdf). Must not contain control characters (newlines, null bytes, etc.). The server shell-escapes this value when building curl_command (including apostrophes); run the returned command exactly as-is and do not re-quote or edit the @path.",
- "maxLength": 1024,
- "minLength": 1,
- "pattern": "^[^\\u0000-\\u001F\\u007F]+$",
- "type": "string"
- },
- "name": {
- "description": "Optional Common Paper attachment name. Supply only when it should differ from the basename of filename.",
- "type": "string"
- }
- },
- "required": [
- "filename"
- ],
- "type": "object"
- }
- },
- "required": [
- "attachment"
- ],
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "application/json body for API clients. Pass the PDF as base64 in `attachment.pdf` (not a filesystem path).",
- "properties": {
- "attachment": {
- "additionalProperties": {},
- "description": "The attachment to create",
- "properties": {
- "description": {
- "description": "Optional description of the file",
- "type": "string"
- },
- "name": {
- "description": "Display name for the uploaded file, including the .pdf extension",
- "type": "string"
- },
- "pdf": {
- "description": "Base64-encoded PDF file contents. Must be the raw file bytes encoded as base64 — not a filesystem path, data URI, or filename. Example: open the PDF, base64-encode its bytes, and pass that string here.",
- "type": "string"
- },
- "uploaded_by": {
- "description": "Email of a Common Paper user associated with your organization. Required for API-key uploads; not used for MCP (OAuth identity is used instead).",
- "format": "email",
- "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
- "type": "string"
- }
- },
- "required": [
- "pdf",
- "name",
- "uploaded_by"
- ],
- "type": "object"
- }
- },
- "required": [
- "attachment"
- ],
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "multipart/form-data body. Send fields as `attachment[pdf]`, `attachment[name]`, `attachment[description]`, and `attachment[uploaded_by]`.",
- "properties": {
- "attachment": {
- "additionalProperties": {},
- "description": "The attachment to create. In multipart/form-data, send each field as `attachment[pdf]`, `attachment[name]`, `attachment[description]`, and `attachment[uploaded_by]`.",
- "properties": {
- "description": {
- "description": "Optional description of the file",
- "type": "string"
- },
- "name": {
- "description": "Name of the file",
- "type": "string"
- },
- "pdf": {
- "description": "The PDF file to upload as a multipart file part",
- "type": "string"
- },
- "uploaded_by": {
- "description": "Email of a Common Paper user associated with your organization. Required for API-key uploads; not used for MCP (OAuth identity is used instead).",
- "format": "email",
- "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
- "type": "string"
- }
- },
- "required": [
- "pdf",
- "name",
- "uploaded_by"
- ],
- "type": "object"
- }
- },
- "required": [
- "attachment"
- ],
- "type": "object"
- }
-]New value: +[
+ {
+ "additionalProperties": false,
+ "description": "MCP clients: send metadata only. Returns a curl_command to POST the local PDF bytes. Do not send pdf/base64. uploaded_by is taken from the OAuth-authenticated MCP user — do not pass it.",
+ "properties": {
+ "attachment": {
+ "additionalProperties": {},
+ "properties": {
+ "description": {
+ "description": "Optional description of the file",
+ "type": "string"
+ },
+ "filename": {
+ "description": "Local PDF path on the client machine (e.g. ./Cloud Service Agreement.pdf). Must not contain control characters (newlines, null bytes, etc.). The server shell-escapes this value when building curl_command (including apostrophes); run the returned command exactly as-is and do not re-quote or edit the @path.",
+ "maxLength": 1024,
+ "minLength": 1,
+ "pattern": "^[^\\u0000-\\u001F\\u007F]+$",
+ "type": "string"
+ },
+ "name": {
+ "description": "Optional Common Paper attachment name. Supply only when it should differ from the basename of filename.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "filename"
+ ],
+ "type": "object"
+ }
+ },
+ "required": [
+ "attachment"
+ ],
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "application/json body for API clients. Pass the PDF as base64 in `attachment.pdf` (not a filesystem path).",
+ "properties": {
+ "attachment": {
+ "additionalProperties": {},
+ "description": "The attachment to create",
+ "properties": {
+ "description": {
+ "description": "Optional description of the file",
+ "type": "string"
+ },
+ "name": {
+ "description": "Display name for the uploaded file, including the .pdf extension",
+ "type": "string"
+ },
+ "pdf": {
+ "description": "Base64-encoded PDF file contents. Must be the raw file bytes encoded as base64 — not a filesystem path, data URI, or filename. Example: open the PDF, base64-encode its bytes, and pass that string here.",
+ "type": "string"
+ },
+ "uploaded_by": {
+ "description": "Email of a Common Paper user associated with your organization. Required for API-key uploads; not used for MCP (OAuth identity is used instead).",
+ "format": "email",
+ "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ }
+ },
+ "required": [
+ "pdf",
+ "name",
+ "uploaded_by"
+ ],
+ "type": "object"
+ }
+ },
+ "required": [
+ "attachment"
+ ],
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "multipart/form-data body. Send fields as `attachment[pdf]`, `attachment[name]`, `attachment[description]`, and `attachment[uploaded_by]`.",
+ "properties": {
+ "attachment": {
+ "additionalProperties": {},
+ "description": "The attachment to create. In multipart/form-data, send each field as `attachment[pdf]`, `attachment[name]`, `attachment[description]`, and `attachment[uploaded_by]`.",
+ "properties": {
+ "description": {
+ "description": "Optional description of the file",
+ "type": "string"
+ },
+ "name": {
+ "description": "Name of the file",
+ "type": "string"
+ },
+ "pdf": {
+ "description": "The PDF file to upload as a multipart file part",
+ "type": "string"
+ },
+ "uploaded_by": {
+ "description": "Email of a Common Paper user associated with your organization. Required for API-key uploads; not used for MCP (OAuth identity is used instead).",
+ "format": "email",
+ "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ }
+ },
+ "required": [
+ "pdf",
+ "name",
+ "uploaded_by"
+ ],
+ "type": "object"
+ }
+ },
+ "required": [
+ "attachment"
+ ],
+ "type": "object"
+ }
+]upload-attachment_multipart_form_data1 field changedInput schema / properties / body / anyOfPrevious value: -[
- {
- "additionalProperties": false,
- "description": "MCP clients: send metadata only. Returns a curl_command to POST the local PDF bytes. Do not send pdf/base64. uploaded_by is taken from the OAuth-authenticated MCP user — do not pass it.",
- "properties": {
- "attachment": {
- "additionalProperties": {},
- "properties": {
- "description": {
- "description": "Optional description of the file",
- "type": "string"
- },
- "filename": {
- "description": "Local PDF path on the client machine (e.g. ./Cloud Service Agreement.pdf). Must not contain control characters (newlines, null bytes, etc.). The server shell-escapes this value when building curl_command (including apostrophes); run the returned command exactly as-is and do not re-quote or edit the @path.",
- "maxLength": 1024,
- "minLength": 1,
- "pattern": "^[^\\u0000-\\u001F\\u007F]+$",
- "type": "string"
- },
- "name": {
- "description": "Optional Common Paper attachment name. Supply only when it should differ from the basename of filename.",
- "type": "string"
- }
- },
- "required": [
- "filename"
- ],
- "type": "object"
- }
- },
- "required": [
- "attachment"
- ],
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "application/json body for API clients. Pass the PDF as base64 in `attachment.pdf` (not a filesystem path).",
- "properties": {
- "attachment": {
- "additionalProperties": {},
- "description": "The attachment to create",
- "properties": {
- "description": {
- "description": "Optional description of the file",
- "type": "string"
- },
- "name": {
- "description": "Display name for the uploaded file, including the .pdf extension",
- "type": "string"
- },
- "pdf": {
- "description": "Base64-encoded PDF file contents. Must be the raw file bytes encoded as base64 — not a filesystem path, data URI, or filename. Example: open the PDF, base64-encode its bytes, and pass that string here.",
- "type": "string"
- },
- "uploaded_by": {
- "description": "Email of a Common Paper user associated with your organization. Required for API-key uploads; not used for MCP (OAuth identity is used instead).",
- "format": "email",
- "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
- "type": "string"
- }
- },
- "required": [
- "pdf",
- "name",
- "uploaded_by"
- ],
- "type": "object"
- }
- },
- "required": [
- "attachment"
- ],
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "multipart/form-data body. Send fields as `attachment[pdf]`, `attachment[name]`, `attachment[description]`, and `attachment[uploaded_by]`.",
- "properties": {
- "attachment": {
- "additionalProperties": {},
- "description": "The attachment to create. In multipart/form-data, send each field as `attachment[pdf]`, `attachment[name]`, `attachment[description]`, and `attachment[uploaded_by]`.",
- "properties": {
- "description": {
- "description": "Optional description of the file",
- "type": "string"
- },
- "name": {
- "description": "Name of the file",
- "type": "string"
- },
- "pdf": {
- "description": "The PDF file to upload as a multipart file part",
- "type": "string"
- },
- "uploaded_by": {
- "description": "Email of a Common Paper user associated with your organization. Required for API-key uploads; not used for MCP (OAuth identity is used instead).",
- "format": "email",
- "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
- "type": "string"
- }
- },
- "required": [
- "pdf",
- "name",
- "uploaded_by"
- ],
- "type": "object"
- }
- },
- "required": [
- "attachment"
- ],
- "type": "object"
- }
-]New value: +[
+ {
+ "additionalProperties": false,
+ "description": "MCP clients: send metadata only. Returns a curl_command to POST the local PDF bytes. Do not send pdf/base64. uploaded_by is taken from the OAuth-authenticated MCP user — do not pass it.",
+ "properties": {
+ "attachment": {
+ "additionalProperties": {},
+ "properties": {
+ "description": {
+ "description": "Optional description of the file",
+ "type": "string"
+ },
+ "filename": {
+ "description": "Local PDF path on the client machine (e.g. ./Cloud Service Agreement.pdf). Must not contain control characters (newlines, null bytes, etc.). The server shell-escapes this value when building curl_command (including apostrophes); run the returned command exactly as-is and do not re-quote or edit the @path.",
+ "maxLength": 1024,
+ "minLength": 1,
+ "pattern": "^[^\\u0000-\\u001F\\u007F]+$",
+ "type": "string"
+ },
+ "name": {
+ "description": "Optional Common Paper attachment name. Supply only when it should differ from the basename of filename.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "filename"
+ ],
+ "type": "object"
+ }
+ },
+ "required": [
+ "attachment"
+ ],
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "application/json body for API clients. Pass the PDF as base64 in `attachment.pdf` (not a filesystem path).",
+ "properties": {
+ "attachment": {
+ "additionalProperties": {},
+ "description": "The attachment to create",
+ "properties": {
+ "description": {
+ "description": "Optional description of the file",
+ "type": "string"
+ },
+ "name": {
+ "description": "Display name for the uploaded file, including the .pdf extension",
+ "type": "string"
+ },
+ "pdf": {
+ "description": "Base64-encoded PDF file contents. Must be the raw file bytes encoded as base64 — not a filesystem path, data URI, or filename. Example: open the PDF, base64-encode its bytes, and pass that string here.",
+ "type": "string"
+ },
+ "uploaded_by": {
+ "description": "Email of a Common Paper user associated with your organization. Required for API-key uploads; not used for MCP (OAuth identity is used instead).",
+ "format": "email",
+ "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ }
+ },
+ "required": [
+ "pdf",
+ "name",
+ "uploaded_by"
+ ],
+ "type": "object"
+ }
+ },
+ "required": [
+ "attachment"
+ ],
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "multipart/form-data body. Send fields as `attachment[pdf]`, `attachment[name]`, `attachment[description]`, and `attachment[uploaded_by]`.",
+ "properties": {
+ "attachment": {
+ "additionalProperties": {},
+ "description": "The attachment to create. In multipart/form-data, send each field as `attachment[pdf]`, `attachment[name]`, `attachment[description]`, and `attachment[uploaded_by]`.",
+ "properties": {
+ "description": {
+ "description": "Optional description of the file",
+ "type": "string"
+ },
+ "name": {
+ "description": "Name of the file",
+ "type": "string"
+ },
+ "pdf": {
+ "description": "The PDF file to upload as a multipart file part",
+ "type": "string"
+ },
+ "uploaded_by": {
+ "description": "Email of a Common Paper user associated with your organization. Required for API-key uploads; not used for MCP (OAuth identity is used instead).",
+ "format": "email",
+ "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ }
+ },
+ "required": [
+ "pdf",
+ "name",
+ "uploaded_by"
+ ],
+ "type": "object"
+ }
+ },
+ "required": [
+ "attachment"
+ ],
+ "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": {
- "enum": [
- "signature",
- "date"
- ],
- "type": "string"
- },
- "framework_terms_type": {
- "type": "string"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "parent_agreement_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "underlying_agreement_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "underlying_agreement_type": {
- "type": "string"
- },
- "underlying_agreement_val": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "baa_attributes": {
- "additionalProperties": false,
- "description": "Override baa terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "aggregation_limitations_permitted": {
- "type": "boolean"
- },
- "aggregation_limitations_permitted_val": {
- "type": "string"
- },
- "breach_notification_unit": {
- "enum": [
- "hours",
- "business days",
- "calendar days"
- ],
- "type": "string"
- },
- "breach_notification_val": {
- "type": "number"
- },
- "business_associate_relationship_type": {
- "enum": [
- "provider",
- "company"
- ],
- "type": "string"
- },
- "deidentification_limitations_include_purpose": {
- "type": "boolean"
- },
- "deidentification_limitations_include_requirements": {
- "type": "boolean"
- },
- "deidentification_limitations_permitted": {
- "type": "boolean"
- },
- "deidentification_limitations_purpose_val": {
- "type": "string"
- },
- "deidentification_limitations_requirements_val": {
- "type": "string"
- },
- "designated_record_set_provider_maintains": {
- "type": "boolean"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_aggregation_limitations": {
- "type": "boolean"
- },
- "include_deidentification_limitations": {
- "type": "boolean"
- },
- "include_limitations": {
- "type": "boolean"
- },
- "include_offshore_limitations": {
- "type": "boolean"
- },
- "include_subcontract_limitations": {
- "type": "boolean"
- },
- "offshore_limitations_permitted": {
- "type": "boolean"
- },
- "offshore_limitations_permitted_val": {
- "type": "string"
- },
- "subcontract_limitations_include_notice": {
- "type": "boolean"
- },
- "subcontract_limitations_include_permission": {
- "type": "boolean"
- },
- "subcontract_limitations_notice_val": {
- "type": "string"
- },
- "subcontract_limitations_permission_val": {
- "type": "string"
- },
- "subcontract_limitations_permitted": {
- "type": "boolean"
- },
- "underlying_agreement_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "underlying_agreement_type": {
- "enum": [
- "internal",
- "external",
- "none"
- ],
- "type": "string"
- },
- "underlying_agreement_val": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "billing_email": {
- "description": "Email of the billing contact. Used when include_billing_info is true.",
- "format": "email",
- "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
- "type": "string"
- },
- "billing_name": {
- "description": "Name of the billing contact. Used when include_billing_info is true.",
- "type": "string"
- },
- "billing_workflow_type": {
- "description": "The type of billing workflow. Use \"link\" to provide a payment_link_url, or \"stripe\" for Stripe-managed billing.",
- "enum": [
- "link",
- "stripe"
- ],
- "type": "string"
- },
- "chosen_courts_country": {
- "description": "The country in which disputes will be resolved.",
- "type": "string"
- },
- "chosen_courts_region": {
- "description": "The state or region in which disputes will be resolved.",
- "type": "string"
- },
- "csa_attributes": {
- "additionalProperties": false,
- "description": "Override csa terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "customer_description": {
- "type": "string"
- },
- "effective_date": {
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "effective_date_marketplace": {
- "enum": [
- "AWS",
- "GCP",
- "Azure"
- ],
- "type": "string"
- },
- "effective_date_type": {
- "enum": [
- "signature",
- "date",
- "marketplace_acceptance"
- ],
- "type": "string"
- },
- "general_cap_amount": {
- "type": "number"
- },
- "general_cap_amount_type": {
- "enum": [
- "preceding",
- "base",
- "period"
- ],
- "type": "string"
- },
- "general_cap_period_currency": {
- "type": "number"
- },
- "general_cap_period_qty": {
- "type": "number"
- },
- "general_cap_preceding_amount": {
- "type": "number"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_acceptable_use_policy": {
- "type": "boolean"
- },
- "include_acceptable_use_policy_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_acceptable_use_policy_location": {
- "type": "string"
- },
- "include_acceptable_use_policy_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_additional_warranties": {
- "type": "boolean"
- },
- "include_additional_warranties_by_customer": {
- "type": "string"
- },
- "include_additional_warranties_by_provider": {
- "type": "string"
- },
- "include_additional_warranties_include_by_customer": {
- "type": "boolean"
- },
- "include_additional_warranties_include_by_provider": {
- "type": "boolean"
- },
- "include_ai_addendum": {
- "type": "boolean"
- },
- "include_ai_addendum_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_covered_claims": {
- "type": "boolean"
- },
- "include_covered_claims_customer_claims": {
- "type": "string"
- },
- "include_covered_claims_include_customer_claims": {
- "type": "boolean"
- },
- "include_covered_claims_include_provider_claims": {
- "type": "boolean"
- },
- "include_covered_claims_provider_claims": {
- "type": "string"
- },
- "include_dpa": {
- "type": "boolean"
- },
- "include_dpa_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_dpa_location": {
- "type": "string"
- },
- "include_dpa_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_increased_cap_amount": {
- "type": "boolean"
- },
- "include_increased_claims": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_confidentiality": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_confidentiality_negligence": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_privsec": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_privsec_negligence": {
- "type": "boolean"
- },
- "include_increased_claims_include_other": {
- "type": "boolean"
- },
- "include_increased_claims_indemnification_obligation": {
- "type": "boolean"
- },
- "include_increased_claims_other": {
- "type": "string"
- },
- "include_insurance_minimums": {
- "type": "boolean"
- },
- "include_insurance_minimums_add_customer": {
- "type": "boolean"
- },
- "include_insurance_minimums_add_customer_com_gen_liability": {
- "type": "boolean"
- },
- "include_insurance_minimums_add_customer_cyber_liability": {
- "type": "boolean"
- },
- "include_insurance_minimums_add_customer_errors_omissions": {
- "type": "boolean"
- },
- "include_insurance_minimums_additional_information": {
- "type": "boolean"
- },
- "include_insurance_minimums_additional_information_text": {
- "type": "string"
- },
- "include_insurance_minimums_cyber_liability_aggregate": {
- "type": "number"
- },
- "include_insurance_minimums_cyber_liability_minimum": {
- "type": "number"
- },
- "include_insurance_minimums_employer_liability_aggregate": {
- "type": "number"
- },
- "include_insurance_minimums_employer_liability_minimum": {
- "type": "number"
- },
- "include_insurance_minimums_general_liability_aggregate": {
- "type": "number"
- },
- "include_insurance_minimums_general_liability_minimum": {
- "type": "number"
- },
- "include_insurance_minimums_include_cyber_liability": {
- "type": "boolean"
- },
- "include_insurance_minimums_include_employer_liability": {
- "type": "boolean"
- },
- "include_insurance_minimums_include_general_liability": {
- "type": "boolean"
- },
- "include_insurance_minimums_include_workers_compensation": {
- "type": "boolean"
- },
- "include_publicity_rights": {
- "type": "boolean"
- },
- "include_publicity_rights_type": {
- "enum": [
- "public",
- "non-public"
- ],
- "type": "string"
- },
- "include_security_policy": {
- "type": "boolean"
- },
- "include_security_policy_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_security_policy_fedramp_auth": {
- "type": "boolean"
- },
- "include_security_policy_hipaa": {
- "type": "boolean"
- },
- "include_security_policy_hitrust": {
- "type": "boolean"
- },
- "include_security_policy_include_annual_maintenance": {
- "type": "boolean"
- },
- "include_security_policy_include_location": {
- "type": "boolean"
- },
- "include_security_policy_include_other": {
- "type": "boolean"
- },
- "include_security_policy_include_reasonable_efforts": {
- "type": "boolean"
- },
- "include_security_policy_iso27001": {
- "type": "boolean"
- },
- "include_security_policy_location": {
- "type": "string"
- },
- "include_security_policy_other": {
- "type": "string"
- },
- "include_security_policy_pci1": {
- "type": "boolean"
- },
- "include_security_policy_pci2": {
- "type": "boolean"
- },
- "include_security_policy_penetration_testing": {
- "type": "boolean"
- },
- "include_security_policy_soc2": {
- "type": "boolean"
- },
- "include_security_policy_soc2_type2": {
- "type": "boolean"
- },
- "include_security_policy_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_supercap": {
- "description": "CSA 3.0 renamed `include_increased_cap_amount` to `include_supercap`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_increased_cap_amount`. Sending the other spelling returns a 422.",
- "type": "boolean"
- },
- "include_uncapped_claims": {
- "description": "CSA 3.0 renamed `include_unlimited_claims` to `include_uncapped_claims`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims`. Sending the other spelling returns a 422.",
- "type": "boolean"
- },
- "include_uncapped_claims_breach_of_confidentiality": {
- "description": "CSA 3.0 renamed `include_unlimited_claims_breach_of_confidentiality` to `include_uncapped_claims_breach_of_confidentiality`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_breach_of_confidentiality`. Sending the other spelling returns a 422.",
- "type": "boolean"
- },
- "include_uncapped_claims_breach_of_confidentiality_negligence": {
- "description": "CSA 3.0 renamed `include_unlimited_claims_breach_of_confidentiality_negligence` to `include_uncapped_claims_breach_of_confidentiality_negligence`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_breach_of_confidentiality_negligence`. Sending the other spelling returns a 422.",
- "type": "boolean"
- },
- "include_uncapped_claims_breach_of_privsec": {
- "description": "CSA 3.0 renamed `include_unlimited_claims_breach_of_privsec` to `include_uncapped_claims_breach_of_privsec`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_breach_of_privsec`. Sending the other spelling returns a 422.",
- "type": "boolean"
- },
- "include_uncapped_claims_breach_of_privsec_negligence": {
- "description": "CSA 3.0 renamed `include_unlimited_claims_breach_of_privsec_negligence` to `include_uncapped_claims_breach_of_privsec_negligence`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_breach_of_privsec_negligence`. Sending the other spelling returns a 422.",
- "type": "boolean"
- },
- "include_uncapped_claims_include_other": {
- "description": "CSA 3.0 renamed `include_unlimited_claims_include_other` to `include_uncapped_claims_include_other`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_include_other`. Sending the other spelling returns a 422.",
- "type": "boolean"
- },
- "include_uncapped_claims_indemnification_obligation": {
- "description": "CSA 3.0 renamed `include_unlimited_claims_indemnification_obligation` to `include_uncapped_claims_indemnification_obligation`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_indemnification_obligation`. Sending the other spelling returns a 422.",
- "type": "boolean"
- },
- "include_uncapped_claims_other": {
- "description": "CSA 3.0 renamed `include_unlimited_claims_other` to `include_uncapped_claims_other`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_other`. Sending the other spelling returns a 422.",
- "type": "boolean"
- },
- "include_unlimited_claims": {
- "type": "boolean"
- },
- "include_unlimited_claims_breach_of_confidentiality": {
- "type": "boolean"
- },
- "include_unlimited_claims_breach_of_confidentiality_negligence": {
- "type": "boolean"
- },
- "include_unlimited_claims_breach_of_privsec": {
- "type": "boolean"
- },
- "include_unlimited_claims_breach_of_privsec_negligence": {
- "type": "boolean"
- },
- "include_unlimited_claims_include_other": {
- "type": "boolean"
- },
- "include_unlimited_claims_indemnification_obligation": {
- "type": "boolean"
- },
- "include_unlimited_claims_other": {
- "type": "string"
- },
- "increased_cap_amount_currency": {
- "type": "number"
- },
- "increased_cap_amount_period_currency": {
- "type": "number"
- },
- "increased_cap_amount_period_qty": {
- "type": "number"
- },
- "increased_cap_amount_qty": {
- "type": "number"
- },
- "increased_cap_amount_type": {
- "enum": [
- "qty",
- "currency",
- "period"
- ],
- "type": "string"
- },
- "provider": {
- "type": "string"
- },
- "supercap_currency": {
- "description": "CSA 3.0 renamed `increased_cap_amount_currency` to `supercap_currency`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `increased_cap_amount_currency`. Sending the other spelling returns a 422.",
- "type": "number"
- },
- "supercap_period_currency": {
- "description": "CSA 3.0 renamed `increased_cap_amount_period_currency` to `supercap_period_currency`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `increased_cap_amount_period_currency`. Sending the other spelling returns a 422.",
- "type": "number"
- },
- "supercap_period_qty": {
- "description": "CSA 3.0 renamed `increased_cap_amount_period_qty` to `supercap_period_qty`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `increased_cap_amount_period_qty`. Sending the other spelling returns a 422.",
- "type": "number"
- },
- "supercap_qty": {
- "description": "CSA 3.0 renamed `increased_cap_amount_qty` to `supercap_qty`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `increased_cap_amount_qty`. Sending the other spelling returns a 422.",
- "type": "number"
- },
- "supercap_type": {
- "description": "CSA 3.0 renamed `increased_cap_amount_type` to `supercap_type`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `increased_cap_amount_type`. Sending the other spelling returns a 422.",
- "type": "number"
- }
- },
- "type": "object"
- },
- "csa_order_form_attributes": {
- "additionalProperties": false,
- "description": "Override csa order form terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "additional_changes": {
- "type": "string"
- },
- "additional_parameters_or_limitations": {
- "type": "string"
- },
- "affiliates_as_users": {
- "type": "boolean"
- },
- "cloud_service_description": {
- "type": "string"
- },
- "consumption_units": {
- "type": "string"
- },
- "fee_amount": {
- "type": "number"
- },
- "fee_custom_unit": {
- "type": "string"
- },
- "fee_period": {
- "enum": [
- "Subscription Period",
- "month",
- "year",
- "User",
- "Custom unit"
- ],
- "type": "string"
- },
- "fees_attributes": {
- "additionalProperties": {
- "anyOf": [
- {
- "additionalProperties": false,
- "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": {
- "enum": [
- "USD",
- "EUR",
- "GBP",
- "CAD",
- "AUD",
- "SGD",
- "ILS",
- "JPY",
- "CHF",
- "HKD"
- ],
- "type": "string"
- },
- "fees_include_fee_increase_upon_renewal": {
- "type": "boolean"
- },
- "fees_include_fee_increase_upon_renewal_fee": {
- "type": "number"
- },
- "fees_include_fee_increase_upon_renewal_type": {
- "enum": [
- "will",
- "may"
- ],
- "type": "string"
- },
- "fees_inclusive_of_taxes": {
- "type": "boolean"
- },
- "framework_terms_type": {
- "enum": [
- "new",
- "existing",
- "description"
- ],
- "type": "string"
- },
- "free_trial_days": {
- "type": "number"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_additional_changes": {
- "type": "boolean"
- },
- "include_additional_parameters_or_limitations": {
- "type": "boolean"
- },
- "include_consumption": {
- "type": "boolean"
- },
- "include_fees": {
- "type": "boolean"
- },
- "include_fees_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_fees_include_attachment": {
- "type": "boolean"
- },
- "include_fees_other": {
- "type": "boolean"
- },
- "include_fees_other_val": {
- "type": "string"
- },
- "include_fees_table": {
- "type": "boolean"
- },
- "include_fees_table_period": {
- "enum": [
- "Subscription Period",
- "month",
- "year",
- "User"
- ],
- "type": "string"
- },
- "include_free_trial": {
- "type": "boolean"
- },
- "include_max_users": {
- "type": "boolean"
- },
- "include_pilot_period": {
- "type": "boolean"
- },
- "include_pilot_period_duration_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_pilot_period_duration_type": {
- "enum": [
- "day",
- "week",
- "month"
- ],
- "type": "string"
- },
- "include_pilot_period_include_fees": {
- "type": "boolean"
- },
- "include_pilot_period_include_fees_amount": {
- "type": "number"
- },
- "include_pilot_period_include_modifications": {
- "type": "boolean"
- },
- "include_pilot_period_include_modifications_description": {
- "type": "string"
- },
- "include_product_support": {
- "type": "boolean"
- },
- "include_product_support_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_product_support_description": {
- "type": "string"
- },
- "include_product_support_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_professional_services": {
- "type": "boolean"
- },
- "include_professional_services_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_professional_services_custom_name": {
- "type": "string"
- },
- "include_professional_services_description": {
- "type": "string"
- },
- "include_professional_services_end_date": {
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "include_professional_services_fees_description": {
- "type": "string"
- },
- "include_professional_services_include_end_date": {
- "type": "boolean"
- },
- "include_professional_services_include_fees_description": {
- "type": "boolean"
- },
- "include_professional_services_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_sla": {
- "type": "boolean"
- },
- "include_sla_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_sla_description": {
- "type": "string"
- },
- "include_sla_include_response_time": {
- "type": "boolean"
- },
- "include_sla_include_response_time_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_sla_include_response_time_credit": {
- "type": "number"
- },
- "include_sla_include_response_time_duration": {
- "enum": [
- "hour",
- "day",
- "week",
- "month",
- "hours"
- ],
- "type": "string"
- },
- "include_sla_include_response_time_support_channel": {
- "type": "string"
- },
- "include_sla_include_target_uptime": {
- "type": "boolean"
- },
- "include_sla_maintenance_notice": {
- "type": "boolean"
- },
- "include_sla_maintenance_window": {
- "type": "boolean"
- },
- "include_sla_maintenance_window_type": {
- "enum": [
- "standard",
- "none"
- ],
- "type": "string"
- },
- "include_sla_standard_maintenance_notice_qty": {
- "type": "number"
- },
- "include_sla_standard_maintenance_notice_unit": {
- "enum": [
- "hour",
- "day",
- "week",
- "month"
- ],
- "type": "string"
- },
- "include_sla_standard_maintenance_window_end_time": {
- "type": "string"
- },
- "include_sla_standard_maintenance_window_friday": {
- "type": "boolean"
- },
- "include_sla_standard_maintenance_window_monday": {
- "type": "boolean"
- },
- "include_sla_standard_maintenance_window_saturday": {
- "type": "boolean"
- },
- "include_sla_standard_maintenance_window_start_time": {
- "type": "string"
- },
- "include_sla_standard_maintenance_window_sunday": {
- "type": "boolean"
- },
- "include_sla_standard_maintenance_window_thursday": {
- "type": "boolean"
- },
- "include_sla_standard_maintenance_window_time_zone": {
- "type": "string"
- },
- "include_sla_standard_maintenance_window_tuesday": {
- "type": "boolean"
- },
- "include_sla_standard_maintenance_window_wednesday": {
- "type": "boolean"
- },
- "include_sla_standard_target_uptime": {
- "type": "number"
- },
- "include_sla_type": {
- "enum": [
- "description",
- "standard",
- "attachment"
- ],
- "type": "string"
- },
- "include_subscription_start_date": {
- "type": "boolean"
- },
- "include_subscription_start_date_date": {
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "include_usage_review": {
- "type": "boolean"
- },
- "include_usage_review_val": {
- "type": "string"
- },
- "include_use_limitations": {
- "type": "boolean"
- },
- "include_use_limitations_val": {
- "type": "string"
- },
- "invoice_period": {
- "enum": [
- "monthly",
- "quarterly",
- "semiannually",
- "annually",
- "Custom unit",
- "Monthly",
- "Quarterly",
- "Semiannually",
- "Annually"
- ],
- "type": "string"
- },
- "invoice_period_custom_unit": {
- "type": "string"
- },
- "max_consumption": {
- "type": "number"
- },
- "max_users": {
- "type": "number"
- },
- "negotiations_allowed": {
- "description": "When true, the recipient can propose changes to the order form, even when the agreement-level `negotiations_allowed` is false. This only covers the order form.",
- "type": "boolean"
- },
- "order_date_date": {
- "type": "string"
- },
- "order_date_other": {
- "type": "string"
- },
- "order_date_type": {
- "enum": [
- "signature",
- "date",
- "other"
- ],
- "type": "string"
- },
- "payment_period": {
- "type": "number"
- },
- "payment_period_timeframe": {
- "enum": [
- "Customer's receipt of invoice",
- "date of invoice"
- ],
- "type": "string"
- },
- "payment_period_unit": {
- "enum": [
- "day(s)",
- "week(s)",
- "month(s)",
- "marketplace_acceptance"
- ],
- "type": "string"
- },
- "payment_process_automatic_frequency": {
- "enum": [
- "monthly",
- "quarterly",
- "semiannually",
- "annually"
- ],
- "type": "string"
- },
- "payment_process_type": {
- "enum": [
- "automatic",
- "invoice",
- "custom",
- "marketplace_acceptance"
- ],
- "type": "string"
- },
- "payment_process_type_custom_val": {
- "type": "string"
- },
- "payment_process_type_invoice_amount": {
- "type": "number"
- },
- "payment_process_type_invoice_custom_unit": {
- "type": "string"
- },
- "payment_process_type_invoice_duration": {
- "enum": [
- "day",
- "week",
- "month",
- "year",
- "day(s)",
- "week(s)",
- "month(s)",
- "year(s)"
- ],
- "type": "string"
- },
- "payment_process_type_invoice_duration_start": {
- "enum": [
- "Customer's receipt of invoice",
- "date of invoice"
- ],
- "type": "string"
- },
- "payment_process_type_invoice_type": {
- "enum": [
- "monthly",
- "quarterly",
- "semiannually",
- "annually",
- "Custom unit"
- ],
- "type": "string"
- },
- "pilot_period_stripe_product_id": {
- "type": "string"
- },
- "service_credits_attributes": {
- "additionalProperties": {
- "additionalProperties": false,
- "properties": {
- "credit": {
- "type": "number"
- },
- "max": {
- "type": "number"
- },
- "min": {
- "type": "number"
- }
- },
- "type": "object"
- },
- "description": "Service credits. Use string keys such as \"0\", \"1\".",
- "propertyNames": {
- "type": "string"
- },
- "type": "object"
- },
- "subscription_auto_renew": {
- "enum": [
- "days",
- "subscription_end"
- ],
- "type": "string"
- },
- "subscription_period": {
- "type": "number"
- },
- "subscription_period_unit": {
- "type": "string"
- },
- "subscription_renewal_notice_days": {
- "type": "number"
- },
- "subscription_start_date": {
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "subscription_start_date_type": {
- "enum": [
- "effective_date",
- "date"
- ],
- "type": "string"
- },
- "underlying_agreement_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "use_limitations_attributes": {
- "additionalProperties": {
- "additionalProperties": false,
- "properties": {
- "amount": {
- "type": "number"
- },
- "limitation_type": {
- "type": "string"
- },
- "unit": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "description": "Use limitations. Use string keys such as \"0\", \"1\".",
- "propertyNames": {
- "type": "string"
- },
- "type": "object"
- }
- },
- "type": "object"
- },
- "custom_field_values": {
- "description": "Values for a custom template's fields, keyed by the field keys defined in the template's YAML definition. Only used when template_id is a custom template. Template defaults fill any fields you omit; a required field with no default and no submitted value returns a 400 naming the field. Values are validated against the field's input type: select and radio values must be one of the field's options, multiselect values are an array of selections each of which must be one of the field's options, number and currency values must be numeric, date values must be YYYY-MM-DD, and email values must be valid addresses. An invalid value returns a 400 naming the field."
- },
- "design_partner_attributes": {
- "additionalProperties": false,
- "description": "Override design partner terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "customer_description": {
- "type": "string"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_fees": {
- "type": "boolean"
- },
- "include_fees_amount": {
- "type": "number"
- },
- "include_fees_description": {
- "type": "string"
- },
- "include_fees_pay_by_amount": {
- "type": "string"
- },
- "include_fees_type": {
- "enum": [
- "default_language",
- "description"
- ],
- "type": "string"
- },
- "include_fees_unit": {
- "enum": [
- "month",
- "quarter",
- "year",
- "Term"
- ],
- "type": "string"
- },
- "include_program_appear_as_customer_private": {
- "type": "boolean"
- },
- "include_program_appear_as_customer_public": {
- "type": "boolean"
- },
- "include_program_case_study": {
- "type": "boolean"
- },
- "include_program_develop_functionality": {
- "type": "boolean"
- },
- "include_program_develop_functionality_val": {
- "type": "string"
- },
- "include_program_discount": {
- "type": "boolean"
- },
- "include_program_discount_amount": {
- "type": "number"
- },
- "include_program_discount_unit": {
- "enum": [
- "U.S. Dollars",
- "percent"
- ],
- "type": "string"
- },
- "include_program_participation_feedback": {
- "type": "boolean"
- },
- "include_program_participation_feedback_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_program_participation_feedback_unit": {
- "enum": [
- "month",
- "quarter",
- "year",
- "Term"
- ],
- "type": "string"
- },
- "include_program_partner_other": {
- "type": "boolean"
- },
- "include_program_partner_other_val": {
- "type": "string"
- },
- "include_program_provider_other": {
- "type": "boolean"
- },
- "include_program_provider_other_val": {
- "type": "string"
- },
- "include_program_reference": {
- "type": "boolean"
- },
- "product_description": {
- "type": "string"
- },
- "term_amount": {
- "type": "number"
- },
- "term_unit": {
- "enum": [
- "day(s)",
- "week(s)",
- "month(s)",
- "quarter(s)",
- "year(s)"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- "district_or_county": {
- "description": "The district or county for dispute resolution.",
- "type": "string"
- },
- "dpa_attributes": {
- "additionalProperties": false,
- "description": "Override dpa terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "approved_subprocessor_type": {
- "description": "`internal` lists approved subprocessors in the agreement (`subprocessors_attributes`); `external` points to a list published elsewhere.",
- "enum": [
- "internal",
- "external"
- ],
- "type": "string"
- },
- "cloud_service_product_name": {
- "type": "string"
- },
- "competent_supervisory_authority": {
- "type": "string"
- },
- "customer_description": {
- "type": "string"
- },
- "data_exporter_address_city": {
- "type": "string"
- },
- "data_exporter_address_country": {
- "type": "string"
- },
- "data_exporter_address_state": {
- "type": "string"
- },
- "data_exporter_address_street_address": {
- "type": "string"
- },
- "data_exporter_address_zipcode": {
- "type": "string"
- },
- "data_exporter_contact_details": {
- "type": "string"
- },
- "data_exporter_contact_name": {
- "type": "string"
- },
- "data_exporter_contact_position": {
- "type": "string"
- },
- "data_exporter_role": {
- "description": "Role of the data exporter. Overwritten to `Controller` when the agreement is created from a template.",
- "enum": [
- "Controller",
- "Processor"
- ],
- "type": "string"
- },
- "data_importer_address": {
- "type": "string"
- },
- "data_importer_address_city": {
- "type": "string"
- },
- "data_importer_address_country": {
- "type": "string"
- },
- "data_importer_address_state": {
- "type": "string"
- },
- "data_importer_address_street_address": {
- "type": "string"
- },
- "data_importer_address_zipcode": {
- "type": "string"
- },
- "data_importer_contact_details": {
- "type": "string"
- },
- "data_importer_contact_name": {
- "type": "string"
- },
- "data_importer_contact_position": {
- "type": "string"
- },
- "duration_of_processing": {
- "type": "string"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_covered_claim": {
- "type": "boolean"
- },
- "include_covered_claim_external_val": {
- "type": "string"
- },
- "include_covered_claim_internal_val": {
- "type": "string"
- },
- "include_covered_claim_type": {
- "description": "Which covered-claim text applies: `internal` uses `include_covered_claim_internal_val`, `external` uses `include_covered_claim_external_val`. Required when `include_covered_claim` is true.",
- "enum": [
- "internal",
- "external"
- ],
- "type": "string"
- },
- "include_data_subjects_custom": {
- "type": "boolean"
- },
- "include_data_subjects_custom_val": {
- "type": "string"
- },
- "include_data_subjects_employees": {
- "type": "boolean"
- },
- "include_data_subjects_end_users": {
- "type": "boolean"
- },
- "include_external_subprocessor_location": {
- "type": "string"
- },
- "include_frequency_of_transfer_continuous": {
- "type": "boolean"
- },
- "include_frequency_of_transfer_custom": {
- "type": "boolean"
- },
- "include_frequency_of_transfer_custom_val": {
- "type": "string"
- },
- "include_governing_country_eu": {
- "type": "boolean"
- },
- "include_governing_country_eu_val": {
- "type": "string"
- },
- "include_governing_country_uk": {
- "type": "boolean"
- },
- "include_governing_country_uk_val": {
- "type": "string"
- },
- "include_governing_law": {
- "type": "boolean"
- },
- "include_governing_law_country": {
- "type": "string"
- },
- "include_governing_law_state": {
- "type": "string"
- },
- "include_increased_claim_amount": {
- "description": "Legacy field. Stored but not shown on the DPA; use the `include_liability_cap*` fields instead.",
- "type": "boolean"
- },
- "include_increased_claim_amount_currency": {
- "description": "Legacy field. Stored but not shown on the DPA; use the `include_liability_cap*` fields instead."
- },
- "include_increased_claim_amount_qty": {
- "description": "Legacy field. Stored but not shown on the DPA; use the `include_liability_cap*` fields instead."
- },
- "include_increased_claim_amount_type": {
- "description": "Legacy field. Stored but not shown on the DPA; use the `include_liability_cap*` fields instead.",
- "type": "string"
- },
- "include_liability_cap": {
- "type": "boolean"
- },
- "include_liability_cap_amount_constant_external": {
- "type": "string"
- },
- "include_liability_cap_amount_constant_internal": {
- "type": "string"
- },
- "include_liability_cap_amount_currency_external": {
- "description": "Currency amount. Numbers and numeric strings (commas allowed) are both accepted."
- },
- "include_liability_cap_amount_currency_internal": {
- "description": "Currency amount. Numbers and numeric strings (commas allowed) are both accepted."
- },
- "include_liability_cap_csa_type": {
- "description": "Which liability cap values apply: the `_internal` or `_external` amount fields. Required when `include_liability_cap` is true.",
- "enum": [
- "internal",
- "external"
- ],
- "type": "string"
- },
- "include_personal_data_biographic_info": {
- "type": "boolean"
- },
- "include_personal_data_contact_info": {
- "type": "boolean"
- },
- "include_personal_data_custom": {
- "type": "boolean"
- },
- "include_personal_data_custom_val": {
- "type": "string"
- },
- "include_personal_data_employment_info": {
- "type": "boolean"
- },
- "include_personal_data_financial_info": {
- "type": "boolean"
- },
- "include_personal_data_location": {
- "type": "boolean"
- },
- "include_personal_data_name": {
- "type": "boolean"
- },
- "include_personal_data_transactional_info": {
- "type": "boolean"
- },
- "include_personal_data_user_activity_info": {
- "type": "boolean"
- },
- "include_processing_purpose_custom": {
- "type": "boolean"
- },
- "include_processing_purpose_custom_val": {
- "type": "string"
- },
- "include_processing_purpose_erasing": {
- "type": "boolean"
- },
- "include_processing_purpose_holding": {
- "type": "boolean"
- },
- "include_processing_purpose_protecting": {
- "type": "boolean"
- },
- "include_processing_purpose_receiving": {
- "type": "boolean"
- },
- "include_processing_purpose_returning": {
- "type": "boolean"
- },
- "include_processing_purpose_sharing": {
- "type": "boolean"
- },
- "include_processing_purpose_updating": {
- "type": "boolean"
- },
- "include_processing_purpose_using": {
- "type": "boolean"
- },
- "include_provider_security_contact_address": {
- "type": "boolean"
- },
- "include_provider_security_contact_address_city": {
- "type": "string"
- },
- "include_provider_security_contact_address_country": {
- "type": "string"
- },
- "include_provider_security_contact_address_state": {
- "type": "string"
- },
- "include_provider_security_contact_address_street_address": {
- "type": "string"
- },
- "include_provider_security_contact_address_zipcode": {
- "type": "string"
- },
- "include_provider_security_contact_email": {
- "type": "boolean"
- },
- "include_provider_security_contact_email_val": {
- "format": "email",
- "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
- "type": "string"
- },
- "include_security_measures_accountability": {
- "type": "boolean"
- },
- "include_security_measures_accountability_val": {
- "type": "string"
- },
- "include_security_measures_certification_or_assurance": {
- "type": "boolean"
- },
- "include_security_measures_certification_or_assurance_val": {
- "type": "string"
- },
- "include_security_measures_confidentiality_integrity": {
- "type": "boolean"
- },
- "include_security_measures_confidentiality_integrity_val": {
- "type": "string"
- },
- "include_security_measures_data_at_rest": {
- "type": "boolean"
- },
- "include_security_measures_data_at_rest_val": {
- "type": "string"
- },
- "include_security_measures_data_minimization": {
- "type": "boolean"
- },
- "include_security_measures_data_minimization_val": {
- "type": "string"
- },
- "include_security_measures_data_quality": {
- "type": "boolean"
- },
- "include_security_measures_data_quality_val": {
- "type": "string"
- },
- "include_security_measures_data_retention": {
- "type": "boolean"
- },
- "include_security_measures_data_retention_val": {
- "type": "string"
- },
- "include_security_measures_data_transmission": {
- "type": "boolean"
- },
- "include_security_measures_data_transmission_val": {
- "type": "string"
- },
- "include_security_measures_event_logging": {
- "type": "boolean"
- },
- "include_security_measures_event_logging_val": {
- "type": "string"
- },
- "include_security_measures_identity_auth": {
- "type": "boolean"
- },
- "include_security_measures_identity_auth_val": {
- "type": "string"
- },
- "include_security_measures_it_security_governance": {
- "type": "boolean"
- },
- "include_security_measures_it_security_governance_val": {
- "type": "string"
- },
- "include_security_measures_physical_security": {
- "type": "boolean"
- },
- "include_security_measures_physical_security_val": {
- "type": "string"
- },
- "include_security_measures_portability_and_erasure": {
- "type": "boolean"
- },
- "include_security_measures_portability_and_erasure_val": {
- "type": "string"
- },
- "include_security_measures_pseudonym_encryption": {
- "type": "boolean"
- },
- "include_security_measures_pseudonym_encryption_val": {
- "type": "string"
- },
- "include_security_measures_restore_data_access": {
- "type": "boolean"
- },
- "include_security_measures_restore_data_access_val": {
- "type": "string"
- },
- "include_security_measures_security_policy": {
- "type": "boolean"
- },
- "include_security_measures_system_configuration": {
- "type": "boolean"
- },
- "include_security_measures_system_configuration_val": {
- "type": "string"
- },
- "include_security_measures_testing_assessment": {
- "type": "boolean"
- },
- "include_security_measures_testing_assessment_val": {
- "type": "string"
- },
- "include_security_policy": {
- "type": "boolean"
- },
- "include_security_policy_fedramp_auth": {
- "type": "boolean"
- },
- "include_security_policy_hipaa": {
- "type": "boolean"
- },
- "include_security_policy_hitrust": {
- "type": "boolean"
- },
- "include_security_policy_include_other": {
- "type": "boolean"
- },
- "include_security_policy_iso27001": {
- "type": "boolean"
- },
- "include_security_policy_other": {
- "type": "string"
- },
- "include_security_policy_pci1": {
- "type": "boolean"
- },
- "include_security_policy_pci2": {
- "type": "boolean"
- },
- "include_security_policy_penetration_testing": {
- "type": "boolean"
- },
- "include_security_policy_soc2": {
- "type": "boolean"
- },
- "include_security_policy_soc2_type2": {
- "type": "boolean"
- },
- "include_sensitive_data_restrictions_custom": {
- "type": "boolean"
- },
- "include_sensitive_data_restrictions_custom_val": {
- "type": "string"
- },
- "include_sensitive_data_restrictions_security_policy": {
- "type": "boolean"
- },
- "include_service_provider_relationship": {
- "type": "boolean"
- },
- "include_special_category_data": {
- "type": "boolean"
- },
- "provider": {
- "type": "string"
- },
- "security_policy_available_at": {
- "type": "string"
- },
- "security_policy_type": {
- "description": "Where the Security Policy is defined. For `external`, set `security_policy_available_at`.",
- "enum": [
- "defined in agreement",
- "provider service",
- "external"
- ],
- "type": "string"
- },
- "subprocessors_attributes": {
- "additionalProperties": {
- "additionalProperties": false,
- "properties": {
- "_destroy": {
- "description": "Set to true with `id` to remove that subprocessor.",
- "type": "boolean"
- },
- "country": {
- "type": "string"
- },
- "id": {
- "description": "ID of an existing subprocessor to update or remove. Omit to add a new subprocessor.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "name": {
- "type": "string"
- },
- "processing_task": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "description": "Subprocessors, keyed by string index such as \"0\", \"1\". On create these are added to the template's subprocessors. On a draft update, an entry without `id` adds a new subprocessor; pass `id` to change one and `id` with `_destroy: true` to remove one.",
- "propertyNames": {
- "type": "string"
- },
- "type": "object"
- },
- "underlying_agreement_id": {
- "description": "ID of the CSA this DPA supplements when `underlying_agreement_type` is `internal`.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "underlying_agreement_type": {
- "description": "`internal` links a CSA in Common Paper (`underlying_agreement_id`); `external` describes another agreement in `underlying_agreement_val` (required). Omit for none.",
- "enum": [
- "internal",
- "external"
- ],
- "type": "string"
- },
- "underlying_agreement_val": {
- "description": "Description of the agreement this DPA supplements. Required when `underlying_agreement_type` is `external`.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "framework_terms_description": {
- "description": "Custom framework terms description. Only used when framework_terms_type is \"description\".",
- "type": "string"
- },
- "framework_terms_type": {
- "description": "How framework terms are specified. Use \"new\" for standard terms or \"description\" to provide a custom framework_terms_description.",
- "enum": [
- "new",
- "description"
- ],
- "type": "string"
- },
- "governing_law_country": {
- "description": "The country whose laws govern the agreement.",
- "type": "string"
- },
- "governing_law_region": {
- "description": "The state or region whose laws govern the agreement.",
- "type": "string"
- },
- "include_automated_payment_reminders": {
- "description": "When true, automatically sends payment reminder emails.",
- "type": "boolean"
- },
- "include_billing_info": {
- "description": "When true, billing contact information (billing_name, billing_email) is included.",
- "type": "boolean"
- },
- "include_billing_workflow": {
- "description": "When true, enables a billing workflow after signing.",
- "type": "boolean"
- },
- "include_expiration_date": {
- "description": "Expiration date in YYYY-MM-DD format. Use when include_expiration_type is \"date\".",
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "include_expiration_days": {
- "description": "Number of days until the agreement expires. Use when include_expiration_type is \"days\".",
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_expiration_type": {
- "description": "How to set expiration: \"none\" (default), \"days\" (use include_expiration_days), or \"date\" (use include_expiration_date).",
- "enum": [
- "none",
- "days",
- "date"
- ],
- "type": "string"
- },
- "include_terms": {
- "description": "When true, the standard terms are included with the agreement.",
- "type": "boolean"
- },
- "loi_attributes": {
- "additionalProperties": false,
- "description": "Override loi terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "confidentiality_custom": {
- "type": "string"
- },
- "confidentiality_mutual_include_loi": {
- "type": "boolean"
- },
- "confidentiality_nda_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "confidentiality_nda_description": {
- "type": "string"
- },
- "confidentiality_nda_include_loi": {
- "type": "boolean"
- },
- "confidentiality_nda_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "confidentiality_type": {
- "enum": [
- "mutual",
- "nda",
- "provider",
- "custom"
- ],
- "type": "string"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_custom_details": {
- "type": "boolean"
- },
- "include_custom_details_val": {
- "type": "string"
- },
- "include_fees": {
- "type": "boolean"
- },
- "include_fees_amount": {
- "type": "number"
- },
- "include_fees_amount_duration": {
- "enum": [
- "month",
- "year",
- "quarter"
- ],
- "type": "string"
- },
- "include_fees_include_amount": {
- "type": "boolean"
- },
- "include_fees_include_other": {
- "type": "boolean"
- },
- "include_fees_other": {
- "type": "string"
- },
- "include_functionality": {
- "type": "boolean"
- },
- "include_functionality_val": {
- "type": "string"
- },
- "include_launch_date": {
- "type": "boolean"
- },
- "include_launch_date_custom": {
- "type": "string"
- },
- "include_launch_date_date": {
- "format": "date-time",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$",
- "type": "string"
- },
- "include_launch_date_type": {
- "enum": [
- "date",
- "custom"
- ],
- "type": "string"
- },
- "product_name": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "manual_send": {
- "description": "When true, the agreement is marked as manually sent outside the platform.",
- "type": "boolean"
- },
- "message": {
- "type": "string"
- },
- "negotiations_allowed": {
- "description": "When true, the recipient can propose changes to the legal terms. For agreement types without separate business terms, that covers every term. CSA order forms, PSA statements of work, partnership business terms and software license order forms have their own `negotiations_allowed` flag.",
- "type": "boolean"
- },
- "partnership_attributes": {
- "additionalProperties": false,
- "description": "Override partnership terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "effective_date": {
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "effective_date_type": {
- "enum": [
- "signature",
- "date"
- ],
- "type": "string"
- },
- "general_cap_amount_currency_val": {
- "type": "number"
- },
- "general_cap_amount_either_currency": {
- "type": "number"
- },
- "general_cap_amount_either_multiple": {
- "type": "number"
- },
- "general_cap_amount_multiple_val": {
- "type": "number"
- },
- "general_cap_amount_type": {
- "enum": [
- "multiple",
- "currency",
- "either",
- "base"
- ],
- "type": "string"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_additional_warranties": {
- "type": "boolean"
- },
- "include_additional_warranties_include_company": {
- "type": "boolean"
- },
- "include_additional_warranties_include_company_val": {
- "type": "string"
- },
- "include_additional_warranties_include_partner": {
- "type": "boolean"
- },
- "include_additional_warranties_include_partner_val": {
- "type": "string"
- },
- "include_brand_guidelines": {
- "type": "boolean"
- },
- "include_brand_guidelines_include_company": {
- "type": "boolean"
- },
- "include_brand_guidelines_include_company_val": {
- "type": "string"
- },
- "include_brand_guidelines_include_partner": {
- "type": "boolean"
- },
- "include_brand_guidelines_include_partner_val": {
- "type": "string"
- },
- "include_covered_claims": {
- "type": "boolean"
- },
- "include_covered_claims_company_claims": {
- "type": "string"
- },
- "include_covered_claims_include_company_claims": {
- "type": "boolean"
- },
- "include_covered_claims_include_partner_claims": {
- "type": "boolean"
- },
- "include_covered_claims_partner_claims": {
- "type": "string"
- },
- "include_dpa": {
- "type": "boolean"
- },
- "include_dpa_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_dpa_location": {
- "type": "string"
- },
- "include_dpa_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_increased_cap_amount": {
- "type": "boolean"
- },
- "include_increased_cap_amount_currency": {
- "type": "number"
- },
- "include_increased_cap_amount_either_currency": {
- "type": "number"
- },
- "include_increased_cap_amount_either_multiple": {
- "type": "string"
- },
- "include_increased_cap_amount_multiple": {
- "type": "string"
- },
- "include_increased_cap_amount_type": {
- "enum": [
- "multiple",
- "currency",
- "either"
- ],
- "type": "string"
- },
- "include_increased_claims": {
- "type": "boolean"
- },
- "include_increased_claims_include_confidentiality": {
- "type": "boolean"
- },
- "include_increased_claims_include_confidentiality_misconduct": {
- "type": "boolean"
- },
- "include_increased_claims_include_covered_claims": {
- "type": "boolean"
- },
- "include_increased_claims_include_misconduct": {
- "type": "boolean"
- },
- "include_increased_claims_include_other": {
- "type": "boolean"
- },
- "include_increased_claims_include_other_val": {
- "type": "string"
- },
- "include_unlimited_claims": {
- "type": "boolean"
- },
- "include_unlimited_claims_confidentiality": {
- "type": "boolean"
- },
- "include_unlimited_claims_confidentiality_misconduct": {
- "type": "boolean"
- },
- "include_unlimited_claims_covered_claims": {
- "type": "boolean"
- },
- "include_unlimited_claims_misconduct": {
- "type": "boolean"
- },
- "include_unlimited_claims_other": {
- "type": "boolean"
- },
- "include_unlimited_claims_other_val": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "partnership_business_terms_attributes": {
- "additionalProperties": false,
- "description": "Override partnership business terms terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "end_date_after_effective_date_amount": {
- "type": "number"
- },
- "end_date_after_effective_date_unit": {
- "enum": [
- "month(s)",
- "quarter(s)",
- "year(s)"
- ],
- "type": "string"
- },
- "end_date_date": {
- "type": "string"
- },
- "end_date_type": {
- "enum": [
- "date",
- "effective date"
- ],
- "type": "string"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_obligations_company_brand": {
- "type": "boolean"
- },
- "include_obligations_company_promotion": {
- "type": "boolean"
- },
- "include_obligations_company_promotion_include_activities": {
- "type": "boolean"
- },
- "include_obligations_company_promotion_include_activities_val": {
- "type": "string"
- },
- "include_obligations_company_promotion_include_materials": {
- "type": "boolean"
- },
- "include_obligations_company_promotion_include_materials_val": {
- "type": "string"
- },
- "include_obligations_company_referral": {
- "type": "boolean"
- },
- "include_obligations_company_referral_include_criteria": {
- "type": "boolean"
- },
- "include_obligations_company_referral_include_criteria_val": {
- "type": "string"
- },
- "include_obligations_company_referral_include_pay_sch": {
- "type": "boolean"
- },
- "include_obligations_company_referral_include_pay_sch_amount": {
- "type": "number"
- },
- "include_obligations_company_referral_include_pay_sch_custom": {
- "type": "string"
- },
- "include_obligations_company_referral_include_pay_sch_unit": {
- "enum": [
- "U.S. Dollars",
- "percent"
- ],
- "type": "string"
- },
- "include_obligations_company_sponsorship": {
- "type": "boolean"
- },
- "include_obligations_company_sponsorship_include_benefits": {
- "type": "boolean"
- },
- "include_obligations_company_sponsorship_include_benefits_val": {
- "type": "string"
- },
- "include_obligations_company_sponsorship_include_payments": {
- "type": "boolean"
- },
- "include_obligations_company_sponsorship_include_payments_amount": {
- "type": "number"
- },
- "include_obligations_company_sponsorship_include_payments_unit": {
- "enum": [
- "U.S. Dollars",
- "percent"
- ],
- "type": "string"
- },
- "include_obligations_partner_brand": {
- "type": "boolean"
- },
- "include_obligations_partner_promotion": {
- "type": "boolean"
- },
- "include_obligations_partner_promotion_include_activities": {
- "type": "boolean"
- },
- "include_obligations_partner_promotion_include_activities_val": {
- "type": "string"
- },
- "include_obligations_partner_promotion_include_materials": {
- "type": "boolean"
- },
- "include_obligations_partner_promotion_include_materials_val": {
- "type": "string"
- },
- "include_obligations_partner_referral": {
- "type": "boolean"
- },
- "include_obligations_partner_referral_include_criteria": {
- "type": "boolean"
- },
- "include_obligations_partner_referral_include_criteria_val": {
- "type": "string"
- },
- "include_obligations_partner_referral_include_pay_sch": {
- "type": "boolean"
- },
- "include_obligations_partner_referral_include_pay_sch_amount": {
- "type": "number"
- },
- "include_obligations_partner_referral_include_pay_sch_custom": {
- "type": "string"
- },
- "include_obligations_partner_referral_include_pay_sch_unit": {
- "enum": [
- "U.S. Dollars",
- "percent"
- ],
- "type": "string"
- },
- "include_obligations_partner_sponsorship": {
- "type": "boolean"
- },
- "include_obligations_partner_sponsorship_include_benefits": {
- "type": "boolean"
- },
- "include_obligations_partner_sponsorship_include_benefits_val": {
- "type": "string"
- },
- "include_obligations_partner_sponsorship_include_payments": {
- "type": "boolean"
- },
- "include_obligations_partner_sponsorship_include_payments_amount": {
- "type": "number"
- },
- "include_obligations_partner_sponsorship_include_payments_unit": {
- "enum": [
- "U.S. Dollars",
- "percent"
- ],
- "type": "string"
- },
- "include_payment_process": {
- "type": "boolean"
- },
- "include_payment_process_company": {
- "type": "boolean"
- },
- "include_payment_process_company_include_address": {
- "type": "boolean"
- },
- "include_payment_process_company_include_address_city": {
- "type": "string"
- },
- "include_payment_process_company_include_address_country": {
- "type": "string"
- },
- "include_payment_process_company_include_address_state": {
- "type": "string"
- },
- "include_payment_process_company_include_address_street_address": {
- "type": "string"
- },
- "include_payment_process_company_include_address_zipcode": {
- "type": "string"
- },
- "include_payment_process_company_include_email": {
- "type": "boolean"
- },
- "include_payment_process_company_include_email_val": {
- "type": "string"
- },
- "include_payment_process_partner": {
- "type": "boolean"
- },
- "include_payment_process_partner_include_address": {
- "type": "boolean"
- },
- "include_payment_process_partner_include_address_city": {
- "type": "string"
- },
- "include_payment_process_partner_include_address_country": {
- "type": "string"
- },
- "include_payment_process_partner_include_address_state": {
- "type": "string"
- },
- "include_payment_process_partner_include_address_street_address": {
- "type": "string"
- },
- "include_payment_process_partner_include_address_zipcode": {
- "type": "string"
- },
- "include_payment_process_partner_include_email": {
- "type": "boolean"
- },
- "include_payment_process_partner_include_email_val": {
- "type": "string"
- },
- "include_payment_schedule": {
- "type": "boolean"
- },
- "include_payment_schedule_custom": {
- "type": "string"
- },
- "include_payment_schedule_specified_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_payment_schedule_specified_timeframe": {
- "enum": [
- "receipt",
- "date"
- ],
- "type": "string"
- },
- "include_payment_schedule_specified_unit": {
- "enum": [
- "day(s)",
- "week(s)",
- "month(s)",
- "quarter(s)",
- "year(s)"
- ],
- "type": "string"
- },
- "include_payment_schedule_type": {
- "enum": [
- "specified",
- "custom"
- ],
- "type": "string"
- },
- "negotiations_allowed": {
- "description": "When true, the recipient can propose changes to the business terms, even when the agreement-level `negotiations_allowed` is false. This only covers the business terms.",
- "type": "boolean"
- },
- "territory_type": {
- "enum": [
- "worldwide",
- "custom"
- ],
- "type": "string"
- },
- "territory_type_val": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "payment_link_url": {
- "description": "A payment URL shown to the recipient after signing. Requires include_billing_workflow to be true and billing_workflow_type to be \"link\".",
- "type": "string"
- },
- "pilot_attributes": {
- "additionalProperties": false,
- "description": "Override pilot terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "fees_type": {
- "enum": [
- "free",
- "pilot_period_fees"
- ],
- "type": "string"
- },
- "general_cap_amount": {
- "type": "number"
- },
- "general_cap_amount_type": {
- "enum": [
- "preceding",
- "base",
- "period"
- ],
- "type": "string"
- },
- "general_cap_period_currency": {
- "type": "number"
- },
- "general_cap_period_qty": {
- "type": "number"
- },
- "general_cap_preceding_amount": {
- "type": "number"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_dpa": {
- "type": "boolean"
- },
- "include_dpa_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_dpa_location": {
- "type": "string"
- },
- "include_dpa_type": {
- "enum": [
- "description",
- "attachment",
- "standard"
- ],
- "type": "string"
- },
- "include_payment_process": {
- "type": "boolean"
- },
- "include_technical_support": {
- "type": "boolean"
- },
- "payment_process_automatic_frequency": {
- "enum": [
- "monthly",
- "quarterly",
- "annually",
- "once_per_period"
- ],
- "type": "string"
- },
- "payment_process_invoice_days": {
- "type": "number"
- },
- "payment_process_invoice_from": {
- "enum": [
- "receipt",
- "date"
- ],
- "type": "string"
- },
- "payment_process_invoice_timeframe": {
- "enum": [
- "days",
- "weeks",
- "months",
- "quarters",
- "years"
- ],
- "type": "string"
- },
- "payment_process_type": {
- "enum": [
- "automatic",
- "invoice"
- ],
- "type": "string"
- },
- "pilot_period_description": {
- "type": "string"
- },
- "pilot_period_fees_description": {
- "type": "string"
- },
- "product_description": {
- "type": "string"
- },
- "technical_support_description": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "psa_attributes": {
- "additionalProperties": false,
- "description": "Override psa terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "additional_changes": {
- "type": "string"
- },
- "customer_description": {
- "type": "string"
- },
- "effective_date": {
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "effective_date_type": {
- "enum": [
- "signature",
- "date"
- ],
- "type": "string"
- },
- "general_cap_amount": {
- "type": "number"
- },
- "general_cap_amount_type": {
- "enum": [
- "preceding",
- "base",
- "period"
- ],
- "type": "string"
- },
- "general_cap_period_currency": {
- "type": "number"
- },
- "general_cap_period_qty": {
- "type": "number"
- },
- "general_cap_preceding_amount": {
- "type": "number"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_additional_changes": {
- "type": "boolean"
- },
- "include_additional_warranties": {
- "type": "boolean"
- },
- "include_additional_warranties_by_customer": {
- "type": "string"
- },
- "include_additional_warranties_by_provider": {
- "type": "string"
- },
- "include_additional_warranties_include_by_customer": {
- "type": "boolean"
- },
- "include_additional_warranties_include_by_provider": {
- "type": "boolean"
- },
- "include_covered_claims": {
- "type": "boolean"
- },
- "include_covered_claims_customer_claims": {
- "type": "string"
- },
- "include_covered_claims_include_customer_claims": {
- "type": "boolean"
- },
- "include_covered_claims_include_provider_claims": {
- "type": "boolean"
- },
- "include_covered_claims_provider_claims": {
- "type": "string"
- },
- "include_customer_insurance_min": {
- "type": "boolean"
- },
- "include_customer_insurance_min_add_provider_com_gen_liability": {
- "type": "boolean"
- },
- "include_customer_insurance_min_add_provider_cyber_liability": {
- "type": "boolean"
- },
- "include_customer_insurance_min_add_provider_errors_omissions": {
- "type": "boolean"
- },
- "include_customer_insurance_min_auto_liability_aggregate": {
- "type": "number"
- },
- "include_customer_insurance_min_auto_liability_minimum": {
- "type": "number"
- },
- "include_customer_insurance_min_cyber_liability_aggregate": {
- "type": "number"
- },
- "include_customer_insurance_min_cyber_liability_minimum": {
- "type": "number"
- },
- "include_customer_insurance_min_employer_liability_aggregate": {
- "type": "number"
- },
- "include_customer_insurance_min_employer_liability_minimum": {
- "type": "number"
- },
- "include_customer_insurance_min_general_liability_aggregate": {
- "type": "number"
- },
- "include_customer_insurance_min_general_liability_minimum": {
- "type": "number"
- },
- "include_customer_insurance_min_include_add_provider": {
- "type": "boolean"
- },
- "include_customer_insurance_min_include_auto_liability": {
- "type": "boolean"
- },
- "include_customer_insurance_min_include_cyber_liability": {
- "type": "boolean"
- },
- "include_customer_insurance_min_include_employer_liability": {
- "type": "boolean"
- },
- "include_customer_insurance_min_include_general_liability": {
- "type": "boolean"
- },
- "include_customer_insurance_min_include_workers_comp": {
- "type": "boolean"
- },
- "include_customer_policies": {
- "type": "boolean"
- },
- "include_customer_policies_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_customer_policies_location": {
- "type": "string"
- },
- "include_customer_policies_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_dpa": {
- "type": "boolean"
- },
- "include_dpa_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_dpa_location": {
- "type": "string"
- },
- "include_dpa_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_increased_cap_amount": {
- "type": "boolean"
- },
- "include_increased_claims": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_confidentiality": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_confidentiality_negligence": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_privsec": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_privsec_negligence": {
- "type": "boolean"
- },
- "include_increased_claims_include_other": {
- "type": "boolean"
- },
- "include_increased_claims_indemnification_obligation": {
- "type": "boolean"
- },
- "include_increased_claims_negligence": {
- "type": "boolean"
- },
- "include_increased_claims_other": {
- "type": "string"
- },
- "include_provider_insurance_min": {
- "type": "boolean"
- },
- "include_provider_insurance_min_add_customer_com_gen_liability": {
- "type": "boolean"
- },
- "include_provider_insurance_min_add_customer_cyber_liability": {
- "type": "boolean"
- },
- "include_provider_insurance_min_add_customer_errors_omissions": {
- "type": "boolean"
- },
- "include_provider_insurance_min_auto_liability_aggregate": {
- "type": "number"
- },
- "include_provider_insurance_min_auto_liability_minimum": {
- "type": "number"
- },
- "include_provider_insurance_min_cyber_liability_aggregate": {
- "type": "number"
- },
- "include_provider_insurance_min_cyber_liability_minimum": {
- "type": "number"
- },
- "include_provider_insurance_min_employer_liability_aggregate": {
- "type": "number"
- },
- "include_provider_insurance_min_employer_liability_minimum": {
- "type": "number"
- },
- "include_provider_insurance_min_general_liability_aggregate": {
- "type": "number"
- },
- "include_provider_insurance_min_general_liability_minimum": {
- "type": "number"
- },
- "include_provider_insurance_min_include_add_customer": {
- "type": "boolean"
- },
- "include_provider_insurance_min_include_auto_liability": {
- "type": "boolean"
- },
- "include_provider_insurance_min_include_cyber_liability": {
- "type": "boolean"
- },
- "include_provider_insurance_min_include_employer_liability": {
- "type": "boolean"
- },
- "include_provider_insurance_min_include_general_liability": {
- "type": "boolean"
- },
- "include_provider_insurance_min_include_workers_comp": {
- "type": "boolean"
- },
- "include_publicity_rights": {
- "type": "boolean"
- },
- "include_publicity_rights_type": {
- "enum": [
- "public",
- "non-public"
- ],
- "type": "string"
- },
- "include_security_policy": {
- "type": "boolean"
- },
- "include_security_policy_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_security_policy_fedramp_auth": {
- "type": "boolean"
- },
- "include_security_policy_hitrust": {
- "type": "boolean"
- },
- "include_security_policy_include_annual_maintenance": {
- "type": "boolean"
- },
- "include_security_policy_include_other": {
- "type": "boolean"
- },
- "include_security_policy_include_other_val": {
- "type": "string"
- },
- "include_security_policy_iso27001": {
- "type": "boolean"
- },
- "include_security_policy_location": {
- "type": "string"
- },
- "include_security_policy_pci1": {
- "type": "boolean"
- },
- "include_security_policy_pci2": {
- "type": "boolean"
- },
- "include_security_policy_penetration_testing": {
- "type": "boolean"
- },
- "include_security_policy_soc2_type1": {
- "type": "boolean"
- },
- "include_security_policy_soc2_type2": {
- "type": "boolean"
- },
- "include_security_policy_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_unlimited_claims": {
- "type": "boolean"
- },
- "include_unlimited_claims_breach_of_confidentiality": {
- "type": "boolean"
- },
- "include_unlimited_claims_breach_of_confidentiality_negligence": {
- "type": "boolean"
- },
- "include_unlimited_claims_breach_of_privsec": {
- "type": "boolean"
- },
- "include_unlimited_claims_breach_of_privsec_negligence": {
- "type": "boolean"
- },
- "include_unlimited_claims_include_other": {
- "type": "boolean"
- },
- "include_unlimited_claims_indemnification_obligation": {
- "type": "boolean"
- },
- "include_unlimited_claims_negligence": {
- "type": "boolean"
- },
- "include_unlimited_claims_other": {
- "type": "string"
- },
- "increased_cap_amount_currency": {
- "type": "number"
- },
- "increased_cap_amount_period_currency": {
- "type": "number"
- },
- "increased_cap_amount_period_qty": {
- "type": "number"
- },
- "increased_cap_amount_qty": {
- "type": "number"
- },
- "increased_cap_amount_type": {
- "enum": [
- "qty",
- "currency",
- "period"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- "psa_statement_of_work_attributes": {
- "additionalProperties": false,
- "description": "Override psa statement of work terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "additional_changes": {
- "type": "string"
- },
- "cost": {
- "type": "number"
- },
- "description": {
- "type": "string"
- },
- "fee_type": {
- "type": "string"
- },
- "fees_attributes": {
- "additionalProperties": {
- "anyOf": [
- {
- "additionalProperties": false,
- "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": "string"
- },
- "include_deliverables": {
- "type": "boolean"
- },
- "include_deliverables_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_deliverables_description": {
- "type": "string"
- },
- "include_deliverables_include_acceptance": {
- "type": "boolean"
- },
- "include_deliverables_include_attachment": {
- "type": "boolean"
- },
- "include_deliverables_include_draft_deliverables": {
- "type": "boolean"
- },
- "include_deliverables_rejection_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_deliverables_rejection_unit": {
- "enum": [
- "hours",
- "days",
- "weeks",
- "months"
- ],
- "type": "string"
- },
- "include_deliverables_resubmission_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_deliverables_resubmission_unit": {
- "enum": [
- "hours",
- "days",
- "weeks",
- "months"
- ],
- "type": "string"
- },
- "include_fees_other": {
- "type": "boolean"
- },
- "include_fees_other_val": {
- "type": "string"
- },
- "include_fees_table": {
- "type": "boolean"
- },
- "include_fees_table_total": {
- "type": "boolean"
- },
- "include_fees_travel": {
- "type": "boolean"
- },
- "include_fees_travel_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_fees_travel_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_fees_travel_val": {
- "type": "string"
- },
- "include_third_party_customer": {
- "type": "boolean"
- },
- "include_third_party_include_description": {
- "type": "boolean"
- },
- "include_third_party_include_description_val": {
- "type": "string"
- },
- "include_third_party_materials": {
- "type": "boolean"
- },
- "include_third_party_provider": {
- "type": "boolean"
- },
- "include_time_of_assignment": {
- "type": "boolean"
- },
- "include_time_of_assignment_type": {
- "enum": [
- "created",
- "paid"
- ],
- "type": "string"
- },
- "invoice_period_description": {
- "type": "string"
- },
- "negotiations_allowed": {
- "description": "When true, the recipient can propose changes to the statement of work, even when the agreement-level `negotiations_allowed` is false. This only covers the statement of work.",
- "type": "boolean"
- },
- "payment_period": {
- "type": "number"
- },
- "payment_period_other": {
- "type": "string"
- },
- "payment_period_timeframe": {
- "enum": [
- "receipt",
- "invoice",
- "Customer's receipt of invoice",
- "date of invoice"
- ],
- "type": "string"
- },
- "payment_period_type": {
- "enum": [
- "standard",
- "other"
- ],
- "type": "string"
- },
- "payment_period_unit": {
- "enum": [
- "day(s)",
- "week(s)",
- "month(s)",
- "quarter(s)",
- "year(s)"
- ],
- "type": "string"
- },
- "quantity": {
- "type": "number"
- },
- "services_description": {
- "type": "string"
- },
- "sow_date": {
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "sow_date_type": {
- "enum": [
- "signature",
- "date"
- ],
- "type": "string"
- },
- "sow_term_amount": {
- "type": "number"
- },
- "sow_term_date": {
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "sow_term_type": {
- "enum": [
- "deliverables",
- "period",
- "date"
- ],
- "type": "string"
- },
- "sow_term_unit": {
- "enum": [
- "month(s)",
- "quarter(s)",
- "year(s)"
- ],
- "type": "string"
- },
- "type": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "recipient_email": {
- "format": "email",
- "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-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_last_to_sign": {
- "description": "When true, your signer signs after the recipient.",
- "type": "boolean"
- },
- "sender_notice_email_address": {
- "description": "Email address for legal notices to the sender.",
- "format": "email",
- "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-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": {
- "enum": [
- "signature",
- "date"
- ],
- "type": "string"
- },
- "general_cap_amount": {
- "type": "number"
- },
- "general_cap_amount_type": {
- "enum": [
- "preceding",
- "base",
- "period"
- ],
- "type": "string"
- },
- "general_cap_period_currency": {
- "type": "number"
- },
- "general_cap_period_qty": {
- "type": "number"
- },
- "general_cap_preceding_amount": {
- "type": "number"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_additional_warranties": {
- "type": "boolean"
- },
- "include_additional_warranties_by_customer": {
- "type": "string"
- },
- "include_additional_warranties_by_provider": {
- "type": "string"
- },
- "include_additional_warranties_include_by_customer": {
- "type": "boolean"
- },
- "include_additional_warranties_include_by_provider": {
- "type": "boolean"
- },
- "include_ai_addendum": {
- "type": "boolean"
- },
- "include_ai_addendum_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_covered_claims": {
- "type": "boolean"
- },
- "include_covered_claims_customer_claims": {
- "type": "string"
- },
- "include_covered_claims_include_customer_claims": {
- "type": "boolean"
- },
- "include_covered_claims_include_provider_claims": {
- "type": "boolean"
- },
- "include_covered_claims_provider_claims": {
- "type": "string"
- },
- "include_dpa": {
- "type": "boolean"
- },
- "include_dpa_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_dpa_location": {
- "type": "string"
- },
- "include_dpa_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_increased_cap_amount": {
- "type": "boolean"
- },
- "include_increased_claims": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_confidentiality": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_confidentiality_negligence": {
- "type": "boolean"
- },
- "include_increased_claims_include_other": {
- "type": "boolean"
- },
- "include_increased_claims_indemnification_obligation": {
- "type": "boolean"
- },
- "include_increased_claims_negligence": {
- "type": "boolean"
- },
- "include_increased_claims_other": {
- "type": "string"
- },
- "include_increased_claims_restrictions": {
- "type": "boolean"
- },
- "include_unlimited_claims": {
- "type": "boolean"
- },
- "include_unlimited_claims_breach_of_confidentiality": {
- "type": "boolean"
- },
- "include_unlimited_claims_breach_of_confidentiality_negligence": {
- "type": "boolean"
- },
- "include_unlimited_claims_include_other": {
- "type": "boolean"
- },
- "include_unlimited_claims_indemnification_obligation": {
- "type": "boolean"
- },
- "include_unlimited_claims_license_or_restrictions": {
- "type": "boolean"
- },
- "include_unlimited_claims_negligence": {
- "type": "boolean"
- },
- "include_unlimited_claims_other": {
- "type": "string"
- },
- "increased_cap_amount_currency": {
- "type": "number"
- },
- "increased_cap_amount_period_currency": {
- "type": "number"
- },
- "increased_cap_amount_period_qty": {
- "type": "number"
- },
- "increased_cap_amount_qty": {
- "type": "number"
- },
- "increased_cap_amount_type": {
- "enum": [
- "qty",
- "currency",
- "period"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- "software_license_order_form_attributes": {
- "additionalProperties": false,
- "description": "Override software license order form terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "additional_changes": {
- "type": "string"
- },
- "deletion_procedure_include_custom": {
- "type": "boolean"
- },
- "deletion_procedure_include_custom_description": {
- "type": "string"
- },
- "deletion_procedure_include_customer_disable": {
- "type": "boolean"
- },
- "deletion_procedure_include_customer_proof": {
- "type": "boolean"
- },
- "deletion_procedure_include_provider_disable": {
- "type": "boolean"
- },
- "fee_custom_unit": {
- "type": "string"
- },
- "fee_period": {
- "enum": [
- "Subscription Period",
- "month",
- "year",
- "Custom unit"
- ],
- "type": "string"
- },
- "fees_attributes": {
- "additionalProperties": {
- "anyOf": [
- {
- "additionalProperties": false,
- "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": {
- "enum": [
- "USD",
- "EUR",
- "GBP",
- "CAD",
- "AUD",
- "SGD",
- "ILS",
- "JPY",
- "CHF",
- "HKD"
- ],
- "type": "string"
- },
- "fees_include_fee_increase_upon_renewal": {
- "type": "boolean"
- },
- "fees_include_fee_increase_upon_renewal_fee": {
- "type": "number"
- },
- "fees_include_fee_increase_upon_renewal_type": {
- "enum": [
- "will",
- "may"
- ],
- "type": "string"
- },
- "fees_inclusive_of_taxes": {
- "type": "boolean"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_additional_changes": {
- "type": "boolean"
- },
- "include_license_compliance_verification": {
- "type": "boolean"
- },
- "include_license_compliance_verification_description": {
- "type": "string"
- },
- "include_license_limits": {
- "type": "boolean"
- },
- "include_license_limits_description": {
- "type": "string"
- },
- "include_payment_process_include_billing_email": {
- "type": "boolean"
- },
- "include_pilot_period": {
- "type": "boolean"
- },
- "include_pilot_period_duration_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_pilot_period_duration_type": {
- "enum": [
- "day",
- "week",
- "month"
- ],
- "type": "string"
- },
- "include_pilot_period_include_fees": {
- "type": "boolean"
- },
- "include_pilot_period_include_fees_amount": {
- "type": "number"
- },
- "include_pilot_period_include_modifications": {
- "type": "boolean"
- },
- "include_pilot_period_include_modifications_description": {
- "type": "string"
- },
- "include_services": {
- "type": "boolean"
- },
- "include_services_description": {
- "type": "string"
- },
- "negotiations_allowed": {
- "description": "When true, the recipient can propose changes to the order form, even when the agreement-level `negotiations_allowed` is false. This only covers the order form.",
- "type": "boolean"
- },
- "order_date_date": {
- "type": "string"
- },
- "order_date_type": {
- "enum": [
- "signature",
- "date",
- "other"
- ],
- "type": "string"
- },
- "payment_process_automatic_frequency": {
- "enum": [
- "monthly",
- "quarterly",
- "semiannually",
- "annually"
- ],
- "type": "string"
- },
- "payment_process_type": {
- "enum": [
- "automatic",
- "invoice",
- "custom"
- ],
- "type": "string"
- },
- "payment_process_type_custom_val": {
- "type": "string"
- },
- "payment_process_type_invoice_amount": {
- "type": "number"
- },
- "payment_process_type_invoice_custom_unit": {
- "type": "string"
- },
- "payment_process_type_invoice_duration": {
- "enum": [
- "day",
- "week",
- "month",
- "year",
- "day(s)",
- "week(s)",
- "month(s)",
- "year(s)"
- ],
- "type": "string"
- },
- "payment_process_type_invoice_duration_start": {
- "enum": [
- "Customer's receipt of invoice",
- "date of invoice"
- ],
- "type": "string"
- },
- "payment_process_type_invoice_type": {
- "enum": [
- "monthly",
- "quarterly",
- "semiannually",
- "annually",
- "Custom unit"
- ],
- "type": "string"
- },
- "permitted_uses_include_custom": {
- "type": "boolean"
- },
- "permitted_uses_include_custom_description": {
- "type": "string"
- },
- "permitted_uses_include_customers_affiliates": {
- "type": "boolean"
- },
- "permitted_uses_include_internal_business": {
- "type": "boolean"
- },
- "pilot_period_stripe_product_id": {
- "type": "string"
- },
- "software_description": {
- "type": "string"
- },
- "subscription_auto_renew": {
- "enum": [
- "days",
- "subscription_end"
- ],
- "type": "string"
- },
- "subscription_period": {
- "type": "number"
- },
- "subscription_period_unit": {
- "type": "string"
- },
- "subscription_renewal_notice_days": {
- "type": "number"
- },
- "warranty_period_description_amount": {
- "type": "number"
- },
- "warranty_period_description_duration": {
- "enum": [
- "day",
- "week",
- "month",
- "year"
- ],
- "type": "string"
- },
- "warranty_period_description_duration_start": {
- "enum": [
- "initial delivery of the Software",
- "delivery of the Software and each subsequent Update",
- "the Order Date"
- ],
- "type": "string"
- },
- "warranty_period_type": {
- "enum": [
- "description",
- "none"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- "test_agreement": {
- "description": "When true, marks the agreement as a test. Test agreements do not count against your monthly limit.",
- "type": "boolean"
- }
- },
- "required": [
- "recipient_name",
- "recipient_email"
- ],
- "type": "object"
- },
- "cc_users": {
- "items": {
- "format": "email",
- "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-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": {
- "enum": [
- "signature",
- "date"
- ],
- "type": "string"
- },
- "framework_terms_type": {
- "type": "string"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "parent_agreement_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "underlying_agreement_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "underlying_agreement_type": {
- "type": "string"
- },
- "underlying_agreement_val": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "baa_attributes": {
- "additionalProperties": false,
- "description": "Override baa terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "aggregation_limitations_permitted": {
- "type": "boolean"
- },
- "aggregation_limitations_permitted_val": {
- "type": "string"
- },
- "breach_notification_unit": {
- "enum": [
- "hours",
- "business days",
- "calendar days"
- ],
- "type": "string"
- },
- "breach_notification_val": {
- "type": "number"
- },
- "business_associate_relationship_type": {
- "enum": [
- "provider",
- "company"
- ],
- "type": "string"
- },
- "deidentification_limitations_include_purpose": {
- "type": "boolean"
- },
- "deidentification_limitations_include_requirements": {
- "type": "boolean"
- },
- "deidentification_limitations_permitted": {
- "type": "boolean"
- },
- "deidentification_limitations_purpose_val": {
- "type": "string"
- },
- "deidentification_limitations_requirements_val": {
- "type": "string"
- },
- "designated_record_set_provider_maintains": {
- "type": "boolean"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_aggregation_limitations": {
- "type": "boolean"
- },
- "include_deidentification_limitations": {
- "type": "boolean"
- },
- "include_limitations": {
- "type": "boolean"
- },
- "include_offshore_limitations": {
- "type": "boolean"
- },
- "include_subcontract_limitations": {
- "type": "boolean"
- },
- "offshore_limitations_permitted": {
- "type": "boolean"
- },
- "offshore_limitations_permitted_val": {
- "type": "string"
- },
- "subcontract_limitations_include_notice": {
- "type": "boolean"
- },
- "subcontract_limitations_include_permission": {
- "type": "boolean"
- },
- "subcontract_limitations_notice_val": {
- "type": "string"
- },
- "subcontract_limitations_permission_val": {
- "type": "string"
- },
- "subcontract_limitations_permitted": {
- "type": "boolean"
- },
- "underlying_agreement_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "underlying_agreement_type": {
- "enum": [
- "internal",
- "external",
- "none"
- ],
- "type": "string"
- },
- "underlying_agreement_val": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "billing_email": {
- "description": "Email of the billing contact. Used when include_billing_info is true.",
- "format": "email",
- "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
- "type": "string"
- },
- "billing_name": {
- "description": "Name of the billing contact. Used when include_billing_info is true.",
- "type": "string"
- },
- "billing_workflow_type": {
- "description": "The type of billing workflow. Use \"link\" to provide a payment_link_url, or \"stripe\" for Stripe-managed billing.",
- "enum": [
- "link",
- "stripe"
- ],
- "type": "string"
- },
- "chosen_courts_country": {
- "description": "The country in which disputes will be resolved.",
- "type": "string"
- },
- "chosen_courts_region": {
- "description": "The state or region in which disputes will be resolved.",
- "type": "string"
- },
- "csa_attributes": {
- "additionalProperties": false,
- "description": "Override csa terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "customer_description": {
- "type": "string"
- },
- "effective_date": {
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "effective_date_marketplace": {
- "enum": [
- "AWS",
- "GCP",
- "Azure"
- ],
- "type": "string"
- },
- "effective_date_type": {
- "enum": [
- "signature",
- "date",
- "marketplace_acceptance"
- ],
- "type": "string"
- },
- "general_cap_amount": {
- "type": "number"
- },
- "general_cap_amount_type": {
- "enum": [
- "preceding",
- "base",
- "period"
- ],
- "type": "string"
- },
- "general_cap_period_currency": {
- "type": "number"
- },
- "general_cap_period_qty": {
- "type": "number"
- },
- "general_cap_preceding_amount": {
- "type": "number"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_acceptable_use_policy": {
- "type": "boolean"
- },
- "include_acceptable_use_policy_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_acceptable_use_policy_location": {
- "type": "string"
- },
- "include_acceptable_use_policy_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_additional_warranties": {
- "type": "boolean"
- },
- "include_additional_warranties_by_customer": {
- "type": "string"
- },
- "include_additional_warranties_by_provider": {
- "type": "string"
- },
- "include_additional_warranties_include_by_customer": {
- "type": "boolean"
- },
- "include_additional_warranties_include_by_provider": {
- "type": "boolean"
- },
- "include_ai_addendum": {
- "type": "boolean"
- },
- "include_ai_addendum_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_covered_claims": {
- "type": "boolean"
- },
- "include_covered_claims_customer_claims": {
- "type": "string"
- },
- "include_covered_claims_include_customer_claims": {
- "type": "boolean"
- },
- "include_covered_claims_include_provider_claims": {
- "type": "boolean"
- },
- "include_covered_claims_provider_claims": {
- "type": "string"
- },
- "include_dpa": {
- "type": "boolean"
- },
- "include_dpa_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_dpa_location": {
- "type": "string"
- },
- "include_dpa_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_increased_cap_amount": {
- "type": "boolean"
- },
- "include_increased_claims": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_confidentiality": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_confidentiality_negligence": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_privsec": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_privsec_negligence": {
- "type": "boolean"
- },
- "include_increased_claims_include_other": {
- "type": "boolean"
- },
- "include_increased_claims_indemnification_obligation": {
- "type": "boolean"
- },
- "include_increased_claims_other": {
- "type": "string"
- },
- "include_insurance_minimums": {
- "type": "boolean"
- },
- "include_insurance_minimums_add_customer": {
- "type": "boolean"
- },
- "include_insurance_minimums_add_customer_com_gen_liability": {
- "type": "boolean"
- },
- "include_insurance_minimums_add_customer_cyber_liability": {
- "type": "boolean"
- },
- "include_insurance_minimums_add_customer_errors_omissions": {
- "type": "boolean"
- },
- "include_insurance_minimums_additional_information": {
- "type": "boolean"
- },
- "include_insurance_minimums_additional_information_text": {
- "type": "string"
- },
- "include_insurance_minimums_cyber_liability_aggregate": {
- "type": "number"
- },
- "include_insurance_minimums_cyber_liability_minimum": {
- "type": "number"
- },
- "include_insurance_minimums_employer_liability_aggregate": {
- "type": "number"
- },
- "include_insurance_minimums_employer_liability_minimum": {
- "type": "number"
- },
- "include_insurance_minimums_general_liability_aggregate": {
- "type": "number"
- },
- "include_insurance_minimums_general_liability_minimum": {
- "type": "number"
- },
- "include_insurance_minimums_include_cyber_liability": {
- "type": "boolean"
- },
- "include_insurance_minimums_include_employer_liability": {
- "type": "boolean"
- },
- "include_insurance_minimums_include_general_liability": {
- "type": "boolean"
- },
- "include_insurance_minimums_include_workers_compensation": {
- "type": "boolean"
- },
- "include_publicity_rights": {
- "type": "boolean"
- },
- "include_publicity_rights_type": {
- "enum": [
- "public",
- "non-public"
- ],
- "type": "string"
- },
- "include_security_policy": {
- "type": "boolean"
- },
- "include_security_policy_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_security_policy_fedramp_auth": {
- "type": "boolean"
- },
- "include_security_policy_hipaa": {
- "type": "boolean"
- },
- "include_security_policy_hitrust": {
- "type": "boolean"
- },
- "include_security_policy_include_annual_maintenance": {
- "type": "boolean"
- },
- "include_security_policy_include_location": {
- "type": "boolean"
- },
- "include_security_policy_include_other": {
- "type": "boolean"
- },
- "include_security_policy_include_reasonable_efforts": {
- "type": "boolean"
- },
- "include_security_policy_iso27001": {
- "type": "boolean"
- },
- "include_security_policy_location": {
- "type": "string"
- },
- "include_security_policy_other": {
- "type": "string"
- },
- "include_security_policy_pci1": {
- "type": "boolean"
- },
- "include_security_policy_pci2": {
- "type": "boolean"
- },
- "include_security_policy_penetration_testing": {
- "type": "boolean"
- },
- "include_security_policy_soc2": {
- "type": "boolean"
- },
- "include_security_policy_soc2_type2": {
- "type": "boolean"
- },
- "include_security_policy_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_supercap": {
- "description": "CSA 3.0 renamed `include_increased_cap_amount` to `include_supercap`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_increased_cap_amount`. Sending the other spelling returns a 422.",
- "type": "boolean"
- },
- "include_uncapped_claims": {
- "description": "CSA 3.0 renamed `include_unlimited_claims` to `include_uncapped_claims`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims`. Sending the other spelling returns a 422.",
- "type": "boolean"
- },
- "include_uncapped_claims_breach_of_confidentiality": {
- "description": "CSA 3.0 renamed `include_unlimited_claims_breach_of_confidentiality` to `include_uncapped_claims_breach_of_confidentiality`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_breach_of_confidentiality`. Sending the other spelling returns a 422.",
- "type": "boolean"
- },
- "include_uncapped_claims_breach_of_confidentiality_negligence": {
- "description": "CSA 3.0 renamed `include_unlimited_claims_breach_of_confidentiality_negligence` to `include_uncapped_claims_breach_of_confidentiality_negligence`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_breach_of_confidentiality_negligence`. Sending the other spelling returns a 422.",
- "type": "boolean"
- },
- "include_uncapped_claims_breach_of_privsec": {
- "description": "CSA 3.0 renamed `include_unlimited_claims_breach_of_privsec` to `include_uncapped_claims_breach_of_privsec`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_breach_of_privsec`. Sending the other spelling returns a 422.",
- "type": "boolean"
- },
- "include_uncapped_claims_breach_of_privsec_negligence": {
- "description": "CSA 3.0 renamed `include_unlimited_claims_breach_of_privsec_negligence` to `include_uncapped_claims_breach_of_privsec_negligence`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_breach_of_privsec_negligence`. Sending the other spelling returns a 422.",
- "type": "boolean"
- },
- "include_uncapped_claims_include_other": {
- "description": "CSA 3.0 renamed `include_unlimited_claims_include_other` to `include_uncapped_claims_include_other`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_include_other`. Sending the other spelling returns a 422.",
- "type": "boolean"
- },
- "include_uncapped_claims_indemnification_obligation": {
- "description": "CSA 3.0 renamed `include_unlimited_claims_indemnification_obligation` to `include_uncapped_claims_indemnification_obligation`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_indemnification_obligation`. Sending the other spelling returns a 422.",
- "type": "boolean"
- },
- "include_uncapped_claims_other": {
- "description": "CSA 3.0 renamed `include_unlimited_claims_other` to `include_uncapped_claims_other`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_other`. Sending the other spelling returns a 422.",
- "type": "boolean"
- },
- "include_unlimited_claims": {
- "type": "boolean"
- },
- "include_unlimited_claims_breach_of_confidentiality": {
- "type": "boolean"
- },
- "include_unlimited_claims_breach_of_confidentiality_negligence": {
- "type": "boolean"
- },
- "include_unlimited_claims_breach_of_privsec": {
- "type": "boolean"
- },
- "include_unlimited_claims_breach_of_privsec_negligence": {
- "type": "boolean"
- },
- "include_unlimited_claims_include_other": {
- "type": "boolean"
- },
- "include_unlimited_claims_indemnification_obligation": {
- "type": "boolean"
- },
- "include_unlimited_claims_other": {
- "type": "string"
- },
- "increased_cap_amount_currency": {
- "type": "number"
- },
- "increased_cap_amount_period_currency": {
- "type": "number"
- },
- "increased_cap_amount_period_qty": {
- "type": "number"
- },
- "increased_cap_amount_qty": {
- "type": "number"
- },
- "increased_cap_amount_type": {
- "enum": [
- "qty",
- "currency",
- "period"
- ],
- "type": "string"
- },
- "provider": {
- "type": "string"
- },
- "supercap_currency": {
- "description": "CSA 3.0 renamed `increased_cap_amount_currency` to `supercap_currency`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `increased_cap_amount_currency`. Sending the other spelling returns a 422.",
- "type": "number"
- },
- "supercap_period_currency": {
- "description": "CSA 3.0 renamed `increased_cap_amount_period_currency` to `supercap_period_currency`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `increased_cap_amount_period_currency`. Sending the other spelling returns a 422.",
- "type": "number"
- },
- "supercap_period_qty": {
- "description": "CSA 3.0 renamed `increased_cap_amount_period_qty` to `supercap_period_qty`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `increased_cap_amount_period_qty`. Sending the other spelling returns a 422.",
- "type": "number"
- },
- "supercap_qty": {
- "description": "CSA 3.0 renamed `increased_cap_amount_qty` to `supercap_qty`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `increased_cap_amount_qty`. Sending the other spelling returns a 422.",
- "type": "number"
- },
- "supercap_type": {
- "description": "CSA 3.0 renamed `increased_cap_amount_type` to `supercap_type`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `increased_cap_amount_type`. Sending the other spelling returns a 422.",
- "type": "number"
- }
- },
- "type": "object"
- },
- "csa_order_form_attributes": {
- "additionalProperties": false,
- "description": "Override csa order form terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "additional_changes": {
- "type": "string"
- },
- "additional_parameters_or_limitations": {
- "type": "string"
- },
- "affiliates_as_users": {
- "type": "boolean"
- },
- "cloud_service_description": {
- "type": "string"
- },
- "consumption_units": {
- "type": "string"
- },
- "fee_amount": {
- "type": "number"
- },
- "fee_custom_unit": {
- "type": "string"
- },
- "fee_period": {
- "enum": [
- "Subscription Period",
- "month",
- "year",
- "User",
- "Custom unit"
- ],
- "type": "string"
- },
- "fees_attributes": {
- "additionalProperties": {
- "anyOf": [
- {
- "additionalProperties": false,
- "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": {
- "enum": [
- "USD",
- "EUR",
- "GBP",
- "CAD",
- "AUD",
- "SGD",
- "ILS",
- "JPY",
- "CHF",
- "HKD"
- ],
- "type": "string"
- },
- "fees_include_fee_increase_upon_renewal": {
- "type": "boolean"
- },
- "fees_include_fee_increase_upon_renewal_fee": {
- "type": "number"
- },
- "fees_include_fee_increase_upon_renewal_type": {
- "enum": [
- "will",
- "may"
- ],
- "type": "string"
- },
- "fees_inclusive_of_taxes": {
- "type": "boolean"
- },
- "framework_terms_type": {
- "enum": [
- "new",
- "existing",
- "description"
- ],
- "type": "string"
- },
- "free_trial_days": {
- "type": "number"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_additional_changes": {
- "type": "boolean"
- },
- "include_additional_parameters_or_limitations": {
- "type": "boolean"
- },
- "include_consumption": {
- "type": "boolean"
- },
- "include_fees": {
- "type": "boolean"
- },
- "include_fees_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_fees_include_attachment": {
- "type": "boolean"
- },
- "include_fees_other": {
- "type": "boolean"
- },
- "include_fees_other_val": {
- "type": "string"
- },
- "include_fees_table": {
- "type": "boolean"
- },
- "include_fees_table_period": {
- "enum": [
- "Subscription Period",
- "month",
- "year",
- "User"
- ],
- "type": "string"
- },
- "include_free_trial": {
- "type": "boolean"
- },
- "include_max_users": {
- "type": "boolean"
- },
- "include_pilot_period": {
- "type": "boolean"
- },
- "include_pilot_period_duration_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_pilot_period_duration_type": {
- "enum": [
- "day",
- "week",
- "month"
- ],
- "type": "string"
- },
- "include_pilot_period_include_fees": {
- "type": "boolean"
- },
- "include_pilot_period_include_fees_amount": {
- "type": "number"
- },
- "include_pilot_period_include_modifications": {
- "type": "boolean"
- },
- "include_pilot_period_include_modifications_description": {
- "type": "string"
- },
- "include_product_support": {
- "type": "boolean"
- },
- "include_product_support_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_product_support_description": {
- "type": "string"
- },
- "include_product_support_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_professional_services": {
- "type": "boolean"
- },
- "include_professional_services_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_professional_services_custom_name": {
- "type": "string"
- },
- "include_professional_services_description": {
- "type": "string"
- },
- "include_professional_services_end_date": {
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "include_professional_services_fees_description": {
- "type": "string"
- },
- "include_professional_services_include_end_date": {
- "type": "boolean"
- },
- "include_professional_services_include_fees_description": {
- "type": "boolean"
- },
- "include_professional_services_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_sla": {
- "type": "boolean"
- },
- "include_sla_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_sla_description": {
- "type": "string"
- },
- "include_sla_include_response_time": {
- "type": "boolean"
- },
- "include_sla_include_response_time_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_sla_include_response_time_credit": {
- "type": "number"
- },
- "include_sla_include_response_time_duration": {
- "enum": [
- "hour",
- "day",
- "week",
- "month",
- "hours"
- ],
- "type": "string"
- },
- "include_sla_include_response_time_support_channel": {
- "type": "string"
- },
- "include_sla_include_target_uptime": {
- "type": "boolean"
- },
- "include_sla_maintenance_notice": {
- "type": "boolean"
- },
- "include_sla_maintenance_window": {
- "type": "boolean"
- },
- "include_sla_maintenance_window_type": {
- "enum": [
- "standard",
- "none"
- ],
- "type": "string"
- },
- "include_sla_standard_maintenance_notice_qty": {
- "type": "number"
- },
- "include_sla_standard_maintenance_notice_unit": {
- "enum": [
- "hour",
- "day",
- "week",
- "month"
- ],
- "type": "string"
- },
- "include_sla_standard_maintenance_window_end_time": {
- "type": "string"
- },
- "include_sla_standard_maintenance_window_friday": {
- "type": "boolean"
- },
- "include_sla_standard_maintenance_window_monday": {
- "type": "boolean"
- },
- "include_sla_standard_maintenance_window_saturday": {
- "type": "boolean"
- },
- "include_sla_standard_maintenance_window_start_time": {
- "type": "string"
- },
- "include_sla_standard_maintenance_window_sunday": {
- "type": "boolean"
- },
- "include_sla_standard_maintenance_window_thursday": {
- "type": "boolean"
- },
- "include_sla_standard_maintenance_window_time_zone": {
- "type": "string"
- },
- "include_sla_standard_maintenance_window_tuesday": {
- "type": "boolean"
- },
- "include_sla_standard_maintenance_window_wednesday": {
- "type": "boolean"
- },
- "include_sla_standard_target_uptime": {
- "type": "number"
- },
- "include_sla_type": {
- "enum": [
- "description",
- "standard",
- "attachment"
- ],
- "type": "string"
- },
- "include_subscription_start_date": {
- "type": "boolean"
- },
- "include_subscription_start_date_date": {
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "include_usage_review": {
- "type": "boolean"
- },
- "include_usage_review_val": {
- "type": "string"
- },
- "include_use_limitations": {
- "type": "boolean"
- },
- "include_use_limitations_val": {
- "type": "string"
- },
- "invoice_period": {
- "enum": [
- "monthly",
- "quarterly",
- "semiannually",
- "annually",
- "Custom unit",
- "Monthly",
- "Quarterly",
- "Semiannually",
- "Annually"
- ],
- "type": "string"
- },
- "invoice_period_custom_unit": {
- "type": "string"
- },
- "max_consumption": {
- "type": "number"
- },
- "max_users": {
- "type": "number"
- },
- "negotiations_allowed": {
- "description": "When true, the recipient can propose changes to the order form, even when the agreement-level `negotiations_allowed` is false. This only covers the order form.",
- "type": "boolean"
- },
- "order_date_date": {
- "type": "string"
- },
- "order_date_other": {
- "type": "string"
- },
- "order_date_type": {
- "enum": [
- "signature",
- "date",
- "other"
- ],
- "type": "string"
- },
- "payment_period": {
- "type": "number"
- },
- "payment_period_timeframe": {
- "enum": [
- "Customer's receipt of invoice",
- "date of invoice"
- ],
- "type": "string"
- },
- "payment_period_unit": {
- "enum": [
- "day(s)",
- "week(s)",
- "month(s)",
- "marketplace_acceptance"
- ],
- "type": "string"
- },
- "payment_process_automatic_frequency": {
- "enum": [
- "monthly",
- "quarterly",
- "semiannually",
- "annually"
- ],
- "type": "string"
- },
- "payment_process_type": {
- "enum": [
- "automatic",
- "invoice",
- "custom",
- "marketplace_acceptance"
- ],
- "type": "string"
- },
- "payment_process_type_custom_val": {
- "type": "string"
- },
- "payment_process_type_invoice_amount": {
- "type": "number"
- },
- "payment_process_type_invoice_custom_unit": {
- "type": "string"
- },
- "payment_process_type_invoice_duration": {
- "enum": [
- "day",
- "week",
- "month",
- "year",
- "day(s)",
- "week(s)",
- "month(s)",
- "year(s)"
- ],
- "type": "string"
- },
- "payment_process_type_invoice_duration_start": {
- "enum": [
- "Customer's receipt of invoice",
- "date of invoice"
- ],
- "type": "string"
- },
- "payment_process_type_invoice_type": {
- "enum": [
- "monthly",
- "quarterly",
- "semiannually",
- "annually",
- "Custom unit"
- ],
- "type": "string"
- },
- "pilot_period_stripe_product_id": {
- "type": "string"
- },
- "service_credits_attributes": {
- "additionalProperties": {
- "additionalProperties": false,
- "properties": {
- "credit": {
- "type": "number"
- },
- "max": {
- "type": "number"
- },
- "min": {
- "type": "number"
- }
- },
- "type": "object"
- },
- "description": "Service credits. Use string keys such as \"0\", \"1\".",
- "propertyNames": {
- "type": "string"
- },
- "type": "object"
- },
- "subscription_auto_renew": {
- "enum": [
- "days",
- "subscription_end"
- ],
- "type": "string"
- },
- "subscription_period": {
- "type": "number"
- },
- "subscription_period_unit": {
- "type": "string"
- },
- "subscription_renewal_notice_days": {
- "type": "number"
- },
- "subscription_start_date": {
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "subscription_start_date_type": {
- "enum": [
- "effective_date",
- "date"
- ],
- "type": "string"
- },
- "underlying_agreement_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "use_limitations_attributes": {
- "additionalProperties": {
- "additionalProperties": false,
- "properties": {
- "amount": {
- "type": "number"
- },
- "limitation_type": {
- "type": "string"
- },
- "unit": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "description": "Use limitations. Use string keys such as \"0\", \"1\".",
- "propertyNames": {
- "type": "string"
- },
- "type": "object"
- }
- },
- "type": "object"
- },
- "custom_field_values": {
- "description": "Values for a custom template's fields, keyed by the field keys defined in the template's YAML definition. Only used when template_id is a custom template. Template defaults fill any fields you omit; a required field with no default and no submitted value returns a 400 naming the field. Values are validated against the field's input type: select and radio values must be one of the field's options, multiselect values are an array of selections each of which must be one of the field's options, number and currency values must be numeric, date values must be YYYY-MM-DD, and email values must be valid addresses. An invalid value returns a 400 naming the field."
- },
- "design_partner_attributes": {
- "additionalProperties": false,
- "description": "Override design partner terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "customer_description": {
- "type": "string"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_fees": {
- "type": "boolean"
- },
- "include_fees_amount": {
- "type": "number"
- },
- "include_fees_description": {
- "type": "string"
- },
- "include_fees_pay_by_amount": {
- "type": "string"
- },
- "include_fees_type": {
- "enum": [
- "default_language",
- "description"
- ],
- "type": "string"
- },
- "include_fees_unit": {
- "enum": [
- "month",
- "quarter",
- "year",
- "Term"
- ],
- "type": "string"
- },
- "include_program_appear_as_customer_private": {
- "type": "boolean"
- },
- "include_program_appear_as_customer_public": {
- "type": "boolean"
- },
- "include_program_case_study": {
- "type": "boolean"
- },
- "include_program_develop_functionality": {
- "type": "boolean"
- },
- "include_program_develop_functionality_val": {
- "type": "string"
- },
- "include_program_discount": {
- "type": "boolean"
- },
- "include_program_discount_amount": {
- "type": "number"
- },
- "include_program_discount_unit": {
- "enum": [
- "U.S. Dollars",
- "percent"
- ],
- "type": "string"
- },
- "include_program_participation_feedback": {
- "type": "boolean"
- },
- "include_program_participation_feedback_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_program_participation_feedback_unit": {
- "enum": [
- "month",
- "quarter",
- "year",
- "Term"
- ],
- "type": "string"
- },
- "include_program_partner_other": {
- "type": "boolean"
- },
- "include_program_partner_other_val": {
- "type": "string"
- },
- "include_program_provider_other": {
- "type": "boolean"
- },
- "include_program_provider_other_val": {
- "type": "string"
- },
- "include_program_reference": {
- "type": "boolean"
- },
- "product_description": {
- "type": "string"
- },
- "term_amount": {
- "type": "number"
- },
- "term_unit": {
- "enum": [
- "day(s)",
- "week(s)",
- "month(s)",
- "quarter(s)",
- "year(s)"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- "district_or_county": {
- "description": "The district or county for dispute resolution.",
- "type": "string"
- },
- "dpa_attributes": {
- "additionalProperties": false,
- "description": "Override dpa terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "approved_subprocessor_type": {
- "description": "`internal` lists approved subprocessors in the agreement (`subprocessors_attributes`); `external` points to a list published elsewhere.",
- "enum": [
- "internal",
- "external"
- ],
- "type": "string"
- },
- "cloud_service_product_name": {
- "type": "string"
- },
- "competent_supervisory_authority": {
- "type": "string"
- },
- "customer_description": {
- "type": "string"
- },
- "data_exporter_address_city": {
- "type": "string"
- },
- "data_exporter_address_country": {
- "type": "string"
- },
- "data_exporter_address_state": {
- "type": "string"
- },
- "data_exporter_address_street_address": {
- "type": "string"
- },
- "data_exporter_address_zipcode": {
- "type": "string"
- },
- "data_exporter_contact_details": {
- "type": "string"
- },
- "data_exporter_contact_name": {
- "type": "string"
- },
- "data_exporter_contact_position": {
- "type": "string"
- },
- "data_exporter_role": {
- "description": "Role of the data exporter. Overwritten to `Controller` when the agreement is created from a template.",
- "enum": [
- "Controller",
- "Processor"
- ],
- "type": "string"
- },
- "data_importer_address": {
- "type": "string"
- },
- "data_importer_address_city": {
- "type": "string"
- },
- "data_importer_address_country": {
- "type": "string"
- },
- "data_importer_address_state": {
- "type": "string"
- },
- "data_importer_address_street_address": {
- "type": "string"
- },
- "data_importer_address_zipcode": {
- "type": "string"
- },
- "data_importer_contact_details": {
- "type": "string"
- },
- "data_importer_contact_name": {
- "type": "string"
- },
- "data_importer_contact_position": {
- "type": "string"
- },
- "duration_of_processing": {
- "type": "string"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_covered_claim": {
- "type": "boolean"
- },
- "include_covered_claim_external_val": {
- "type": "string"
- },
- "include_covered_claim_internal_val": {
- "type": "string"
- },
- "include_covered_claim_type": {
- "description": "Which covered-claim text applies: `internal` uses `include_covered_claim_internal_val`, `external` uses `include_covered_claim_external_val`. Required when `include_covered_claim` is true.",
- "enum": [
- "internal",
- "external"
- ],
- "type": "string"
- },
- "include_data_subjects_custom": {
- "type": "boolean"
- },
- "include_data_subjects_custom_val": {
- "type": "string"
- },
- "include_data_subjects_employees": {
- "type": "boolean"
- },
- "include_data_subjects_end_users": {
- "type": "boolean"
- },
- "include_external_subprocessor_location": {
- "type": "string"
- },
- "include_frequency_of_transfer_continuous": {
- "type": "boolean"
- },
- "include_frequency_of_transfer_custom": {
- "type": "boolean"
- },
- "include_frequency_of_transfer_custom_val": {
- "type": "string"
- },
- "include_governing_country_eu": {
- "type": "boolean"
- },
- "include_governing_country_eu_val": {
- "type": "string"
- },
- "include_governing_country_uk": {
- "type": "boolean"
- },
- "include_governing_country_uk_val": {
- "type": "string"
- },
- "include_governing_law": {
- "type": "boolean"
- },
- "include_governing_law_country": {
- "type": "string"
- },
- "include_governing_law_state": {
- "type": "string"
- },
- "include_increased_claim_amount": {
- "description": "Legacy field. Stored but not shown on the DPA; use the `include_liability_cap*` fields instead.",
- "type": "boolean"
- },
- "include_increased_claim_amount_currency": {
- "description": "Legacy field. Stored but not shown on the DPA; use the `include_liability_cap*` fields instead."
- },
- "include_increased_claim_amount_qty": {
- "description": "Legacy field. Stored but not shown on the DPA; use the `include_liability_cap*` fields instead."
- },
- "include_increased_claim_amount_type": {
- "description": "Legacy field. Stored but not shown on the DPA; use the `include_liability_cap*` fields instead.",
- "type": "string"
- },
- "include_liability_cap": {
- "type": "boolean"
- },
- "include_liability_cap_amount_constant_external": {
- "type": "string"
- },
- "include_liability_cap_amount_constant_internal": {
- "type": "string"
- },
- "include_liability_cap_amount_currency_external": {
- "description": "Currency amount. Numbers and numeric strings (commas allowed) are both accepted."
- },
- "include_liability_cap_amount_currency_internal": {
- "description": "Currency amount. Numbers and numeric strings (commas allowed) are both accepted."
- },
- "include_liability_cap_csa_type": {
- "description": "Which liability cap values apply: the `_internal` or `_external` amount fields. Required when `include_liability_cap` is true.",
- "enum": [
- "internal",
- "external"
- ],
- "type": "string"
- },
- "include_personal_data_biographic_info": {
- "type": "boolean"
- },
- "include_personal_data_contact_info": {
- "type": "boolean"
- },
- "include_personal_data_custom": {
- "type": "boolean"
- },
- "include_personal_data_custom_val": {
- "type": "string"
- },
- "include_personal_data_employment_info": {
- "type": "boolean"
- },
- "include_personal_data_financial_info": {
- "type": "boolean"
- },
- "include_personal_data_location": {
- "type": "boolean"
- },
- "include_personal_data_name": {
- "type": "boolean"
- },
- "include_personal_data_transactional_info": {
- "type": "boolean"
- },
- "include_personal_data_user_activity_info": {
- "type": "boolean"
- },
- "include_processing_purpose_custom": {
- "type": "boolean"
- },
- "include_processing_purpose_custom_val": {
- "type": "string"
- },
- "include_processing_purpose_erasing": {
- "type": "boolean"
- },
- "include_processing_purpose_holding": {
- "type": "boolean"
- },
- "include_processing_purpose_protecting": {
- "type": "boolean"
- },
- "include_processing_purpose_receiving": {
- "type": "boolean"
- },
- "include_processing_purpose_returning": {
- "type": "boolean"
- },
- "include_processing_purpose_sharing": {
- "type": "boolean"
- },
- "include_processing_purpose_updating": {
- "type": "boolean"
- },
- "include_processing_purpose_using": {
- "type": "boolean"
- },
- "include_provider_security_contact_address": {
- "type": "boolean"
- },
- "include_provider_security_contact_address_city": {
- "type": "string"
- },
- "include_provider_security_contact_address_country": {
- "type": "string"
- },
- "include_provider_security_contact_address_state": {
- "type": "string"
- },
- "include_provider_security_contact_address_street_address": {
- "type": "string"
- },
- "include_provider_security_contact_address_zipcode": {
- "type": "string"
- },
- "include_provider_security_contact_email": {
- "type": "boolean"
- },
- "include_provider_security_contact_email_val": {
- "format": "email",
- "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
- "type": "string"
- },
- "include_security_measures_accountability": {
- "type": "boolean"
- },
- "include_security_measures_accountability_val": {
- "type": "string"
- },
- "include_security_measures_certification_or_assurance": {
- "type": "boolean"
- },
- "include_security_measures_certification_or_assurance_val": {
- "type": "string"
- },
- "include_security_measures_confidentiality_integrity": {
- "type": "boolean"
- },
- "include_security_measures_confidentiality_integrity_val": {
- "type": "string"
- },
- "include_security_measures_data_at_rest": {
- "type": "boolean"
- },
- "include_security_measures_data_at_rest_val": {
- "type": "string"
- },
- "include_security_measures_data_minimization": {
- "type": "boolean"
- },
- "include_security_measures_data_minimization_val": {
- "type": "string"
- },
- "include_security_measures_data_quality": {
- "type": "boolean"
- },
- "include_security_measures_data_quality_val": {
- "type": "string"
- },
- "include_security_measures_data_retention": {
- "type": "boolean"
- },
- "include_security_measures_data_retention_val": {
- "type": "string"
- },
- "include_security_measures_data_transmission": {
- "type": "boolean"
- },
- "include_security_measures_data_transmission_val": {
- "type": "string"
- },
- "include_security_measures_event_logging": {
- "type": "boolean"
- },
- "include_security_measures_event_logging_val": {
- "type": "string"
- },
- "include_security_measures_identity_auth": {
- "type": "boolean"
- },
- "include_security_measures_identity_auth_val": {
- "type": "string"
- },
- "include_security_measures_it_security_governance": {
- "type": "boolean"
- },
- "include_security_measures_it_security_governance_val": {
- "type": "string"
- },
- "include_security_measures_physical_security": {
- "type": "boolean"
- },
- "include_security_measures_physical_security_val": {
- "type": "string"
- },
- "include_security_measures_portability_and_erasure": {
- "type": "boolean"
- },
- "include_security_measures_portability_and_erasure_val": {
- "type": "string"
- },
- "include_security_measures_pseudonym_encryption": {
- "type": "boolean"
- },
- "include_security_measures_pseudonym_encryption_val": {
- "type": "string"
- },
- "include_security_measures_restore_data_access": {
- "type": "boolean"
- },
- "include_security_measures_restore_data_access_val": {
- "type": "string"
- },
- "include_security_measures_security_policy": {
- "type": "boolean"
- },
- "include_security_measures_system_configuration": {
- "type": "boolean"
- },
- "include_security_measures_system_configuration_val": {
- "type": "string"
- },
- "include_security_measures_testing_assessment": {
- "type": "boolean"
- },
- "include_security_measures_testing_assessment_val": {
- "type": "string"
- },
- "include_security_policy": {
- "type": "boolean"
- },
- "include_security_policy_fedramp_auth": {
- "type": "boolean"
- },
- "include_security_policy_hipaa": {
- "type": "boolean"
- },
- "include_security_policy_hitrust": {
- "type": "boolean"
- },
- "include_security_policy_include_other": {
- "type": "boolean"
- },
- "include_security_policy_iso27001": {
- "type": "boolean"
- },
- "include_security_policy_other": {
- "type": "string"
- },
- "include_security_policy_pci1": {
- "type": "boolean"
- },
- "include_security_policy_pci2": {
- "type": "boolean"
- },
- "include_security_policy_penetration_testing": {
- "type": "boolean"
- },
- "include_security_policy_soc2": {
- "type": "boolean"
- },
- "include_security_policy_soc2_type2": {
- "type": "boolean"
- },
- "include_sensitive_data_restrictions_custom": {
- "type": "boolean"
- },
- "include_sensitive_data_restrictions_custom_val": {
- "type": "string"
- },
- "include_sensitive_data_restrictions_security_policy": {
- "type": "boolean"
- },
- "include_service_provider_relationship": {
- "type": "boolean"
- },
- "include_special_category_data": {
- "type": "boolean"
- },
- "provider": {
- "type": "string"
- },
- "security_policy_available_at": {
- "type": "string"
- },
- "security_policy_type": {
- "description": "Where the Security Policy is defined. For `external`, set `security_policy_available_at`.",
- "enum": [
- "defined in agreement",
- "provider service",
- "external"
- ],
- "type": "string"
- },
- "subprocessors_attributes": {
- "additionalProperties": {
- "additionalProperties": false,
- "properties": {
- "_destroy": {
- "description": "Set to true with `id` to remove that subprocessor.",
- "type": "boolean"
- },
- "country": {
- "type": "string"
- },
- "id": {
- "description": "ID of an existing subprocessor to update or remove. Omit to add a new subprocessor.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "name": {
- "type": "string"
- },
- "processing_task": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "description": "Subprocessors, keyed by string index such as \"0\", \"1\". On create these are added to the template's subprocessors. On a draft update, an entry without `id` adds a new subprocessor; pass `id` to change one and `id` with `_destroy: true` to remove one.",
- "propertyNames": {
- "type": "string"
- },
- "type": "object"
- },
- "underlying_agreement_id": {
- "description": "ID of the CSA this DPA supplements when `underlying_agreement_type` is `internal`.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "underlying_agreement_type": {
- "description": "`internal` links a CSA in Common Paper (`underlying_agreement_id`); `external` describes another agreement in `underlying_agreement_val` (required). Omit for none.",
- "enum": [
- "internal",
- "external"
- ],
- "type": "string"
- },
- "underlying_agreement_val": {
- "description": "Description of the agreement this DPA supplements. Required when `underlying_agreement_type` is `external`.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "framework_terms_description": {
- "description": "Custom framework terms description. Only used when framework_terms_type is \"description\".",
- "type": "string"
- },
- "framework_terms_type": {
- "description": "How framework terms are specified. Use \"new\" for standard terms or \"description\" to provide a custom framework_terms_description.",
- "enum": [
- "new",
- "description"
- ],
- "type": "string"
- },
- "governing_law_country": {
- "description": "The country whose laws govern the agreement.",
- "type": "string"
- },
- "governing_law_region": {
- "description": "The state or region whose laws govern the agreement.",
- "type": "string"
- },
- "include_automated_payment_reminders": {
- "description": "When true, automatically sends payment reminder emails.",
- "type": "boolean"
- },
- "include_billing_info": {
- "description": "When true, billing contact information (billing_name, billing_email) is included.",
- "type": "boolean"
- },
- "include_billing_workflow": {
- "description": "When true, enables a billing workflow after signing.",
- "type": "boolean"
- },
- "include_expiration_date": {
- "description": "Expiration date in YYYY-MM-DD format. Use when include_expiration_type is \"date\".",
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "include_expiration_days": {
- "description": "Number of days until the agreement expires. Use when include_expiration_type is \"days\".",
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_expiration_type": {
- "description": "How to set expiration: \"none\" (default), \"days\" (use include_expiration_days), or \"date\" (use include_expiration_date).",
- "enum": [
- "none",
- "days",
- "date"
- ],
- "type": "string"
- },
- "include_terms": {
- "description": "When true, the standard terms are included with the agreement.",
- "type": "boolean"
- },
- "loi_attributes": {
- "additionalProperties": false,
- "description": "Override loi terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "confidentiality_custom": {
- "type": "string"
- },
- "confidentiality_mutual_include_loi": {
- "type": "boolean"
- },
- "confidentiality_nda_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "confidentiality_nda_description": {
- "type": "string"
- },
- "confidentiality_nda_include_loi": {
- "type": "boolean"
- },
- "confidentiality_nda_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "confidentiality_type": {
- "enum": [
- "mutual",
- "nda",
- "provider",
- "custom"
- ],
- "type": "string"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_custom_details": {
- "type": "boolean"
- },
- "include_custom_details_val": {
- "type": "string"
- },
- "include_fees": {
- "type": "boolean"
- },
- "include_fees_amount": {
- "type": "number"
- },
- "include_fees_amount_duration": {
- "enum": [
- "month",
- "year",
- "quarter"
- ],
- "type": "string"
- },
- "include_fees_include_amount": {
- "type": "boolean"
- },
- "include_fees_include_other": {
- "type": "boolean"
- },
- "include_fees_other": {
- "type": "string"
- },
- "include_functionality": {
- "type": "boolean"
- },
- "include_functionality_val": {
- "type": "string"
- },
- "include_launch_date": {
- "type": "boolean"
- },
- "include_launch_date_custom": {
- "type": "string"
- },
- "include_launch_date_date": {
- "format": "date-time",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$",
- "type": "string"
- },
- "include_launch_date_type": {
- "enum": [
- "date",
- "custom"
- ],
- "type": "string"
- },
- "product_name": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "manual_send": {
- "description": "When true, the agreement is marked as manually sent outside the platform.",
- "type": "boolean"
- },
- "message": {
- "type": "string"
- },
- "negotiations_allowed": {
- "description": "When true, the recipient can propose changes to the legal terms. For agreement types without separate business terms, that covers every term. CSA order forms, PSA statements of work, partnership business terms and software license order forms have their own `negotiations_allowed` flag.",
- "type": "boolean"
- },
- "partnership_attributes": {
- "additionalProperties": false,
- "description": "Override partnership terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "effective_date": {
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "effective_date_type": {
- "enum": [
- "signature",
- "date"
- ],
- "type": "string"
- },
- "general_cap_amount_currency_val": {
- "type": "number"
- },
- "general_cap_amount_either_currency": {
- "type": "number"
- },
- "general_cap_amount_either_multiple": {
- "type": "number"
- },
- "general_cap_amount_multiple_val": {
- "type": "number"
- },
- "general_cap_amount_type": {
- "enum": [
- "multiple",
- "currency",
- "either",
- "base"
- ],
- "type": "string"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_additional_warranties": {
- "type": "boolean"
- },
- "include_additional_warranties_include_company": {
- "type": "boolean"
- },
- "include_additional_warranties_include_company_val": {
- "type": "string"
- },
- "include_additional_warranties_include_partner": {
- "type": "boolean"
- },
- "include_additional_warranties_include_partner_val": {
- "type": "string"
- },
- "include_brand_guidelines": {
- "type": "boolean"
- },
- "include_brand_guidelines_include_company": {
- "type": "boolean"
- },
- "include_brand_guidelines_include_company_val": {
- "type": "string"
- },
- "include_brand_guidelines_include_partner": {
- "type": "boolean"
- },
- "include_brand_guidelines_include_partner_val": {
- "type": "string"
- },
- "include_covered_claims": {
- "type": "boolean"
- },
- "include_covered_claims_company_claims": {
- "type": "string"
- },
- "include_covered_claims_include_company_claims": {
- "type": "boolean"
- },
- "include_covered_claims_include_partner_claims": {
- "type": "boolean"
- },
- "include_covered_claims_partner_claims": {
- "type": "string"
- },
- "include_dpa": {
- "type": "boolean"
- },
- "include_dpa_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_dpa_location": {
- "type": "string"
- },
- "include_dpa_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_increased_cap_amount": {
- "type": "boolean"
- },
- "include_increased_cap_amount_currency": {
- "type": "number"
- },
- "include_increased_cap_amount_either_currency": {
- "type": "number"
- },
- "include_increased_cap_amount_either_multiple": {
- "type": "string"
- },
- "include_increased_cap_amount_multiple": {
- "type": "string"
- },
- "include_increased_cap_amount_type": {
- "enum": [
- "multiple",
- "currency",
- "either"
- ],
- "type": "string"
- },
- "include_increased_claims": {
- "type": "boolean"
- },
- "include_increased_claims_include_confidentiality": {
- "type": "boolean"
- },
- "include_increased_claims_include_confidentiality_misconduct": {
- "type": "boolean"
- },
- "include_increased_claims_include_covered_claims": {
- "type": "boolean"
- },
- "include_increased_claims_include_misconduct": {
- "type": "boolean"
- },
- "include_increased_claims_include_other": {
- "type": "boolean"
- },
- "include_increased_claims_include_other_val": {
- "type": "string"
- },
- "include_unlimited_claims": {
- "type": "boolean"
- },
- "include_unlimited_claims_confidentiality": {
- "type": "boolean"
- },
- "include_unlimited_claims_confidentiality_misconduct": {
- "type": "boolean"
- },
- "include_unlimited_claims_covered_claims": {
- "type": "boolean"
- },
- "include_unlimited_claims_misconduct": {
- "type": "boolean"
- },
- "include_unlimited_claims_other": {
- "type": "boolean"
- },
- "include_unlimited_claims_other_val": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "partnership_business_terms_attributes": {
- "additionalProperties": false,
- "description": "Override partnership business terms terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "end_date_after_effective_date_amount": {
- "type": "number"
- },
- "end_date_after_effective_date_unit": {
- "enum": [
- "month(s)",
- "quarter(s)",
- "year(s)"
- ],
- "type": "string"
- },
- "end_date_date": {
- "type": "string"
- },
- "end_date_type": {
- "enum": [
- "date",
- "effective date"
- ],
- "type": "string"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_obligations_company_brand": {
- "type": "boolean"
- },
- "include_obligations_company_promotion": {
- "type": "boolean"
- },
- "include_obligations_company_promotion_include_activities": {
- "type": "boolean"
- },
- "include_obligations_company_promotion_include_activities_val": {
- "type": "string"
- },
- "include_obligations_company_promotion_include_materials": {
- "type": "boolean"
- },
- "include_obligations_company_promotion_include_materials_val": {
- "type": "string"
- },
- "include_obligations_company_referral": {
- "type": "boolean"
- },
- "include_obligations_company_referral_include_criteria": {
- "type": "boolean"
- },
- "include_obligations_company_referral_include_criteria_val": {
- "type": "string"
- },
- "include_obligations_company_referral_include_pay_sch": {
- "type": "boolean"
- },
- "include_obligations_company_referral_include_pay_sch_amount": {
- "type": "number"
- },
- "include_obligations_company_referral_include_pay_sch_custom": {
- "type": "string"
- },
- "include_obligations_company_referral_include_pay_sch_unit": {
- "enum": [
- "U.S. Dollars",
- "percent"
- ],
- "type": "string"
- },
- "include_obligations_company_sponsorship": {
- "type": "boolean"
- },
- "include_obligations_company_sponsorship_include_benefits": {
- "type": "boolean"
- },
- "include_obligations_company_sponsorship_include_benefits_val": {
- "type": "string"
- },
- "include_obligations_company_sponsorship_include_payments": {
- "type": "boolean"
- },
- "include_obligations_company_sponsorship_include_payments_amount": {
- "type": "number"
- },
- "include_obligations_company_sponsorship_include_payments_unit": {
- "enum": [
- "U.S. Dollars",
- "percent"
- ],
- "type": "string"
- },
- "include_obligations_partner_brand": {
- "type": "boolean"
- },
- "include_obligations_partner_promotion": {
- "type": "boolean"
- },
- "include_obligations_partner_promotion_include_activities": {
- "type": "boolean"
- },
- "include_obligations_partner_promotion_include_activities_val": {
- "type": "string"
- },
- "include_obligations_partner_promotion_include_materials": {
- "type": "boolean"
- },
- "include_obligations_partner_promotion_include_materials_val": {
- "type": "string"
- },
- "include_obligations_partner_referral": {
- "type": "boolean"
- },
- "include_obligations_partner_referral_include_criteria": {
- "type": "boolean"
- },
- "include_obligations_partner_referral_include_criteria_val": {
- "type": "string"
- },
- "include_obligations_partner_referral_include_pay_sch": {
- "type": "boolean"
- },
- "include_obligations_partner_referral_include_pay_sch_amount": {
- "type": "number"
- },
- "include_obligations_partner_referral_include_pay_sch_custom": {
- "type": "string"
- },
- "include_obligations_partner_referral_include_pay_sch_unit": {
- "enum": [
- "U.S. Dollars",
- "percent"
- ],
- "type": "string"
- },
- "include_obligations_partner_sponsorship": {
- "type": "boolean"
- },
- "include_obligations_partner_sponsorship_include_benefits": {
- "type": "boolean"
- },
- "include_obligations_partner_sponsorship_include_benefits_val": {
- "type": "string"
- },
- "include_obligations_partner_sponsorship_include_payments": {
- "type": "boolean"
- },
- "include_obligations_partner_sponsorship_include_payments_amount": {
- "type": "number"
- },
- "include_obligations_partner_sponsorship_include_payments_unit": {
- "enum": [
- "U.S. Dollars",
- "percent"
- ],
- "type": "string"
- },
- "include_payment_process": {
- "type": "boolean"
- },
- "include_payment_process_company": {
- "type": "boolean"
- },
- "include_payment_process_company_include_address": {
- "type": "boolean"
- },
- "include_payment_process_company_include_address_city": {
- "type": "string"
- },
- "include_payment_process_company_include_address_country": {
- "type": "string"
- },
- "include_payment_process_company_include_address_state": {
- "type": "string"
- },
- "include_payment_process_company_include_address_street_address": {
- "type": "string"
- },
- "include_payment_process_company_include_address_zipcode": {
- "type": "string"
- },
- "include_payment_process_company_include_email": {
- "type": "boolean"
- },
- "include_payment_process_company_include_email_val": {
- "type": "string"
- },
- "include_payment_process_partner": {
- "type": "boolean"
- },
- "include_payment_process_partner_include_address": {
- "type": "boolean"
- },
- "include_payment_process_partner_include_address_city": {
- "type": "string"
- },
- "include_payment_process_partner_include_address_country": {
- "type": "string"
- },
- "include_payment_process_partner_include_address_state": {
- "type": "string"
- },
- "include_payment_process_partner_include_address_street_address": {
- "type": "string"
- },
- "include_payment_process_partner_include_address_zipcode": {
- "type": "string"
- },
- "include_payment_process_partner_include_email": {
- "type": "boolean"
- },
- "include_payment_process_partner_include_email_val": {
- "type": "string"
- },
- "include_payment_schedule": {
- "type": "boolean"
- },
- "include_payment_schedule_custom": {
- "type": "string"
- },
- "include_payment_schedule_specified_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_payment_schedule_specified_timeframe": {
- "enum": [
- "receipt",
- "date"
- ],
- "type": "string"
- },
- "include_payment_schedule_specified_unit": {
- "enum": [
- "day(s)",
- "week(s)",
- "month(s)",
- "quarter(s)",
- "year(s)"
- ],
- "type": "string"
- },
- "include_payment_schedule_type": {
- "enum": [
- "specified",
- "custom"
- ],
- "type": "string"
- },
- "negotiations_allowed": {
- "description": "When true, the recipient can propose changes to the business terms, even when the agreement-level `negotiations_allowed` is false. This only covers the business terms.",
- "type": "boolean"
- },
- "territory_type": {
- "enum": [
- "worldwide",
- "custom"
- ],
- "type": "string"
- },
- "territory_type_val": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "payment_link_url": {
- "description": "A payment URL shown to the recipient after signing. Requires include_billing_workflow to be true and billing_workflow_type to be \"link\".",
- "type": "string"
- },
- "pilot_attributes": {
- "additionalProperties": false,
- "description": "Override pilot terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "fees_type": {
- "enum": [
- "free",
- "pilot_period_fees"
- ],
- "type": "string"
- },
- "general_cap_amount": {
- "type": "number"
- },
- "general_cap_amount_type": {
- "enum": [
- "preceding",
- "base",
- "period"
- ],
- "type": "string"
- },
- "general_cap_period_currency": {
- "type": "number"
- },
- "general_cap_period_qty": {
- "type": "number"
- },
- "general_cap_preceding_amount": {
- "type": "number"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_dpa": {
- "type": "boolean"
- },
- "include_dpa_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_dpa_location": {
- "type": "string"
- },
- "include_dpa_type": {
- "enum": [
- "description",
- "attachment",
- "standard"
- ],
- "type": "string"
- },
- "include_payment_process": {
- "type": "boolean"
- },
- "include_technical_support": {
- "type": "boolean"
- },
- "payment_process_automatic_frequency": {
- "enum": [
- "monthly",
- "quarterly",
- "annually",
- "once_per_period"
- ],
- "type": "string"
- },
- "payment_process_invoice_days": {
- "type": "number"
- },
- "payment_process_invoice_from": {
- "enum": [
- "receipt",
- "date"
- ],
- "type": "string"
- },
- "payment_process_invoice_timeframe": {
- "enum": [
- "days",
- "weeks",
- "months",
- "quarters",
- "years"
- ],
- "type": "string"
- },
- "payment_process_type": {
- "enum": [
- "automatic",
- "invoice"
- ],
- "type": "string"
- },
- "pilot_period_description": {
- "type": "string"
- },
- "pilot_period_fees_description": {
- "type": "string"
- },
- "product_description": {
- "type": "string"
- },
- "technical_support_description": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "psa_attributes": {
- "additionalProperties": false,
- "description": "Override psa terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "additional_changes": {
- "type": "string"
- },
- "customer_description": {
- "type": "string"
- },
- "effective_date": {
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "effective_date_type": {
- "enum": [
- "signature",
- "date"
- ],
- "type": "string"
- },
- "general_cap_amount": {
- "type": "number"
- },
- "general_cap_amount_type": {
- "enum": [
- "preceding",
- "base",
- "period"
- ],
- "type": "string"
- },
- "general_cap_period_currency": {
- "type": "number"
- },
- "general_cap_period_qty": {
- "type": "number"
- },
- "general_cap_preceding_amount": {
- "type": "number"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_additional_changes": {
- "type": "boolean"
- },
- "include_additional_warranties": {
- "type": "boolean"
- },
- "include_additional_warranties_by_customer": {
- "type": "string"
- },
- "include_additional_warranties_by_provider": {
- "type": "string"
- },
- "include_additional_warranties_include_by_customer": {
- "type": "boolean"
- },
- "include_additional_warranties_include_by_provider": {
- "type": "boolean"
- },
- "include_covered_claims": {
- "type": "boolean"
- },
- "include_covered_claims_customer_claims": {
- "type": "string"
- },
- "include_covered_claims_include_customer_claims": {
- "type": "boolean"
- },
- "include_covered_claims_include_provider_claims": {
- "type": "boolean"
- },
- "include_covered_claims_provider_claims": {
- "type": "string"
- },
- "include_customer_insurance_min": {
- "type": "boolean"
- },
- "include_customer_insurance_min_add_provider_com_gen_liability": {
- "type": "boolean"
- },
- "include_customer_insurance_min_add_provider_cyber_liability": {
- "type": "boolean"
- },
- "include_customer_insurance_min_add_provider_errors_omissions": {
- "type": "boolean"
- },
- "include_customer_insurance_min_auto_liability_aggregate": {
- "type": "number"
- },
- "include_customer_insurance_min_auto_liability_minimum": {
- "type": "number"
- },
- "include_customer_insurance_min_cyber_liability_aggregate": {
- "type": "number"
- },
- "include_customer_insurance_min_cyber_liability_minimum": {
- "type": "number"
- },
- "include_customer_insurance_min_employer_liability_aggregate": {
- "type": "number"
- },
- "include_customer_insurance_min_employer_liability_minimum": {
- "type": "number"
- },
- "include_customer_insurance_min_general_liability_aggregate": {
- "type": "number"
- },
- "include_customer_insurance_min_general_liability_minimum": {
- "type": "number"
- },
- "include_customer_insurance_min_include_add_provider": {
- "type": "boolean"
- },
- "include_customer_insurance_min_include_auto_liability": {
- "type": "boolean"
- },
- "include_customer_insurance_min_include_cyber_liability": {
- "type": "boolean"
- },
- "include_customer_insurance_min_include_employer_liability": {
- "type": "boolean"
- },
- "include_customer_insurance_min_include_general_liability": {
- "type": "boolean"
- },
- "include_customer_insurance_min_include_workers_comp": {
- "type": "boolean"
- },
- "include_customer_policies": {
- "type": "boolean"
- },
- "include_customer_policies_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_customer_policies_location": {
- "type": "string"
- },
- "include_customer_policies_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_dpa": {
- "type": "boolean"
- },
- "include_dpa_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_dpa_location": {
- "type": "string"
- },
- "include_dpa_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_increased_cap_amount": {
- "type": "boolean"
- },
- "include_increased_claims": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_confidentiality": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_confidentiality_negligence": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_privsec": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_privsec_negligence": {
- "type": "boolean"
- },
- "include_increased_claims_include_other": {
- "type": "boolean"
- },
- "include_increased_claims_indemnification_obligation": {
- "type": "boolean"
- },
- "include_increased_claims_negligence": {
- "type": "boolean"
- },
- "include_increased_claims_other": {
- "type": "string"
- },
- "include_provider_insurance_min": {
- "type": "boolean"
- },
- "include_provider_insurance_min_add_customer_com_gen_liability": {
- "type": "boolean"
- },
- "include_provider_insurance_min_add_customer_cyber_liability": {
- "type": "boolean"
- },
- "include_provider_insurance_min_add_customer_errors_omissions": {
- "type": "boolean"
- },
- "include_provider_insurance_min_auto_liability_aggregate": {
- "type": "number"
- },
- "include_provider_insurance_min_auto_liability_minimum": {
- "type": "number"
- },
- "include_provider_insurance_min_cyber_liability_aggregate": {
- "type": "number"
- },
- "include_provider_insurance_min_cyber_liability_minimum": {
- "type": "number"
- },
- "include_provider_insurance_min_employer_liability_aggregate": {
- "type": "number"
- },
- "include_provider_insurance_min_employer_liability_minimum": {
- "type": "number"
- },
- "include_provider_insurance_min_general_liability_aggregate": {
- "type": "number"
- },
- "include_provider_insurance_min_general_liability_minimum": {
- "type": "number"
- },
- "include_provider_insurance_min_include_add_customer": {
- "type": "boolean"
- },
- "include_provider_insurance_min_include_auto_liability": {
- "type": "boolean"
- },
- "include_provider_insurance_min_include_cyber_liability": {
- "type": "boolean"
- },
- "include_provider_insurance_min_include_employer_liability": {
- "type": "boolean"
- },
- "include_provider_insurance_min_include_general_liability": {
- "type": "boolean"
- },
- "include_provider_insurance_min_include_workers_comp": {
- "type": "boolean"
- },
- "include_publicity_rights": {
- "type": "boolean"
- },
- "include_publicity_rights_type": {
- "enum": [
- "public",
- "non-public"
- ],
- "type": "string"
- },
- "include_security_policy": {
- "type": "boolean"
- },
- "include_security_policy_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_security_policy_fedramp_auth": {
- "type": "boolean"
- },
- "include_security_policy_hitrust": {
- "type": "boolean"
- },
- "include_security_policy_include_annual_maintenance": {
- "type": "boolean"
- },
- "include_security_policy_include_other": {
- "type": "boolean"
- },
- "include_security_policy_include_other_val": {
- "type": "string"
- },
- "include_security_policy_iso27001": {
- "type": "boolean"
- },
- "include_security_policy_location": {
- "type": "string"
- },
- "include_security_policy_pci1": {
- "type": "boolean"
- },
- "include_security_policy_pci2": {
- "type": "boolean"
- },
- "include_security_policy_penetration_testing": {
- "type": "boolean"
- },
- "include_security_policy_soc2_type1": {
- "type": "boolean"
- },
- "include_security_policy_soc2_type2": {
- "type": "boolean"
- },
- "include_security_policy_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_unlimited_claims": {
- "type": "boolean"
- },
- "include_unlimited_claims_breach_of_confidentiality": {
- "type": "boolean"
- },
- "include_unlimited_claims_breach_of_confidentiality_negligence": {
- "type": "boolean"
- },
- "include_unlimited_claims_breach_of_privsec": {
- "type": "boolean"
- },
- "include_unlimited_claims_breach_of_privsec_negligence": {
- "type": "boolean"
- },
- "include_unlimited_claims_include_other": {
- "type": "boolean"
- },
- "include_unlimited_claims_indemnification_obligation": {
- "type": "boolean"
- },
- "include_unlimited_claims_negligence": {
- "type": "boolean"
- },
- "include_unlimited_claims_other": {
- "type": "string"
- },
- "increased_cap_amount_currency": {
- "type": "number"
- },
- "increased_cap_amount_period_currency": {
- "type": "number"
- },
- "increased_cap_amount_period_qty": {
- "type": "number"
- },
- "increased_cap_amount_qty": {
- "type": "number"
- },
- "increased_cap_amount_type": {
- "enum": [
- "qty",
- "currency",
- "period"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- "psa_statement_of_work_attributes": {
- "additionalProperties": false,
- "description": "Override psa statement of work terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "additional_changes": {
- "type": "string"
- },
- "cost": {
- "type": "number"
- },
- "description": {
- "type": "string"
- },
- "fee_type": {
- "type": "string"
- },
- "fees_attributes": {
- "additionalProperties": {
- "anyOf": [
- {
- "additionalProperties": false,
- "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": "string"
- },
- "include_deliverables": {
- "type": "boolean"
- },
- "include_deliverables_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_deliverables_description": {
- "type": "string"
- },
- "include_deliverables_include_acceptance": {
- "type": "boolean"
- },
- "include_deliverables_include_attachment": {
- "type": "boolean"
- },
- "include_deliverables_include_draft_deliverables": {
- "type": "boolean"
- },
- "include_deliverables_rejection_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_deliverables_rejection_unit": {
- "enum": [
- "hours",
- "days",
- "weeks",
- "months"
- ],
- "type": "string"
- },
- "include_deliverables_resubmission_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_deliverables_resubmission_unit": {
- "enum": [
- "hours",
- "days",
- "weeks",
- "months"
- ],
- "type": "string"
- },
- "include_fees_other": {
- "type": "boolean"
- },
- "include_fees_other_val": {
- "type": "string"
- },
- "include_fees_table": {
- "type": "boolean"
- },
- "include_fees_table_total": {
- "type": "boolean"
- },
- "include_fees_travel": {
- "type": "boolean"
- },
- "include_fees_travel_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_fees_travel_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_fees_travel_val": {
- "type": "string"
- },
- "include_third_party_customer": {
- "type": "boolean"
- },
- "include_third_party_include_description": {
- "type": "boolean"
- },
- "include_third_party_include_description_val": {
- "type": "string"
- },
- "include_third_party_materials": {
- "type": "boolean"
- },
- "include_third_party_provider": {
- "type": "boolean"
- },
- "include_time_of_assignment": {
- "type": "boolean"
- },
- "include_time_of_assignment_type": {
- "enum": [
- "created",
- "paid"
- ],
- "type": "string"
- },
- "invoice_period_description": {
- "type": "string"
- },
- "negotiations_allowed": {
- "description": "When true, the recipient can propose changes to the statement of work, even when the agreement-level `negotiations_allowed` is false. This only covers the statement of work.",
- "type": "boolean"
- },
- "payment_period": {
- "type": "number"
- },
- "payment_period_other": {
- "type": "string"
- },
- "payment_period_timeframe": {
- "enum": [
- "receipt",
- "invoice",
- "Customer's receipt of invoice",
- "date of invoice"
- ],
- "type": "string"
- },
- "payment_period_type": {
- "enum": [
- "standard",
- "other"
- ],
- "type": "string"
- },
- "payment_period_unit": {
- "enum": [
- "day(s)",
- "week(s)",
- "month(s)",
- "quarter(s)",
- "year(s)"
- ],
- "type": "string"
- },
- "quantity": {
- "type": "number"
- },
- "services_description": {
- "type": "string"
- },
- "sow_date": {
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "sow_date_type": {
- "enum": [
- "signature",
- "date"
- ],
- "type": "string"
- },
- "sow_term_amount": {
- "type": "number"
- },
- "sow_term_date": {
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "sow_term_type": {
- "enum": [
- "deliverables",
- "period",
- "date"
- ],
- "type": "string"
- },
- "sow_term_unit": {
- "enum": [
- "month(s)",
- "quarter(s)",
- "year(s)"
- ],
- "type": "string"
- },
- "type": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "recipient_email": {
- "format": "email",
- "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-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_last_to_sign": {
- "description": "When true, your signer signs after the recipient.",
- "type": "boolean"
- },
- "sender_notice_email_address": {
- "description": "Email address for legal notices to the sender.",
- "format": "email",
- "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-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": {
- "enum": [
- "signature",
- "date"
- ],
- "type": "string"
- },
- "general_cap_amount": {
- "type": "number"
- },
- "general_cap_amount_type": {
- "enum": [
- "preceding",
- "base",
- "period"
- ],
- "type": "string"
- },
- "general_cap_period_currency": {
- "type": "number"
- },
- "general_cap_period_qty": {
- "type": "number"
- },
- "general_cap_preceding_amount": {
- "type": "number"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_additional_warranties": {
- "type": "boolean"
- },
- "include_additional_warranties_by_customer": {
- "type": "string"
- },
- "include_additional_warranties_by_provider": {
- "type": "string"
- },
- "include_additional_warranties_include_by_customer": {
- "type": "boolean"
- },
- "include_additional_warranties_include_by_provider": {
- "type": "boolean"
- },
- "include_ai_addendum": {
- "type": "boolean"
- },
- "include_ai_addendum_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_covered_claims": {
- "type": "boolean"
- },
- "include_covered_claims_customer_claims": {
- "type": "string"
- },
- "include_covered_claims_include_customer_claims": {
- "type": "boolean"
- },
- "include_covered_claims_include_provider_claims": {
- "type": "boolean"
- },
- "include_covered_claims_provider_claims": {
- "type": "string"
- },
- "include_dpa": {
- "type": "boolean"
- },
- "include_dpa_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_dpa_location": {
- "type": "string"
- },
- "include_dpa_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_increased_cap_amount": {
- "type": "boolean"
- },
- "include_increased_claims": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_confidentiality": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_confidentiality_negligence": {
- "type": "boolean"
- },
- "include_increased_claims_include_other": {
- "type": "boolean"
- },
- "include_increased_claims_indemnification_obligation": {
- "type": "boolean"
- },
- "include_increased_claims_negligence": {
- "type": "boolean"
- },
- "include_increased_claims_other": {
- "type": "string"
- },
- "include_increased_claims_restrictions": {
- "type": "boolean"
- },
- "include_unlimited_claims": {
- "type": "boolean"
- },
- "include_unlimited_claims_breach_of_confidentiality": {
- "type": "boolean"
- },
- "include_unlimited_claims_breach_of_confidentiality_negligence": {
- "type": "boolean"
- },
- "include_unlimited_claims_include_other": {
- "type": "boolean"
- },
- "include_unlimited_claims_indemnification_obligation": {
- "type": "boolean"
- },
- "include_unlimited_claims_license_or_restrictions": {
- "type": "boolean"
- },
- "include_unlimited_claims_negligence": {
- "type": "boolean"
- },
- "include_unlimited_claims_other": {
- "type": "string"
- },
- "increased_cap_amount_currency": {
- "type": "number"
- },
- "increased_cap_amount_period_currency": {
- "type": "number"
- },
- "increased_cap_amount_period_qty": {
- "type": "number"
- },
- "increased_cap_amount_qty": {
- "type": "number"
- },
- "increased_cap_amount_type": {
- "enum": [
- "qty",
- "currency",
- "period"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- "software_license_order_form_attributes": {
- "additionalProperties": false,
- "description": "Override software license order form terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "additional_changes": {
- "type": "string"
- },
- "deletion_procedure_include_custom": {
- "type": "boolean"
- },
- "deletion_procedure_include_custom_description": {
- "type": "string"
- },
- "deletion_procedure_include_customer_disable": {
- "type": "boolean"
- },
- "deletion_procedure_include_customer_proof": {
- "type": "boolean"
- },
- "deletion_procedure_include_provider_disable": {
- "type": "boolean"
- },
- "fee_custom_unit": {
- "type": "string"
- },
- "fee_period": {
- "enum": [
- "Subscription Period",
- "month",
- "year",
- "Custom unit"
- ],
- "type": "string"
- },
- "fees_attributes": {
- "additionalProperties": {
- "anyOf": [
- {
- "additionalProperties": false,
- "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": {
- "enum": [
- "USD",
- "EUR",
- "GBP",
- "CAD",
- "AUD",
- "SGD",
- "ILS",
- "JPY",
- "CHF",
- "HKD"
- ],
- "type": "string"
- },
- "fees_include_fee_increase_upon_renewal": {
- "type": "boolean"
- },
- "fees_include_fee_increase_upon_renewal_fee": {
- "type": "number"
- },
- "fees_include_fee_increase_upon_renewal_type": {
- "enum": [
- "will",
- "may"
- ],
- "type": "string"
- },
- "fees_inclusive_of_taxes": {
- "type": "boolean"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_additional_changes": {
- "type": "boolean"
- },
- "include_license_compliance_verification": {
- "type": "boolean"
- },
- "include_license_compliance_verification_description": {
- "type": "string"
- },
- "include_license_limits": {
- "type": "boolean"
- },
- "include_license_limits_description": {
- "type": "string"
- },
- "include_payment_process_include_billing_email": {
- "type": "boolean"
- },
- "include_pilot_period": {
- "type": "boolean"
- },
- "include_pilot_period_duration_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_pilot_period_duration_type": {
- "enum": [
- "day",
- "week",
- "month"
- ],
- "type": "string"
- },
- "include_pilot_period_include_fees": {
- "type": "boolean"
- },
- "include_pilot_period_include_fees_amount": {
- "type": "number"
- },
- "include_pilot_period_include_modifications": {
- "type": "boolean"
- },
- "include_pilot_period_include_modifications_description": {
- "type": "string"
- },
- "include_services": {
- "type": "boolean"
- },
- "include_services_description": {
- "type": "string"
- },
- "negotiations_allowed": {
- "description": "When true, the recipient can propose changes to the order form, even when the agreement-level `negotiations_allowed` is false. This only covers the order form.",
- "type": "boolean"
- },
- "order_date_date": {
- "type": "string"
- },
- "order_date_type": {
- "enum": [
- "signature",
- "date",
- "other"
- ],
- "type": "string"
- },
- "payment_process_automatic_frequency": {
- "enum": [
- "monthly",
- "quarterly",
- "semiannually",
- "annually"
- ],
- "type": "string"
- },
- "payment_process_type": {
- "enum": [
- "automatic",
- "invoice",
- "custom"
- ],
- "type": "string"
- },
- "payment_process_type_custom_val": {
- "type": "string"
- },
- "payment_process_type_invoice_amount": {
- "type": "number"
- },
- "payment_process_type_invoice_custom_unit": {
- "type": "string"
- },
- "payment_process_type_invoice_duration": {
- "enum": [
- "day",
- "week",
- "month",
- "year",
- "day(s)",
- "week(s)",
- "month(s)",
- "year(s)"
- ],
- "type": "string"
- },
- "payment_process_type_invoice_duration_start": {
- "enum": [
- "Customer's receipt of invoice",
- "date of invoice"
- ],
- "type": "string"
- },
- "payment_process_type_invoice_type": {
- "enum": [
- "monthly",
- "quarterly",
- "semiannually",
- "annually",
- "Custom unit"
- ],
- "type": "string"
- },
- "permitted_uses_include_custom": {
- "type": "boolean"
- },
- "permitted_uses_include_custom_description": {
- "type": "string"
- },
- "permitted_uses_include_customers_affiliates": {
- "type": "boolean"
- },
- "permitted_uses_include_internal_business": {
- "type": "boolean"
- },
- "pilot_period_stripe_product_id": {
- "type": "string"
- },
- "software_description": {
- "type": "string"
- },
- "subscription_auto_renew": {
- "enum": [
- "days",
- "subscription_end"
- ],
- "type": "string"
- },
- "subscription_period": {
- "type": "number"
- },
- "subscription_period_unit": {
- "type": "string"
- },
- "subscription_renewal_notice_days": {
- "type": "number"
- },
- "warranty_period_description_amount": {
- "type": "number"
- },
- "warranty_period_description_duration": {
- "enum": [
- "day",
- "week",
- "month",
- "year"
- ],
- "type": "string"
- },
- "warranty_period_description_duration_start": {
- "enum": [
- "initial delivery of the Software",
- "delivery of the Software and each subsequent Update",
- "the Order Date"
- ],
- "type": "string"
- },
- "warranty_period_type": {
- "enum": [
- "description",
- "none"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- "test_agreement": {
- "description": "When true, marks the agreement as a test. Test agreements do not count against your monthly limit.",
- "type": "boolean"
- }
- },
- "required": [
- "recipient_name",
- "recipient_email"
- ],
- "type": "object"
- },
- "cc_users": {
- "items": {
- "format": "email",
- "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
- "type": "string"
- },
- "type": "array"
- },
- "draft": {
- "description": "When true, the agreement is saved as a draft and not sent to the recipient. Use POST /v1/agreements/{id}/send to send a draft agreement later.",
- "type": "boolean"
- },
- "owner_email": {
- "description": "Email address of the agreement owner (sender).",
- "type": "string"
- },
- "signer_id": {
- "description": "User id of the signer from the owner's organization.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "template_id": {
- "description": "UUID of a template from `GET /v1/templates`. Accepts both Common Paper standard templates and uploaded PDF templates (`type` `uploaded_template`).",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- }
- },
- "required": [
- "template_id",
- "owner_email",
- "signer_id",
- "agreement"
- ],
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "agreement": {
- "additionalProperties": {},
- "properties": {
- "amendment_attributes": {
- "additionalProperties": false,
- "description": "Override amendment terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "amended_terms_attributes": {
- "additionalProperties": {
- "additionalProperties": false,
- "properties": {
- "description": {
- "type": "string"
- },
- "term": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "description": "Amended terms. Use string keys such as \"0\", \"1\".",
- "propertyNames": {
- "type": "string"
- },
- "type": "object"
- },
- "amendment_date": {
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "amendment_date_type": {
- "enum": [
- "signature",
- "date"
- ],
- "type": "string"
- },
- "framework_terms_type": {
- "type": "string"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "parent_agreement_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "underlying_agreement_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "underlying_agreement_type": {
- "type": "string"
- },
- "underlying_agreement_val": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "baa_attributes": {
- "additionalProperties": false,
- "description": "Override baa terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "aggregation_limitations_permitted": {
- "type": "boolean"
- },
- "aggregation_limitations_permitted_val": {
- "type": "string"
- },
- "breach_notification_unit": {
- "enum": [
- "hours",
- "business days",
- "calendar days"
- ],
- "type": "string"
- },
- "breach_notification_val": {
- "type": "number"
- },
- "business_associate_relationship_type": {
- "enum": [
- "provider",
- "company"
- ],
- "type": "string"
- },
- "deidentification_limitations_include_purpose": {
- "type": "boolean"
- },
- "deidentification_limitations_include_requirements": {
- "type": "boolean"
- },
- "deidentification_limitations_permitted": {
- "type": "boolean"
- },
- "deidentification_limitations_purpose_val": {
- "type": "string"
- },
- "deidentification_limitations_requirements_val": {
- "type": "string"
- },
- "designated_record_set_provider_maintains": {
- "type": "boolean"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_aggregation_limitations": {
- "type": "boolean"
- },
- "include_deidentification_limitations": {
- "type": "boolean"
- },
- "include_limitations": {
- "type": "boolean"
- },
- "include_offshore_limitations": {
- "type": "boolean"
- },
- "include_subcontract_limitations": {
- "type": "boolean"
- },
- "offshore_limitations_permitted": {
- "type": "boolean"
- },
- "offshore_limitations_permitted_val": {
- "type": "string"
- },
- "subcontract_limitations_include_notice": {
- "type": "boolean"
- },
- "subcontract_limitations_include_permission": {
- "type": "boolean"
- },
- "subcontract_limitations_notice_val": {
- "type": "string"
- },
- "subcontract_limitations_permission_val": {
- "type": "string"
- },
- "subcontract_limitations_permitted": {
- "type": "boolean"
- },
- "underlying_agreement_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "underlying_agreement_type": {
- "enum": [
- "internal",
- "external",
- "none"
- ],
- "type": "string"
- },
- "underlying_agreement_val": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "billing_email": {
- "description": "Email of the billing contact. Used when include_billing_info is true.",
- "format": "email",
- "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
- "type": "string"
- },
- "billing_name": {
- "description": "Name of the billing contact. Used when include_billing_info is true.",
- "type": "string"
- },
- "billing_workflow_type": {
- "description": "The type of billing workflow. Use \"link\" to provide a payment_link_url, or \"stripe\" for Stripe-managed billing.",
- "enum": [
- "link",
- "stripe"
- ],
- "type": "string"
- },
- "chosen_courts_country": {
- "description": "The country in which disputes will be resolved.",
- "type": "string"
- },
- "chosen_courts_region": {
- "description": "The state or region in which disputes will be resolved.",
- "type": "string"
- },
- "csa_attributes": {
- "additionalProperties": false,
- "description": "Override csa terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "customer_description": {
- "type": "string"
- },
- "effective_date": {
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "effective_date_marketplace": {
- "enum": [
- "AWS",
- "GCP",
- "Azure"
- ],
- "type": "string"
- },
- "effective_date_type": {
- "enum": [
- "signature",
- "date",
- "marketplace_acceptance"
- ],
- "type": "string"
- },
- "general_cap_amount": {
- "type": "number"
- },
- "general_cap_amount_type": {
- "enum": [
- "preceding",
- "base",
- "period"
- ],
- "type": "string"
- },
- "general_cap_period_currency": {
- "type": "number"
- },
- "general_cap_period_qty": {
- "type": "number"
- },
- "general_cap_preceding_amount": {
- "type": "number"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_acceptable_use_policy": {
- "type": "boolean"
- },
- "include_acceptable_use_policy_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_acceptable_use_policy_location": {
- "type": "string"
- },
- "include_acceptable_use_policy_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_additional_warranties": {
- "type": "boolean"
- },
- "include_additional_warranties_by_customer": {
- "type": "string"
- },
- "include_additional_warranties_by_provider": {
- "type": "string"
- },
- "include_additional_warranties_include_by_customer": {
- "type": "boolean"
- },
- "include_additional_warranties_include_by_provider": {
- "type": "boolean"
- },
- "include_ai_addendum": {
- "type": "boolean"
- },
- "include_ai_addendum_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_covered_claims": {
- "type": "boolean"
- },
- "include_covered_claims_customer_claims": {
- "type": "string"
- },
- "include_covered_claims_include_customer_claims": {
- "type": "boolean"
- },
- "include_covered_claims_include_provider_claims": {
- "type": "boolean"
- },
- "include_covered_claims_provider_claims": {
- "type": "string"
- },
- "include_dpa": {
- "type": "boolean"
- },
- "include_dpa_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_dpa_location": {
- "type": "string"
- },
- "include_dpa_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_increased_cap_amount": {
- "type": "boolean"
- },
- "include_increased_claims": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_confidentiality": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_confidentiality_negligence": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_privsec": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_privsec_negligence": {
- "type": "boolean"
- },
- "include_increased_claims_include_other": {
- "type": "boolean"
- },
- "include_increased_claims_indemnification_obligation": {
- "type": "boolean"
- },
- "include_increased_claims_other": {
- "type": "string"
- },
- "include_insurance_minimums": {
- "type": "boolean"
- },
- "include_insurance_minimums_add_customer": {
- "type": "boolean"
- },
- "include_insurance_minimums_add_customer_com_gen_liability": {
- "type": "boolean"
- },
- "include_insurance_minimums_add_customer_cyber_liability": {
- "type": "boolean"
- },
- "include_insurance_minimums_add_customer_errors_omissions": {
- "type": "boolean"
- },
- "include_insurance_minimums_additional_information": {
- "type": "boolean"
- },
- "include_insurance_minimums_additional_information_text": {
- "type": "string"
- },
- "include_insurance_minimums_cyber_liability_aggregate": {
- "type": "number"
- },
- "include_insurance_minimums_cyber_liability_minimum": {
- "type": "number"
- },
- "include_insurance_minimums_employer_liability_aggregate": {
- "type": "number"
- },
- "include_insurance_minimums_employer_liability_minimum": {
- "type": "number"
- },
- "include_insurance_minimums_general_liability_aggregate": {
- "type": "number"
- },
- "include_insurance_minimums_general_liability_minimum": {
- "type": "number"
- },
- "include_insurance_minimums_include_cyber_liability": {
- "type": "boolean"
- },
- "include_insurance_minimums_include_employer_liability": {
- "type": "boolean"
- },
- "include_insurance_minimums_include_general_liability": {
- "type": "boolean"
- },
- "include_insurance_minimums_include_workers_compensation": {
- "type": "boolean"
- },
- "include_publicity_rights": {
- "type": "boolean"
- },
- "include_publicity_rights_type": {
- "enum": [
- "public",
- "non-public"
- ],
- "type": "string"
- },
- "include_security_policy": {
- "type": "boolean"
- },
- "include_security_policy_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_security_policy_fedramp_auth": {
- "type": "boolean"
- },
- "include_security_policy_hipaa": {
- "type": "boolean"
- },
- "include_security_policy_hitrust": {
- "type": "boolean"
- },
- "include_security_policy_include_annual_maintenance": {
- "type": "boolean"
- },
- "include_security_policy_include_location": {
- "type": "boolean"
- },
- "include_security_policy_include_other": {
- "type": "boolean"
- },
- "include_security_policy_include_reasonable_efforts": {
- "type": "boolean"
- },
- "include_security_policy_iso27001": {
- "type": "boolean"
- },
- "include_security_policy_location": {
- "type": "string"
- },
- "include_security_policy_other": {
- "type": "string"
- },
- "include_security_policy_pci1": {
- "type": "boolean"
- },
- "include_security_policy_pci2": {
- "type": "boolean"
- },
- "include_security_policy_penetration_testing": {
- "type": "boolean"
- },
- "include_security_policy_soc2": {
- "type": "boolean"
- },
- "include_security_policy_soc2_type2": {
- "type": "boolean"
- },
- "include_security_policy_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_supercap": {
- "description": "CSA 3.0 renamed `include_increased_cap_amount` to `include_supercap`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_increased_cap_amount`. Sending the other spelling returns a 422.",
- "type": "boolean"
- },
- "include_uncapped_claims": {
- "description": "CSA 3.0 renamed `include_unlimited_claims` to `include_uncapped_claims`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims`. Sending the other spelling returns a 422.",
- "type": "boolean"
- },
- "include_uncapped_claims_breach_of_confidentiality": {
- "description": "CSA 3.0 renamed `include_unlimited_claims_breach_of_confidentiality` to `include_uncapped_claims_breach_of_confidentiality`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_breach_of_confidentiality`. Sending the other spelling returns a 422.",
- "type": "boolean"
- },
- "include_uncapped_claims_breach_of_confidentiality_negligence": {
- "description": "CSA 3.0 renamed `include_unlimited_claims_breach_of_confidentiality_negligence` to `include_uncapped_claims_breach_of_confidentiality_negligence`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_breach_of_confidentiality_negligence`. Sending the other spelling returns a 422.",
- "type": "boolean"
- },
- "include_uncapped_claims_breach_of_privsec": {
- "description": "CSA 3.0 renamed `include_unlimited_claims_breach_of_privsec` to `include_uncapped_claims_breach_of_privsec`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_breach_of_privsec`. Sending the other spelling returns a 422.",
- "type": "boolean"
- },
- "include_uncapped_claims_breach_of_privsec_negligence": {
- "description": "CSA 3.0 renamed `include_unlimited_claims_breach_of_privsec_negligence` to `include_uncapped_claims_breach_of_privsec_negligence`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_breach_of_privsec_negligence`. Sending the other spelling returns a 422.",
- "type": "boolean"
- },
- "include_uncapped_claims_include_other": {
- "description": "CSA 3.0 renamed `include_unlimited_claims_include_other` to `include_uncapped_claims_include_other`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_include_other`. Sending the other spelling returns a 422.",
- "type": "boolean"
- },
- "include_uncapped_claims_indemnification_obligation": {
- "description": "CSA 3.0 renamed `include_unlimited_claims_indemnification_obligation` to `include_uncapped_claims_indemnification_obligation`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_indemnification_obligation`. Sending the other spelling returns a 422.",
- "type": "boolean"
- },
- "include_uncapped_claims_other": {
- "description": "CSA 3.0 renamed `include_unlimited_claims_other` to `include_uncapped_claims_other`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_other`. Sending the other spelling returns a 422.",
- "type": "boolean"
- },
- "include_unlimited_claims": {
- "type": "boolean"
- },
- "include_unlimited_claims_breach_of_confidentiality": {
- "type": "boolean"
- },
- "include_unlimited_claims_breach_of_confidentiality_negligence": {
- "type": "boolean"
- },
- "include_unlimited_claims_breach_of_privsec": {
- "type": "boolean"
- },
- "include_unlimited_claims_breach_of_privsec_negligence": {
- "type": "boolean"
- },
- "include_unlimited_claims_include_other": {
- "type": "boolean"
- },
- "include_unlimited_claims_indemnification_obligation": {
- "type": "boolean"
- },
- "include_unlimited_claims_other": {
- "type": "string"
- },
- "increased_cap_amount_currency": {
- "type": "number"
- },
- "increased_cap_amount_period_currency": {
- "type": "number"
- },
- "increased_cap_amount_period_qty": {
- "type": "number"
- },
- "increased_cap_amount_qty": {
- "type": "number"
- },
- "increased_cap_amount_type": {
- "enum": [
- "qty",
- "currency",
- "period"
- ],
- "type": "string"
- },
- "provider": {
- "type": "string"
- },
- "supercap_currency": {
- "description": "CSA 3.0 renamed `increased_cap_amount_currency` to `supercap_currency`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `increased_cap_amount_currency`. Sending the other spelling returns a 422.",
- "type": "number"
- },
- "supercap_period_currency": {
- "description": "CSA 3.0 renamed `increased_cap_amount_period_currency` to `supercap_period_currency`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `increased_cap_amount_period_currency`. Sending the other spelling returns a 422.",
- "type": "number"
- },
- "supercap_period_qty": {
- "description": "CSA 3.0 renamed `increased_cap_amount_period_qty` to `supercap_period_qty`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `increased_cap_amount_period_qty`. Sending the other spelling returns a 422.",
- "type": "number"
- },
- "supercap_qty": {
- "description": "CSA 3.0 renamed `increased_cap_amount_qty` to `supercap_qty`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `increased_cap_amount_qty`. Sending the other spelling returns a 422.",
- "type": "number"
- },
- "supercap_type": {
- "description": "CSA 3.0 renamed `increased_cap_amount_type` to `supercap_type`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `increased_cap_amount_type`. Sending the other spelling returns a 422.",
- "type": "number"
- }
- },
- "type": "object"
- },
- "csa_order_form_attributes": {
- "additionalProperties": false,
- "description": "Override csa order form terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "additional_changes": {
- "type": "string"
- },
- "additional_parameters_or_limitations": {
- "type": "string"
- },
- "affiliates_as_users": {
- "type": "boolean"
- },
- "cloud_service_description": {
- "type": "string"
- },
- "consumption_units": {
- "type": "string"
- },
- "fee_amount": {
- "type": "number"
- },
- "fee_custom_unit": {
- "type": "string"
- },
- "fee_period": {
- "enum": [
- "Subscription Period",
- "month",
- "year",
- "User",
- "Custom unit"
- ],
- "type": "string"
- },
- "fees_attributes": {
- "additionalProperties": {
- "anyOf": [
- {
- "additionalProperties": false,
- "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": {
- "enum": [
- "USD",
- "EUR",
- "GBP",
- "CAD",
- "AUD",
- "SGD",
- "ILS",
- "JPY",
- "CHF",
- "HKD"
- ],
- "type": "string"
- },
- "fees_include_fee_increase_upon_renewal": {
- "type": "boolean"
- },
- "fees_include_fee_increase_upon_renewal_fee": {
- "type": "number"
- },
- "fees_include_fee_increase_upon_renewal_type": {
- "enum": [
- "will",
- "may"
- ],
- "type": "string"
- },
- "fees_inclusive_of_taxes": {
- "type": "boolean"
- },
- "framework_terms_type": {
- "enum": [
- "new",
- "existing",
- "description"
- ],
- "type": "string"
- },
- "free_trial_days": {
- "type": "number"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_additional_changes": {
- "type": "boolean"
- },
- "include_additional_parameters_or_limitations": {
- "type": "boolean"
- },
- "include_consumption": {
- "type": "boolean"
- },
- "include_fees": {
- "type": "boolean"
- },
- "include_fees_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_fees_include_attachment": {
- "type": "boolean"
- },
- "include_fees_other": {
- "type": "boolean"
- },
- "include_fees_other_val": {
- "type": "string"
- },
- "include_fees_table": {
- "type": "boolean"
- },
- "include_fees_table_period": {
- "enum": [
- "Subscription Period",
- "month",
- "year",
- "User"
- ],
- "type": "string"
- },
- "include_free_trial": {
- "type": "boolean"
- },
- "include_max_users": {
- "type": "boolean"
- },
- "include_pilot_period": {
- "type": "boolean"
- },
- "include_pilot_period_duration_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_pilot_period_duration_type": {
- "enum": [
- "day",
- "week",
- "month"
- ],
- "type": "string"
- },
- "include_pilot_period_include_fees": {
- "type": "boolean"
- },
- "include_pilot_period_include_fees_amount": {
- "type": "number"
- },
- "include_pilot_period_include_modifications": {
- "type": "boolean"
- },
- "include_pilot_period_include_modifications_description": {
- "type": "string"
- },
- "include_product_support": {
- "type": "boolean"
- },
- "include_product_support_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_product_support_description": {
- "type": "string"
- },
- "include_product_support_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_professional_services": {
- "type": "boolean"
- },
- "include_professional_services_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_professional_services_custom_name": {
- "type": "string"
- },
- "include_professional_services_description": {
- "type": "string"
- },
- "include_professional_services_end_date": {
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "include_professional_services_fees_description": {
- "type": "string"
- },
- "include_professional_services_include_end_date": {
- "type": "boolean"
- },
- "include_professional_services_include_fees_description": {
- "type": "boolean"
- },
- "include_professional_services_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_sla": {
- "type": "boolean"
- },
- "include_sla_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_sla_description": {
- "type": "string"
- },
- "include_sla_include_response_time": {
- "type": "boolean"
- },
- "include_sla_include_response_time_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_sla_include_response_time_credit": {
- "type": "number"
- },
- "include_sla_include_response_time_duration": {
- "enum": [
- "hour",
- "day",
- "week",
- "month",
- "hours"
- ],
- "type": "string"
- },
- "include_sla_include_response_time_support_channel": {
- "type": "string"
- },
- "include_sla_include_target_uptime": {
- "type": "boolean"
- },
- "include_sla_maintenance_notice": {
- "type": "boolean"
- },
- "include_sla_maintenance_window": {
- "type": "boolean"
- },
- "include_sla_maintenance_window_type": {
- "enum": [
- "standard",
- "none"
- ],
- "type": "string"
- },
- "include_sla_standard_maintenance_notice_qty": {
- "type": "number"
- },
- "include_sla_standard_maintenance_notice_unit": {
- "enum": [
- "hour",
- "day",
- "week",
- "month"
- ],
- "type": "string"
- },
- "include_sla_standard_maintenance_window_end_time": {
- "type": "string"
- },
- "include_sla_standard_maintenance_window_friday": {
- "type": "boolean"
- },
- "include_sla_standard_maintenance_window_monday": {
- "type": "boolean"
- },
- "include_sla_standard_maintenance_window_saturday": {
- "type": "boolean"
- },
- "include_sla_standard_maintenance_window_start_time": {
- "type": "string"
- },
- "include_sla_standard_maintenance_window_sunday": {
- "type": "boolean"
- },
- "include_sla_standard_maintenance_window_thursday": {
- "type": "boolean"
- },
- "include_sla_standard_maintenance_window_time_zone": {
- "type": "string"
- },
- "include_sla_standard_maintenance_window_tuesday": {
- "type": "boolean"
- },
- "include_sla_standard_maintenance_window_wednesday": {
- "type": "boolean"
- },
- "include_sla_standard_target_uptime": {
- "type": "number"
- },
- "include_sla_type": {
- "enum": [
- "description",
- "standard",
- "attachment"
- ],
- "type": "string"
- },
- "include_subscription_start_date": {
- "type": "boolean"
- },
- "include_subscription_start_date_date": {
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "include_usage_review": {
- "type": "boolean"
- },
- "include_usage_review_val": {
- "type": "string"
- },
- "include_use_limitations": {
- "type": "boolean"
- },
- "include_use_limitations_val": {
- "type": "string"
- },
- "invoice_period": {
- "enum": [
- "monthly",
- "quarterly",
- "semiannually",
- "annually",
- "Custom unit",
- "Monthly",
- "Quarterly",
- "Semiannually",
- "Annually"
- ],
- "type": "string"
- },
- "invoice_period_custom_unit": {
- "type": "string"
- },
- "max_consumption": {
- "type": "number"
- },
- "max_users": {
- "type": "number"
- },
- "negotiations_allowed": {
- "description": "When true, the recipient can propose changes to the order form, even when the agreement-level `negotiations_allowed` is false. This only covers the order form.",
- "type": "boolean"
- },
- "order_date_date": {
- "type": "string"
- },
- "order_date_other": {
- "type": "string"
- },
- "order_date_type": {
- "enum": [
- "signature",
- "date",
- "other"
- ],
- "type": "string"
- },
- "payment_period": {
- "type": "number"
- },
- "payment_period_timeframe": {
- "enum": [
- "Customer's receipt of invoice",
- "date of invoice"
- ],
- "type": "string"
- },
- "payment_period_unit": {
- "enum": [
- "day(s)",
- "week(s)",
- "month(s)",
- "marketplace_acceptance"
- ],
- "type": "string"
- },
- "payment_process_automatic_frequency": {
- "enum": [
- "monthly",
- "quarterly",
- "semiannually",
- "annually"
- ],
- "type": "string"
- },
- "payment_process_type": {
- "enum": [
- "automatic",
- "invoice",
- "custom",
- "marketplace_acceptance"
- ],
- "type": "string"
- },
- "payment_process_type_custom_val": {
- "type": "string"
- },
- "payment_process_type_invoice_amount": {
- "type": "number"
- },
- "payment_process_type_invoice_custom_unit": {
- "type": "string"
- },
- "payment_process_type_invoice_duration": {
- "enum": [
- "day",
- "week",
- "month",
- "year",
- "day(s)",
- "week(s)",
- "month(s)",
- "year(s)"
- ],
- "type": "string"
- },
- "payment_process_type_invoice_duration_start": {
- "enum": [
- "Customer's receipt of invoice",
- "date of invoice"
- ],
- "type": "string"
- },
- "payment_process_type_invoice_type": {
- "enum": [
- "monthly",
- "quarterly",
- "semiannually",
- "annually",
- "Custom unit"
- ],
- "type": "string"
- },
- "pilot_period_stripe_product_id": {
- "type": "string"
- },
- "service_credits_attributes": {
- "additionalProperties": {
- "additionalProperties": false,
- "properties": {
- "credit": {
- "type": "number"
- },
- "max": {
- "type": "number"
- },
- "min": {
- "type": "number"
- }
- },
- "type": "object"
- },
- "description": "Service credits. Use string keys such as \"0\", \"1\".",
- "propertyNames": {
- "type": "string"
- },
- "type": "object"
- },
- "subscription_auto_renew": {
- "enum": [
- "days",
- "subscription_end"
- ],
- "type": "string"
- },
- "subscription_period": {
- "type": "number"
- },
- "subscription_period_unit": {
- "type": "string"
- },
- "subscription_renewal_notice_days": {
- "type": "number"
- },
- "subscription_start_date": {
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "subscription_start_date_type": {
- "enum": [
- "effective_date",
- "date"
- ],
- "type": "string"
- },
- "underlying_agreement_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "use_limitations_attributes": {
- "additionalProperties": {
- "additionalProperties": false,
- "properties": {
- "amount": {
- "type": "number"
- },
- "limitation_type": {
- "type": "string"
- },
- "unit": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "description": "Use limitations. Use string keys such as \"0\", \"1\".",
- "propertyNames": {
- "type": "string"
- },
- "type": "object"
- }
- },
- "type": "object"
- },
- "custom_field_values": {
- "description": "Values for a custom template's fields, keyed by the field keys defined in the template's YAML definition. Only used when template_id is a custom template. Template defaults fill any fields you omit; a required field with no default and no submitted value returns a 400 naming the field. Values are validated against the field's input type: select and radio values must be one of the field's options, multiselect values are an array of selections each of which must be one of the field's options, number and currency values must be numeric, date values must be YYYY-MM-DD, and email values must be valid addresses. An invalid value returns a 400 naming the field."
- },
- "design_partner_attributes": {
- "additionalProperties": false,
- "description": "Override design partner terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "customer_description": {
- "type": "string"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_fees": {
- "type": "boolean"
- },
- "include_fees_amount": {
- "type": "number"
- },
- "include_fees_description": {
- "type": "string"
- },
- "include_fees_pay_by_amount": {
- "type": "string"
- },
- "include_fees_type": {
- "enum": [
- "default_language",
- "description"
- ],
- "type": "string"
- },
- "include_fees_unit": {
- "enum": [
- "month",
- "quarter",
- "year",
- "Term"
- ],
- "type": "string"
- },
- "include_program_appear_as_customer_private": {
- "type": "boolean"
- },
- "include_program_appear_as_customer_public": {
- "type": "boolean"
- },
- "include_program_case_study": {
- "type": "boolean"
- },
- "include_program_develop_functionality": {
- "type": "boolean"
- },
- "include_program_develop_functionality_val": {
- "type": "string"
- },
- "include_program_discount": {
- "type": "boolean"
- },
- "include_program_discount_amount": {
- "type": "number"
- },
- "include_program_discount_unit": {
- "enum": [
- "U.S. Dollars",
- "percent"
- ],
- "type": "string"
- },
- "include_program_participation_feedback": {
- "type": "boolean"
- },
- "include_program_participation_feedback_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_program_participation_feedback_unit": {
- "enum": [
- "month",
- "quarter",
- "year",
- "Term"
- ],
- "type": "string"
- },
- "include_program_partner_other": {
- "type": "boolean"
- },
- "include_program_partner_other_val": {
- "type": "string"
- },
- "include_program_provider_other": {
- "type": "boolean"
- },
- "include_program_provider_other_val": {
- "type": "string"
- },
- "include_program_reference": {
- "type": "boolean"
- },
- "product_description": {
- "type": "string"
- },
- "term_amount": {
- "type": "number"
- },
- "term_unit": {
- "enum": [
- "day(s)",
- "week(s)",
- "month(s)",
- "quarter(s)",
- "year(s)"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- "district_or_county": {
- "description": "The district or county for dispute resolution.",
- "type": "string"
- },
- "dpa_attributes": {
- "additionalProperties": false,
- "description": "Override dpa terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "approved_subprocessor_type": {
- "description": "`internal` lists approved subprocessors in the agreement (`subprocessors_attributes`); `external` points to a list published elsewhere.",
- "enum": [
- "internal",
- "external"
- ],
- "type": "string"
- },
- "cloud_service_product_name": {
- "type": "string"
- },
- "competent_supervisory_authority": {
- "type": "string"
- },
- "customer_description": {
- "type": "string"
- },
- "data_exporter_address_city": {
- "type": "string"
- },
- "data_exporter_address_country": {
- "type": "string"
- },
- "data_exporter_address_state": {
- "type": "string"
- },
- "data_exporter_address_street_address": {
- "type": "string"
- },
- "data_exporter_address_zipcode": {
- "type": "string"
- },
- "data_exporter_contact_details": {
- "type": "string"
- },
- "data_exporter_contact_name": {
- "type": "string"
- },
- "data_exporter_contact_position": {
- "type": "string"
- },
- "data_exporter_role": {
- "description": "Role of the data exporter. Overwritten to `Controller` when the agreement is created from a template.",
- "enum": [
- "Controller",
- "Processor"
- ],
- "type": "string"
- },
- "data_importer_address": {
- "type": "string"
- },
- "data_importer_address_city": {
- "type": "string"
- },
- "data_importer_address_country": {
- "type": "string"
- },
- "data_importer_address_state": {
- "type": "string"
- },
- "data_importer_address_street_address": {
- "type": "string"
- },
- "data_importer_address_zipcode": {
- "type": "string"
- },
- "data_importer_contact_details": {
- "type": "string"
- },
- "data_importer_contact_name": {
- "type": "string"
- },
- "data_importer_contact_position": {
- "type": "string"
- },
- "duration_of_processing": {
- "type": "string"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_covered_claim": {
- "type": "boolean"
- },
- "include_covered_claim_external_val": {
- "type": "string"
- },
- "include_covered_claim_internal_val": {
- "type": "string"
- },
- "include_covered_claim_type": {
- "description": "Which covered-claim text applies: `internal` uses `include_covered_claim_internal_val`, `external` uses `include_covered_claim_external_val`. Required when `include_covered_claim` is true.",
- "enum": [
- "internal",
- "external"
- ],
- "type": "string"
- },
- "include_data_subjects_custom": {
- "type": "boolean"
- },
- "include_data_subjects_custom_val": {
- "type": "string"
- },
- "include_data_subjects_employees": {
- "type": "boolean"
- },
- "include_data_subjects_end_users": {
- "type": "boolean"
- },
- "include_external_subprocessor_location": {
- "type": "string"
- },
- "include_frequency_of_transfer_continuous": {
- "type": "boolean"
- },
- "include_frequency_of_transfer_custom": {
- "type": "boolean"
- },
- "include_frequency_of_transfer_custom_val": {
- "type": "string"
- },
- "include_governing_country_eu": {
- "type": "boolean"
- },
- "include_governing_country_eu_val": {
- "type": "string"
- },
- "include_governing_country_uk": {
- "type": "boolean"
- },
- "include_governing_country_uk_val": {
- "type": "string"
- },
- "include_governing_law": {
- "type": "boolean"
- },
- "include_governing_law_country": {
- "type": "string"
- },
- "include_governing_law_state": {
- "type": "string"
- },
- "include_increased_claim_amount": {
- "description": "Legacy field. Stored but not shown on the DPA; use the `include_liability_cap*` fields instead.",
- "type": "boolean"
- },
- "include_increased_claim_amount_currency": {
- "description": "Legacy field. Stored but not shown on the DPA; use the `include_liability_cap*` fields instead."
- },
- "include_increased_claim_amount_qty": {
- "description": "Legacy field. Stored but not shown on the DPA; use the `include_liability_cap*` fields instead."
- },
- "include_increased_claim_amount_type": {
- "description": "Legacy field. Stored but not shown on the DPA; use the `include_liability_cap*` fields instead.",
- "type": "string"
- },
- "include_liability_cap": {
- "type": "boolean"
- },
- "include_liability_cap_amount_constant_external": {
- "type": "string"
- },
- "include_liability_cap_amount_constant_internal": {
- "type": "string"
- },
- "include_liability_cap_amount_currency_external": {
- "description": "Currency amount. Numbers and numeric strings (commas allowed) are both accepted."
- },
- "include_liability_cap_amount_currency_internal": {
- "description": "Currency amount. Numbers and numeric strings (commas allowed) are both accepted."
- },
- "include_liability_cap_csa_type": {
- "description": "Which liability cap values apply: the `_internal` or `_external` amount fields. Required when `include_liability_cap` is true.",
- "enum": [
- "internal",
- "external"
- ],
- "type": "string"
- },
- "include_personal_data_biographic_info": {
- "type": "boolean"
- },
- "include_personal_data_contact_info": {
- "type": "boolean"
- },
- "include_personal_data_custom": {
- "type": "boolean"
- },
- "include_personal_data_custom_val": {
- "type": "string"
- },
- "include_personal_data_employment_info": {
- "type": "boolean"
- },
- "include_personal_data_financial_info": {
- "type": "boolean"
- },
- "include_personal_data_location": {
- "type": "boolean"
- },
- "include_personal_data_name": {
- "type": "boolean"
- },
- "include_personal_data_transactional_info": {
- "type": "boolean"
- },
- "include_personal_data_user_activity_info": {
- "type": "boolean"
- },
- "include_processing_purpose_custom": {
- "type": "boolean"
- },
- "include_processing_purpose_custom_val": {
- "type": "string"
- },
- "include_processing_purpose_erasing": {
- "type": "boolean"
- },
- "include_processing_purpose_holding": {
- "type": "boolean"
- },
- "include_processing_purpose_protecting": {
- "type": "boolean"
- },
- "include_processing_purpose_receiving": {
- "type": "boolean"
- },
- "include_processing_purpose_returning": {
- "type": "boolean"
- },
- "include_processing_purpose_sharing": {
- "type": "boolean"
- },
- "include_processing_purpose_updating": {
- "type": "boolean"
- },
- "include_processing_purpose_using": {
- "type": "boolean"
- },
- "include_provider_security_contact_address": {
- "type": "boolean"
- },
- "include_provider_security_contact_address_city": {
- "type": "string"
- },
- "include_provider_security_contact_address_country": {
- "type": "string"
- },
- "include_provider_security_contact_address_state": {
- "type": "string"
- },
- "include_provider_security_contact_address_street_address": {
- "type": "string"
- },
- "include_provider_security_contact_address_zipcode": {
- "type": "string"
- },
- "include_provider_security_contact_email": {
- "type": "boolean"
- },
- "include_provider_security_contact_email_val": {
- "format": "email",
- "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
- "type": "string"
- },
- "include_security_measures_accountability": {
- "type": "boolean"
- },
- "include_security_measures_accountability_val": {
- "type": "string"
- },
- "include_security_measures_certification_or_assurance": {
- "type": "boolean"
- },
- "include_security_measures_certification_or_assurance_val": {
- "type": "string"
- },
- "include_security_measures_confidentiality_integrity": {
- "type": "boolean"
- },
- "include_security_measures_confidentiality_integrity_val": {
- "type": "string"
- },
- "include_security_measures_data_at_rest": {
- "type": "boolean"
- },
- "include_security_measures_data_at_rest_val": {
- "type": "string"
- },
- "include_security_measures_data_minimization": {
- "type": "boolean"
- },
- "include_security_measures_data_minimization_val": {
- "type": "string"
- },
- "include_security_measures_data_quality": {
- "type": "boolean"
- },
- "include_security_measures_data_quality_val": {
- "type": "string"
- },
- "include_security_measures_data_retention": {
- "type": "boolean"
- },
- "include_security_measures_data_retention_val": {
- "type": "string"
- },
- "include_security_measures_data_transmission": {
- "type": "boolean"
- },
- "include_security_measures_data_transmission_val": {
- "type": "string"
- },
- "include_security_measures_event_logging": {
- "type": "boolean"
- },
- "include_security_measures_event_logging_val": {
- "type": "string"
- },
- "include_security_measures_identity_auth": {
- "type": "boolean"
- },
- "include_security_measures_identity_auth_val": {
- "type": "string"
- },
- "include_security_measures_it_security_governance": {
- "type": "boolean"
- },
- "include_security_measures_it_security_governance_val": {
- "type": "string"
- },
- "include_security_measures_physical_security": {
- "type": "boolean"
- },
- "include_security_measures_physical_security_val": {
- "type": "string"
- },
- "include_security_measures_portability_and_erasure": {
- "type": "boolean"
- },
- "include_security_measures_portability_and_erasure_val": {
- "type": "string"
- },
- "include_security_measures_pseudonym_encryption": {
- "type": "boolean"
- },
- "include_security_measures_pseudonym_encryption_val": {
- "type": "string"
- },
- "include_security_measures_restore_data_access": {
- "type": "boolean"
- },
- "include_security_measures_restore_data_access_val": {
- "type": "string"
- },
- "include_security_measures_security_policy": {
- "type": "boolean"
- },
- "include_security_measures_system_configuration": {
- "type": "boolean"
- },
- "include_security_measures_system_configuration_val": {
- "type": "string"
- },
- "include_security_measures_testing_assessment": {
- "type": "boolean"
- },
- "include_security_measures_testing_assessment_val": {
- "type": "string"
- },
- "include_security_policy": {
- "type": "boolean"
- },
- "include_security_policy_fedramp_auth": {
- "type": "boolean"
- },
- "include_security_policy_hipaa": {
- "type": "boolean"
- },
- "include_security_policy_hitrust": {
- "type": "boolean"
- },
- "include_security_policy_include_other": {
- "type": "boolean"
- },
- "include_security_policy_iso27001": {
- "type": "boolean"
- },
- "include_security_policy_other": {
- "type": "string"
- },
- "include_security_policy_pci1": {
- "type": "boolean"
- },
- "include_security_policy_pci2": {
- "type": "boolean"
- },
- "include_security_policy_penetration_testing": {
- "type": "boolean"
- },
- "include_security_policy_soc2": {
- "type": "boolean"
- },
- "include_security_policy_soc2_type2": {
- "type": "boolean"
- },
- "include_sensitive_data_restrictions_custom": {
- "type": "boolean"
- },
- "include_sensitive_data_restrictions_custom_val": {
- "type": "string"
- },
- "include_sensitive_data_restrictions_security_policy": {
- "type": "boolean"
- },
- "include_service_provider_relationship": {
- "type": "boolean"
- },
- "include_special_category_data": {
- "type": "boolean"
- },
- "provider": {
- "type": "string"
- },
- "security_policy_available_at": {
- "type": "string"
- },
- "security_policy_type": {
- "description": "Where the Security Policy is defined. For `external`, set `security_policy_available_at`.",
- "enum": [
- "defined in agreement",
- "provider service",
- "external"
- ],
- "type": "string"
- },
- "subprocessors_attributes": {
- "additionalProperties": {
- "additionalProperties": false,
- "properties": {
- "_destroy": {
- "description": "Set to true with `id` to remove that subprocessor.",
- "type": "boolean"
- },
- "country": {
- "type": "string"
- },
- "id": {
- "description": "ID of an existing subprocessor to update or remove. Omit to add a new subprocessor.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "name": {
- "type": "string"
- },
- "processing_task": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "description": "Subprocessors, keyed by string index such as \"0\", \"1\". On create these are added to the template's subprocessors. On a draft update, an entry without `id` adds a new subprocessor; pass `id` to change one and `id` with `_destroy: true` to remove one.",
- "propertyNames": {
- "type": "string"
- },
- "type": "object"
- },
- "underlying_agreement_id": {
- "description": "ID of the CSA this DPA supplements when `underlying_agreement_type` is `internal`.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "underlying_agreement_type": {
- "description": "`internal` links a CSA in Common Paper (`underlying_agreement_id`); `external` describes another agreement in `underlying_agreement_val` (required). Omit for none.",
- "enum": [
- "internal",
- "external"
- ],
- "type": "string"
- },
- "underlying_agreement_val": {
- "description": "Description of the agreement this DPA supplements. Required when `underlying_agreement_type` is `external`.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "framework_terms_description": {
- "description": "Custom framework terms description. Only used when framework_terms_type is \"description\".",
- "type": "string"
- },
- "framework_terms_type": {
- "description": "How framework terms are specified. Use \"new\" for standard terms or \"description\" to provide a custom framework_terms_description.",
- "enum": [
- "new",
- "description"
- ],
- "type": "string"
- },
- "governing_law_country": {
- "description": "The country whose laws govern the agreement.",
- "type": "string"
- },
- "governing_law_region": {
- "description": "The state or region whose laws govern the agreement.",
- "type": "string"
- },
- "include_automated_payment_reminders": {
- "description": "When true, automatically sends payment reminder emails.",
- "type": "boolean"
- },
- "include_billing_info": {
- "description": "When true, billing contact information (billing_name, billing_email) is included.",
- "type": "boolean"
- },
- "include_billing_workflow": {
- "description": "When true, enables a billing workflow after signing.",
- "type": "boolean"
- },
- "include_expiration_date": {
- "description": "Expiration date in YYYY-MM-DD format. Use when include_expiration_type is \"date\".",
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "include_expiration_days": {
- "description": "Number of days until the agreement expires. Use when include_expiration_type is \"days\".",
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_expiration_type": {
- "description": "How to set expiration: \"none\" (default), \"days\" (use include_expiration_days), or \"date\" (use include_expiration_date).",
- "enum": [
- "none",
- "days",
- "date"
- ],
- "type": "string"
- },
- "include_terms": {
- "description": "When true, the standard terms are included with the agreement.",
- "type": "boolean"
- },
- "loi_attributes": {
- "additionalProperties": false,
- "description": "Override loi terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "confidentiality_custom": {
- "type": "string"
- },
- "confidentiality_mutual_include_loi": {
- "type": "boolean"
- },
- "confidentiality_nda_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "confidentiality_nda_description": {
- "type": "string"
- },
- "confidentiality_nda_include_loi": {
- "type": "boolean"
- },
- "confidentiality_nda_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "confidentiality_type": {
- "enum": [
- "mutual",
- "nda",
- "provider",
- "custom"
- ],
- "type": "string"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_custom_details": {
- "type": "boolean"
- },
- "include_custom_details_val": {
- "type": "string"
- },
- "include_fees": {
- "type": "boolean"
- },
- "include_fees_amount": {
- "type": "number"
- },
- "include_fees_amount_duration": {
- "enum": [
- "month",
- "year",
- "quarter"
- ],
- "type": "string"
- },
- "include_fees_include_amount": {
- "type": "boolean"
- },
- "include_fees_include_other": {
- "type": "boolean"
- },
- "include_fees_other": {
- "type": "string"
- },
- "include_functionality": {
- "type": "boolean"
- },
- "include_functionality_val": {
- "type": "string"
- },
- "include_launch_date": {
- "type": "boolean"
- },
- "include_launch_date_custom": {
- "type": "string"
- },
- "include_launch_date_date": {
- "format": "date-time",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$",
- "type": "string"
- },
- "include_launch_date_type": {
- "enum": [
- "date",
- "custom"
- ],
- "type": "string"
- },
- "product_name": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "manual_send": {
- "description": "When true, the agreement is marked as manually sent outside the platform.",
- "type": "boolean"
- },
- "message": {
- "type": "string"
- },
- "negotiations_allowed": {
- "description": "When true, the recipient can propose changes to the legal terms. For agreement types without separate business terms, that covers every term. CSA order forms, PSA statements of work, partnership business terms and software license order forms have their own `negotiations_allowed` flag.",
- "type": "boolean"
- },
- "partnership_attributes": {
- "additionalProperties": false,
- "description": "Override partnership terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "effective_date": {
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "effective_date_type": {
- "enum": [
- "signature",
- "date"
- ],
- "type": "string"
- },
- "general_cap_amount_currency_val": {
- "type": "number"
- },
- "general_cap_amount_either_currency": {
- "type": "number"
- },
- "general_cap_amount_either_multiple": {
- "type": "number"
- },
- "general_cap_amount_multiple_val": {
- "type": "number"
- },
- "general_cap_amount_type": {
- "enum": [
- "multiple",
- "currency",
- "either",
- "base"
- ],
- "type": "string"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_additional_warranties": {
- "type": "boolean"
- },
- "include_additional_warranties_include_company": {
- "type": "boolean"
- },
- "include_additional_warranties_include_company_val": {
- "type": "string"
- },
- "include_additional_warranties_include_partner": {
- "type": "boolean"
- },
- "include_additional_warranties_include_partner_val": {
- "type": "string"
- },
- "include_brand_guidelines": {
- "type": "boolean"
- },
- "include_brand_guidelines_include_company": {
- "type": "boolean"
- },
- "include_brand_guidelines_include_company_val": {
- "type": "string"
- },
- "include_brand_guidelines_include_partner": {
- "type": "boolean"
- },
- "include_brand_guidelines_include_partner_val": {
- "type": "string"
- },
- "include_covered_claims": {
- "type": "boolean"
- },
- "include_covered_claims_company_claims": {
- "type": "string"
- },
- "include_covered_claims_include_company_claims": {
- "type": "boolean"
- },
- "include_covered_claims_include_partner_claims": {
- "type": "boolean"
- },
- "include_covered_claims_partner_claims": {
- "type": "string"
- },
- "include_dpa": {
- "type": "boolean"
- },
- "include_dpa_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_dpa_location": {
- "type": "string"
- },
- "include_dpa_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_increased_cap_amount": {
- "type": "boolean"
- },
- "include_increased_cap_amount_currency": {
- "type": "number"
- },
- "include_increased_cap_amount_either_currency": {
- "type": "number"
- },
- "include_increased_cap_amount_either_multiple": {
- "type": "string"
- },
- "include_increased_cap_amount_multiple": {
- "type": "string"
- },
- "include_increased_cap_amount_type": {
- "enum": [
- "multiple",
- "currency",
- "either"
- ],
- "type": "string"
- },
- "include_increased_claims": {
- "type": "boolean"
- },
- "include_increased_claims_include_confidentiality": {
- "type": "boolean"
- },
- "include_increased_claims_include_confidentiality_misconduct": {
- "type": "boolean"
- },
- "include_increased_claims_include_covered_claims": {
- "type": "boolean"
- },
- "include_increased_claims_include_misconduct": {
- "type": "boolean"
- },
- "include_increased_claims_include_other": {
- "type": "boolean"
- },
- "include_increased_claims_include_other_val": {
- "type": "string"
- },
- "include_unlimited_claims": {
- "type": "boolean"
- },
- "include_unlimited_claims_confidentiality": {
- "type": "boolean"
- },
- "include_unlimited_claims_confidentiality_misconduct": {
- "type": "boolean"
- },
- "include_unlimited_claims_covered_claims": {
- "type": "boolean"
- },
- "include_unlimited_claims_misconduct": {
- "type": "boolean"
- },
- "include_unlimited_claims_other": {
- "type": "boolean"
- },
- "include_unlimited_claims_other_val": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "partnership_business_terms_attributes": {
- "additionalProperties": false,
- "description": "Override partnership business terms terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "end_date_after_effective_date_amount": {
- "type": "number"
- },
- "end_date_after_effective_date_unit": {
- "enum": [
- "month(s)",
- "quarter(s)",
- "year(s)"
- ],
- "type": "string"
- },
- "end_date_date": {
- "type": "string"
- },
- "end_date_type": {
- "enum": [
- "date",
- "effective date"
- ],
- "type": "string"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_obligations_company_brand": {
- "type": "boolean"
- },
- "include_obligations_company_promotion": {
- "type": "boolean"
- },
- "include_obligations_company_promotion_include_activities": {
- "type": "boolean"
- },
- "include_obligations_company_promotion_include_activities_val": {
- "type": "string"
- },
- "include_obligations_company_promotion_include_materials": {
- "type": "boolean"
- },
- "include_obligations_company_promotion_include_materials_val": {
- "type": "string"
- },
- "include_obligations_company_referral": {
- "type": "boolean"
- },
- "include_obligations_company_referral_include_criteria": {
- "type": "boolean"
- },
- "include_obligations_company_referral_include_criteria_val": {
- "type": "string"
- },
- "include_obligations_company_referral_include_pay_sch": {
- "type": "boolean"
- },
- "include_obligations_company_referral_include_pay_sch_amount": {
- "type": "number"
- },
- "include_obligations_company_referral_include_pay_sch_custom": {
- "type": "string"
- },
- "include_obligations_company_referral_include_pay_sch_unit": {
- "enum": [
- "U.S. Dollars",
- "percent"
- ],
- "type": "string"
- },
- "include_obligations_company_sponsorship": {
- "type": "boolean"
- },
- "include_obligations_company_sponsorship_include_benefits": {
- "type": "boolean"
- },
- "include_obligations_company_sponsorship_include_benefits_val": {
- "type": "string"
- },
- "include_obligations_company_sponsorship_include_payments": {
- "type": "boolean"
- },
- "include_obligations_company_sponsorship_include_payments_amount": {
- "type": "number"
- },
- "include_obligations_company_sponsorship_include_payments_unit": {
- "enum": [
- "U.S. Dollars",
- "percent"
- ],
- "type": "string"
- },
- "include_obligations_partner_brand": {
- "type": "boolean"
- },
- "include_obligations_partner_promotion": {
- "type": "boolean"
- },
- "include_obligations_partner_promotion_include_activities": {
- "type": "boolean"
- },
- "include_obligations_partner_promotion_include_activities_val": {
- "type": "string"
- },
- "include_obligations_partner_promotion_include_materials": {
- "type": "boolean"
- },
- "include_obligations_partner_promotion_include_materials_val": {
- "type": "string"
- },
- "include_obligations_partner_referral": {
- "type": "boolean"
- },
- "include_obligations_partner_referral_include_criteria": {
- "type": "boolean"
- },
- "include_obligations_partner_referral_include_criteria_val": {
- "type": "string"
- },
- "include_obligations_partner_referral_include_pay_sch": {
- "type": "boolean"
- },
- "include_obligations_partner_referral_include_pay_sch_amount": {
- "type": "number"
- },
- "include_obligations_partner_referral_include_pay_sch_custom": {
- "type": "string"
- },
- "include_obligations_partner_referral_include_pay_sch_unit": {
- "enum": [
- "U.S. Dollars",
- "percent"
- ],
- "type": "string"
- },
- "include_obligations_partner_sponsorship": {
- "type": "boolean"
- },
- "include_obligations_partner_sponsorship_include_benefits": {
- "type": "boolean"
- },
- "include_obligations_partner_sponsorship_include_benefits_val": {
- "type": "string"
- },
- "include_obligations_partner_sponsorship_include_payments": {
- "type": "boolean"
- },
- "include_obligations_partner_sponsorship_include_payments_amount": {
- "type": "number"
- },
- "include_obligations_partner_sponsorship_include_payments_unit": {
- "enum": [
- "U.S. Dollars",
- "percent"
- ],
- "type": "string"
- },
- "include_payment_process": {
- "type": "boolean"
- },
- "include_payment_process_company": {
- "type": "boolean"
- },
- "include_payment_process_company_include_address": {
- "type": "boolean"
- },
- "include_payment_process_company_include_address_city": {
- "type": "string"
- },
- "include_payment_process_company_include_address_country": {
- "type": "string"
- },
- "include_payment_process_company_include_address_state": {
- "type": "string"
- },
- "include_payment_process_company_include_address_street_address": {
- "type": "string"
- },
- "include_payment_process_company_include_address_zipcode": {
- "type": "string"
- },
- "include_payment_process_company_include_email": {
- "type": "boolean"
- },
- "include_payment_process_company_include_email_val": {
- "type": "string"
- },
- "include_payment_process_partner": {
- "type": "boolean"
- },
- "include_payment_process_partner_include_address": {
- "type": "boolean"
- },
- "include_payment_process_partner_include_address_city": {
- "type": "string"
- },
- "include_payment_process_partner_include_address_country": {
- "type": "string"
- },
- "include_payment_process_partner_include_address_state": {
- "type": "string"
- },
- "include_payment_process_partner_include_address_street_address": {
- "type": "string"
- },
- "include_payment_process_partner_include_address_zipcode": {
- "type": "string"
- },
- "include_payment_process_partner_include_email": {
- "type": "boolean"
- },
- "include_payment_process_partner_include_email_val": {
- "type": "string"
- },
- "include_payment_schedule": {
- "type": "boolean"
- },
- "include_payment_schedule_custom": {
- "type": "string"
- },
- "include_payment_schedule_specified_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_payment_schedule_specified_timeframe": {
- "enum": [
- "receipt",
- "date"
- ],
- "type": "string"
- },
- "include_payment_schedule_specified_unit": {
- "enum": [
- "day(s)",
- "week(s)",
- "month(s)",
- "quarter(s)",
- "year(s)"
- ],
- "type": "string"
- },
- "include_payment_schedule_type": {
- "enum": [
- "specified",
- "custom"
- ],
- "type": "string"
- },
- "negotiations_allowed": {
- "description": "When true, the recipient can propose changes to the business terms, even when the agreement-level `negotiations_allowed` is false. This only covers the business terms.",
- "type": "boolean"
- },
- "territory_type": {
- "enum": [
- "worldwide",
- "custom"
- ],
- "type": "string"
- },
- "territory_type_val": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "payment_link_url": {
- "description": "A payment URL shown to the recipient after signing. Requires include_billing_workflow to be true and billing_workflow_type to be \"link\".",
- "type": "string"
- },
- "pilot_attributes": {
- "additionalProperties": false,
- "description": "Override pilot terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "fees_type": {
- "enum": [
- "free",
- "pilot_period_fees"
- ],
- "type": "string"
- },
- "general_cap_amount": {
- "type": "number"
- },
- "general_cap_amount_type": {
- "enum": [
- "preceding",
- "base",
- "period"
- ],
- "type": "string"
- },
- "general_cap_period_currency": {
- "type": "number"
- },
- "general_cap_period_qty": {
- "type": "number"
- },
- "general_cap_preceding_amount": {
- "type": "number"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_dpa": {
- "type": "boolean"
- },
- "include_dpa_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_dpa_location": {
- "type": "string"
- },
- "include_dpa_type": {
- "enum": [
- "description",
- "attachment",
- "standard"
- ],
- "type": "string"
- },
- "include_payment_process": {
- "type": "boolean"
- },
- "include_technical_support": {
- "type": "boolean"
- },
- "payment_process_automatic_frequency": {
- "enum": [
- "monthly",
- "quarterly",
- "annually",
- "once_per_period"
- ],
- "type": "string"
- },
- "payment_process_invoice_days": {
- "type": "number"
- },
- "payment_process_invoice_from": {
- "enum": [
- "receipt",
- "date"
- ],
- "type": "string"
- },
- "payment_process_invoice_timeframe": {
- "enum": [
- "days",
- "weeks",
- "months",
- "quarters",
- "years"
- ],
- "type": "string"
- },
- "payment_process_type": {
- "enum": [
- "automatic",
- "invoice"
- ],
- "type": "string"
- },
- "pilot_period_description": {
- "type": "string"
- },
- "pilot_period_fees_description": {
- "type": "string"
- },
- "product_description": {
- "type": "string"
- },
- "technical_support_description": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "psa_attributes": {
- "additionalProperties": false,
- "description": "Override psa terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "additional_changes": {
- "type": "string"
- },
- "customer_description": {
- "type": "string"
- },
- "effective_date": {
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "effective_date_type": {
- "enum": [
- "signature",
- "date"
- ],
- "type": "string"
- },
- "general_cap_amount": {
- "type": "number"
- },
- "general_cap_amount_type": {
- "enum": [
- "preceding",
- "base",
- "period"
- ],
- "type": "string"
- },
- "general_cap_period_currency": {
- "type": "number"
- },
- "general_cap_period_qty": {
- "type": "number"
- },
- "general_cap_preceding_amount": {
- "type": "number"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_additional_changes": {
- "type": "boolean"
- },
- "include_additional_warranties": {
- "type": "boolean"
- },
- "include_additional_warranties_by_customer": {
- "type": "string"
- },
- "include_additional_warranties_by_provider": {
- "type": "string"
- },
- "include_additional_warranties_include_by_customer": {
- "type": "boolean"
- },
- "include_additional_warranties_include_by_provider": {
- "type": "boolean"
- },
- "include_covered_claims": {
- "type": "boolean"
- },
- "include_covered_claims_customer_claims": {
- "type": "string"
- },
- "include_covered_claims_include_customer_claims": {
- "type": "boolean"
- },
- "include_covered_claims_include_provider_claims": {
- "type": "boolean"
- },
- "include_covered_claims_provider_claims": {
- "type": "string"
- },
- "include_customer_insurance_min": {
- "type": "boolean"
- },
- "include_customer_insurance_min_add_provider_com_gen_liability": {
- "type": "boolean"
- },
- "include_customer_insurance_min_add_provider_cyber_liability": {
- "type": "boolean"
- },
- "include_customer_insurance_min_add_provider_errors_omissions": {
- "type": "boolean"
- },
- "include_customer_insurance_min_auto_liability_aggregate": {
- "type": "number"
- },
- "include_customer_insurance_min_auto_liability_minimum": {
- "type": "number"
- },
- "include_customer_insurance_min_cyber_liability_aggregate": {
- "type": "number"
- },
- "include_customer_insurance_min_cyber_liability_minimum": {
- "type": "number"
- },
- "include_customer_insurance_min_employer_liability_aggregate": {
- "type": "number"
- },
- "include_customer_insurance_min_employer_liability_minimum": {
- "type": "number"
- },
- "include_customer_insurance_min_general_liability_aggregate": {
- "type": "number"
- },
- "include_customer_insurance_min_general_liability_minimum": {
- "type": "number"
- },
- "include_customer_insurance_min_include_add_provider": {
- "type": "boolean"
- },
- "include_customer_insurance_min_include_auto_liability": {
- "type": "boolean"
- },
- "include_customer_insurance_min_include_cyber_liability": {
- "type": "boolean"
- },
- "include_customer_insurance_min_include_employer_liability": {
- "type": "boolean"
- },
- "include_customer_insurance_min_include_general_liability": {
- "type": "boolean"
- },
- "include_customer_insurance_min_include_workers_comp": {
- "type": "boolean"
- },
- "include_customer_policies": {
- "type": "boolean"
- },
- "include_customer_policies_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_customer_policies_location": {
- "type": "string"
- },
- "include_customer_policies_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_dpa": {
- "type": "boolean"
- },
- "include_dpa_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_dpa_location": {
- "type": "string"
- },
- "include_dpa_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_increased_cap_amount": {
- "type": "boolean"
- },
- "include_increased_claims": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_confidentiality": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_confidentiality_negligence": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_privsec": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_privsec_negligence": {
- "type": "boolean"
- },
- "include_increased_claims_include_other": {
- "type": "boolean"
- },
- "include_increased_claims_indemnification_obligation": {
- "type": "boolean"
- },
- "include_increased_claims_negligence": {
- "type": "boolean"
- },
- "include_increased_claims_other": {
- "type": "string"
- },
- "include_provider_insurance_min": {
- "type": "boolean"
- },
- "include_provider_insurance_min_add_customer_com_gen_liability": {
- "type": "boolean"
- },
- "include_provider_insurance_min_add_customer_cyber_liability": {
- "type": "boolean"
- },
- "include_provider_insurance_min_add_customer_errors_omissions": {
- "type": "boolean"
- },
- "include_provider_insurance_min_auto_liability_aggregate": {
- "type": "number"
- },
- "include_provider_insurance_min_auto_liability_minimum": {
- "type": "number"
- },
- "include_provider_insurance_min_cyber_liability_aggregate": {
- "type": "number"
- },
- "include_provider_insurance_min_cyber_liability_minimum": {
- "type": "number"
- },
- "include_provider_insurance_min_employer_liability_aggregate": {
- "type": "number"
- },
- "include_provider_insurance_min_employer_liability_minimum": {
- "type": "number"
- },
- "include_provider_insurance_min_general_liability_aggregate": {
- "type": "number"
- },
- "include_provider_insurance_min_general_liability_minimum": {
- "type": "number"
- },
- "include_provider_insurance_min_include_add_customer": {
- "type": "boolean"
- },
- "include_provider_insurance_min_include_auto_liability": {
- "type": "boolean"
- },
- "include_provider_insurance_min_include_cyber_liability": {
- "type": "boolean"
- },
- "include_provider_insurance_min_include_employer_liability": {
- "type": "boolean"
- },
- "include_provider_insurance_min_include_general_liability": {
- "type": "boolean"
- },
- "include_provider_insurance_min_include_workers_comp": {
- "type": "boolean"
- },
- "include_publicity_rights": {
- "type": "boolean"
- },
- "include_publicity_rights_type": {
- "enum": [
- "public",
- "non-public"
- ],
- "type": "string"
- },
- "include_security_policy": {
- "type": "boolean"
- },
- "include_security_policy_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_security_policy_fedramp_auth": {
- "type": "boolean"
- },
- "include_security_policy_hitrust": {
- "type": "boolean"
- },
- "include_security_policy_include_annual_maintenance": {
- "type": "boolean"
- },
- "include_security_policy_include_other": {
- "type": "boolean"
- },
- "include_security_policy_include_other_val": {
- "type": "string"
- },
- "include_security_policy_iso27001": {
- "type": "boolean"
- },
- "include_security_policy_location": {
- "type": "string"
- },
- "include_security_policy_pci1": {
- "type": "boolean"
- },
- "include_security_policy_pci2": {
- "type": "boolean"
- },
- "include_security_policy_penetration_testing": {
- "type": "boolean"
- },
- "include_security_policy_soc2_type1": {
- "type": "boolean"
- },
- "include_security_policy_soc2_type2": {
- "type": "boolean"
- },
- "include_security_policy_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_unlimited_claims": {
- "type": "boolean"
- },
- "include_unlimited_claims_breach_of_confidentiality": {
- "type": "boolean"
- },
- "include_unlimited_claims_breach_of_confidentiality_negligence": {
- "type": "boolean"
- },
- "include_unlimited_claims_breach_of_privsec": {
- "type": "boolean"
- },
- "include_unlimited_claims_breach_of_privsec_negligence": {
- "type": "boolean"
- },
- "include_unlimited_claims_include_other": {
- "type": "boolean"
- },
- "include_unlimited_claims_indemnification_obligation": {
- "type": "boolean"
- },
- "include_unlimited_claims_negligence": {
- "type": "boolean"
- },
- "include_unlimited_claims_other": {
- "type": "string"
- },
- "increased_cap_amount_currency": {
- "type": "number"
- },
- "increased_cap_amount_period_currency": {
- "type": "number"
- },
- "increased_cap_amount_period_qty": {
- "type": "number"
- },
- "increased_cap_amount_qty": {
- "type": "number"
- },
- "increased_cap_amount_type": {
- "enum": [
- "qty",
- "currency",
- "period"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- "psa_statement_of_work_attributes": {
- "additionalProperties": false,
- "description": "Override psa statement of work terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "additional_changes": {
- "type": "string"
- },
- "cost": {
- "type": "number"
- },
- "description": {
- "type": "string"
- },
- "fee_type": {
- "type": "string"
- },
- "fees_attributes": {
- "additionalProperties": {
- "anyOf": [
- {
- "additionalProperties": false,
- "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": "string"
- },
- "include_deliverables": {
- "type": "boolean"
- },
- "include_deliverables_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_deliverables_description": {
- "type": "string"
- },
- "include_deliverables_include_acceptance": {
- "type": "boolean"
- },
- "include_deliverables_include_attachment": {
- "type": "boolean"
- },
- "include_deliverables_include_draft_deliverables": {
- "type": "boolean"
- },
- "include_deliverables_rejection_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_deliverables_rejection_unit": {
- "enum": [
- "hours",
- "days",
- "weeks",
- "months"
- ],
- "type": "string"
- },
- "include_deliverables_resubmission_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_deliverables_resubmission_unit": {
- "enum": [
- "hours",
- "days",
- "weeks",
- "months"
- ],
- "type": "string"
- },
- "include_fees_other": {
- "type": "boolean"
- },
- "include_fees_other_val": {
- "type": "string"
- },
- "include_fees_table": {
- "type": "boolean"
- },
- "include_fees_table_total": {
- "type": "boolean"
- },
- "include_fees_travel": {
- "type": "boolean"
- },
- "include_fees_travel_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_fees_travel_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_fees_travel_val": {
- "type": "string"
- },
- "include_third_party_customer": {
- "type": "boolean"
- },
- "include_third_party_include_description": {
- "type": "boolean"
- },
- "include_third_party_include_description_val": {
- "type": "string"
- },
- "include_third_party_materials": {
- "type": "boolean"
- },
- "include_third_party_provider": {
- "type": "boolean"
- },
- "include_time_of_assignment": {
- "type": "boolean"
- },
- "include_time_of_assignment_type": {
- "enum": [
- "created",
- "paid"
- ],
- "type": "string"
- },
- "invoice_period_description": {
- "type": "string"
- },
- "negotiations_allowed": {
- "description": "When true, the recipient can propose changes to the statement of work, even when the agreement-level `negotiations_allowed` is false. This only covers the statement of work.",
- "type": "boolean"
- },
- "payment_period": {
- "type": "number"
- },
- "payment_period_other": {
- "type": "string"
- },
- "payment_period_timeframe": {
- "enum": [
- "receipt",
- "invoice",
- "Customer's receipt of invoice",
- "date of invoice"
- ],
- "type": "string"
- },
- "payment_period_type": {
- "enum": [
- "standard",
- "other"
- ],
- "type": "string"
- },
- "payment_period_unit": {
- "enum": [
- "day(s)",
- "week(s)",
- "month(s)",
- "quarter(s)",
- "year(s)"
- ],
- "type": "string"
- },
- "quantity": {
- "type": "number"
- },
- "services_description": {
- "type": "string"
- },
- "sow_date": {
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "sow_date_type": {
- "enum": [
- "signature",
- "date"
- ],
- "type": "string"
- },
- "sow_term_amount": {
- "type": "number"
- },
- "sow_term_date": {
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "sow_term_type": {
- "enum": [
- "deliverables",
- "period",
- "date"
- ],
- "type": "string"
- },
- "sow_term_unit": {
- "enum": [
- "month(s)",
- "quarter(s)",
- "year(s)"
- ],
- "type": "string"
- },
- "type": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "recipient_email": {
- "format": "email",
- "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-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_last_to_sign": {
- "description": "When true, your signer signs after the recipient.",
- "type": "boolean"
- },
- "sender_notice_email_address": {
- "description": "Email address for legal notices to the sender.",
- "format": "email",
- "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-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": {
- "enum": [
- "signature",
- "date"
- ],
- "type": "string"
- },
- "general_cap_amount": {
- "type": "number"
- },
- "general_cap_amount_type": {
- "enum": [
- "preceding",
- "base",
- "period"
- ],
- "type": "string"
- },
- "general_cap_period_currency": {
- "type": "number"
- },
- "general_cap_period_qty": {
- "type": "number"
- },
- "general_cap_preceding_amount": {
- "type": "number"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_additional_warranties": {
- "type": "boolean"
- },
- "include_additional_warranties_by_customer": {
- "type": "string"
- },
- "include_additional_warranties_by_provider": {
- "type": "string"
- },
- "include_additional_warranties_include_by_customer": {
- "type": "boolean"
- },
- "include_additional_warranties_include_by_provider": {
- "type": "boolean"
- },
- "include_ai_addendum": {
- "type": "boolean"
- },
- "include_ai_addendum_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_covered_claims": {
- "type": "boolean"
- },
- "include_covered_claims_customer_claims": {
- "type": "string"
- },
- "include_covered_claims_include_customer_claims": {
- "type": "boolean"
- },
- "include_covered_claims_include_provider_claims": {
- "type": "boolean"
- },
- "include_covered_claims_provider_claims": {
- "type": "string"
- },
- "include_dpa": {
- "type": "boolean"
- },
- "include_dpa_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_dpa_location": {
- "type": "string"
- },
- "include_dpa_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_increased_cap_amount": {
- "type": "boolean"
- },
- "include_increased_claims": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_confidentiality": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_confidentiality_negligence": {
- "type": "boolean"
- },
- "include_increased_claims_include_other": {
- "type": "boolean"
- },
- "include_increased_claims_indemnification_obligation": {
- "type": "boolean"
- },
- "include_increased_claims_negligence": {
- "type": "boolean"
- },
- "include_increased_claims_other": {
- "type": "string"
- },
- "include_increased_claims_restrictions": {
- "type": "boolean"
- },
- "include_unlimited_claims": {
- "type": "boolean"
- },
- "include_unlimited_claims_breach_of_confidentiality": {
- "type": "boolean"
- },
- "include_unlimited_claims_breach_of_confidentiality_negligence": {
- "type": "boolean"
- },
- "include_unlimited_claims_include_other": {
- "type": "boolean"
- },
- "include_unlimited_claims_indemnification_obligation": {
- "type": "boolean"
- },
- "include_unlimited_claims_license_or_restrictions": {
- "type": "boolean"
- },
- "include_unlimited_claims_negligence": {
- "type": "boolean"
- },
- "include_unlimited_claims_other": {
- "type": "string"
- },
- "increased_cap_amount_currency": {
- "type": "number"
- },
- "increased_cap_amount_period_currency": {
- "type": "number"
- },
- "increased_cap_amount_period_qty": {
- "type": "number"
- },
- "increased_cap_amount_qty": {
- "type": "number"
- },
- "increased_cap_amount_type": {
- "enum": [
- "qty",
- "currency",
- "period"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- "software_license_order_form_attributes": {
- "additionalProperties": false,
- "description": "Override software license order form terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "additional_changes": {
- "type": "string"
- },
- "deletion_procedure_include_custom": {
- "type": "boolean"
- },
- "deletion_procedure_include_custom_description": {
- "type": "string"
- },
- "deletion_procedure_include_customer_disable": {
- "type": "boolean"
- },
- "deletion_procedure_include_customer_proof": {
- "type": "boolean"
- },
- "deletion_procedure_include_provider_disable": {
- "type": "boolean"
- },
- "fee_custom_unit": {
- "type": "string"
- },
- "fee_period": {
- "enum": [
- "Subscription Period",
- "month",
- "year",
- "Custom unit"
- ],
- "type": "string"
- },
- "fees_attributes": {
- "additionalProperties": {
- "anyOf": [
- {
- "additionalProperties": false,
- "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": {
- "enum": [
- "USD",
- "EUR",
- "GBP",
- "CAD",
- "AUD",
- "SGD",
- "ILS",
- "JPY",
- "CHF",
- "HKD"
- ],
- "type": "string"
- },
- "fees_include_fee_increase_upon_renewal": {
- "type": "boolean"
- },
- "fees_include_fee_increase_upon_renewal_fee": {
- "type": "number"
- },
- "fees_include_fee_increase_upon_renewal_type": {
- "enum": [
- "will",
- "may"
- ],
- "type": "string"
- },
- "fees_inclusive_of_taxes": {
- "type": "boolean"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_additional_changes": {
- "type": "boolean"
- },
- "include_license_compliance_verification": {
- "type": "boolean"
- },
- "include_license_compliance_verification_description": {
- "type": "string"
- },
- "include_license_limits": {
- "type": "boolean"
- },
- "include_license_limits_description": {
- "type": "string"
- },
- "include_payment_process_include_billing_email": {
- "type": "boolean"
- },
- "include_pilot_period": {
- "type": "boolean"
- },
- "include_pilot_period_duration_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_pilot_period_duration_type": {
- "enum": [
- "day",
- "week",
- "month"
- ],
- "type": "string"
- },
- "include_pilot_period_include_fees": {
- "type": "boolean"
- },
- "include_pilot_period_include_fees_amount": {
- "type": "number"
- },
- "include_pilot_period_include_modifications": {
- "type": "boolean"
- },
- "include_pilot_period_include_modifications_description": {
- "type": "string"
- },
- "include_services": {
- "type": "boolean"
- },
- "include_services_description": {
- "type": "string"
- },
- "negotiations_allowed": {
- "description": "When true, the recipient can propose changes to the order form, even when the agreement-level `negotiations_allowed` is false. This only covers the order form.",
- "type": "boolean"
- },
- "order_date_date": {
- "type": "string"
- },
- "order_date_type": {
- "enum": [
- "signature",
- "date",
- "other"
- ],
- "type": "string"
- },
- "payment_process_automatic_frequency": {
- "enum": [
- "monthly",
- "quarterly",
- "semiannually",
- "annually"
- ],
- "type": "string"
- },
- "payment_process_type": {
- "enum": [
- "automatic",
- "invoice",
- "custom"
- ],
- "type": "string"
- },
- "payment_process_type_custom_val": {
- "type": "string"
- },
- "payment_process_type_invoice_amount": {
- "type": "number"
- },
- "payment_process_type_invoice_custom_unit": {
- "type": "string"
- },
- "payment_process_type_invoice_duration": {
- "enum": [
- "day",
- "week",
- "month",
- "year",
- "day(s)",
- "week(s)",
- "month(s)",
- "year(s)"
- ],
- "type": "string"
- },
- "payment_process_type_invoice_duration_start": {
- "enum": [
- "Customer's receipt of invoice",
- "date of invoice"
- ],
- "type": "string"
- },
- "payment_process_type_invoice_type": {
- "enum": [
- "monthly",
- "quarterly",
- "semiannually",
- "annually",
- "Custom unit"
- ],
- "type": "string"
- },
- "permitted_uses_include_custom": {
- "type": "boolean"
- },
- "permitted_uses_include_custom_description": {
- "type": "string"
- },
- "permitted_uses_include_customers_affiliates": {
- "type": "boolean"
- },
- "permitted_uses_include_internal_business": {
- "type": "boolean"
- },
- "pilot_period_stripe_product_id": {
- "type": "string"
- },
- "software_description": {
- "type": "string"
- },
- "subscription_auto_renew": {
- "enum": [
- "days",
- "subscription_end"
- ],
- "type": "string"
- },
- "subscription_period": {
- "type": "number"
- },
- "subscription_period_unit": {
- "type": "string"
- },
- "subscription_renewal_notice_days": {
- "type": "number"
- },
- "warranty_period_description_amount": {
- "type": "number"
- },
- "warranty_period_description_duration": {
- "enum": [
- "day",
- "week",
- "month",
- "year"
- ],
- "type": "string"
- },
- "warranty_period_description_duration_start": {
- "enum": [
- "initial delivery of the Software",
- "delivery of the Software and each subsequent Update",
- "the Order Date"
- ],
- "type": "string"
- },
- "warranty_period_type": {
- "enum": [
- "description",
- "none"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- "test_agreement": {
- "description": "When true, marks the agreement as a test. Test agreements do not count against your monthly limit.",
- "type": "boolean"
- }
- },
- "required": [
- "recipient_name",
- "recipient_email"
- ],
- "type": "object"
- },
- "cc_users": {
- "items": {
- "format": "email",
- "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-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": {
- "enum": [
- "signature",
- "date"
- ],
- "type": "string"
- },
- "framework_terms_type": {
- "type": "string"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "parent_agreement_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "underlying_agreement_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "underlying_agreement_type": {
- "type": "string"
- },
- "underlying_agreement_val": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "baa_attributes": {
- "additionalProperties": false,
- "description": "Override baa terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "aggregation_limitations_permitted": {
- "type": "boolean"
- },
- "aggregation_limitations_permitted_val": {
- "type": "string"
- },
- "breach_notification_unit": {
- "enum": [
- "hours",
- "business days",
- "calendar days"
- ],
- "type": "string"
- },
- "breach_notification_val": {
- "type": "number"
- },
- "business_associate_relationship_type": {
- "enum": [
- "provider",
- "company"
- ],
- "type": "string"
- },
- "deidentification_limitations_include_purpose": {
- "type": "boolean"
- },
- "deidentification_limitations_include_requirements": {
- "type": "boolean"
- },
- "deidentification_limitations_permitted": {
- "type": "boolean"
- },
- "deidentification_limitations_purpose_val": {
- "type": "string"
- },
- "deidentification_limitations_requirements_val": {
- "type": "string"
- },
- "designated_record_set_provider_maintains": {
- "type": "boolean"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_aggregation_limitations": {
- "type": "boolean"
- },
- "include_deidentification_limitations": {
- "type": "boolean"
- },
- "include_limitations": {
- "type": "boolean"
- },
- "include_offshore_limitations": {
- "type": "boolean"
- },
- "include_subcontract_limitations": {
- "type": "boolean"
- },
- "offshore_limitations_permitted": {
- "type": "boolean"
- },
- "offshore_limitations_permitted_val": {
- "type": "string"
- },
- "subcontract_limitations_include_notice": {
- "type": "boolean"
- },
- "subcontract_limitations_include_permission": {
- "type": "boolean"
- },
- "subcontract_limitations_notice_val": {
- "type": "string"
- },
- "subcontract_limitations_permission_val": {
- "type": "string"
- },
- "subcontract_limitations_permitted": {
- "type": "boolean"
- },
- "underlying_agreement_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "underlying_agreement_type": {
- "enum": [
- "internal",
- "external",
- "none"
- ],
- "type": "string"
- },
- "underlying_agreement_val": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "billing_email": {
- "description": "Email of the billing contact. Used when include_billing_info is true.",
- "format": "email",
- "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
- "type": "string"
- },
- "billing_name": {
- "description": "Name of the billing contact. Used when include_billing_info is true.",
- "type": "string"
- },
- "billing_workflow_type": {
- "description": "The type of billing workflow. Use \"link\" to provide a payment_link_url, or \"stripe\" for Stripe-managed billing.",
- "enum": [
- "link",
- "stripe"
- ],
- "type": "string"
- },
- "chosen_courts_country": {
- "description": "The country in which disputes will be resolved.",
- "type": "string"
- },
- "chosen_courts_region": {
- "description": "The state or region in which disputes will be resolved.",
- "type": "string"
- },
- "csa_attributes": {
- "additionalProperties": false,
- "description": "Override csa terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "customer_description": {
- "type": "string"
- },
- "effective_date": {
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "effective_date_marketplace": {
- "enum": [
- "AWS",
- "GCP",
- "Azure"
- ],
- "type": "string"
- },
- "effective_date_type": {
- "enum": [
- "signature",
- "date",
- "marketplace_acceptance"
- ],
- "type": "string"
- },
- "general_cap_amount": {
- "type": "number"
- },
- "general_cap_amount_type": {
- "enum": [
- "preceding",
- "base",
- "period"
- ],
- "type": "string"
- },
- "general_cap_period_currency": {
- "type": "number"
- },
- "general_cap_period_qty": {
- "type": "number"
- },
- "general_cap_preceding_amount": {
- "type": "number"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_acceptable_use_policy": {
- "type": "boolean"
- },
- "include_acceptable_use_policy_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_acceptable_use_policy_location": {
- "type": "string"
- },
- "include_acceptable_use_policy_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_additional_warranties": {
- "type": "boolean"
- },
- "include_additional_warranties_by_customer": {
- "type": "string"
- },
- "include_additional_warranties_by_provider": {
- "type": "string"
- },
- "include_additional_warranties_include_by_customer": {
- "type": "boolean"
- },
- "include_additional_warranties_include_by_provider": {
- "type": "boolean"
- },
- "include_ai_addendum": {
- "type": "boolean"
- },
- "include_ai_addendum_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_covered_claims": {
- "type": "boolean"
- },
- "include_covered_claims_customer_claims": {
- "type": "string"
- },
- "include_covered_claims_include_customer_claims": {
- "type": "boolean"
- },
- "include_covered_claims_include_provider_claims": {
- "type": "boolean"
- },
- "include_covered_claims_provider_claims": {
- "type": "string"
- },
- "include_dpa": {
- "type": "boolean"
- },
- "include_dpa_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_dpa_location": {
- "type": "string"
- },
- "include_dpa_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_increased_cap_amount": {
- "type": "boolean"
- },
- "include_increased_claims": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_confidentiality": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_confidentiality_negligence": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_privsec": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_privsec_negligence": {
- "type": "boolean"
- },
- "include_increased_claims_include_other": {
- "type": "boolean"
- },
- "include_increased_claims_indemnification_obligation": {
- "type": "boolean"
- },
- "include_increased_claims_other": {
- "type": "string"
- },
- "include_insurance_minimums": {
- "type": "boolean"
- },
- "include_insurance_minimums_add_customer": {
- "type": "boolean"
- },
- "include_insurance_minimums_add_customer_com_gen_liability": {
- "type": "boolean"
- },
- "include_insurance_minimums_add_customer_cyber_liability": {
- "type": "boolean"
- },
- "include_insurance_minimums_add_customer_errors_omissions": {
- "type": "boolean"
- },
- "include_insurance_minimums_additional_information": {
- "type": "boolean"
- },
- "include_insurance_minimums_additional_information_text": {
- "type": "string"
- },
- "include_insurance_minimums_cyber_liability_aggregate": {
- "type": "number"
- },
- "include_insurance_minimums_cyber_liability_minimum": {
- "type": "number"
- },
- "include_insurance_minimums_employer_liability_aggregate": {
- "type": "number"
- },
- "include_insurance_minimums_employer_liability_minimum": {
- "type": "number"
- },
- "include_insurance_minimums_general_liability_aggregate": {
- "type": "number"
- },
- "include_insurance_minimums_general_liability_minimum": {
- "type": "number"
- },
- "include_insurance_minimums_include_cyber_liability": {
- "type": "boolean"
- },
- "include_insurance_minimums_include_employer_liability": {
- "type": "boolean"
- },
- "include_insurance_minimums_include_general_liability": {
- "type": "boolean"
- },
- "include_insurance_minimums_include_workers_compensation": {
- "type": "boolean"
- },
- "include_publicity_rights": {
- "type": "boolean"
- },
- "include_publicity_rights_type": {
- "enum": [
- "public",
- "non-public"
- ],
- "type": "string"
- },
- "include_security_policy": {
- "type": "boolean"
- },
- "include_security_policy_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_security_policy_fedramp_auth": {
- "type": "boolean"
- },
- "include_security_policy_hipaa": {
- "type": "boolean"
- },
- "include_security_policy_hitrust": {
- "type": "boolean"
- },
- "include_security_policy_include_annual_maintenance": {
- "type": "boolean"
- },
- "include_security_policy_include_location": {
- "type": "boolean"
- },
- "include_security_policy_include_other": {
- "type": "boolean"
- },
- "include_security_policy_include_reasonable_efforts": {
- "type": "boolean"
- },
- "include_security_policy_iso27001": {
- "type": "boolean"
- },
- "include_security_policy_location": {
- "type": "string"
- },
- "include_security_policy_other": {
- "type": "string"
- },
- "include_security_policy_pci1": {
- "type": "boolean"
- },
- "include_security_policy_pci2": {
- "type": "boolean"
- },
- "include_security_policy_penetration_testing": {
- "type": "boolean"
- },
- "include_security_policy_soc2": {
- "type": "boolean"
- },
- "include_security_policy_soc2_type2": {
- "type": "boolean"
- },
- "include_security_policy_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_supercap": {
- "description": "CSA 3.0 renamed `include_increased_cap_amount` to `include_supercap`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_increased_cap_amount`. Sending the other spelling returns a 422.",
- "type": "boolean"
- },
- "include_uncapped_claims": {
- "description": "CSA 3.0 renamed `include_unlimited_claims` to `include_uncapped_claims`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims`. Sending the other spelling returns a 422.",
- "type": "boolean"
- },
- "include_uncapped_claims_breach_of_confidentiality": {
- "description": "CSA 3.0 renamed `include_unlimited_claims_breach_of_confidentiality` to `include_uncapped_claims_breach_of_confidentiality`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_breach_of_confidentiality`. Sending the other spelling returns a 422.",
- "type": "boolean"
- },
- "include_uncapped_claims_breach_of_confidentiality_negligence": {
- "description": "CSA 3.0 renamed `include_unlimited_claims_breach_of_confidentiality_negligence` to `include_uncapped_claims_breach_of_confidentiality_negligence`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_breach_of_confidentiality_negligence`. Sending the other spelling returns a 422.",
- "type": "boolean"
- },
- "include_uncapped_claims_breach_of_privsec": {
- "description": "CSA 3.0 renamed `include_unlimited_claims_breach_of_privsec` to `include_uncapped_claims_breach_of_privsec`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_breach_of_privsec`. Sending the other spelling returns a 422.",
- "type": "boolean"
- },
- "include_uncapped_claims_breach_of_privsec_negligence": {
- "description": "CSA 3.0 renamed `include_unlimited_claims_breach_of_privsec_negligence` to `include_uncapped_claims_breach_of_privsec_negligence`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_breach_of_privsec_negligence`. Sending the other spelling returns a 422.",
- "type": "boolean"
- },
- "include_uncapped_claims_include_other": {
- "description": "CSA 3.0 renamed `include_unlimited_claims_include_other` to `include_uncapped_claims_include_other`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_include_other`. Sending the other spelling returns a 422.",
- "type": "boolean"
- },
- "include_uncapped_claims_indemnification_obligation": {
- "description": "CSA 3.0 renamed `include_unlimited_claims_indemnification_obligation` to `include_uncapped_claims_indemnification_obligation`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_indemnification_obligation`. Sending the other spelling returns a 422.",
- "type": "boolean"
- },
- "include_uncapped_claims_other": {
- "description": "CSA 3.0 renamed `include_unlimited_claims_other` to `include_uncapped_claims_other`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_other`. Sending the other spelling returns a 422.",
- "type": "boolean"
- },
- "include_unlimited_claims": {
- "type": "boolean"
- },
- "include_unlimited_claims_breach_of_confidentiality": {
- "type": "boolean"
- },
- "include_unlimited_claims_breach_of_confidentiality_negligence": {
- "type": "boolean"
- },
- "include_unlimited_claims_breach_of_privsec": {
- "type": "boolean"
- },
- "include_unlimited_claims_breach_of_privsec_negligence": {
- "type": "boolean"
- },
- "include_unlimited_claims_include_other": {
- "type": "boolean"
- },
- "include_unlimited_claims_indemnification_obligation": {
- "type": "boolean"
- },
- "include_unlimited_claims_other": {
- "type": "string"
- },
- "increased_cap_amount_currency": {
- "type": "number"
- },
- "increased_cap_amount_period_currency": {
- "type": "number"
- },
- "increased_cap_amount_period_qty": {
- "type": "number"
- },
- "increased_cap_amount_qty": {
- "type": "number"
- },
- "increased_cap_amount_type": {
- "enum": [
- "qty",
- "currency",
- "period"
- ],
- "type": "string"
- },
- "provider": {
- "type": "string"
- },
- "supercap_currency": {
- "description": "CSA 3.0 renamed `increased_cap_amount_currency` to `supercap_currency`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `increased_cap_amount_currency`. Sending the other spelling returns a 422.",
- "type": "number"
- },
- "supercap_period_currency": {
- "description": "CSA 3.0 renamed `increased_cap_amount_period_currency` to `supercap_period_currency`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `increased_cap_amount_period_currency`. Sending the other spelling returns a 422.",
- "type": "number"
- },
- "supercap_period_qty": {
- "description": "CSA 3.0 renamed `increased_cap_amount_period_qty` to `supercap_period_qty`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `increased_cap_amount_period_qty`. Sending the other spelling returns a 422.",
- "type": "number"
- },
- "supercap_qty": {
- "description": "CSA 3.0 renamed `increased_cap_amount_qty` to `supercap_qty`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `increased_cap_amount_qty`. Sending the other spelling returns a 422.",
- "type": "number"
- },
- "supercap_type": {
- "description": "CSA 3.0 renamed `increased_cap_amount_type` to `supercap_type`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `increased_cap_amount_type`. Sending the other spelling returns a 422.",
- "type": "number"
- }
- },
- "type": "object"
- },
- "csa_order_form_attributes": {
- "additionalProperties": false,
- "description": "Override csa order form terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "additional_changes": {
- "type": "string"
- },
- "additional_parameters_or_limitations": {
- "type": "string"
- },
- "affiliates_as_users": {
- "type": "boolean"
- },
- "cloud_service_description": {
- "type": "string"
- },
- "consumption_units": {
- "type": "string"
- },
- "fee_amount": {
- "type": "number"
- },
- "fee_custom_unit": {
- "type": "string"
- },
- "fee_period": {
- "enum": [
- "Subscription Period",
- "month",
- "year",
- "User",
- "Custom unit"
- ],
- "type": "string"
- },
- "fees_attributes": {
- "additionalProperties": {
- "anyOf": [
- {
- "additionalProperties": false,
- "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": {
- "enum": [
- "USD",
- "EUR",
- "GBP",
- "CAD",
- "AUD",
- "SGD",
- "ILS",
- "JPY",
- "CHF",
- "HKD"
- ],
- "type": "string"
- },
- "fees_include_fee_increase_upon_renewal": {
- "type": "boolean"
- },
- "fees_include_fee_increase_upon_renewal_fee": {
- "type": "number"
- },
- "fees_include_fee_increase_upon_renewal_type": {
- "enum": [
- "will",
- "may"
- ],
- "type": "string"
- },
- "fees_inclusive_of_taxes": {
- "type": "boolean"
- },
- "framework_terms_type": {
- "enum": [
- "new",
- "existing",
- "description"
- ],
- "type": "string"
- },
- "free_trial_days": {
- "type": "number"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_additional_changes": {
- "type": "boolean"
- },
- "include_additional_parameters_or_limitations": {
- "type": "boolean"
- },
- "include_consumption": {
- "type": "boolean"
- },
- "include_fees": {
- "type": "boolean"
- },
- "include_fees_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_fees_include_attachment": {
- "type": "boolean"
- },
- "include_fees_other": {
- "type": "boolean"
- },
- "include_fees_other_val": {
- "type": "string"
- },
- "include_fees_table": {
- "type": "boolean"
- },
- "include_fees_table_period": {
- "enum": [
- "Subscription Period",
- "month",
- "year",
- "User"
- ],
- "type": "string"
- },
- "include_free_trial": {
- "type": "boolean"
- },
- "include_max_users": {
- "type": "boolean"
- },
- "include_pilot_period": {
- "type": "boolean"
- },
- "include_pilot_period_duration_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_pilot_period_duration_type": {
- "enum": [
- "day",
- "week",
- "month"
- ],
- "type": "string"
- },
- "include_pilot_period_include_fees": {
- "type": "boolean"
- },
- "include_pilot_period_include_fees_amount": {
- "type": "number"
- },
- "include_pilot_period_include_modifications": {
- "type": "boolean"
- },
- "include_pilot_period_include_modifications_description": {
- "type": "string"
- },
- "include_product_support": {
- "type": "boolean"
- },
- "include_product_support_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_product_support_description": {
- "type": "string"
- },
- "include_product_support_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_professional_services": {
- "type": "boolean"
- },
- "include_professional_services_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_professional_services_custom_name": {
- "type": "string"
- },
- "include_professional_services_description": {
- "type": "string"
- },
- "include_professional_services_end_date": {
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "include_professional_services_fees_description": {
- "type": "string"
- },
- "include_professional_services_include_end_date": {
- "type": "boolean"
- },
- "include_professional_services_include_fees_description": {
- "type": "boolean"
- },
- "include_professional_services_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_sla": {
- "type": "boolean"
- },
- "include_sla_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_sla_description": {
- "type": "string"
- },
- "include_sla_include_response_time": {
- "type": "boolean"
- },
- "include_sla_include_response_time_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_sla_include_response_time_credit": {
- "type": "number"
- },
- "include_sla_include_response_time_duration": {
- "enum": [
- "hour",
- "day",
- "week",
- "month",
- "hours"
- ],
- "type": "string"
- },
- "include_sla_include_response_time_support_channel": {
- "type": "string"
- },
- "include_sla_include_target_uptime": {
- "type": "boolean"
- },
- "include_sla_maintenance_notice": {
- "type": "boolean"
- },
- "include_sla_maintenance_window": {
- "type": "boolean"
- },
- "include_sla_maintenance_window_type": {
- "enum": [
- "standard",
- "none"
- ],
- "type": "string"
- },
- "include_sla_standard_maintenance_notice_qty": {
- "type": "number"
- },
- "include_sla_standard_maintenance_notice_unit": {
- "enum": [
- "hour",
- "day",
- "week",
- "month"
- ],
- "type": "string"
- },
- "include_sla_standard_maintenance_window_end_time": {
- "type": "string"
- },
- "include_sla_standard_maintenance_window_friday": {
- "type": "boolean"
- },
- "include_sla_standard_maintenance_window_monday": {
- "type": "boolean"
- },
- "include_sla_standard_maintenance_window_saturday": {
- "type": "boolean"
- },
- "include_sla_standard_maintenance_window_start_time": {
- "type": "string"
- },
- "include_sla_standard_maintenance_window_sunday": {
- "type": "boolean"
- },
- "include_sla_standard_maintenance_window_thursday": {
- "type": "boolean"
- },
- "include_sla_standard_maintenance_window_time_zone": {
- "type": "string"
- },
- "include_sla_standard_maintenance_window_tuesday": {
- "type": "boolean"
- },
- "include_sla_standard_maintenance_window_wednesday": {
- "type": "boolean"
- },
- "include_sla_standard_target_uptime": {
- "type": "number"
- },
- "include_sla_type": {
- "enum": [
- "description",
- "standard",
- "attachment"
- ],
- "type": "string"
- },
- "include_subscription_start_date": {
- "type": "boolean"
- },
- "include_subscription_start_date_date": {
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "include_usage_review": {
- "type": "boolean"
- },
- "include_usage_review_val": {
- "type": "string"
- },
- "include_use_limitations": {
- "type": "boolean"
- },
- "include_use_limitations_val": {
- "type": "string"
- },
- "invoice_period": {
- "enum": [
- "monthly",
- "quarterly",
- "semiannually",
- "annually",
- "Custom unit",
- "Monthly",
- "Quarterly",
- "Semiannually",
- "Annually"
- ],
- "type": "string"
- },
- "invoice_period_custom_unit": {
- "type": "string"
- },
- "max_consumption": {
- "type": "number"
- },
- "max_users": {
- "type": "number"
- },
- "negotiations_allowed": {
- "description": "When true, the recipient can propose changes to the order form, even when the agreement-level `negotiations_allowed` is false. This only covers the order form.",
- "type": "boolean"
- },
- "order_date_date": {
- "type": "string"
- },
- "order_date_other": {
- "type": "string"
- },
- "order_date_type": {
- "enum": [
- "signature",
- "date",
- "other"
- ],
- "type": "string"
- },
- "payment_period": {
- "type": "number"
- },
- "payment_period_timeframe": {
- "enum": [
- "Customer's receipt of invoice",
- "date of invoice"
- ],
- "type": "string"
- },
- "payment_period_unit": {
- "enum": [
- "day(s)",
- "week(s)",
- "month(s)",
- "marketplace_acceptance"
- ],
- "type": "string"
- },
- "payment_process_automatic_frequency": {
- "enum": [
- "monthly",
- "quarterly",
- "semiannually",
- "annually"
- ],
- "type": "string"
- },
- "payment_process_type": {
- "enum": [
- "automatic",
- "invoice",
- "custom",
- "marketplace_acceptance"
- ],
- "type": "string"
- },
- "payment_process_type_custom_val": {
- "type": "string"
- },
- "payment_process_type_invoice_amount": {
- "type": "number"
- },
- "payment_process_type_invoice_custom_unit": {
- "type": "string"
- },
- "payment_process_type_invoice_duration": {
- "enum": [
- "day",
- "week",
- "month",
- "year",
- "day(s)",
- "week(s)",
- "month(s)",
- "year(s)"
- ],
- "type": "string"
- },
- "payment_process_type_invoice_duration_start": {
- "enum": [
- "Customer's receipt of invoice",
- "date of invoice"
- ],
- "type": "string"
- },
- "payment_process_type_invoice_type": {
- "enum": [
- "monthly",
- "quarterly",
- "semiannually",
- "annually",
- "Custom unit"
- ],
- "type": "string"
- },
- "pilot_period_stripe_product_id": {
- "type": "string"
- },
- "service_credits_attributes": {
- "additionalProperties": {
- "additionalProperties": false,
- "properties": {
- "credit": {
- "type": "number"
- },
- "max": {
- "type": "number"
- },
- "min": {
- "type": "number"
- }
- },
- "type": "object"
- },
- "description": "Service credits. Use string keys such as \"0\", \"1\".",
- "propertyNames": {
- "type": "string"
- },
- "type": "object"
- },
- "subscription_auto_renew": {
- "enum": [
- "days",
- "subscription_end"
- ],
- "type": "string"
- },
- "subscription_period": {
- "type": "number"
- },
- "subscription_period_unit": {
- "type": "string"
- },
- "subscription_renewal_notice_days": {
- "type": "number"
- },
- "subscription_start_date": {
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "subscription_start_date_type": {
- "enum": [
- "effective_date",
- "date"
- ],
- "type": "string"
- },
- "underlying_agreement_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "use_limitations_attributes": {
- "additionalProperties": {
- "additionalProperties": false,
- "properties": {
- "amount": {
- "type": "number"
- },
- "limitation_type": {
- "type": "string"
- },
- "unit": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "description": "Use limitations. Use string keys such as \"0\", \"1\".",
- "propertyNames": {
- "type": "string"
- },
- "type": "object"
- }
- },
- "type": "object"
- },
- "custom_field_values": {
- "description": "Values for a custom template's fields, keyed by the field keys defined in the template's YAML definition. Only used when template_id is a custom template. Template defaults fill any fields you omit; a required field with no default and no submitted value returns a 400 naming the field. Values are validated against the field's input type: select and radio values must be one of the field's options, multiselect values are an array of selections each of which must be one of the field's options, number and currency values must be numeric, date values must be YYYY-MM-DD, and email values must be valid addresses. An invalid value returns a 400 naming the field."
- },
- "design_partner_attributes": {
- "additionalProperties": false,
- "description": "Override design partner terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "customer_description": {
- "type": "string"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_fees": {
- "type": "boolean"
- },
- "include_fees_amount": {
- "type": "number"
- },
- "include_fees_description": {
- "type": "string"
- },
- "include_fees_pay_by_amount": {
- "type": "string"
- },
- "include_fees_type": {
- "enum": [
- "default_language",
- "description"
- ],
- "type": "string"
- },
- "include_fees_unit": {
- "enum": [
- "month",
- "quarter",
- "year",
- "Term"
- ],
- "type": "string"
- },
- "include_program_appear_as_customer_private": {
- "type": "boolean"
- },
- "include_program_appear_as_customer_public": {
- "type": "boolean"
- },
- "include_program_case_study": {
- "type": "boolean"
- },
- "include_program_develop_functionality": {
- "type": "boolean"
- },
- "include_program_develop_functionality_val": {
- "type": "string"
- },
- "include_program_discount": {
- "type": "boolean"
- },
- "include_program_discount_amount": {
- "type": "number"
- },
- "include_program_discount_unit": {
- "enum": [
- "U.S. Dollars",
- "percent"
- ],
- "type": "string"
- },
- "include_program_participation_feedback": {
- "type": "boolean"
- },
- "include_program_participation_feedback_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_program_participation_feedback_unit": {
- "enum": [
- "month",
- "quarter",
- "year",
- "Term"
- ],
- "type": "string"
- },
- "include_program_partner_other": {
- "type": "boolean"
- },
- "include_program_partner_other_val": {
- "type": "string"
- },
- "include_program_provider_other": {
- "type": "boolean"
- },
- "include_program_provider_other_val": {
- "type": "string"
- },
- "include_program_reference": {
- "type": "boolean"
- },
- "product_description": {
- "type": "string"
- },
- "term_amount": {
- "type": "number"
- },
- "term_unit": {
- "enum": [
- "day(s)",
- "week(s)",
- "month(s)",
- "quarter(s)",
- "year(s)"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- "district_or_county": {
- "description": "The district or county for dispute resolution.",
- "type": "string"
- },
- "dpa_attributes": {
- "additionalProperties": false,
- "description": "Override dpa terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "approved_subprocessor_type": {
- "description": "`internal` lists approved subprocessors in the agreement (`subprocessors_attributes`); `external` points to a list published elsewhere.",
- "enum": [
- "internal",
- "external"
- ],
- "type": "string"
- },
- "cloud_service_product_name": {
- "type": "string"
- },
- "competent_supervisory_authority": {
- "type": "string"
- },
- "customer_description": {
- "type": "string"
- },
- "data_exporter_address_city": {
- "type": "string"
- },
- "data_exporter_address_country": {
- "type": "string"
- },
- "data_exporter_address_state": {
- "type": "string"
- },
- "data_exporter_address_street_address": {
- "type": "string"
- },
- "data_exporter_address_zipcode": {
- "type": "string"
- },
- "data_exporter_contact_details": {
- "type": "string"
- },
- "data_exporter_contact_name": {
- "type": "string"
- },
- "data_exporter_contact_position": {
- "type": "string"
- },
- "data_exporter_role": {
- "description": "Role of the data exporter. Overwritten to `Controller` when the agreement is created from a template.",
- "enum": [
- "Controller",
- "Processor"
- ],
- "type": "string"
- },
- "data_importer_address": {
- "type": "string"
- },
- "data_importer_address_city": {
- "type": "string"
- },
- "data_importer_address_country": {
- "type": "string"
- },
- "data_importer_address_state": {
- "type": "string"
- },
- "data_importer_address_street_address": {
- "type": "string"
- },
- "data_importer_address_zipcode": {
- "type": "string"
- },
- "data_importer_contact_details": {
- "type": "string"
- },
- "data_importer_contact_name": {
- "type": "string"
- },
- "data_importer_contact_position": {
- "type": "string"
- },
- "duration_of_processing": {
- "type": "string"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_covered_claim": {
- "type": "boolean"
- },
- "include_covered_claim_external_val": {
- "type": "string"
- },
- "include_covered_claim_internal_val": {
- "type": "string"
- },
- "include_covered_claim_type": {
- "description": "Which covered-claim text applies: `internal` uses `include_covered_claim_internal_val`, `external` uses `include_covered_claim_external_val`. Required when `include_covered_claim` is true.",
- "enum": [
- "internal",
- "external"
- ],
- "type": "string"
- },
- "include_data_subjects_custom": {
- "type": "boolean"
- },
- "include_data_subjects_custom_val": {
- "type": "string"
- },
- "include_data_subjects_employees": {
- "type": "boolean"
- },
- "include_data_subjects_end_users": {
- "type": "boolean"
- },
- "include_external_subprocessor_location": {
- "type": "string"
- },
- "include_frequency_of_transfer_continuous": {
- "type": "boolean"
- },
- "include_frequency_of_transfer_custom": {
- "type": "boolean"
- },
- "include_frequency_of_transfer_custom_val": {
- "type": "string"
- },
- "include_governing_country_eu": {
- "type": "boolean"
- },
- "include_governing_country_eu_val": {
- "type": "string"
- },
- "include_governing_country_uk": {
- "type": "boolean"
- },
- "include_governing_country_uk_val": {
- "type": "string"
- },
- "include_governing_law": {
- "type": "boolean"
- },
- "include_governing_law_country": {
- "type": "string"
- },
- "include_governing_law_state": {
- "type": "string"
- },
- "include_increased_claim_amount": {
- "description": "Legacy field. Stored but not shown on the DPA; use the `include_liability_cap*` fields instead.",
- "type": "boolean"
- },
- "include_increased_claim_amount_currency": {
- "description": "Legacy field. Stored but not shown on the DPA; use the `include_liability_cap*` fields instead."
- },
- "include_increased_claim_amount_qty": {
- "description": "Legacy field. Stored but not shown on the DPA; use the `include_liability_cap*` fields instead."
- },
- "include_increased_claim_amount_type": {
- "description": "Legacy field. Stored but not shown on the DPA; use the `include_liability_cap*` fields instead.",
- "type": "string"
- },
- "include_liability_cap": {
- "type": "boolean"
- },
- "include_liability_cap_amount_constant_external": {
- "type": "string"
- },
- "include_liability_cap_amount_constant_internal": {
- "type": "string"
- },
- "include_liability_cap_amount_currency_external": {
- "description": "Currency amount. Numbers and numeric strings (commas allowed) are both accepted."
- },
- "include_liability_cap_amount_currency_internal": {
- "description": "Currency amount. Numbers and numeric strings (commas allowed) are both accepted."
- },
- "include_liability_cap_csa_type": {
- "description": "Which liability cap values apply: the `_internal` or `_external` amount fields. Required when `include_liability_cap` is true.",
- "enum": [
- "internal",
- "external"
- ],
- "type": "string"
- },
- "include_personal_data_biographic_info": {
- "type": "boolean"
- },
- "include_personal_data_contact_info": {
- "type": "boolean"
- },
- "include_personal_data_custom": {
- "type": "boolean"
- },
- "include_personal_data_custom_val": {
- "type": "string"
- },
- "include_personal_data_employment_info": {
- "type": "boolean"
- },
- "include_personal_data_financial_info": {
- "type": "boolean"
- },
- "include_personal_data_location": {
- "type": "boolean"
- },
- "include_personal_data_name": {
- "type": "boolean"
- },
- "include_personal_data_transactional_info": {
- "type": "boolean"
- },
- "include_personal_data_user_activity_info": {
- "type": "boolean"
- },
- "include_processing_purpose_custom": {
- "type": "boolean"
- },
- "include_processing_purpose_custom_val": {
- "type": "string"
- },
- "include_processing_purpose_erasing": {
- "type": "boolean"
- },
- "include_processing_purpose_holding": {
- "type": "boolean"
- },
- "include_processing_purpose_protecting": {
- "type": "boolean"
- },
- "include_processing_purpose_receiving": {
- "type": "boolean"
- },
- "include_processing_purpose_returning": {
- "type": "boolean"
- },
- "include_processing_purpose_sharing": {
- "type": "boolean"
- },
- "include_processing_purpose_updating": {
- "type": "boolean"
- },
- "include_processing_purpose_using": {
- "type": "boolean"
- },
- "include_provider_security_contact_address": {
- "type": "boolean"
- },
- "include_provider_security_contact_address_city": {
- "type": "string"
- },
- "include_provider_security_contact_address_country": {
- "type": "string"
- },
- "include_provider_security_contact_address_state": {
- "type": "string"
- },
- "include_provider_security_contact_address_street_address": {
- "type": "string"
- },
- "include_provider_security_contact_address_zipcode": {
- "type": "string"
- },
- "include_provider_security_contact_email": {
- "type": "boolean"
- },
- "include_provider_security_contact_email_val": {
- "format": "email",
- "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
- "type": "string"
- },
- "include_security_measures_accountability": {
- "type": "boolean"
- },
- "include_security_measures_accountability_val": {
- "type": "string"
- },
- "include_security_measures_certification_or_assurance": {
- "type": "boolean"
- },
- "include_security_measures_certification_or_assurance_val": {
- "type": "string"
- },
- "include_security_measures_confidentiality_integrity": {
- "type": "boolean"
- },
- "include_security_measures_confidentiality_integrity_val": {
- "type": "string"
- },
- "include_security_measures_data_at_rest": {
- "type": "boolean"
- },
- "include_security_measures_data_at_rest_val": {
- "type": "string"
- },
- "include_security_measures_data_minimization": {
- "type": "boolean"
- },
- "include_security_measures_data_minimization_val": {
- "type": "string"
- },
- "include_security_measures_data_quality": {
- "type": "boolean"
- },
- "include_security_measures_data_quality_val": {
- "type": "string"
- },
- "include_security_measures_data_retention": {
- "type": "boolean"
- },
- "include_security_measures_data_retention_val": {
- "type": "string"
- },
- "include_security_measures_data_transmission": {
- "type": "boolean"
- },
- "include_security_measures_data_transmission_val": {
- "type": "string"
- },
- "include_security_measures_event_logging": {
- "type": "boolean"
- },
- "include_security_measures_event_logging_val": {
- "type": "string"
- },
- "include_security_measures_identity_auth": {
- "type": "boolean"
- },
- "include_security_measures_identity_auth_val": {
- "type": "string"
- },
- "include_security_measures_it_security_governance": {
- "type": "boolean"
- },
- "include_security_measures_it_security_governance_val": {
- "type": "string"
- },
- "include_security_measures_physical_security": {
- "type": "boolean"
- },
- "include_security_measures_physical_security_val": {
- "type": "string"
- },
- "include_security_measures_portability_and_erasure": {
- "type": "boolean"
- },
- "include_security_measures_portability_and_erasure_val": {
- "type": "string"
- },
- "include_security_measures_pseudonym_encryption": {
- "type": "boolean"
- },
- "include_security_measures_pseudonym_encryption_val": {
- "type": "string"
- },
- "include_security_measures_restore_data_access": {
- "type": "boolean"
- },
- "include_security_measures_restore_data_access_val": {
- "type": "string"
- },
- "include_security_measures_security_policy": {
- "type": "boolean"
- },
- "include_security_measures_system_configuration": {
- "type": "boolean"
- },
- "include_security_measures_system_configuration_val": {
- "type": "string"
- },
- "include_security_measures_testing_assessment": {
- "type": "boolean"
- },
- "include_security_measures_testing_assessment_val": {
- "type": "string"
- },
- "include_security_policy": {
- "type": "boolean"
- },
- "include_security_policy_fedramp_auth": {
- "type": "boolean"
- },
- "include_security_policy_hipaa": {
- "type": "boolean"
- },
- "include_security_policy_hitrust": {
- "type": "boolean"
- },
- "include_security_policy_include_other": {
- "type": "boolean"
- },
- "include_security_policy_iso27001": {
- "type": "boolean"
- },
- "include_security_policy_other": {
- "type": "string"
- },
- "include_security_policy_pci1": {
- "type": "boolean"
- },
- "include_security_policy_pci2": {
- "type": "boolean"
- },
- "include_security_policy_penetration_testing": {
- "type": "boolean"
- },
- "include_security_policy_soc2": {
- "type": "boolean"
- },
- "include_security_policy_soc2_type2": {
- "type": "boolean"
- },
- "include_sensitive_data_restrictions_custom": {
- "type": "boolean"
- },
- "include_sensitive_data_restrictions_custom_val": {
- "type": "string"
- },
- "include_sensitive_data_restrictions_security_policy": {
- "type": "boolean"
- },
- "include_service_provider_relationship": {
- "type": "boolean"
- },
- "include_special_category_data": {
- "type": "boolean"
- },
- "provider": {
- "type": "string"
- },
- "security_policy_available_at": {
- "type": "string"
- },
- "security_policy_type": {
- "description": "Where the Security Policy is defined. For `external`, set `security_policy_available_at`.",
- "enum": [
- "defined in agreement",
- "provider service",
- "external"
- ],
- "type": "string"
- },
- "subprocessors_attributes": {
- "additionalProperties": {
- "additionalProperties": false,
- "properties": {
- "_destroy": {
- "description": "Set to true with `id` to remove that subprocessor.",
- "type": "boolean"
- },
- "country": {
- "type": "string"
- },
- "id": {
- "description": "ID of an existing subprocessor to update or remove. Omit to add a new subprocessor.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "name": {
- "type": "string"
- },
- "processing_task": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "description": "Subprocessors, keyed by string index such as \"0\", \"1\". On create these are added to the template's subprocessors. On a draft update, an entry without `id` adds a new subprocessor; pass `id` to change one and `id` with `_destroy: true` to remove one.",
- "propertyNames": {
- "type": "string"
- },
- "type": "object"
- },
- "underlying_agreement_id": {
- "description": "ID of the CSA this DPA supplements when `underlying_agreement_type` is `internal`.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "underlying_agreement_type": {
- "description": "`internal` links a CSA in Common Paper (`underlying_agreement_id`); `external` describes another agreement in `underlying_agreement_val` (required). Omit for none.",
- "enum": [
- "internal",
- "external"
- ],
- "type": "string"
- },
- "underlying_agreement_val": {
- "description": "Description of the agreement this DPA supplements. Required when `underlying_agreement_type` is `external`.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "framework_terms_description": {
- "description": "Custom framework terms description. Only used when framework_terms_type is \"description\".",
- "type": "string"
- },
- "framework_terms_type": {
- "description": "How framework terms are specified. Use \"new\" for standard terms or \"description\" to provide a custom framework_terms_description.",
- "enum": [
- "new",
- "description"
- ],
- "type": "string"
- },
- "governing_law_country": {
- "description": "The country whose laws govern the agreement.",
- "type": "string"
- },
- "governing_law_region": {
- "description": "The state or region whose laws govern the agreement.",
- "type": "string"
- },
- "include_automated_payment_reminders": {
- "description": "When true, automatically sends payment reminder emails.",
- "type": "boolean"
- },
- "include_billing_info": {
- "description": "When true, billing contact information (billing_name, billing_email) is included.",
- "type": "boolean"
- },
- "include_billing_workflow": {
- "description": "When true, enables a billing workflow after signing.",
- "type": "boolean"
- },
- "include_expiration_date": {
- "description": "Expiration date in YYYY-MM-DD format. Use when include_expiration_type is \"date\".",
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "include_expiration_days": {
- "description": "Number of days until the agreement expires. Use when include_expiration_type is \"days\".",
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_expiration_type": {
- "description": "How to set expiration: \"none\" (default), \"days\" (use include_expiration_days), or \"date\" (use include_expiration_date).",
- "enum": [
- "none",
- "days",
- "date"
- ],
- "type": "string"
- },
- "include_terms": {
- "description": "When true, the standard terms are included with the agreement.",
- "type": "boolean"
- },
- "loi_attributes": {
- "additionalProperties": false,
- "description": "Override loi terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "confidentiality_custom": {
- "type": "string"
- },
- "confidentiality_mutual_include_loi": {
- "type": "boolean"
- },
- "confidentiality_nda_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "confidentiality_nda_description": {
- "type": "string"
- },
- "confidentiality_nda_include_loi": {
- "type": "boolean"
- },
- "confidentiality_nda_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "confidentiality_type": {
- "enum": [
- "mutual",
- "nda",
- "provider",
- "custom"
- ],
- "type": "string"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_custom_details": {
- "type": "boolean"
- },
- "include_custom_details_val": {
- "type": "string"
- },
- "include_fees": {
- "type": "boolean"
- },
- "include_fees_amount": {
- "type": "number"
- },
- "include_fees_amount_duration": {
- "enum": [
- "month",
- "year",
- "quarter"
- ],
- "type": "string"
- },
- "include_fees_include_amount": {
- "type": "boolean"
- },
- "include_fees_include_other": {
- "type": "boolean"
- },
- "include_fees_other": {
- "type": "string"
- },
- "include_functionality": {
- "type": "boolean"
- },
- "include_functionality_val": {
- "type": "string"
- },
- "include_launch_date": {
- "type": "boolean"
- },
- "include_launch_date_custom": {
- "type": "string"
- },
- "include_launch_date_date": {
- "format": "date-time",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$",
- "type": "string"
- },
- "include_launch_date_type": {
- "enum": [
- "date",
- "custom"
- ],
- "type": "string"
- },
- "product_name": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "manual_send": {
- "description": "When true, the agreement is marked as manually sent outside the platform.",
- "type": "boolean"
- },
- "message": {
- "type": "string"
- },
- "negotiations_allowed": {
- "description": "When true, the recipient can propose changes to the legal terms. For agreement types without separate business terms, that covers every term. CSA order forms, PSA statements of work, partnership business terms and software license order forms have their own `negotiations_allowed` flag.",
- "type": "boolean"
- },
- "partnership_attributes": {
- "additionalProperties": false,
- "description": "Override partnership terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "effective_date": {
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "effective_date_type": {
- "enum": [
- "signature",
- "date"
- ],
- "type": "string"
- },
- "general_cap_amount_currency_val": {
- "type": "number"
- },
- "general_cap_amount_either_currency": {
- "type": "number"
- },
- "general_cap_amount_either_multiple": {
- "type": "number"
- },
- "general_cap_amount_multiple_val": {
- "type": "number"
- },
- "general_cap_amount_type": {
- "enum": [
- "multiple",
- "currency",
- "either",
- "base"
- ],
- "type": "string"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_additional_warranties": {
- "type": "boolean"
- },
- "include_additional_warranties_include_company": {
- "type": "boolean"
- },
- "include_additional_warranties_include_company_val": {
- "type": "string"
- },
- "include_additional_warranties_include_partner": {
- "type": "boolean"
- },
- "include_additional_warranties_include_partner_val": {
- "type": "string"
- },
- "include_brand_guidelines": {
- "type": "boolean"
- },
- "include_brand_guidelines_include_company": {
- "type": "boolean"
- },
- "include_brand_guidelines_include_company_val": {
- "type": "string"
- },
- "include_brand_guidelines_include_partner": {
- "type": "boolean"
- },
- "include_brand_guidelines_include_partner_val": {
- "type": "string"
- },
- "include_covered_claims": {
- "type": "boolean"
- },
- "include_covered_claims_company_claims": {
- "type": "string"
- },
- "include_covered_claims_include_company_claims": {
- "type": "boolean"
- },
- "include_covered_claims_include_partner_claims": {
- "type": "boolean"
- },
- "include_covered_claims_partner_claims": {
- "type": "string"
- },
- "include_dpa": {
- "type": "boolean"
- },
- "include_dpa_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_dpa_location": {
- "type": "string"
- },
- "include_dpa_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_increased_cap_amount": {
- "type": "boolean"
- },
- "include_increased_cap_amount_currency": {
- "type": "number"
- },
- "include_increased_cap_amount_either_currency": {
- "type": "number"
- },
- "include_increased_cap_amount_either_multiple": {
- "type": "string"
- },
- "include_increased_cap_amount_multiple": {
- "type": "string"
- },
- "include_increased_cap_amount_type": {
- "enum": [
- "multiple",
- "currency",
- "either"
- ],
- "type": "string"
- },
- "include_increased_claims": {
- "type": "boolean"
- },
- "include_increased_claims_include_confidentiality": {
- "type": "boolean"
- },
- "include_increased_claims_include_confidentiality_misconduct": {
- "type": "boolean"
- },
- "include_increased_claims_include_covered_claims": {
- "type": "boolean"
- },
- "include_increased_claims_include_misconduct": {
- "type": "boolean"
- },
- "include_increased_claims_include_other": {
- "type": "boolean"
- },
- "include_increased_claims_include_other_val": {
- "type": "string"
- },
- "include_unlimited_claims": {
- "type": "boolean"
- },
- "include_unlimited_claims_confidentiality": {
- "type": "boolean"
- },
- "include_unlimited_claims_confidentiality_misconduct": {
- "type": "boolean"
- },
- "include_unlimited_claims_covered_claims": {
- "type": "boolean"
- },
- "include_unlimited_claims_misconduct": {
- "type": "boolean"
- },
- "include_unlimited_claims_other": {
- "type": "boolean"
- },
- "include_unlimited_claims_other_val": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "partnership_business_terms_attributes": {
- "additionalProperties": false,
- "description": "Override partnership business terms terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "end_date_after_effective_date_amount": {
- "type": "number"
- },
- "end_date_after_effective_date_unit": {
- "enum": [
- "month(s)",
- "quarter(s)",
- "year(s)"
- ],
- "type": "string"
- },
- "end_date_date": {
- "type": "string"
- },
- "end_date_type": {
- "enum": [
- "date",
- "effective date"
- ],
- "type": "string"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_obligations_company_brand": {
- "type": "boolean"
- },
- "include_obligations_company_promotion": {
- "type": "boolean"
- },
- "include_obligations_company_promotion_include_activities": {
- "type": "boolean"
- },
- "include_obligations_company_promotion_include_activities_val": {
- "type": "string"
- },
- "include_obligations_company_promotion_include_materials": {
- "type": "boolean"
- },
- "include_obligations_company_promotion_include_materials_val": {
- "type": "string"
- },
- "include_obligations_company_referral": {
- "type": "boolean"
- },
- "include_obligations_company_referral_include_criteria": {
- "type": "boolean"
- },
- "include_obligations_company_referral_include_criteria_val": {
- "type": "string"
- },
- "include_obligations_company_referral_include_pay_sch": {
- "type": "boolean"
- },
- "include_obligations_company_referral_include_pay_sch_amount": {
- "type": "number"
- },
- "include_obligations_company_referral_include_pay_sch_custom": {
- "type": "string"
- },
- "include_obligations_company_referral_include_pay_sch_unit": {
- "enum": [
- "U.S. Dollars",
- "percent"
- ],
- "type": "string"
- },
- "include_obligations_company_sponsorship": {
- "type": "boolean"
- },
- "include_obligations_company_sponsorship_include_benefits": {
- "type": "boolean"
- },
- "include_obligations_company_sponsorship_include_benefits_val": {
- "type": "string"
- },
- "include_obligations_company_sponsorship_include_payments": {
- "type": "boolean"
- },
- "include_obligations_company_sponsorship_include_payments_amount": {
- "type": "number"
- },
- "include_obligations_company_sponsorship_include_payments_unit": {
- "enum": [
- "U.S. Dollars",
- "percent"
- ],
- "type": "string"
- },
- "include_obligations_partner_brand": {
- "type": "boolean"
- },
- "include_obligations_partner_promotion": {
- "type": "boolean"
- },
- "include_obligations_partner_promotion_include_activities": {
- "type": "boolean"
- },
- "include_obligations_partner_promotion_include_activities_val": {
- "type": "string"
- },
- "include_obligations_partner_promotion_include_materials": {
- "type": "boolean"
- },
- "include_obligations_partner_promotion_include_materials_val": {
- "type": "string"
- },
- "include_obligations_partner_referral": {
- "type": "boolean"
- },
- "include_obligations_partner_referral_include_criteria": {
- "type": "boolean"
- },
- "include_obligations_partner_referral_include_criteria_val": {
- "type": "string"
- },
- "include_obligations_partner_referral_include_pay_sch": {
- "type": "boolean"
- },
- "include_obligations_partner_referral_include_pay_sch_amount": {
- "type": "number"
- },
- "include_obligations_partner_referral_include_pay_sch_custom": {
- "type": "string"
- },
- "include_obligations_partner_referral_include_pay_sch_unit": {
- "enum": [
- "U.S. Dollars",
- "percent"
- ],
- "type": "string"
- },
- "include_obligations_partner_sponsorship": {
- "type": "boolean"
- },
- "include_obligations_partner_sponsorship_include_benefits": {
- "type": "boolean"
- },
- "include_obligations_partner_sponsorship_include_benefits_val": {
- "type": "string"
- },
- "include_obligations_partner_sponsorship_include_payments": {
- "type": "boolean"
- },
- "include_obligations_partner_sponsorship_include_payments_amount": {
- "type": "number"
- },
- "include_obligations_partner_sponsorship_include_payments_unit": {
- "enum": [
- "U.S. Dollars",
- "percent"
- ],
- "type": "string"
- },
- "include_payment_process": {
- "type": "boolean"
- },
- "include_payment_process_company": {
- "type": "boolean"
- },
- "include_payment_process_company_include_address": {
- "type": "boolean"
- },
- "include_payment_process_company_include_address_city": {
- "type": "string"
- },
- "include_payment_process_company_include_address_country": {
- "type": "string"
- },
- "include_payment_process_company_include_address_state": {
- "type": "string"
- },
- "include_payment_process_company_include_address_street_address": {
- "type": "string"
- },
- "include_payment_process_company_include_address_zipcode": {
- "type": "string"
- },
- "include_payment_process_company_include_email": {
- "type": "boolean"
- },
- "include_payment_process_company_include_email_val": {
- "type": "string"
- },
- "include_payment_process_partner": {
- "type": "boolean"
- },
- "include_payment_process_partner_include_address": {
- "type": "boolean"
- },
- "include_payment_process_partner_include_address_city": {
- "type": "string"
- },
- "include_payment_process_partner_include_address_country": {
- "type": "string"
- },
- "include_payment_process_partner_include_address_state": {
- "type": "string"
- },
- "include_payment_process_partner_include_address_street_address": {
- "type": "string"
- },
- "include_payment_process_partner_include_address_zipcode": {
- "type": "string"
- },
- "include_payment_process_partner_include_email": {
- "type": "boolean"
- },
- "include_payment_process_partner_include_email_val": {
- "type": "string"
- },
- "include_payment_schedule": {
- "type": "boolean"
- },
- "include_payment_schedule_custom": {
- "type": "string"
- },
- "include_payment_schedule_specified_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_payment_schedule_specified_timeframe": {
- "enum": [
- "receipt",
- "date"
- ],
- "type": "string"
- },
- "include_payment_schedule_specified_unit": {
- "enum": [
- "day(s)",
- "week(s)",
- "month(s)",
- "quarter(s)",
- "year(s)"
- ],
- "type": "string"
- },
- "include_payment_schedule_type": {
- "enum": [
- "specified",
- "custom"
- ],
- "type": "string"
- },
- "negotiations_allowed": {
- "description": "When true, the recipient can propose changes to the business terms, even when the agreement-level `negotiations_allowed` is false. This only covers the business terms.",
- "type": "boolean"
- },
- "territory_type": {
- "enum": [
- "worldwide",
- "custom"
- ],
- "type": "string"
- },
- "territory_type_val": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "payment_link_url": {
- "description": "A payment URL shown to the recipient after signing. Requires include_billing_workflow to be true and billing_workflow_type to be \"link\".",
- "type": "string"
- },
- "pilot_attributes": {
- "additionalProperties": false,
- "description": "Override pilot terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "fees_type": {
- "enum": [
- "free",
- "pilot_period_fees"
- ],
- "type": "string"
- },
- "general_cap_amount": {
- "type": "number"
- },
- "general_cap_amount_type": {
- "enum": [
- "preceding",
- "base",
- "period"
- ],
- "type": "string"
- },
- "general_cap_period_currency": {
- "type": "number"
- },
- "general_cap_period_qty": {
- "type": "number"
- },
- "general_cap_preceding_amount": {
- "type": "number"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_dpa": {
- "type": "boolean"
- },
- "include_dpa_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_dpa_location": {
- "type": "string"
- },
- "include_dpa_type": {
- "enum": [
- "description",
- "attachment",
- "standard"
- ],
- "type": "string"
- },
- "include_payment_process": {
- "type": "boolean"
- },
- "include_technical_support": {
- "type": "boolean"
- },
- "payment_process_automatic_frequency": {
- "enum": [
- "monthly",
- "quarterly",
- "annually",
- "once_per_period"
- ],
- "type": "string"
- },
- "payment_process_invoice_days": {
- "type": "number"
- },
- "payment_process_invoice_from": {
- "enum": [
- "receipt",
- "date"
- ],
- "type": "string"
- },
- "payment_process_invoice_timeframe": {
- "enum": [
- "days",
- "weeks",
- "months",
- "quarters",
- "years"
- ],
- "type": "string"
- },
- "payment_process_type": {
- "enum": [
- "automatic",
- "invoice"
- ],
- "type": "string"
- },
- "pilot_period_description": {
- "type": "string"
- },
- "pilot_period_fees_description": {
- "type": "string"
- },
- "product_description": {
- "type": "string"
- },
- "technical_support_description": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "psa_attributes": {
- "additionalProperties": false,
- "description": "Override psa terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "additional_changes": {
- "type": "string"
- },
- "customer_description": {
- "type": "string"
- },
- "effective_date": {
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "effective_date_type": {
- "enum": [
- "signature",
- "date"
- ],
- "type": "string"
- },
- "general_cap_amount": {
- "type": "number"
- },
- "general_cap_amount_type": {
- "enum": [
- "preceding",
- "base",
- "period"
- ],
- "type": "string"
- },
- "general_cap_period_currency": {
- "type": "number"
- },
- "general_cap_period_qty": {
- "type": "number"
- },
- "general_cap_preceding_amount": {
- "type": "number"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_additional_changes": {
- "type": "boolean"
- },
- "include_additional_warranties": {
- "type": "boolean"
- },
- "include_additional_warranties_by_customer": {
- "type": "string"
- },
- "include_additional_warranties_by_provider": {
- "type": "string"
- },
- "include_additional_warranties_include_by_customer": {
- "type": "boolean"
- },
- "include_additional_warranties_include_by_provider": {
- "type": "boolean"
- },
- "include_covered_claims": {
- "type": "boolean"
- },
- "include_covered_claims_customer_claims": {
- "type": "string"
- },
- "include_covered_claims_include_customer_claims": {
- "type": "boolean"
- },
- "include_covered_claims_include_provider_claims": {
- "type": "boolean"
- },
- "include_covered_claims_provider_claims": {
- "type": "string"
- },
- "include_customer_insurance_min": {
- "type": "boolean"
- },
- "include_customer_insurance_min_add_provider_com_gen_liability": {
- "type": "boolean"
- },
- "include_customer_insurance_min_add_provider_cyber_liability": {
- "type": "boolean"
- },
- "include_customer_insurance_min_add_provider_errors_omissions": {
- "type": "boolean"
- },
- "include_customer_insurance_min_auto_liability_aggregate": {
- "type": "number"
- },
- "include_customer_insurance_min_auto_liability_minimum": {
- "type": "number"
- },
- "include_customer_insurance_min_cyber_liability_aggregate": {
- "type": "number"
- },
- "include_customer_insurance_min_cyber_liability_minimum": {
- "type": "number"
- },
- "include_customer_insurance_min_employer_liability_aggregate": {
- "type": "number"
- },
- "include_customer_insurance_min_employer_liability_minimum": {
- "type": "number"
- },
- "include_customer_insurance_min_general_liability_aggregate": {
- "type": "number"
- },
- "include_customer_insurance_min_general_liability_minimum": {
- "type": "number"
- },
- "include_customer_insurance_min_include_add_provider": {
- "type": "boolean"
- },
- "include_customer_insurance_min_include_auto_liability": {
- "type": "boolean"
- },
- "include_customer_insurance_min_include_cyber_liability": {
- "type": "boolean"
- },
- "include_customer_insurance_min_include_employer_liability": {
- "type": "boolean"
- },
- "include_customer_insurance_min_include_general_liability": {
- "type": "boolean"
- },
- "include_customer_insurance_min_include_workers_comp": {
- "type": "boolean"
- },
- "include_customer_policies": {
- "type": "boolean"
- },
- "include_customer_policies_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_customer_policies_location": {
- "type": "string"
- },
- "include_customer_policies_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_dpa": {
- "type": "boolean"
- },
- "include_dpa_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_dpa_location": {
- "type": "string"
- },
- "include_dpa_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_increased_cap_amount": {
- "type": "boolean"
- },
- "include_increased_claims": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_confidentiality": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_confidentiality_negligence": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_privsec": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_privsec_negligence": {
- "type": "boolean"
- },
- "include_increased_claims_include_other": {
- "type": "boolean"
- },
- "include_increased_claims_indemnification_obligation": {
- "type": "boolean"
- },
- "include_increased_claims_negligence": {
- "type": "boolean"
- },
- "include_increased_claims_other": {
- "type": "string"
- },
- "include_provider_insurance_min": {
- "type": "boolean"
- },
- "include_provider_insurance_min_add_customer_com_gen_liability": {
- "type": "boolean"
- },
- "include_provider_insurance_min_add_customer_cyber_liability": {
- "type": "boolean"
- },
- "include_provider_insurance_min_add_customer_errors_omissions": {
- "type": "boolean"
- },
- "include_provider_insurance_min_auto_liability_aggregate": {
- "type": "number"
- },
- "include_provider_insurance_min_auto_liability_minimum": {
- "type": "number"
- },
- "include_provider_insurance_min_cyber_liability_aggregate": {
- "type": "number"
- },
- "include_provider_insurance_min_cyber_liability_minimum": {
- "type": "number"
- },
- "include_provider_insurance_min_employer_liability_aggregate": {
- "type": "number"
- },
- "include_provider_insurance_min_employer_liability_minimum": {
- "type": "number"
- },
- "include_provider_insurance_min_general_liability_aggregate": {
- "type": "number"
- },
- "include_provider_insurance_min_general_liability_minimum": {
- "type": "number"
- },
- "include_provider_insurance_min_include_add_customer": {
- "type": "boolean"
- },
- "include_provider_insurance_min_include_auto_liability": {
- "type": "boolean"
- },
- "include_provider_insurance_min_include_cyber_liability": {
- "type": "boolean"
- },
- "include_provider_insurance_min_include_employer_liability": {
- "type": "boolean"
- },
- "include_provider_insurance_min_include_general_liability": {
- "type": "boolean"
- },
- "include_provider_insurance_min_include_workers_comp": {
- "type": "boolean"
- },
- "include_publicity_rights": {
- "type": "boolean"
- },
- "include_publicity_rights_type": {
- "enum": [
- "public",
- "non-public"
- ],
- "type": "string"
- },
- "include_security_policy": {
- "type": "boolean"
- },
- "include_security_policy_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_security_policy_fedramp_auth": {
- "type": "boolean"
- },
- "include_security_policy_hitrust": {
- "type": "boolean"
- },
- "include_security_policy_include_annual_maintenance": {
- "type": "boolean"
- },
- "include_security_policy_include_other": {
- "type": "boolean"
- },
- "include_security_policy_include_other_val": {
- "type": "string"
- },
- "include_security_policy_iso27001": {
- "type": "boolean"
- },
- "include_security_policy_location": {
- "type": "string"
- },
- "include_security_policy_pci1": {
- "type": "boolean"
- },
- "include_security_policy_pci2": {
- "type": "boolean"
- },
- "include_security_policy_penetration_testing": {
- "type": "boolean"
- },
- "include_security_policy_soc2_type1": {
- "type": "boolean"
- },
- "include_security_policy_soc2_type2": {
- "type": "boolean"
- },
- "include_security_policy_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_unlimited_claims": {
- "type": "boolean"
- },
- "include_unlimited_claims_breach_of_confidentiality": {
- "type": "boolean"
- },
- "include_unlimited_claims_breach_of_confidentiality_negligence": {
- "type": "boolean"
- },
- "include_unlimited_claims_breach_of_privsec": {
- "type": "boolean"
- },
- "include_unlimited_claims_breach_of_privsec_negligence": {
- "type": "boolean"
- },
- "include_unlimited_claims_include_other": {
- "type": "boolean"
- },
- "include_unlimited_claims_indemnification_obligation": {
- "type": "boolean"
- },
- "include_unlimited_claims_negligence": {
- "type": "boolean"
- },
- "include_unlimited_claims_other": {
- "type": "string"
- },
- "increased_cap_amount_currency": {
- "type": "number"
- },
- "increased_cap_amount_period_currency": {
- "type": "number"
- },
- "increased_cap_amount_period_qty": {
- "type": "number"
- },
- "increased_cap_amount_qty": {
- "type": "number"
- },
- "increased_cap_amount_type": {
- "enum": [
- "qty",
- "currency",
- "period"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- "psa_statement_of_work_attributes": {
- "additionalProperties": false,
- "description": "Override psa statement of work terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "additional_changes": {
- "type": "string"
- },
- "cost": {
- "type": "number"
- },
- "description": {
- "type": "string"
- },
- "fee_type": {
- "type": "string"
- },
- "fees_attributes": {
- "additionalProperties": {
- "anyOf": [
- {
- "additionalProperties": false,
- "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": "string"
- },
- "include_deliverables": {
- "type": "boolean"
- },
- "include_deliverables_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_deliverables_description": {
- "type": "string"
- },
- "include_deliverables_include_acceptance": {
- "type": "boolean"
- },
- "include_deliverables_include_attachment": {
- "type": "boolean"
- },
- "include_deliverables_include_draft_deliverables": {
- "type": "boolean"
- },
- "include_deliverables_rejection_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_deliverables_rejection_unit": {
- "enum": [
- "hours",
- "days",
- "weeks",
- "months"
- ],
- "type": "string"
- },
- "include_deliverables_resubmission_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_deliverables_resubmission_unit": {
- "enum": [
- "hours",
- "days",
- "weeks",
- "months"
- ],
- "type": "string"
- },
- "include_fees_other": {
- "type": "boolean"
- },
- "include_fees_other_val": {
- "type": "string"
- },
- "include_fees_table": {
- "type": "boolean"
- },
- "include_fees_table_total": {
- "type": "boolean"
- },
- "include_fees_travel": {
- "type": "boolean"
- },
- "include_fees_travel_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_fees_travel_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_fees_travel_val": {
- "type": "string"
- },
- "include_third_party_customer": {
- "type": "boolean"
- },
- "include_third_party_include_description": {
- "type": "boolean"
- },
- "include_third_party_include_description_val": {
- "type": "string"
- },
- "include_third_party_materials": {
- "type": "boolean"
- },
- "include_third_party_provider": {
- "type": "boolean"
- },
- "include_time_of_assignment": {
- "type": "boolean"
- },
- "include_time_of_assignment_type": {
- "enum": [
- "created",
- "paid"
- ],
- "type": "string"
- },
- "invoice_period_description": {
- "type": "string"
- },
- "negotiations_allowed": {
- "description": "When true, the recipient can propose changes to the statement of work, even when the agreement-level `negotiations_allowed` is false. This only covers the statement of work.",
- "type": "boolean"
- },
- "payment_period": {
- "type": "number"
- },
- "payment_period_other": {
- "type": "string"
- },
- "payment_period_timeframe": {
- "enum": [
- "receipt",
- "invoice",
- "Customer's receipt of invoice",
- "date of invoice"
- ],
- "type": "string"
- },
- "payment_period_type": {
- "enum": [
- "standard",
- "other"
- ],
- "type": "string"
- },
- "payment_period_unit": {
- "enum": [
- "day(s)",
- "week(s)",
- "month(s)",
- "quarter(s)",
- "year(s)"
- ],
- "type": "string"
- },
- "quantity": {
- "type": "number"
- },
- "services_description": {
- "type": "string"
- },
- "sow_date": {
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "sow_date_type": {
- "enum": [
- "signature",
- "date"
- ],
- "type": "string"
- },
- "sow_term_amount": {
- "type": "number"
- },
- "sow_term_date": {
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "sow_term_type": {
- "enum": [
- "deliverables",
- "period",
- "date"
- ],
- "type": "string"
- },
- "sow_term_unit": {
- "enum": [
- "month(s)",
- "quarter(s)",
- "year(s)"
- ],
- "type": "string"
- },
- "type": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "recipient_email": {
- "format": "email",
- "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-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_last_to_sign": {
- "description": "When true, your signer signs after the recipient.",
- "type": "boolean"
- },
- "sender_notice_email_address": {
- "description": "Email address for legal notices to the sender.",
- "format": "email",
- "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-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": {
- "enum": [
- "signature",
- "date"
- ],
- "type": "string"
- },
- "general_cap_amount": {
- "type": "number"
- },
- "general_cap_amount_type": {
- "enum": [
- "preceding",
- "base",
- "period"
- ],
- "type": "string"
- },
- "general_cap_period_currency": {
- "type": "number"
- },
- "general_cap_period_qty": {
- "type": "number"
- },
- "general_cap_preceding_amount": {
- "type": "number"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_additional_warranties": {
- "type": "boolean"
- },
- "include_additional_warranties_by_customer": {
- "type": "string"
- },
- "include_additional_warranties_by_provider": {
- "type": "string"
- },
- "include_additional_warranties_include_by_customer": {
- "type": "boolean"
- },
- "include_additional_warranties_include_by_provider": {
- "type": "boolean"
- },
- "include_ai_addendum": {
- "type": "boolean"
- },
- "include_ai_addendum_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_covered_claims": {
- "type": "boolean"
- },
- "include_covered_claims_customer_claims": {
- "type": "string"
- },
- "include_covered_claims_include_customer_claims": {
- "type": "boolean"
- },
- "include_covered_claims_include_provider_claims": {
- "type": "boolean"
- },
- "include_covered_claims_provider_claims": {
- "type": "string"
- },
- "include_dpa": {
- "type": "boolean"
- },
- "include_dpa_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_dpa_location": {
- "type": "string"
- },
- "include_dpa_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_increased_cap_amount": {
- "type": "boolean"
- },
- "include_increased_claims": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_confidentiality": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_confidentiality_negligence": {
- "type": "boolean"
- },
- "include_increased_claims_include_other": {
- "type": "boolean"
- },
- "include_increased_claims_indemnification_obligation": {
- "type": "boolean"
- },
- "include_increased_claims_negligence": {
- "type": "boolean"
- },
- "include_increased_claims_other": {
- "type": "string"
- },
- "include_increased_claims_restrictions": {
- "type": "boolean"
- },
- "include_unlimited_claims": {
- "type": "boolean"
- },
- "include_unlimited_claims_breach_of_confidentiality": {
- "type": "boolean"
- },
- "include_unlimited_claims_breach_of_confidentiality_negligence": {
- "type": "boolean"
- },
- "include_unlimited_claims_include_other": {
- "type": "boolean"
- },
- "include_unlimited_claims_indemnification_obligation": {
- "type": "boolean"
- },
- "include_unlimited_claims_license_or_restrictions": {
- "type": "boolean"
- },
- "include_unlimited_claims_negligence": {
- "type": "boolean"
- },
- "include_unlimited_claims_other": {
- "type": "string"
- },
- "increased_cap_amount_currency": {
- "type": "number"
- },
- "increased_cap_amount_period_currency": {
- "type": "number"
- },
- "increased_cap_amount_period_qty": {
- "type": "number"
- },
- "increased_cap_amount_qty": {
- "type": "number"
- },
- "increased_cap_amount_type": {
- "enum": [
- "qty",
- "currency",
- "period"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- "software_license_order_form_attributes": {
- "additionalProperties": false,
- "description": "Override software license order form terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "additional_changes": {
- "type": "string"
- },
- "deletion_procedure_include_custom": {
- "type": "boolean"
- },
- "deletion_procedure_include_custom_description": {
- "type": "string"
- },
- "deletion_procedure_include_customer_disable": {
- "type": "boolean"
- },
- "deletion_procedure_include_customer_proof": {
- "type": "boolean"
- },
- "deletion_procedure_include_provider_disable": {
- "type": "boolean"
- },
- "fee_custom_unit": {
- "type": "string"
- },
- "fee_period": {
- "enum": [
- "Subscription Period",
- "month",
- "year",
- "Custom unit"
- ],
- "type": "string"
- },
- "fees_attributes": {
- "additionalProperties": {
- "anyOf": [
- {
- "additionalProperties": false,
- "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": {
- "enum": [
- "USD",
- "EUR",
- "GBP",
- "CAD",
- "AUD",
- "SGD",
- "ILS",
- "JPY",
- "CHF",
- "HKD"
- ],
- "type": "string"
- },
- "fees_include_fee_increase_upon_renewal": {
- "type": "boolean"
- },
- "fees_include_fee_increase_upon_renewal_fee": {
- "type": "number"
- },
- "fees_include_fee_increase_upon_renewal_type": {
- "enum": [
- "will",
- "may"
- ],
- "type": "string"
- },
- "fees_inclusive_of_taxes": {
- "type": "boolean"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_additional_changes": {
- "type": "boolean"
- },
- "include_license_compliance_verification": {
- "type": "boolean"
- },
- "include_license_compliance_verification_description": {
- "type": "string"
- },
- "include_license_limits": {
- "type": "boolean"
- },
- "include_license_limits_description": {
- "type": "string"
- },
- "include_payment_process_include_billing_email": {
- "type": "boolean"
- },
- "include_pilot_period": {
- "type": "boolean"
- },
- "include_pilot_period_duration_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_pilot_period_duration_type": {
- "enum": [
- "day",
- "week",
- "month"
- ],
- "type": "string"
- },
- "include_pilot_period_include_fees": {
- "type": "boolean"
- },
- "include_pilot_period_include_fees_amount": {
- "type": "number"
- },
- "include_pilot_period_include_modifications": {
- "type": "boolean"
- },
- "include_pilot_period_include_modifications_description": {
- "type": "string"
- },
- "include_services": {
- "type": "boolean"
- },
- "include_services_description": {
- "type": "string"
- },
- "negotiations_allowed": {
- "description": "When true, the recipient can propose changes to the order form, even when the agreement-level `negotiations_allowed` is false. This only covers the order form.",
- "type": "boolean"
- },
- "order_date_date": {
- "type": "string"
- },
- "order_date_type": {
- "enum": [
- "signature",
- "date",
- "other"
- ],
- "type": "string"
- },
- "payment_process_automatic_frequency": {
- "enum": [
- "monthly",
- "quarterly",
- "semiannually",
- "annually"
- ],
- "type": "string"
- },
- "payment_process_type": {
- "enum": [
- "automatic",
- "invoice",
- "custom"
- ],
- "type": "string"
- },
- "payment_process_type_custom_val": {
- "type": "string"
- },
- "payment_process_type_invoice_amount": {
- "type": "number"
- },
- "payment_process_type_invoice_custom_unit": {
- "type": "string"
- },
- "payment_process_type_invoice_duration": {
- "enum": [
- "day",
- "week",
- "month",
- "year",
- "day(s)",
- "week(s)",
- "month(s)",
- "year(s)"
- ],
- "type": "string"
- },
- "payment_process_type_invoice_duration_start": {
- "enum": [
- "Customer's receipt of invoice",
- "date of invoice"
- ],
- "type": "string"
- },
- "payment_process_type_invoice_type": {
- "enum": [
- "monthly",
- "quarterly",
- "semiannually",
- "annually",
- "Custom unit"
- ],
- "type": "string"
- },
- "permitted_uses_include_custom": {
- "type": "boolean"
- },
- "permitted_uses_include_custom_description": {
- "type": "string"
- },
- "permitted_uses_include_customers_affiliates": {
- "type": "boolean"
- },
- "permitted_uses_include_internal_business": {
- "type": "boolean"
- },
- "pilot_period_stripe_product_id": {
- "type": "string"
- },
- "software_description": {
- "type": "string"
- },
- "subscription_auto_renew": {
- "enum": [
- "days",
- "subscription_end"
- ],
- "type": "string"
- },
- "subscription_period": {
- "type": "number"
- },
- "subscription_period_unit": {
- "type": "string"
- },
- "subscription_renewal_notice_days": {
- "type": "number"
- },
- "warranty_period_description_amount": {
- "type": "number"
- },
- "warranty_period_description_duration": {
- "enum": [
- "day",
- "week",
- "month",
- "year"
- ],
- "type": "string"
- },
- "warranty_period_description_duration_start": {
- "enum": [
- "initial delivery of the Software",
- "delivery of the Software and each subsequent Update",
- "the Order Date"
- ],
- "type": "string"
- },
- "warranty_period_type": {
- "enum": [
- "description",
- "none"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- "test_agreement": {
- "description": "When true, marks the agreement as a test. Test agreements do not count against your monthly limit.",
- "type": "boolean"
- }
- },
- "required": [
- "recipient_name",
- "recipient_email"
- ],
- "type": "object"
- },
- "cc_users": {
- "items": {
- "format": "email",
- "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
- "type": "string"
- },
- "type": "array"
- },
- "draft": {
- "description": "When true, the agreement is saved as a draft and not sent to the recipient. Use POST /v1/agreements/{id}/send to send a draft agreement later.",
- "type": "boolean"
- },
- "owner_id": {
- "description": "User id of the agreement owner (sender).",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "signer_id": {
- "description": "User id of the signer from the owner's organization.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "template_id": {
- "description": "UUID of a template from `GET /v1/templates`. Accepts both Common Paper standard templates and uploaded PDF templates (`type` `uploaded_template`).",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- }
- },
- "required": [
- "template_id",
- "owner_id",
- "signer_id",
- "agreement"
- ],
- "type": "object"
- }
-]New value: +[
+ {
+ "additionalProperties": false,
+ "properties": {
+ "agreement": {
+ "additionalProperties": {},
+ "properties": {
+ "amendment_attributes": {
+ "additionalProperties": false,
+ "description": "Override amendment terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "amended_terms_attributes": {
+ "additionalProperties": {
+ "additionalProperties": false,
+ "properties": {
+ "description": {
+ "type": "string"
+ },
+ "term": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "description": "Amended terms. Use string keys such as \"0\", \"1\".",
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+ },
+ "amendment_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "amendment_date_type": {
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "type": "string"
+ },
+ "framework_terms_type": {
+ "type": "string"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "parent_agreement_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "underlying_agreement_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "underlying_agreement_type": {
+ "type": "string"
+ },
+ "underlying_agreement_val": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "baa_attributes": {
+ "additionalProperties": false,
+ "description": "Override baa terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "aggregation_limitations_permitted": {
+ "type": "boolean"
+ },
+ "aggregation_limitations_permitted_val": {
+ "type": "string"
+ },
+ "breach_notification_unit": {
+ "enum": [
+ "hours",
+ "business days",
+ "calendar days"
+ ],
+ "type": "string"
+ },
+ "breach_notification_val": {
+ "type": "number"
+ },
+ "business_associate_relationship_type": {
+ "enum": [
+ "provider",
+ "company"
+ ],
+ "type": "string"
+ },
+ "deidentification_limitations_include_purpose": {
+ "type": "boolean"
+ },
+ "deidentification_limitations_include_requirements": {
+ "type": "boolean"
+ },
+ "deidentification_limitations_permitted": {
+ "type": "boolean"
+ },
+ "deidentification_limitations_purpose_val": {
+ "type": "string"
+ },
+ "deidentification_limitations_requirements_val": {
+ "type": "string"
+ },
+ "designated_record_set_provider_maintains": {
+ "type": "boolean"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_aggregation_limitations": {
+ "type": "boolean"
+ },
+ "include_deidentification_limitations": {
+ "type": "boolean"
+ },
+ "include_limitations": {
+ "type": "boolean"
+ },
+ "include_offshore_limitations": {
+ "type": "boolean"
+ },
+ "include_subcontract_limitations": {
+ "type": "boolean"
+ },
+ "offshore_limitations_permitted": {
+ "type": "boolean"
+ },
+ "offshore_limitations_permitted_val": {
+ "type": "string"
+ },
+ "subcontract_limitations_include_notice": {
+ "type": "boolean"
+ },
+ "subcontract_limitations_include_permission": {
+ "type": "boolean"
+ },
+ "subcontract_limitations_notice_val": {
+ "type": "string"
+ },
+ "subcontract_limitations_permission_val": {
+ "type": "string"
+ },
+ "subcontract_limitations_permitted": {
+ "type": "boolean"
+ },
+ "underlying_agreement_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "underlying_agreement_type": {
+ "enum": [
+ "internal",
+ "external",
+ "none"
+ ],
+ "type": "string"
+ },
+ "underlying_agreement_val": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "billing_email": {
+ "description": "Email of the billing contact. Used when include_billing_info is true.",
+ "format": "email",
+ "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "billing_name": {
+ "description": "Name of the billing contact. Used when include_billing_info is true.",
+ "type": "string"
+ },
+ "billing_workflow_type": {
+ "description": "The type of billing workflow. Use \"link\" to provide a payment_link_url, or \"stripe\" for Stripe-managed billing.",
+ "enum": [
+ "link",
+ "stripe"
+ ],
+ "type": "string"
+ },
+ "chosen_courts_country": {
+ "description": "The country in which disputes will be resolved.",
+ "type": "string"
+ },
+ "chosen_courts_region": {
+ "description": "The state or region in which disputes will be resolved.",
+ "type": "string"
+ },
+ "csa_attributes": {
+ "additionalProperties": false,
+ "description": "Override csa terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "customer_description": {
+ "type": "string"
+ },
+ "effective_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "effective_date_marketplace": {
+ "enum": [
+ "AWS",
+ "GCP",
+ "Azure"
+ ],
+ "type": "string"
+ },
+ "effective_date_type": {
+ "enum": [
+ "signature",
+ "date",
+ "marketplace_acceptance"
+ ],
+ "type": "string"
+ },
+ "general_cap_amount": {
+ "type": "number"
+ },
+ "general_cap_amount_type": {
+ "enum": [
+ "preceding",
+ "base",
+ "period"
+ ],
+ "type": "string"
+ },
+ "general_cap_period_currency": {
+ "type": "number"
+ },
+ "general_cap_period_qty": {
+ "type": "number"
+ },
+ "general_cap_preceding_amount": {
+ "type": "number"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_acceptable_use_policy": {
+ "type": "boolean"
+ },
+ "include_acceptable_use_policy_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_acceptable_use_policy_location": {
+ "type": "string"
+ },
+ "include_acceptable_use_policy_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_additional_warranties": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_by_customer": {
+ "type": "string"
+ },
+ "include_additional_warranties_by_provider": {
+ "type": "string"
+ },
+ "include_additional_warranties_include_by_customer": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_include_by_provider": {
+ "type": "boolean"
+ },
+ "include_ai_addendum": {
+ "type": "boolean"
+ },
+ "include_ai_addendum_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_covered_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_customer_claims": {
+ "type": "string"
+ },
+ "include_covered_claims_include_customer_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_include_provider_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_provider_claims": {
+ "type": "string"
+ },
+ "include_dpa": {
+ "type": "boolean"
+ },
+ "include_dpa_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_dpa_location": {
+ "type": "string"
+ },
+ "include_dpa_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_increased_cap_amount": {
+ "type": "boolean"
+ },
+ "include_increased_claims": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_confidentiality": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_confidentiality_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_privsec": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_privsec_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_other": {
+ "type": "boolean"
+ },
+ "include_increased_claims_indemnification_obligation": {
+ "type": "boolean"
+ },
+ "include_increased_claims_other": {
+ "type": "string"
+ },
+ "include_insurance_minimums": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_add_customer": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_add_customer_com_gen_liability": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_add_customer_cyber_liability": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_add_customer_errors_omissions": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_additional_information": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_additional_information_text": {
+ "type": "string"
+ },
+ "include_insurance_minimums_cyber_liability_aggregate": {
+ "type": "number"
+ },
+ "include_insurance_minimums_cyber_liability_minimum": {
+ "type": "number"
+ },
+ "include_insurance_minimums_employer_liability_aggregate": {
+ "type": "number"
+ },
+ "include_insurance_minimums_employer_liability_minimum": {
+ "type": "number"
+ },
+ "include_insurance_minimums_general_liability_aggregate": {
+ "type": "number"
+ },
+ "include_insurance_minimums_general_liability_minimum": {
+ "type": "number"
+ },
+ "include_insurance_minimums_include_cyber_liability": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_include_employer_liability": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_include_general_liability": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_include_workers_compensation": {
+ "type": "boolean"
+ },
+ "include_publicity_rights": {
+ "type": "boolean"
+ },
+ "include_publicity_rights_type": {
+ "enum": [
+ "public",
+ "non-public"
+ ],
+ "type": "string"
+ },
+ "include_security_policy": {
+ "type": "boolean"
+ },
+ "include_security_policy_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_security_policy_fedramp_auth": {
+ "type": "boolean"
+ },
+ "include_security_policy_hipaa": {
+ "type": "boolean"
+ },
+ "include_security_policy_hitrust": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_annual_maintenance": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_location": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_other": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_reasonable_efforts": {
+ "type": "boolean"
+ },
+ "include_security_policy_iso27001": {
+ "type": "boolean"
+ },
+ "include_security_policy_location": {
+ "type": "string"
+ },
+ "include_security_policy_other": {
+ "type": "string"
+ },
+ "include_security_policy_pci1": {
+ "type": "boolean"
+ },
+ "include_security_policy_pci2": {
+ "type": "boolean"
+ },
+ "include_security_policy_penetration_testing": {
+ "type": "boolean"
+ },
+ "include_security_policy_soc2": {
+ "type": "boolean"
+ },
+ "include_security_policy_soc2_type2": {
+ "type": "boolean"
+ },
+ "include_security_policy_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_supercap": {
+ "description": "CSA 3.0 renamed `include_increased_cap_amount` to `include_supercap`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_increased_cap_amount`. Sending the other spelling returns a 422.",
+ "type": "boolean"
+ },
+ "include_uncapped_claims": {
+ "description": "CSA 3.0 renamed `include_unlimited_claims` to `include_uncapped_claims`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims`. Sending the other spelling returns a 422.",
+ "type": "boolean"
+ },
+ "include_uncapped_claims_breach_of_confidentiality": {
+ "description": "CSA 3.0 renamed `include_unlimited_claims_breach_of_confidentiality` to `include_uncapped_claims_breach_of_confidentiality`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_breach_of_confidentiality`. Sending the other spelling returns a 422.",
+ "type": "boolean"
+ },
+ "include_uncapped_claims_breach_of_confidentiality_negligence": {
+ "description": "CSA 3.0 renamed `include_unlimited_claims_breach_of_confidentiality_negligence` to `include_uncapped_claims_breach_of_confidentiality_negligence`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_breach_of_confidentiality_negligence`. Sending the other spelling returns a 422.",
+ "type": "boolean"
+ },
+ "include_uncapped_claims_breach_of_privsec": {
+ "description": "CSA 3.0 renamed `include_unlimited_claims_breach_of_privsec` to `include_uncapped_claims_breach_of_privsec`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_breach_of_privsec`. Sending the other spelling returns a 422.",
+ "type": "boolean"
+ },
+ "include_uncapped_claims_breach_of_privsec_negligence": {
+ "description": "CSA 3.0 renamed `include_unlimited_claims_breach_of_privsec_negligence` to `include_uncapped_claims_breach_of_privsec_negligence`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_breach_of_privsec_negligence`. Sending the other spelling returns a 422.",
+ "type": "boolean"
+ },
+ "include_uncapped_claims_include_other": {
+ "description": "CSA 3.0 renamed `include_unlimited_claims_include_other` to `include_uncapped_claims_include_other`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_include_other`. Sending the other spelling returns a 422.",
+ "type": "boolean"
+ },
+ "include_uncapped_claims_indemnification_obligation": {
+ "description": "CSA 3.0 renamed `include_unlimited_claims_indemnification_obligation` to `include_uncapped_claims_indemnification_obligation`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_indemnification_obligation`. Sending the other spelling returns a 422.",
+ "type": "boolean"
+ },
+ "include_uncapped_claims_other": {
+ "description": "CSA 3.0 renamed `include_unlimited_claims_other` to `include_uncapped_claims_other`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_other`. Sending the other spelling returns a 422.",
+ "type": "boolean"
+ },
+ "include_unlimited_claims": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_confidentiality": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_confidentiality_negligence": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_privsec": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_privsec_negligence": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_include_other": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_indemnification_obligation": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_other": {
+ "type": "string"
+ },
+ "increased_cap_amount_currency": {
+ "type": "number"
+ },
+ "increased_cap_amount_period_currency": {
+ "type": "number"
+ },
+ "increased_cap_amount_period_qty": {
+ "type": "number"
+ },
+ "increased_cap_amount_qty": {
+ "type": "number"
+ },
+ "increased_cap_amount_type": {
+ "enum": [
+ "qty",
+ "currency",
+ "period"
+ ],
+ "type": "string"
+ },
+ "provider": {
+ "type": "string"
+ },
+ "supercap_currency": {
+ "description": "CSA 3.0 renamed `increased_cap_amount_currency` to `supercap_currency`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `increased_cap_amount_currency`. Sending the other spelling returns a 422.",
+ "type": "number"
+ },
+ "supercap_period_currency": {
+ "description": "CSA 3.0 renamed `increased_cap_amount_period_currency` to `supercap_period_currency`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `increased_cap_amount_period_currency`. Sending the other spelling returns a 422.",
+ "type": "number"
+ },
+ "supercap_period_qty": {
+ "description": "CSA 3.0 renamed `increased_cap_amount_period_qty` to `supercap_period_qty`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `increased_cap_amount_period_qty`. Sending the other spelling returns a 422.",
+ "type": "number"
+ },
+ "supercap_qty": {
+ "description": "CSA 3.0 renamed `increased_cap_amount_qty` to `supercap_qty`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `increased_cap_amount_qty`. Sending the other spelling returns a 422.",
+ "type": "number"
+ },
+ "supercap_type": {
+ "description": "CSA 3.0 renamed `increased_cap_amount_type` to `supercap_type`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `increased_cap_amount_type`. Sending the other spelling returns a 422.",
+ "type": "number"
+ }
+ },
+ "type": "object"
+ },
+ "csa_order_form_attributes": {
+ "additionalProperties": false,
+ "description": "Override csa order form terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "additional_changes": {
+ "type": "string"
+ },
+ "additional_parameters_or_limitations": {
+ "type": "string"
+ },
+ "affiliates_as_users": {
+ "type": "boolean"
+ },
+ "cloud_service_description": {
+ "type": "string"
+ },
+ "consumption_units": {
+ "type": "string"
+ },
+ "fee_amount": {
+ "type": "number"
+ },
+ "fee_custom_unit": {
+ "type": "string"
+ },
+ "fee_period": {
+ "enum": [
+ "Subscription Period",
+ "month",
+ "year",
+ "User",
+ "Custom unit"
+ ],
+ "type": "string"
+ },
+ "fees_attributes": {
+ "additionalProperties": {
+ "anyOf": [
+ {
+ "additionalProperties": false,
+ "description": "Fees::Flat (fee_type \"flat\"). A fixed recurring fee, e.g. a platform subscription. Set type to \"Fees::Flat\" or fee_type to \"flat\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Fixed amount in the order form's fees_currency, charged per fee_period. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"flat\". Alternative to type.",
+ "enum": [
+ "flat"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Flat\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Flat"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Discount (fee_type \"discount\"). A discount, as a fixed amount or a percentage, applied forever, once, or for a number of months. Set type to \"Fees::Discount\" or fee_type to \"discount\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Discount size: an amount in fees_currency when discount_type is fixed_amount (a plain amount, not cents: 20 means 20.00), or a percentage (e.g. 10 for 10%) when it is percentage.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "discount_duration_amount": {
+ "description": "Number of months the discount applies. Required when discount_duration_type is multiple_months.",
+ "type": "number"
+ },
+ "discount_duration_type": {
+ "description": "How long the discount applies. multiple_months also needs discount_duration_amount.",
+ "enum": [
+ "forever",
+ "once",
+ "multiple_months"
+ ],
+ "type": "string"
+ },
+ "discount_type": {
+ "description": "Whether cost is a currency amount or a percentage.",
+ "enum": [
+ "fixed_amount",
+ "percentage"
+ ],
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"discount\". Alternative to type.",
+ "enum": [
+ "discount"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Discount\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Discount"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Cost (fee_type \"cost\"). A per-unit fee: price per unit times quantity, e.g. seats. Set type to \"Fees::Cost\" or fee_type to \"cost\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Price per unit in fees_currency. The row total is quantity x cost. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"cost\". Alternative to type.",
+ "enum": [
+ "cost"
+ ],
+ "type": "string"
+ },
+ "quantity": {
+ "description": "Number of units.",
+ "type": "number"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Cost\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Cost"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Attachment (fee_type \"attachment\"). A fee described in an uploaded attachment instead of in the table. Set type to \"Fees::Attachment\" or fee_type to \"attachment\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "attachment_id": {
+ "description": "ID of an attachment uploaded with upload-attachment.",
+ "type": "string"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"attachment\". Alternative to type.",
+ "enum": [
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Attachment\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Attachment"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Graduated (fee_type \"graduated\"). Tiered pricing, with the price set per tier in graduated_fee_tiers_attributes. Set type to \"Fees::Graduated\" or fee_type to \"graduated\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"graduated\". Alternative to type.",
+ "enum": [
+ "graduated"
+ ],
+ "type": "string"
+ },
+ "graduated_fee_tiers_attributes": {
+ "additionalProperties": {
+ "additionalProperties": false,
+ "properties": {
+ "flat_price": {
+ "type": "number"
+ },
+ "price_per_unit": {
+ "type": "string"
+ },
+ "upper_limit": {
+ "type": "number"
+ }
+ },
+ "type": "object"
+ },
+ "description": "Graduated fee tiers. Use string keys such as \"0\", \"1\".",
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Graduated\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Graduated"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Included (fee_type \"included\"). An item included at no charge. Set type to \"Fees::Included\" or fee_type to \"included\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"included\". Alternative to type.",
+ "enum": [
+ "included"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Included\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Included"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Metered (fee_type \"metered\"). Usage-based pricing, billed per unit used. Set type to \"Fees::Metered\" or fee_type to \"metered\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Price per unit of usage in fees_currency. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"metered\". Alternative to type.",
+ "enum": [
+ "metered"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Metered\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Metered"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::OneTime (fee_type \"one_time\"). A one-time charge, such as a setup fee. Set type to \"Fees::OneTime\" or fee_type to \"one_time\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "One-time amount in fees_currency, charged once rather than per fee_period. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"one_time\". Alternative to type.",
+ "enum": [
+ "one_time"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::OneTime\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::OneTime"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Text (fee_type \"text\"). A fee term described in free text. Set type to \"Fees::Text\" or fee_type to \"text\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"text\". Alternative to type.",
+ "enum": [
+ "text"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Text\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Text"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ }
+ ]
+ },
+ "description": "Fee table rows, keyed by string index (\"0\", \"1\", ...). Replaces the template's fees when provided. Each row sets type or fee_type to pick the fee class. Amounts are in the order form's fees_currency and, for recurring fees, are charged per fee_period.",
+ "examples": [
+ {
+ "0": {
+ "cost": 2000,
+ "description": "Platform subscription",
+ "type": "Fees::Flat"
+ }
+ },
+ {
+ "0": {
+ "cost": 50,
+ "description": "Seats",
+ "fee_type": "cost",
+ "quantity": 10
+ },
+ "1": {
+ "cost": 10,
+ "description": "Launch discount",
+ "discount_duration_amount": 3,
+ "discount_duration_type": "multiple_months",
+ "discount_type": "percentage",
+ "fee_type": "discount"
+ }
+ }
+ ],
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+ },
+ "fees_currency": {
+ "enum": [
+ "USD",
+ "EUR",
+ "GBP",
+ "CAD",
+ "AUD",
+ "SGD",
+ "ILS",
+ "JPY",
+ "CHF",
+ "HKD"
+ ],
+ "type": "string"
+ },
+ "fees_include_fee_increase_upon_renewal": {
+ "type": "boolean"
+ },
+ "fees_include_fee_increase_upon_renewal_fee": {
+ "type": "number"
+ },
+ "fees_include_fee_increase_upon_renewal_type": {
+ "enum": [
+ "will",
+ "may"
+ ],
+ "type": "string"
+ },
+ "fees_inclusive_of_taxes": {
+ "type": "boolean"
+ },
+ "framework_terms_type": {
+ "enum": [
+ "new",
+ "existing",
+ "description"
+ ],
+ "type": "string"
+ },
+ "free_trial_days": {
+ "type": "number"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_additional_changes": {
+ "type": "boolean"
+ },
+ "include_additional_parameters_or_limitations": {
+ "type": "boolean"
+ },
+ "include_consumption": {
+ "type": "boolean"
+ },
+ "include_fees": {
+ "type": "boolean"
+ },
+ "include_fees_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_fees_include_attachment": {
+ "type": "boolean"
+ },
+ "include_fees_other": {
+ "type": "boolean"
+ },
+ "include_fees_other_val": {
+ "type": "string"
+ },
+ "include_fees_table": {
+ "type": "boolean"
+ },
+ "include_fees_table_period": {
+ "enum": [
+ "Subscription Period",
+ "month",
+ "year",
+ "User"
+ ],
+ "type": "string"
+ },
+ "include_free_trial": {
+ "type": "boolean"
+ },
+ "include_max_users": {
+ "type": "boolean"
+ },
+ "include_pilot_period": {
+ "type": "boolean"
+ },
+ "include_pilot_period_duration_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_pilot_period_duration_type": {
+ "enum": [
+ "day",
+ "week",
+ "month"
+ ],
+ "type": "string"
+ },
+ "include_pilot_period_include_fees": {
+ "type": "boolean"
+ },
+ "include_pilot_period_include_fees_amount": {
+ "type": "number"
+ },
+ "include_pilot_period_include_modifications": {
+ "type": "boolean"
+ },
+ "include_pilot_period_include_modifications_description": {
+ "type": "string"
+ },
+ "include_product_support": {
+ "type": "boolean"
+ },
+ "include_product_support_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_product_support_description": {
+ "type": "string"
+ },
+ "include_product_support_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_professional_services": {
+ "type": "boolean"
+ },
+ "include_professional_services_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_professional_services_custom_name": {
+ "type": "string"
+ },
+ "include_professional_services_description": {
+ "type": "string"
+ },
+ "include_professional_services_end_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "include_professional_services_fees_description": {
+ "type": "string"
+ },
+ "include_professional_services_include_end_date": {
+ "type": "boolean"
+ },
+ "include_professional_services_include_fees_description": {
+ "type": "boolean"
+ },
+ "include_professional_services_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_sla": {
+ "type": "boolean"
+ },
+ "include_sla_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_sla_description": {
+ "type": "string"
+ },
+ "include_sla_include_response_time": {
+ "type": "boolean"
+ },
+ "include_sla_include_response_time_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_sla_include_response_time_credit": {
+ "type": "number"
+ },
+ "include_sla_include_response_time_duration": {
+ "enum": [
+ "hour",
+ "day",
+ "week",
+ "month",
+ "hours"
+ ],
+ "type": "string"
+ },
+ "include_sla_include_response_time_support_channel": {
+ "type": "string"
+ },
+ "include_sla_include_target_uptime": {
+ "type": "boolean"
+ },
+ "include_sla_maintenance_notice": {
+ "type": "boolean"
+ },
+ "include_sla_maintenance_window": {
+ "type": "boolean"
+ },
+ "include_sla_maintenance_window_type": {
+ "enum": [
+ "standard",
+ "none"
+ ],
+ "type": "string"
+ },
+ "include_sla_standard_maintenance_notice_qty": {
+ "type": "number"
+ },
+ "include_sla_standard_maintenance_notice_unit": {
+ "enum": [
+ "hour",
+ "day",
+ "week",
+ "month"
+ ],
+ "type": "string"
+ },
+ "include_sla_standard_maintenance_window_end_time": {
+ "type": "string"
+ },
+ "include_sla_standard_maintenance_window_friday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_monday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_saturday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_start_time": {
+ "type": "string"
+ },
+ "include_sla_standard_maintenance_window_sunday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_thursday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_time_zone": {
+ "type": "string"
+ },
+ "include_sla_standard_maintenance_window_tuesday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_wednesday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_target_uptime": {
+ "type": "number"
+ },
+ "include_sla_type": {
+ "enum": [
+ "description",
+ "standard",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_subscription_start_date": {
+ "type": "boolean"
+ },
+ "include_subscription_start_date_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "include_usage_review": {
+ "type": "boolean"
+ },
+ "include_usage_review_val": {
+ "type": "string"
+ },
+ "include_use_limitations": {
+ "type": "boolean"
+ },
+ "include_use_limitations_val": {
+ "type": "string"
+ },
+ "invoice_period": {
+ "enum": [
+ "monthly",
+ "quarterly",
+ "semiannually",
+ "annually",
+ "Custom unit",
+ "Monthly",
+ "Quarterly",
+ "Semiannually",
+ "Annually"
+ ],
+ "type": "string"
+ },
+ "invoice_period_custom_unit": {
+ "type": "string"
+ },
+ "max_consumption": {
+ "type": "number"
+ },
+ "max_users": {
+ "type": "number"
+ },
+ "negotiations_allowed": {
+ "description": "When true, the recipient can propose changes to the order form, even when the agreement-level `negotiations_allowed` is false. This only covers the order form.",
+ "type": "boolean"
+ },
+ "order_date_date": {
+ "type": "string"
+ },
+ "order_date_other": {
+ "type": "string"
+ },
+ "order_date_type": {
+ "enum": [
+ "signature",
+ "date",
+ "other"
+ ],
+ "type": "string"
+ },
+ "payment_period": {
+ "type": "number"
+ },
+ "payment_period_timeframe": {
+ "enum": [
+ "Customer's receipt of invoice",
+ "date of invoice"
+ ],
+ "type": "string"
+ },
+ "payment_period_unit": {
+ "enum": [
+ "day(s)",
+ "week(s)",
+ "month(s)",
+ "marketplace_acceptance"
+ ],
+ "type": "string"
+ },
+ "payment_process_automatic_frequency": {
+ "enum": [
+ "monthly",
+ "quarterly",
+ "semiannually",
+ "annually"
+ ],
+ "type": "string"
+ },
+ "payment_process_type": {
+ "enum": [
+ "automatic",
+ "invoice",
+ "custom",
+ "marketplace_acceptance"
+ ],
+ "type": "string"
+ },
+ "payment_process_type_custom_val": {
+ "type": "string"
+ },
+ "payment_process_type_invoice_amount": {
+ "type": "number"
+ },
+ "payment_process_type_invoice_custom_unit": {
+ "type": "string"
+ },
+ "payment_process_type_invoice_duration": {
+ "enum": [
+ "day",
+ "week",
+ "month",
+ "year",
+ "day(s)",
+ "week(s)",
+ "month(s)",
+ "year(s)"
+ ],
+ "type": "string"
+ },
+ "payment_process_type_invoice_duration_start": {
+ "enum": [
+ "Customer's receipt of invoice",
+ "date of invoice"
+ ],
+ "type": "string"
+ },
+ "payment_process_type_invoice_type": {
+ "enum": [
+ "monthly",
+ "quarterly",
+ "semiannually",
+ "annually",
+ "Custom unit"
+ ],
+ "type": "string"
+ },
+ "pilot_period_stripe_product_id": {
+ "type": "string"
+ },
+ "service_credits_attributes": {
+ "additionalProperties": {
+ "additionalProperties": false,
+ "properties": {
+ "credit": {
+ "type": "number"
+ },
+ "max": {
+ "type": "number"
+ },
+ "min": {
+ "type": "number"
+ }
+ },
+ "type": "object"
+ },
+ "description": "Service credits. Use string keys such as \"0\", \"1\".",
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+ },
+ "subscription_auto_renew": {
+ "enum": [
+ "days",
+ "subscription_end"
+ ],
+ "type": "string"
+ },
+ "subscription_period": {
+ "type": "number"
+ },
+ "subscription_period_unit": {
+ "type": "string"
+ },
+ "subscription_renewal_notice_days": {
+ "type": "number"
+ },
+ "subscription_start_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "subscription_start_date_type": {
+ "enum": [
+ "effective_date",
+ "date"
+ ],
+ "type": "string"
+ },
+ "underlying_agreement_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "use_limitations_attributes": {
+ "additionalProperties": {
+ "additionalProperties": false,
+ "properties": {
+ "amount": {
+ "type": "number"
+ },
+ "limitation_type": {
+ "type": "string"
+ },
+ "unit": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "description": "Use limitations. Use string keys such as \"0\", \"1\".",
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+ }
+ },
+ "type": "object"
+ },
+ "custom_field_values": {
+ "description": "Values for a custom template's fields, keyed by the field keys defined in the template's YAML definition. Only used when template_id is a custom template. Template defaults fill any fields you omit; a required field with no default and no submitted value returns a 400 naming the field. Values are validated against the field's input type: select and radio values must be one of the field's options, multiselect values are an array of selections each of which must be one of the field's options, number and currency values must be numeric, date values must be YYYY-MM-DD, and email values must be valid addresses. An invalid value returns a 400 naming the field."
+ },
+ "design_partner_attributes": {
+ "additionalProperties": false,
+ "description": "Override design partner terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "customer_description": {
+ "type": "string"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_fees": {
+ "type": "boolean"
+ },
+ "include_fees_amount": {
+ "type": "number"
+ },
+ "include_fees_description": {
+ "type": "string"
+ },
+ "include_fees_pay_by_amount": {
+ "type": "string"
+ },
+ "include_fees_type": {
+ "enum": [
+ "default_language",
+ "description"
+ ],
+ "type": "string"
+ },
+ "include_fees_unit": {
+ "enum": [
+ "month",
+ "quarter",
+ "year",
+ "Term"
+ ],
+ "type": "string"
+ },
+ "include_program_appear_as_customer_private": {
+ "type": "boolean"
+ },
+ "include_program_appear_as_customer_public": {
+ "type": "boolean"
+ },
+ "include_program_case_study": {
+ "type": "boolean"
+ },
+ "include_program_develop_functionality": {
+ "type": "boolean"
+ },
+ "include_program_develop_functionality_val": {
+ "type": "string"
+ },
+ "include_program_discount": {
+ "type": "boolean"
+ },
+ "include_program_discount_amount": {
+ "type": "number"
+ },
+ "include_program_discount_unit": {
+ "enum": [
+ "U.S. Dollars",
+ "percent"
+ ],
+ "type": "string"
+ },
+ "include_program_participation_feedback": {
+ "type": "boolean"
+ },
+ "include_program_participation_feedback_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_program_participation_feedback_unit": {
+ "enum": [
+ "month",
+ "quarter",
+ "year",
+ "Term"
+ ],
+ "type": "string"
+ },
+ "include_program_partner_other": {
+ "type": "boolean"
+ },
+ "include_program_partner_other_val": {
+ "type": "string"
+ },
+ "include_program_provider_other": {
+ "type": "boolean"
+ },
+ "include_program_provider_other_val": {
+ "type": "string"
+ },
+ "include_program_reference": {
+ "type": "boolean"
+ },
+ "product_description": {
+ "type": "string"
+ },
+ "term_amount": {
+ "type": "number"
+ },
+ "term_unit": {
+ "enum": [
+ "day(s)",
+ "week(s)",
+ "month(s)",
+ "quarter(s)",
+ "year(s)"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "district_or_county": {
+ "description": "The district or county for dispute resolution.",
+ "type": "string"
+ },
+ "dpa_attributes": {
+ "additionalProperties": false,
+ "description": "Override dpa terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "approved_subprocessor_type": {
+ "description": "`internal` lists approved subprocessors in the agreement (`subprocessors_attributes`); `external` points to a list published elsewhere.",
+ "enum": [
+ "internal",
+ "external"
+ ],
+ "type": "string"
+ },
+ "cloud_service_product_name": {
+ "type": "string"
+ },
+ "competent_supervisory_authority": {
+ "type": "string"
+ },
+ "customer_description": {
+ "type": "string"
+ },
+ "data_exporter_address_city": {
+ "type": "string"
+ },
+ "data_exporter_address_country": {
+ "type": "string"
+ },
+ "data_exporter_address_state": {
+ "type": "string"
+ },
+ "data_exporter_address_street_address": {
+ "type": "string"
+ },
+ "data_exporter_address_zipcode": {
+ "type": "string"
+ },
+ "data_exporter_contact_details": {
+ "type": "string"
+ },
+ "data_exporter_contact_name": {
+ "type": "string"
+ },
+ "data_exporter_contact_position": {
+ "type": "string"
+ },
+ "data_exporter_role": {
+ "description": "Role of the data exporter. Overwritten to `Controller` when the agreement is created from a template.",
+ "enum": [
+ "Controller",
+ "Processor"
+ ],
+ "type": "string"
+ },
+ "data_importer_address": {
+ "type": "string"
+ },
+ "data_importer_address_city": {
+ "type": "string"
+ },
+ "data_importer_address_country": {
+ "type": "string"
+ },
+ "data_importer_address_state": {
+ "type": "string"
+ },
+ "data_importer_address_street_address": {
+ "type": "string"
+ },
+ "data_importer_address_zipcode": {
+ "type": "string"
+ },
+ "data_importer_contact_details": {
+ "type": "string"
+ },
+ "data_importer_contact_name": {
+ "type": "string"
+ },
+ "data_importer_contact_position": {
+ "type": "string"
+ },
+ "duration_of_processing": {
+ "type": "string"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_covered_claim": {
+ "type": "boolean"
+ },
+ "include_covered_claim_external_val": {
+ "type": "string"
+ },
+ "include_covered_claim_internal_val": {
+ "type": "string"
+ },
+ "include_covered_claim_type": {
+ "description": "Which covered-claim text applies: `internal` uses `include_covered_claim_internal_val`, `external` uses `include_covered_claim_external_val`. Required when `include_covered_claim` is true.",
+ "enum": [
+ "internal",
+ "external"
+ ],
+ "type": "string"
+ },
+ "include_data_subjects_custom": {
+ "type": "boolean"
+ },
+ "include_data_subjects_custom_val": {
+ "type": "string"
+ },
+ "include_data_subjects_employees": {
+ "type": "boolean"
+ },
+ "include_data_subjects_end_users": {
+ "type": "boolean"
+ },
+ "include_external_subprocessor_location": {
+ "type": "string"
+ },
+ "include_frequency_of_transfer_continuous": {
+ "type": "boolean"
+ },
+ "include_frequency_of_transfer_custom": {
+ "type": "boolean"
+ },
+ "include_frequency_of_transfer_custom_val": {
+ "type": "string"
+ },
+ "include_governing_country_eu": {
+ "type": "boolean"
+ },
+ "include_governing_country_eu_val": {
+ "type": "string"
+ },
+ "include_governing_country_uk": {
+ "type": "boolean"
+ },
+ "include_governing_country_uk_val": {
+ "type": "string"
+ },
+ "include_governing_law": {
+ "type": "boolean"
+ },
+ "include_governing_law_country": {
+ "type": "string"
+ },
+ "include_governing_law_state": {
+ "type": "string"
+ },
+ "include_increased_claim_amount": {
+ "description": "Legacy field. Stored but not shown on the DPA; use the `include_liability_cap*` fields instead.",
+ "type": "boolean"
+ },
+ "include_increased_claim_amount_currency": {
+ "description": "Legacy field. Stored but not shown on the DPA; use the `include_liability_cap*` fields instead."
+ },
+ "include_increased_claim_amount_qty": {
+ "description": "Legacy field. Stored but not shown on the DPA; use the `include_liability_cap*` fields instead."
+ },
+ "include_increased_claim_amount_type": {
+ "description": "Legacy field. Stored but not shown on the DPA; use the `include_liability_cap*` fields instead.",
+ "type": "string"
+ },
+ "include_liability_cap": {
+ "type": "boolean"
+ },
+ "include_liability_cap_amount_constant_external": {
+ "type": "string"
+ },
+ "include_liability_cap_amount_constant_internal": {
+ "type": "string"
+ },
+ "include_liability_cap_amount_currency_external": {
+ "description": "Currency amount. Numbers and numeric strings (commas allowed) are both accepted."
+ },
+ "include_liability_cap_amount_currency_internal": {
+ "description": "Currency amount. Numbers and numeric strings (commas allowed) are both accepted."
+ },
+ "include_liability_cap_csa_type": {
+ "description": "Which liability cap values apply: the `_internal` or `_external` amount fields. Required when `include_liability_cap` is true.",
+ "enum": [
+ "internal",
+ "external"
+ ],
+ "type": "string"
+ },
+ "include_personal_data_biographic_info": {
+ "type": "boolean"
+ },
+ "include_personal_data_contact_info": {
+ "type": "boolean"
+ },
+ "include_personal_data_custom": {
+ "type": "boolean"
+ },
+ "include_personal_data_custom_val": {
+ "type": "string"
+ },
+ "include_personal_data_employment_info": {
+ "type": "boolean"
+ },
+ "include_personal_data_financial_info": {
+ "type": "boolean"
+ },
+ "include_personal_data_location": {
+ "type": "boolean"
+ },
+ "include_personal_data_name": {
+ "type": "boolean"
+ },
+ "include_personal_data_transactional_info": {
+ "type": "boolean"
+ },
+ "include_personal_data_user_activity_info": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_custom": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_custom_val": {
+ "type": "string"
+ },
+ "include_processing_purpose_erasing": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_holding": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_protecting": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_receiving": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_returning": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_sharing": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_updating": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_using": {
+ "type": "boolean"
+ },
+ "include_provider_security_contact_address": {
+ "type": "boolean"
+ },
+ "include_provider_security_contact_address_city": {
+ "type": "string"
+ },
+ "include_provider_security_contact_address_country": {
+ "type": "string"
+ },
+ "include_provider_security_contact_address_state": {
+ "type": "string"
+ },
+ "include_provider_security_contact_address_street_address": {
+ "type": "string"
+ },
+ "include_provider_security_contact_address_zipcode": {
+ "type": "string"
+ },
+ "include_provider_security_contact_email": {
+ "type": "boolean"
+ },
+ "include_provider_security_contact_email_val": {
+ "format": "email",
+ "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "include_security_measures_accountability": {
+ "type": "boolean"
+ },
+ "include_security_measures_accountability_val": {
+ "type": "string"
+ },
+ "include_security_measures_certification_or_assurance": {
+ "type": "boolean"
+ },
+ "include_security_measures_certification_or_assurance_val": {
+ "type": "string"
+ },
+ "include_security_measures_confidentiality_integrity": {
+ "type": "boolean"
+ },
+ "include_security_measures_confidentiality_integrity_val": {
+ "type": "string"
+ },
+ "include_security_measures_data_at_rest": {
+ "type": "boolean"
+ },
+ "include_security_measures_data_at_rest_val": {
+ "type": "string"
+ },
+ "include_security_measures_data_minimization": {
+ "type": "boolean"
+ },
+ "include_security_measures_data_minimization_val": {
+ "type": "string"
+ },
+ "include_security_measures_data_quality": {
+ "type": "boolean"
+ },
+ "include_security_measures_data_quality_val": {
+ "type": "string"
+ },
+ "include_security_measures_data_retention": {
+ "type": "boolean"
+ },
+ "include_security_measures_data_retention_val": {
+ "type": "string"
+ },
+ "include_security_measures_data_transmission": {
+ "type": "boolean"
+ },
+ "include_security_measures_data_transmission_val": {
+ "type": "string"
+ },
+ "include_security_measures_event_logging": {
+ "type": "boolean"
+ },
+ "include_security_measures_event_logging_val": {
+ "type": "string"
+ },
+ "include_security_measures_identity_auth": {
+ "type": "boolean"
+ },
+ "include_security_measures_identity_auth_val": {
+ "type": "string"
+ },
+ "include_security_measures_it_security_governance": {
+ "type": "boolean"
+ },
+ "include_security_measures_it_security_governance_val": {
+ "type": "string"
+ },
+ "include_security_measures_physical_security": {
+ "type": "boolean"
+ },
+ "include_security_measures_physical_security_val": {
+ "type": "string"
+ },
+ "include_security_measures_portability_and_erasure": {
+ "type": "boolean"
+ },
+ "include_security_measures_portability_and_erasure_val": {
+ "type": "string"
+ },
+ "include_security_measures_pseudonym_encryption": {
+ "type": "boolean"
+ },
+ "include_security_measures_pseudonym_encryption_val": {
+ "type": "string"
+ },
+ "include_security_measures_restore_data_access": {
+ "type": "boolean"
+ },
+ "include_security_measures_restore_data_access_val": {
+ "type": "string"
+ },
+ "include_security_measures_security_policy": {
+ "type": "boolean"
+ },
+ "include_security_measures_system_configuration": {
+ "type": "boolean"
+ },
+ "include_security_measures_system_configuration_val": {
+ "type": "string"
+ },
+ "include_security_measures_testing_assessment": {
+ "type": "boolean"
+ },
+ "include_security_measures_testing_assessment_val": {
+ "type": "string"
+ },
+ "include_security_policy": {
+ "type": "boolean"
+ },
+ "include_security_policy_fedramp_auth": {
+ "type": "boolean"
+ },
+ "include_security_policy_hipaa": {
+ "type": "boolean"
+ },
+ "include_security_policy_hitrust": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_other": {
+ "type": "boolean"
+ },
+ "include_security_policy_iso27001": {
+ "type": "boolean"
+ },
+ "include_security_policy_other": {
+ "type": "string"
+ },
+ "include_security_policy_pci1": {
+ "type": "boolean"
+ },
+ "include_security_policy_pci2": {
+ "type": "boolean"
+ },
+ "include_security_policy_penetration_testing": {
+ "type": "boolean"
+ },
+ "include_security_policy_soc2": {
+ "type": "boolean"
+ },
+ "include_security_policy_soc2_type2": {
+ "type": "boolean"
+ },
+ "include_sensitive_data_restrictions_custom": {
+ "type": "boolean"
+ },
+ "include_sensitive_data_restrictions_custom_val": {
+ "type": "string"
+ },
+ "include_sensitive_data_restrictions_security_policy": {
+ "type": "boolean"
+ },
+ "include_service_provider_relationship": {
+ "type": "boolean"
+ },
+ "include_special_category_data": {
+ "type": "boolean"
+ },
+ "provider": {
+ "type": "string"
+ },
+ "security_policy_available_at": {
+ "type": "string"
+ },
+ "security_policy_type": {
+ "description": "Where the Security Policy is defined. For `external`, set `security_policy_available_at`.",
+ "enum": [
+ "defined in agreement",
+ "provider service",
+ "external"
+ ],
+ "type": "string"
+ },
+ "subprocessors_attributes": {
+ "additionalProperties": {
+ "additionalProperties": false,
+ "properties": {
+ "_destroy": {
+ "description": "Set to true with `id` to remove that subprocessor.",
+ "type": "boolean"
+ },
+ "country": {
+ "type": "string"
+ },
+ "id": {
+ "description": "ID of an existing subprocessor to update or remove. Omit to add a new subprocessor.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "processing_task": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "description": "Subprocessors, keyed by string index such as \"0\", \"1\". On create these are added to the template's subprocessors. On a draft update, an entry without `id` adds a new subprocessor; pass `id` to change one and `id` with `_destroy: true` to remove one.",
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+ },
+ "underlying_agreement_id": {
+ "description": "ID of the CSA this DPA supplements when `underlying_agreement_type` is `internal`.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "underlying_agreement_type": {
+ "description": "`internal` links a CSA in Common Paper (`underlying_agreement_id`); `external` describes another agreement in `underlying_agreement_val` (required). Omit for none.",
+ "enum": [
+ "internal",
+ "external"
+ ],
+ "type": "string"
+ },
+ "underlying_agreement_val": {
+ "description": "Description of the agreement this DPA supplements. Required when `underlying_agreement_type` is `external`.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "framework_terms_description": {
+ "description": "Custom framework terms description. Only used when framework_terms_type is \"description\".",
+ "type": "string"
+ },
+ "framework_terms_type": {
+ "description": "How framework terms are specified. Use \"new\" for standard terms or \"description\" to provide a custom framework_terms_description.",
+ "enum": [
+ "new",
+ "description"
+ ],
+ "type": "string"
+ },
+ "governing_law_country": {
+ "description": "The country whose laws govern the agreement.",
+ "type": "string"
+ },
+ "governing_law_region": {
+ "description": "The state or region whose laws govern the agreement.",
+ "type": "string"
+ },
+ "include_automated_payment_reminders": {
+ "description": "When true, automatically sends payment reminder emails.",
+ "type": "boolean"
+ },
+ "include_billing_info": {
+ "description": "When true, billing contact information (billing_name, billing_email) is included.",
+ "type": "boolean"
+ },
+ "include_billing_workflow": {
+ "description": "When true, enables a billing workflow after signing.",
+ "type": "boolean"
+ },
+ "include_expiration_date": {
+ "description": "Expiration date in YYYY-MM-DD format. Use when include_expiration_type is \"date\".",
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "include_expiration_days": {
+ "description": "Number of days until the agreement expires. Use when include_expiration_type is \"days\".",
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_expiration_type": {
+ "description": "How to set expiration: \"none\" (default), \"days\" (use include_expiration_days), or \"date\" (use include_expiration_date).",
+ "enum": [
+ "none",
+ "days",
+ "date"
+ ],
+ "type": "string"
+ },
+ "include_terms": {
+ "description": "When true, the standard terms are included with the agreement.",
+ "type": "boolean"
+ },
+ "loi_attributes": {
+ "additionalProperties": false,
+ "description": "Override loi terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "confidentiality_custom": {
+ "type": "string"
+ },
+ "confidentiality_mutual_include_loi": {
+ "type": "boolean"
+ },
+ "confidentiality_nda_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "confidentiality_nda_description": {
+ "type": "string"
+ },
+ "confidentiality_nda_include_loi": {
+ "type": "boolean"
+ },
+ "confidentiality_nda_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "confidentiality_type": {
+ "enum": [
+ "mutual",
+ "nda",
+ "provider",
+ "custom"
+ ],
+ "type": "string"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_custom_details": {
+ "type": "boolean"
+ },
+ "include_custom_details_val": {
+ "type": "string"
+ },
+ "include_fees": {
+ "type": "boolean"
+ },
+ "include_fees_amount": {
+ "type": "number"
+ },
+ "include_fees_amount_duration": {
+ "enum": [
+ "month",
+ "year",
+ "quarter"
+ ],
+ "type": "string"
+ },
+ "include_fees_include_amount": {
+ "type": "boolean"
+ },
+ "include_fees_include_other": {
+ "type": "boolean"
+ },
+ "include_fees_other": {
+ "type": "string"
+ },
+ "include_functionality": {
+ "type": "boolean"
+ },
+ "include_functionality_val": {
+ "type": "string"
+ },
+ "include_launch_date": {
+ "type": "boolean"
+ },
+ "include_launch_date_custom": {
+ "type": "string"
+ },
+ "include_launch_date_date": {
+ "format": "date-time",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$",
+ "type": "string"
+ },
+ "include_launch_date_type": {
+ "enum": [
+ "date",
+ "custom"
+ ],
+ "type": "string"
+ },
+ "product_name": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "manual_send": {
+ "description": "When true, the agreement is marked as manually sent outside the platform.",
+ "type": "boolean"
+ },
+ "message": {
+ "type": "string"
+ },
+ "negotiations_allowed": {
+ "description": "When true, the recipient can propose changes to the legal terms. For agreement types without separate business terms, that covers every term. CSA order forms, PSA statements of work, partnership business terms and software license order forms have their own `negotiations_allowed` flag.",
+ "type": "boolean"
+ },
+ "partnership_attributes": {
+ "additionalProperties": false,
+ "description": "Override partnership terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "effective_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "effective_date_type": {
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "type": "string"
+ },
+ "general_cap_amount_currency_val": {
+ "type": "number"
+ },
+ "general_cap_amount_either_currency": {
+ "type": "number"
+ },
+ "general_cap_amount_either_multiple": {
+ "type": "number"
+ },
+ "general_cap_amount_multiple_val": {
+ "type": "number"
+ },
+ "general_cap_amount_type": {
+ "enum": [
+ "multiple",
+ "currency",
+ "either",
+ "base"
+ ],
+ "type": "string"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_additional_warranties": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_include_company": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_include_company_val": {
+ "type": "string"
+ },
+ "include_additional_warranties_include_partner": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_include_partner_val": {
+ "type": "string"
+ },
+ "include_brand_guidelines": {
+ "type": "boolean"
+ },
+ "include_brand_guidelines_include_company": {
+ "type": "boolean"
+ },
+ "include_brand_guidelines_include_company_val": {
+ "type": "string"
+ },
+ "include_brand_guidelines_include_partner": {
+ "type": "boolean"
+ },
+ "include_brand_guidelines_include_partner_val": {
+ "type": "string"
+ },
+ "include_covered_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_company_claims": {
+ "type": "string"
+ },
+ "include_covered_claims_include_company_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_include_partner_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_partner_claims": {
+ "type": "string"
+ },
+ "include_dpa": {
+ "type": "boolean"
+ },
+ "include_dpa_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_dpa_location": {
+ "type": "string"
+ },
+ "include_dpa_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_increased_cap_amount": {
+ "type": "boolean"
+ },
+ "include_increased_cap_amount_currency": {
+ "type": "number"
+ },
+ "include_increased_cap_amount_either_currency": {
+ "type": "number"
+ },
+ "include_increased_cap_amount_either_multiple": {
+ "type": "string"
+ },
+ "include_increased_cap_amount_multiple": {
+ "type": "string"
+ },
+ "include_increased_cap_amount_type": {
+ "enum": [
+ "multiple",
+ "currency",
+ "either"
+ ],
+ "type": "string"
+ },
+ "include_increased_claims": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_confidentiality": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_confidentiality_misconduct": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_covered_claims": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_misconduct": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_other": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_other_val": {
+ "type": "string"
+ },
+ "include_unlimited_claims": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_confidentiality": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_confidentiality_misconduct": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_covered_claims": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_misconduct": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_other": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_other_val": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "partnership_business_terms_attributes": {
+ "additionalProperties": false,
+ "description": "Override partnership business terms terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "end_date_after_effective_date_amount": {
+ "type": "number"
+ },
+ "end_date_after_effective_date_unit": {
+ "enum": [
+ "month(s)",
+ "quarter(s)",
+ "year(s)"
+ ],
+ "type": "string"
+ },
+ "end_date_date": {
+ "type": "string"
+ },
+ "end_date_type": {
+ "enum": [
+ "date",
+ "effective date"
+ ],
+ "type": "string"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_obligations_company_brand": {
+ "type": "boolean"
+ },
+ "include_obligations_company_promotion": {
+ "type": "boolean"
+ },
+ "include_obligations_company_promotion_include_activities": {
+ "type": "boolean"
+ },
+ "include_obligations_company_promotion_include_activities_val": {
+ "type": "string"
+ },
+ "include_obligations_company_promotion_include_materials": {
+ "type": "boolean"
+ },
+ "include_obligations_company_promotion_include_materials_val": {
+ "type": "string"
+ },
+ "include_obligations_company_referral": {
+ "type": "boolean"
+ },
+ "include_obligations_company_referral_include_criteria": {
+ "type": "boolean"
+ },
+ "include_obligations_company_referral_include_criteria_val": {
+ "type": "string"
+ },
+ "include_obligations_company_referral_include_pay_sch": {
+ "type": "boolean"
+ },
+ "include_obligations_company_referral_include_pay_sch_amount": {
+ "type": "number"
+ },
+ "include_obligations_company_referral_include_pay_sch_custom": {
+ "type": "string"
+ },
+ "include_obligations_company_referral_include_pay_sch_unit": {
+ "enum": [
+ "U.S. Dollars",
+ "percent"
+ ],
+ "type": "string"
+ },
+ "include_obligations_company_sponsorship": {
+ "type": "boolean"
+ },
+ "include_obligations_company_sponsorship_include_benefits": {
+ "type": "boolean"
+ },
+ "include_obligations_company_sponsorship_include_benefits_val": {
+ "type": "string"
+ },
+ "include_obligations_company_sponsorship_include_payments": {
+ "type": "boolean"
+ },
+ "include_obligations_company_sponsorship_include_payments_amount": {
+ "type": "number"
+ },
+ "include_obligations_company_sponsorship_include_payments_unit": {
+ "enum": [
+ "U.S. Dollars",
+ "percent"
+ ],
+ "type": "string"
+ },
+ "include_obligations_partner_brand": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_promotion": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_promotion_include_activities": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_promotion_include_activities_val": {
+ "type": "string"
+ },
+ "include_obligations_partner_promotion_include_materials": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_promotion_include_materials_val": {
+ "type": "string"
+ },
+ "include_obligations_partner_referral": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_referral_include_criteria": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_referral_include_criteria_val": {
+ "type": "string"
+ },
+ "include_obligations_partner_referral_include_pay_sch": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_referral_include_pay_sch_amount": {
+ "type": "number"
+ },
+ "include_obligations_partner_referral_include_pay_sch_custom": {
+ "type": "string"
+ },
+ "include_obligations_partner_referral_include_pay_sch_unit": {
+ "enum": [
+ "U.S. Dollars",
+ "percent"
+ ],
+ "type": "string"
+ },
+ "include_obligations_partner_sponsorship": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_sponsorship_include_benefits": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_sponsorship_include_benefits_val": {
+ "type": "string"
+ },
+ "include_obligations_partner_sponsorship_include_payments": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_sponsorship_include_payments_amount": {
+ "type": "number"
+ },
+ "include_obligations_partner_sponsorship_include_payments_unit": {
+ "enum": [
+ "U.S. Dollars",
+ "percent"
+ ],
+ "type": "string"
+ },
+ "include_payment_process": {
+ "type": "boolean"
+ },
+ "include_payment_process_company": {
+ "type": "boolean"
+ },
+ "include_payment_process_company_include_address": {
+ "type": "boolean"
+ },
+ "include_payment_process_company_include_address_city": {
+ "type": "string"
+ },
+ "include_payment_process_company_include_address_country": {
+ "type": "string"
+ },
+ "include_payment_process_company_include_address_state": {
+ "type": "string"
+ },
+ "include_payment_process_company_include_address_street_address": {
+ "type": "string"
+ },
+ "include_payment_process_company_include_address_zipcode": {
+ "type": "string"
+ },
+ "include_payment_process_company_include_email": {
+ "type": "boolean"
+ },
+ "include_payment_process_company_include_email_val": {
+ "type": "string"
+ },
+ "include_payment_process_partner": {
+ "type": "boolean"
+ },
+ "include_payment_process_partner_include_address": {
+ "type": "boolean"
+ },
+ "include_payment_process_partner_include_address_city": {
+ "type": "string"
+ },
+ "include_payment_process_partner_include_address_country": {
+ "type": "string"
+ },
+ "include_payment_process_partner_include_address_state": {
+ "type": "string"
+ },
+ "include_payment_process_partner_include_address_street_address": {
+ "type": "string"
+ },
+ "include_payment_process_partner_include_address_zipcode": {
+ "type": "string"
+ },
+ "include_payment_process_partner_include_email": {
+ "type": "boolean"
+ },
+ "include_payment_process_partner_include_email_val": {
+ "type": "string"
+ },
+ "include_payment_schedule": {
+ "type": "boolean"
+ },
+ "include_payment_schedule_custom": {
+ "type": "string"
+ },
+ "include_payment_schedule_specified_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_payment_schedule_specified_timeframe": {
+ "enum": [
+ "receipt",
+ "date"
+ ],
+ "type": "string"
+ },
+ "include_payment_schedule_specified_unit": {
+ "enum": [
+ "day(s)",
+ "week(s)",
+ "month(s)",
+ "quarter(s)",
+ "year(s)"
+ ],
+ "type": "string"
+ },
+ "include_payment_schedule_type": {
+ "enum": [
+ "specified",
+ "custom"
+ ],
+ "type": "string"
+ },
+ "negotiations_allowed": {
+ "description": "When true, the recipient can propose changes to the business terms, even when the agreement-level `negotiations_allowed` is false. This only covers the business terms.",
+ "type": "boolean"
+ },
+ "territory_type": {
+ "enum": [
+ "worldwide",
+ "custom"
+ ],
+ "type": "string"
+ },
+ "territory_type_val": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "payment_link_url": {
+ "description": "A payment URL shown to the recipient after signing. Requires include_billing_workflow to be true and billing_workflow_type to be \"link\".",
+ "type": "string"
+ },
+ "pilot_attributes": {
+ "additionalProperties": false,
+ "description": "Override pilot terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "fees_type": {
+ "enum": [
+ "free",
+ "pilot_period_fees"
+ ],
+ "type": "string"
+ },
+ "general_cap_amount": {
+ "type": "number"
+ },
+ "general_cap_amount_type": {
+ "enum": [
+ "preceding",
+ "base",
+ "period"
+ ],
+ "type": "string"
+ },
+ "general_cap_period_currency": {
+ "type": "number"
+ },
+ "general_cap_period_qty": {
+ "type": "number"
+ },
+ "general_cap_preceding_amount": {
+ "type": "number"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_dpa": {
+ "type": "boolean"
+ },
+ "include_dpa_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_dpa_location": {
+ "type": "string"
+ },
+ "include_dpa_type": {
+ "enum": [
+ "description",
+ "attachment",
+ "standard"
+ ],
+ "type": "string"
+ },
+ "include_payment_process": {
+ "type": "boolean"
+ },
+ "include_technical_support": {
+ "type": "boolean"
+ },
+ "payment_process_automatic_frequency": {
+ "enum": [
+ "monthly",
+ "quarterly",
+ "annually",
+ "once_per_period"
+ ],
+ "type": "string"
+ },
+ "payment_process_invoice_days": {
+ "type": "number"
+ },
+ "payment_process_invoice_from": {
+ "enum": [
+ "receipt",
+ "date"
+ ],
+ "type": "string"
+ },
+ "payment_process_invoice_timeframe": {
+ "enum": [
+ "days",
+ "weeks",
+ "months",
+ "quarters",
+ "years"
+ ],
+ "type": "string"
+ },
+ "payment_process_type": {
+ "enum": [
+ "automatic",
+ "invoice"
+ ],
+ "type": "string"
+ },
+ "pilot_period_description": {
+ "type": "string"
+ },
+ "pilot_period_fees_description": {
+ "type": "string"
+ },
+ "product_description": {
+ "type": "string"
+ },
+ "technical_support_description": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "psa_attributes": {
+ "additionalProperties": false,
+ "description": "Override psa terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "additional_changes": {
+ "type": "string"
+ },
+ "customer_description": {
+ "type": "string"
+ },
+ "effective_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "effective_date_type": {
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "type": "string"
+ },
+ "general_cap_amount": {
+ "type": "number"
+ },
+ "general_cap_amount_type": {
+ "enum": [
+ "preceding",
+ "base",
+ "period"
+ ],
+ "type": "string"
+ },
+ "general_cap_period_currency": {
+ "type": "number"
+ },
+ "general_cap_period_qty": {
+ "type": "number"
+ },
+ "general_cap_preceding_amount": {
+ "type": "number"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_additional_changes": {
+ "type": "boolean"
+ },
+ "include_additional_warranties": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_by_customer": {
+ "type": "string"
+ },
+ "include_additional_warranties_by_provider": {
+ "type": "string"
+ },
+ "include_additional_warranties_include_by_customer": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_include_by_provider": {
+ "type": "boolean"
+ },
+ "include_covered_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_customer_claims": {
+ "type": "string"
+ },
+ "include_covered_claims_include_customer_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_include_provider_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_provider_claims": {
+ "type": "string"
+ },
+ "include_customer_insurance_min": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_add_provider_com_gen_liability": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_add_provider_cyber_liability": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_add_provider_errors_omissions": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_auto_liability_aggregate": {
+ "type": "number"
+ },
+ "include_customer_insurance_min_auto_liability_minimum": {
+ "type": "number"
+ },
+ "include_customer_insurance_min_cyber_liability_aggregate": {
+ "type": "number"
+ },
+ "include_customer_insurance_min_cyber_liability_minimum": {
+ "type": "number"
+ },
+ "include_customer_insurance_min_employer_liability_aggregate": {
+ "type": "number"
+ },
+ "include_customer_insurance_min_employer_liability_minimum": {
+ "type": "number"
+ },
+ "include_customer_insurance_min_general_liability_aggregate": {
+ "type": "number"
+ },
+ "include_customer_insurance_min_general_liability_minimum": {
+ "type": "number"
+ },
+ "include_customer_insurance_min_include_add_provider": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_include_auto_liability": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_include_cyber_liability": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_include_employer_liability": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_include_general_liability": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_include_workers_comp": {
+ "type": "boolean"
+ },
+ "include_customer_policies": {
+ "type": "boolean"
+ },
+ "include_customer_policies_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_customer_policies_location": {
+ "type": "string"
+ },
+ "include_customer_policies_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_dpa": {
+ "type": "boolean"
+ },
+ "include_dpa_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_dpa_location": {
+ "type": "string"
+ },
+ "include_dpa_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_increased_cap_amount": {
+ "type": "boolean"
+ },
+ "include_increased_claims": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_confidentiality": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_confidentiality_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_privsec": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_privsec_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_other": {
+ "type": "boolean"
+ },
+ "include_increased_claims_indemnification_obligation": {
+ "type": "boolean"
+ },
+ "include_increased_claims_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_other": {
+ "type": "string"
+ },
+ "include_provider_insurance_min": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_add_customer_com_gen_liability": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_add_customer_cyber_liability": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_add_customer_errors_omissions": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_auto_liability_aggregate": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_auto_liability_minimum": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_cyber_liability_aggregate": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_cyber_liability_minimum": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_employer_liability_aggregate": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_employer_liability_minimum": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_general_liability_aggregate": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_general_liability_minimum": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_include_add_customer": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_include_auto_liability": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_include_cyber_liability": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_include_employer_liability": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_include_general_liability": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_include_workers_comp": {
+ "type": "boolean"
+ },
+ "include_publicity_rights": {
+ "type": "boolean"
+ },
+ "include_publicity_rights_type": {
+ "enum": [
+ "public",
+ "non-public"
+ ],
+ "type": "string"
+ },
+ "include_security_policy": {
+ "type": "boolean"
+ },
+ "include_security_policy_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_security_policy_fedramp_auth": {
+ "type": "boolean"
+ },
+ "include_security_policy_hitrust": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_annual_maintenance": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_other": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_other_val": {
+ "type": "string"
+ },
+ "include_security_policy_iso27001": {
+ "type": "boolean"
+ },
+ "include_security_policy_location": {
+ "type": "string"
+ },
+ "include_security_policy_pci1": {
+ "type": "boolean"
+ },
+ "include_security_policy_pci2": {
+ "type": "boolean"
+ },
+ "include_security_policy_penetration_testing": {
+ "type": "boolean"
+ },
+ "include_security_policy_soc2_type1": {
+ "type": "boolean"
+ },
+ "include_security_policy_soc2_type2": {
+ "type": "boolean"
+ },
+ "include_security_policy_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_unlimited_claims": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_confidentiality": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_confidentiality_negligence": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_privsec": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_privsec_negligence": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_include_other": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_indemnification_obligation": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_negligence": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_other": {
+ "type": "string"
+ },
+ "increased_cap_amount_currency": {
+ "type": "number"
+ },
+ "increased_cap_amount_period_currency": {
+ "type": "number"
+ },
+ "increased_cap_amount_period_qty": {
+ "type": "number"
+ },
+ "increased_cap_amount_qty": {
+ "type": "number"
+ },
+ "increased_cap_amount_type": {
+ "enum": [
+ "qty",
+ "currency",
+ "period"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "psa_statement_of_work_attributes": {
+ "additionalProperties": false,
+ "description": "Override psa statement of work terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "additional_changes": {
+ "type": "string"
+ },
+ "cost": {
+ "type": "number"
+ },
+ "description": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "fees_attributes": {
+ "additionalProperties": {
+ "anyOf": [
+ {
+ "additionalProperties": false,
+ "description": "Fees::Flat (fee_type \"flat\"). A fixed recurring fee, e.g. a platform subscription. Set type to \"Fees::Flat\" or fee_type to \"flat\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Fixed amount in the order form's fees_currency, charged per fee_period. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"flat\". Alternative to type.",
+ "enum": [
+ "flat"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Flat\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Flat"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Discount (fee_type \"discount\"). A discount, as a fixed amount or a percentage, applied forever, once, or for a number of months. Set type to \"Fees::Discount\" or fee_type to \"discount\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Discount size: an amount in fees_currency when discount_type is fixed_amount (a plain amount, not cents: 20 means 20.00), or a percentage (e.g. 10 for 10%) when it is percentage.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "discount_duration_amount": {
+ "description": "Number of months the discount applies. Required when discount_duration_type is multiple_months.",
+ "type": "number"
+ },
+ "discount_duration_type": {
+ "description": "How long the discount applies. multiple_months also needs discount_duration_amount.",
+ "enum": [
+ "forever",
+ "once",
+ "multiple_months"
+ ],
+ "type": "string"
+ },
+ "discount_type": {
+ "description": "Whether cost is a currency amount or a percentage.",
+ "enum": [
+ "fixed_amount",
+ "percentage"
+ ],
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"discount\". Alternative to type.",
+ "enum": [
+ "discount"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Discount\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Discount"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Cost (fee_type \"cost\"). A per-unit fee: price per unit times quantity, e.g. seats. Set type to \"Fees::Cost\" or fee_type to \"cost\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Price per unit in fees_currency. The row total is quantity x cost. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"cost\". Alternative to type.",
+ "enum": [
+ "cost"
+ ],
+ "type": "string"
+ },
+ "quantity": {
+ "description": "Number of units.",
+ "type": "number"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Cost\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Cost"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Attachment (fee_type \"attachment\"). A fee described in an uploaded attachment instead of in the table. Set type to \"Fees::Attachment\" or fee_type to \"attachment\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "attachment_id": {
+ "description": "ID of an attachment uploaded with upload-attachment.",
+ "type": "string"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"attachment\". Alternative to type.",
+ "enum": [
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Attachment\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Attachment"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Graduated (fee_type \"graduated\"). Tiered pricing, with the price set per tier in graduated_fee_tiers_attributes. Set type to \"Fees::Graduated\" or fee_type to \"graduated\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"graduated\". Alternative to type.",
+ "enum": [
+ "graduated"
+ ],
+ "type": "string"
+ },
+ "graduated_fee_tiers_attributes": {
+ "additionalProperties": {
+ "additionalProperties": false,
+ "properties": {
+ "flat_price": {
+ "type": "number"
+ },
+ "price_per_unit": {
+ "type": "string"
+ },
+ "upper_limit": {
+ "type": "number"
+ }
+ },
+ "type": "object"
+ },
+ "description": "Graduated fee tiers. Use string keys such as \"0\", \"1\".",
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Graduated\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Graduated"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Included (fee_type \"included\"). An item included at no charge. Set type to \"Fees::Included\" or fee_type to \"included\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"included\". Alternative to type.",
+ "enum": [
+ "included"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Included\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Included"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Metered (fee_type \"metered\"). Usage-based pricing, billed per unit used. Set type to \"Fees::Metered\" or fee_type to \"metered\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Price per unit of usage in fees_currency. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"metered\". Alternative to type.",
+ "enum": [
+ "metered"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Metered\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Metered"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::OneTime (fee_type \"one_time\"). A one-time charge, such as a setup fee. Set type to \"Fees::OneTime\" or fee_type to \"one_time\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "One-time amount in fees_currency, charged once rather than per fee_period. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"one_time\". Alternative to type.",
+ "enum": [
+ "one_time"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::OneTime\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::OneTime"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Text (fee_type \"text\"). A fee term described in free text. Set type to \"Fees::Text\" or fee_type to \"text\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"text\". Alternative to type.",
+ "enum": [
+ "text"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Text\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Text"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ }
+ ]
+ },
+ "description": "Fee line items. Use string keys such as \"0\", \"1\". Replaces template fees when provided.",
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_additional_changes": {
+ "type": "boolean"
+ },
+ "include_customer_obligation": {
+ "type": "boolean"
+ },
+ "include_customer_obligation_val": {
+ "type": "string"
+ },
+ "include_deliverables": {
+ "type": "boolean"
+ },
+ "include_deliverables_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_deliverables_description": {
+ "type": "string"
+ },
+ "include_deliverables_include_acceptance": {
+ "type": "boolean"
+ },
+ "include_deliverables_include_attachment": {
+ "type": "boolean"
+ },
+ "include_deliverables_include_draft_deliverables": {
+ "type": "boolean"
+ },
+ "include_deliverables_rejection_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_deliverables_rejection_unit": {
+ "enum": [
+ "hours",
+ "days",
+ "weeks",
+ "months"
+ ],
+ "type": "string"
+ },
+ "include_deliverables_resubmission_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_deliverables_resubmission_unit": {
+ "enum": [
+ "hours",
+ "days",
+ "weeks",
+ "months"
+ ],
+ "type": "string"
+ },
+ "include_fees_other": {
+ "type": "boolean"
+ },
+ "include_fees_other_val": {
+ "type": "string"
+ },
+ "include_fees_table": {
+ "type": "boolean"
+ },
+ "include_fees_table_total": {
+ "type": "boolean"
+ },
+ "include_fees_travel": {
+ "type": "boolean"
+ },
+ "include_fees_travel_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_fees_travel_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_fees_travel_val": {
+ "type": "string"
+ },
+ "include_third_party_customer": {
+ "type": "boolean"
+ },
+ "include_third_party_include_description": {
+ "type": "boolean"
+ },
+ "include_third_party_include_description_val": {
+ "type": "string"
+ },
+ "include_third_party_materials": {
+ "type": "boolean"
+ },
+ "include_third_party_provider": {
+ "type": "boolean"
+ },
+ "include_time_of_assignment": {
+ "type": "boolean"
+ },
+ "include_time_of_assignment_type": {
+ "enum": [
+ "created",
+ "paid"
+ ],
+ "type": "string"
+ },
+ "invoice_period_description": {
+ "type": "string"
+ },
+ "negotiations_allowed": {
+ "description": "When true, the recipient can propose changes to the statement of work, even when the agreement-level `negotiations_allowed` is false. This only covers the statement of work.",
+ "type": "boolean"
+ },
+ "payment_period": {
+ "type": "number"
+ },
+ "payment_period_other": {
+ "type": "string"
+ },
+ "payment_period_timeframe": {
+ "enum": [
+ "receipt",
+ "invoice",
+ "Customer's receipt of invoice",
+ "date of invoice"
+ ],
+ "type": "string"
+ },
+ "payment_period_type": {
+ "enum": [
+ "standard",
+ "other"
+ ],
+ "type": "string"
+ },
+ "payment_period_unit": {
+ "enum": [
+ "day(s)",
+ "week(s)",
+ "month(s)",
+ "quarter(s)",
+ "year(s)"
+ ],
+ "type": "string"
+ },
+ "quantity": {
+ "type": "number"
+ },
+ "services_description": {
+ "type": "string"
+ },
+ "sow_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "sow_date_type": {
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "type": "string"
+ },
+ "sow_term_amount": {
+ "type": "number"
+ },
+ "sow_term_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "sow_term_type": {
+ "enum": [
+ "deliverables",
+ "period",
+ "date"
+ ],
+ "type": "string"
+ },
+ "sow_term_unit": {
+ "enum": [
+ "month(s)",
+ "quarter(s)",
+ "year(s)"
+ ],
+ "type": "string"
+ },
+ "type": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "recipient_email": {
+ "format": "email",
+ "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-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_last_to_sign": {
+ "description": "When true, your signer signs after the recipient.",
+ "type": "boolean"
+ },
+ "sender_notice_email_address": {
+ "description": "Email address for legal notices to the sender.",
+ "format": "email",
+ "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-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": {
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "type": "string"
+ },
+ "general_cap_amount": {
+ "type": "number"
+ },
+ "general_cap_amount_type": {
+ "enum": [
+ "preceding",
+ "base",
+ "period"
+ ],
+ "type": "string"
+ },
+ "general_cap_period_currency": {
+ "type": "number"
+ },
+ "general_cap_period_qty": {
+ "type": "number"
+ },
+ "general_cap_preceding_amount": {
+ "type": "number"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_additional_warranties": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_by_customer": {
+ "type": "string"
+ },
+ "include_additional_warranties_by_provider": {
+ "type": "string"
+ },
+ "include_additional_warranties_include_by_customer": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_include_by_provider": {
+ "type": "boolean"
+ },
+ "include_ai_addendum": {
+ "type": "boolean"
+ },
+ "include_ai_addendum_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_covered_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_customer_claims": {
+ "type": "string"
+ },
+ "include_covered_claims_include_customer_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_include_provider_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_provider_claims": {
+ "type": "string"
+ },
+ "include_dpa": {
+ "type": "boolean"
+ },
+ "include_dpa_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_dpa_location": {
+ "type": "string"
+ },
+ "include_dpa_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_increased_cap_amount": {
+ "type": "boolean"
+ },
+ "include_increased_claims": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_confidentiality": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_confidentiality_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_other": {
+ "type": "boolean"
+ },
+ "include_increased_claims_indemnification_obligation": {
+ "type": "boolean"
+ },
+ "include_increased_claims_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_other": {
+ "type": "string"
+ },
+ "include_increased_claims_restrictions": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_confidentiality": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_confidentiality_negligence": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_include_other": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_indemnification_obligation": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_license_or_restrictions": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_negligence": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_other": {
+ "type": "string"
+ },
+ "increased_cap_amount_currency": {
+ "type": "number"
+ },
+ "increased_cap_amount_period_currency": {
+ "type": "number"
+ },
+ "increased_cap_amount_period_qty": {
+ "type": "number"
+ },
+ "increased_cap_amount_qty": {
+ "type": "number"
+ },
+ "increased_cap_amount_type": {
+ "enum": [
+ "qty",
+ "currency",
+ "period"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "software_license_order_form_attributes": {
+ "additionalProperties": false,
+ "description": "Override software license order form terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "additional_changes": {
+ "type": "string"
+ },
+ "deletion_procedure_include_custom": {
+ "type": "boolean"
+ },
+ "deletion_procedure_include_custom_description": {
+ "type": "string"
+ },
+ "deletion_procedure_include_customer_disable": {
+ "type": "boolean"
+ },
+ "deletion_procedure_include_customer_proof": {
+ "type": "boolean"
+ },
+ "deletion_procedure_include_provider_disable": {
+ "type": "boolean"
+ },
+ "fee_custom_unit": {
+ "type": "string"
+ },
+ "fee_period": {
+ "enum": [
+ "Subscription Period",
+ "month",
+ "year",
+ "Custom unit"
+ ],
+ "type": "string"
+ },
+ "fees_attributes": {
+ "additionalProperties": {
+ "anyOf": [
+ {
+ "additionalProperties": false,
+ "description": "Fees::Flat (fee_type \"flat\"). A fixed recurring fee, e.g. a platform subscription. Set type to \"Fees::Flat\" or fee_type to \"flat\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Fixed amount in the order form's fees_currency, charged per fee_period. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"flat\". Alternative to type.",
+ "enum": [
+ "flat"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Flat\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Flat"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Discount (fee_type \"discount\"). A discount, as a fixed amount or a percentage, applied forever, once, or for a number of months. Set type to \"Fees::Discount\" or fee_type to \"discount\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Discount size: an amount in fees_currency when discount_type is fixed_amount (a plain amount, not cents: 20 means 20.00), or a percentage (e.g. 10 for 10%) when it is percentage.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "discount_duration_amount": {
+ "description": "Number of months the discount applies. Required when discount_duration_type is multiple_months.",
+ "type": "number"
+ },
+ "discount_duration_type": {
+ "description": "How long the discount applies. multiple_months also needs discount_duration_amount.",
+ "enum": [
+ "forever",
+ "once",
+ "multiple_months"
+ ],
+ "type": "string"
+ },
+ "discount_type": {
+ "description": "Whether cost is a currency amount or a percentage.",
+ "enum": [
+ "fixed_amount",
+ "percentage"
+ ],
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"discount\". Alternative to type.",
+ "enum": [
+ "discount"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Discount\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Discount"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Cost (fee_type \"cost\"). A per-unit fee: price per unit times quantity, e.g. seats. Set type to \"Fees::Cost\" or fee_type to \"cost\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Price per unit in fees_currency. The row total is quantity x cost. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"cost\". Alternative to type.",
+ "enum": [
+ "cost"
+ ],
+ "type": "string"
+ },
+ "quantity": {
+ "description": "Number of units.",
+ "type": "number"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Cost\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Cost"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Attachment (fee_type \"attachment\"). A fee described in an uploaded attachment instead of in the table. Set type to \"Fees::Attachment\" or fee_type to \"attachment\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "attachment_id": {
+ "description": "ID of an attachment uploaded with upload-attachment.",
+ "type": "string"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"attachment\". Alternative to type.",
+ "enum": [
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Attachment\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Attachment"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Graduated (fee_type \"graduated\"). Tiered pricing, with the price set per tier in graduated_fee_tiers_attributes. Set type to \"Fees::Graduated\" or fee_type to \"graduated\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"graduated\". Alternative to type.",
+ "enum": [
+ "graduated"
+ ],
+ "type": "string"
+ },
+ "graduated_fee_tiers_attributes": {
+ "additionalProperties": {
+ "additionalProperties": false,
+ "properties": {
+ "flat_price": {
+ "type": "number"
+ },
+ "price_per_unit": {
+ "type": "string"
+ },
+ "upper_limit": {
+ "type": "number"
+ }
+ },
+ "type": "object"
+ },
+ "description": "Graduated fee tiers. Use string keys such as \"0\", \"1\".",
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Graduated\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Graduated"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Included (fee_type \"included\"). An item included at no charge. Set type to \"Fees::Included\" or fee_type to \"included\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"included\". Alternative to type.",
+ "enum": [
+ "included"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Included\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Included"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Metered (fee_type \"metered\"). Usage-based pricing, billed per unit used. Set type to \"Fees::Metered\" or fee_type to \"metered\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Price per unit of usage in fees_currency. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"metered\". Alternative to type.",
+ "enum": [
+ "metered"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Metered\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Metered"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::OneTime (fee_type \"one_time\"). A one-time charge, such as a setup fee. Set type to \"Fees::OneTime\" or fee_type to \"one_time\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "One-time amount in fees_currency, charged once rather than per fee_period. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"one_time\". Alternative to type.",
+ "enum": [
+ "one_time"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::OneTime\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::OneTime"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Text (fee_type \"text\"). A fee term described in free text. Set type to \"Fees::Text\" or fee_type to \"text\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"text\". Alternative to type.",
+ "enum": [
+ "text"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Text\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Text"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ }
+ ]
+ },
+ "description": "Fee line items. Use string keys such as \"0\", \"1\". Replaces template fees when provided.",
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+ },
+ "fees_currency": {
+ "enum": [
+ "USD",
+ "EUR",
+ "GBP",
+ "CAD",
+ "AUD",
+ "SGD",
+ "ILS",
+ "JPY",
+ "CHF",
+ "HKD"
+ ],
+ "type": "string"
+ },
+ "fees_include_fee_increase_upon_renewal": {
+ "type": "boolean"
+ },
+ "fees_include_fee_increase_upon_renewal_fee": {
+ "type": "number"
+ },
+ "fees_include_fee_increase_upon_renewal_type": {
+ "enum": [
+ "will",
+ "may"
+ ],
+ "type": "string"
+ },
+ "fees_inclusive_of_taxes": {
+ "type": "boolean"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_additional_changes": {
+ "type": "boolean"
+ },
+ "include_license_compliance_verification": {
+ "type": "boolean"
+ },
+ "include_license_compliance_verification_description": {
+ "type": "string"
+ },
+ "include_license_limits": {
+ "type": "boolean"
+ },
+ "include_license_limits_description": {
+ "type": "string"
+ },
+ "include_payment_process_include_billing_email": {
+ "type": "boolean"
+ },
+ "include_pilot_period": {
+ "type": "boolean"
+ },
+ "include_pilot_period_duration_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_pilot_period_duration_type": {
+ "enum": [
+ "day",
+ "week",
+ "month"
+ ],
+ "type": "string"
+ },
+ "include_pilot_period_include_fees": {
+ "type": "boolean"
+ },
+ "include_pilot_period_include_fees_amount": {
+ "type": "number"
+ },
+ "include_pilot_period_include_modifications": {
+ "type": "boolean"
+ },
+ "include_pilot_period_include_modifications_description": {
+ "type": "string"
+ },
+ "include_services": {
+ "type": "boolean"
+ },
+ "include_services_description": {
+ "type": "string"
+ },
+ "negotiations_allowed": {
+ "description": "When true, the recipient can propose changes to the order form, even when the agreement-level `negotiations_allowed` is false. This only covers the order form.",
+ "type": "boolean"
+ },
+ "order_date_date": {
+ "type": "string"
+ },
+ "order_date_type": {
+ "enum": [
+ "signature",
+ "date",
+ "other"
+ ],
+ "type": "string"
+ },
+ "payment_process_automatic_frequency": {
+ "enum": [
+ "monthly",
+ "quarterly",
+ "semiannually",
+ "annually"
+ ],
+ "type": "string"
+ },
+ "payment_process_type": {
+ "enum": [
+ "automatic",
+ "invoice",
+ "custom"
+ ],
+ "type": "string"
+ },
+ "payment_process_type_custom_val": {
+ "type": "string"
+ },
+ "payment_process_type_invoice_amount": {
+ "type": "number"
+ },
+ "payment_process_type_invoice_custom_unit": {
+ "type": "string"
+ },
+ "payment_process_type_invoice_duration": {
+ "enum": [
+ "day",
+ "week",
+ "month",
+ "year",
+ "day(s)",
+ "week(s)",
+ "month(s)",
+ "year(s)"
+ ],
+ "type": "string"
+ },
+ "payment_process_type_invoice_duration_start": {
+ "enum": [
+ "Customer's receipt of invoice",
+ "date of invoice"
+ ],
+ "type": "string"
+ },
+ "payment_process_type_invoice_type": {
+ "enum": [
+ "monthly",
+ "quarterly",
+ "semiannually",
+ "annually",
+ "Custom unit"
+ ],
+ "type": "string"
+ },
+ "permitted_uses_include_custom": {
+ "type": "boolean"
+ },
+ "permitted_uses_include_custom_description": {
+ "type": "string"
+ },
+ "permitted_uses_include_customers_affiliates": {
+ "type": "boolean"
+ },
+ "permitted_uses_include_internal_business": {
+ "type": "boolean"
+ },
+ "pilot_period_stripe_product_id": {
+ "type": "string"
+ },
+ "software_description": {
+ "type": "string"
+ },
+ "subscription_auto_renew": {
+ "enum": [
+ "days",
+ "subscription_end"
+ ],
+ "type": "string"
+ },
+ "subscription_period": {
+ "type": "number"
+ },
+ "subscription_period_unit": {
+ "type": "string"
+ },
+ "subscription_renewal_notice_days": {
+ "type": "number"
+ },
+ "warranty_period_description_amount": {
+ "type": "number"
+ },
+ "warranty_period_description_duration": {
+ "enum": [
+ "day",
+ "week",
+ "month",
+ "year"
+ ],
+ "type": "string"
+ },
+ "warranty_period_description_duration_start": {
+ "enum": [
+ "initial delivery of the Software",
+ "delivery of the Software and each subsequent Update",
+ "the Order Date"
+ ],
+ "type": "string"
+ },
+ "warranty_period_type": {
+ "enum": [
+ "description",
+ "none"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "test_agreement": {
+ "description": "When true, marks the agreement as a test. Test agreements do not count against your monthly limit.",
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "recipient_name",
+ "recipient_email"
+ ],
+ "type": "object"
+ },
+ "cc_users": {
+ "items": {
+ "format": "email",
+ "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-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": {
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "type": "string"
+ },
+ "framework_terms_type": {
+ "type": "string"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "parent_agreement_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "underlying_agreement_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "underlying_agreement_type": {
+ "type": "string"
+ },
+ "underlying_agreement_val": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "baa_attributes": {
+ "additionalProperties": false,
+ "description": "Override baa terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "aggregation_limitations_permitted": {
+ "type": "boolean"
+ },
+ "aggregation_limitations_permitted_val": {
+ "type": "string"
+ },
+ "breach_notification_unit": {
+ "enum": [
+ "hours",
+ "business days",
+ "calendar days"
+ ],
+ "type": "string"
+ },
+ "breach_notification_val": {
+ "type": "number"
+ },
+ "business_associate_relationship_type": {
+ "enum": [
+ "provider",
+ "company"
+ ],
+ "type": "string"
+ },
+ "deidentification_limitations_include_purpose": {
+ "type": "boolean"
+ },
+ "deidentification_limitations_include_requirements": {
+ "type": "boolean"
+ },
+ "deidentification_limitations_permitted": {
+ "type": "boolean"
+ },
+ "deidentification_limitations_purpose_val": {
+ "type": "string"
+ },
+ "deidentification_limitations_requirements_val": {
+ "type": "string"
+ },
+ "designated_record_set_provider_maintains": {
+ "type": "boolean"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_aggregation_limitations": {
+ "type": "boolean"
+ },
+ "include_deidentification_limitations": {
+ "type": "boolean"
+ },
+ "include_limitations": {
+ "type": "boolean"
+ },
+ "include_offshore_limitations": {
+ "type": "boolean"
+ },
+ "include_subcontract_limitations": {
+ "type": "boolean"
+ },
+ "offshore_limitations_permitted": {
+ "type": "boolean"
+ },
+ "offshore_limitations_permitted_val": {
+ "type": "string"
+ },
+ "subcontract_limitations_include_notice": {
+ "type": "boolean"
+ },
+ "subcontract_limitations_include_permission": {
+ "type": "boolean"
+ },
+ "subcontract_limitations_notice_val": {
+ "type": "string"
+ },
+ "subcontract_limitations_permission_val": {
+ "type": "string"
+ },
+ "subcontract_limitations_permitted": {
+ "type": "boolean"
+ },
+ "underlying_agreement_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "underlying_agreement_type": {
+ "enum": [
+ "internal",
+ "external",
+ "none"
+ ],
+ "type": "string"
+ },
+ "underlying_agreement_val": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "billing_email": {
+ "description": "Email of the billing contact. Used when include_billing_info is true.",
+ "format": "email",
+ "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "billing_name": {
+ "description": "Name of the billing contact. Used when include_billing_info is true.",
+ "type": "string"
+ },
+ "billing_workflow_type": {
+ "description": "The type of billing workflow. Use \"link\" to provide a payment_link_url, or \"stripe\" for Stripe-managed billing.",
+ "enum": [
+ "link",
+ "stripe"
+ ],
+ "type": "string"
+ },
+ "chosen_courts_country": {
+ "description": "The country in which disputes will be resolved.",
+ "type": "string"
+ },
+ "chosen_courts_region": {
+ "description": "The state or region in which disputes will be resolved.",
+ "type": "string"
+ },
+ "csa_attributes": {
+ "additionalProperties": false,
+ "description": "Override csa terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "customer_description": {
+ "type": "string"
+ },
+ "effective_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "effective_date_marketplace": {
+ "enum": [
+ "AWS",
+ "GCP",
+ "Azure"
+ ],
+ "type": "string"
+ },
+ "effective_date_type": {
+ "enum": [
+ "signature",
+ "date",
+ "marketplace_acceptance"
+ ],
+ "type": "string"
+ },
+ "general_cap_amount": {
+ "type": "number"
+ },
+ "general_cap_amount_type": {
+ "enum": [
+ "preceding",
+ "base",
+ "period"
+ ],
+ "type": "string"
+ },
+ "general_cap_period_currency": {
+ "type": "number"
+ },
+ "general_cap_period_qty": {
+ "type": "number"
+ },
+ "general_cap_preceding_amount": {
+ "type": "number"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_acceptable_use_policy": {
+ "type": "boolean"
+ },
+ "include_acceptable_use_policy_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_acceptable_use_policy_location": {
+ "type": "string"
+ },
+ "include_acceptable_use_policy_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_additional_warranties": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_by_customer": {
+ "type": "string"
+ },
+ "include_additional_warranties_by_provider": {
+ "type": "string"
+ },
+ "include_additional_warranties_include_by_customer": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_include_by_provider": {
+ "type": "boolean"
+ },
+ "include_ai_addendum": {
+ "type": "boolean"
+ },
+ "include_ai_addendum_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_covered_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_customer_claims": {
+ "type": "string"
+ },
+ "include_covered_claims_include_customer_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_include_provider_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_provider_claims": {
+ "type": "string"
+ },
+ "include_dpa": {
+ "type": "boolean"
+ },
+ "include_dpa_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_dpa_location": {
+ "type": "string"
+ },
+ "include_dpa_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_increased_cap_amount": {
+ "type": "boolean"
+ },
+ "include_increased_claims": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_confidentiality": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_confidentiality_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_privsec": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_privsec_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_other": {
+ "type": "boolean"
+ },
+ "include_increased_claims_indemnification_obligation": {
+ "type": "boolean"
+ },
+ "include_increased_claims_other": {
+ "type": "string"
+ },
+ "include_insurance_minimums": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_add_customer": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_add_customer_com_gen_liability": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_add_customer_cyber_liability": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_add_customer_errors_omissions": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_additional_information": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_additional_information_text": {
+ "type": "string"
+ },
+ "include_insurance_minimums_cyber_liability_aggregate": {
+ "type": "number"
+ },
+ "include_insurance_minimums_cyber_liability_minimum": {
+ "type": "number"
+ },
+ "include_insurance_minimums_employer_liability_aggregate": {
+ "type": "number"
+ },
+ "include_insurance_minimums_employer_liability_minimum": {
+ "type": "number"
+ },
+ "include_insurance_minimums_general_liability_aggregate": {
+ "type": "number"
+ },
+ "include_insurance_minimums_general_liability_minimum": {
+ "type": "number"
+ },
+ "include_insurance_minimums_include_cyber_liability": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_include_employer_liability": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_include_general_liability": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_include_workers_compensation": {
+ "type": "boolean"
+ },
+ "include_publicity_rights": {
+ "type": "boolean"
+ },
+ "include_publicity_rights_type": {
+ "enum": [
+ "public",
+ "non-public"
+ ],
+ "type": "string"
+ },
+ "include_security_policy": {
+ "type": "boolean"
+ },
+ "include_security_policy_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_security_policy_fedramp_auth": {
+ "type": "boolean"
+ },
+ "include_security_policy_hipaa": {
+ "type": "boolean"
+ },
+ "include_security_policy_hitrust": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_annual_maintenance": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_location": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_other": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_reasonable_efforts": {
+ "type": "boolean"
+ },
+ "include_security_policy_iso27001": {
+ "type": "boolean"
+ },
+ "include_security_policy_location": {
+ "type": "string"
+ },
+ "include_security_policy_other": {
+ "type": "string"
+ },
+ "include_security_policy_pci1": {
+ "type": "boolean"
+ },
+ "include_security_policy_pci2": {
+ "type": "boolean"
+ },
+ "include_security_policy_penetration_testing": {
+ "type": "boolean"
+ },
+ "include_security_policy_soc2": {
+ "type": "boolean"
+ },
+ "include_security_policy_soc2_type2": {
+ "type": "boolean"
+ },
+ "include_security_policy_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_supercap": {
+ "description": "CSA 3.0 renamed `include_increased_cap_amount` to `include_supercap`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_increased_cap_amount`. Sending the other spelling returns a 422.",
+ "type": "boolean"
+ },
+ "include_uncapped_claims": {
+ "description": "CSA 3.0 renamed `include_unlimited_claims` to `include_uncapped_claims`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims`. Sending the other spelling returns a 422.",
+ "type": "boolean"
+ },
+ "include_uncapped_claims_breach_of_confidentiality": {
+ "description": "CSA 3.0 renamed `include_unlimited_claims_breach_of_confidentiality` to `include_uncapped_claims_breach_of_confidentiality`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_breach_of_confidentiality`. Sending the other spelling returns a 422.",
+ "type": "boolean"
+ },
+ "include_uncapped_claims_breach_of_confidentiality_negligence": {
+ "description": "CSA 3.0 renamed `include_unlimited_claims_breach_of_confidentiality_negligence` to `include_uncapped_claims_breach_of_confidentiality_negligence`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_breach_of_confidentiality_negligence`. Sending the other spelling returns a 422.",
+ "type": "boolean"
+ },
+ "include_uncapped_claims_breach_of_privsec": {
+ "description": "CSA 3.0 renamed `include_unlimited_claims_breach_of_privsec` to `include_uncapped_claims_breach_of_privsec`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_breach_of_privsec`. Sending the other spelling returns a 422.",
+ "type": "boolean"
+ },
+ "include_uncapped_claims_breach_of_privsec_negligence": {
+ "description": "CSA 3.0 renamed `include_unlimited_claims_breach_of_privsec_negligence` to `include_uncapped_claims_breach_of_privsec_negligence`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_breach_of_privsec_negligence`. Sending the other spelling returns a 422.",
+ "type": "boolean"
+ },
+ "include_uncapped_claims_include_other": {
+ "description": "CSA 3.0 renamed `include_unlimited_claims_include_other` to `include_uncapped_claims_include_other`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_include_other`. Sending the other spelling returns a 422.",
+ "type": "boolean"
+ },
+ "include_uncapped_claims_indemnification_obligation": {
+ "description": "CSA 3.0 renamed `include_unlimited_claims_indemnification_obligation` to `include_uncapped_claims_indemnification_obligation`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_indemnification_obligation`. Sending the other spelling returns a 422.",
+ "type": "boolean"
+ },
+ "include_uncapped_claims_other": {
+ "description": "CSA 3.0 renamed `include_unlimited_claims_other` to `include_uncapped_claims_other`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_other`. Sending the other spelling returns a 422.",
+ "type": "boolean"
+ },
+ "include_unlimited_claims": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_confidentiality": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_confidentiality_negligence": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_privsec": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_privsec_negligence": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_include_other": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_indemnification_obligation": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_other": {
+ "type": "string"
+ },
+ "increased_cap_amount_currency": {
+ "type": "number"
+ },
+ "increased_cap_amount_period_currency": {
+ "type": "number"
+ },
+ "increased_cap_amount_period_qty": {
+ "type": "number"
+ },
+ "increased_cap_amount_qty": {
+ "type": "number"
+ },
+ "increased_cap_amount_type": {
+ "enum": [
+ "qty",
+ "currency",
+ "period"
+ ],
+ "type": "string"
+ },
+ "provider": {
+ "type": "string"
+ },
+ "supercap_currency": {
+ "description": "CSA 3.0 renamed `increased_cap_amount_currency` to `supercap_currency`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `increased_cap_amount_currency`. Sending the other spelling returns a 422.",
+ "type": "number"
+ },
+ "supercap_period_currency": {
+ "description": "CSA 3.0 renamed `increased_cap_amount_period_currency` to `supercap_period_currency`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `increased_cap_amount_period_currency`. Sending the other spelling returns a 422.",
+ "type": "number"
+ },
+ "supercap_period_qty": {
+ "description": "CSA 3.0 renamed `increased_cap_amount_period_qty` to `supercap_period_qty`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `increased_cap_amount_period_qty`. Sending the other spelling returns a 422.",
+ "type": "number"
+ },
+ "supercap_qty": {
+ "description": "CSA 3.0 renamed `increased_cap_amount_qty` to `supercap_qty`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `increased_cap_amount_qty`. Sending the other spelling returns a 422.",
+ "type": "number"
+ },
+ "supercap_type": {
+ "description": "CSA 3.0 renamed `increased_cap_amount_type` to `supercap_type`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `increased_cap_amount_type`. Sending the other spelling returns a 422.",
+ "type": "number"
+ }
+ },
+ "type": "object"
+ },
+ "csa_order_form_attributes": {
+ "additionalProperties": false,
+ "description": "Override csa order form terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "additional_changes": {
+ "type": "string"
+ },
+ "additional_parameters_or_limitations": {
+ "type": "string"
+ },
+ "affiliates_as_users": {
+ "type": "boolean"
+ },
+ "cloud_service_description": {
+ "type": "string"
+ },
+ "consumption_units": {
+ "type": "string"
+ },
+ "fee_amount": {
+ "type": "number"
+ },
+ "fee_custom_unit": {
+ "type": "string"
+ },
+ "fee_period": {
+ "enum": [
+ "Subscription Period",
+ "month",
+ "year",
+ "User",
+ "Custom unit"
+ ],
+ "type": "string"
+ },
+ "fees_attributes": {
+ "additionalProperties": {
+ "anyOf": [
+ {
+ "additionalProperties": false,
+ "description": "Fees::Flat (fee_type \"flat\"). A fixed recurring fee, e.g. a platform subscription. Set type to \"Fees::Flat\" or fee_type to \"flat\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Fixed amount in the order form's fees_currency, charged per fee_period. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"flat\". Alternative to type.",
+ "enum": [
+ "flat"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Flat\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Flat"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Discount (fee_type \"discount\"). A discount, as a fixed amount or a percentage, applied forever, once, or for a number of months. Set type to \"Fees::Discount\" or fee_type to \"discount\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Discount size: an amount in fees_currency when discount_type is fixed_amount (a plain amount, not cents: 20 means 20.00), or a percentage (e.g. 10 for 10%) when it is percentage.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "discount_duration_amount": {
+ "description": "Number of months the discount applies. Required when discount_duration_type is multiple_months.",
+ "type": "number"
+ },
+ "discount_duration_type": {
+ "description": "How long the discount applies. multiple_months also needs discount_duration_amount.",
+ "enum": [
+ "forever",
+ "once",
+ "multiple_months"
+ ],
+ "type": "string"
+ },
+ "discount_type": {
+ "description": "Whether cost is a currency amount or a percentage.",
+ "enum": [
+ "fixed_amount",
+ "percentage"
+ ],
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"discount\". Alternative to type.",
+ "enum": [
+ "discount"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Discount\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Discount"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Cost (fee_type \"cost\"). A per-unit fee: price per unit times quantity, e.g. seats. Set type to \"Fees::Cost\" or fee_type to \"cost\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Price per unit in fees_currency. The row total is quantity x cost. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"cost\". Alternative to type.",
+ "enum": [
+ "cost"
+ ],
+ "type": "string"
+ },
+ "quantity": {
+ "description": "Number of units.",
+ "type": "number"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Cost\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Cost"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Attachment (fee_type \"attachment\"). A fee described in an uploaded attachment instead of in the table. Set type to \"Fees::Attachment\" or fee_type to \"attachment\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "attachment_id": {
+ "description": "ID of an attachment uploaded with upload-attachment.",
+ "type": "string"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"attachment\". Alternative to type.",
+ "enum": [
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Attachment\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Attachment"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Graduated (fee_type \"graduated\"). Tiered pricing, with the price set per tier in graduated_fee_tiers_attributes. Set type to \"Fees::Graduated\" or fee_type to \"graduated\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"graduated\". Alternative to type.",
+ "enum": [
+ "graduated"
+ ],
+ "type": "string"
+ },
+ "graduated_fee_tiers_attributes": {
+ "additionalProperties": {
+ "additionalProperties": false,
+ "properties": {
+ "flat_price": {
+ "type": "number"
+ },
+ "price_per_unit": {
+ "type": "string"
+ },
+ "upper_limit": {
+ "type": "number"
+ }
+ },
+ "type": "object"
+ },
+ "description": "Graduated fee tiers. Use string keys such as \"0\", \"1\".",
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Graduated\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Graduated"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Included (fee_type \"included\"). An item included at no charge. Set type to \"Fees::Included\" or fee_type to \"included\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"included\". Alternative to type.",
+ "enum": [
+ "included"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Included\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Included"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Metered (fee_type \"metered\"). Usage-based pricing, billed per unit used. Set type to \"Fees::Metered\" or fee_type to \"metered\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Price per unit of usage in fees_currency. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"metered\". Alternative to type.",
+ "enum": [
+ "metered"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Metered\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Metered"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::OneTime (fee_type \"one_time\"). A one-time charge, such as a setup fee. Set type to \"Fees::OneTime\" or fee_type to \"one_time\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "One-time amount in fees_currency, charged once rather than per fee_period. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"one_time\". Alternative to type.",
+ "enum": [
+ "one_time"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::OneTime\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::OneTime"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Text (fee_type \"text\"). A fee term described in free text. Set type to \"Fees::Text\" or fee_type to \"text\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"text\". Alternative to type.",
+ "enum": [
+ "text"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Text\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Text"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ }
+ ]
+ },
+ "description": "Fee table rows, keyed by string index (\"0\", \"1\", ...). Replaces the template's fees when provided. Each row sets type or fee_type to pick the fee class. Amounts are in the order form's fees_currency and, for recurring fees, are charged per fee_period.",
+ "examples": [
+ {
+ "0": {
+ "cost": 2000,
+ "description": "Platform subscription",
+ "type": "Fees::Flat"
+ }
+ },
+ {
+ "0": {
+ "cost": 50,
+ "description": "Seats",
+ "fee_type": "cost",
+ "quantity": 10
+ },
+ "1": {
+ "cost": 10,
+ "description": "Launch discount",
+ "discount_duration_amount": 3,
+ "discount_duration_type": "multiple_months",
+ "discount_type": "percentage",
+ "fee_type": "discount"
+ }
+ }
+ ],
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+ },
+ "fees_currency": {
+ "enum": [
+ "USD",
+ "EUR",
+ "GBP",
+ "CAD",
+ "AUD",
+ "SGD",
+ "ILS",
+ "JPY",
+ "CHF",
+ "HKD"
+ ],
+ "type": "string"
+ },
+ "fees_include_fee_increase_upon_renewal": {
+ "type": "boolean"
+ },
+ "fees_include_fee_increase_upon_renewal_fee": {
+ "type": "number"
+ },
+ "fees_include_fee_increase_upon_renewal_type": {
+ "enum": [
+ "will",
+ "may"
+ ],
+ "type": "string"
+ },
+ "fees_inclusive_of_taxes": {
+ "type": "boolean"
+ },
+ "framework_terms_type": {
+ "enum": [
+ "new",
+ "existing",
+ "description"
+ ],
+ "type": "string"
+ },
+ "free_trial_days": {
+ "type": "number"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_additional_changes": {
+ "type": "boolean"
+ },
+ "include_additional_parameters_or_limitations": {
+ "type": "boolean"
+ },
+ "include_consumption": {
+ "type": "boolean"
+ },
+ "include_fees": {
+ "type": "boolean"
+ },
+ "include_fees_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_fees_include_attachment": {
+ "type": "boolean"
+ },
+ "include_fees_other": {
+ "type": "boolean"
+ },
+ "include_fees_other_val": {
+ "type": "string"
+ },
+ "include_fees_table": {
+ "type": "boolean"
+ },
+ "include_fees_table_period": {
+ "enum": [
+ "Subscription Period",
+ "month",
+ "year",
+ "User"
+ ],
+ "type": "string"
+ },
+ "include_free_trial": {
+ "type": "boolean"
+ },
+ "include_max_users": {
+ "type": "boolean"
+ },
+ "include_pilot_period": {
+ "type": "boolean"
+ },
+ "include_pilot_period_duration_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_pilot_period_duration_type": {
+ "enum": [
+ "day",
+ "week",
+ "month"
+ ],
+ "type": "string"
+ },
+ "include_pilot_period_include_fees": {
+ "type": "boolean"
+ },
+ "include_pilot_period_include_fees_amount": {
+ "type": "number"
+ },
+ "include_pilot_period_include_modifications": {
+ "type": "boolean"
+ },
+ "include_pilot_period_include_modifications_description": {
+ "type": "string"
+ },
+ "include_product_support": {
+ "type": "boolean"
+ },
+ "include_product_support_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_product_support_description": {
+ "type": "string"
+ },
+ "include_product_support_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_professional_services": {
+ "type": "boolean"
+ },
+ "include_professional_services_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_professional_services_custom_name": {
+ "type": "string"
+ },
+ "include_professional_services_description": {
+ "type": "string"
+ },
+ "include_professional_services_end_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "include_professional_services_fees_description": {
+ "type": "string"
+ },
+ "include_professional_services_include_end_date": {
+ "type": "boolean"
+ },
+ "include_professional_services_include_fees_description": {
+ "type": "boolean"
+ },
+ "include_professional_services_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_sla": {
+ "type": "boolean"
+ },
+ "include_sla_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_sla_description": {
+ "type": "string"
+ },
+ "include_sla_include_response_time": {
+ "type": "boolean"
+ },
+ "include_sla_include_response_time_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_sla_include_response_time_credit": {
+ "type": "number"
+ },
+ "include_sla_include_response_time_duration": {
+ "enum": [
+ "hour",
+ "day",
+ "week",
+ "month",
+ "hours"
+ ],
+ "type": "string"
+ },
+ "include_sla_include_response_time_support_channel": {
+ "type": "string"
+ },
+ "include_sla_include_target_uptime": {
+ "type": "boolean"
+ },
+ "include_sla_maintenance_notice": {
+ "type": "boolean"
+ },
+ "include_sla_maintenance_window": {
+ "type": "boolean"
+ },
+ "include_sla_maintenance_window_type": {
+ "enum": [
+ "standard",
+ "none"
+ ],
+ "type": "string"
+ },
+ "include_sla_standard_maintenance_notice_qty": {
+ "type": "number"
+ },
+ "include_sla_standard_maintenance_notice_unit": {
+ "enum": [
+ "hour",
+ "day",
+ "week",
+ "month"
+ ],
+ "type": "string"
+ },
+ "include_sla_standard_maintenance_window_end_time": {
+ "type": "string"
+ },
+ "include_sla_standard_maintenance_window_friday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_monday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_saturday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_start_time": {
+ "type": "string"
+ },
+ "include_sla_standard_maintenance_window_sunday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_thursday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_time_zone": {
+ "type": "string"
+ },
+ "include_sla_standard_maintenance_window_tuesday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_wednesday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_target_uptime": {
+ "type": "number"
+ },
+ "include_sla_type": {
+ "enum": [
+ "description",
+ "standard",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_subscription_start_date": {
+ "type": "boolean"
+ },
+ "include_subscription_start_date_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "include_usage_review": {
+ "type": "boolean"
+ },
+ "include_usage_review_val": {
+ "type": "string"
+ },
+ "include_use_limitations": {
+ "type": "boolean"
+ },
+ "include_use_limitations_val": {
+ "type": "string"
+ },
+ "invoice_period": {
+ "enum": [
+ "monthly",
+ "quarterly",
+ "semiannually",
+ "annually",
+ "Custom unit",
+ "Monthly",
+ "Quarterly",
+ "Semiannually",
+ "Annually"
+ ],
+ "type": "string"
+ },
+ "invoice_period_custom_unit": {
+ "type": "string"
+ },
+ "max_consumption": {
+ "type": "number"
+ },
+ "max_users": {
+ "type": "number"
+ },
+ "negotiations_allowed": {
+ "description": "When true, the recipient can propose changes to the order form, even when the agreement-level `negotiations_allowed` is false. This only covers the order form.",
+ "type": "boolean"
+ },
+ "order_date_date": {
+ "type": "string"
+ },
+ "order_date_other": {
+ "type": "string"
+ },
+ "order_date_type": {
+ "enum": [
+ "signature",
+ "date",
+ "other"
+ ],
+ "type": "string"
+ },
+ "payment_period": {
+ "type": "number"
+ },
+ "payment_period_timeframe": {
+ "enum": [
+ "Customer's receipt of invoice",
+ "date of invoice"
+ ],
+ "type": "string"
+ },
+ "payment_period_unit": {
+ "enum": [
+ "day(s)",
+ "week(s)",
+ "month(s)",
+ "marketplace_acceptance"
+ ],
+ "type": "string"
+ },
+ "payment_process_automatic_frequency": {
+ "enum": [
+ "monthly",
+ "quarterly",
+ "semiannually",
+ "annually"
+ ],
+ "type": "string"
+ },
+ "payment_process_type": {
+ "enum": [
+ "automatic",
+ "invoice",
+ "custom",
+ "marketplace_acceptance"
+ ],
+ "type": "string"
+ },
+ "payment_process_type_custom_val": {
+ "type": "string"
+ },
+ "payment_process_type_invoice_amount": {
+ "type": "number"
+ },
+ "payment_process_type_invoice_custom_unit": {
+ "type": "string"
+ },
+ "payment_process_type_invoice_duration": {
+ "enum": [
+ "day",
+ "week",
+ "month",
+ "year",
+ "day(s)",
+ "week(s)",
+ "month(s)",
+ "year(s)"
+ ],
+ "type": "string"
+ },
+ "payment_process_type_invoice_duration_start": {
+ "enum": [
+ "Customer's receipt of invoice",
+ "date of invoice"
+ ],
+ "type": "string"
+ },
+ "payment_process_type_invoice_type": {
+ "enum": [
+ "monthly",
+ "quarterly",
+ "semiannually",
+ "annually",
+ "Custom unit"
+ ],
+ "type": "string"
+ },
+ "pilot_period_stripe_product_id": {
+ "type": "string"
+ },
+ "service_credits_attributes": {
+ "additionalProperties": {
+ "additionalProperties": false,
+ "properties": {
+ "credit": {
+ "type": "number"
+ },
+ "max": {
+ "type": "number"
+ },
+ "min": {
+ "type": "number"
+ }
+ },
+ "type": "object"
+ },
+ "description": "Service credits. Use string keys such as \"0\", \"1\".",
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+ },
+ "subscription_auto_renew": {
+ "enum": [
+ "days",
+ "subscription_end"
+ ],
+ "type": "string"
+ },
+ "subscription_period": {
+ "type": "number"
+ },
+ "subscription_period_unit": {
+ "type": "string"
+ },
+ "subscription_renewal_notice_days": {
+ "type": "number"
+ },
+ "subscription_start_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "subscription_start_date_type": {
+ "enum": [
+ "effective_date",
+ "date"
+ ],
+ "type": "string"
+ },
+ "underlying_agreement_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "use_limitations_attributes": {
+ "additionalProperties": {
+ "additionalProperties": false,
+ "properties": {
+ "amount": {
+ "type": "number"
+ },
+ "limitation_type": {
+ "type": "string"
+ },
+ "unit": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "description": "Use limitations. Use string keys such as \"0\", \"1\".",
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+ }
+ },
+ "type": "object"
+ },
+ "custom_field_values": {
+ "description": "Values for a custom template's fields, keyed by the field keys defined in the template's YAML definition. Only used when template_id is a custom template. Template defaults fill any fields you omit; a required field with no default and no submitted value returns a 400 naming the field. Values are validated against the field's input type: select and radio values must be one of the field's options, multiselect values are an array of selections each of which must be one of the field's options, number and currency values must be numeric, date values must be YYYY-MM-DD, and email values must be valid addresses. An invalid value returns a 400 naming the field."
+ },
+ "design_partner_attributes": {
+ "additionalProperties": false,
+ "description": "Override design partner terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "customer_description": {
+ "type": "string"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_fees": {
+ "type": "boolean"
+ },
+ "include_fees_amount": {
+ "type": "number"
+ },
+ "include_fees_description": {
+ "type": "string"
+ },
+ "include_fees_pay_by_amount": {
+ "type": "string"
+ },
+ "include_fees_type": {
+ "enum": [
+ "default_language",
+ "description"
+ ],
+ "type": "string"
+ },
+ "include_fees_unit": {
+ "enum": [
+ "month",
+ "quarter",
+ "year",
+ "Term"
+ ],
+ "type": "string"
+ },
+ "include_program_appear_as_customer_private": {
+ "type": "boolean"
+ },
+ "include_program_appear_as_customer_public": {
+ "type": "boolean"
+ },
+ "include_program_case_study": {
+ "type": "boolean"
+ },
+ "include_program_develop_functionality": {
+ "type": "boolean"
+ },
+ "include_program_develop_functionality_val": {
+ "type": "string"
+ },
+ "include_program_discount": {
+ "type": "boolean"
+ },
+ "include_program_discount_amount": {
+ "type": "number"
+ },
+ "include_program_discount_unit": {
+ "enum": [
+ "U.S. Dollars",
+ "percent"
+ ],
+ "type": "string"
+ },
+ "include_program_participation_feedback": {
+ "type": "boolean"
+ },
+ "include_program_participation_feedback_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_program_participation_feedback_unit": {
+ "enum": [
+ "month",
+ "quarter",
+ "year",
+ "Term"
+ ],
+ "type": "string"
+ },
+ "include_program_partner_other": {
+ "type": "boolean"
+ },
+ "include_program_partner_other_val": {
+ "type": "string"
+ },
+ "include_program_provider_other": {
+ "type": "boolean"
+ },
+ "include_program_provider_other_val": {
+ "type": "string"
+ },
+ "include_program_reference": {
+ "type": "boolean"
+ },
+ "product_description": {
+ "type": "string"
+ },
+ "term_amount": {
+ "type": "number"
+ },
+ "term_unit": {
+ "enum": [
+ "day(s)",
+ "week(s)",
+ "month(s)",
+ "quarter(s)",
+ "year(s)"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "district_or_county": {
+ "description": "The district or county for dispute resolution.",
+ "type": "string"
+ },
+ "dpa_attributes": {
+ "additionalProperties": false,
+ "description": "Override dpa terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "approved_subprocessor_type": {
+ "description": "`internal` lists approved subprocessors in the agreement (`subprocessors_attributes`); `external` points to a list published elsewhere.",
+ "enum": [
+ "internal",
+ "external"
+ ],
+ "type": "string"
+ },
+ "cloud_service_product_name": {
+ "type": "string"
+ },
+ "competent_supervisory_authority": {
+ "type": "string"
+ },
+ "customer_description": {
+ "type": "string"
+ },
+ "data_exporter_address_city": {
+ "type": "string"
+ },
+ "data_exporter_address_country": {
+ "type": "string"
+ },
+ "data_exporter_address_state": {
+ "type": "string"
+ },
+ "data_exporter_address_street_address": {
+ "type": "string"
+ },
+ "data_exporter_address_zipcode": {
+ "type": "string"
+ },
+ "data_exporter_contact_details": {
+ "type": "string"
+ },
+ "data_exporter_contact_name": {
+ "type": "string"
+ },
+ "data_exporter_contact_position": {
+ "type": "string"
+ },
+ "data_exporter_role": {
+ "description": "Role of the data exporter. Overwritten to `Controller` when the agreement is created from a template.",
+ "enum": [
+ "Controller",
+ "Processor"
+ ],
+ "type": "string"
+ },
+ "data_importer_address": {
+ "type": "string"
+ },
+ "data_importer_address_city": {
+ "type": "string"
+ },
+ "data_importer_address_country": {
+ "type": "string"
+ },
+ "data_importer_address_state": {
+ "type": "string"
+ },
+ "data_importer_address_street_address": {
+ "type": "string"
+ },
+ "data_importer_address_zipcode": {
+ "type": "string"
+ },
+ "data_importer_contact_details": {
+ "type": "string"
+ },
+ "data_importer_contact_name": {
+ "type": "string"
+ },
+ "data_importer_contact_position": {
+ "type": "string"
+ },
+ "duration_of_processing": {
+ "type": "string"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_covered_claim": {
+ "type": "boolean"
+ },
+ "include_covered_claim_external_val": {
+ "type": "string"
+ },
+ "include_covered_claim_internal_val": {
+ "type": "string"
+ },
+ "include_covered_claim_type": {
+ "description": "Which covered-claim text applies: `internal` uses `include_covered_claim_internal_val`, `external` uses `include_covered_claim_external_val`. Required when `include_covered_claim` is true.",
+ "enum": [
+ "internal",
+ "external"
+ ],
+ "type": "string"
+ },
+ "include_data_subjects_custom": {
+ "type": "boolean"
+ },
+ "include_data_subjects_custom_val": {
+ "type": "string"
+ },
+ "include_data_subjects_employees": {
+ "type": "boolean"
+ },
+ "include_data_subjects_end_users": {
+ "type": "boolean"
+ },
+ "include_external_subprocessor_location": {
+ "type": "string"
+ },
+ "include_frequency_of_transfer_continuous": {
+ "type": "boolean"
+ },
+ "include_frequency_of_transfer_custom": {
+ "type": "boolean"
+ },
+ "include_frequency_of_transfer_custom_val": {
+ "type": "string"
+ },
+ "include_governing_country_eu": {
+ "type": "boolean"
+ },
+ "include_governing_country_eu_val": {
+ "type": "string"
+ },
+ "include_governing_country_uk": {
+ "type": "boolean"
+ },
+ "include_governing_country_uk_val": {
+ "type": "string"
+ },
+ "include_governing_law": {
+ "type": "boolean"
+ },
+ "include_governing_law_country": {
+ "type": "string"
+ },
+ "include_governing_law_state": {
+ "type": "string"
+ },
+ "include_increased_claim_amount": {
+ "description": "Legacy field. Stored but not shown on the DPA; use the `include_liability_cap*` fields instead.",
+ "type": "boolean"
+ },
+ "include_increased_claim_amount_currency": {
+ "description": "Legacy field. Stored but not shown on the DPA; use the `include_liability_cap*` fields instead."
+ },
+ "include_increased_claim_amount_qty": {
+ "description": "Legacy field. Stored but not shown on the DPA; use the `include_liability_cap*` fields instead."
+ },
+ "include_increased_claim_amount_type": {
+ "description": "Legacy field. Stored but not shown on the DPA; use the `include_liability_cap*` fields instead.",
+ "type": "string"
+ },
+ "include_liability_cap": {
+ "type": "boolean"
+ },
+ "include_liability_cap_amount_constant_external": {
+ "type": "string"
+ },
+ "include_liability_cap_amount_constant_internal": {
+ "type": "string"
+ },
+ "include_liability_cap_amount_currency_external": {
+ "description": "Currency amount. Numbers and numeric strings (commas allowed) are both accepted."
+ },
+ "include_liability_cap_amount_currency_internal": {
+ "description": "Currency amount. Numbers and numeric strings (commas allowed) are both accepted."
+ },
+ "include_liability_cap_csa_type": {
+ "description": "Which liability cap values apply: the `_internal` or `_external` amount fields. Required when `include_liability_cap` is true.",
+ "enum": [
+ "internal",
+ "external"
+ ],
+ "type": "string"
+ },
+ "include_personal_data_biographic_info": {
+ "type": "boolean"
+ },
+ "include_personal_data_contact_info": {
+ "type": "boolean"
+ },
+ "include_personal_data_custom": {
+ "type": "boolean"
+ },
+ "include_personal_data_custom_val": {
+ "type": "string"
+ },
+ "include_personal_data_employment_info": {
+ "type": "boolean"
+ },
+ "include_personal_data_financial_info": {
+ "type": "boolean"
+ },
+ "include_personal_data_location": {
+ "type": "boolean"
+ },
+ "include_personal_data_name": {
+ "type": "boolean"
+ },
+ "include_personal_data_transactional_info": {
+ "type": "boolean"
+ },
+ "include_personal_data_user_activity_info": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_custom": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_custom_val": {
+ "type": "string"
+ },
+ "include_processing_purpose_erasing": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_holding": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_protecting": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_receiving": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_returning": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_sharing": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_updating": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_using": {
+ "type": "boolean"
+ },
+ "include_provider_security_contact_address": {
+ "type": "boolean"
+ },
+ "include_provider_security_contact_address_city": {
+ "type": "string"
+ },
+ "include_provider_security_contact_address_country": {
+ "type": "string"
+ },
+ "include_provider_security_contact_address_state": {
+ "type": "string"
+ },
+ "include_provider_security_contact_address_street_address": {
+ "type": "string"
+ },
+ "include_provider_security_contact_address_zipcode": {
+ "type": "string"
+ },
+ "include_provider_security_contact_email": {
+ "type": "boolean"
+ },
+ "include_provider_security_contact_email_val": {
+ "format": "email",
+ "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "include_security_measures_accountability": {
+ "type": "boolean"
+ },
+ "include_security_measures_accountability_val": {
+ "type": "string"
+ },
+ "include_security_measures_certification_or_assurance": {
+ "type": "boolean"
+ },
+ "include_security_measures_certification_or_assurance_val": {
+ "type": "string"
+ },
+ "include_security_measures_confidentiality_integrity": {
+ "type": "boolean"
+ },
+ "include_security_measures_confidentiality_integrity_val": {
+ "type": "string"
+ },
+ "include_security_measures_data_at_rest": {
+ "type": "boolean"
+ },
+ "include_security_measures_data_at_rest_val": {
+ "type": "string"
+ },
+ "include_security_measures_data_minimization": {
+ "type": "boolean"
+ },
+ "include_security_measures_data_minimization_val": {
+ "type": "string"
+ },
+ "include_security_measures_data_quality": {
+ "type": "boolean"
+ },
+ "include_security_measures_data_quality_val": {
+ "type": "string"
+ },
+ "include_security_measures_data_retention": {
+ "type": "boolean"
+ },
+ "include_security_measures_data_retention_val": {
+ "type": "string"
+ },
+ "include_security_measures_data_transmission": {
+ "type": "boolean"
+ },
+ "include_security_measures_data_transmission_val": {
+ "type": "string"
+ },
+ "include_security_measures_event_logging": {
+ "type": "boolean"
+ },
+ "include_security_measures_event_logging_val": {
+ "type": "string"
+ },
+ "include_security_measures_identity_auth": {
+ "type": "boolean"
+ },
+ "include_security_measures_identity_auth_val": {
+ "type": "string"
+ },
+ "include_security_measures_it_security_governance": {
+ "type": "boolean"
+ },
+ "include_security_measures_it_security_governance_val": {
+ "type": "string"
+ },
+ "include_security_measures_physical_security": {
+ "type": "boolean"
+ },
+ "include_security_measures_physical_security_val": {
+ "type": "string"
+ },
+ "include_security_measures_portability_and_erasure": {
+ "type": "boolean"
+ },
+ "include_security_measures_portability_and_erasure_val": {
+ "type": "string"
+ },
+ "include_security_measures_pseudonym_encryption": {
+ "type": "boolean"
+ },
+ "include_security_measures_pseudonym_encryption_val": {
+ "type": "string"
+ },
+ "include_security_measures_restore_data_access": {
+ "type": "boolean"
+ },
+ "include_security_measures_restore_data_access_val": {
+ "type": "string"
+ },
+ "include_security_measures_security_policy": {
+ "type": "boolean"
+ },
+ "include_security_measures_system_configuration": {
+ "type": "boolean"
+ },
+ "include_security_measures_system_configuration_val": {
+ "type": "string"
+ },
+ "include_security_measures_testing_assessment": {
+ "type": "boolean"
+ },
+ "include_security_measures_testing_assessment_val": {
+ "type": "string"
+ },
+ "include_security_policy": {
+ "type": "boolean"
+ },
+ "include_security_policy_fedramp_auth": {
+ "type": "boolean"
+ },
+ "include_security_policy_hipaa": {
+ "type": "boolean"
+ },
+ "include_security_policy_hitrust": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_other": {
+ "type": "boolean"
+ },
+ "include_security_policy_iso27001": {
+ "type": "boolean"
+ },
+ "include_security_policy_other": {
+ "type": "string"
+ },
+ "include_security_policy_pci1": {
+ "type": "boolean"
+ },
+ "include_security_policy_pci2": {
+ "type": "boolean"
+ },
+ "include_security_policy_penetration_testing": {
+ "type": "boolean"
+ },
+ "include_security_policy_soc2": {
+ "type": "boolean"
+ },
+ "include_security_policy_soc2_type2": {
+ "type": "boolean"
+ },
+ "include_sensitive_data_restrictions_custom": {
+ "type": "boolean"
+ },
+ "include_sensitive_data_restrictions_custom_val": {
+ "type": "string"
+ },
+ "include_sensitive_data_restrictions_security_policy": {
+ "type": "boolean"
+ },
+ "include_service_provider_relationship": {
+ "type": "boolean"
+ },
+ "include_special_category_data": {
+ "type": "boolean"
+ },
+ "provider": {
+ "type": "string"
+ },
+ "security_policy_available_at": {
+ "type": "string"
+ },
+ "security_policy_type": {
+ "description": "Where the Security Policy is defined. For `external`, set `security_policy_available_at`.",
+ "enum": [
+ "defined in agreement",
+ "provider service",
+ "external"
+ ],
+ "type": "string"
+ },
+ "subprocessors_attributes": {
+ "additionalProperties": {
+ "additionalProperties": false,
+ "properties": {
+ "_destroy": {
+ "description": "Set to true with `id` to remove that subprocessor.",
+ "type": "boolean"
+ },
+ "country": {
+ "type": "string"
+ },
+ "id": {
+ "description": "ID of an existing subprocessor to update or remove. Omit to add a new subprocessor.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "processing_task": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "description": "Subprocessors, keyed by string index such as \"0\", \"1\". On create these are added to the template's subprocessors. On a draft update, an entry without `id` adds a new subprocessor; pass `id` to change one and `id` with `_destroy: true` to remove one.",
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+ },
+ "underlying_agreement_id": {
+ "description": "ID of the CSA this DPA supplements when `underlying_agreement_type` is `internal`.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "underlying_agreement_type": {
+ "description": "`internal` links a CSA in Common Paper (`underlying_agreement_id`); `external` describes another agreement in `underlying_agreement_val` (required). Omit for none.",
+ "enum": [
+ "internal",
+ "external"
+ ],
+ "type": "string"
+ },
+ "underlying_agreement_val": {
+ "description": "Description of the agreement this DPA supplements. Required when `underlying_agreement_type` is `external`.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "framework_terms_description": {
+ "description": "Custom framework terms description. Only used when framework_terms_type is \"description\".",
+ "type": "string"
+ },
+ "framework_terms_type": {
+ "description": "How framework terms are specified. Use \"new\" for standard terms or \"description\" to provide a custom framework_terms_description.",
+ "enum": [
+ "new",
+ "description"
+ ],
+ "type": "string"
+ },
+ "governing_law_country": {
+ "description": "The country whose laws govern the agreement.",
+ "type": "string"
+ },
+ "governing_law_region": {
+ "description": "The state or region whose laws govern the agreement.",
+ "type": "string"
+ },
+ "include_automated_payment_reminders": {
+ "description": "When true, automatically sends payment reminder emails.",
+ "type": "boolean"
+ },
+ "include_billing_info": {
+ "description": "When true, billing contact information (billing_name, billing_email) is included.",
+ "type": "boolean"
+ },
+ "include_billing_workflow": {
+ "description": "When true, enables a billing workflow after signing.",
+ "type": "boolean"
+ },
+ "include_expiration_date": {
+ "description": "Expiration date in YYYY-MM-DD format. Use when include_expiration_type is \"date\".",
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "include_expiration_days": {
+ "description": "Number of days until the agreement expires. Use when include_expiration_type is \"days\".",
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_expiration_type": {
+ "description": "How to set expiration: \"none\" (default), \"days\" (use include_expiration_days), or \"date\" (use include_expiration_date).",
+ "enum": [
+ "none",
+ "days",
+ "date"
+ ],
+ "type": "string"
+ },
+ "include_terms": {
+ "description": "When true, the standard terms are included with the agreement.",
+ "type": "boolean"
+ },
+ "loi_attributes": {
+ "additionalProperties": false,
+ "description": "Override loi terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "confidentiality_custom": {
+ "type": "string"
+ },
+ "confidentiality_mutual_include_loi": {
+ "type": "boolean"
+ },
+ "confidentiality_nda_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "confidentiality_nda_description": {
+ "type": "string"
+ },
+ "confidentiality_nda_include_loi": {
+ "type": "boolean"
+ },
+ "confidentiality_nda_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "confidentiality_type": {
+ "enum": [
+ "mutual",
+ "nda",
+ "provider",
+ "custom"
+ ],
+ "type": "string"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_custom_details": {
+ "type": "boolean"
+ },
+ "include_custom_details_val": {
+ "type": "string"
+ },
+ "include_fees": {
+ "type": "boolean"
+ },
+ "include_fees_amount": {
+ "type": "number"
+ },
+ "include_fees_amount_duration": {
+ "enum": [
+ "month",
+ "year",
+ "quarter"
+ ],
+ "type": "string"
+ },
+ "include_fees_include_amount": {
+ "type": "boolean"
+ },
+ "include_fees_include_other": {
+ "type": "boolean"
+ },
+ "include_fees_other": {
+ "type": "string"
+ },
+ "include_functionality": {
+ "type": "boolean"
+ },
+ "include_functionality_val": {
+ "type": "string"
+ },
+ "include_launch_date": {
+ "type": "boolean"
+ },
+ "include_launch_date_custom": {
+ "type": "string"
+ },
+ "include_launch_date_date": {
+ "format": "date-time",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$",
+ "type": "string"
+ },
+ "include_launch_date_type": {
+ "enum": [
+ "date",
+ "custom"
+ ],
+ "type": "string"
+ },
+ "product_name": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "manual_send": {
+ "description": "When true, the agreement is marked as manually sent outside the platform.",
+ "type": "boolean"
+ },
+ "message": {
+ "type": "string"
+ },
+ "negotiations_allowed": {
+ "description": "When true, the recipient can propose changes to the legal terms. For agreement types without separate business terms, that covers every term. CSA order forms, PSA statements of work, partnership business terms and software license order forms have their own `negotiations_allowed` flag.",
+ "type": "boolean"
+ },
+ "partnership_attributes": {
+ "additionalProperties": false,
+ "description": "Override partnership terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "effective_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "effective_date_type": {
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "type": "string"
+ },
+ "general_cap_amount_currency_val": {
+ "type": "number"
+ },
+ "general_cap_amount_either_currency": {
+ "type": "number"
+ },
+ "general_cap_amount_either_multiple": {
+ "type": "number"
+ },
+ "general_cap_amount_multiple_val": {
+ "type": "number"
+ },
+ "general_cap_amount_type": {
+ "enum": [
+ "multiple",
+ "currency",
+ "either",
+ "base"
+ ],
+ "type": "string"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_additional_warranties": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_include_company": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_include_company_val": {
+ "type": "string"
+ },
+ "include_additional_warranties_include_partner": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_include_partner_val": {
+ "type": "string"
+ },
+ "include_brand_guidelines": {
+ "type": "boolean"
+ },
+ "include_brand_guidelines_include_company": {
+ "type": "boolean"
+ },
+ "include_brand_guidelines_include_company_val": {
+ "type": "string"
+ },
+ "include_brand_guidelines_include_partner": {
+ "type": "boolean"
+ },
+ "include_brand_guidelines_include_partner_val": {
+ "type": "string"
+ },
+ "include_covered_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_company_claims": {
+ "type": "string"
+ },
+ "include_covered_claims_include_company_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_include_partner_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_partner_claims": {
+ "type": "string"
+ },
+ "include_dpa": {
+ "type": "boolean"
+ },
+ "include_dpa_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_dpa_location": {
+ "type": "string"
+ },
+ "include_dpa_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_increased_cap_amount": {
+ "type": "boolean"
+ },
+ "include_increased_cap_amount_currency": {
+ "type": "number"
+ },
+ "include_increased_cap_amount_either_currency": {
+ "type": "number"
+ },
+ "include_increased_cap_amount_either_multiple": {
+ "type": "string"
+ },
+ "include_increased_cap_amount_multiple": {
+ "type": "string"
+ },
+ "include_increased_cap_amount_type": {
+ "enum": [
+ "multiple",
+ "currency",
+ "either"
+ ],
+ "type": "string"
+ },
+ "include_increased_claims": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_confidentiality": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_confidentiality_misconduct": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_covered_claims": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_misconduct": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_other": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_other_val": {
+ "type": "string"
+ },
+ "include_unlimited_claims": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_confidentiality": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_confidentiality_misconduct": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_covered_claims": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_misconduct": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_other": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_other_val": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "partnership_business_terms_attributes": {
+ "additionalProperties": false,
+ "description": "Override partnership business terms terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "end_date_after_effective_date_amount": {
+ "type": "number"
+ },
+ "end_date_after_effective_date_unit": {
+ "enum": [
+ "month(s)",
+ "quarter(s)",
+ "year(s)"
+ ],
+ "type": "string"
+ },
+ "end_date_date": {
+ "type": "string"
+ },
+ "end_date_type": {
+ "enum": [
+ "date",
+ "effective date"
+ ],
+ "type": "string"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_obligations_company_brand": {
+ "type": "boolean"
+ },
+ "include_obligations_company_promotion": {
+ "type": "boolean"
+ },
+ "include_obligations_company_promotion_include_activities": {
+ "type": "boolean"
+ },
+ "include_obligations_company_promotion_include_activities_val": {
+ "type": "string"
+ },
+ "include_obligations_company_promotion_include_materials": {
+ "type": "boolean"
+ },
+ "include_obligations_company_promotion_include_materials_val": {
+ "type": "string"
+ },
+ "include_obligations_company_referral": {
+ "type": "boolean"
+ },
+ "include_obligations_company_referral_include_criteria": {
+ "type": "boolean"
+ },
+ "include_obligations_company_referral_include_criteria_val": {
+ "type": "string"
+ },
+ "include_obligations_company_referral_include_pay_sch": {
+ "type": "boolean"
+ },
+ "include_obligations_company_referral_include_pay_sch_amount": {
+ "type": "number"
+ },
+ "include_obligations_company_referral_include_pay_sch_custom": {
+ "type": "string"
+ },
+ "include_obligations_company_referral_include_pay_sch_unit": {
+ "enum": [
+ "U.S. Dollars",
+ "percent"
+ ],
+ "type": "string"
+ },
+ "include_obligations_company_sponsorship": {
+ "type": "boolean"
+ },
+ "include_obligations_company_sponsorship_include_benefits": {
+ "type": "boolean"
+ },
+ "include_obligations_company_sponsorship_include_benefits_val": {
+ "type": "string"
+ },
+ "include_obligations_company_sponsorship_include_payments": {
+ "type": "boolean"
+ },
+ "include_obligations_company_sponsorship_include_payments_amount": {
+ "type": "number"
+ },
+ "include_obligations_company_sponsorship_include_payments_unit": {
+ "enum": [
+ "U.S. Dollars",
+ "percent"
+ ],
+ "type": "string"
+ },
+ "include_obligations_partner_brand": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_promotion": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_promotion_include_activities": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_promotion_include_activities_val": {
+ "type": "string"
+ },
+ "include_obligations_partner_promotion_include_materials": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_promotion_include_materials_val": {
+ "type": "string"
+ },
+ "include_obligations_partner_referral": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_referral_include_criteria": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_referral_include_criteria_val": {
+ "type": "string"
+ },
+ "include_obligations_partner_referral_include_pay_sch": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_referral_include_pay_sch_amount": {
+ "type": "number"
+ },
+ "include_obligations_partner_referral_include_pay_sch_custom": {
+ "type": "string"
+ },
+ "include_obligations_partner_referral_include_pay_sch_unit": {
+ "enum": [
+ "U.S. Dollars",
+ "percent"
+ ],
+ "type": "string"
+ },
+ "include_obligations_partner_sponsorship": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_sponsorship_include_benefits": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_sponsorship_include_benefits_val": {
+ "type": "string"
+ },
+ "include_obligations_partner_sponsorship_include_payments": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_sponsorship_include_payments_amount": {
+ "type": "number"
+ },
+ "include_obligations_partner_sponsorship_include_payments_unit": {
+ "enum": [
+ "U.S. Dollars",
+ "percent"
+ ],
+ "type": "string"
+ },
+ "include_payment_process": {
+ "type": "boolean"
+ },
+ "include_payment_process_company": {
+ "type": "boolean"
+ },
+ "include_payment_process_company_include_address": {
+ "type": "boolean"
+ },
+ "include_payment_process_company_include_address_city": {
+ "type": "string"
+ },
+ "include_payment_process_company_include_address_country": {
+ "type": "string"
+ },
+ "include_payment_process_company_include_address_state": {
+ "type": "string"
+ },
+ "include_payment_process_company_include_address_street_address": {
+ "type": "string"
+ },
+ "include_payment_process_company_include_address_zipcode": {
+ "type": "string"
+ },
+ "include_payment_process_company_include_email": {
+ "type": "boolean"
+ },
+ "include_payment_process_company_include_email_val": {
+ "type": "string"
+ },
+ "include_payment_process_partner": {
+ "type": "boolean"
+ },
+ "include_payment_process_partner_include_address": {
+ "type": "boolean"
+ },
+ "include_payment_process_partner_include_address_city": {
+ "type": "string"
+ },
+ "include_payment_process_partner_include_address_country": {
+ "type": "string"
+ },
+ "include_payment_process_partner_include_address_state": {
+ "type": "string"
+ },
+ "include_payment_process_partner_include_address_street_address": {
+ "type": "string"
+ },
+ "include_payment_process_partner_include_address_zipcode": {
+ "type": "string"
+ },
+ "include_payment_process_partner_include_email": {
+ "type": "boolean"
+ },
+ "include_payment_process_partner_include_email_val": {
+ "type": "string"
+ },
+ "include_payment_schedule": {
+ "type": "boolean"
+ },
+ "include_payment_schedule_custom": {
+ "type": "string"
+ },
+ "include_payment_schedule_specified_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_payment_schedule_specified_timeframe": {
+ "enum": [
+ "receipt",
+ "date"
+ ],
+ "type": "string"
+ },
+ "include_payment_schedule_specified_unit": {
+ "enum": [
+ "day(s)",
+ "week(s)",
+ "month(s)",
+ "quarter(s)",
+ "year(s)"
+ ],
+ "type": "string"
+ },
+ "include_payment_schedule_type": {
+ "enum": [
+ "specified",
+ "custom"
+ ],
+ "type": "string"
+ },
+ "negotiations_allowed": {
+ "description": "When true, the recipient can propose changes to the business terms, even when the agreement-level `negotiations_allowed` is false. This only covers the business terms.",
+ "type": "boolean"
+ },
+ "territory_type": {
+ "enum": [
+ "worldwide",
+ "custom"
+ ],
+ "type": "string"
+ },
+ "territory_type_val": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "payment_link_url": {
+ "description": "A payment URL shown to the recipient after signing. Requires include_billing_workflow to be true and billing_workflow_type to be \"link\".",
+ "type": "string"
+ },
+ "pilot_attributes": {
+ "additionalProperties": false,
+ "description": "Override pilot terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "fees_type": {
+ "enum": [
+ "free",
+ "pilot_period_fees"
+ ],
+ "type": "string"
+ },
+ "general_cap_amount": {
+ "type": "number"
+ },
+ "general_cap_amount_type": {
+ "enum": [
+ "preceding",
+ "base",
+ "period"
+ ],
+ "type": "string"
+ },
+ "general_cap_period_currency": {
+ "type": "number"
+ },
+ "general_cap_period_qty": {
+ "type": "number"
+ },
+ "general_cap_preceding_amount": {
+ "type": "number"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_dpa": {
+ "type": "boolean"
+ },
+ "include_dpa_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_dpa_location": {
+ "type": "string"
+ },
+ "include_dpa_type": {
+ "enum": [
+ "description",
+ "attachment",
+ "standard"
+ ],
+ "type": "string"
+ },
+ "include_payment_process": {
+ "type": "boolean"
+ },
+ "include_technical_support": {
+ "type": "boolean"
+ },
+ "payment_process_automatic_frequency": {
+ "enum": [
+ "monthly",
+ "quarterly",
+ "annually",
+ "once_per_period"
+ ],
+ "type": "string"
+ },
+ "payment_process_invoice_days": {
+ "type": "number"
+ },
+ "payment_process_invoice_from": {
+ "enum": [
+ "receipt",
+ "date"
+ ],
+ "type": "string"
+ },
+ "payment_process_invoice_timeframe": {
+ "enum": [
+ "days",
+ "weeks",
+ "months",
+ "quarters",
+ "years"
+ ],
+ "type": "string"
+ },
+ "payment_process_type": {
+ "enum": [
+ "automatic",
+ "invoice"
+ ],
+ "type": "string"
+ },
+ "pilot_period_description": {
+ "type": "string"
+ },
+ "pilot_period_fees_description": {
+ "type": "string"
+ },
+ "product_description": {
+ "type": "string"
+ },
+ "technical_support_description": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "psa_attributes": {
+ "additionalProperties": false,
+ "description": "Override psa terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "additional_changes": {
+ "type": "string"
+ },
+ "customer_description": {
+ "type": "string"
+ },
+ "effective_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "effective_date_type": {
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "type": "string"
+ },
+ "general_cap_amount": {
+ "type": "number"
+ },
+ "general_cap_amount_type": {
+ "enum": [
+ "preceding",
+ "base",
+ "period"
+ ],
+ "type": "string"
+ },
+ "general_cap_period_currency": {
+ "type": "number"
+ },
+ "general_cap_period_qty": {
+ "type": "number"
+ },
+ "general_cap_preceding_amount": {
+ "type": "number"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_additional_changes": {
+ "type": "boolean"
+ },
+ "include_additional_warranties": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_by_customer": {
+ "type": "string"
+ },
+ "include_additional_warranties_by_provider": {
+ "type": "string"
+ },
+ "include_additional_warranties_include_by_customer": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_include_by_provider": {
+ "type": "boolean"
+ },
+ "include_covered_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_customer_claims": {
+ "type": "string"
+ },
+ "include_covered_claims_include_customer_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_include_provider_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_provider_claims": {
+ "type": "string"
+ },
+ "include_customer_insurance_min": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_add_provider_com_gen_liability": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_add_provider_cyber_liability": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_add_provider_errors_omissions": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_auto_liability_aggregate": {
+ "type": "number"
+ },
+ "include_customer_insurance_min_auto_liability_minimum": {
+ "type": "number"
+ },
+ "include_customer_insurance_min_cyber_liability_aggregate": {
+ "type": "number"
+ },
+ "include_customer_insurance_min_cyber_liability_minimum": {
+ "type": "number"
+ },
+ "include_customer_insurance_min_employer_liability_aggregate": {
+ "type": "number"
+ },
+ "include_customer_insurance_min_employer_liability_minimum": {
+ "type": "number"
+ },
+ "include_customer_insurance_min_general_liability_aggregate": {
+ "type": "number"
+ },
+ "include_customer_insurance_min_general_liability_minimum": {
+ "type": "number"
+ },
+ "include_customer_insurance_min_include_add_provider": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_include_auto_liability": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_include_cyber_liability": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_include_employer_liability": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_include_general_liability": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_include_workers_comp": {
+ "type": "boolean"
+ },
+ "include_customer_policies": {
+ "type": "boolean"
+ },
+ "include_customer_policies_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_customer_policies_location": {
+ "type": "string"
+ },
+ "include_customer_policies_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_dpa": {
+ "type": "boolean"
+ },
+ "include_dpa_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_dpa_location": {
+ "type": "string"
+ },
+ "include_dpa_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_increased_cap_amount": {
+ "type": "boolean"
+ },
+ "include_increased_claims": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_confidentiality": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_confidentiality_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_privsec": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_privsec_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_other": {
+ "type": "boolean"
+ },
+ "include_increased_claims_indemnification_obligation": {
+ "type": "boolean"
+ },
+ "include_increased_claims_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_other": {
+ "type": "string"
+ },
+ "include_provider_insurance_min": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_add_customer_com_gen_liability": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_add_customer_cyber_liability": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_add_customer_errors_omissions": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_auto_liability_aggregate": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_auto_liability_minimum": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_cyber_liability_aggregate": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_cyber_liability_minimum": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_employer_liability_aggregate": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_employer_liability_minimum": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_general_liability_aggregate": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_general_liability_minimum": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_include_add_customer": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_include_auto_liability": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_include_cyber_liability": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_include_employer_liability": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_include_general_liability": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_include_workers_comp": {
+ "type": "boolean"
+ },
+ "include_publicity_rights": {
+ "type": "boolean"
+ },
+ "include_publicity_rights_type": {
+ "enum": [
+ "public",
+ "non-public"
+ ],
+ "type": "string"
+ },
+ "include_security_policy": {
+ "type": "boolean"
+ },
+ "include_security_policy_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_security_policy_fedramp_auth": {
+ "type": "boolean"
+ },
+ "include_security_policy_hitrust": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_annual_maintenance": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_other": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_other_val": {
+ "type": "string"
+ },
+ "include_security_policy_iso27001": {
+ "type": "boolean"
+ },
+ "include_security_policy_location": {
+ "type": "string"
+ },
+ "include_security_policy_pci1": {
+ "type": "boolean"
+ },
+ "include_security_policy_pci2": {
+ "type": "boolean"
+ },
+ "include_security_policy_penetration_testing": {
+ "type": "boolean"
+ },
+ "include_security_policy_soc2_type1": {
+ "type": "boolean"
+ },
+ "include_security_policy_soc2_type2": {
+ "type": "boolean"
+ },
+ "include_security_policy_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_unlimited_claims": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_confidentiality": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_confidentiality_negligence": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_privsec": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_privsec_negligence": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_include_other": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_indemnification_obligation": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_negligence": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_other": {
+ "type": "string"
+ },
+ "increased_cap_amount_currency": {
+ "type": "number"
+ },
+ "increased_cap_amount_period_currency": {
+ "type": "number"
+ },
+ "increased_cap_amount_period_qty": {
+ "type": "number"
+ },
+ "increased_cap_amount_qty": {
+ "type": "number"
+ },
+ "increased_cap_amount_type": {
+ "enum": [
+ "qty",
+ "currency",
+ "period"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "psa_statement_of_work_attributes": {
+ "additionalProperties": false,
+ "description": "Override psa statement of work terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "additional_changes": {
+ "type": "string"
+ },
+ "cost": {
+ "type": "number"
+ },
+ "description": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "fees_attributes": {
+ "additionalProperties": {
+ "anyOf": [
+ {
+ "additionalProperties": false,
+ "description": "Fees::Flat (fee_type \"flat\"). A fixed recurring fee, e.g. a platform subscription. Set type to \"Fees::Flat\" or fee_type to \"flat\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Fixed amount in the order form's fees_currency, charged per fee_period. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"flat\". Alternative to type.",
+ "enum": [
+ "flat"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Flat\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Flat"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Discount (fee_type \"discount\"). A discount, as a fixed amount or a percentage, applied forever, once, or for a number of months. Set type to \"Fees::Discount\" or fee_type to \"discount\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Discount size: an amount in fees_currency when discount_type is fixed_amount (a plain amount, not cents: 20 means 20.00), or a percentage (e.g. 10 for 10%) when it is percentage.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "discount_duration_amount": {
+ "description": "Number of months the discount applies. Required when discount_duration_type is multiple_months.",
+ "type": "number"
+ },
+ "discount_duration_type": {
+ "description": "How long the discount applies. multiple_months also needs discount_duration_amount.",
+ "enum": [
+ "forever",
+ "once",
+ "multiple_months"
+ ],
+ "type": "string"
+ },
+ "discount_type": {
+ "description": "Whether cost is a currency amount or a percentage.",
+ "enum": [
+ "fixed_amount",
+ "percentage"
+ ],
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"discount\". Alternative to type.",
+ "enum": [
+ "discount"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Discount\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Discount"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Cost (fee_type \"cost\"). A per-unit fee: price per unit times quantity, e.g. seats. Set type to \"Fees::Cost\" or fee_type to \"cost\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Price per unit in fees_currency. The row total is quantity x cost. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"cost\". Alternative to type.",
+ "enum": [
+ "cost"
+ ],
+ "type": "string"
+ },
+ "quantity": {
+ "description": "Number of units.",
+ "type": "number"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Cost\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Cost"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Attachment (fee_type \"attachment\"). A fee described in an uploaded attachment instead of in the table. Set type to \"Fees::Attachment\" or fee_type to \"attachment\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "attachment_id": {
+ "description": "ID of an attachment uploaded with upload-attachment.",
+ "type": "string"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"attachment\". Alternative to type.",
+ "enum": [
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Attachment\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Attachment"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Graduated (fee_type \"graduated\"). Tiered pricing, with the price set per tier in graduated_fee_tiers_attributes. Set type to \"Fees::Graduated\" or fee_type to \"graduated\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"graduated\". Alternative to type.",
+ "enum": [
+ "graduated"
+ ],
+ "type": "string"
+ },
+ "graduated_fee_tiers_attributes": {
+ "additionalProperties": {
+ "additionalProperties": false,
+ "properties": {
+ "flat_price": {
+ "type": "number"
+ },
+ "price_per_unit": {
+ "type": "string"
+ },
+ "upper_limit": {
+ "type": "number"
+ }
+ },
+ "type": "object"
+ },
+ "description": "Graduated fee tiers. Use string keys such as \"0\", \"1\".",
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Graduated\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Graduated"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Included (fee_type \"included\"). An item included at no charge. Set type to \"Fees::Included\" or fee_type to \"included\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"included\". Alternative to type.",
+ "enum": [
+ "included"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Included\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Included"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Metered (fee_type \"metered\"). Usage-based pricing, billed per unit used. Set type to \"Fees::Metered\" or fee_type to \"metered\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Price per unit of usage in fees_currency. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"metered\". Alternative to type.",
+ "enum": [
+ "metered"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Metered\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Metered"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::OneTime (fee_type \"one_time\"). A one-time charge, such as a setup fee. Set type to \"Fees::OneTime\" or fee_type to \"one_time\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "One-time amount in fees_currency, charged once rather than per fee_period. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"one_time\". Alternative to type.",
+ "enum": [
+ "one_time"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::OneTime\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::OneTime"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Text (fee_type \"text\"). A fee term described in free text. Set type to \"Fees::Text\" or fee_type to \"text\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"text\". Alternative to type.",
+ "enum": [
+ "text"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Text\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Text"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ }
+ ]
+ },
+ "description": "Fee line items. Use string keys such as \"0\", \"1\". Replaces template fees when provided.",
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_additional_changes": {
+ "type": "boolean"
+ },
+ "include_customer_obligation": {
+ "type": "boolean"
+ },
+ "include_customer_obligation_val": {
+ "type": "string"
+ },
+ "include_deliverables": {
+ "type": "boolean"
+ },
+ "include_deliverables_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_deliverables_description": {
+ "type": "string"
+ },
+ "include_deliverables_include_acceptance": {
+ "type": "boolean"
+ },
+ "include_deliverables_include_attachment": {
+ "type": "boolean"
+ },
+ "include_deliverables_include_draft_deliverables": {
+ "type": "boolean"
+ },
+ "include_deliverables_rejection_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_deliverables_rejection_unit": {
+ "enum": [
+ "hours",
+ "days",
+ "weeks",
+ "months"
+ ],
+ "type": "string"
+ },
+ "include_deliverables_resubmission_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_deliverables_resubmission_unit": {
+ "enum": [
+ "hours",
+ "days",
+ "weeks",
+ "months"
+ ],
+ "type": "string"
+ },
+ "include_fees_other": {
+ "type": "boolean"
+ },
+ "include_fees_other_val": {
+ "type": "string"
+ },
+ "include_fees_table": {
+ "type": "boolean"
+ },
+ "include_fees_table_total": {
+ "type": "boolean"
+ },
+ "include_fees_travel": {
+ "type": "boolean"
+ },
+ "include_fees_travel_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_fees_travel_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_fees_travel_val": {
+ "type": "string"
+ },
+ "include_third_party_customer": {
+ "type": "boolean"
+ },
+ "include_third_party_include_description": {
+ "type": "boolean"
+ },
+ "include_third_party_include_description_val": {
+ "type": "string"
+ },
+ "include_third_party_materials": {
+ "type": "boolean"
+ },
+ "include_third_party_provider": {
+ "type": "boolean"
+ },
+ "include_time_of_assignment": {
+ "type": "boolean"
+ },
+ "include_time_of_assignment_type": {
+ "enum": [
+ "created",
+ "paid"
+ ],
+ "type": "string"
+ },
+ "invoice_period_description": {
+ "type": "string"
+ },
+ "negotiations_allowed": {
+ "description": "When true, the recipient can propose changes to the statement of work, even when the agreement-level `negotiations_allowed` is false. This only covers the statement of work.",
+ "type": "boolean"
+ },
+ "payment_period": {
+ "type": "number"
+ },
+ "payment_period_other": {
+ "type": "string"
+ },
+ "payment_period_timeframe": {
+ "enum": [
+ "receipt",
+ "invoice",
+ "Customer's receipt of invoice",
+ "date of invoice"
+ ],
+ "type": "string"
+ },
+ "payment_period_type": {
+ "enum": [
+ "standard",
+ "other"
+ ],
+ "type": "string"
+ },
+ "payment_period_unit": {
+ "enum": [
+ "day(s)",
+ "week(s)",
+ "month(s)",
+ "quarter(s)",
+ "year(s)"
+ ],
+ "type": "string"
+ },
+ "quantity": {
+ "type": "number"
+ },
+ "services_description": {
+ "type": "string"
+ },
+ "sow_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "sow_date_type": {
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "type": "string"
+ },
+ "sow_term_amount": {
+ "type": "number"
+ },
+ "sow_term_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "sow_term_type": {
+ "enum": [
+ "deliverables",
+ "period",
+ "date"
+ ],
+ "type": "string"
+ },
+ "sow_term_unit": {
+ "enum": [
+ "month(s)",
+ "quarter(s)",
+ "year(s)"
+ ],
+ "type": "string"
+ },
+ "type": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "recipient_email": {
+ "format": "email",
+ "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-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_last_to_sign": {
+ "description": "When true, your signer signs after the recipient.",
+ "type": "boolean"
+ },
+ "sender_notice_email_address": {
+ "description": "Email address for legal notices to the sender.",
+ "format": "email",
+ "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-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": {
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "type": "string"
+ },
+ "general_cap_amount": {
+ "type": "number"
+ },
+ "general_cap_amount_type": {
+ "enum": [
+ "preceding",
+ "base",
+ "period"
+ ],
+ "type": "string"
+ },
+ "general_cap_period_currency": {
+ "type": "number"
+ },
+ "general_cap_period_qty": {
+ "type": "number"
+ },
+ "general_cap_preceding_amount": {
+ "type": "number"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_additional_warranties": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_by_customer": {
+ "type": "string"
+ },
+ "include_additional_warranties_by_provider": {
+ "type": "string"
+ },
+ "include_additional_warranties_include_by_customer": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_include_by_provider": {
+ "type": "boolean"
+ },
+ "include_ai_addendum": {
+ "type": "boolean"
+ },
+ "include_ai_addendum_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_covered_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_customer_claims": {
+ "type": "string"
+ },
+ "include_covered_claims_include_customer_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_include_provider_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_provider_claims": {
+ "type": "string"
+ },
+ "include_dpa": {
+ "type": "boolean"
+ },
+ "include_dpa_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_dpa_location": {
+ "type": "string"
+ },
+ "include_dpa_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_increased_cap_amount": {
+ "type": "boolean"
+ },
+ "include_increased_claims": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_confidentiality": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_confidentiality_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_other": {
+ "type": "boolean"
+ },
+ "include_increased_claims_indemnification_obligation": {
+ "type": "boolean"
+ },
+ "include_increased_claims_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_other": {
+ "type": "string"
+ },
+ "include_increased_claims_restrictions": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_confidentiality": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_confidentiality_negligence": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_include_other": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_indemnification_obligation": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_license_or_restrictions": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_negligence": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_other": {
+ "type": "string"
+ },
+ "increased_cap_amount_currency": {
+ "type": "number"
+ },
+ "increased_cap_amount_period_currency": {
+ "type": "number"
+ },
+ "increased_cap_amount_period_qty": {
+ "type": "number"
+ },
+ "increased_cap_amount_qty": {
+ "type": "number"
+ },
+ "increased_cap_amount_type": {
+ "enum": [
+ "qty",
+ "currency",
+ "period"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "software_license_order_form_attributes": {
+ "additionalProperties": false,
+ "description": "Override software license order form terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "additional_changes": {
+ "type": "string"
+ },
+ "deletion_procedure_include_custom": {
+ "type": "boolean"
+ },
+ "deletion_procedure_include_custom_description": {
+ "type": "string"
+ },
+ "deletion_procedure_include_customer_disable": {
+ "type": "boolean"
+ },
+ "deletion_procedure_include_customer_proof": {
+ "type": "boolean"
+ },
+ "deletion_procedure_include_provider_disable": {
+ "type": "boolean"
+ },
+ "fee_custom_unit": {
+ "type": "string"
+ },
+ "fee_period": {
+ "enum": [
+ "Subscription Period",
+ "month",
+ "year",
+ "Custom unit"
+ ],
+ "type": "string"
+ },
+ "fees_attributes": {
+ "additionalProperties": {
+ "anyOf": [
+ {
+ "additionalProperties": false,
+ "description": "Fees::Flat (fee_type \"flat\"). A fixed recurring fee, e.g. a platform subscription. Set type to \"Fees::Flat\" or fee_type to \"flat\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Fixed amount in the order form's fees_currency, charged per fee_period. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"flat\". Alternative to type.",
+ "enum": [
+ "flat"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Flat\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Flat"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Discount (fee_type \"discount\"). A discount, as a fixed amount or a percentage, applied forever, once, or for a number of months. Set type to \"Fees::Discount\" or fee_type to \"discount\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Discount size: an amount in fees_currency when discount_type is fixed_amount (a plain amount, not cents: 20 means 20.00), or a percentage (e.g. 10 for 10%) when it is percentage.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "discount_duration_amount": {
+ "description": "Number of months the discount applies. Required when discount_duration_type is multiple_months.",
+ "type": "number"
+ },
+ "discount_duration_type": {
+ "description": "How long the discount applies. multiple_months also needs discount_duration_amount.",
+ "enum": [
+ "forever",
+ "once",
+ "multiple_months"
+ ],
+ "type": "string"
+ },
+ "discount_type": {
+ "description": "Whether cost is a currency amount or a percentage.",
+ "enum": [
+ "fixed_amount",
+ "percentage"
+ ],
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"discount\". Alternative to type.",
+ "enum": [
+ "discount"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Discount\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Discount"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Cost (fee_type \"cost\"). A per-unit fee: price per unit times quantity, e.g. seats. Set type to \"Fees::Cost\" or fee_type to \"cost\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Price per unit in fees_currency. The row total is quantity x cost. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"cost\". Alternative to type.",
+ "enum": [
+ "cost"
+ ],
+ "type": "string"
+ },
+ "quantity": {
+ "description": "Number of units.",
+ "type": "number"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Cost\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Cost"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Attachment (fee_type \"attachment\"). A fee described in an uploaded attachment instead of in the table. Set type to \"Fees::Attachment\" or fee_type to \"attachment\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "attachment_id": {
+ "description": "ID of an attachment uploaded with upload-attachment.",
+ "type": "string"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"attachment\". Alternative to type.",
+ "enum": [
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Attachment\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Attachment"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Graduated (fee_type \"graduated\"). Tiered pricing, with the price set per tier in graduated_fee_tiers_attributes. Set type to \"Fees::Graduated\" or fee_type to \"graduated\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"graduated\". Alternative to type.",
+ "enum": [
+ "graduated"
+ ],
+ "type": "string"
+ },
+ "graduated_fee_tiers_attributes": {
+ "additionalProperties": {
+ "additionalProperties": false,
+ "properties": {
+ "flat_price": {
+ "type": "number"
+ },
+ "price_per_unit": {
+ "type": "string"
+ },
+ "upper_limit": {
+ "type": "number"
+ }
+ },
+ "type": "object"
+ },
+ "description": "Graduated fee tiers. Use string keys such as \"0\", \"1\".",
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Graduated\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Graduated"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Included (fee_type \"included\"). An item included at no charge. Set type to \"Fees::Included\" or fee_type to \"included\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"included\". Alternative to type.",
+ "enum": [
+ "included"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Included\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Included"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Metered (fee_type \"metered\"). Usage-based pricing, billed per unit used. Set type to \"Fees::Metered\" or fee_type to \"metered\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Price per unit of usage in fees_currency. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"metered\". Alternative to type.",
+ "enum": [
+ "metered"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Metered\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Metered"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::OneTime (fee_type \"one_time\"). A one-time charge, such as a setup fee. Set type to \"Fees::OneTime\" or fee_type to \"one_time\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "One-time amount in fees_currency, charged once rather than per fee_period. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"one_time\". Alternative to type.",
+ "enum": [
+ "one_time"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::OneTime\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::OneTime"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Text (fee_type \"text\"). A fee term described in free text. Set type to \"Fees::Text\" or fee_type to \"text\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"text\". Alternative to type.",
+ "enum": [
+ "text"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Text\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Text"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ }
+ ]
+ },
+ "description": "Fee line items. Use string keys such as \"0\", \"1\". Replaces template fees when provided.",
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+ },
+ "fees_currency": {
+ "enum": [
+ "USD",
+ "EUR",
+ "GBP",
+ "CAD",
+ "AUD",
+ "SGD",
+ "ILS",
+ "JPY",
+ "CHF",
+ "HKD"
+ ],
+ "type": "string"
+ },
+ "fees_include_fee_increase_upon_renewal": {
+ "type": "boolean"
+ },
+ "fees_include_fee_increase_upon_renewal_fee": {
+ "type": "number"
+ },
+ "fees_include_fee_increase_upon_renewal_type": {
+ "enum": [
+ "will",
+ "may"
+ ],
+ "type": "string"
+ },
+ "fees_inclusive_of_taxes": {
+ "type": "boolean"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_additional_changes": {
+ "type": "boolean"
+ },
+ "include_license_compliance_verification": {
+ "type": "boolean"
+ },
+ "include_license_compliance_verification_description": {
+ "type": "string"
+ },
+ "include_license_limits": {
+ "type": "boolean"
+ },
+ "include_license_limits_description": {
+ "type": "string"
+ },
+ "include_payment_process_include_billing_email": {
+ "type": "boolean"
+ },
+ "include_pilot_period": {
+ "type": "boolean"
+ },
+ "include_pilot_period_duration_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_pilot_period_duration_type": {
+ "enum": [
+ "day",
+ "week",
+ "month"
+ ],
+ "type": "string"
+ },
+ "include_pilot_period_include_fees": {
+ "type": "boolean"
+ },
+ "include_pilot_period_include_fees_amount": {
+ "type": "number"
+ },
+ "include_pilot_period_include_modifications": {
+ "type": "boolean"
+ },
+ "include_pilot_period_include_modifications_description": {
+ "type": "string"
+ },
+ "include_services": {
+ "type": "boolean"
+ },
+ "include_services_description": {
+ "type": "string"
+ },
+ "negotiations_allowed": {
+ "description": "When true, the recipient can propose changes to the order form, even when the agreement-level `negotiations_allowed` is false. This only covers the order form.",
+ "type": "boolean"
+ },
+ "order_date_date": {
+ "type": "string"
+ },
+ "order_date_type": {
+ "enum": [
+ "signature",
+ "date",
+ "other"
+ ],
+ "type": "string"
+ },
+ "payment_process_automatic_frequency": {
+ "enum": [
+ "monthly",
+ "quarterly",
+ "semiannually",
+ "annually"
+ ],
+ "type": "string"
+ },
+ "payment_process_type": {
+ "enum": [
+ "automatic",
+ "invoice",
+ "custom"
+ ],
+ "type": "string"
+ },
+ "payment_process_type_custom_val": {
+ "type": "string"
+ },
+ "payment_process_type_invoice_amount": {
+ "type": "number"
+ },
+ "payment_process_type_invoice_custom_unit": {
+ "type": "string"
+ },
+ "payment_process_type_invoice_duration": {
+ "enum": [
+ "day",
+ "week",
+ "month",
+ "year",
+ "day(s)",
+ "week(s)",
+ "month(s)",
+ "year(s)"
+ ],
+ "type": "string"
+ },
+ "payment_process_type_invoice_duration_start": {
+ "enum": [
+ "Customer's receipt of invoice",
+ "date of invoice"
+ ],
+ "type": "string"
+ },
+ "payment_process_type_invoice_type": {
+ "enum": [
+ "monthly",
+ "quarterly",
+ "semiannually",
+ "annually",
+ "Custom unit"
+ ],
+ "type": "string"
+ },
+ "permitted_uses_include_custom": {
+ "type": "boolean"
+ },
+ "permitted_uses_include_custom_description": {
+ "type": "string"
+ },
+ "permitted_uses_include_customers_affiliates": {
+ "type": "boolean"
+ },
+ "permitted_uses_include_internal_business": {
+ "type": "boolean"
+ },
+ "pilot_period_stripe_product_id": {
+ "type": "string"
+ },
+ "software_description": {
+ "type": "string"
+ },
+ "subscription_auto_renew": {
+ "enum": [
+ "days",
+ "subscription_end"
+ ],
+ "type": "string"
+ },
+ "subscription_period": {
+ "type": "number"
+ },
+ "subscription_period_unit": {
+ "type": "string"
+ },
+ "subscription_renewal_notice_days": {
+ "type": "number"
+ },
+ "warranty_period_description_amount": {
+ "type": "number"
+ },
+ "warranty_period_description_duration": {
+ "enum": [
+ "day",
+ "week",
+ "month",
+ "year"
+ ],
+ "type": "string"
+ },
+ "warranty_period_description_duration_start": {
+ "enum": [
+ "initial delivery of the Software",
+ "delivery of the Software and each subsequent Update",
+ "the Order Date"
+ ],
+ "type": "string"
+ },
+ "warranty_period_type": {
+ "enum": [
+ "description",
+ "none"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "test_agreement": {
+ "description": "When true, marks the agreement as a test. Test agreements do not count against your monthly limit.",
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "recipient_name",
+ "recipient_email"
+ ],
+ "type": "object"
+ },
+ "cc_users": {
+ "items": {
+ "format": "email",
+ "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "draft": {
+ "description": "When true, the agreement is saved as a draft and not sent to the recipient. Use POST /v1/agreements/{id}/send to send a draft agreement later.",
+ "type": "boolean"
+ },
+ "owner_email": {
+ "description": "Email address of the agreement owner (sender).",
+ "type": "string"
+ },
+ "signer_id": {
+ "description": "User id of the signer from the owner's organization.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "template_id": {
+ "description": "UUID of a template from `GET /v1/templates`. Accepts both Common Paper standard templates and uploaded PDF templates (`type` `uploaded_template`).",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ }
+ },
+ "required": [
+ "template_id",
+ "owner_email",
+ "signer_id",
+ "agreement"
+ ],
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "agreement": {
+ "additionalProperties": {},
+ "properties": {
+ "amendment_attributes": {
+ "additionalProperties": false,
+ "description": "Override amendment terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "amended_terms_attributes": {
+ "additionalProperties": {
+ "additionalProperties": false,
+ "properties": {
+ "description": {
+ "type": "string"
+ },
+ "term": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "description": "Amended terms. Use string keys such as \"0\", \"1\".",
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+ },
+ "amendment_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "amendment_date_type": {
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "type": "string"
+ },
+ "framework_terms_type": {
+ "type": "string"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "parent_agreement_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "underlying_agreement_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "underlying_agreement_type": {
+ "type": "string"
+ },
+ "underlying_agreement_val": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "baa_attributes": {
+ "additionalProperties": false,
+ "description": "Override baa terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "aggregation_limitations_permitted": {
+ "type": "boolean"
+ },
+ "aggregation_limitations_permitted_val": {
+ "type": "string"
+ },
+ "breach_notification_unit": {
+ "enum": [
+ "hours",
+ "business days",
+ "calendar days"
+ ],
+ "type": "string"
+ },
+ "breach_notification_val": {
+ "type": "number"
+ },
+ "business_associate_relationship_type": {
+ "enum": [
+ "provider",
+ "company"
+ ],
+ "type": "string"
+ },
+ "deidentification_limitations_include_purpose": {
+ "type": "boolean"
+ },
+ "deidentification_limitations_include_requirements": {
+ "type": "boolean"
+ },
+ "deidentification_limitations_permitted": {
+ "type": "boolean"
+ },
+ "deidentification_limitations_purpose_val": {
+ "type": "string"
+ },
+ "deidentification_limitations_requirements_val": {
+ "type": "string"
+ },
+ "designated_record_set_provider_maintains": {
+ "type": "boolean"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_aggregation_limitations": {
+ "type": "boolean"
+ },
+ "include_deidentification_limitations": {
+ "type": "boolean"
+ },
+ "include_limitations": {
+ "type": "boolean"
+ },
+ "include_offshore_limitations": {
+ "type": "boolean"
+ },
+ "include_subcontract_limitations": {
+ "type": "boolean"
+ },
+ "offshore_limitations_permitted": {
+ "type": "boolean"
+ },
+ "offshore_limitations_permitted_val": {
+ "type": "string"
+ },
+ "subcontract_limitations_include_notice": {
+ "type": "boolean"
+ },
+ "subcontract_limitations_include_permission": {
+ "type": "boolean"
+ },
+ "subcontract_limitations_notice_val": {
+ "type": "string"
+ },
+ "subcontract_limitations_permission_val": {
+ "type": "string"
+ },
+ "subcontract_limitations_permitted": {
+ "type": "boolean"
+ },
+ "underlying_agreement_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "underlying_agreement_type": {
+ "enum": [
+ "internal",
+ "external",
+ "none"
+ ],
+ "type": "string"
+ },
+ "underlying_agreement_val": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "billing_email": {
+ "description": "Email of the billing contact. Used when include_billing_info is true.",
+ "format": "email",
+ "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "billing_name": {
+ "description": "Name of the billing contact. Used when include_billing_info is true.",
+ "type": "string"
+ },
+ "billing_workflow_type": {
+ "description": "The type of billing workflow. Use \"link\" to provide a payment_link_url, or \"stripe\" for Stripe-managed billing.",
+ "enum": [
+ "link",
+ "stripe"
+ ],
+ "type": "string"
+ },
+ "chosen_courts_country": {
+ "description": "The country in which disputes will be resolved.",
+ "type": "string"
+ },
+ "chosen_courts_region": {
+ "description": "The state or region in which disputes will be resolved.",
+ "type": "string"
+ },
+ "csa_attributes": {
+ "additionalProperties": false,
+ "description": "Override csa terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "customer_description": {
+ "type": "string"
+ },
+ "effective_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "effective_date_marketplace": {
+ "enum": [
+ "AWS",
+ "GCP",
+ "Azure"
+ ],
+ "type": "string"
+ },
+ "effective_date_type": {
+ "enum": [
+ "signature",
+ "date",
+ "marketplace_acceptance"
+ ],
+ "type": "string"
+ },
+ "general_cap_amount": {
+ "type": "number"
+ },
+ "general_cap_amount_type": {
+ "enum": [
+ "preceding",
+ "base",
+ "period"
+ ],
+ "type": "string"
+ },
+ "general_cap_period_currency": {
+ "type": "number"
+ },
+ "general_cap_period_qty": {
+ "type": "number"
+ },
+ "general_cap_preceding_amount": {
+ "type": "number"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_acceptable_use_policy": {
+ "type": "boolean"
+ },
+ "include_acceptable_use_policy_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_acceptable_use_policy_location": {
+ "type": "string"
+ },
+ "include_acceptable_use_policy_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_additional_warranties": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_by_customer": {
+ "type": "string"
+ },
+ "include_additional_warranties_by_provider": {
+ "type": "string"
+ },
+ "include_additional_warranties_include_by_customer": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_include_by_provider": {
+ "type": "boolean"
+ },
+ "include_ai_addendum": {
+ "type": "boolean"
+ },
+ "include_ai_addendum_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_covered_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_customer_claims": {
+ "type": "string"
+ },
+ "include_covered_claims_include_customer_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_include_provider_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_provider_claims": {
+ "type": "string"
+ },
+ "include_dpa": {
+ "type": "boolean"
+ },
+ "include_dpa_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_dpa_location": {
+ "type": "string"
+ },
+ "include_dpa_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_increased_cap_amount": {
+ "type": "boolean"
+ },
+ "include_increased_claims": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_confidentiality": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_confidentiality_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_privsec": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_privsec_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_other": {
+ "type": "boolean"
+ },
+ "include_increased_claims_indemnification_obligation": {
+ "type": "boolean"
+ },
+ "include_increased_claims_other": {
+ "type": "string"
+ },
+ "include_insurance_minimums": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_add_customer": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_add_customer_com_gen_liability": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_add_customer_cyber_liability": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_add_customer_errors_omissions": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_additional_information": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_additional_information_text": {
+ "type": "string"
+ },
+ "include_insurance_minimums_cyber_liability_aggregate": {
+ "type": "number"
+ },
+ "include_insurance_minimums_cyber_liability_minimum": {
+ "type": "number"
+ },
+ "include_insurance_minimums_employer_liability_aggregate": {
+ "type": "number"
+ },
+ "include_insurance_minimums_employer_liability_minimum": {
+ "type": "number"
+ },
+ "include_insurance_minimums_general_liability_aggregate": {
+ "type": "number"
+ },
+ "include_insurance_minimums_general_liability_minimum": {
+ "type": "number"
+ },
+ "include_insurance_minimums_include_cyber_liability": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_include_employer_liability": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_include_general_liability": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_include_workers_compensation": {
+ "type": "boolean"
+ },
+ "include_publicity_rights": {
+ "type": "boolean"
+ },
+ "include_publicity_rights_type": {
+ "enum": [
+ "public",
+ "non-public"
+ ],
+ "type": "string"
+ },
+ "include_security_policy": {
+ "type": "boolean"
+ },
+ "include_security_policy_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_security_policy_fedramp_auth": {
+ "type": "boolean"
+ },
+ "include_security_policy_hipaa": {
+ "type": "boolean"
+ },
+ "include_security_policy_hitrust": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_annual_maintenance": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_location": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_other": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_reasonable_efforts": {
+ "type": "boolean"
+ },
+ "include_security_policy_iso27001": {
+ "type": "boolean"
+ },
+ "include_security_policy_location": {
+ "type": "string"
+ },
+ "include_security_policy_other": {
+ "type": "string"
+ },
+ "include_security_policy_pci1": {
+ "type": "boolean"
+ },
+ "include_security_policy_pci2": {
+ "type": "boolean"
+ },
+ "include_security_policy_penetration_testing": {
+ "type": "boolean"
+ },
+ "include_security_policy_soc2": {
+ "type": "boolean"
+ },
+ "include_security_policy_soc2_type2": {
+ "type": "boolean"
+ },
+ "include_security_policy_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_supercap": {
+ "description": "CSA 3.0 renamed `include_increased_cap_amount` to `include_supercap`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_increased_cap_amount`. Sending the other spelling returns a 422.",
+ "type": "boolean"
+ },
+ "include_uncapped_claims": {
+ "description": "CSA 3.0 renamed `include_unlimited_claims` to `include_uncapped_claims`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims`. Sending the other spelling returns a 422.",
+ "type": "boolean"
+ },
+ "include_uncapped_claims_breach_of_confidentiality": {
+ "description": "CSA 3.0 renamed `include_unlimited_claims_breach_of_confidentiality` to `include_uncapped_claims_breach_of_confidentiality`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_breach_of_confidentiality`. Sending the other spelling returns a 422.",
+ "type": "boolean"
+ },
+ "include_uncapped_claims_breach_of_confidentiality_negligence": {
+ "description": "CSA 3.0 renamed `include_unlimited_claims_breach_of_confidentiality_negligence` to `include_uncapped_claims_breach_of_confidentiality_negligence`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_breach_of_confidentiality_negligence`. Sending the other spelling returns a 422.",
+ "type": "boolean"
+ },
+ "include_uncapped_claims_breach_of_privsec": {
+ "description": "CSA 3.0 renamed `include_unlimited_claims_breach_of_privsec` to `include_uncapped_claims_breach_of_privsec`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_breach_of_privsec`. Sending the other spelling returns a 422.",
+ "type": "boolean"
+ },
+ "include_uncapped_claims_breach_of_privsec_negligence": {
+ "description": "CSA 3.0 renamed `include_unlimited_claims_breach_of_privsec_negligence` to `include_uncapped_claims_breach_of_privsec_negligence`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_breach_of_privsec_negligence`. Sending the other spelling returns a 422.",
+ "type": "boolean"
+ },
+ "include_uncapped_claims_include_other": {
+ "description": "CSA 3.0 renamed `include_unlimited_claims_include_other` to `include_uncapped_claims_include_other`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_include_other`. Sending the other spelling returns a 422.",
+ "type": "boolean"
+ },
+ "include_uncapped_claims_indemnification_obligation": {
+ "description": "CSA 3.0 renamed `include_unlimited_claims_indemnification_obligation` to `include_uncapped_claims_indemnification_obligation`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_indemnification_obligation`. Sending the other spelling returns a 422.",
+ "type": "boolean"
+ },
+ "include_uncapped_claims_other": {
+ "description": "CSA 3.0 renamed `include_unlimited_claims_other` to `include_uncapped_claims_other`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_other`. Sending the other spelling returns a 422.",
+ "type": "boolean"
+ },
+ "include_unlimited_claims": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_confidentiality": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_confidentiality_negligence": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_privsec": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_privsec_negligence": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_include_other": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_indemnification_obligation": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_other": {
+ "type": "string"
+ },
+ "increased_cap_amount_currency": {
+ "type": "number"
+ },
+ "increased_cap_amount_period_currency": {
+ "type": "number"
+ },
+ "increased_cap_amount_period_qty": {
+ "type": "number"
+ },
+ "increased_cap_amount_qty": {
+ "type": "number"
+ },
+ "increased_cap_amount_type": {
+ "enum": [
+ "qty",
+ "currency",
+ "period"
+ ],
+ "type": "string"
+ },
+ "provider": {
+ "type": "string"
+ },
+ "supercap_currency": {
+ "description": "CSA 3.0 renamed `increased_cap_amount_currency` to `supercap_currency`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `increased_cap_amount_currency`. Sending the other spelling returns a 422.",
+ "type": "number"
+ },
+ "supercap_period_currency": {
+ "description": "CSA 3.0 renamed `increased_cap_amount_period_currency` to `supercap_period_currency`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `increased_cap_amount_period_currency`. Sending the other spelling returns a 422.",
+ "type": "number"
+ },
+ "supercap_period_qty": {
+ "description": "CSA 3.0 renamed `increased_cap_amount_period_qty` to `supercap_period_qty`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `increased_cap_amount_period_qty`. Sending the other spelling returns a 422.",
+ "type": "number"
+ },
+ "supercap_qty": {
+ "description": "CSA 3.0 renamed `increased_cap_amount_qty` to `supercap_qty`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `increased_cap_amount_qty`. Sending the other spelling returns a 422.",
+ "type": "number"
+ },
+ "supercap_type": {
+ "description": "CSA 3.0 renamed `increased_cap_amount_type` to `supercap_type`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `increased_cap_amount_type`. Sending the other spelling returns a 422.",
+ "type": "number"
+ }
+ },
+ "type": "object"
+ },
+ "csa_order_form_attributes": {
+ "additionalProperties": false,
+ "description": "Override csa order form terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "additional_changes": {
+ "type": "string"
+ },
+ "additional_parameters_or_limitations": {
+ "type": "string"
+ },
+ "affiliates_as_users": {
+ "type": "boolean"
+ },
+ "cloud_service_description": {
+ "type": "string"
+ },
+ "consumption_units": {
+ "type": "string"
+ },
+ "fee_amount": {
+ "type": "number"
+ },
+ "fee_custom_unit": {
+ "type": "string"
+ },
+ "fee_period": {
+ "enum": [
+ "Subscription Period",
+ "month",
+ "year",
+ "User",
+ "Custom unit"
+ ],
+ "type": "string"
+ },
+ "fees_attributes": {
+ "additionalProperties": {
+ "anyOf": [
+ {
+ "additionalProperties": false,
+ "description": "Fees::Flat (fee_type \"flat\"). A fixed recurring fee, e.g. a platform subscription. Set type to \"Fees::Flat\" or fee_type to \"flat\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Fixed amount in the order form's fees_currency, charged per fee_period. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"flat\". Alternative to type.",
+ "enum": [
+ "flat"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Flat\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Flat"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Discount (fee_type \"discount\"). A discount, as a fixed amount or a percentage, applied forever, once, or for a number of months. Set type to \"Fees::Discount\" or fee_type to \"discount\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Discount size: an amount in fees_currency when discount_type is fixed_amount (a plain amount, not cents: 20 means 20.00), or a percentage (e.g. 10 for 10%) when it is percentage.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "discount_duration_amount": {
+ "description": "Number of months the discount applies. Required when discount_duration_type is multiple_months.",
+ "type": "number"
+ },
+ "discount_duration_type": {
+ "description": "How long the discount applies. multiple_months also needs discount_duration_amount.",
+ "enum": [
+ "forever",
+ "once",
+ "multiple_months"
+ ],
+ "type": "string"
+ },
+ "discount_type": {
+ "description": "Whether cost is a currency amount or a percentage.",
+ "enum": [
+ "fixed_amount",
+ "percentage"
+ ],
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"discount\". Alternative to type.",
+ "enum": [
+ "discount"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Discount\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Discount"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Cost (fee_type \"cost\"). A per-unit fee: price per unit times quantity, e.g. seats. Set type to \"Fees::Cost\" or fee_type to \"cost\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Price per unit in fees_currency. The row total is quantity x cost. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"cost\". Alternative to type.",
+ "enum": [
+ "cost"
+ ],
+ "type": "string"
+ },
+ "quantity": {
+ "description": "Number of units.",
+ "type": "number"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Cost\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Cost"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Attachment (fee_type \"attachment\"). A fee described in an uploaded attachment instead of in the table. Set type to \"Fees::Attachment\" or fee_type to \"attachment\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "attachment_id": {
+ "description": "ID of an attachment uploaded with upload-attachment.",
+ "type": "string"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"attachment\". Alternative to type.",
+ "enum": [
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Attachment\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Attachment"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Graduated (fee_type \"graduated\"). Tiered pricing, with the price set per tier in graduated_fee_tiers_attributes. Set type to \"Fees::Graduated\" or fee_type to \"graduated\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"graduated\". Alternative to type.",
+ "enum": [
+ "graduated"
+ ],
+ "type": "string"
+ },
+ "graduated_fee_tiers_attributes": {
+ "additionalProperties": {
+ "additionalProperties": false,
+ "properties": {
+ "flat_price": {
+ "type": "number"
+ },
+ "price_per_unit": {
+ "type": "string"
+ },
+ "upper_limit": {
+ "type": "number"
+ }
+ },
+ "type": "object"
+ },
+ "description": "Graduated fee tiers. Use string keys such as \"0\", \"1\".",
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Graduated\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Graduated"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Included (fee_type \"included\"). An item included at no charge. Set type to \"Fees::Included\" or fee_type to \"included\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"included\". Alternative to type.",
+ "enum": [
+ "included"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Included\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Included"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Metered (fee_type \"metered\"). Usage-based pricing, billed per unit used. Set type to \"Fees::Metered\" or fee_type to \"metered\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Price per unit of usage in fees_currency. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"metered\". Alternative to type.",
+ "enum": [
+ "metered"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Metered\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Metered"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::OneTime (fee_type \"one_time\"). A one-time charge, such as a setup fee. Set type to \"Fees::OneTime\" or fee_type to \"one_time\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "One-time amount in fees_currency, charged once rather than per fee_period. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"one_time\". Alternative to type.",
+ "enum": [
+ "one_time"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::OneTime\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::OneTime"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Text (fee_type \"text\"). A fee term described in free text. Set type to \"Fees::Text\" or fee_type to \"text\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"text\". Alternative to type.",
+ "enum": [
+ "text"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Text\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Text"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ }
+ ]
+ },
+ "description": "Fee table rows, keyed by string index (\"0\", \"1\", ...). Replaces the template's fees when provided. Each row sets type or fee_type to pick the fee class. Amounts are in the order form's fees_currency and, for recurring fees, are charged per fee_period.",
+ "examples": [
+ {
+ "0": {
+ "cost": 2000,
+ "description": "Platform subscription",
+ "type": "Fees::Flat"
+ }
+ },
+ {
+ "0": {
+ "cost": 50,
+ "description": "Seats",
+ "fee_type": "cost",
+ "quantity": 10
+ },
+ "1": {
+ "cost": 10,
+ "description": "Launch discount",
+ "discount_duration_amount": 3,
+ "discount_duration_type": "multiple_months",
+ "discount_type": "percentage",
+ "fee_type": "discount"
+ }
+ }
+ ],
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+ },
+ "fees_currency": {
+ "enum": [
+ "USD",
+ "EUR",
+ "GBP",
+ "CAD",
+ "AUD",
+ "SGD",
+ "ILS",
+ "JPY",
+ "CHF",
+ "HKD"
+ ],
+ "type": "string"
+ },
+ "fees_include_fee_increase_upon_renewal": {
+ "type": "boolean"
+ },
+ "fees_include_fee_increase_upon_renewal_fee": {
+ "type": "number"
+ },
+ "fees_include_fee_increase_upon_renewal_type": {
+ "enum": [
+ "will",
+ "may"
+ ],
+ "type": "string"
+ },
+ "fees_inclusive_of_taxes": {
+ "type": "boolean"
+ },
+ "framework_terms_type": {
+ "enum": [
+ "new",
+ "existing",
+ "description"
+ ],
+ "type": "string"
+ },
+ "free_trial_days": {
+ "type": "number"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_additional_changes": {
+ "type": "boolean"
+ },
+ "include_additional_parameters_or_limitations": {
+ "type": "boolean"
+ },
+ "include_consumption": {
+ "type": "boolean"
+ },
+ "include_fees": {
+ "type": "boolean"
+ },
+ "include_fees_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_fees_include_attachment": {
+ "type": "boolean"
+ },
+ "include_fees_other": {
+ "type": "boolean"
+ },
+ "include_fees_other_val": {
+ "type": "string"
+ },
+ "include_fees_table": {
+ "type": "boolean"
+ },
+ "include_fees_table_period": {
+ "enum": [
+ "Subscription Period",
+ "month",
+ "year",
+ "User"
+ ],
+ "type": "string"
+ },
+ "include_free_trial": {
+ "type": "boolean"
+ },
+ "include_max_users": {
+ "type": "boolean"
+ },
+ "include_pilot_period": {
+ "type": "boolean"
+ },
+ "include_pilot_period_duration_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_pilot_period_duration_type": {
+ "enum": [
+ "day",
+ "week",
+ "month"
+ ],
+ "type": "string"
+ },
+ "include_pilot_period_include_fees": {
+ "type": "boolean"
+ },
+ "include_pilot_period_include_fees_amount": {
+ "type": "number"
+ },
+ "include_pilot_period_include_modifications": {
+ "type": "boolean"
+ },
+ "include_pilot_period_include_modifications_description": {
+ "type": "string"
+ },
+ "include_product_support": {
+ "type": "boolean"
+ },
+ "include_product_support_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_product_support_description": {
+ "type": "string"
+ },
+ "include_product_support_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_professional_services": {
+ "type": "boolean"
+ },
+ "include_professional_services_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_professional_services_custom_name": {
+ "type": "string"
+ },
+ "include_professional_services_description": {
+ "type": "string"
+ },
+ "include_professional_services_end_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "include_professional_services_fees_description": {
+ "type": "string"
+ },
+ "include_professional_services_include_end_date": {
+ "type": "boolean"
+ },
+ "include_professional_services_include_fees_description": {
+ "type": "boolean"
+ },
+ "include_professional_services_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_sla": {
+ "type": "boolean"
+ },
+ "include_sla_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_sla_description": {
+ "type": "string"
+ },
+ "include_sla_include_response_time": {
+ "type": "boolean"
+ },
+ "include_sla_include_response_time_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_sla_include_response_time_credit": {
+ "type": "number"
+ },
+ "include_sla_include_response_time_duration": {
+ "enum": [
+ "hour",
+ "day",
+ "week",
+ "month",
+ "hours"
+ ],
+ "type": "string"
+ },
+ "include_sla_include_response_time_support_channel": {
+ "type": "string"
+ },
+ "include_sla_include_target_uptime": {
+ "type": "boolean"
+ },
+ "include_sla_maintenance_notice": {
+ "type": "boolean"
+ },
+ "include_sla_maintenance_window": {
+ "type": "boolean"
+ },
+ "include_sla_maintenance_window_type": {
+ "enum": [
+ "standard",
+ "none"
+ ],
+ "type": "string"
+ },
+ "include_sla_standard_maintenance_notice_qty": {
+ "type": "number"
+ },
+ "include_sla_standard_maintenance_notice_unit": {
+ "enum": [
+ "hour",
+ "day",
+ "week",
+ "month"
+ ],
+ "type": "string"
+ },
+ "include_sla_standard_maintenance_window_end_time": {
+ "type": "string"
+ },
+ "include_sla_standard_maintenance_window_friday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_monday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_saturday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_start_time": {
+ "type": "string"
+ },
+ "include_sla_standard_maintenance_window_sunday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_thursday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_time_zone": {
+ "type": "string"
+ },
+ "include_sla_standard_maintenance_window_tuesday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_wednesday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_target_uptime": {
+ "type": "number"
+ },
+ "include_sla_type": {
+ "enum": [
+ "description",
+ "standard",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_subscription_start_date": {
+ "type": "boolean"
+ },
+ "include_subscription_start_date_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "include_usage_review": {
+ "type": "boolean"
+ },
+ "include_usage_review_val": {
+ "type": "string"
+ },
+ "include_use_limitations": {
+ "type": "boolean"
+ },
+ "include_use_limitations_val": {
+ "type": "string"
+ },
+ "invoice_period": {
+ "enum": [
+ "monthly",
+ "quarterly",
+ "semiannually",
+ "annually",
+ "Custom unit",
+ "Monthly",
+ "Quarterly",
+ "Semiannually",
+ "Annually"
+ ],
+ "type": "string"
+ },
+ "invoice_period_custom_unit": {
+ "type": "string"
+ },
+ "max_consumption": {
+ "type": "number"
+ },
+ "max_users": {
+ "type": "number"
+ },
+ "negotiations_allowed": {
+ "description": "When true, the recipient can propose changes to the order form, even when the agreement-level `negotiations_allowed` is false. This only covers the order form.",
+ "type": "boolean"
+ },
+ "order_date_date": {
+ "type": "string"
+ },
+ "order_date_other": {
+ "type": "string"
+ },
+ "order_date_type": {
+ "enum": [
+ "signature",
+ "date",
+ "other"
+ ],
+ "type": "string"
+ },
+ "payment_period": {
+ "type": "number"
+ },
+ "payment_period_timeframe": {
+ "enum": [
+ "Customer's receipt of invoice",
+ "date of invoice"
+ ],
+ "type": "string"
+ },
+ "payment_period_unit": {
+ "enum": [
+ "day(s)",
+ "week(s)",
+ "month(s)",
+ "marketplace_acceptance"
+ ],
+ "type": "string"
+ },
+ "payment_process_automatic_frequency": {
+ "enum": [
+ "monthly",
+ "quarterly",
+ "semiannually",
+ "annually"
+ ],
+ "type": "string"
+ },
+ "payment_process_type": {
+ "enum": [
+ "automatic",
+ "invoice",
+ "custom",
+ "marketplace_acceptance"
+ ],
+ "type": "string"
+ },
+ "payment_process_type_custom_val": {
+ "type": "string"
+ },
+ "payment_process_type_invoice_amount": {
+ "type": "number"
+ },
+ "payment_process_type_invoice_custom_unit": {
+ "type": "string"
+ },
+ "payment_process_type_invoice_duration": {
+ "enum": [
+ "day",
+ "week",
+ "month",
+ "year",
+ "day(s)",
+ "week(s)",
+ "month(s)",
+ "year(s)"
+ ],
+ "type": "string"
+ },
+ "payment_process_type_invoice_duration_start": {
+ "enum": [
+ "Customer's receipt of invoice",
+ "date of invoice"
+ ],
+ "type": "string"
+ },
+ "payment_process_type_invoice_type": {
+ "enum": [
+ "monthly",
+ "quarterly",
+ "semiannually",
+ "annually",
+ "Custom unit"
+ ],
+ "type": "string"
+ },
+ "pilot_period_stripe_product_id": {
+ "type": "string"
+ },
+ "service_credits_attributes": {
+ "additionalProperties": {
+ "additionalProperties": false,
+ "properties": {
+ "credit": {
+ "type": "number"
+ },
+ "max": {
+ "type": "number"
+ },
+ "min": {
+ "type": "number"
+ }
+ },
+ "type": "object"
+ },
+ "description": "Service credits. Use string keys such as \"0\", \"1\".",
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+ },
+ "subscription_auto_renew": {
+ "enum": [
+ "days",
+ "subscription_end"
+ ],
+ "type": "string"
+ },
+ "subscription_period": {
+ "type": "number"
+ },
+ "subscription_period_unit": {
+ "type": "string"
+ },
+ "subscription_renewal_notice_days": {
+ "type": "number"
+ },
+ "subscription_start_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "subscription_start_date_type": {
+ "enum": [
+ "effective_date",
+ "date"
+ ],
+ "type": "string"
+ },
+ "underlying_agreement_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "use_limitations_attributes": {
+ "additionalProperties": {
+ "additionalProperties": false,
+ "properties": {
+ "amount": {
+ "type": "number"
+ },
+ "limitation_type": {
+ "type": "string"
+ },
+ "unit": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "description": "Use limitations. Use string keys such as \"0\", \"1\".",
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+ }
+ },
+ "type": "object"
+ },
+ "custom_field_values": {
+ "description": "Values for a custom template's fields, keyed by the field keys defined in the template's YAML definition. Only used when template_id is a custom template. Template defaults fill any fields you omit; a required field with no default and no submitted value returns a 400 naming the field. Values are validated against the field's input type: select and radio values must be one of the field's options, multiselect values are an array of selections each of which must be one of the field's options, number and currency values must be numeric, date values must be YYYY-MM-DD, and email values must be valid addresses. An invalid value returns a 400 naming the field."
+ },
+ "design_partner_attributes": {
+ "additionalProperties": false,
+ "description": "Override design partner terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "customer_description": {
+ "type": "string"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_fees": {
+ "type": "boolean"
+ },
+ "include_fees_amount": {
+ "type": "number"
+ },
+ "include_fees_description": {
+ "type": "string"
+ },
+ "include_fees_pay_by_amount": {
+ "type": "string"
+ },
+ "include_fees_type": {
+ "enum": [
+ "default_language",
+ "description"
+ ],
+ "type": "string"
+ },
+ "include_fees_unit": {
+ "enum": [
+ "month",
+ "quarter",
+ "year",
+ "Term"
+ ],
+ "type": "string"
+ },
+ "include_program_appear_as_customer_private": {
+ "type": "boolean"
+ },
+ "include_program_appear_as_customer_public": {
+ "type": "boolean"
+ },
+ "include_program_case_study": {
+ "type": "boolean"
+ },
+ "include_program_develop_functionality": {
+ "type": "boolean"
+ },
+ "include_program_develop_functionality_val": {
+ "type": "string"
+ },
+ "include_program_discount": {
+ "type": "boolean"
+ },
+ "include_program_discount_amount": {
+ "type": "number"
+ },
+ "include_program_discount_unit": {
+ "enum": [
+ "U.S. Dollars",
+ "percent"
+ ],
+ "type": "string"
+ },
+ "include_program_participation_feedback": {
+ "type": "boolean"
+ },
+ "include_program_participation_feedback_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_program_participation_feedback_unit": {
+ "enum": [
+ "month",
+ "quarter",
+ "year",
+ "Term"
+ ],
+ "type": "string"
+ },
+ "include_program_partner_other": {
+ "type": "boolean"
+ },
+ "include_program_partner_other_val": {
+ "type": "string"
+ },
+ "include_program_provider_other": {
+ "type": "boolean"
+ },
+ "include_program_provider_other_val": {
+ "type": "string"
+ },
+ "include_program_reference": {
+ "type": "boolean"
+ },
+ "product_description": {
+ "type": "string"
+ },
+ "term_amount": {
+ "type": "number"
+ },
+ "term_unit": {
+ "enum": [
+ "day(s)",
+ "week(s)",
+ "month(s)",
+ "quarter(s)",
+ "year(s)"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "district_or_county": {
+ "description": "The district or county for dispute resolution.",
+ "type": "string"
+ },
+ "dpa_attributes": {
+ "additionalProperties": false,
+ "description": "Override dpa terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "approved_subprocessor_type": {
+ "description": "`internal` lists approved subprocessors in the agreement (`subprocessors_attributes`); `external` points to a list published elsewhere.",
+ "enum": [
+ "internal",
+ "external"
+ ],
+ "type": "string"
+ },
+ "cloud_service_product_name": {
+ "type": "string"
+ },
+ "competent_supervisory_authority": {
+ "type": "string"
+ },
+ "customer_description": {
+ "type": "string"
+ },
+ "data_exporter_address_city": {
+ "type": "string"
+ },
+ "data_exporter_address_country": {
+ "type": "string"
+ },
+ "data_exporter_address_state": {
+ "type": "string"
+ },
+ "data_exporter_address_street_address": {
+ "type": "string"
+ },
+ "data_exporter_address_zipcode": {
+ "type": "string"
+ },
+ "data_exporter_contact_details": {
+ "type": "string"
+ },
+ "data_exporter_contact_name": {
+ "type": "string"
+ },
+ "data_exporter_contact_position": {
+ "type": "string"
+ },
+ "data_exporter_role": {
+ "description": "Role of the data exporter. Overwritten to `Controller` when the agreement is created from a template.",
+ "enum": [
+ "Controller",
+ "Processor"
+ ],
+ "type": "string"
+ },
+ "data_importer_address": {
+ "type": "string"
+ },
+ "data_importer_address_city": {
+ "type": "string"
+ },
+ "data_importer_address_country": {
+ "type": "string"
+ },
+ "data_importer_address_state": {
+ "type": "string"
+ },
+ "data_importer_address_street_address": {
+ "type": "string"
+ },
+ "data_importer_address_zipcode": {
+ "type": "string"
+ },
+ "data_importer_contact_details": {
+ "type": "string"
+ },
+ "data_importer_contact_name": {
+ "type": "string"
+ },
+ "data_importer_contact_position": {
+ "type": "string"
+ },
+ "duration_of_processing": {
+ "type": "string"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_covered_claim": {
+ "type": "boolean"
+ },
+ "include_covered_claim_external_val": {
+ "type": "string"
+ },
+ "include_covered_claim_internal_val": {
+ "type": "string"
+ },
+ "include_covered_claim_type": {
+ "description": "Which covered-claim text applies: `internal` uses `include_covered_claim_internal_val`, `external` uses `include_covered_claim_external_val`. Required when `include_covered_claim` is true.",
+ "enum": [
+ "internal",
+ "external"
+ ],
+ "type": "string"
+ },
+ "include_data_subjects_custom": {
+ "type": "boolean"
+ },
+ "include_data_subjects_custom_val": {
+ "type": "string"
+ },
+ "include_data_subjects_employees": {
+ "type": "boolean"
+ },
+ "include_data_subjects_end_users": {
+ "type": "boolean"
+ },
+ "include_external_subprocessor_location": {
+ "type": "string"
+ },
+ "include_frequency_of_transfer_continuous": {
+ "type": "boolean"
+ },
+ "include_frequency_of_transfer_custom": {
+ "type": "boolean"
+ },
+ "include_frequency_of_transfer_custom_val": {
+ "type": "string"
+ },
+ "include_governing_country_eu": {
+ "type": "boolean"
+ },
+ "include_governing_country_eu_val": {
+ "type": "string"
+ },
+ "include_governing_country_uk": {
+ "type": "boolean"
+ },
+ "include_governing_country_uk_val": {
+ "type": "string"
+ },
+ "include_governing_law": {
+ "type": "boolean"
+ },
+ "include_governing_law_country": {
+ "type": "string"
+ },
+ "include_governing_law_state": {
+ "type": "string"
+ },
+ "include_increased_claim_amount": {
+ "description": "Legacy field. Stored but not shown on the DPA; use the `include_liability_cap*` fields instead.",
+ "type": "boolean"
+ },
+ "include_increased_claim_amount_currency": {
+ "description": "Legacy field. Stored but not shown on the DPA; use the `include_liability_cap*` fields instead."
+ },
+ "include_increased_claim_amount_qty": {
+ "description": "Legacy field. Stored but not shown on the DPA; use the `include_liability_cap*` fields instead."
+ },
+ "include_increased_claim_amount_type": {
+ "description": "Legacy field. Stored but not shown on the DPA; use the `include_liability_cap*` fields instead.",
+ "type": "string"
+ },
+ "include_liability_cap": {
+ "type": "boolean"
+ },
+ "include_liability_cap_amount_constant_external": {
+ "type": "string"
+ },
+ "include_liability_cap_amount_constant_internal": {
+ "type": "string"
+ },
+ "include_liability_cap_amount_currency_external": {
+ "description": "Currency amount. Numbers and numeric strings (commas allowed) are both accepted."
+ },
+ "include_liability_cap_amount_currency_internal": {
+ "description": "Currency amount. Numbers and numeric strings (commas allowed) are both accepted."
+ },
+ "include_liability_cap_csa_type": {
+ "description": "Which liability cap values apply: the `_internal` or `_external` amount fields. Required when `include_liability_cap` is true.",
+ "enum": [
+ "internal",
+ "external"
+ ],
+ "type": "string"
+ },
+ "include_personal_data_biographic_info": {
+ "type": "boolean"
+ },
+ "include_personal_data_contact_info": {
+ "type": "boolean"
+ },
+ "include_personal_data_custom": {
+ "type": "boolean"
+ },
+ "include_personal_data_custom_val": {
+ "type": "string"
+ },
+ "include_personal_data_employment_info": {
+ "type": "boolean"
+ },
+ "include_personal_data_financial_info": {
+ "type": "boolean"
+ },
+ "include_personal_data_location": {
+ "type": "boolean"
+ },
+ "include_personal_data_name": {
+ "type": "boolean"
+ },
+ "include_personal_data_transactional_info": {
+ "type": "boolean"
+ },
+ "include_personal_data_user_activity_info": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_custom": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_custom_val": {
+ "type": "string"
+ },
+ "include_processing_purpose_erasing": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_holding": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_protecting": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_receiving": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_returning": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_sharing": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_updating": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_using": {
+ "type": "boolean"
+ },
+ "include_provider_security_contact_address": {
+ "type": "boolean"
+ },
+ "include_provider_security_contact_address_city": {
+ "type": "string"
+ },
+ "include_provider_security_contact_address_country": {
+ "type": "string"
+ },
+ "include_provider_security_contact_address_state": {
+ "type": "string"
+ },
+ "include_provider_security_contact_address_street_address": {
+ "type": "string"
+ },
+ "include_provider_security_contact_address_zipcode": {
+ "type": "string"
+ },
+ "include_provider_security_contact_email": {
+ "type": "boolean"
+ },
+ "include_provider_security_contact_email_val": {
+ "format": "email",
+ "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "include_security_measures_accountability": {
+ "type": "boolean"
+ },
+ "include_security_measures_accountability_val": {
+ "type": "string"
+ },
+ "include_security_measures_certification_or_assurance": {
+ "type": "boolean"
+ },
+ "include_security_measures_certification_or_assurance_val": {
+ "type": "string"
+ },
+ "include_security_measures_confidentiality_integrity": {
+ "type": "boolean"
+ },
+ "include_security_measures_confidentiality_integrity_val": {
+ "type": "string"
+ },
+ "include_security_measures_data_at_rest": {
+ "type": "boolean"
+ },
+ "include_security_measures_data_at_rest_val": {
+ "type": "string"
+ },
+ "include_security_measures_data_minimization": {
+ "type": "boolean"
+ },
+ "include_security_measures_data_minimization_val": {
+ "type": "string"
+ },
+ "include_security_measures_data_quality": {
+ "type": "boolean"
+ },
+ "include_security_measures_data_quality_val": {
+ "type": "string"
+ },
+ "include_security_measures_data_retention": {
+ "type": "boolean"
+ },
+ "include_security_measures_data_retention_val": {
+ "type": "string"
+ },
+ "include_security_measures_data_transmission": {
+ "type": "boolean"
+ },
+ "include_security_measures_data_transmission_val": {
+ "type": "string"
+ },
+ "include_security_measures_event_logging": {
+ "type": "boolean"
+ },
+ "include_security_measures_event_logging_val": {
+ "type": "string"
+ },
+ "include_security_measures_identity_auth": {
+ "type": "boolean"
+ },
+ "include_security_measures_identity_auth_val": {
+ "type": "string"
+ },
+ "include_security_measures_it_security_governance": {
+ "type": "boolean"
+ },
+ "include_security_measures_it_security_governance_val": {
+ "type": "string"
+ },
+ "include_security_measures_physical_security": {
+ "type": "boolean"
+ },
+ "include_security_measures_physical_security_val": {
+ "type": "string"
+ },
+ "include_security_measures_portability_and_erasure": {
+ "type": "boolean"
+ },
+ "include_security_measures_portability_and_erasure_val": {
+ "type": "string"
+ },
+ "include_security_measures_pseudonym_encryption": {
+ "type": "boolean"
+ },
+ "include_security_measures_pseudonym_encryption_val": {
+ "type": "string"
+ },
+ "include_security_measures_restore_data_access": {
+ "type": "boolean"
+ },
+ "include_security_measures_restore_data_access_val": {
+ "type": "string"
+ },
+ "include_security_measures_security_policy": {
+ "type": "boolean"
+ },
+ "include_security_measures_system_configuration": {
+ "type": "boolean"
+ },
+ "include_security_measures_system_configuration_val": {
+ "type": "string"
+ },
+ "include_security_measures_testing_assessment": {
+ "type": "boolean"
+ },
+ "include_security_measures_testing_assessment_val": {
+ "type": "string"
+ },
+ "include_security_policy": {
+ "type": "boolean"
+ },
+ "include_security_policy_fedramp_auth": {
+ "type": "boolean"
+ },
+ "include_security_policy_hipaa": {
+ "type": "boolean"
+ },
+ "include_security_policy_hitrust": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_other": {
+ "type": "boolean"
+ },
+ "include_security_policy_iso27001": {
+ "type": "boolean"
+ },
+ "include_security_policy_other": {
+ "type": "string"
+ },
+ "include_security_policy_pci1": {
+ "type": "boolean"
+ },
+ "include_security_policy_pci2": {
+ "type": "boolean"
+ },
+ "include_security_policy_penetration_testing": {
+ "type": "boolean"
+ },
+ "include_security_policy_soc2": {
+ "type": "boolean"
+ },
+ "include_security_policy_soc2_type2": {
+ "type": "boolean"
+ },
+ "include_sensitive_data_restrictions_custom": {
+ "type": "boolean"
+ },
+ "include_sensitive_data_restrictions_custom_val": {
+ "type": "string"
+ },
+ "include_sensitive_data_restrictions_security_policy": {
+ "type": "boolean"
+ },
+ "include_service_provider_relationship": {
+ "type": "boolean"
+ },
+ "include_special_category_data": {
+ "type": "boolean"
+ },
+ "provider": {
+ "type": "string"
+ },
+ "security_policy_available_at": {
+ "type": "string"
+ },
+ "security_policy_type": {
+ "description": "Where the Security Policy is defined. For `external`, set `security_policy_available_at`.",
+ "enum": [
+ "defined in agreement",
+ "provider service",
+ "external"
+ ],
+ "type": "string"
+ },
+ "subprocessors_attributes": {
+ "additionalProperties": {
+ "additionalProperties": false,
+ "properties": {
+ "_destroy": {
+ "description": "Set to true with `id` to remove that subprocessor.",
+ "type": "boolean"
+ },
+ "country": {
+ "type": "string"
+ },
+ "id": {
+ "description": "ID of an existing subprocessor to update or remove. Omit to add a new subprocessor.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "processing_task": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "description": "Subprocessors, keyed by string index such as \"0\", \"1\". On create these are added to the template's subprocessors. On a draft update, an entry without `id` adds a new subprocessor; pass `id` to change one and `id` with `_destroy: true` to remove one.",
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+ },
+ "underlying_agreement_id": {
+ "description": "ID of the CSA this DPA supplements when `underlying_agreement_type` is `internal`.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "underlying_agreement_type": {
+ "description": "`internal` links a CSA in Common Paper (`underlying_agreement_id`); `external` describes another agreement in `underlying_agreement_val` (required). Omit for none.",
+ "enum": [
+ "internal",
+ "external"
+ ],
+ "type": "string"
+ },
+ "underlying_agreement_val": {
+ "description": "Description of the agreement this DPA supplements. Required when `underlying_agreement_type` is `external`.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "framework_terms_description": {
+ "description": "Custom framework terms description. Only used when framework_terms_type is \"description\".",
+ "type": "string"
+ },
+ "framework_terms_type": {
+ "description": "How framework terms are specified. Use \"new\" for standard terms or \"description\" to provide a custom framework_terms_description.",
+ "enum": [
+ "new",
+ "description"
+ ],
+ "type": "string"
+ },
+ "governing_law_country": {
+ "description": "The country whose laws govern the agreement.",
+ "type": "string"
+ },
+ "governing_law_region": {
+ "description": "The state or region whose laws govern the agreement.",
+ "type": "string"
+ },
+ "include_automated_payment_reminders": {
+ "description": "When true, automatically sends payment reminder emails.",
+ "type": "boolean"
+ },
+ "include_billing_info": {
+ "description": "When true, billing contact information (billing_name, billing_email) is included.",
+ "type": "boolean"
+ },
+ "include_billing_workflow": {
+ "description": "When true, enables a billing workflow after signing.",
+ "type": "boolean"
+ },
+ "include_expiration_date": {
+ "description": "Expiration date in YYYY-MM-DD format. Use when include_expiration_type is \"date\".",
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "include_expiration_days": {
+ "description": "Number of days until the agreement expires. Use when include_expiration_type is \"days\".",
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_expiration_type": {
+ "description": "How to set expiration: \"none\" (default), \"days\" (use include_expiration_days), or \"date\" (use include_expiration_date).",
+ "enum": [
+ "none",
+ "days",
+ "date"
+ ],
+ "type": "string"
+ },
+ "include_terms": {
+ "description": "When true, the standard terms are included with the agreement.",
+ "type": "boolean"
+ },
+ "loi_attributes": {
+ "additionalProperties": false,
+ "description": "Override loi terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "confidentiality_custom": {
+ "type": "string"
+ },
+ "confidentiality_mutual_include_loi": {
+ "type": "boolean"
+ },
+ "confidentiality_nda_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "confidentiality_nda_description": {
+ "type": "string"
+ },
+ "confidentiality_nda_include_loi": {
+ "type": "boolean"
+ },
+ "confidentiality_nda_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "confidentiality_type": {
+ "enum": [
+ "mutual",
+ "nda",
+ "provider",
+ "custom"
+ ],
+ "type": "string"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_custom_details": {
+ "type": "boolean"
+ },
+ "include_custom_details_val": {
+ "type": "string"
+ },
+ "include_fees": {
+ "type": "boolean"
+ },
+ "include_fees_amount": {
+ "type": "number"
+ },
+ "include_fees_amount_duration": {
+ "enum": [
+ "month",
+ "year",
+ "quarter"
+ ],
+ "type": "string"
+ },
+ "include_fees_include_amount": {
+ "type": "boolean"
+ },
+ "include_fees_include_other": {
+ "type": "boolean"
+ },
+ "include_fees_other": {
+ "type": "string"
+ },
+ "include_functionality": {
+ "type": "boolean"
+ },
+ "include_functionality_val": {
+ "type": "string"
+ },
+ "include_launch_date": {
+ "type": "boolean"
+ },
+ "include_launch_date_custom": {
+ "type": "string"
+ },
+ "include_launch_date_date": {
+ "format": "date-time",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$",
+ "type": "string"
+ },
+ "include_launch_date_type": {
+ "enum": [
+ "date",
+ "custom"
+ ],
+ "type": "string"
+ },
+ "product_name": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "manual_send": {
+ "description": "When true, the agreement is marked as manually sent outside the platform.",
+ "type": "boolean"
+ },
+ "message": {
+ "type": "string"
+ },
+ "negotiations_allowed": {
+ "description": "When true, the recipient can propose changes to the legal terms. For agreement types without separate business terms, that covers every term. CSA order forms, PSA statements of work, partnership business terms and software license order forms have their own `negotiations_allowed` flag.",
+ "type": "boolean"
+ },
+ "partnership_attributes": {
+ "additionalProperties": false,
+ "description": "Override partnership terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "effective_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "effective_date_type": {
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "type": "string"
+ },
+ "general_cap_amount_currency_val": {
+ "type": "number"
+ },
+ "general_cap_amount_either_currency": {
+ "type": "number"
+ },
+ "general_cap_amount_either_multiple": {
+ "type": "number"
+ },
+ "general_cap_amount_multiple_val": {
+ "type": "number"
+ },
+ "general_cap_amount_type": {
+ "enum": [
+ "multiple",
+ "currency",
+ "either",
+ "base"
+ ],
+ "type": "string"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_additional_warranties": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_include_company": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_include_company_val": {
+ "type": "string"
+ },
+ "include_additional_warranties_include_partner": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_include_partner_val": {
+ "type": "string"
+ },
+ "include_brand_guidelines": {
+ "type": "boolean"
+ },
+ "include_brand_guidelines_include_company": {
+ "type": "boolean"
+ },
+ "include_brand_guidelines_include_company_val": {
+ "type": "string"
+ },
+ "include_brand_guidelines_include_partner": {
+ "type": "boolean"
+ },
+ "include_brand_guidelines_include_partner_val": {
+ "type": "string"
+ },
+ "include_covered_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_company_claims": {
+ "type": "string"
+ },
+ "include_covered_claims_include_company_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_include_partner_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_partner_claims": {
+ "type": "string"
+ },
+ "include_dpa": {
+ "type": "boolean"
+ },
+ "include_dpa_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_dpa_location": {
+ "type": "string"
+ },
+ "include_dpa_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_increased_cap_amount": {
+ "type": "boolean"
+ },
+ "include_increased_cap_amount_currency": {
+ "type": "number"
+ },
+ "include_increased_cap_amount_either_currency": {
+ "type": "number"
+ },
+ "include_increased_cap_amount_either_multiple": {
+ "type": "string"
+ },
+ "include_increased_cap_amount_multiple": {
+ "type": "string"
+ },
+ "include_increased_cap_amount_type": {
+ "enum": [
+ "multiple",
+ "currency",
+ "either"
+ ],
+ "type": "string"
+ },
+ "include_increased_claims": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_confidentiality": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_confidentiality_misconduct": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_covered_claims": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_misconduct": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_other": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_other_val": {
+ "type": "string"
+ },
+ "include_unlimited_claims": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_confidentiality": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_confidentiality_misconduct": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_covered_claims": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_misconduct": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_other": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_other_val": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "partnership_business_terms_attributes": {
+ "additionalProperties": false,
+ "description": "Override partnership business terms terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "end_date_after_effective_date_amount": {
+ "type": "number"
+ },
+ "end_date_after_effective_date_unit": {
+ "enum": [
+ "month(s)",
+ "quarter(s)",
+ "year(s)"
+ ],
+ "type": "string"
+ },
+ "end_date_date": {
+ "type": "string"
+ },
+ "end_date_type": {
+ "enum": [
+ "date",
+ "effective date"
+ ],
+ "type": "string"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_obligations_company_brand": {
+ "type": "boolean"
+ },
+ "include_obligations_company_promotion": {
+ "type": "boolean"
+ },
+ "include_obligations_company_promotion_include_activities": {
+ "type": "boolean"
+ },
+ "include_obligations_company_promotion_include_activities_val": {
+ "type": "string"
+ },
+ "include_obligations_company_promotion_include_materials": {
+ "type": "boolean"
+ },
+ "include_obligations_company_promotion_include_materials_val": {
+ "type": "string"
+ },
+ "include_obligations_company_referral": {
+ "type": "boolean"
+ },
+ "include_obligations_company_referral_include_criteria": {
+ "type": "boolean"
+ },
+ "include_obligations_company_referral_include_criteria_val": {
+ "type": "string"
+ },
+ "include_obligations_company_referral_include_pay_sch": {
+ "type": "boolean"
+ },
+ "include_obligations_company_referral_include_pay_sch_amount": {
+ "type": "number"
+ },
+ "include_obligations_company_referral_include_pay_sch_custom": {
+ "type": "string"
+ },
+ "include_obligations_company_referral_include_pay_sch_unit": {
+ "enum": [
+ "U.S. Dollars",
+ "percent"
+ ],
+ "type": "string"
+ },
+ "include_obligations_company_sponsorship": {
+ "type": "boolean"
+ },
+ "include_obligations_company_sponsorship_include_benefits": {
+ "type": "boolean"
+ },
+ "include_obligations_company_sponsorship_include_benefits_val": {
+ "type": "string"
+ },
+ "include_obligations_company_sponsorship_include_payments": {
+ "type": "boolean"
+ },
+ "include_obligations_company_sponsorship_include_payments_amount": {
+ "type": "number"
+ },
+ "include_obligations_company_sponsorship_include_payments_unit": {
+ "enum": [
+ "U.S. Dollars",
+ "percent"
+ ],
+ "type": "string"
+ },
+ "include_obligations_partner_brand": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_promotion": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_promotion_include_activities": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_promotion_include_activities_val": {
+ "type": "string"
+ },
+ "include_obligations_partner_promotion_include_materials": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_promotion_include_materials_val": {
+ "type": "string"
+ },
+ "include_obligations_partner_referral": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_referral_include_criteria": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_referral_include_criteria_val": {
+ "type": "string"
+ },
+ "include_obligations_partner_referral_include_pay_sch": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_referral_include_pay_sch_amount": {
+ "type": "number"
+ },
+ "include_obligations_partner_referral_include_pay_sch_custom": {
+ "type": "string"
+ },
+ "include_obligations_partner_referral_include_pay_sch_unit": {
+ "enum": [
+ "U.S. Dollars",
+ "percent"
+ ],
+ "type": "string"
+ },
+ "include_obligations_partner_sponsorship": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_sponsorship_include_benefits": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_sponsorship_include_benefits_val": {
+ "type": "string"
+ },
+ "include_obligations_partner_sponsorship_include_payments": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_sponsorship_include_payments_amount": {
+ "type": "number"
+ },
+ "include_obligations_partner_sponsorship_include_payments_unit": {
+ "enum": [
+ "U.S. Dollars",
+ "percent"
+ ],
+ "type": "string"
+ },
+ "include_payment_process": {
+ "type": "boolean"
+ },
+ "include_payment_process_company": {
+ "type": "boolean"
+ },
+ "include_payment_process_company_include_address": {
+ "type": "boolean"
+ },
+ "include_payment_process_company_include_address_city": {
+ "type": "string"
+ },
+ "include_payment_process_company_include_address_country": {
+ "type": "string"
+ },
+ "include_payment_process_company_include_address_state": {
+ "type": "string"
+ },
+ "include_payment_process_company_include_address_street_address": {
+ "type": "string"
+ },
+ "include_payment_process_company_include_address_zipcode": {
+ "type": "string"
+ },
+ "include_payment_process_company_include_email": {
+ "type": "boolean"
+ },
+ "include_payment_process_company_include_email_val": {
+ "type": "string"
+ },
+ "include_payment_process_partner": {
+ "type": "boolean"
+ },
+ "include_payment_process_partner_include_address": {
+ "type": "boolean"
+ },
+ "include_payment_process_partner_include_address_city": {
+ "type": "string"
+ },
+ "include_payment_process_partner_include_address_country": {
+ "type": "string"
+ },
+ "include_payment_process_partner_include_address_state": {
+ "type": "string"
+ },
+ "include_payment_process_partner_include_address_street_address": {
+ "type": "string"
+ },
+ "include_payment_process_partner_include_address_zipcode": {
+ "type": "string"
+ },
+ "include_payment_process_partner_include_email": {
+ "type": "boolean"
+ },
+ "include_payment_process_partner_include_email_val": {
+ "type": "string"
+ },
+ "include_payment_schedule": {
+ "type": "boolean"
+ },
+ "include_payment_schedule_custom": {
+ "type": "string"
+ },
+ "include_payment_schedule_specified_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_payment_schedule_specified_timeframe": {
+ "enum": [
+ "receipt",
+ "date"
+ ],
+ "type": "string"
+ },
+ "include_payment_schedule_specified_unit": {
+ "enum": [
+ "day(s)",
+ "week(s)",
+ "month(s)",
+ "quarter(s)",
+ "year(s)"
+ ],
+ "type": "string"
+ },
+ "include_payment_schedule_type": {
+ "enum": [
+ "specified",
+ "custom"
+ ],
+ "type": "string"
+ },
+ "negotiations_allowed": {
+ "description": "When true, the recipient can propose changes to the business terms, even when the agreement-level `negotiations_allowed` is false. This only covers the business terms.",
+ "type": "boolean"
+ },
+ "territory_type": {
+ "enum": [
+ "worldwide",
+ "custom"
+ ],
+ "type": "string"
+ },
+ "territory_type_val": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "payment_link_url": {
+ "description": "A payment URL shown to the recipient after signing. Requires include_billing_workflow to be true and billing_workflow_type to be \"link\".",
+ "type": "string"
+ },
+ "pilot_attributes": {
+ "additionalProperties": false,
+ "description": "Override pilot terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "fees_type": {
+ "enum": [
+ "free",
+ "pilot_period_fees"
+ ],
+ "type": "string"
+ },
+ "general_cap_amount": {
+ "type": "number"
+ },
+ "general_cap_amount_type": {
+ "enum": [
+ "preceding",
+ "base",
+ "period"
+ ],
+ "type": "string"
+ },
+ "general_cap_period_currency": {
+ "type": "number"
+ },
+ "general_cap_period_qty": {
+ "type": "number"
+ },
+ "general_cap_preceding_amount": {
+ "type": "number"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_dpa": {
+ "type": "boolean"
+ },
+ "include_dpa_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_dpa_location": {
+ "type": "string"
+ },
+ "include_dpa_type": {
+ "enum": [
+ "description",
+ "attachment",
+ "standard"
+ ],
+ "type": "string"
+ },
+ "include_payment_process": {
+ "type": "boolean"
+ },
+ "include_technical_support": {
+ "type": "boolean"
+ },
+ "payment_process_automatic_frequency": {
+ "enum": [
+ "monthly",
+ "quarterly",
+ "annually",
+ "once_per_period"
+ ],
+ "type": "string"
+ },
+ "payment_process_invoice_days": {
+ "type": "number"
+ },
+ "payment_process_invoice_from": {
+ "enum": [
+ "receipt",
+ "date"
+ ],
+ "type": "string"
+ },
+ "payment_process_invoice_timeframe": {
+ "enum": [
+ "days",
+ "weeks",
+ "months",
+ "quarters",
+ "years"
+ ],
+ "type": "string"
+ },
+ "payment_process_type": {
+ "enum": [
+ "automatic",
+ "invoice"
+ ],
+ "type": "string"
+ },
+ "pilot_period_description": {
+ "type": "string"
+ },
+ "pilot_period_fees_description": {
+ "type": "string"
+ },
+ "product_description": {
+ "type": "string"
+ },
+ "technical_support_description": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "psa_attributes": {
+ "additionalProperties": false,
+ "description": "Override psa terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "additional_changes": {
+ "type": "string"
+ },
+ "customer_description": {
+ "type": "string"
+ },
+ "effective_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "effective_date_type": {
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "type": "string"
+ },
+ "general_cap_amount": {
+ "type": "number"
+ },
+ "general_cap_amount_type": {
+ "enum": [
+ "preceding",
+ "base",
+ "period"
+ ],
+ "type": "string"
+ },
+ "general_cap_period_currency": {
+ "type": "number"
+ },
+ "general_cap_period_qty": {
+ "type": "number"
+ },
+ "general_cap_preceding_amount": {
+ "type": "number"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_additional_changes": {
+ "type": "boolean"
+ },
+ "include_additional_warranties": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_by_customer": {
+ "type": "string"
+ },
+ "include_additional_warranties_by_provider": {
+ "type": "string"
+ },
+ "include_additional_warranties_include_by_customer": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_include_by_provider": {
+ "type": "boolean"
+ },
+ "include_covered_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_customer_claims": {
+ "type": "string"
+ },
+ "include_covered_claims_include_customer_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_include_provider_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_provider_claims": {
+ "type": "string"
+ },
+ "include_customer_insurance_min": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_add_provider_com_gen_liability": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_add_provider_cyber_liability": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_add_provider_errors_omissions": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_auto_liability_aggregate": {
+ "type": "number"
+ },
+ "include_customer_insurance_min_auto_liability_minimum": {
+ "type": "number"
+ },
+ "include_customer_insurance_min_cyber_liability_aggregate": {
+ "type": "number"
+ },
+ "include_customer_insurance_min_cyber_liability_minimum": {
+ "type": "number"
+ },
+ "include_customer_insurance_min_employer_liability_aggregate": {
+ "type": "number"
+ },
+ "include_customer_insurance_min_employer_liability_minimum": {
+ "type": "number"
+ },
+ "include_customer_insurance_min_general_liability_aggregate": {
+ "type": "number"
+ },
+ "include_customer_insurance_min_general_liability_minimum": {
+ "type": "number"
+ },
+ "include_customer_insurance_min_include_add_provider": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_include_auto_liability": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_include_cyber_liability": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_include_employer_liability": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_include_general_liability": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_include_workers_comp": {
+ "type": "boolean"
+ },
+ "include_customer_policies": {
+ "type": "boolean"
+ },
+ "include_customer_policies_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_customer_policies_location": {
+ "type": "string"
+ },
+ "include_customer_policies_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_dpa": {
+ "type": "boolean"
+ },
+ "include_dpa_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_dpa_location": {
+ "type": "string"
+ },
+ "include_dpa_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_increased_cap_amount": {
+ "type": "boolean"
+ },
+ "include_increased_claims": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_confidentiality": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_confidentiality_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_privsec": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_privsec_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_other": {
+ "type": "boolean"
+ },
+ "include_increased_claims_indemnification_obligation": {
+ "type": "boolean"
+ },
+ "include_increased_claims_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_other": {
+ "type": "string"
+ },
+ "include_provider_insurance_min": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_add_customer_com_gen_liability": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_add_customer_cyber_liability": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_add_customer_errors_omissions": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_auto_liability_aggregate": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_auto_liability_minimum": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_cyber_liability_aggregate": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_cyber_liability_minimum": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_employer_liability_aggregate": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_employer_liability_minimum": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_general_liability_aggregate": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_general_liability_minimum": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_include_add_customer": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_include_auto_liability": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_include_cyber_liability": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_include_employer_liability": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_include_general_liability": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_include_workers_comp": {
+ "type": "boolean"
+ },
+ "include_publicity_rights": {
+ "type": "boolean"
+ },
+ "include_publicity_rights_type": {
+ "enum": [
+ "public",
+ "non-public"
+ ],
+ "type": "string"
+ },
+ "include_security_policy": {
+ "type": "boolean"
+ },
+ "include_security_policy_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_security_policy_fedramp_auth": {
+ "type": "boolean"
+ },
+ "include_security_policy_hitrust": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_annual_maintenance": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_other": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_other_val": {
+ "type": "string"
+ },
+ "include_security_policy_iso27001": {
+ "type": "boolean"
+ },
+ "include_security_policy_location": {
+ "type": "string"
+ },
+ "include_security_policy_pci1": {
+ "type": "boolean"
+ },
+ "include_security_policy_pci2": {
+ "type": "boolean"
+ },
+ "include_security_policy_penetration_testing": {
+ "type": "boolean"
+ },
+ "include_security_policy_soc2_type1": {
+ "type": "boolean"
+ },
+ "include_security_policy_soc2_type2": {
+ "type": "boolean"
+ },
+ "include_security_policy_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_unlimited_claims": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_confidentiality": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_confidentiality_negligence": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_privsec": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_privsec_negligence": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_include_other": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_indemnification_obligation": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_negligence": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_other": {
+ "type": "string"
+ },
+ "increased_cap_amount_currency": {
+ "type": "number"
+ },
+ "increased_cap_amount_period_currency": {
+ "type": "number"
+ },
+ "increased_cap_amount_period_qty": {
+ "type": "number"
+ },
+ "increased_cap_amount_qty": {
+ "type": "number"
+ },
+ "increased_cap_amount_type": {
+ "enum": [
+ "qty",
+ "currency",
+ "period"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "psa_statement_of_work_attributes": {
+ "additionalProperties": false,
+ "description": "Override psa statement of work terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "additional_changes": {
+ "type": "string"
+ },
+ "cost": {
+ "type": "number"
+ },
+ "description": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "fees_attributes": {
+ "additionalProperties": {
+ "anyOf": [
+ {
+ "additionalProperties": false,
+ "description": "Fees::Flat (fee_type \"flat\"). A fixed recurring fee, e.g. a platform subscription. Set type to \"Fees::Flat\" or fee_type to \"flat\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Fixed amount in the order form's fees_currency, charged per fee_period. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"flat\". Alternative to type.",
+ "enum": [
+ "flat"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Flat\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Flat"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Discount (fee_type \"discount\"). A discount, as a fixed amount or a percentage, applied forever, once, or for a number of months. Set type to \"Fees::Discount\" or fee_type to \"discount\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Discount size: an amount in fees_currency when discount_type is fixed_amount (a plain amount, not cents: 20 means 20.00), or a percentage (e.g. 10 for 10%) when it is percentage.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "discount_duration_amount": {
+ "description": "Number of months the discount applies. Required when discount_duration_type is multiple_months.",
+ "type": "number"
+ },
+ "discount_duration_type": {
+ "description": "How long the discount applies. multiple_months also needs discount_duration_amount.",
+ "enum": [
+ "forever",
+ "once",
+ "multiple_months"
+ ],
+ "type": "string"
+ },
+ "discount_type": {
+ "description": "Whether cost is a currency amount or a percentage.",
+ "enum": [
+ "fixed_amount",
+ "percentage"
+ ],
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"discount\". Alternative to type.",
+ "enum": [
+ "discount"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Discount\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Discount"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Cost (fee_type \"cost\"). A per-unit fee: price per unit times quantity, e.g. seats. Set type to \"Fees::Cost\" or fee_type to \"cost\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Price per unit in fees_currency. The row total is quantity x cost. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"cost\". Alternative to type.",
+ "enum": [
+ "cost"
+ ],
+ "type": "string"
+ },
+ "quantity": {
+ "description": "Number of units.",
+ "type": "number"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Cost\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Cost"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Attachment (fee_type \"attachment\"). A fee described in an uploaded attachment instead of in the table. Set type to \"Fees::Attachment\" or fee_type to \"attachment\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "attachment_id": {
+ "description": "ID of an attachment uploaded with upload-attachment.",
+ "type": "string"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"attachment\". Alternative to type.",
+ "enum": [
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Attachment\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Attachment"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Graduated (fee_type \"graduated\"). Tiered pricing, with the price set per tier in graduated_fee_tiers_attributes. Set type to \"Fees::Graduated\" or fee_type to \"graduated\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"graduated\". Alternative to type.",
+ "enum": [
+ "graduated"
+ ],
+ "type": "string"
+ },
+ "graduated_fee_tiers_attributes": {
+ "additionalProperties": {
+ "additionalProperties": false,
+ "properties": {
+ "flat_price": {
+ "type": "number"
+ },
+ "price_per_unit": {
+ "type": "string"
+ },
+ "upper_limit": {
+ "type": "number"
+ }
+ },
+ "type": "object"
+ },
+ "description": "Graduated fee tiers. Use string keys such as \"0\", \"1\".",
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Graduated\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Graduated"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Included (fee_type \"included\"). An item included at no charge. Set type to \"Fees::Included\" or fee_type to \"included\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"included\". Alternative to type.",
+ "enum": [
+ "included"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Included\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Included"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Metered (fee_type \"metered\"). Usage-based pricing, billed per unit used. Set type to \"Fees::Metered\" or fee_type to \"metered\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Price per unit of usage in fees_currency. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"metered\". Alternative to type.",
+ "enum": [
+ "metered"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Metered\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Metered"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::OneTime (fee_type \"one_time\"). A one-time charge, such as a setup fee. Set type to \"Fees::OneTime\" or fee_type to \"one_time\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "One-time amount in fees_currency, charged once rather than per fee_period. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"one_time\". Alternative to type.",
+ "enum": [
+ "one_time"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::OneTime\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::OneTime"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Text (fee_type \"text\"). A fee term described in free text. Set type to \"Fees::Text\" or fee_type to \"text\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"text\". Alternative to type.",
+ "enum": [
+ "text"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Text\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Text"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ }
+ ]
+ },
+ "description": "Fee line items. Use string keys such as \"0\", \"1\". Replaces template fees when provided.",
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_additional_changes": {
+ "type": "boolean"
+ },
+ "include_customer_obligation": {
+ "type": "boolean"
+ },
+ "include_customer_obligation_val": {
+ "type": "string"
+ },
+ "include_deliverables": {
+ "type": "boolean"
+ },
+ "include_deliverables_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_deliverables_description": {
+ "type": "string"
+ },
+ "include_deliverables_include_acceptance": {
+ "type": "boolean"
+ },
+ "include_deliverables_include_attachment": {
+ "type": "boolean"
+ },
+ "include_deliverables_include_draft_deliverables": {
+ "type": "boolean"
+ },
+ "include_deliverables_rejection_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_deliverables_rejection_unit": {
+ "enum": [
+ "hours",
+ "days",
+ "weeks",
+ "months"
+ ],
+ "type": "string"
+ },
+ "include_deliverables_resubmission_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_deliverables_resubmission_unit": {
+ "enum": [
+ "hours",
+ "days",
+ "weeks",
+ "months"
+ ],
+ "type": "string"
+ },
+ "include_fees_other": {
+ "type": "boolean"
+ },
+ "include_fees_other_val": {
+ "type": "string"
+ },
+ "include_fees_table": {
+ "type": "boolean"
+ },
+ "include_fees_table_total": {
+ "type": "boolean"
+ },
+ "include_fees_travel": {
+ "type": "boolean"
+ },
+ "include_fees_travel_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_fees_travel_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_fees_travel_val": {
+ "type": "string"
+ },
+ "include_third_party_customer": {
+ "type": "boolean"
+ },
+ "include_third_party_include_description": {
+ "type": "boolean"
+ },
+ "include_third_party_include_description_val": {
+ "type": "string"
+ },
+ "include_third_party_materials": {
+ "type": "boolean"
+ },
+ "include_third_party_provider": {
+ "type": "boolean"
+ },
+ "include_time_of_assignment": {
+ "type": "boolean"
+ },
+ "include_time_of_assignment_type": {
+ "enum": [
+ "created",
+ "paid"
+ ],
+ "type": "string"
+ },
+ "invoice_period_description": {
+ "type": "string"
+ },
+ "negotiations_allowed": {
+ "description": "When true, the recipient can propose changes to the statement of work, even when the agreement-level `negotiations_allowed` is false. This only covers the statement of work.",
+ "type": "boolean"
+ },
+ "payment_period": {
+ "type": "number"
+ },
+ "payment_period_other": {
+ "type": "string"
+ },
+ "payment_period_timeframe": {
+ "enum": [
+ "receipt",
+ "invoice",
+ "Customer's receipt of invoice",
+ "date of invoice"
+ ],
+ "type": "string"
+ },
+ "payment_period_type": {
+ "enum": [
+ "standard",
+ "other"
+ ],
+ "type": "string"
+ },
+ "payment_period_unit": {
+ "enum": [
+ "day(s)",
+ "week(s)",
+ "month(s)",
+ "quarter(s)",
+ "year(s)"
+ ],
+ "type": "string"
+ },
+ "quantity": {
+ "type": "number"
+ },
+ "services_description": {
+ "type": "string"
+ },
+ "sow_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "sow_date_type": {
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "type": "string"
+ },
+ "sow_term_amount": {
+ "type": "number"
+ },
+ "sow_term_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "sow_term_type": {
+ "enum": [
+ "deliverables",
+ "period",
+ "date"
+ ],
+ "type": "string"
+ },
+ "sow_term_unit": {
+ "enum": [
+ "month(s)",
+ "quarter(s)",
+ "year(s)"
+ ],
+ "type": "string"
+ },
+ "type": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "recipient_email": {
+ "format": "email",
+ "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-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_last_to_sign": {
+ "description": "When true, your signer signs after the recipient.",
+ "type": "boolean"
+ },
+ "sender_notice_email_address": {
+ "description": "Email address for legal notices to the sender.",
+ "format": "email",
+ "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-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": {
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "type": "string"
+ },
+ "general_cap_amount": {
+ "type": "number"
+ },
+ "general_cap_amount_type": {
+ "enum": [
+ "preceding",
+ "base",
+ "period"
+ ],
+ "type": "string"
+ },
+ "general_cap_period_currency": {
+ "type": "number"
+ },
+ "general_cap_period_qty": {
+ "type": "number"
+ },
+ "general_cap_preceding_amount": {
+ "type": "number"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_additional_warranties": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_by_customer": {
+ "type": "string"
+ },
+ "include_additional_warranties_by_provider": {
+ "type": "string"
+ },
+ "include_additional_warranties_include_by_customer": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_include_by_provider": {
+ "type": "boolean"
+ },
+ "include_ai_addendum": {
+ "type": "boolean"
+ },
+ "include_ai_addendum_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_covered_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_customer_claims": {
+ "type": "string"
+ },
+ "include_covered_claims_include_customer_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_include_provider_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_provider_claims": {
+ "type": "string"
+ },
+ "include_dpa": {
+ "type": "boolean"
+ },
+ "include_dpa_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_dpa_location": {
+ "type": "string"
+ },
+ "include_dpa_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_increased_cap_amount": {
+ "type": "boolean"
+ },
+ "include_increased_claims": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_confidentiality": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_confidentiality_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_other": {
+ "type": "boolean"
+ },
+ "include_increased_claims_indemnification_obligation": {
+ "type": "boolean"
+ },
+ "include_increased_claims_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_other": {
+ "type": "string"
+ },
+ "include_increased_claims_restrictions": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_confidentiality": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_confidentiality_negligence": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_include_other": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_indemnification_obligation": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_license_or_restrictions": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_negligence": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_other": {
+ "type": "string"
+ },
+ "increased_cap_amount_currency": {
+ "type": "number"
+ },
+ "increased_cap_amount_period_currency": {
+ "type": "number"
+ },
+ "increased_cap_amount_period_qty": {
+ "type": "number"
+ },
+ "increased_cap_amount_qty": {
+ "type": "number"
+ },
+ "increased_cap_amount_type": {
+ "enum": [
+ "qty",
+ "currency",
+ "period"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "software_license_order_form_attributes": {
+ "additionalProperties": false,
+ "description": "Override software license order form terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "additional_changes": {
+ "type": "string"
+ },
+ "deletion_procedure_include_custom": {
+ "type": "boolean"
+ },
+ "deletion_procedure_include_custom_description": {
+ "type": "string"
+ },
+ "deletion_procedure_include_customer_disable": {
+ "type": "boolean"
+ },
+ "deletion_procedure_include_customer_proof": {
+ "type": "boolean"
+ },
+ "deletion_procedure_include_provider_disable": {
+ "type": "boolean"
+ },
+ "fee_custom_unit": {
+ "type": "string"
+ },
+ "fee_period": {
+ "enum": [
+ "Subscription Period",
+ "month",
+ "year",
+ "Custom unit"
+ ],
+ "type": "string"
+ },
+ "fees_attributes": {
+ "additionalProperties": {
+ "anyOf": [
+ {
+ "additionalProperties": false,
+ "description": "Fees::Flat (fee_type \"flat\"). A fixed recurring fee, e.g. a platform subscription. Set type to \"Fees::Flat\" or fee_type to \"flat\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Fixed amount in the order form's fees_currency, charged per fee_period. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"flat\". Alternative to type.",
+ "enum": [
+ "flat"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Flat\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Flat"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Discount (fee_type \"discount\"). A discount, as a fixed amount or a percentage, applied forever, once, or for a number of months. Set type to \"Fees::Discount\" or fee_type to \"discount\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Discount size: an amount in fees_currency when discount_type is fixed_amount (a plain amount, not cents: 20 means 20.00), or a percentage (e.g. 10 for 10%) when it is percentage.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "discount_duration_amount": {
+ "description": "Number of months the discount applies. Required when discount_duration_type is multiple_months.",
+ "type": "number"
+ },
+ "discount_duration_type": {
+ "description": "How long the discount applies. multiple_months also needs discount_duration_amount.",
+ "enum": [
+ "forever",
+ "once",
+ "multiple_months"
+ ],
+ "type": "string"
+ },
+ "discount_type": {
+ "description": "Whether cost is a currency amount or a percentage.",
+ "enum": [
+ "fixed_amount",
+ "percentage"
+ ],
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"discount\". Alternative to type.",
+ "enum": [
+ "discount"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Discount\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Discount"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Cost (fee_type \"cost\"). A per-unit fee: price per unit times quantity, e.g. seats. Set type to \"Fees::Cost\" or fee_type to \"cost\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Price per unit in fees_currency. The row total is quantity x cost. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"cost\". Alternative to type.",
+ "enum": [
+ "cost"
+ ],
+ "type": "string"
+ },
+ "quantity": {
+ "description": "Number of units.",
+ "type": "number"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Cost\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Cost"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Attachment (fee_type \"attachment\"). A fee described in an uploaded attachment instead of in the table. Set type to \"Fees::Attachment\" or fee_type to \"attachment\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "attachment_id": {
+ "description": "ID of an attachment uploaded with upload-attachment.",
+ "type": "string"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"attachment\". Alternative to type.",
+ "enum": [
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Attachment\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Attachment"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Graduated (fee_type \"graduated\"). Tiered pricing, with the price set per tier in graduated_fee_tiers_attributes. Set type to \"Fees::Graduated\" or fee_type to \"graduated\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"graduated\". Alternative to type.",
+ "enum": [
+ "graduated"
+ ],
+ "type": "string"
+ },
+ "graduated_fee_tiers_attributes": {
+ "additionalProperties": {
+ "additionalProperties": false,
+ "properties": {
+ "flat_price": {
+ "type": "number"
+ },
+ "price_per_unit": {
+ "type": "string"
+ },
+ "upper_limit": {
+ "type": "number"
+ }
+ },
+ "type": "object"
+ },
+ "description": "Graduated fee tiers. Use string keys such as \"0\", \"1\".",
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Graduated\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Graduated"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Included (fee_type \"included\"). An item included at no charge. Set type to \"Fees::Included\" or fee_type to \"included\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"included\". Alternative to type.",
+ "enum": [
+ "included"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Included\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Included"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Metered (fee_type \"metered\"). Usage-based pricing, billed per unit used. Set type to \"Fees::Metered\" or fee_type to \"metered\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Price per unit of usage in fees_currency. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"metered\". Alternative to type.",
+ "enum": [
+ "metered"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Metered\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Metered"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::OneTime (fee_type \"one_time\"). A one-time charge, such as a setup fee. Set type to \"Fees::OneTime\" or fee_type to \"one_time\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "One-time amount in fees_currency, charged once rather than per fee_period. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"one_time\". Alternative to type.",
+ "enum": [
+ "one_time"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::OneTime\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::OneTime"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Text (fee_type \"text\"). A fee term described in free text. Set type to \"Fees::Text\" or fee_type to \"text\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"text\". Alternative to type.",
+ "enum": [
+ "text"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Text\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Text"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ }
+ ]
+ },
+ "description": "Fee line items. Use string keys such as \"0\", \"1\". Replaces template fees when provided.",
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+ },
+ "fees_currency": {
+ "enum": [
+ "USD",
+ "EUR",
+ "GBP",
+ "CAD",
+ "AUD",
+ "SGD",
+ "ILS",
+ "JPY",
+ "CHF",
+ "HKD"
+ ],
+ "type": "string"
+ },
+ "fees_include_fee_increase_upon_renewal": {
+ "type": "boolean"
+ },
+ "fees_include_fee_increase_upon_renewal_fee": {
+ "type": "number"
+ },
+ "fees_include_fee_increase_upon_renewal_type": {
+ "enum": [
+ "will",
+ "may"
+ ],
+ "type": "string"
+ },
+ "fees_inclusive_of_taxes": {
+ "type": "boolean"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_additional_changes": {
+ "type": "boolean"
+ },
+ "include_license_compliance_verification": {
+ "type": "boolean"
+ },
+ "include_license_compliance_verification_description": {
+ "type": "string"
+ },
+ "include_license_limits": {
+ "type": "boolean"
+ },
+ "include_license_limits_description": {
+ "type": "string"
+ },
+ "include_payment_process_include_billing_email": {
+ "type": "boolean"
+ },
+ "include_pilot_period": {
+ "type": "boolean"
+ },
+ "include_pilot_period_duration_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_pilot_period_duration_type": {
+ "enum": [
+ "day",
+ "week",
+ "month"
+ ],
+ "type": "string"
+ },
+ "include_pilot_period_include_fees": {
+ "type": "boolean"
+ },
+ "include_pilot_period_include_fees_amount": {
+ "type": "number"
+ },
+ "include_pilot_period_include_modifications": {
+ "type": "boolean"
+ },
+ "include_pilot_period_include_modifications_description": {
+ "type": "string"
+ },
+ "include_services": {
+ "type": "boolean"
+ },
+ "include_services_description": {
+ "type": "string"
+ },
+ "negotiations_allowed": {
+ "description": "When true, the recipient can propose changes to the order form, even when the agreement-level `negotiations_allowed` is false. This only covers the order form.",
+ "type": "boolean"
+ },
+ "order_date_date": {
+ "type": "string"
+ },
+ "order_date_type": {
+ "enum": [
+ "signature",
+ "date",
+ "other"
+ ],
+ "type": "string"
+ },
+ "payment_process_automatic_frequency": {
+ "enum": [
+ "monthly",
+ "quarterly",
+ "semiannually",
+ "annually"
+ ],
+ "type": "string"
+ },
+ "payment_process_type": {
+ "enum": [
+ "automatic",
+ "invoice",
+ "custom"
+ ],
+ "type": "string"
+ },
+ "payment_process_type_custom_val": {
+ "type": "string"
+ },
+ "payment_process_type_invoice_amount": {
+ "type": "number"
+ },
+ "payment_process_type_invoice_custom_unit": {
+ "type": "string"
+ },
+ "payment_process_type_invoice_duration": {
+ "enum": [
+ "day",
+ "week",
+ "month",
+ "year",
+ "day(s)",
+ "week(s)",
+ "month(s)",
+ "year(s)"
+ ],
+ "type": "string"
+ },
+ "payment_process_type_invoice_duration_start": {
+ "enum": [
+ "Customer's receipt of invoice",
+ "date of invoice"
+ ],
+ "type": "string"
+ },
+ "payment_process_type_invoice_type": {
+ "enum": [
+ "monthly",
+ "quarterly",
+ "semiannually",
+ "annually",
+ "Custom unit"
+ ],
+ "type": "string"
+ },
+ "permitted_uses_include_custom": {
+ "type": "boolean"
+ },
+ "permitted_uses_include_custom_description": {
+ "type": "string"
+ },
+ "permitted_uses_include_customers_affiliates": {
+ "type": "boolean"
+ },
+ "permitted_uses_include_internal_business": {
+ "type": "boolean"
+ },
+ "pilot_period_stripe_product_id": {
+ "type": "string"
+ },
+ "software_description": {
+ "type": "string"
+ },
+ "subscription_auto_renew": {
+ "enum": [
+ "days",
+ "subscription_end"
+ ],
+ "type": "string"
+ },
+ "subscription_period": {
+ "type": "number"
+ },
+ "subscription_period_unit": {
+ "type": "string"
+ },
+ "subscription_renewal_notice_days": {
+ "type": "number"
+ },
+ "warranty_period_description_amount": {
+ "type": "number"
+ },
+ "warranty_period_description_duration": {
+ "enum": [
+ "day",
+ "week",
+ "month",
+ "year"
+ ],
+ "type": "string"
+ },
+ "warranty_period_description_duration_start": {
+ "enum": [
+ "initial delivery of the Software",
+ "delivery of the Software and each subsequent Update",
+ "the Order Date"
+ ],
+ "type": "string"
+ },
+ "warranty_period_type": {
+ "enum": [
+ "description",
+ "none"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "test_agreement": {
+ "description": "When true, marks the agreement as a test. Test agreements do not count against your monthly limit.",
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "recipient_name",
+ "recipient_email"
+ ],
+ "type": "object"
+ },
+ "cc_users": {
+ "items": {
+ "format": "email",
+ "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-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": {
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "type": "string"
+ },
+ "framework_terms_type": {
+ "type": "string"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "parent_agreement_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "underlying_agreement_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "underlying_agreement_type": {
+ "type": "string"
+ },
+ "underlying_agreement_val": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "baa_attributes": {
+ "additionalProperties": false,
+ "description": "Override baa terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "aggregation_limitations_permitted": {
+ "type": "boolean"
+ },
+ "aggregation_limitations_permitted_val": {
+ "type": "string"
+ },
+ "breach_notification_unit": {
+ "enum": [
+ "hours",
+ "business days",
+ "calendar days"
+ ],
+ "type": "string"
+ },
+ "breach_notification_val": {
+ "type": "number"
+ },
+ "business_associate_relationship_type": {
+ "enum": [
+ "provider",
+ "company"
+ ],
+ "type": "string"
+ },
+ "deidentification_limitations_include_purpose": {
+ "type": "boolean"
+ },
+ "deidentification_limitations_include_requirements": {
+ "type": "boolean"
+ },
+ "deidentification_limitations_permitted": {
+ "type": "boolean"
+ },
+ "deidentification_limitations_purpose_val": {
+ "type": "string"
+ },
+ "deidentification_limitations_requirements_val": {
+ "type": "string"
+ },
+ "designated_record_set_provider_maintains": {
+ "type": "boolean"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_aggregation_limitations": {
+ "type": "boolean"
+ },
+ "include_deidentification_limitations": {
+ "type": "boolean"
+ },
+ "include_limitations": {
+ "type": "boolean"
+ },
+ "include_offshore_limitations": {
+ "type": "boolean"
+ },
+ "include_subcontract_limitations": {
+ "type": "boolean"
+ },
+ "offshore_limitations_permitted": {
+ "type": "boolean"
+ },
+ "offshore_limitations_permitted_val": {
+ "type": "string"
+ },
+ "subcontract_limitations_include_notice": {
+ "type": "boolean"
+ },
+ "subcontract_limitations_include_permission": {
+ "type": "boolean"
+ },
+ "subcontract_limitations_notice_val": {
+ "type": "string"
+ },
+ "subcontract_limitations_permission_val": {
+ "type": "string"
+ },
+ "subcontract_limitations_permitted": {
+ "type": "boolean"
+ },
+ "underlying_agreement_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "underlying_agreement_type": {
+ "enum": [
+ "internal",
+ "external",
+ "none"
+ ],
+ "type": "string"
+ },
+ "underlying_agreement_val": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "billing_email": {
+ "description": "Email of the billing contact. Used when include_billing_info is true.",
+ "format": "email",
+ "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "billing_name": {
+ "description": "Name of the billing contact. Used when include_billing_info is true.",
+ "type": "string"
+ },
+ "billing_workflow_type": {
+ "description": "The type of billing workflow. Use \"link\" to provide a payment_link_url, or \"stripe\" for Stripe-managed billing.",
+ "enum": [
+ "link",
+ "stripe"
+ ],
+ "type": "string"
+ },
+ "chosen_courts_country": {
+ "description": "The country in which disputes will be resolved.",
+ "type": "string"
+ },
+ "chosen_courts_region": {
+ "description": "The state or region in which disputes will be resolved.",
+ "type": "string"
+ },
+ "csa_attributes": {
+ "additionalProperties": false,
+ "description": "Override csa terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "customer_description": {
+ "type": "string"
+ },
+ "effective_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "effective_date_marketplace": {
+ "enum": [
+ "AWS",
+ "GCP",
+ "Azure"
+ ],
+ "type": "string"
+ },
+ "effective_date_type": {
+ "enum": [
+ "signature",
+ "date",
+ "marketplace_acceptance"
+ ],
+ "type": "string"
+ },
+ "general_cap_amount": {
+ "type": "number"
+ },
+ "general_cap_amount_type": {
+ "enum": [
+ "preceding",
+ "base",
+ "period"
+ ],
+ "type": "string"
+ },
+ "general_cap_period_currency": {
+ "type": "number"
+ },
+ "general_cap_period_qty": {
+ "type": "number"
+ },
+ "general_cap_preceding_amount": {
+ "type": "number"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_acceptable_use_policy": {
+ "type": "boolean"
+ },
+ "include_acceptable_use_policy_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_acceptable_use_policy_location": {
+ "type": "string"
+ },
+ "include_acceptable_use_policy_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_additional_warranties": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_by_customer": {
+ "type": "string"
+ },
+ "include_additional_warranties_by_provider": {
+ "type": "string"
+ },
+ "include_additional_warranties_include_by_customer": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_include_by_provider": {
+ "type": "boolean"
+ },
+ "include_ai_addendum": {
+ "type": "boolean"
+ },
+ "include_ai_addendum_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_covered_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_customer_claims": {
+ "type": "string"
+ },
+ "include_covered_claims_include_customer_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_include_provider_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_provider_claims": {
+ "type": "string"
+ },
+ "include_dpa": {
+ "type": "boolean"
+ },
+ "include_dpa_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_dpa_location": {
+ "type": "string"
+ },
+ "include_dpa_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_increased_cap_amount": {
+ "type": "boolean"
+ },
+ "include_increased_claims": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_confidentiality": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_confidentiality_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_privsec": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_privsec_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_other": {
+ "type": "boolean"
+ },
+ "include_increased_claims_indemnification_obligation": {
+ "type": "boolean"
+ },
+ "include_increased_claims_other": {
+ "type": "string"
+ },
+ "include_insurance_minimums": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_add_customer": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_add_customer_com_gen_liability": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_add_customer_cyber_liability": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_add_customer_errors_omissions": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_additional_information": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_additional_information_text": {
+ "type": "string"
+ },
+ "include_insurance_minimums_cyber_liability_aggregate": {
+ "type": "number"
+ },
+ "include_insurance_minimums_cyber_liability_minimum": {
+ "type": "number"
+ },
+ "include_insurance_minimums_employer_liability_aggregate": {
+ "type": "number"
+ },
+ "include_insurance_minimums_employer_liability_minimum": {
+ "type": "number"
+ },
+ "include_insurance_minimums_general_liability_aggregate": {
+ "type": "number"
+ },
+ "include_insurance_minimums_general_liability_minimum": {
+ "type": "number"
+ },
+ "include_insurance_minimums_include_cyber_liability": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_include_employer_liability": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_include_general_liability": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_include_workers_compensation": {
+ "type": "boolean"
+ },
+ "include_publicity_rights": {
+ "type": "boolean"
+ },
+ "include_publicity_rights_type": {
+ "enum": [
+ "public",
+ "non-public"
+ ],
+ "type": "string"
+ },
+ "include_security_policy": {
+ "type": "boolean"
+ },
+ "include_security_policy_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_security_policy_fedramp_auth": {
+ "type": "boolean"
+ },
+ "include_security_policy_hipaa": {
+ "type": "boolean"
+ },
+ "include_security_policy_hitrust": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_annual_maintenance": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_location": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_other": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_reasonable_efforts": {
+ "type": "boolean"
+ },
+ "include_security_policy_iso27001": {
+ "type": "boolean"
+ },
+ "include_security_policy_location": {
+ "type": "string"
+ },
+ "include_security_policy_other": {
+ "type": "string"
+ },
+ "include_security_policy_pci1": {
+ "type": "boolean"
+ },
+ "include_security_policy_pci2": {
+ "type": "boolean"
+ },
+ "include_security_policy_penetration_testing": {
+ "type": "boolean"
+ },
+ "include_security_policy_soc2": {
+ "type": "boolean"
+ },
+ "include_security_policy_soc2_type2": {
+ "type": "boolean"
+ },
+ "include_security_policy_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_supercap": {
+ "description": "CSA 3.0 renamed `include_increased_cap_amount` to `include_supercap`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_increased_cap_amount`. Sending the other spelling returns a 422.",
+ "type": "boolean"
+ },
+ "include_uncapped_claims": {
+ "description": "CSA 3.0 renamed `include_unlimited_claims` to `include_uncapped_claims`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims`. Sending the other spelling returns a 422.",
+ "type": "boolean"
+ },
+ "include_uncapped_claims_breach_of_confidentiality": {
+ "description": "CSA 3.0 renamed `include_unlimited_claims_breach_of_confidentiality` to `include_uncapped_claims_breach_of_confidentiality`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_breach_of_confidentiality`. Sending the other spelling returns a 422.",
+ "type": "boolean"
+ },
+ "include_uncapped_claims_breach_of_confidentiality_negligence": {
+ "description": "CSA 3.0 renamed `include_unlimited_claims_breach_of_confidentiality_negligence` to `include_uncapped_claims_breach_of_confidentiality_negligence`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_breach_of_confidentiality_negligence`. Sending the other spelling returns a 422.",
+ "type": "boolean"
+ },
+ "include_uncapped_claims_breach_of_privsec": {
+ "description": "CSA 3.0 renamed `include_unlimited_claims_breach_of_privsec` to `include_uncapped_claims_breach_of_privsec`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_breach_of_privsec`. Sending the other spelling returns a 422.",
+ "type": "boolean"
+ },
+ "include_uncapped_claims_breach_of_privsec_negligence": {
+ "description": "CSA 3.0 renamed `include_unlimited_claims_breach_of_privsec_negligence` to `include_uncapped_claims_breach_of_privsec_negligence`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_breach_of_privsec_negligence`. Sending the other spelling returns a 422.",
+ "type": "boolean"
+ },
+ "include_uncapped_claims_include_other": {
+ "description": "CSA 3.0 renamed `include_unlimited_claims_include_other` to `include_uncapped_claims_include_other`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_include_other`. Sending the other spelling returns a 422.",
+ "type": "boolean"
+ },
+ "include_uncapped_claims_indemnification_obligation": {
+ "description": "CSA 3.0 renamed `include_unlimited_claims_indemnification_obligation` to `include_uncapped_claims_indemnification_obligation`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_indemnification_obligation`. Sending the other spelling returns a 422.",
+ "type": "boolean"
+ },
+ "include_uncapped_claims_other": {
+ "description": "CSA 3.0 renamed `include_unlimited_claims_other` to `include_uncapped_claims_other`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_other`. Sending the other spelling returns a 422.",
+ "type": "boolean"
+ },
+ "include_unlimited_claims": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_confidentiality": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_confidentiality_negligence": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_privsec": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_privsec_negligence": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_include_other": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_indemnification_obligation": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_other": {
+ "type": "string"
+ },
+ "increased_cap_amount_currency": {
+ "type": "number"
+ },
+ "increased_cap_amount_period_currency": {
+ "type": "number"
+ },
+ "increased_cap_amount_period_qty": {
+ "type": "number"
+ },
+ "increased_cap_amount_qty": {
+ "type": "number"
+ },
+ "increased_cap_amount_type": {
+ "enum": [
+ "qty",
+ "currency",
+ "period"
+ ],
+ "type": "string"
+ },
+ "provider": {
+ "type": "string"
+ },
+ "supercap_currency": {
+ "description": "CSA 3.0 renamed `increased_cap_amount_currency` to `supercap_currency`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `increased_cap_amount_currency`. Sending the other spelling returns a 422.",
+ "type": "number"
+ },
+ "supercap_period_currency": {
+ "description": "CSA 3.0 renamed `increased_cap_amount_period_currency` to `supercap_period_currency`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `increased_cap_amount_period_currency`. Sending the other spelling returns a 422.",
+ "type": "number"
+ },
+ "supercap_period_qty": {
+ "description": "CSA 3.0 renamed `increased_cap_amount_period_qty` to `supercap_period_qty`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `increased_cap_amount_period_qty`. Sending the other spelling returns a 422.",
+ "type": "number"
+ },
+ "supercap_qty": {
+ "description": "CSA 3.0 renamed `increased_cap_amount_qty` to `supercap_qty`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `increased_cap_amount_qty`. Sending the other spelling returns a 422.",
+ "type": "number"
+ },
+ "supercap_type": {
+ "description": "CSA 3.0 renamed `increased_cap_amount_type` to `supercap_type`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `increased_cap_amount_type`. Sending the other spelling returns a 422.",
+ "type": "number"
+ }
+ },
+ "type": "object"
+ },
+ "csa_order_form_attributes": {
+ "additionalProperties": false,
+ "description": "Override csa order form terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "additional_changes": {
+ "type": "string"
+ },
+ "additional_parameters_or_limitations": {
+ "type": "string"
+ },
+ "affiliates_as_users": {
+ "type": "boolean"
+ },
+ "cloud_service_description": {
+ "type": "string"
+ },
+ "consumption_units": {
+ "type": "string"
+ },
+ "fee_amount": {
+ "type": "number"
+ },
+ "fee_custom_unit": {
+ "type": "string"
+ },
+ "fee_period": {
+ "enum": [
+ "Subscription Period",
+ "month",
+ "year",
+ "User",
+ "Custom unit"
+ ],
+ "type": "string"
+ },
+ "fees_attributes": {
+ "additionalProperties": {
+ "anyOf": [
+ {
+ "additionalProperties": false,
+ "description": "Fees::Flat (fee_type \"flat\"). A fixed recurring fee, e.g. a platform subscription. Set type to \"Fees::Flat\" or fee_type to \"flat\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Fixed amount in the order form's fees_currency, charged per fee_period. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"flat\". Alternative to type.",
+ "enum": [
+ "flat"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Flat\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Flat"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Discount (fee_type \"discount\"). A discount, as a fixed amount or a percentage, applied forever, once, or for a number of months. Set type to \"Fees::Discount\" or fee_type to \"discount\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Discount size: an amount in fees_currency when discount_type is fixed_amount (a plain amount, not cents: 20 means 20.00), or a percentage (e.g. 10 for 10%) when it is percentage.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "discount_duration_amount": {
+ "description": "Number of months the discount applies. Required when discount_duration_type is multiple_months.",
+ "type": "number"
+ },
+ "discount_duration_type": {
+ "description": "How long the discount applies. multiple_months also needs discount_duration_amount.",
+ "enum": [
+ "forever",
+ "once",
+ "multiple_months"
+ ],
+ "type": "string"
+ },
+ "discount_type": {
+ "description": "Whether cost is a currency amount or a percentage.",
+ "enum": [
+ "fixed_amount",
+ "percentage"
+ ],
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"discount\". Alternative to type.",
+ "enum": [
+ "discount"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Discount\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Discount"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Cost (fee_type \"cost\"). A per-unit fee: price per unit times quantity, e.g. seats. Set type to \"Fees::Cost\" or fee_type to \"cost\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Price per unit in fees_currency. The row total is quantity x cost. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"cost\". Alternative to type.",
+ "enum": [
+ "cost"
+ ],
+ "type": "string"
+ },
+ "quantity": {
+ "description": "Number of units.",
+ "type": "number"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Cost\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Cost"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Attachment (fee_type \"attachment\"). A fee described in an uploaded attachment instead of in the table. Set type to \"Fees::Attachment\" or fee_type to \"attachment\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "attachment_id": {
+ "description": "ID of an attachment uploaded with upload-attachment.",
+ "type": "string"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"attachment\". Alternative to type.",
+ "enum": [
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Attachment\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Attachment"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Graduated (fee_type \"graduated\"). Tiered pricing, with the price set per tier in graduated_fee_tiers_attributes. Set type to \"Fees::Graduated\" or fee_type to \"graduated\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"graduated\". Alternative to type.",
+ "enum": [
+ "graduated"
+ ],
+ "type": "string"
+ },
+ "graduated_fee_tiers_attributes": {
+ "additionalProperties": {
+ "additionalProperties": false,
+ "properties": {
+ "flat_price": {
+ "type": "number"
+ },
+ "price_per_unit": {
+ "type": "string"
+ },
+ "upper_limit": {
+ "type": "number"
+ }
+ },
+ "type": "object"
+ },
+ "description": "Graduated fee tiers. Use string keys such as \"0\", \"1\".",
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Graduated\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Graduated"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Included (fee_type \"included\"). An item included at no charge. Set type to \"Fees::Included\" or fee_type to \"included\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"included\". Alternative to type.",
+ "enum": [
+ "included"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Included\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Included"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Metered (fee_type \"metered\"). Usage-based pricing, billed per unit used. Set type to \"Fees::Metered\" or fee_type to \"metered\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Price per unit of usage in fees_currency. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"metered\". Alternative to type.",
+ "enum": [
+ "metered"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Metered\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Metered"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::OneTime (fee_type \"one_time\"). A one-time charge, such as a setup fee. Set type to \"Fees::OneTime\" or fee_type to \"one_time\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "One-time amount in fees_currency, charged once rather than per fee_period. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"one_time\". Alternative to type.",
+ "enum": [
+ "one_time"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::OneTime\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::OneTime"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Text (fee_type \"text\"). A fee term described in free text. Set type to \"Fees::Text\" or fee_type to \"text\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"text\". Alternative to type.",
+ "enum": [
+ "text"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Text\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Text"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ }
+ ]
+ },
+ "description": "Fee table rows, keyed by string index (\"0\", \"1\", ...). Replaces the template's fees when provided. Each row sets type or fee_type to pick the fee class. Amounts are in the order form's fees_currency and, for recurring fees, are charged per fee_period.",
+ "examples": [
+ {
+ "0": {
+ "cost": 2000,
+ "description": "Platform subscription",
+ "type": "Fees::Flat"
+ }
+ },
+ {
+ "0": {
+ "cost": 50,
+ "description": "Seats",
+ "fee_type": "cost",
+ "quantity": 10
+ },
+ "1": {
+ "cost": 10,
+ "description": "Launch discount",
+ "discount_duration_amount": 3,
+ "discount_duration_type": "multiple_months",
+ "discount_type": "percentage",
+ "fee_type": "discount"
+ }
+ }
+ ],
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+ },
+ "fees_currency": {
+ "enum": [
+ "USD",
+ "EUR",
+ "GBP",
+ "CAD",
+ "AUD",
+ "SGD",
+ "ILS",
+ "JPY",
+ "CHF",
+ "HKD"
+ ],
+ "type": "string"
+ },
+ "fees_include_fee_increase_upon_renewal": {
+ "type": "boolean"
+ },
+ "fees_include_fee_increase_upon_renewal_fee": {
+ "type": "number"
+ },
+ "fees_include_fee_increase_upon_renewal_type": {
+ "enum": [
+ "will",
+ "may"
+ ],
+ "type": "string"
+ },
+ "fees_inclusive_of_taxes": {
+ "type": "boolean"
+ },
+ "framework_terms_type": {
+ "enum": [
+ "new",
+ "existing",
+ "description"
+ ],
+ "type": "string"
+ },
+ "free_trial_days": {
+ "type": "number"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_additional_changes": {
+ "type": "boolean"
+ },
+ "include_additional_parameters_or_limitations": {
+ "type": "boolean"
+ },
+ "include_consumption": {
+ "type": "boolean"
+ },
+ "include_fees": {
+ "type": "boolean"
+ },
+ "include_fees_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_fees_include_attachment": {
+ "type": "boolean"
+ },
+ "include_fees_other": {
+ "type": "boolean"
+ },
+ "include_fees_other_val": {
+ "type": "string"
+ },
+ "include_fees_table": {
+ "type": "boolean"
+ },
+ "include_fees_table_period": {
+ "enum": [
+ "Subscription Period",
+ "month",
+ "year",
+ "User"
+ ],
+ "type": "string"
+ },
+ "include_free_trial": {
+ "type": "boolean"
+ },
+ "include_max_users": {
+ "type": "boolean"
+ },
+ "include_pilot_period": {
+ "type": "boolean"
+ },
+ "include_pilot_period_duration_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_pilot_period_duration_type": {
+ "enum": [
+ "day",
+ "week",
+ "month"
+ ],
+ "type": "string"
+ },
+ "include_pilot_period_include_fees": {
+ "type": "boolean"
+ },
+ "include_pilot_period_include_fees_amount": {
+ "type": "number"
+ },
+ "include_pilot_period_include_modifications": {
+ "type": "boolean"
+ },
+ "include_pilot_period_include_modifications_description": {
+ "type": "string"
+ },
+ "include_product_support": {
+ "type": "boolean"
+ },
+ "include_product_support_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_product_support_description": {
+ "type": "string"
+ },
+ "include_product_support_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_professional_services": {
+ "type": "boolean"
+ },
+ "include_professional_services_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_professional_services_custom_name": {
+ "type": "string"
+ },
+ "include_professional_services_description": {
+ "type": "string"
+ },
+ "include_professional_services_end_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "include_professional_services_fees_description": {
+ "type": "string"
+ },
+ "include_professional_services_include_end_date": {
+ "type": "boolean"
+ },
+ "include_professional_services_include_fees_description": {
+ "type": "boolean"
+ },
+ "include_professional_services_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_sla": {
+ "type": "boolean"
+ },
+ "include_sla_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_sla_description": {
+ "type": "string"
+ },
+ "include_sla_include_response_time": {
+ "type": "boolean"
+ },
+ "include_sla_include_response_time_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_sla_include_response_time_credit": {
+ "type": "number"
+ },
+ "include_sla_include_response_time_duration": {
+ "enum": [
+ "hour",
+ "day",
+ "week",
+ "month",
+ "hours"
+ ],
+ "type": "string"
+ },
+ "include_sla_include_response_time_support_channel": {
+ "type": "string"
+ },
+ "include_sla_include_target_uptime": {
+ "type": "boolean"
+ },
+ "include_sla_maintenance_notice": {
+ "type": "boolean"
+ },
+ "include_sla_maintenance_window": {
+ "type": "boolean"
+ },
+ "include_sla_maintenance_window_type": {
+ "enum": [
+ "standard",
+ "none"
+ ],
+ "type": "string"
+ },
+ "include_sla_standard_maintenance_notice_qty": {
+ "type": "number"
+ },
+ "include_sla_standard_maintenance_notice_unit": {
+ "enum": [
+ "hour",
+ "day",
+ "week",
+ "month"
+ ],
+ "type": "string"
+ },
+ "include_sla_standard_maintenance_window_end_time": {
+ "type": "string"
+ },
+ "include_sla_standard_maintenance_window_friday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_monday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_saturday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_start_time": {
+ "type": "string"
+ },
+ "include_sla_standard_maintenance_window_sunday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_thursday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_time_zone": {
+ "type": "string"
+ },
+ "include_sla_standard_maintenance_window_tuesday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_wednesday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_target_uptime": {
+ "type": "number"
+ },
+ "include_sla_type": {
+ "enum": [
+ "description",
+ "standard",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_subscription_start_date": {
+ "type": "boolean"
+ },
+ "include_subscription_start_date_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "include_usage_review": {
+ "type": "boolean"
+ },
+ "include_usage_review_val": {
+ "type": "string"
+ },
+ "include_use_limitations": {
+ "type": "boolean"
+ },
+ "include_use_limitations_val": {
+ "type": "string"
+ },
+ "invoice_period": {
+ "enum": [
+ "monthly",
+ "quarterly",
+ "semiannually",
+ "annually",
+ "Custom unit",
+ "Monthly",
+ "Quarterly",
+ "Semiannually",
+ "Annually"
+ ],
+ "type": "string"
+ },
+ "invoice_period_custom_unit": {
+ "type": "string"
+ },
+ "max_consumption": {
+ "type": "number"
+ },
+ "max_users": {
+ "type": "number"
+ },
+ "negotiations_allowed": {
+ "description": "When true, the recipient can propose changes to the order form, even when the agreement-level `negotiations_allowed` is false. This only covers the order form.",
+ "type": "boolean"
+ },
+ "order_date_date": {
+ "type": "string"
+ },
+ "order_date_other": {
+ "type": "string"
+ },
+ "order_date_type": {
+ "enum": [
+ "signature",
+ "date",
+ "other"
+ ],
+ "type": "string"
+ },
+ "payment_period": {
+ "type": "number"
+ },
+ "payment_period_timeframe": {
+ "enum": [
+ "Customer's receipt of invoice",
+ "date of invoice"
+ ],
+ "type": "string"
+ },
+ "payment_period_unit": {
+ "enum": [
+ "day(s)",
+ "week(s)",
+ "month(s)",
+ "marketplace_acceptance"
+ ],
+ "type": "string"
+ },
+ "payment_process_automatic_frequency": {
+ "enum": [
+ "monthly",
+ "quarterly",
+ "semiannually",
+ "annually"
+ ],
+ "type": "string"
+ },
+ "payment_process_type": {
+ "enum": [
+ "automatic",
+ "invoice",
+ "custom",
+ "marketplace_acceptance"
+ ],
+ "type": "string"
+ },
+ "payment_process_type_custom_val": {
+ "type": "string"
+ },
+ "payment_process_type_invoice_amount": {
+ "type": "number"
+ },
+ "payment_process_type_invoice_custom_unit": {
+ "type": "string"
+ },
+ "payment_process_type_invoice_duration": {
+ "enum": [
+ "day",
+ "week",
+ "month",
+ "year",
+ "day(s)",
+ "week(s)",
+ "month(s)",
+ "year(s)"
+ ],
+ "type": "string"
+ },
+ "payment_process_type_invoice_duration_start": {
+ "enum": [
+ "Customer's receipt of invoice",
+ "date of invoice"
+ ],
+ "type": "string"
+ },
+ "payment_process_type_invoice_type": {
+ "enum": [
+ "monthly",
+ "quarterly",
+ "semiannually",
+ "annually",
+ "Custom unit"
+ ],
+ "type": "string"
+ },
+ "pilot_period_stripe_product_id": {
+ "type": "string"
+ },
+ "service_credits_attributes": {
+ "additionalProperties": {
+ "additionalProperties": false,
+ "properties": {
+ "credit": {
+ "type": "number"
+ },
+ "max": {
+ "type": "number"
+ },
+ "min": {
+ "type": "number"
+ }
+ },
+ "type": "object"
+ },
+ "description": "Service credits. Use string keys such as \"0\", \"1\".",
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+ },
+ "subscription_auto_renew": {
+ "enum": [
+ "days",
+ "subscription_end"
+ ],
+ "type": "string"
+ },
+ "subscription_period": {
+ "type": "number"
+ },
+ "subscription_period_unit": {
+ "type": "string"
+ },
+ "subscription_renewal_notice_days": {
+ "type": "number"
+ },
+ "subscription_start_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "subscription_start_date_type": {
+ "enum": [
+ "effective_date",
+ "date"
+ ],
+ "type": "string"
+ },
+ "underlying_agreement_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "use_limitations_attributes": {
+ "additionalProperties": {
+ "additionalProperties": false,
+ "properties": {
+ "amount": {
+ "type": "number"
+ },
+ "limitation_type": {
+ "type": "string"
+ },
+ "unit": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "description": "Use limitations. Use string keys such as \"0\", \"1\".",
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+ }
+ },
+ "type": "object"
+ },
+ "custom_field_values": {
+ "description": "Values for a custom template's fields, keyed by the field keys defined in the template's YAML definition. Only used when template_id is a custom template. Template defaults fill any fields you omit; a required field with no default and no submitted value returns a 400 naming the field. Values are validated against the field's input type: select and radio values must be one of the field's options, multiselect values are an array of selections each of which must be one of the field's options, number and currency values must be numeric, date values must be YYYY-MM-DD, and email values must be valid addresses. An invalid value returns a 400 naming the field."
+ },
+ "design_partner_attributes": {
+ "additionalProperties": false,
+ "description": "Override design partner terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "customer_description": {
+ "type": "string"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_fees": {
+ "type": "boolean"
+ },
+ "include_fees_amount": {
+ "type": "number"
+ },
+ "include_fees_description": {
+ "type": "string"
+ },
+ "include_fees_pay_by_amount": {
+ "type": "string"
+ },
+ "include_fees_type": {
+ "enum": [
+ "default_language",
+ "description"
+ ],
+ "type": "string"
+ },
+ "include_fees_unit": {
+ "enum": [
+ "month",
+ "quarter",
+ "year",
+ "Term"
+ ],
+ "type": "string"
+ },
+ "include_program_appear_as_customer_private": {
+ "type": "boolean"
+ },
+ "include_program_appear_as_customer_public": {
+ "type": "boolean"
+ },
+ "include_program_case_study": {
+ "type": "boolean"
+ },
+ "include_program_develop_functionality": {
+ "type": "boolean"
+ },
+ "include_program_develop_functionality_val": {
+ "type": "string"
+ },
+ "include_program_discount": {
+ "type": "boolean"
+ },
+ "include_program_discount_amount": {
+ "type": "number"
+ },
+ "include_program_discount_unit": {
+ "enum": [
+ "U.S. Dollars",
+ "percent"
+ ],
+ "type": "string"
+ },
+ "include_program_participation_feedback": {
+ "type": "boolean"
+ },
+ "include_program_participation_feedback_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_program_participation_feedback_unit": {
+ "enum": [
+ "month",
+ "quarter",
+ "year",
+ "Term"
+ ],
+ "type": "string"
+ },
+ "include_program_partner_other": {
+ "type": "boolean"
+ },
+ "include_program_partner_other_val": {
+ "type": "string"
+ },
+ "include_program_provider_other": {
+ "type": "boolean"
+ },
+ "include_program_provider_other_val": {
+ "type": "string"
+ },
+ "include_program_reference": {
+ "type": "boolean"
+ },
+ "product_description": {
+ "type": "string"
+ },
+ "term_amount": {
+ "type": "number"
+ },
+ "term_unit": {
+ "enum": [
+ "day(s)",
+ "week(s)",
+ "month(s)",
+ "quarter(s)",
+ "year(s)"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "district_or_county": {
+ "description": "The district or county for dispute resolution.",
+ "type": "string"
+ },
+ "dpa_attributes": {
+ "additionalProperties": false,
+ "description": "Override dpa terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "approved_subprocessor_type": {
+ "description": "`internal` lists approved subprocessors in the agreement (`subprocessors_attributes`); `external` points to a list published elsewhere.",
+ "enum": [
+ "internal",
+ "external"
+ ],
+ "type": "string"
+ },
+ "cloud_service_product_name": {
+ "type": "string"
+ },
+ "competent_supervisory_authority": {
+ "type": "string"
+ },
+ "customer_description": {
+ "type": "string"
+ },
+ "data_exporter_address_city": {
+ "type": "string"
+ },
+ "data_exporter_address_country": {
+ "type": "string"
+ },
+ "data_exporter_address_state": {
+ "type": "string"
+ },
+ "data_exporter_address_street_address": {
+ "type": "string"
+ },
+ "data_exporter_address_zipcode": {
+ "type": "string"
+ },
+ "data_exporter_contact_details": {
+ "type": "string"
+ },
+ "data_exporter_contact_name": {
+ "type": "string"
+ },
+ "data_exporter_contact_position": {
+ "type": "string"
+ },
+ "data_exporter_role": {
+ "description": "Role of the data exporter. Overwritten to `Controller` when the agreement is created from a template.",
+ "enum": [
+ "Controller",
+ "Processor"
+ ],
+ "type": "string"
+ },
+ "data_importer_address": {
+ "type": "string"
+ },
+ "data_importer_address_city": {
+ "type": "string"
+ },
+ "data_importer_address_country": {
+ "type": "string"
+ },
+ "data_importer_address_state": {
+ "type": "string"
+ },
+ "data_importer_address_street_address": {
+ "type": "string"
+ },
+ "data_importer_address_zipcode": {
+ "type": "string"
+ },
+ "data_importer_contact_details": {
+ "type": "string"
+ },
+ "data_importer_contact_name": {
+ "type": "string"
+ },
+ "data_importer_contact_position": {
+ "type": "string"
+ },
+ "duration_of_processing": {
+ "type": "string"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_covered_claim": {
+ "type": "boolean"
+ },
+ "include_covered_claim_external_val": {
+ "type": "string"
+ },
+ "include_covered_claim_internal_val": {
+ "type": "string"
+ },
+ "include_covered_claim_type": {
+ "description": "Which covered-claim text applies: `internal` uses `include_covered_claim_internal_val`, `external` uses `include_covered_claim_external_val`. Required when `include_covered_claim` is true.",
+ "enum": [
+ "internal",
+ "external"
+ ],
+ "type": "string"
+ },
+ "include_data_subjects_custom": {
+ "type": "boolean"
+ },
+ "include_data_subjects_custom_val": {
+ "type": "string"
+ },
+ "include_data_subjects_employees": {
+ "type": "boolean"
+ },
+ "include_data_subjects_end_users": {
+ "type": "boolean"
+ },
+ "include_external_subprocessor_location": {
+ "type": "string"
+ },
+ "include_frequency_of_transfer_continuous": {
+ "type": "boolean"
+ },
+ "include_frequency_of_transfer_custom": {
+ "type": "boolean"
+ },
+ "include_frequency_of_transfer_custom_val": {
+ "type": "string"
+ },
+ "include_governing_country_eu": {
+ "type": "boolean"
+ },
+ "include_governing_country_eu_val": {
+ "type": "string"
+ },
+ "include_governing_country_uk": {
+ "type": "boolean"
+ },
+ "include_governing_country_uk_val": {
+ "type": "string"
+ },
+ "include_governing_law": {
+ "type": "boolean"
+ },
+ "include_governing_law_country": {
+ "type": "string"
+ },
+ "include_governing_law_state": {
+ "type": "string"
+ },
+ "include_increased_claim_amount": {
+ "description": "Legacy field. Stored but not shown on the DPA; use the `include_liability_cap*` fields instead.",
+ "type": "boolean"
+ },
+ "include_increased_claim_amount_currency": {
+ "description": "Legacy field. Stored but not shown on the DPA; use the `include_liability_cap*` fields instead."
+ },
+ "include_increased_claim_amount_qty": {
+ "description": "Legacy field. Stored but not shown on the DPA; use the `include_liability_cap*` fields instead."
+ },
+ "include_increased_claim_amount_type": {
+ "description": "Legacy field. Stored but not shown on the DPA; use the `include_liability_cap*` fields instead.",
+ "type": "string"
+ },
+ "include_liability_cap": {
+ "type": "boolean"
+ },
+ "include_liability_cap_amount_constant_external": {
+ "type": "string"
+ },
+ "include_liability_cap_amount_constant_internal": {
+ "type": "string"
+ },
+ "include_liability_cap_amount_currency_external": {
+ "description": "Currency amount. Numbers and numeric strings (commas allowed) are both accepted."
+ },
+ "include_liability_cap_amount_currency_internal": {
+ "description": "Currency amount. Numbers and numeric strings (commas allowed) are both accepted."
+ },
+ "include_liability_cap_csa_type": {
+ "description": "Which liability cap values apply: the `_internal` or `_external` amount fields. Required when `include_liability_cap` is true.",
+ "enum": [
+ "internal",
+ "external"
+ ],
+ "type": "string"
+ },
+ "include_personal_data_biographic_info": {
+ "type": "boolean"
+ },
+ "include_personal_data_contact_info": {
+ "type": "boolean"
+ },
+ "include_personal_data_custom": {
+ "type": "boolean"
+ },
+ "include_personal_data_custom_val": {
+ "type": "string"
+ },
+ "include_personal_data_employment_info": {
+ "type": "boolean"
+ },
+ "include_personal_data_financial_info": {
+ "type": "boolean"
+ },
+ "include_personal_data_location": {
+ "type": "boolean"
+ },
+ "include_personal_data_name": {
+ "type": "boolean"
+ },
+ "include_personal_data_transactional_info": {
+ "type": "boolean"
+ },
+ "include_personal_data_user_activity_info": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_custom": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_custom_val": {
+ "type": "string"
+ },
+ "include_processing_purpose_erasing": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_holding": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_protecting": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_receiving": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_returning": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_sharing": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_updating": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_using": {
+ "type": "boolean"
+ },
+ "include_provider_security_contact_address": {
+ "type": "boolean"
+ },
+ "include_provider_security_contact_address_city": {
+ "type": "string"
+ },
+ "include_provider_security_contact_address_country": {
+ "type": "string"
+ },
+ "include_provider_security_contact_address_state": {
+ "type": "string"
+ },
+ "include_provider_security_contact_address_street_address": {
+ "type": "string"
+ },
+ "include_provider_security_contact_address_zipcode": {
+ "type": "string"
+ },
+ "include_provider_security_contact_email": {
+ "type": "boolean"
+ },
+ "include_provider_security_contact_email_val": {
+ "format": "email",
+ "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "include_security_measures_accountability": {
+ "type": "boolean"
+ },
+ "include_security_measures_accountability_val": {
+ "type": "string"
+ },
+ "include_security_measures_certification_or_assurance": {
+ "type": "boolean"
+ },
+ "include_security_measures_certification_or_assurance_val": {
+ "type": "string"
+ },
+ "include_security_measures_confidentiality_integrity": {
+ "type": "boolean"
+ },
+ "include_security_measures_confidentiality_integrity_val": {
+ "type": "string"
+ },
+ "include_security_measures_data_at_rest": {
+ "type": "boolean"
+ },
+ "include_security_measures_data_at_rest_val": {
+ "type": "string"
+ },
+ "include_security_measures_data_minimization": {
+ "type": "boolean"
+ },
+ "include_security_measures_data_minimization_val": {
+ "type": "string"
+ },
+ "include_security_measures_data_quality": {
+ "type": "boolean"
+ },
+ "include_security_measures_data_quality_val": {
+ "type": "string"
+ },
+ "include_security_measures_data_retention": {
+ "type": "boolean"
+ },
+ "include_security_measures_data_retention_val": {
+ "type": "string"
+ },
+ "include_security_measures_data_transmission": {
+ "type": "boolean"
+ },
+ "include_security_measures_data_transmission_val": {
+ "type": "string"
+ },
+ "include_security_measures_event_logging": {
+ "type": "boolean"
+ },
+ "include_security_measures_event_logging_val": {
+ "type": "string"
+ },
+ "include_security_measures_identity_auth": {
+ "type": "boolean"
+ },
+ "include_security_measures_identity_auth_val": {
+ "type": "string"
+ },
+ "include_security_measures_it_security_governance": {
+ "type": "boolean"
+ },
+ "include_security_measures_it_security_governance_val": {
+ "type": "string"
+ },
+ "include_security_measures_physical_security": {
+ "type": "boolean"
+ },
+ "include_security_measures_physical_security_val": {
+ "type": "string"
+ },
+ "include_security_measures_portability_and_erasure": {
+ "type": "boolean"
+ },
+ "include_security_measures_portability_and_erasure_val": {
+ "type": "string"
+ },
+ "include_security_measures_pseudonym_encryption": {
+ "type": "boolean"
+ },
+ "include_security_measures_pseudonym_encryption_val": {
+ "type": "string"
+ },
+ "include_security_measures_restore_data_access": {
+ "type": "boolean"
+ },
+ "include_security_measures_restore_data_access_val": {
+ "type": "string"
+ },
+ "include_security_measures_security_policy": {
+ "type": "boolean"
+ },
+ "include_security_measures_system_configuration": {
+ "type": "boolean"
+ },
+ "include_security_measures_system_configuration_val": {
+ "type": "string"
+ },
+ "include_security_measures_testing_assessment": {
+ "type": "boolean"
+ },
+ "include_security_measures_testing_assessment_val": {
+ "type": "string"
+ },
+ "include_security_policy": {
+ "type": "boolean"
+ },
+ "include_security_policy_fedramp_auth": {
+ "type": "boolean"
+ },
+ "include_security_policy_hipaa": {
+ "type": "boolean"
+ },
+ "include_security_policy_hitrust": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_other": {
+ "type": "boolean"
+ },
+ "include_security_policy_iso27001": {
+ "type": "boolean"
+ },
+ "include_security_policy_other": {
+ "type": "string"
+ },
+ "include_security_policy_pci1": {
+ "type": "boolean"
+ },
+ "include_security_policy_pci2": {
+ "type": "boolean"
+ },
+ "include_security_policy_penetration_testing": {
+ "type": "boolean"
+ },
+ "include_security_policy_soc2": {
+ "type": "boolean"
+ },
+ "include_security_policy_soc2_type2": {
+ "type": "boolean"
+ },
+ "include_sensitive_data_restrictions_custom": {
+ "type": "boolean"
+ },
+ "include_sensitive_data_restrictions_custom_val": {
+ "type": "string"
+ },
+ "include_sensitive_data_restrictions_security_policy": {
+ "type": "boolean"
+ },
+ "include_service_provider_relationship": {
+ "type": "boolean"
+ },
+ "include_special_category_data": {
+ "type": "boolean"
+ },
+ "provider": {
+ "type": "string"
+ },
+ "security_policy_available_at": {
+ "type": "string"
+ },
+ "security_policy_type": {
+ "description": "Where the Security Policy is defined. For `external`, set `security_policy_available_at`.",
+ "enum": [
+ "defined in agreement",
+ "provider service",
+ "external"
+ ],
+ "type": "string"
+ },
+ "subprocessors_attributes": {
+ "additionalProperties": {
+ "additionalProperties": false,
+ "properties": {
+ "_destroy": {
+ "description": "Set to true with `id` to remove that subprocessor.",
+ "type": "boolean"
+ },
+ "country": {
+ "type": "string"
+ },
+ "id": {
+ "description": "ID of an existing subprocessor to update or remove. Omit to add a new subprocessor.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "processing_task": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "description": "Subprocessors, keyed by string index such as \"0\", \"1\". On create these are added to the template's subprocessors. On a draft update, an entry without `id` adds a new subprocessor; pass `id` to change one and `id` with `_destroy: true` to remove one.",
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+ },
+ "underlying_agreement_id": {
+ "description": "ID of the CSA this DPA supplements when `underlying_agreement_type` is `internal`.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "underlying_agreement_type": {
+ "description": "`internal` links a CSA in Common Paper (`underlying_agreement_id`); `external` describes another agreement in `underlying_agreement_val` (required). Omit for none.",
+ "enum": [
+ "internal",
+ "external"
+ ],
+ "type": "string"
+ },
+ "underlying_agreement_val": {
+ "description": "Description of the agreement this DPA supplements. Required when `underlying_agreement_type` is `external`.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "framework_terms_description": {
+ "description": "Custom framework terms description. Only used when framework_terms_type is \"description\".",
+ "type": "string"
+ },
+ "framework_terms_type": {
+ "description": "How framework terms are specified. Use \"new\" for standard terms or \"description\" to provide a custom framework_terms_description.",
+ "enum": [
+ "new",
+ "description"
+ ],
+ "type": "string"
+ },
+ "governing_law_country": {
+ "description": "The country whose laws govern the agreement.",
+ "type": "string"
+ },
+ "governing_law_region": {
+ "description": "The state or region whose laws govern the agreement.",
+ "type": "string"
+ },
+ "include_automated_payment_reminders": {
+ "description": "When true, automatically sends payment reminder emails.",
+ "type": "boolean"
+ },
+ "include_billing_info": {
+ "description": "When true, billing contact information (billing_name, billing_email) is included.",
+ "type": "boolean"
+ },
+ "include_billing_workflow": {
+ "description": "When true, enables a billing workflow after signing.",
+ "type": "boolean"
+ },
+ "include_expiration_date": {
+ "description": "Expiration date in YYYY-MM-DD format. Use when include_expiration_type is \"date\".",
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "include_expiration_days": {
+ "description": "Number of days until the agreement expires. Use when include_expiration_type is \"days\".",
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_expiration_type": {
+ "description": "How to set expiration: \"none\" (default), \"days\" (use include_expiration_days), or \"date\" (use include_expiration_date).",
+ "enum": [
+ "none",
+ "days",
+ "date"
+ ],
+ "type": "string"
+ },
+ "include_terms": {
+ "description": "When true, the standard terms are included with the agreement.",
+ "type": "boolean"
+ },
+ "loi_attributes": {
+ "additionalProperties": false,
+ "description": "Override loi terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "confidentiality_custom": {
+ "type": "string"
+ },
+ "confidentiality_mutual_include_loi": {
+ "type": "boolean"
+ },
+ "confidentiality_nda_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "confidentiality_nda_description": {
+ "type": "string"
+ },
+ "confidentiality_nda_include_loi": {
+ "type": "boolean"
+ },
+ "confidentiality_nda_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "confidentiality_type": {
+ "enum": [
+ "mutual",
+ "nda",
+ "provider",
+ "custom"
+ ],
+ "type": "string"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_custom_details": {
+ "type": "boolean"
+ },
+ "include_custom_details_val": {
+ "type": "string"
+ },
+ "include_fees": {
+ "type": "boolean"
+ },
+ "include_fees_amount": {
+ "type": "number"
+ },
+ "include_fees_amount_duration": {
+ "enum": [
+ "month",
+ "year",
+ "quarter"
+ ],
+ "type": "string"
+ },
+ "include_fees_include_amount": {
+ "type": "boolean"
+ },
+ "include_fees_include_other": {
+ "type": "boolean"
+ },
+ "include_fees_other": {
+ "type": "string"
+ },
+ "include_functionality": {
+ "type": "boolean"
+ },
+ "include_functionality_val": {
+ "type": "string"
+ },
+ "include_launch_date": {
+ "type": "boolean"
+ },
+ "include_launch_date_custom": {
+ "type": "string"
+ },
+ "include_launch_date_date": {
+ "format": "date-time",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$",
+ "type": "string"
+ },
+ "include_launch_date_type": {
+ "enum": [
+ "date",
+ "custom"
+ ],
+ "type": "string"
+ },
+ "product_name": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "manual_send": {
+ "description": "When true, the agreement is marked as manually sent outside the platform.",
+ "type": "boolean"
+ },
+ "message": {
+ "type": "string"
+ },
+ "negotiations_allowed": {
+ "description": "When true, the recipient can propose changes to the legal terms. For agreement types without separate business terms, that covers every term. CSA order forms, PSA statements of work, partnership business terms and software license order forms have their own `negotiations_allowed` flag.",
+ "type": "boolean"
+ },
+ "partnership_attributes": {
+ "additionalProperties": false,
+ "description": "Override partnership terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "effective_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "effective_date_type": {
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "type": "string"
+ },
+ "general_cap_amount_currency_val": {
+ "type": "number"
+ },
+ "general_cap_amount_either_currency": {
+ "type": "number"
+ },
+ "general_cap_amount_either_multiple": {
+ "type": "number"
+ },
+ "general_cap_amount_multiple_val": {
+ "type": "number"
+ },
+ "general_cap_amount_type": {
+ "enum": [
+ "multiple",
+ "currency",
+ "either",
+ "base"
+ ],
+ "type": "string"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_additional_warranties": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_include_company": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_include_company_val": {
+ "type": "string"
+ },
+ "include_additional_warranties_include_partner": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_include_partner_val": {
+ "type": "string"
+ },
+ "include_brand_guidelines": {
+ "type": "boolean"
+ },
+ "include_brand_guidelines_include_company": {
+ "type": "boolean"
+ },
+ "include_brand_guidelines_include_company_val": {
+ "type": "string"
+ },
+ "include_brand_guidelines_include_partner": {
+ "type": "boolean"
+ },
+ "include_brand_guidelines_include_partner_val": {
+ "type": "string"
+ },
+ "include_covered_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_company_claims": {
+ "type": "string"
+ },
+ "include_covered_claims_include_company_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_include_partner_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_partner_claims": {
+ "type": "string"
+ },
+ "include_dpa": {
+ "type": "boolean"
+ },
+ "include_dpa_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_dpa_location": {
+ "type": "string"
+ },
+ "include_dpa_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_increased_cap_amount": {
+ "type": "boolean"
+ },
+ "include_increased_cap_amount_currency": {
+ "type": "number"
+ },
+ "include_increased_cap_amount_either_currency": {
+ "type": "number"
+ },
+ "include_increased_cap_amount_either_multiple": {
+ "type": "string"
+ },
+ "include_increased_cap_amount_multiple": {
+ "type": "string"
+ },
+ "include_increased_cap_amount_type": {
+ "enum": [
+ "multiple",
+ "currency",
+ "either"
+ ],
+ "type": "string"
+ },
+ "include_increased_claims": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_confidentiality": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_confidentiality_misconduct": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_covered_claims": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_misconduct": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_other": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_other_val": {
+ "type": "string"
+ },
+ "include_unlimited_claims": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_confidentiality": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_confidentiality_misconduct": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_covered_claims": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_misconduct": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_other": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_other_val": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "partnership_business_terms_attributes": {
+ "additionalProperties": false,
+ "description": "Override partnership business terms terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "end_date_after_effective_date_amount": {
+ "type": "number"
+ },
+ "end_date_after_effective_date_unit": {
+ "enum": [
+ "month(s)",
+ "quarter(s)",
+ "year(s)"
+ ],
+ "type": "string"
+ },
+ "end_date_date": {
+ "type": "string"
+ },
+ "end_date_type": {
+ "enum": [
+ "date",
+ "effective date"
+ ],
+ "type": "string"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_obligations_company_brand": {
+ "type": "boolean"
+ },
+ "include_obligations_company_promotion": {
+ "type": "boolean"
+ },
+ "include_obligations_company_promotion_include_activities": {
+ "type": "boolean"
+ },
+ "include_obligations_company_promotion_include_activities_val": {
+ "type": "string"
+ },
+ "include_obligations_company_promotion_include_materials": {
+ "type": "boolean"
+ },
+ "include_obligations_company_promotion_include_materials_val": {
+ "type": "string"
+ },
+ "include_obligations_company_referral": {
+ "type": "boolean"
+ },
+ "include_obligations_company_referral_include_criteria": {
+ "type": "boolean"
+ },
+ "include_obligations_company_referral_include_criteria_val": {
+ "type": "string"
+ },
+ "include_obligations_company_referral_include_pay_sch": {
+ "type": "boolean"
+ },
+ "include_obligations_company_referral_include_pay_sch_amount": {
+ "type": "number"
+ },
+ "include_obligations_company_referral_include_pay_sch_custom": {
+ "type": "string"
+ },
+ "include_obligations_company_referral_include_pay_sch_unit": {
+ "enum": [
+ "U.S. Dollars",
+ "percent"
+ ],
+ "type": "string"
+ },
+ "include_obligations_company_sponsorship": {
+ "type": "boolean"
+ },
+ "include_obligations_company_sponsorship_include_benefits": {
+ "type": "boolean"
+ },
+ "include_obligations_company_sponsorship_include_benefits_val": {
+ "type": "string"
+ },
+ "include_obligations_company_sponsorship_include_payments": {
+ "type": "boolean"
+ },
+ "include_obligations_company_sponsorship_include_payments_amount": {
+ "type": "number"
+ },
+ "include_obligations_company_sponsorship_include_payments_unit": {
+ "enum": [
+ "U.S. Dollars",
+ "percent"
+ ],
+ "type": "string"
+ },
+ "include_obligations_partner_brand": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_promotion": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_promotion_include_activities": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_promotion_include_activities_val": {
+ "type": "string"
+ },
+ "include_obligations_partner_promotion_include_materials": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_promotion_include_materials_val": {
+ "type": "string"
+ },
+ "include_obligations_partner_referral": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_referral_include_criteria": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_referral_include_criteria_val": {
+ "type": "string"
+ },
+ "include_obligations_partner_referral_include_pay_sch": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_referral_include_pay_sch_amount": {
+ "type": "number"
+ },
+ "include_obligations_partner_referral_include_pay_sch_custom": {
+ "type": "string"
+ },
+ "include_obligations_partner_referral_include_pay_sch_unit": {
+ "enum": [
+ "U.S. Dollars",
+ "percent"
+ ],
+ "type": "string"
+ },
+ "include_obligations_partner_sponsorship": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_sponsorship_include_benefits": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_sponsorship_include_benefits_val": {
+ "type": "string"
+ },
+ "include_obligations_partner_sponsorship_include_payments": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_sponsorship_include_payments_amount": {
+ "type": "number"
+ },
+ "include_obligations_partner_sponsorship_include_payments_unit": {
+ "enum": [
+ "U.S. Dollars",
+ "percent"
+ ],
+ "type": "string"
+ },
+ "include_payment_process": {
+ "type": "boolean"
+ },
+ "include_payment_process_company": {
+ "type": "boolean"
+ },
+ "include_payment_process_company_include_address": {
+ "type": "boolean"
+ },
+ "include_payment_process_company_include_address_city": {
+ "type": "string"
+ },
+ "include_payment_process_company_include_address_country": {
+ "type": "string"
+ },
+ "include_payment_process_company_include_address_state": {
+ "type": "string"
+ },
+ "include_payment_process_company_include_address_street_address": {
+ "type": "string"
+ },
+ "include_payment_process_company_include_address_zipcode": {
+ "type": "string"
+ },
+ "include_payment_process_company_include_email": {
+ "type": "boolean"
+ },
+ "include_payment_process_company_include_email_val": {
+ "type": "string"
+ },
+ "include_payment_process_partner": {
+ "type": "boolean"
+ },
+ "include_payment_process_partner_include_address": {
+ "type": "boolean"
+ },
+ "include_payment_process_partner_include_address_city": {
+ "type": "string"
+ },
+ "include_payment_process_partner_include_address_country": {
+ "type": "string"
+ },
+ "include_payment_process_partner_include_address_state": {
+ "type": "string"
+ },
+ "include_payment_process_partner_include_address_street_address": {
+ "type": "string"
+ },
+ "include_payment_process_partner_include_address_zipcode": {
+ "type": "string"
+ },
+ "include_payment_process_partner_include_email": {
+ "type": "boolean"
+ },
+ "include_payment_process_partner_include_email_val": {
+ "type": "string"
+ },
+ "include_payment_schedule": {
+ "type": "boolean"
+ },
+ "include_payment_schedule_custom": {
+ "type": "string"
+ },
+ "include_payment_schedule_specified_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_payment_schedule_specified_timeframe": {
+ "enum": [
+ "receipt",
+ "date"
+ ],
+ "type": "string"
+ },
+ "include_payment_schedule_specified_unit": {
+ "enum": [
+ "day(s)",
+ "week(s)",
+ "month(s)",
+ "quarter(s)",
+ "year(s)"
+ ],
+ "type": "string"
+ },
+ "include_payment_schedule_type": {
+ "enum": [
+ "specified",
+ "custom"
+ ],
+ "type": "string"
+ },
+ "negotiations_allowed": {
+ "description": "When true, the recipient can propose changes to the business terms, even when the agreement-level `negotiations_allowed` is false. This only covers the business terms.",
+ "type": "boolean"
+ },
+ "territory_type": {
+ "enum": [
+ "worldwide",
+ "custom"
+ ],
+ "type": "string"
+ },
+ "territory_type_val": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "payment_link_url": {
+ "description": "A payment URL shown to the recipient after signing. Requires include_billing_workflow to be true and billing_workflow_type to be \"link\".",
+ "type": "string"
+ },
+ "pilot_attributes": {
+ "additionalProperties": false,
+ "description": "Override pilot terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "fees_type": {
+ "enum": [
+ "free",
+ "pilot_period_fees"
+ ],
+ "type": "string"
+ },
+ "general_cap_amount": {
+ "type": "number"
+ },
+ "general_cap_amount_type": {
+ "enum": [
+ "preceding",
+ "base",
+ "period"
+ ],
+ "type": "string"
+ },
+ "general_cap_period_currency": {
+ "type": "number"
+ },
+ "general_cap_period_qty": {
+ "type": "number"
+ },
+ "general_cap_preceding_amount": {
+ "type": "number"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_dpa": {
+ "type": "boolean"
+ },
+ "include_dpa_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_dpa_location": {
+ "type": "string"
+ },
+ "include_dpa_type": {
+ "enum": [
+ "description",
+ "attachment",
+ "standard"
+ ],
+ "type": "string"
+ },
+ "include_payment_process": {
+ "type": "boolean"
+ },
+ "include_technical_support": {
+ "type": "boolean"
+ },
+ "payment_process_automatic_frequency": {
+ "enum": [
+ "monthly",
+ "quarterly",
+ "annually",
+ "once_per_period"
+ ],
+ "type": "string"
+ },
+ "payment_process_invoice_days": {
+ "type": "number"
+ },
+ "payment_process_invoice_from": {
+ "enum": [
+ "receipt",
+ "date"
+ ],
+ "type": "string"
+ },
+ "payment_process_invoice_timeframe": {
+ "enum": [
+ "days",
+ "weeks",
+ "months",
+ "quarters",
+ "years"
+ ],
+ "type": "string"
+ },
+ "payment_process_type": {
+ "enum": [
+ "automatic",
+ "invoice"
+ ],
+ "type": "string"
+ },
+ "pilot_period_description": {
+ "type": "string"
+ },
+ "pilot_period_fees_description": {
+ "type": "string"
+ },
+ "product_description": {
+ "type": "string"
+ },
+ "technical_support_description": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "psa_attributes": {
+ "additionalProperties": false,
+ "description": "Override psa terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "additional_changes": {
+ "type": "string"
+ },
+ "customer_description": {
+ "type": "string"
+ },
+ "effective_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "effective_date_type": {
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "type": "string"
+ },
+ "general_cap_amount": {
+ "type": "number"
+ },
+ "general_cap_amount_type": {
+ "enum": [
+ "preceding",
+ "base",
+ "period"
+ ],
+ "type": "string"
+ },
+ "general_cap_period_currency": {
+ "type": "number"
+ },
+ "general_cap_period_qty": {
+ "type": "number"
+ },
+ "general_cap_preceding_amount": {
+ "type": "number"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_additional_changes": {
+ "type": "boolean"
+ },
+ "include_additional_warranties": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_by_customer": {
+ "type": "string"
+ },
+ "include_additional_warranties_by_provider": {
+ "type": "string"
+ },
+ "include_additional_warranties_include_by_customer": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_include_by_provider": {
+ "type": "boolean"
+ },
+ "include_covered_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_customer_claims": {
+ "type": "string"
+ },
+ "include_covered_claims_include_customer_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_include_provider_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_provider_claims": {
+ "type": "string"
+ },
+ "include_customer_insurance_min": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_add_provider_com_gen_liability": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_add_provider_cyber_liability": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_add_provider_errors_omissions": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_auto_liability_aggregate": {
+ "type": "number"
+ },
+ "include_customer_insurance_min_auto_liability_minimum": {
+ "type": "number"
+ },
+ "include_customer_insurance_min_cyber_liability_aggregate": {
+ "type": "number"
+ },
+ "include_customer_insurance_min_cyber_liability_minimum": {
+ "type": "number"
+ },
+ "include_customer_insurance_min_employer_liability_aggregate": {
+ "type": "number"
+ },
+ "include_customer_insurance_min_employer_liability_minimum": {
+ "type": "number"
+ },
+ "include_customer_insurance_min_general_liability_aggregate": {
+ "type": "number"
+ },
+ "include_customer_insurance_min_general_liability_minimum": {
+ "type": "number"
+ },
+ "include_customer_insurance_min_include_add_provider": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_include_auto_liability": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_include_cyber_liability": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_include_employer_liability": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_include_general_liability": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_include_workers_comp": {
+ "type": "boolean"
+ },
+ "include_customer_policies": {
+ "type": "boolean"
+ },
+ "include_customer_policies_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_customer_policies_location": {
+ "type": "string"
+ },
+ "include_customer_policies_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_dpa": {
+ "type": "boolean"
+ },
+ "include_dpa_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_dpa_location": {
+ "type": "string"
+ },
+ "include_dpa_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_increased_cap_amount": {
+ "type": "boolean"
+ },
+ "include_increased_claims": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_confidentiality": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_confidentiality_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_privsec": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_privsec_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_other": {
+ "type": "boolean"
+ },
+ "include_increased_claims_indemnification_obligation": {
+ "type": "boolean"
+ },
+ "include_increased_claims_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_other": {
+ "type": "string"
+ },
+ "include_provider_insurance_min": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_add_customer_com_gen_liability": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_add_customer_cyber_liability": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_add_customer_errors_omissions": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_auto_liability_aggregate": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_auto_liability_minimum": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_cyber_liability_aggregate": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_cyber_liability_minimum": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_employer_liability_aggregate": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_employer_liability_minimum": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_general_liability_aggregate": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_general_liability_minimum": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_include_add_customer": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_include_auto_liability": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_include_cyber_liability": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_include_employer_liability": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_include_general_liability": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_include_workers_comp": {
+ "type": "boolean"
+ },
+ "include_publicity_rights": {
+ "type": "boolean"
+ },
+ "include_publicity_rights_type": {
+ "enum": [
+ "public",
+ "non-public"
+ ],
+ "type": "string"
+ },
+ "include_security_policy": {
+ "type": "boolean"
+ },
+ "include_security_policy_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_security_policy_fedramp_auth": {
+ "type": "boolean"
+ },
+ "include_security_policy_hitrust": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_annual_maintenance": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_other": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_other_val": {
+ "type": "string"
+ },
+ "include_security_policy_iso27001": {
+ "type": "boolean"
+ },
+ "include_security_policy_location": {
+ "type": "string"
+ },
+ "include_security_policy_pci1": {
+ "type": "boolean"
+ },
+ "include_security_policy_pci2": {
+ "type": "boolean"
+ },
+ "include_security_policy_penetration_testing": {
+ "type": "boolean"
+ },
+ "include_security_policy_soc2_type1": {
+ "type": "boolean"
+ },
+ "include_security_policy_soc2_type2": {
+ "type": "boolean"
+ },
+ "include_security_policy_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_unlimited_claims": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_confidentiality": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_confidentiality_negligence": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_privsec": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_privsec_negligence": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_include_other": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_indemnification_obligation": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_negligence": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_other": {
+ "type": "string"
+ },
+ "increased_cap_amount_currency": {
+ "type": "number"
+ },
+ "increased_cap_amount_period_currency": {
+ "type": "number"
+ },
+ "increased_cap_amount_period_qty": {
+ "type": "number"
+ },
+ "increased_cap_amount_qty": {
+ "type": "number"
+ },
+ "increased_cap_amount_type": {
+ "enum": [
+ "qty",
+ "currency",
+ "period"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "psa_statement_of_work_attributes": {
+ "additionalProperties": false,
+ "description": "Override psa statement of work terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "additional_changes": {
+ "type": "string"
+ },
+ "cost": {
+ "type": "number"
+ },
+ "description": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "fees_attributes": {
+ "additionalProperties": {
+ "anyOf": [
+ {
+ "additionalProperties": false,
+ "description": "Fees::Flat (fee_type \"flat\"). A fixed recurring fee, e.g. a platform subscription. Set type to \"Fees::Flat\" or fee_type to \"flat\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Fixed amount in the order form's fees_currency, charged per fee_period. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"flat\". Alternative to type.",
+ "enum": [
+ "flat"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Flat\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Flat"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Discount (fee_type \"discount\"). A discount, as a fixed amount or a percentage, applied forever, once, or for a number of months. Set type to \"Fees::Discount\" or fee_type to \"discount\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Discount size: an amount in fees_currency when discount_type is fixed_amount (a plain amount, not cents: 20 means 20.00), or a percentage (e.g. 10 for 10%) when it is percentage.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "discount_duration_amount": {
+ "description": "Number of months the discount applies. Required when discount_duration_type is multiple_months.",
+ "type": "number"
+ },
+ "discount_duration_type": {
+ "description": "How long the discount applies. multiple_months also needs discount_duration_amount.",
+ "enum": [
+ "forever",
+ "once",
+ "multiple_months"
+ ],
+ "type": "string"
+ },
+ "discount_type": {
+ "description": "Whether cost is a currency amount or a percentage.",
+ "enum": [
+ "fixed_amount",
+ "percentage"
+ ],
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"discount\". Alternative to type.",
+ "enum": [
+ "discount"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Discount\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Discount"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Cost (fee_type \"cost\"). A per-unit fee: price per unit times quantity, e.g. seats. Set type to \"Fees::Cost\" or fee_type to \"cost\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Price per unit in fees_currency. The row total is quantity x cost. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"cost\". Alternative to type.",
+ "enum": [
+ "cost"
+ ],
+ "type": "string"
+ },
+ "quantity": {
+ "description": "Number of units.",
+ "type": "number"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Cost\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Cost"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Attachment (fee_type \"attachment\"). A fee described in an uploaded attachment instead of in the table. Set type to \"Fees::Attachment\" or fee_type to \"attachment\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "attachment_id": {
+ "description": "ID of an attachment uploaded with upload-attachment.",
+ "type": "string"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"attachment\". Alternative to type.",
+ "enum": [
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Attachment\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Attachment"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Graduated (fee_type \"graduated\"). Tiered pricing, with the price set per tier in graduated_fee_tiers_attributes. Set type to \"Fees::Graduated\" or fee_type to \"graduated\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"graduated\". Alternative to type.",
+ "enum": [
+ "graduated"
+ ],
+ "type": "string"
+ },
+ "graduated_fee_tiers_attributes": {
+ "additionalProperties": {
+ "additionalProperties": false,
+ "properties": {
+ "flat_price": {
+ "type": "number"
+ },
+ "price_per_unit": {
+ "type": "string"
+ },
+ "upper_limit": {
+ "type": "number"
+ }
+ },
+ "type": "object"
+ },
+ "description": "Graduated fee tiers. Use string keys such as \"0\", \"1\".",
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Graduated\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Graduated"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Included (fee_type \"included\"). An item included at no charge. Set type to \"Fees::Included\" or fee_type to \"included\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"included\". Alternative to type.",
+ "enum": [
+ "included"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Included\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Included"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Metered (fee_type \"metered\"). Usage-based pricing, billed per unit used. Set type to \"Fees::Metered\" or fee_type to \"metered\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Price per unit of usage in fees_currency. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"metered\". Alternative to type.",
+ "enum": [
+ "metered"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Metered\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Metered"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::OneTime (fee_type \"one_time\"). A one-time charge, such as a setup fee. Set type to \"Fees::OneTime\" or fee_type to \"one_time\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "One-time amount in fees_currency, charged once rather than per fee_period. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"one_time\". Alternative to type.",
+ "enum": [
+ "one_time"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::OneTime\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::OneTime"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Text (fee_type \"text\"). A fee term described in free text. Set type to \"Fees::Text\" or fee_type to \"text\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"text\". Alternative to type.",
+ "enum": [
+ "text"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Text\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Text"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ }
+ ]
+ },
+ "description": "Fee line items. Use string keys such as \"0\", \"1\". Replaces template fees when provided.",
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_additional_changes": {
+ "type": "boolean"
+ },
+ "include_customer_obligation": {
+ "type": "boolean"
+ },
+ "include_customer_obligation_val": {
+ "type": "string"
+ },
+ "include_deliverables": {
+ "type": "boolean"
+ },
+ "include_deliverables_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_deliverables_description": {
+ "type": "string"
+ },
+ "include_deliverables_include_acceptance": {
+ "type": "boolean"
+ },
+ "include_deliverables_include_attachment": {
+ "type": "boolean"
+ },
+ "include_deliverables_include_draft_deliverables": {
+ "type": "boolean"
+ },
+ "include_deliverables_rejection_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_deliverables_rejection_unit": {
+ "enum": [
+ "hours",
+ "days",
+ "weeks",
+ "months"
+ ],
+ "type": "string"
+ },
+ "include_deliverables_resubmission_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_deliverables_resubmission_unit": {
+ "enum": [
+ "hours",
+ "days",
+ "weeks",
+ "months"
+ ],
+ "type": "string"
+ },
+ "include_fees_other": {
+ "type": "boolean"
+ },
+ "include_fees_other_val": {
+ "type": "string"
+ },
+ "include_fees_table": {
+ "type": "boolean"
+ },
+ "include_fees_table_total": {
+ "type": "boolean"
+ },
+ "include_fees_travel": {
+ "type": "boolean"
+ },
+ "include_fees_travel_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_fees_travel_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_fees_travel_val": {
+ "type": "string"
+ },
+ "include_third_party_customer": {
+ "type": "boolean"
+ },
+ "include_third_party_include_description": {
+ "type": "boolean"
+ },
+ "include_third_party_include_description_val": {
+ "type": "string"
+ },
+ "include_third_party_materials": {
+ "type": "boolean"
+ },
+ "include_third_party_provider": {
+ "type": "boolean"
+ },
+ "include_time_of_assignment": {
+ "type": "boolean"
+ },
+ "include_time_of_assignment_type": {
+ "enum": [
+ "created",
+ "paid"
+ ],
+ "type": "string"
+ },
+ "invoice_period_description": {
+ "type": "string"
+ },
+ "negotiations_allowed": {
+ "description": "When true, the recipient can propose changes to the statement of work, even when the agreement-level `negotiations_allowed` is false. This only covers the statement of work.",
+ "type": "boolean"
+ },
+ "payment_period": {
+ "type": "number"
+ },
+ "payment_period_other": {
+ "type": "string"
+ },
+ "payment_period_timeframe": {
+ "enum": [
+ "receipt",
+ "invoice",
+ "Customer's receipt of invoice",
+ "date of invoice"
+ ],
+ "type": "string"
+ },
+ "payment_period_type": {
+ "enum": [
+ "standard",
+ "other"
+ ],
+ "type": "string"
+ },
+ "payment_period_unit": {
+ "enum": [
+ "day(s)",
+ "week(s)",
+ "month(s)",
+ "quarter(s)",
+ "year(s)"
+ ],
+ "type": "string"
+ },
+ "quantity": {
+ "type": "number"
+ },
+ "services_description": {
+ "type": "string"
+ },
+ "sow_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "sow_date_type": {
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "type": "string"
+ },
+ "sow_term_amount": {
+ "type": "number"
+ },
+ "sow_term_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "sow_term_type": {
+ "enum": [
+ "deliverables",
+ "period",
+ "date"
+ ],
+ "type": "string"
+ },
+ "sow_term_unit": {
+ "enum": [
+ "month(s)",
+ "quarter(s)",
+ "year(s)"
+ ],
+ "type": "string"
+ },
+ "type": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "recipient_email": {
+ "format": "email",
+ "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-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_last_to_sign": {
+ "description": "When true, your signer signs after the recipient.",
+ "type": "boolean"
+ },
+ "sender_notice_email_address": {
+ "description": "Email address for legal notices to the sender.",
+ "format": "email",
+ "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-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": {
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "type": "string"
+ },
+ "general_cap_amount": {
+ "type": "number"
+ },
+ "general_cap_amount_type": {
+ "enum": [
+ "preceding",
+ "base",
+ "period"
+ ],
+ "type": "string"
+ },
+ "general_cap_period_currency": {
+ "type": "number"
+ },
+ "general_cap_period_qty": {
+ "type": "number"
+ },
+ "general_cap_preceding_amount": {
+ "type": "number"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_additional_warranties": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_by_customer": {
+ "type": "string"
+ },
+ "include_additional_warranties_by_provider": {
+ "type": "string"
+ },
+ "include_additional_warranties_include_by_customer": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_include_by_provider": {
+ "type": "boolean"
+ },
+ "include_ai_addendum": {
+ "type": "boolean"
+ },
+ "include_ai_addendum_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_covered_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_customer_claims": {
+ "type": "string"
+ },
+ "include_covered_claims_include_customer_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_include_provider_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_provider_claims": {
+ "type": "string"
+ },
+ "include_dpa": {
+ "type": "boolean"
+ },
+ "include_dpa_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_dpa_location": {
+ "type": "string"
+ },
+ "include_dpa_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_increased_cap_amount": {
+ "type": "boolean"
+ },
+ "include_increased_claims": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_confidentiality": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_confidentiality_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_other": {
+ "type": "boolean"
+ },
+ "include_increased_claims_indemnification_obligation": {
+ "type": "boolean"
+ },
+ "include_increased_claims_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_other": {
+ "type": "string"
+ },
+ "include_increased_claims_restrictions": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_confidentiality": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_confidentiality_negligence": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_include_other": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_indemnification_obligation": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_license_or_restrictions": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_negligence": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_other": {
+ "type": "string"
+ },
+ "increased_cap_amount_currency": {
+ "type": "number"
+ },
+ "increased_cap_amount_period_currency": {
+ "type": "number"
+ },
+ "increased_cap_amount_period_qty": {
+ "type": "number"
+ },
+ "increased_cap_amount_qty": {
+ "type": "number"
+ },
+ "increased_cap_amount_type": {
+ "enum": [
+ "qty",
+ "currency",
+ "period"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "software_license_order_form_attributes": {
+ "additionalProperties": false,
+ "description": "Override software license order form terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "additional_changes": {
+ "type": "string"
+ },
+ "deletion_procedure_include_custom": {
+ "type": "boolean"
+ },
+ "deletion_procedure_include_custom_description": {
+ "type": "string"
+ },
+ "deletion_procedure_include_customer_disable": {
+ "type": "boolean"
+ },
+ "deletion_procedure_include_customer_proof": {
+ "type": "boolean"
+ },
+ "deletion_procedure_include_provider_disable": {
+ "type": "boolean"
+ },
+ "fee_custom_unit": {
+ "type": "string"
+ },
+ "fee_period": {
+ "enum": [
+ "Subscription Period",
+ "month",
+ "year",
+ "Custom unit"
+ ],
+ "type": "string"
+ },
+ "fees_attributes": {
+ "additionalProperties": {
+ "anyOf": [
+ {
+ "additionalProperties": false,
+ "description": "Fees::Flat (fee_type \"flat\"). A fixed recurring fee, e.g. a platform subscription. Set type to \"Fees::Flat\" or fee_type to \"flat\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Fixed amount in the order form's fees_currency, charged per fee_period. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"flat\". Alternative to type.",
+ "enum": [
+ "flat"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Flat\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Flat"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Discount (fee_type \"discount\"). A discount, as a fixed amount or a percentage, applied forever, once, or for a number of months. Set type to \"Fees::Discount\" or fee_type to \"discount\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Discount size: an amount in fees_currency when discount_type is fixed_amount (a plain amount, not cents: 20 means 20.00), or a percentage (e.g. 10 for 10%) when it is percentage.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "discount_duration_amount": {
+ "description": "Number of months the discount applies. Required when discount_duration_type is multiple_months.",
+ "type": "number"
+ },
+ "discount_duration_type": {
+ "description": "How long the discount applies. multiple_months also needs discount_duration_amount.",
+ "enum": [
+ "forever",
+ "once",
+ "multiple_months"
+ ],
+ "type": "string"
+ },
+ "discount_type": {
+ "description": "Whether cost is a currency amount or a percentage.",
+ "enum": [
+ "fixed_amount",
+ "percentage"
+ ],
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"discount\". Alternative to type.",
+ "enum": [
+ "discount"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Discount\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Discount"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Cost (fee_type \"cost\"). A per-unit fee: price per unit times quantity, e.g. seats. Set type to \"Fees::Cost\" or fee_type to \"cost\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Price per unit in fees_currency. The row total is quantity x cost. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"cost\". Alternative to type.",
+ "enum": [
+ "cost"
+ ],
+ "type": "string"
+ },
+ "quantity": {
+ "description": "Number of units.",
+ "type": "number"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Cost\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Cost"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Attachment (fee_type \"attachment\"). A fee described in an uploaded attachment instead of in the table. Set type to \"Fees::Attachment\" or fee_type to \"attachment\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "attachment_id": {
+ "description": "ID of an attachment uploaded with upload-attachment.",
+ "type": "string"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"attachment\". Alternative to type.",
+ "enum": [
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Attachment\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Attachment"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Graduated (fee_type \"graduated\"). Tiered pricing, with the price set per tier in graduated_fee_tiers_attributes. Set type to \"Fees::Graduated\" or fee_type to \"graduated\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"graduated\". Alternative to type.",
+ "enum": [
+ "graduated"
+ ],
+ "type": "string"
+ },
+ "graduated_fee_tiers_attributes": {
+ "additionalProperties": {
+ "additionalProperties": false,
+ "properties": {
+ "flat_price": {
+ "type": "number"
+ },
+ "price_per_unit": {
+ "type": "string"
+ },
+ "upper_limit": {
+ "type": "number"
+ }
+ },
+ "type": "object"
+ },
+ "description": "Graduated fee tiers. Use string keys such as \"0\", \"1\".",
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Graduated\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Graduated"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Included (fee_type \"included\"). An item included at no charge. Set type to \"Fees::Included\" or fee_type to \"included\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"included\". Alternative to type.",
+ "enum": [
+ "included"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Included\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Included"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Metered (fee_type \"metered\"). Usage-based pricing, billed per unit used. Set type to \"Fees::Metered\" or fee_type to \"metered\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "Price per unit of usage in fees_currency. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"metered\". Alternative to type.",
+ "enum": [
+ "metered"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Metered\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Metered"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::OneTime (fee_type \"one_time\"). A one-time charge, such as a setup fee. Set type to \"Fees::OneTime\" or fee_type to \"one_time\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "cost": {
+ "description": "One-time amount in fees_currency, charged once rather than per fee_period. A plain amount, not cents: 20 means 20.00.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"one_time\". Alternative to type.",
+ "enum": [
+ "one_time"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::OneTime\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::OneTime"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "Fees::Text (fee_type \"text\"). A fee term described in free text. Set type to \"Fees::Text\" or fee_type to \"text\". Rows go in fees_attributes keyed by string index (\"0\", \"1\", ...).",
+ "properties": {
+ "description": {
+ "description": "Line item label shown in the fee table.",
+ "type": "string"
+ },
+ "fee_type": {
+ "description": "Fee class as a short name: \"text\". Alternative to type.",
+ "enum": [
+ "text"
+ ],
+ "type": "string"
+ },
+ "stripe_product_id": {
+ "description": "Optional Stripe product ID, for orgs that bill through Stripe.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Fee class: \"Fees::Text\". Optional when fee_type is set.",
+ "enum": [
+ "Fees::Text"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ }
+ ]
+ },
+ "description": "Fee line items. Use string keys such as \"0\", \"1\". Replaces template fees when provided.",
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+ },
+ "fees_currency": {
+ "enum": [
+ "USD",
+ "EUR",
+ "GBP",
+ "CAD",
+ "AUD",
+ "SGD",
+ "ILS",
+ "JPY",
+ "CHF",
+ "HKD"
+ ],
+ "type": "string"
+ },
+ "fees_include_fee_increase_upon_renewal": {
+ "type": "boolean"
+ },
+ "fees_include_fee_increase_upon_renewal_fee": {
+ "type": "number"
+ },
+ "fees_include_fee_increase_upon_renewal_type": {
+ "enum": [
+ "will",
+ "may"
+ ],
+ "type": "string"
+ },
+ "fees_inclusive_of_taxes": {
+ "type": "boolean"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_additional_changes": {
+ "type": "boolean"
+ },
+ "include_license_compliance_verification": {
+ "type": "boolean"
+ },
+ "include_license_compliance_verification_description": {
+ "type": "string"
+ },
+ "include_license_limits": {
+ "type": "boolean"
+ },
+ "include_license_limits_description": {
+ "type": "string"
+ },
+ "include_payment_process_include_billing_email": {
+ "type": "boolean"
+ },
+ "include_pilot_period": {
+ "type": "boolean"
+ },
+ "include_pilot_period_duration_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_pilot_period_duration_type": {
+ "enum": [
+ "day",
+ "week",
+ "month"
+ ],
+ "type": "string"
+ },
+ "include_pilot_period_include_fees": {
+ "type": "boolean"
+ },
+ "include_pilot_period_include_fees_amount": {
+ "type": "number"
+ },
+ "include_pilot_period_include_modifications": {
+ "type": "boolean"
+ },
+ "include_pilot_period_include_modifications_description": {
+ "type": "string"
+ },
+ "include_services": {
+ "type": "boolean"
+ },
+ "include_services_description": {
+ "type": "string"
+ },
+ "negotiations_allowed": {
+ "description": "When true, the recipient can propose changes to the order form, even when the agreement-level `negotiations_allowed` is false. This only covers the order form.",
+ "type": "boolean"
+ },
+ "order_date_date": {
+ "type": "string"
+ },
+ "order_date_type": {
+ "enum": [
+ "signature",
+ "date",
+ "other"
+ ],
+ "type": "string"
+ },
+ "payment_process_automatic_frequency": {
+ "enum": [
+ "monthly",
+ "quarterly",
+ "semiannually",
+ "annually"
+ ],
+ "type": "string"
+ },
+ "payment_process_type": {
+ "enum": [
+ "automatic",
+ "invoice",
+ "custom"
+ ],
+ "type": "string"
+ },
+ "payment_process_type_custom_val": {
+ "type": "string"
+ },
+ "payment_process_type_invoice_amount": {
+ "type": "number"
+ },
+ "payment_process_type_invoice_custom_unit": {
+ "type": "string"
+ },
+ "payment_process_type_invoice_duration": {
+ "enum": [
+ "day",
+ "week",
+ "month",
+ "year",
+ "day(s)",
+ "week(s)",
+ "month(s)",
+ "year(s)"
+ ],
+ "type": "string"
+ },
+ "payment_process_type_invoice_duration_start": {
+ "enum": [
+ "Customer's receipt of invoice",
+ "date of invoice"
+ ],
+ "type": "string"
+ },
+ "payment_process_type_invoice_type": {
+ "enum": [
+ "monthly",
+ "quarterly",
+ "semiannually",
+ "annually",
+ "Custom unit"
+ ],
+ "type": "string"
+ },
+ "permitted_uses_include_custom": {
+ "type": "boolean"
+ },
+ "permitted_uses_include_custom_description": {
+ "type": "string"
+ },
+ "permitted_uses_include_customers_affiliates": {
+ "type": "boolean"
+ },
+ "permitted_uses_include_internal_business": {
+ "type": "boolean"
+ },
+ "pilot_period_stripe_product_id": {
+ "type": "string"
+ },
+ "software_description": {
+ "type": "string"
+ },
+ "subscription_auto_renew": {
+ "enum": [
+ "days",
+ "subscription_end"
+ ],
+ "type": "string"
+ },
+ "subscription_period": {
+ "type": "number"
+ },
+ "subscription_period_unit": {
+ "type": "string"
+ },
+ "subscription_renewal_notice_days": {
+ "type": "number"
+ },
+ "warranty_period_description_amount": {
+ "type": "number"
+ },
+ "warranty_period_description_duration": {
+ "enum": [
+ "day",
+ "week",
+ "month",
+ "year"
+ ],
+ "type": "string"
+ },
+ "warranty_period_description_duration_start": {
+ "enum": [
+ "initial delivery of the Software",
+ "delivery of the Software and each subsequent Update",
+ "the Order Date"
+ ],
+ "type": "string"
+ },
+ "warranty_period_type": {
+ "enum": [
+ "description",
+ "none"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "test_agreement": {
+ "description": "When true, marks the agreement as a test. Test agreements do not count against your monthly limit.",
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "recipient_name",
+ "recipient_email"
+ ],
+ "type": "object"
+ },
+ "cc_users": {
+ "items": {
+ "format": "email",
+ "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-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": {
- "enum": [
- "signature",
- "date"
- ],
- "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": {
- "enum": [
- "stripe",
- "link"
- ],
- "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": {
- "enum": [
- "AWS",
- "GCP",
- "Azure"
- ],
- "type": "string"
- },
- "effective_date_type": {
- "enum": [
- "signature",
- "date",
- "marketplace_acceptance"
- ],
- "type": "string"
- },
- "general_cap_amount": {
- "type": "number"
- },
- "general_cap_amount_type": {
- "enum": [
- "preceding",
- "base",
- "period"
- ],
- "type": "string"
- },
- "general_cap_period_currency": {
- "type": "number"
- },
- "general_cap_period_qty": {
- "type": "number"
- },
- "general_cap_preceding_amount": {
- "type": "number"
- },
- "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": {
- "enum": [
- "description",
- "attachment"
- ],
- "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": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_increased_cap_amount": {
- "type": "boolean"
- },
- "include_increased_claims": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_confidentiality": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_confidentiality_negligence": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_privsec": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_privsec_negligence": {
- "type": "boolean"
- },
- "include_increased_claims_include_other": {
- "type": "boolean"
- },
- "include_increased_claims_indemnification_obligation": {
- "type": "boolean"
- },
- "include_increased_claims_other": {
- "type": "string"
- },
- "include_insurance_minimums": {
- "type": "boolean"
- },
- "include_insurance_minimums_add_customer": {
- "type": "boolean"
- },
- "include_insurance_minimums_add_customer_com_gen_liability": {
- "type": "boolean"
- },
- "include_insurance_minimums_add_customer_cyber_liability": {
- "type": "boolean"
- },
- "include_insurance_minimums_add_customer_errors_omissions": {
- "type": "boolean"
- },
- "include_insurance_minimums_additional_information": {
- "type": "boolean"
- },
- "include_insurance_minimums_additional_information_text": {
- "type": "string"
- },
- "include_insurance_minimums_cyber_liability_aggregate": {
- "type": "number"
- },
- "include_insurance_minimums_cyber_liability_minimum": {
- "type": "number"
- },
- "include_insurance_minimums_employer_liability_aggregate": {
- "type": "number"
- },
- "include_insurance_minimums_employer_liability_minimum": {
- "type": "number"
- },
- "include_insurance_minimums_general_liability_aggregate": {
- "type": "number"
- },
- "include_insurance_minimums_general_liability_minimum": {
- "type": "number"
- },
- "include_insurance_minimums_include_cyber_liability": {
- "type": "boolean"
- },
- "include_insurance_minimums_include_employer_liability": {
- "type": "boolean"
- },
- "include_insurance_minimums_include_general_liability": {
- "type": "boolean"
- },
- "include_insurance_minimums_include_workers_compensation": {
- "type": "boolean"
- },
- "include_publicity_rights": {
- "type": "boolean"
- },
- "include_publicity_rights_type": {
- "enum": [
- "public",
- "non-public"
- ],
- "type": "string"
- },
- "include_security_policy": {
- "type": "boolean"
- },
- "include_security_policy_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_security_policy_fedramp_auth": {
- "type": "boolean"
- },
- "include_security_policy_hipaa": {
- "type": "boolean"
- },
- "include_security_policy_hitrust": {
- "type": "boolean"
- },
- "include_security_policy_include_annual_maintenance": {
- "type": "boolean"
- },
- "include_security_policy_include_location": {
- "type": "boolean"
- },
- "include_security_policy_include_other": {
- "type": "boolean"
- },
- "include_security_policy_include_reasonable_efforts": {
- "type": "boolean"
- },
- "include_security_policy_iso27001": {
- "type": "boolean"
- },
- "include_security_policy_location": {
- "type": "string"
- },
- "include_security_policy_other": {
- "type": "string"
- },
- "include_security_policy_pci1": {
- "type": "boolean"
- },
- "include_security_policy_pci2": {
- "type": "boolean"
- },
- "include_security_policy_penetration_testing": {
- "type": "boolean"
- },
- "include_security_policy_soc2": {
- "type": "boolean"
- },
- "include_security_policy_soc2_type2": {
- "type": "boolean"
- },
- "include_security_policy_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_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": {
- "type": "number"
- },
- "increased_cap_amount_qty": {
- "type": "number"
- },
- "increased_cap_amount_type": {
- "enum": [
- "qty",
- "currency",
- "period"
- ],
- "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": {
- "enum": [
- "automatic",
- "invoice"
- ],
- "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": {
- "enum": [
- "Subscription Period",
- "month",
- "year",
- "User",
- "Custom unit"
- ],
- "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": {
- "enum": [
- "USD",
- "EUR",
- "GBP",
- "CAD",
- "AUD",
- "SGD",
- "ILS",
- "JPY",
- "CHF",
- "HKD"
- ],
- "type": "string"
- },
- "fees_include_fee_increase_upon_renewal": {
- "type": "boolean"
- },
- "fees_include_fee_increase_upon_renewal_fee": {
- "type": "number"
- },
- "fees_include_fee_increase_upon_renewal_type": {
- "enum": [
- "will",
- "may"
- ],
- "type": "string"
- },
- "fees_inclusive_of_taxes": {
- "type": "boolean"
- },
- "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": {
- "enum": [
- "Subscription Period",
- "month",
- "year",
- "User"
- ],
- "type": "string"
- },
- "include_free_trial": {
- "type": "boolean"
- },
- "include_max_users": {
- "type": "boolean"
- },
- "include_pilot_period": {
- "type": "boolean"
- },
- "include_pilot_period_duration_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_pilot_period_duration_type": {
- "enum": [
- "day",
- "week",
- "month"
- ],
- "type": "string"
- },
- "include_pilot_period_include_fees": {
- "type": "boolean"
- },
- "include_pilot_period_include_fees_amount": {
- "type": "number"
- },
- "include_pilot_period_include_modifications": {
- "type": "boolean"
- },
- "include_pilot_period_include_modifications_description": {
- "type": "string"
- },
- "include_product_support": {
- "type": "boolean"
- },
- "include_product_support_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_product_support_description": {
- "type": "string"
- },
- "include_product_support_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_professional_services": {
- "type": "boolean"
- },
- "include_professional_services_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_professional_services_custom_name": {
- "type": "string"
- },
- "include_professional_services_description": {
- "type": "string"
- },
- "include_professional_services_end_date": {
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "include_professional_services_fees_description": {
- "type": "string"
- },
- "include_professional_services_include_end_date": {
- "type": "boolean"
- },
- "include_professional_services_include_fees_description": {
- "type": "boolean"
- },
- "include_professional_services_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_sla": {
- "type": "boolean"
- },
- "include_sla_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_sla_description": {
- "type": "string"
- },
- "include_sla_include_response_time": {
- "type": "boolean"
- },
- "include_sla_include_response_time_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_sla_include_response_time_credit": {
- "type": "number"
- },
- "include_sla_include_response_time_duration": {
- "enum": [
- "hour",
- "day",
- "week",
- "month",
- "hours"
- ],
- "type": "string"
- },
- "include_sla_include_response_time_support_channel": {
- "type": "string"
- },
- "include_sla_include_target_uptime": {
- "type": "boolean"
- },
- "include_sla_maintenance_notice": {
- "type": "boolean"
- },
- "include_sla_maintenance_window": {
- "type": "boolean"
- },
- "include_sla_maintenance_window_type": {
- "enum": [
- "standard",
- "none"
- ],
- "type": "string"
- },
- "include_sla_standard_maintenance_notice_qty": {
- "type": "number"
- },
- "include_sla_standard_maintenance_notice_unit": {
- "enum": [
- "hour",
- "day",
- "week",
- "month"
- ],
- "type": "string"
- },
- "include_sla_standard_maintenance_window_end_time": {
- "type": "string"
- },
- "include_sla_standard_maintenance_window_friday": {
- "type": "boolean"
- },
- "include_sla_standard_maintenance_window_monday": {
- "type": "boolean"
- },
- "include_sla_standard_maintenance_window_saturday": {
- "type": "boolean"
- },
- "include_sla_standard_maintenance_window_start_time": {
- "type": "string"
- },
- "include_sla_standard_maintenance_window_sunday": {
- "type": "boolean"
- },
- "include_sla_standard_maintenance_window_thursday": {
- "type": "boolean"
- },
- "include_sla_standard_maintenance_window_time_zone": {
- "type": "string"
- },
- "include_sla_standard_maintenance_window_tuesday": {
- "type": "boolean"
- },
- "include_sla_standard_maintenance_window_wednesday": {
- "type": "boolean"
- },
- "include_sla_standard_target_uptime": {
- "type": "number"
- },
- "include_sla_type": {
- "enum": [
- "description",
- "standard",
- "attachment"
- ],
- "type": "string"
- },
- "include_subscription_start_date": {
- "type": "boolean"
- },
- "include_subscription_start_date_date": {
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "include_usage_review": {
- "type": "boolean"
- },
- "include_usage_review_val": {
- "type": "string"
- },
- "include_use_limitations": {
- "type": "boolean"
- },
- "include_use_limitations_val": {
- "type": "string"
- },
- "invoice_period": {
- "enum": [
- "monthly",
- "quarterly",
- "semiannually",
- "annually",
- "Custom unit",
- "Monthly",
- "Quarterly",
- "Semiannually",
- "Annually"
- ],
- "type": "string"
- },
- "invoice_period_custom_unit": {
- "type": "string"
- },
- "max_consumption": {
- "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": {
- "enum": [
- "signature",
- "date",
- "other"
- ],
- "type": "string"
- },
- "payment_period": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "payment_period_timeframe": {
- "enum": [
- "Customer's receipt of invoice",
- "date of invoice"
- ],
- "type": "string"
- },
- "payment_period_unit": {
- "enum": [
- "day(s)",
- "week(s)",
- "month(s)",
- "marketplace_acceptance"
- ],
- "type": "string"
- },
- "payment_process_automatic_frequency": {
- "enum": [
- "monthly",
- "quarterly",
- "semiannually",
- "annually"
- ],
- "type": "string"
- },
- "payment_process_type": {
- "enum": [
- "automatic",
- "invoice",
- "custom",
- "marketplace_acceptance"
- ],
- "type": "string"
- },
- "payment_process_type_custom_val": {
- "type": "string"
- },
- "payment_process_type_invoice_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "payment_process_type_invoice_custom_unit": {
- "type": "string"
- },
- "payment_process_type_invoice_duration": {
- "enum": [
- "day",
- "week",
- "month",
- "year",
- "day(s)",
- "week(s)",
- "month(s)",
- "year(s)"
- ],
- "type": "string"
- },
- "payment_process_type_invoice_duration_start": {
- "enum": [
- "Customer's receipt of invoice",
- "date of invoice"
- ],
- "type": "string"
- },
- "payment_process_type_invoice_type": {
- "enum": [
- "monthly",
- "quarterly",
- "semiannually",
- "annually",
- "Custom unit"
- ],
- "type": "string"
- },
- "pilot_period_stripe_product_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-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": {
- "enum": [
- "days",
- "subscription_end"
- ],
- "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": {
- "enum": [
- "effective_date",
- "date"
- ],
- "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": {
- "enum": [
- "signature",
- "date"
- ],
- "type": "string"
- },
- "general_cap_amount": {
- "type": "number"
- },
- "general_cap_amount_type": {
- "enum": [
- "preceding",
- "base",
- "period"
- ],
- "type": "string"
- },
- "general_cap_period_currency": {
- "type": "number"
- },
- "general_cap_period_qty": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "general_cap_preceding_amount": {
- "type": "number"
- },
- "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": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_dpa": {
- "type": "boolean"
- },
- "include_dpa_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_dpa_location": {
- "type": "string"
- },
- "include_dpa_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_increased_cap_amount": {
- "type": "boolean"
- },
- "include_increased_claims": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_confidentiality": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_confidentiality_negligence": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_privsec": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_privsec_negligence": {
- "type": "boolean"
- },
- "include_increased_claims_include_other": {
- "type": "boolean"
- },
- "include_increased_claims_indemnification_obligation": {
- "type": "boolean"
- },
- "include_increased_claims_negligence": {
- "type": "boolean"
- },
- "include_increased_claims_other": {
- "type": "string"
- },
- "include_provider_insurance_min": {
- "type": "boolean"
- },
- "include_provider_insurance_min_add_customer_com_gen_liability": {
- "type": "boolean"
- },
- "include_provider_insurance_min_add_customer_cyber_liability": {
- "type": "boolean"
- },
- "include_provider_insurance_min_add_customer_errors_omissions": {
- "type": "boolean"
- },
- "include_provider_insurance_min_auto_liability_aggregate": {
- "type": "number"
- },
- "include_provider_insurance_min_auto_liability_minimum": {
- "type": "number"
- },
- "include_provider_insurance_min_cyber_liability_aggregate": {
- "type": "number"
- },
- "include_provider_insurance_min_cyber_liability_minimum": {
- "type": "number"
- },
- "include_provider_insurance_min_employer_liability_aggregate": {
- "type": "number"
- },
- "include_provider_insurance_min_employer_liability_minimum": {
- "type": "number"
- },
- "include_provider_insurance_min_general_liability_aggregate": {
- "type": "number"
- },
- "include_provider_insurance_min_general_liability_minimum": {
- "type": "number"
- },
- "include_provider_insurance_min_include_add_customer": {
- "type": "boolean"
- },
- "include_provider_insurance_min_include_auto_liability": {
- "type": "boolean"
- },
- "include_provider_insurance_min_include_cyber_liability": {
- "type": "boolean"
- },
- "include_provider_insurance_min_include_employer_liability": {
- "type": "boolean"
- },
- "include_provider_insurance_min_include_general_liability": {
- "type": "boolean"
- },
- "include_provider_insurance_min_include_workers_comp": {
- "type": "boolean"
- },
- "include_publicity_rights": {
- "type": "boolean"
- },
- "include_publicity_rights_type": {
- "enum": [
- "public",
- "non-public"
- ],
- "type": "string"
- },
- "include_security_policy": {
- "type": "boolean"
- },
- "include_security_policy_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_security_policy_fedramp_auth": {
- "type": "boolean"
- },
- "include_security_policy_hitrust": {
- "type": "boolean"
- },
- "include_security_policy_include_annual_maintenance": {
- "type": "boolean"
- },
- "include_security_policy_include_other": {
- "type": "boolean"
- },
- "include_security_policy_include_other_val": {
- "type": "string"
- },
- "include_security_policy_iso27001": {
- "type": "boolean"
- },
- "include_security_policy_location": {
- "type": "string"
- },
- "include_security_policy_pci1": {
- "type": "boolean"
- },
- "include_security_policy_pci2": {
- "type": "boolean"
- },
- "include_security_policy_penetration_testing": {
- "type": "boolean"
- },
- "include_security_policy_soc2_type1": {
- "type": "boolean"
- },
- "include_security_policy_soc2_type2": {
- "type": "boolean"
- },
- "include_security_policy_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_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": {
- "enum": [
- "qty",
- "currency",
- "period"
- ],
- "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": {
- "enum": [
- "hours",
- "days",
- "weeks",
- "months"
- ],
- "type": "string"
- },
- "include_deliverables_resubmission_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_deliverables_resubmission_unit": {
- "enum": [
- "hours",
- "days",
- "weeks",
- "months"
- ],
- "type": "string"
- },
- "include_fees_other": {
- "type": "boolean"
- },
- "include_fees_other_val": {
- "type": "string"
- },
- "include_fees_table": {
- "type": "boolean"
- },
- "include_fees_table_total": {
- "type": "boolean"
- },
- "include_fees_travel": {
- "type": "boolean"
- },
- "include_fees_travel_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_fees_travel_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_fees_travel_val": {
- "type": "string"
- },
- "include_third_party_customer": {
- "type": "boolean"
- },
- "include_third_party_include_description": {
- "type": "boolean"
- },
- "include_third_party_include_description_val": {
- "type": "string"
- },
- "include_third_party_materials": {
- "type": "boolean"
- },
- "include_third_party_provider": {
- "type": "boolean"
- },
- "include_time_of_assignment": {
- "type": "boolean"
- },
- "include_time_of_assignment_type": {
- "enum": [
- "created",
- "paid"
- ],
- "type": "string"
- },
- "invoice_period_description": {
- "type": "string"
- },
- "negotiations_allowed": {
- "description": "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": {
- "enum": [
- "receipt",
- "invoice",
- "Customer's receipt of invoice",
- "date of invoice"
- ],
- "type": "string"
- },
- "payment_period_type": {
- "enum": [
- "standard",
- "other"
- ],
- "type": "string"
- },
- "payment_period_unit": {
- "enum": [
- "day(s)",
- "week(s)",
- "month(s)",
- "quarter(s)",
- "year(s)"
- ],
- "type": "string"
- },
- "services_description": {
- "type": "string"
- },
- "sow_date": {
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "sow_date_type": {
- "enum": [
- "signature",
- "date"
- ],
- "type": "string"
- },
- "sow_term_amount": {
- "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": {
- "enum": [
- "deliverables",
- "period",
- "date"
- ],
- "type": "string"
- },
- "sow_term_unit": {
- "enum": [
- "month(s)",
- "quarter(s)",
- "year(s)"
- ],
- "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": {
- "enum": [
- "signature",
- "date"
- ],
- "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": {
- "enum": [
- "default_language",
- "description"
- ],
- "type": "string"
- },
- "include_fees_unit": {
- "enum": [
- "month",
- "quarter",
- "year",
- "Term"
- ],
- "type": "string"
- },
- "include_program_appear_as_customer_private": {
- "type": "boolean"
- },
- "include_program_appear_as_customer_public": {
- "type": "boolean"
- },
- "include_program_case_study": {
- "type": "boolean"
- },
- "include_program_develop_functionality": {
- "type": "boolean"
- },
- "include_program_develop_functionality_val": {
- "type": "string"
- },
- "include_program_discount": {
- "type": "boolean"
- },
- "include_program_discount_amount": {
- "type": "number"
- },
- "include_program_discount_unit": {
- "enum": [
- "U.S. Dollars",
- "percent"
- ],
- "type": "string"
- },
- "include_program_participation_feedback": {
- "type": "boolean"
- },
- "include_program_participation_feedback_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_program_participation_feedback_unit": {
- "enum": [
- "month",
- "quarter",
- "year",
- "Term"
- ],
- "type": "string"
- },
- "include_program_partner_other": {
- "type": "boolean"
- },
- "include_program_partner_other_val": {
- "type": "string"
- },
- "include_program_provider_other": {
- "type": "boolean"
- },
- "include_program_provider_other_val": {
- "type": "string"
- },
- "include_program_reference": {
- "type": "boolean"
- },
- "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": {
- "enum": [
- "day(s)",
- "week(s)",
- "month(s)",
- "quarter(s)",
- "year(s)"
- ],
- "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": {
- "enum": [
- "stripe",
- "link"
- ],
- "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": {
- "enum": [
- "signature",
- "date"
- ],
- "type": "string"
- },
- "general_cap_amount": {
- "type": "number"
- },
- "general_cap_amount_type": {
- "enum": [
- "preceding",
- "base",
- "period"
- ],
- "type": "string"
- },
- "general_cap_period_currency": {
- "type": "number"
- },
- "general_cap_period_qty": {
- "type": "number"
- },
- "general_cap_preceding_amount": {
- "type": "number"
- },
- "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": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_increased_cap_amount": {
- "type": "boolean"
- },
- "include_increased_claims": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_confidentiality": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_confidentiality_negligence": {
- "type": "boolean"
- },
- "include_increased_claims_include_other": {
- "type": "boolean"
- },
- "include_increased_claims_indemnification_obligation": {
- "type": "boolean"
- },
- "include_increased_claims_negligence": {
- "type": "boolean"
- },
- "include_increased_claims_other": {
- "type": "string"
- },
- "include_increased_claims_restrictions": {
- "type": "boolean"
- },
- "include_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": {
- "enum": [
- "qty",
- "currency",
- "period"
- ],
- "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": {
- "enum": [
- "automatic",
- "manual"
- ],
- "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": {
- "enum": [
- "automatic",
- "invoice"
- ],
- "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": {
- "enum": [
- "Subscription Period",
- "month",
- "year",
- "Custom unit"
- ],
- "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": {
- "enum": [
- "USD",
- "EUR",
- "GBP",
- "CAD",
- "AUD",
- "SGD",
- "ILS",
- "JPY",
- "CHF",
- "HKD"
- ],
- "type": "string"
- },
- "fees_include_fee_increase_upon_renewal": {
- "type": "boolean"
- },
- "fees_include_fee_increase_upon_renewal_fee": {
- "type": "number"
- },
- "fees_include_fee_increase_upon_renewal_type": {
- "enum": [
- "will",
- "may"
- ],
- "type": "string"
- },
- "fees_inclusive_of_taxes": {
- "type": "boolean"
- },
- "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": {
- "enum": [
- "day",
- "week",
- "month"
- ],
- "type": "string"
- },
- "include_pilot_period_include_fees": {
- "type": "boolean"
- },
- "include_pilot_period_include_fees_amount": {
- "type": "number"
- },
- "include_pilot_period_include_modifications": {
- "type": "boolean"
- },
- "include_pilot_period_include_modifications_description": {
- "type": "string"
- },
- "include_services": {
- "type": "boolean"
- },
- "include_services_description": {
- "type": "string"
- },
- "negotiations_allowed": {
- "description": "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": {
- "enum": [
- "signature",
- "date",
- "other"
- ],
- "type": "string"
- },
- "payment_process_automatic_frequency": {
- "enum": [
- "monthly",
- "quarterly",
- "semiannually",
- "annually"
- ],
- "type": "string"
- },
- "payment_process_type": {
- "enum": [
- "automatic",
- "invoice",
- "custom"
- ],
- "type": "string"
- },
- "payment_process_type_custom_val": {
- "type": "string"
- },
- "payment_process_type_invoice_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "payment_process_type_invoice_custom_unit": {
- "type": "string"
- },
- "payment_process_type_invoice_duration": {
- "enum": [
- "day",
- "week",
- "month",
- "year",
- "day(s)",
- "week(s)",
- "month(s)",
- "year(s)"
- ],
- "type": "string"
- },
- "payment_process_type_invoice_duration_start": {
- "enum": [
- "Customer's receipt of invoice",
- "date of invoice"
- ],
- "type": "string"
- },
- "payment_process_type_invoice_type": {
- "enum": [
- "monthly",
- "quarterly",
- "semiannually",
- "annually",
- "Custom unit"
- ],
- "type": "string"
- },
- "permitted_uses_include_custom": {
- "type": "boolean"
- },
- "permitted_uses_include_custom_description": {
- "type": "string"
- },
- "permitted_uses_include_customers_affiliates": {
- "type": "boolean"
- },
- "permitted_uses_include_internal_business": {
- "type": "boolean"
- },
- "pilot_period_stripe_product_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-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": {
- "enum": [
- "days",
- "subscription_end"
- ],
- "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": {
- "enum": [
- "day",
- "week",
- "month",
- "year"
- ],
- "type": "string"
- },
- "warranty_period_description_duration_start": {
- "enum": [
- "initial delivery of the Software",
- "delivery of the Software and each subsequent Update",
- "the Order Date"
- ],
- "type": "string"
- },
- "warranty_period_type": {
- "enum": [
- "description",
- "none"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- "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": {
- "enum": [
- "signature",
- "date"
- ],
- "type": "string"
- },
- "fees_type": {
- "enum": [
- "free",
- "pilot_period_fees"
- ],
- "type": "string"
- },
- "general_cap_amount": {
- "type": "number"
- },
- "general_cap_amount_type": {
- "enum": [
- "preceding",
- "base",
- "period"
- ],
- "type": "string"
- },
- "general_cap_period_currency": {
- "type": "number"
- },
- "general_cap_period_qty": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "general_cap_preceding_amount": {
- "type": "number"
- },
- "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": {
- "enum": [
- "description",
- "attachment",
- "standard"
- ],
- "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": {
- "enum": [
- "monthly",
- "quarterly",
- "annually",
- "once_per_period"
- ],
- "type": "string"
- },
- "payment_process_invoice_days": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "payment_process_invoice_from": {
- "enum": [
- "receipt",
- "date"
- ],
- "type": "string"
- },
- "payment_process_invoice_timeframe": {
- "enum": [
- "days",
- "weeks",
- "months",
- "quarters",
- "years"
- ],
- "type": "string"
- },
- "payment_process_type": {
- "enum": [
- "automatic",
- "invoice"
- ],
- "type": "string"
- },
- "pilot_period_description": {
- "type": "string"
- },
- "pilot_period_fees_description": {
- "type": "string"
- },
- "product_description": {
- "type": "string"
- },
- "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": {
- "enum": [
- "signature",
- "date"
- ],
- "type": "string"
- },
- "general_cap_amount_currency_val": {
- "type": "number"
- },
- "general_cap_amount_either_currency": {
- "type": "number"
- },
- "general_cap_amount_either_multiple": {
- "type": "number"
- },
- "general_cap_amount_multiple_val": {
- "type": "number"
- },
- "general_cap_amount_type": {
- "enum": [
- "multiple",
- "currency",
- "either",
- "base"
- ],
- "type": "string"
- },
- "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": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_increased_cap_amount": {
- "type": "boolean"
- },
- "include_increased_cap_amount_currency": {
- "type": "number"
- },
- "include_increased_cap_amount_either_currency": {
- "type": "number"
- },
- "include_increased_cap_amount_either_multiple": {},
- "include_increased_cap_amount_multiple": {},
- "include_increased_cap_amount_type": {
- "enum": [
- "multiple",
- "currency",
- "either"
- ],
- "type": "string"
- },
- "include_increased_claims": {
- "type": "boolean"
- },
- "include_increased_claims_include_confidentiality": {
- "type": "boolean"
- },
- "include_increased_claims_include_confidentiality_misconduct": {
- "type": "boolean"
- },
- "include_increased_claims_include_covered_claims": {
- "type": "boolean"
- },
- "include_increased_claims_include_misconduct": {
- "type": "boolean"
- },
- "include_increased_claims_include_other": {
- "type": "boolean"
- },
- "include_increased_claims_include_other_val": {
- "type": "string"
- },
- "include_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": {
- "enum": [
- "month(s)",
- "quarter(s)",
- "year(s)"
- ],
- "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": {
- "enum": [
- "date",
- "effective date"
- ],
- "type": "string"
- },
- "include_obligations_company_brand": {
- "type": "boolean"
- },
- "include_obligations_company_promotion": {
- "type": "boolean"
- },
- "include_obligations_company_promotion_include_activities": {
- "type": "boolean"
- },
- "include_obligations_company_promotion_include_activities_val": {
- "type": "string"
- },
- "include_obligations_company_promotion_include_materials": {
- "type": "boolean"
- },
- "include_obligations_company_promotion_include_materials_val": {
- "type": "string"
- },
- "include_obligations_company_referral": {
- "type": "boolean"
- },
- "include_obligations_company_referral_include_criteria": {
- "type": "boolean"
- },
- "include_obligations_company_referral_include_criteria_val": {
- "type": "string"
- },
- "include_obligations_company_referral_include_pay_sch": {
- "type": "boolean"
- },
- "include_obligations_company_referral_include_pay_sch_amount": {
- "type": "number"
- },
- "include_obligations_company_referral_include_pay_sch_custom": {
- "type": "string"
- },
- "include_obligations_company_referral_include_pay_sch_unit": {
- "enum": [
- "U.S. Dollars",
- "percent"
- ],
- "type": "string"
- },
- "include_obligations_company_sponsorship": {
- "type": "boolean"
- },
- "include_obligations_company_sponsorship_include_benefits": {
- "type": "boolean"
- },
- "include_obligations_company_sponsorship_include_benefits_val": {
- "type": "string"
- },
- "include_obligations_company_sponsorship_include_payments": {
- "type": "boolean"
- },
- "include_obligations_company_sponsorship_include_payments_amount": {
- "type": "number"
- },
- "include_obligations_company_sponsorship_include_payments_unit": {
- "enum": [
- "U.S. Dollars",
- "percent"
- ],
- "type": "string"
- },
- "include_obligations_partner_brand": {
- "type": "boolean"
- },
- "include_obligations_partner_promotion": {
- "type": "boolean"
- },
- "include_obligations_partner_promotion_include_activities": {
- "type": "boolean"
- },
- "include_obligations_partner_promotion_include_activities_val": {
- "type": "string"
- },
- "include_obligations_partner_promotion_include_materials": {
- "type": "boolean"
- },
- "include_obligations_partner_promotion_include_materials_val": {
- "type": "string"
- },
- "include_obligations_partner_referral": {
- "type": "boolean"
- },
- "include_obligations_partner_referral_include_criteria": {
- "type": "boolean"
- },
- "include_obligations_partner_referral_include_criteria_val": {
- "type": "string"
- },
- "include_obligations_partner_referral_include_pay_sch": {
- "type": "boolean"
- },
- "include_obligations_partner_referral_include_pay_sch_amount": {
- "type": "number"
- },
- "include_obligations_partner_referral_include_pay_sch_custom": {
- "type": "string"
- },
- "include_obligations_partner_referral_include_pay_sch_unit": {
- "enum": [
- "U.S. Dollars",
- "percent"
- ],
- "type": "string"
- },
- "include_obligations_partner_sponsorship": {
- "type": "boolean"
- },
- "include_obligations_partner_sponsorship_include_benefits": {
- "type": "boolean"
- },
- "include_obligations_partner_sponsorship_include_benefits_val": {
- "type": "string"
- },
- "include_obligations_partner_sponsorship_include_payments": {
- "type": "boolean"
- },
- "include_obligations_partner_sponsorship_include_payments_amount": {
- "type": "number"
- },
- "include_obligations_partner_sponsorship_include_payments_unit": {
- "enum": [
- "U.S. Dollars",
- "percent"
- ],
- "type": "string"
- },
- "include_payment_process": {
- "type": "boolean"
- },
- "include_payment_process_company": {
- "type": "boolean"
- },
- "include_payment_process_company_include_address": {
- "type": "boolean"
- },
- "include_payment_process_company_include_address_city": {
- "type": "string"
- },
- "include_payment_process_company_include_address_country": {
- "type": "string"
- },
- "include_payment_process_company_include_address_state": {
- "type": "string"
- },
- "include_payment_process_company_include_address_street_address": {
- "type": "string"
- },
- "include_payment_process_company_include_address_zipcode": {
- "type": "string"
- },
- "include_payment_process_company_include_email": {
- "type": "boolean"
- },
- "include_payment_process_company_include_email_val": {
- "format": "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": {
- "enum": [
- "receipt",
- "date"
- ],
- "type": "string"
- },
- "include_payment_schedule_specified_unit": {
- "enum": [
- "day(s)",
- "week(s)",
- "month(s)",
- "quarter(s)",
- "year(s)"
- ],
- "type": "string"
- },
- "include_payment_schedule_type": {
- "enum": [
- "specified",
- "custom"
- ],
- "type": "string"
- },
- "negotiations_allowed": {
- "description": "Whether counterparties can propose changes to agreements created from this template.",
- "type": "boolean"
- },
- "territory_type": {
- "enum": [
- "worldwide",
- "custom"
- ],
- "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": {
- "enum": [
- "hours",
- "business days",
- "calendar days"
- ],
- "type": "string"
- },
- "breach_notification_val": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "business_associate_relationship_type": {
- "enum": [
- "provider",
- "company"
- ],
- "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": {
- "enum": [
- "signature",
- "date"
- ],
- "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": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "confidentiality_type": {
- "enum": [
- "mutual",
- "nda",
- "provider",
- "custom"
- ],
- "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": {
- "enum": [
- "month",
- "year",
- "quarter"
- ],
- "type": "string"
- },
- "include_fees_include_amount": {
- "type": "boolean"
- },
- "include_fees_include_other": {
- "type": "boolean"
- },
- "include_fees_other": {
- "type": "string"
- },
- "include_functionality": {
- "type": "boolean"
- },
- "include_functionality_val": {
- "type": "string"
- },
- "include_launch_date": {
- "type": "boolean"
- },
- "include_launch_date_custom": {
- "type": "string"
- },
- "include_launch_date_date": {
- "format": "date-time",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$",
- "type": "string"
- },
- "include_launch_date_type": {
- "enum": [
- "date",
- "custom"
- ],
- "type": "string"
- },
- "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": {
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "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.",
+ "enum": [
+ "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": {
+ "enum": [
+ "stripe",
+ "link"
+ ],
+ "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": {
+ "enum": [
+ "AWS",
+ "GCP",
+ "Azure"
+ ],
+ "type": "string"
+ },
+ "effective_date_type": {
+ "enum": [
+ "signature",
+ "date",
+ "marketplace_acceptance"
+ ],
+ "type": "string"
+ },
+ "general_cap_amount": {
+ "type": "number"
+ },
+ "general_cap_amount_type": {
+ "enum": [
+ "preceding",
+ "base",
+ "period"
+ ],
+ "type": "string"
+ },
+ "general_cap_period_currency": {
+ "type": "number"
+ },
+ "general_cap_period_qty": {
+ "type": "number"
+ },
+ "general_cap_preceding_amount": {
+ "type": "number"
+ },
+ "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": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "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": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_increased_cap_amount": {
+ "type": "boolean"
+ },
+ "include_increased_claims": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_confidentiality": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_confidentiality_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_privsec": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_privsec_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_other": {
+ "type": "boolean"
+ },
+ "include_increased_claims_indemnification_obligation": {
+ "type": "boolean"
+ },
+ "include_increased_claims_other": {
+ "type": "string"
+ },
+ "include_insurance_minimums": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_add_customer": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_add_customer_com_gen_liability": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_add_customer_cyber_liability": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_add_customer_errors_omissions": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_additional_information": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_additional_information_text": {
+ "type": "string"
+ },
+ "include_insurance_minimums_cyber_liability_aggregate": {
+ "type": "number"
+ },
+ "include_insurance_minimums_cyber_liability_minimum": {
+ "type": "number"
+ },
+ "include_insurance_minimums_employer_liability_aggregate": {
+ "type": "number"
+ },
+ "include_insurance_minimums_employer_liability_minimum": {
+ "type": "number"
+ },
+ "include_insurance_minimums_general_liability_aggregate": {
+ "type": "number"
+ },
+ "include_insurance_minimums_general_liability_minimum": {
+ "type": "number"
+ },
+ "include_insurance_minimums_include_cyber_liability": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_include_employer_liability": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_include_general_liability": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_include_workers_compensation": {
+ "type": "boolean"
+ },
+ "include_publicity_rights": {
+ "type": "boolean"
+ },
+ "include_publicity_rights_type": {
+ "enum": [
+ "public",
+ "non-public"
+ ],
+ "type": "string"
+ },
+ "include_security_policy": {
+ "type": "boolean"
+ },
+ "include_security_policy_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_security_policy_fedramp_auth": {
+ "type": "boolean"
+ },
+ "include_security_policy_hipaa": {
+ "type": "boolean"
+ },
+ "include_security_policy_hitrust": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_annual_maintenance": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_location": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_other": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_reasonable_efforts": {
+ "type": "boolean"
+ },
+ "include_security_policy_iso27001": {
+ "type": "boolean"
+ },
+ "include_security_policy_location": {
+ "type": "string"
+ },
+ "include_security_policy_other": {
+ "type": "string"
+ },
+ "include_security_policy_pci1": {
+ "type": "boolean"
+ },
+ "include_security_policy_pci2": {
+ "type": "boolean"
+ },
+ "include_security_policy_penetration_testing": {
+ "type": "boolean"
+ },
+ "include_security_policy_soc2": {
+ "type": "boolean"
+ },
+ "include_security_policy_soc2_type2": {
+ "type": "boolean"
+ },
+ "include_security_policy_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_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": {
+ "type": "number"
+ },
+ "increased_cap_amount_qty": {
+ "type": "number"
+ },
+ "increased_cap_amount_type": {
+ "enum": [
+ "qty",
+ "currency",
+ "period"
+ ],
+ "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": {
+ "enum": [
+ "automatic",
+ "invoice"
+ ],
+ "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": {
+ "enum": [
+ "Subscription Period",
+ "month",
+ "year",
+ "User",
+ "Custom unit"
+ ],
+ "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": {
+ "enum": [
+ "USD",
+ "EUR",
+ "GBP",
+ "CAD",
+ "AUD",
+ "SGD",
+ "ILS",
+ "JPY",
+ "CHF",
+ "HKD"
+ ],
+ "type": "string"
+ },
+ "fees_include_fee_increase_upon_renewal": {
+ "type": "boolean"
+ },
+ "fees_include_fee_increase_upon_renewal_fee": {
+ "type": "number"
+ },
+ "fees_include_fee_increase_upon_renewal_type": {
+ "enum": [
+ "will",
+ "may"
+ ],
+ "type": "string"
+ },
+ "fees_inclusive_of_taxes": {
+ "type": "boolean"
+ },
+ "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": {
+ "enum": [
+ "Subscription Period",
+ "month",
+ "year",
+ "User"
+ ],
+ "type": "string"
+ },
+ "include_free_trial": {
+ "type": "boolean"
+ },
+ "include_max_users": {
+ "type": "boolean"
+ },
+ "include_pilot_period": {
+ "type": "boolean"
+ },
+ "include_pilot_period_duration_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_pilot_period_duration_type": {
+ "enum": [
+ "day",
+ "week",
+ "month"
+ ],
+ "type": "string"
+ },
+ "include_pilot_period_include_fees": {
+ "type": "boolean"
+ },
+ "include_pilot_period_include_fees_amount": {
+ "type": "number"
+ },
+ "include_pilot_period_include_modifications": {
+ "type": "boolean"
+ },
+ "include_pilot_period_include_modifications_description": {
+ "type": "string"
+ },
+ "include_product_support": {
+ "type": "boolean"
+ },
+ "include_product_support_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_product_support_description": {
+ "type": "string"
+ },
+ "include_product_support_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_professional_services": {
+ "type": "boolean"
+ },
+ "include_professional_services_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_professional_services_custom_name": {
+ "type": "string"
+ },
+ "include_professional_services_description": {
+ "type": "string"
+ },
+ "include_professional_services_end_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "include_professional_services_fees_description": {
+ "type": "string"
+ },
+ "include_professional_services_include_end_date": {
+ "type": "boolean"
+ },
+ "include_professional_services_include_fees_description": {
+ "type": "boolean"
+ },
+ "include_professional_services_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_sla": {
+ "type": "boolean"
+ },
+ "include_sla_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_sla_description": {
+ "type": "string"
+ },
+ "include_sla_include_response_time": {
+ "type": "boolean"
+ },
+ "include_sla_include_response_time_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_sla_include_response_time_credit": {
+ "type": "number"
+ },
+ "include_sla_include_response_time_duration": {
+ "enum": [
+ "hour",
+ "day",
+ "week",
+ "month",
+ "hours"
+ ],
+ "type": "string"
+ },
+ "include_sla_include_response_time_support_channel": {
+ "type": "string"
+ },
+ "include_sla_include_target_uptime": {
+ "type": "boolean"
+ },
+ "include_sla_maintenance_notice": {
+ "type": "boolean"
+ },
+ "include_sla_maintenance_window": {
+ "type": "boolean"
+ },
+ "include_sla_maintenance_window_type": {
+ "enum": [
+ "standard",
+ "none"
+ ],
+ "type": "string"
+ },
+ "include_sla_standard_maintenance_notice_qty": {
+ "type": "number"
+ },
+ "include_sla_standard_maintenance_notice_unit": {
+ "enum": [
+ "hour",
+ "day",
+ "week",
+ "month"
+ ],
+ "type": "string"
+ },
+ "include_sla_standard_maintenance_window_end_time": {
+ "type": "string"
+ },
+ "include_sla_standard_maintenance_window_friday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_monday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_saturday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_start_time": {
+ "type": "string"
+ },
+ "include_sla_standard_maintenance_window_sunday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_thursday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_time_zone": {
+ "type": "string"
+ },
+ "include_sla_standard_maintenance_window_tuesday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_wednesday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_target_uptime": {
+ "type": "number"
+ },
+ "include_sla_type": {
+ "enum": [
+ "description",
+ "standard",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_subscription_start_date": {
+ "type": "boolean"
+ },
+ "include_subscription_start_date_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "include_usage_review": {
+ "type": "boolean"
+ },
+ "include_usage_review_val": {
+ "type": "string"
+ },
+ "include_use_limitations": {
+ "type": "boolean"
+ },
+ "include_use_limitations_val": {
+ "type": "string"
+ },
+ "invoice_period": {
+ "enum": [
+ "monthly",
+ "quarterly",
+ "semiannually",
+ "annually",
+ "Custom unit",
+ "Monthly",
+ "Quarterly",
+ "Semiannually",
+ "Annually"
+ ],
+ "type": "string"
+ },
+ "invoice_period_custom_unit": {
+ "type": "string"
+ },
+ "max_consumption": {
+ "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": {
+ "enum": [
+ "signature",
+ "date",
+ "other"
+ ],
+ "type": "string"
+ },
+ "payment_period": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "payment_period_timeframe": {
+ "enum": [
+ "Customer's receipt of invoice",
+ "date of invoice"
+ ],
+ "type": "string"
+ },
+ "payment_period_unit": {
+ "enum": [
+ "day(s)",
+ "week(s)",
+ "month(s)",
+ "marketplace_acceptance"
+ ],
+ "type": "string"
+ },
+ "payment_process_automatic_frequency": {
+ "enum": [
+ "monthly",
+ "quarterly",
+ "semiannually",
+ "annually"
+ ],
+ "type": "string"
+ },
+ "payment_process_type": {
+ "enum": [
+ "automatic",
+ "invoice",
+ "custom",
+ "marketplace_acceptance"
+ ],
+ "type": "string"
+ },
+ "payment_process_type_custom_val": {
+ "type": "string"
+ },
+ "payment_process_type_invoice_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "payment_process_type_invoice_custom_unit": {
+ "type": "string"
+ },
+ "payment_process_type_invoice_duration": {
+ "enum": [
+ "day",
+ "week",
+ "month",
+ "year",
+ "day(s)",
+ "week(s)",
+ "month(s)",
+ "year(s)"
+ ],
+ "type": "string"
+ },
+ "payment_process_type_invoice_duration_start": {
+ "enum": [
+ "Customer's receipt of invoice",
+ "date of invoice"
+ ],
+ "type": "string"
+ },
+ "payment_process_type_invoice_type": {
+ "enum": [
+ "monthly",
+ "quarterly",
+ "semiannually",
+ "annually",
+ "Custom unit"
+ ],
+ "type": "string"
+ },
+ "pilot_period_stripe_product_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-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": {
+ "enum": [
+ "days",
+ "subscription_end"
+ ],
+ "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": {
+ "enum": [
+ "effective_date",
+ "date"
+ ],
+ "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.",
+ "enum": [
+ "CSA"
+ ],
+ "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.",
+ "enum": [
+ "DPA"
+ ],
+ "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": {
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "type": "string"
+ },
+ "general_cap_amount": {
+ "type": "number"
+ },
+ "general_cap_amount_type": {
+ "enum": [
+ "preceding",
+ "base",
+ "period"
+ ],
+ "type": "string"
+ },
+ "general_cap_period_currency": {
+ "type": "number"
+ },
+ "general_cap_period_qty": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "general_cap_preceding_amount": {
+ "type": "number"
+ },
+ "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": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_dpa": {
+ "type": "boolean"
+ },
+ "include_dpa_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_dpa_location": {
+ "type": "string"
+ },
+ "include_dpa_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_increased_cap_amount": {
+ "type": "boolean"
+ },
+ "include_increased_claims": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_confidentiality": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_confidentiality_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_privsec": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_privsec_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_other": {
+ "type": "boolean"
+ },
+ "include_increased_claims_indemnification_obligation": {
+ "type": "boolean"
+ },
+ "include_increased_claims_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_other": {
+ "type": "string"
+ },
+ "include_provider_insurance_min": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_add_customer_com_gen_liability": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_add_customer_cyber_liability": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_add_customer_errors_omissions": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_auto_liability_aggregate": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_auto_liability_minimum": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_cyber_liability_aggregate": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_cyber_liability_minimum": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_employer_liability_aggregate": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_employer_liability_minimum": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_general_liability_aggregate": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_general_liability_minimum": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_include_add_customer": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_include_auto_liability": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_include_cyber_liability": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_include_employer_liability": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_include_general_liability": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_include_workers_comp": {
+ "type": "boolean"
+ },
+ "include_publicity_rights": {
+ "type": "boolean"
+ },
+ "include_publicity_rights_type": {
+ "enum": [
+ "public",
+ "non-public"
+ ],
+ "type": "string"
+ },
+ "include_security_policy": {
+ "type": "boolean"
+ },
+ "include_security_policy_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_security_policy_fedramp_auth": {
+ "type": "boolean"
+ },
+ "include_security_policy_hitrust": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_annual_maintenance": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_other": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_other_val": {
+ "type": "string"
+ },
+ "include_security_policy_iso27001": {
+ "type": "boolean"
+ },
+ "include_security_policy_location": {
+ "type": "string"
+ },
+ "include_security_policy_pci1": {
+ "type": "boolean"
+ },
+ "include_security_policy_pci2": {
+ "type": "boolean"
+ },
+ "include_security_policy_penetration_testing": {
+ "type": "boolean"
+ },
+ "include_security_policy_soc2_type1": {
+ "type": "boolean"
+ },
+ "include_security_policy_soc2_type2": {
+ "type": "boolean"
+ },
+ "include_security_policy_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_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": {
+ "enum": [
+ "qty",
+ "currency",
+ "period"
+ ],
+ "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": {
+ "enum": [
+ "hours",
+ "days",
+ "weeks",
+ "months"
+ ],
+ "type": "string"
+ },
+ "include_deliverables_resubmission_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_deliverables_resubmission_unit": {
+ "enum": [
+ "hours",
+ "days",
+ "weeks",
+ "months"
+ ],
+ "type": "string"
+ },
+ "include_fees_other": {
+ "type": "boolean"
+ },
+ "include_fees_other_val": {
+ "type": "string"
+ },
+ "include_fees_table": {
+ "type": "boolean"
+ },
+ "include_fees_table_total": {
+ "type": "boolean"
+ },
+ "include_fees_travel": {
+ "type": "boolean"
+ },
+ "include_fees_travel_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_fees_travel_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_fees_travel_val": {
+ "type": "string"
+ },
+ "include_third_party_customer": {
+ "type": "boolean"
+ },
+ "include_third_party_include_description": {
+ "type": "boolean"
+ },
+ "include_third_party_include_description_val": {
+ "type": "string"
+ },
+ "include_third_party_materials": {
+ "type": "boolean"
+ },
+ "include_third_party_provider": {
+ "type": "boolean"
+ },
+ "include_time_of_assignment": {
+ "type": "boolean"
+ },
+ "include_time_of_assignment_type": {
+ "enum": [
+ "created",
+ "paid"
+ ],
+ "type": "string"
+ },
+ "invoice_period_description": {
+ "type": "string"
+ },
+ "negotiations_allowed": {
+ "description": "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": {
+ "enum": [
+ "receipt",
+ "invoice",
+ "Customer's receipt of invoice",
+ "date of invoice"
+ ],
+ "type": "string"
+ },
+ "payment_period_type": {
+ "enum": [
+ "standard",
+ "other"
+ ],
+ "type": "string"
+ },
+ "payment_period_unit": {
+ "enum": [
+ "day(s)",
+ "week(s)",
+ "month(s)",
+ "quarter(s)",
+ "year(s)"
+ ],
+ "type": "string"
+ },
+ "services_description": {
+ "type": "string"
+ },
+ "sow_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "sow_date_type": {
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "type": "string"
+ },
+ "sow_term_amount": {
+ "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": {
+ "enum": [
+ "deliverables",
+ "period",
+ "date"
+ ],
+ "type": "string"
+ },
+ "sow_term_unit": {
+ "enum": [
+ "month(s)",
+ "quarter(s)",
+ "year(s)"
+ ],
+ "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.",
+ "enum": [
+ "PSA"
+ ],
+ "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": {
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "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": {
+ "enum": [
+ "default_language",
+ "description"
+ ],
+ "type": "string"
+ },
+ "include_fees_unit": {
+ "enum": [
+ "month",
+ "quarter",
+ "year",
+ "Term"
+ ],
+ "type": "string"
+ },
+ "include_program_appear_as_customer_private": {
+ "type": "boolean"
+ },
+ "include_program_appear_as_customer_public": {
+ "type": "boolean"
+ },
+ "include_program_case_study": {
+ "type": "boolean"
+ },
+ "include_program_develop_functionality": {
+ "type": "boolean"
+ },
+ "include_program_develop_functionality_val": {
+ "type": "string"
+ },
+ "include_program_discount": {
+ "type": "boolean"
+ },
+ "include_program_discount_amount": {
+ "type": "number"
+ },
+ "include_program_discount_unit": {
+ "enum": [
+ "U.S. Dollars",
+ "percent"
+ ],
+ "type": "string"
+ },
+ "include_program_participation_feedback": {
+ "type": "boolean"
+ },
+ "include_program_participation_feedback_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_program_participation_feedback_unit": {
+ "enum": [
+ "month",
+ "quarter",
+ "year",
+ "Term"
+ ],
+ "type": "string"
+ },
+ "include_program_partner_other": {
+ "type": "boolean"
+ },
+ "include_program_partner_other_val": {
+ "type": "string"
+ },
+ "include_program_provider_other": {
+ "type": "boolean"
+ },
+ "include_program_provider_other_val": {
+ "type": "string"
+ },
+ "include_program_reference": {
+ "type": "boolean"
+ },
+ "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": {
+ "enum": [
+ "day(s)",
+ "week(s)",
+ "month(s)",
+ "quarter(s)",
+ "year(s)"
+ ],
+ "type": "string"
+ },
+ "type": {
+ "description": "The type of template to create.",
+ "enum": [
+ "Design"
+ ],
+ "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": {
+ "enum": [
+ "stripe",
+ "link"
+ ],
+ "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": {
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "type": "string"
+ },
+ "general_cap_amount": {
+ "type": "number"
+ },
+ "general_cap_amount_type": {
+ "enum": [
+ "preceding",
+ "base",
+ "period"
+ ],
+ "type": "string"
+ },
+ "general_cap_period_currency": {
+ "type": "number"
+ },
+ "general_cap_period_qty": {
+ "type": "number"
+ },
+ "general_cap_preceding_amount": {
+ "type": "number"
+ },
+ "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": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_increased_cap_amount": {
+ "type": "boolean"
+ },
+ "include_increased_claims": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_confidentiality": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_confidentiality_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_other": {
+ "type": "boolean"
+ },
+ "include_increased_claims_indemnification_obligation": {
+ "type": "boolean"
+ },
+ "include_increased_claims_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_other": {
+ "type": "string"
+ },
+ "include_increased_claims_restrictions": {
+ "type": "boolean"
+ },
+ "include_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": {
+ "enum": [
+ "qty",
+ "currency",
+ "period"
+ ],
+ "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": {
+ "enum": [
+ "automatic",
+ "manual"
+ ],
+ "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": {
+ "enum": [
+ "automatic",
+ "invoice"
+ ],
+ "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": {
+ "enum": [
+ "Subscription Period",
+ "month",
+ "year",
+ "Custom unit"
+ ],
+ "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": {
+ "enum": [
+ "USD",
+ "EUR",
+ "GBP",
+ "CAD",
+ "AUD",
+ "SGD",
+ "ILS",
+ "JPY",
+ "CHF",
+ "HKD"
+ ],
+ "type": "string"
+ },
+ "fees_include_fee_increase_upon_renewal": {
+ "type": "boolean"
+ },
+ "fees_include_fee_increase_upon_renewal_fee": {
+ "type": "number"
+ },
+ "fees_include_fee_increase_upon_renewal_type": {
+ "enum": [
+ "will",
+ "may"
+ ],
+ "type": "string"
+ },
+ "fees_inclusive_of_taxes": {
+ "type": "boolean"
+ },
+ "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": {
+ "enum": [
+ "day",
+ "week",
+ "month"
+ ],
+ "type": "string"
+ },
+ "include_pilot_period_include_fees": {
+ "type": "boolean"
+ },
+ "include_pilot_period_include_fees_amount": {
+ "type": "number"
+ },
+ "include_pilot_period_include_modifications": {
+ "type": "boolean"
+ },
+ "include_pilot_period_include_modifications_description": {
+ "type": "string"
+ },
+ "include_services": {
+ "type": "boolean"
+ },
+ "include_services_description": {
+ "type": "string"
+ },
+ "negotiations_allowed": {
+ "description": "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": {
+ "enum": [
+ "signature",
+ "date",
+ "other"
+ ],
+ "type": "string"
+ },
+ "payment_process_automatic_frequency": {
+ "enum": [
+ "monthly",
+ "quarterly",
+ "semiannually",
+ "annually"
+ ],
+ "type": "string"
+ },
+ "payment_process_type": {
+ "enum": [
+ "automatic",
+ "invoice",
+ "custom"
+ ],
+ "type": "string"
+ },
+ "payment_process_type_custom_val": {
+ "type": "string"
+ },
+ "payment_process_type_invoice_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "payment_process_type_invoice_custom_unit": {
+ "type": "string"
+ },
+ "payment_process_type_invoice_duration": {
+ "enum": [
+ "day",
+ "week",
+ "month",
+ "year",
+ "day(s)",
+ "week(s)",
+ "month(s)",
+ "year(s)"
+ ],
+ "type": "string"
+ },
+ "payment_process_type_invoice_duration_start": {
+ "enum": [
+ "Customer's receipt of invoice",
+ "date of invoice"
+ ],
+ "type": "string"
+ },
+ "payment_process_type_invoice_type": {
+ "enum": [
+ "monthly",
+ "quarterly",
+ "semiannually",
+ "annually",
+ "Custom unit"
+ ],
+ "type": "string"
+ },
+ "permitted_uses_include_custom": {
+ "type": "boolean"
+ },
+ "permitted_uses_include_custom_description": {
+ "type": "string"
+ },
+ "permitted_uses_include_customers_affiliates": {
+ "type": "boolean"
+ },
+ "permitted_uses_include_internal_business": {
+ "type": "boolean"
+ },
+ "pilot_period_stripe_product_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-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": {
+ "enum": [
+ "days",
+ "subscription_end"
+ ],
+ "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": {
+ "enum": [
+ "day",
+ "week",
+ "month",
+ "year"
+ ],
+ "type": "string"
+ },
+ "warranty_period_description_duration_start": {
+ "enum": [
+ "initial delivery of the Software",
+ "delivery of the Software and each subsequent Update",
+ "the Order Date"
+ ],
+ "type": "string"
+ },
+ "warranty_period_type": {
+ "enum": [
+ "description",
+ "none"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "type": {
+ "description": "The type of template to create.",
+ "enum": [
+ "Software License"
+ ],
+ "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": {
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "type": "string"
+ },
+ "fees_type": {
+ "enum": [
+ "free",
+ "pilot_period_fees"
+ ],
+ "type": "string"
+ },
+ "general_cap_amount": {
+ "type": "number"
+ },
+ "general_cap_amount_type": {
+ "enum": [
+ "preceding",
+ "base",
+ "period"
+ ],
+ "type": "string"
+ },
+ "general_cap_period_currency": {
+ "type": "number"
+ },
+ "general_cap_period_qty": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "general_cap_preceding_amount": {
+ "type": "number"
+ },
+ "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": {
+ "enum": [
+ "description",
+ "attachment",
+ "standard"
+ ],
+ "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": {
+ "enum": [
+ "monthly",
+ "quarterly",
+ "annually",
+ "once_per_period"
+ ],
+ "type": "string"
+ },
+ "payment_process_invoice_days": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "payment_process_invoice_from": {
+ "enum": [
+ "receipt",
+ "date"
+ ],
+ "type": "string"
+ },
+ "payment_process_invoice_timeframe": {
+ "enum": [
+ "days",
+ "weeks",
+ "months",
+ "quarters",
+ "years"
+ ],
+ "type": "string"
+ },
+ "payment_process_type": {
+ "enum": [
+ "automatic",
+ "invoice"
+ ],
+ "type": "string"
+ },
+ "pilot_period_description": {
+ "type": "string"
+ },
+ "pilot_period_fees_description": {
+ "type": "string"
+ },
+ "product_description": {
+ "type": "string"
+ },
+ "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.",
+ "enum": [
+ "Pilot"
+ ],
+ "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": {
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "type": "string"
+ },
+ "general_cap_amount_currency_val": {
+ "type": "number"
+ },
+ "general_cap_amount_either_currency": {
+ "type": "number"
+ },
+ "general_cap_amount_either_multiple": {
+ "type": "number"
+ },
+ "general_cap_amount_multiple_val": {
+ "type": "number"
+ },
+ "general_cap_amount_type": {
+ "enum": [
+ "multiple",
+ "currency",
+ "either",
+ "base"
+ ],
+ "type": "string"
+ },
+ "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": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_increased_cap_amount": {
+ "type": "boolean"
+ },
+ "include_increased_cap_amount_currency": {
+ "type": "number"
+ },
+ "include_increased_cap_amount_either_currency": {
+ "type": "number"
+ },
+ "include_increased_cap_amount_either_multiple": {},
+ "include_increased_cap_amount_multiple": {},
+ "include_increased_cap_amount_type": {
+ "enum": [
+ "multiple",
+ "currency",
+ "either"
+ ],
+ "type": "string"
+ },
+ "include_increased_claims": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_confidentiality": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_confidentiality_misconduct": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_covered_claims": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_misconduct": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_other": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_other_val": {
+ "type": "string"
+ },
+ "include_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": {
+ "enum": [
+ "month(s)",
+ "quarter(s)",
+ "year(s)"
+ ],
+ "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": {
+ "enum": [
+ "date",
+ "effective date"
+ ],
+ "type": "string"
+ },
+ "include_obligations_company_brand": {
+ "type": "boolean"
+ },
+ "include_obligations_company_promotion": {
+ "type": "boolean"
+ },
+ "include_obligations_company_promotion_include_activities": {
+ "type": "boolean"
+ },
+ "include_obligations_company_promotion_include_activities_val": {
+ "type": "string"
+ },
+ "include_obligations_company_promotion_include_materials": {
+ "type": "boolean"
+ },
+ "include_obligations_company_promotion_include_materials_val": {
+ "type": "string"
+ },
+ "include_obligations_company_referral": {
+ "type": "boolean"
+ },
+ "include_obligations_company_referral_include_criteria": {
+ "type": "boolean"
+ },
+ "include_obligations_company_referral_include_criteria_val": {
+ "type": "string"
+ },
+ "include_obligations_company_referral_include_pay_sch": {
+ "type": "boolean"
+ },
+ "include_obligations_company_referral_include_pay_sch_amount": {
+ "type": "number"
+ },
+ "include_obligations_company_referral_include_pay_sch_custom": {
+ "type": "string"
+ },
+ "include_obligations_company_referral_include_pay_sch_unit": {
+ "enum": [
+ "U.S. Dollars",
+ "percent"
+ ],
+ "type": "string"
+ },
+ "include_obligations_company_sponsorship": {
+ "type": "boolean"
+ },
+ "include_obligations_company_sponsorship_include_benefits": {
+ "type": "boolean"
+ },
+ "include_obligations_company_sponsorship_include_benefits_val": {
+ "type": "string"
+ },
+ "include_obligations_company_sponsorship_include_payments": {
+ "type": "boolean"
+ },
+ "include_obligations_company_sponsorship_include_payments_amount": {
+ "type": "number"
+ },
+ "include_obligations_company_sponsorship_include_payments_unit": {
+ "enum": [
+ "U.S. Dollars",
+ "percent"
+ ],
+ "type": "string"
+ },
+ "include_obligations_partner_brand": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_promotion": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_promotion_include_activities": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_promotion_include_activities_val": {
+ "type": "string"
+ },
+ "include_obligations_partner_promotion_include_materials": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_promotion_include_materials_val": {
+ "type": "string"
+ },
+ "include_obligations_partner_referral": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_referral_include_criteria": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_referral_include_criteria_val": {
+ "type": "string"
+ },
+ "include_obligations_partner_referral_include_pay_sch": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_referral_include_pay_sch_amount": {
+ "type": "number"
+ },
+ "include_obligations_partner_referral_include_pay_sch_custom": {
+ "type": "string"
+ },
+ "include_obligations_partner_referral_include_pay_sch_unit": {
+ "enum": [
+ "U.S. Dollars",
+ "percent"
+ ],
+ "type": "string"
+ },
+ "include_obligations_partner_sponsorship": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_sponsorship_include_benefits": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_sponsorship_include_benefits_val": {
+ "type": "string"
+ },
+ "include_obligations_partner_sponsorship_include_payments": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_sponsorship_include_payments_amount": {
+ "type": "number"
+ },
+ "include_obligations_partner_sponsorship_include_payments_unit": {
+ "enum": [
+ "U.S. Dollars",
+ "percent"
+ ],
+ "type": "string"
+ },
+ "include_payment_process": {
+ "type": "boolean"
+ },
+ "include_payment_process_company": {
+ "type": "boolean"
+ },
+ "include_payment_process_company_include_address": {
+ "type": "boolean"
+ },
+ "include_payment_process_company_include_address_city": {
+ "type": "string"
+ },
+ "include_payment_process_company_include_address_country": {
+ "type": "string"
+ },
+ "include_payment_process_company_include_address_state": {
+ "type": "string"
+ },
+ "include_payment_process_company_include_address_street_address": {
+ "type": "string"
+ },
+ "include_payment_process_company_include_address_zipcode": {
+ "type": "string"
+ },
+ "include_payment_process_company_include_email": {
+ "type": "boolean"
+ },
+ "include_payment_process_company_include_email_val": {
+ "format": "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": {
+ "enum": [
+ "receipt",
+ "date"
+ ],
+ "type": "string"
+ },
+ "include_payment_schedule_specified_unit": {
+ "enum": [
+ "day(s)",
+ "week(s)",
+ "month(s)",
+ "quarter(s)",
+ "year(s)"
+ ],
+ "type": "string"
+ },
+ "include_payment_schedule_type": {
+ "enum": [
+ "specified",
+ "custom"
+ ],
+ "type": "string"
+ },
+ "negotiations_allowed": {
+ "description": "Whether counterparties can propose changes to agreements created from this template.",
+ "type": "boolean"
+ },
+ "territory_type": {
+ "enum": [
+ "worldwide",
+ "custom"
+ ],
+ "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.",
+ "enum": [
+ "Partnership"
+ ],
+ "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": {
+ "enum": [
+ "hours",
+ "business days",
+ "calendar days"
+ ],
+ "type": "string"
+ },
+ "breach_notification_val": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "business_associate_relationship_type": {
+ "enum": [
+ "provider",
+ "company"
+ ],
+ "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": {
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "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.",
+ "enum": [
+ "BAA"
+ ],
+ "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": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "confidentiality_type": {
+ "enum": [
+ "mutual",
+ "nda",
+ "provider",
+ "custom"
+ ],
+ "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": {
+ "enum": [
+ "month",
+ "year",
+ "quarter"
+ ],
+ "type": "string"
+ },
+ "include_fees_include_amount": {
+ "type": "boolean"
+ },
+ "include_fees_include_other": {
+ "type": "boolean"
+ },
+ "include_fees_other": {
+ "type": "string"
+ },
+ "include_functionality": {
+ "type": "boolean"
+ },
+ "include_functionality_val": {
+ "type": "string"
+ },
+ "include_launch_date": {
+ "type": "boolean"
+ },
+ "include_launch_date_custom": {
+ "type": "string"
+ },
+ "include_launch_date_date": {
+ "format": "date-time",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$",
+ "type": "string"
+ },
+ "include_launch_date_type": {
+ "enum": [
+ "date",
+ "custom"
+ ],
+ "type": "string"
+ },
+ "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.",
+ "enum": [
+ "LOI"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "type"
+ ],
+ "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": {
- "enum": [
- "signature",
- "date"
- ],
- "type": "string"
- },
- "framework_terms_type": {
- "type": "string"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "parent_agreement_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "underlying_agreement_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "underlying_agreement_type": {
- "type": "string"
- },
- "underlying_agreement_val": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "baa_attributes": {
- "additionalProperties": false,
- "description": "Override baa terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "aggregation_limitations_permitted": {
- "type": "boolean"
- },
- "aggregation_limitations_permitted_val": {
- "type": "string"
- },
- "breach_notification_unit": {
- "enum": [
- "hours",
- "business days",
- "calendar days"
- ],
- "type": "string"
- },
- "breach_notification_val": {
- "type": "number"
- },
- "business_associate_relationship_type": {
- "enum": [
- "provider",
- "company"
- ],
- "type": "string"
- },
- "deidentification_limitations_include_purpose": {
- "type": "boolean"
- },
- "deidentification_limitations_include_requirements": {
- "type": "boolean"
- },
- "deidentification_limitations_permitted": {
- "type": "boolean"
- },
- "deidentification_limitations_purpose_val": {
- "type": "string"
- },
- "deidentification_limitations_requirements_val": {
- "type": "string"
- },
- "designated_record_set_provider_maintains": {
- "type": "boolean"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_aggregation_limitations": {
- "type": "boolean"
- },
- "include_deidentification_limitations": {
- "type": "boolean"
- },
- "include_limitations": {
- "type": "boolean"
- },
- "include_offshore_limitations": {
- "type": "boolean"
- },
- "include_subcontract_limitations": {
- "type": "boolean"
- },
- "offshore_limitations_permitted": {
- "type": "boolean"
- },
- "offshore_limitations_permitted_val": {
- "type": "string"
- },
- "subcontract_limitations_include_notice": {
- "type": "boolean"
- },
- "subcontract_limitations_include_permission": {
- "type": "boolean"
- },
- "subcontract_limitations_notice_val": {
- "type": "string"
- },
- "subcontract_limitations_permission_val": {
- "type": "string"
- },
- "subcontract_limitations_permitted": {
- "type": "boolean"
- },
- "underlying_agreement_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "underlying_agreement_type": {
- "enum": [
- "internal",
- "external",
- "none"
- ],
- "type": "string"
- },
- "underlying_agreement_val": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "billing_email": {
- "description": "Email of the billing contact. Used when include_billing_info is true.",
- "format": "email",
- "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-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": {
- "enum": [
- "AWS",
- "GCP",
- "Azure"
- ],
- "type": "string"
- },
- "effective_date_type": {
- "enum": [
- "signature",
- "date",
- "marketplace_acceptance"
- ],
- "type": "string"
- },
- "general_cap_amount": {
- "type": "number"
- },
- "general_cap_amount_type": {
- "enum": [
- "preceding",
- "base",
- "period"
- ],
- "type": "string"
- },
- "general_cap_period_currency": {
- "type": "number"
- },
- "general_cap_period_qty": {
- "type": "number"
- },
- "general_cap_preceding_amount": {
- "type": "number"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_acceptable_use_policy": {
- "type": "boolean"
- },
- "include_acceptable_use_policy_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_acceptable_use_policy_location": {
- "type": "string"
- },
- "include_acceptable_use_policy_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_additional_warranties": {
- "type": "boolean"
- },
- "include_additional_warranties_by_customer": {
- "type": "string"
- },
- "include_additional_warranties_by_provider": {
- "type": "string"
- },
- "include_additional_warranties_include_by_customer": {
- "type": "boolean"
- },
- "include_additional_warranties_include_by_provider": {
- "type": "boolean"
- },
- "include_ai_addendum": {
- "type": "boolean"
- },
- "include_ai_addendum_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_covered_claims": {
- "type": "boolean"
- },
- "include_covered_claims_customer_claims": {
- "type": "string"
- },
- "include_covered_claims_include_customer_claims": {
- "type": "boolean"
- },
- "include_covered_claims_include_provider_claims": {
- "type": "boolean"
- },
- "include_covered_claims_provider_claims": {
- "type": "string"
- },
- "include_dpa": {
- "type": "boolean"
- },
- "include_dpa_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_dpa_location": {
- "type": "string"
- },
- "include_dpa_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_increased_cap_amount": {
- "type": "boolean"
- },
- "include_increased_claims": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_confidentiality": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_confidentiality_negligence": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_privsec": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_privsec_negligence": {
- "type": "boolean"
- },
- "include_increased_claims_include_other": {
- "type": "boolean"
- },
- "include_increased_claims_indemnification_obligation": {
- "type": "boolean"
- },
- "include_increased_claims_other": {
- "type": "string"
- },
- "include_insurance_minimums": {
- "type": "boolean"
- },
- "include_insurance_minimums_add_customer": {
- "type": "boolean"
- },
- "include_insurance_minimums_add_customer_com_gen_liability": {
- "type": "boolean"
- },
- "include_insurance_minimums_add_customer_cyber_liability": {
- "type": "boolean"
- },
- "include_insurance_minimums_add_customer_errors_omissions": {
- "type": "boolean"
- },
- "include_insurance_minimums_additional_information": {
- "type": "boolean"
- },
- "include_insurance_minimums_additional_information_text": {
- "type": "string"
- },
- "include_insurance_minimums_cyber_liability_aggregate": {
- "type": "number"
- },
- "include_insurance_minimums_cyber_liability_minimum": {
- "type": "number"
- },
- "include_insurance_minimums_employer_liability_aggregate": {
- "type": "number"
- },
- "include_insurance_minimums_employer_liability_minimum": {
- "type": "number"
- },
- "include_insurance_minimums_general_liability_aggregate": {
- "type": "number"
- },
- "include_insurance_minimums_general_liability_minimum": {
- "type": "number"
- },
- "include_insurance_minimums_include_cyber_liability": {
- "type": "boolean"
- },
- "include_insurance_minimums_include_employer_liability": {
- "type": "boolean"
- },
- "include_insurance_minimums_include_general_liability": {
- "type": "boolean"
- },
- "include_insurance_minimums_include_workers_compensation": {
- "type": "boolean"
- },
- "include_publicity_rights": {
- "type": "boolean"
- },
- "include_publicity_rights_type": {
- "enum": [
- "public",
- "non-public"
- ],
- "type": "string"
- },
- "include_security_policy": {
- "type": "boolean"
- },
- "include_security_policy_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_security_policy_fedramp_auth": {
- "type": "boolean"
- },
- "include_security_policy_hipaa": {
- "type": "boolean"
- },
- "include_security_policy_hitrust": {
- "type": "boolean"
- },
- "include_security_policy_include_annual_maintenance": {
- "type": "boolean"
- },
- "include_security_policy_include_location": {
- "type": "boolean"
- },
- "include_security_policy_include_other": {
- "type": "boolean"
- },
- "include_security_policy_include_reasonable_efforts": {
- "type": "boolean"
- },
- "include_security_policy_iso27001": {
- "type": "boolean"
- },
- "include_security_policy_location": {
- "type": "string"
- },
- "include_security_policy_other": {
- "type": "string"
- },
- "include_security_policy_pci1": {
- "type": "boolean"
- },
- "include_security_policy_pci2": {
- "type": "boolean"
- },
- "include_security_policy_penetration_testing": {
- "type": "boolean"
- },
- "include_security_policy_soc2": {
- "type": "boolean"
- },
- "include_security_policy_soc2_type2": {
- "type": "boolean"
- },
- "include_security_policy_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_supercap": {
- "description": "CSA 3.0 renamed `include_increased_cap_amount` to `include_supercap`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_increased_cap_amount`. Sending the other spelling returns a 422.",
- "type": "boolean"
- },
- "include_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": "string"
- },
- "increased_cap_amount_currency": {
- "type": "number"
- },
- "increased_cap_amount_period_currency": {
- "type": "number"
- },
- "increased_cap_amount_period_qty": {
- "type": "number"
- },
- "increased_cap_amount_qty": {
- "type": "number"
- },
- "increased_cap_amount_type": {
- "enum": [
- "qty",
- "currency",
- "period"
- ],
- "type": "string"
- },
- "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": "string"
- },
- "affiliates_as_users": {
- "type": "boolean"
- },
- "cloud_service_description": {
- "type": "string"
- },
- "consumption_units": {
- "type": "string"
- },
- "fee_amount": {
- "type": "number"
- },
- "fee_custom_unit": {
- "type": "string"
- },
- "fee_period": {
- "enum": [
- "Subscription Period",
- "month",
- "year",
- "User",
- "Custom unit"
- ],
- "type": "string"
- },
- "fees_attributes": {
- "additionalProperties": {
- "anyOf": [
- {
- "additionalProperties": false,
- "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": {
- "enum": [
- "USD",
- "EUR",
- "GBP",
- "CAD",
- "AUD",
- "SGD",
- "ILS",
- "JPY",
- "CHF",
- "HKD"
- ],
- "type": "string"
- },
- "fees_include_fee_increase_upon_renewal": {
- "type": "boolean"
- },
- "fees_include_fee_increase_upon_renewal_fee": {
- "type": "number"
- },
- "fees_include_fee_increase_upon_renewal_type": {
- "enum": [
- "will",
- "may"
- ],
- "type": "string"
- },
- "fees_inclusive_of_taxes": {
- "type": "boolean"
- },
- "framework_terms_type": {
- "enum": [
- "new",
- "existing",
- "description"
- ],
- "type": "string"
- },
- "free_trial_days": {
- "type": "number"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_additional_changes": {
- "type": "boolean"
- },
- "include_additional_parameters_or_limitations": {
- "type": "boolean"
- },
- "include_consumption": {
- "type": "boolean"
- },
- "include_fees": {
- "type": "boolean"
- },
- "include_fees_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_fees_include_attachment": {
- "type": "boolean"
- },
- "include_fees_other": {
- "type": "boolean"
- },
- "include_fees_other_val": {
- "type": "string"
- },
- "include_fees_table": {
- "type": "boolean"
- },
- "include_fees_table_period": {
- "enum": [
- "Subscription Period",
- "month",
- "year",
- "User"
- ],
- "type": "string"
- },
- "include_free_trial": {
- "type": "boolean"
- },
- "include_max_users": {
- "type": "boolean"
- },
- "include_pilot_period": {
- "type": "boolean"
- },
- "include_pilot_period_duration_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_pilot_period_duration_type": {
- "enum": [
- "day",
- "week",
- "month"
- ],
- "type": "string"
- },
- "include_pilot_period_include_fees": {
- "type": "boolean"
- },
- "include_pilot_period_include_fees_amount": {
- "type": "number"
- },
- "include_pilot_period_include_modifications": {
- "type": "boolean"
- },
- "include_pilot_period_include_modifications_description": {
- "type": "string"
- },
- "include_product_support": {
- "type": "boolean"
- },
- "include_product_support_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_product_support_description": {
- "type": "string"
- },
- "include_product_support_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_professional_services": {
- "type": "boolean"
- },
- "include_professional_services_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_professional_services_custom_name": {
- "type": "string"
- },
- "include_professional_services_description": {
- "type": "string"
- },
- "include_professional_services_end_date": {
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "include_professional_services_fees_description": {
- "type": "string"
- },
- "include_professional_services_include_end_date": {
- "type": "boolean"
- },
- "include_professional_services_include_fees_description": {
- "type": "boolean"
- },
- "include_professional_services_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_sla": {
- "type": "boolean"
- },
- "include_sla_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_sla_description": {
- "type": "string"
- },
- "include_sla_include_response_time": {
- "type": "boolean"
- },
- "include_sla_include_response_time_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_sla_include_response_time_credit": {
- "type": "number"
- },
- "include_sla_include_response_time_duration": {
- "enum": [
- "hour",
- "day",
- "week",
- "month",
- "hours"
- ],
- "type": "string"
- },
- "include_sla_include_response_time_support_channel": {
- "type": "string"
- },
- "include_sla_include_target_uptime": {
- "type": "boolean"
- },
- "include_sla_maintenance_notice": {
- "type": "boolean"
- },
- "include_sla_maintenance_window": {
- "type": "boolean"
- },
- "include_sla_maintenance_window_type": {
- "enum": [
- "standard",
- "none"
- ],
- "type": "string"
- },
- "include_sla_standard_maintenance_notice_qty": {
- "type": "number"
- },
- "include_sla_standard_maintenance_notice_unit": {
- "enum": [
- "hour",
- "day",
- "week",
- "month"
- ],
- "type": "string"
- },
- "include_sla_standard_maintenance_window_end_time": {
- "type": "string"
- },
- "include_sla_standard_maintenance_window_friday": {
- "type": "boolean"
- },
- "include_sla_standard_maintenance_window_monday": {
- "type": "boolean"
- },
- "include_sla_standard_maintenance_window_saturday": {
- "type": "boolean"
- },
- "include_sla_standard_maintenance_window_start_time": {
- "type": "string"
- },
- "include_sla_standard_maintenance_window_sunday": {
- "type": "boolean"
- },
- "include_sla_standard_maintenance_window_thursday": {
- "type": "boolean"
- },
- "include_sla_standard_maintenance_window_time_zone": {
- "type": "string"
- },
- "include_sla_standard_maintenance_window_tuesday": {
- "type": "boolean"
- },
- "include_sla_standard_maintenance_window_wednesday": {
- "type": "boolean"
- },
- "include_sla_standard_target_uptime": {
- "type": "number"
- },
- "include_sla_type": {
- "enum": [
- "description",
- "standard",
- "attachment"
- ],
- "type": "string"
- },
- "include_subscription_start_date": {
- "type": "boolean"
- },
- "include_subscription_start_date_date": {
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "include_usage_review": {
- "type": "boolean"
- },
- "include_usage_review_val": {
- "type": "string"
- },
- "include_use_limitations": {
- "type": "boolean"
- },
- "include_use_limitations_val": {
- "type": "string"
- },
- "invoice_period": {
- "enum": [
- "monthly",
- "quarterly",
- "semiannually",
- "annually",
- "Custom unit",
- "Monthly",
- "Quarterly",
- "Semiannually",
- "Annually"
- ],
- "type": "string"
- },
- "invoice_period_custom_unit": {
- "type": "string"
- },
- "max_consumption": {
- "type": "number"
- },
- "max_users": {
- "type": "number"
- },
- "negotiations_allowed": {
- "type": "boolean"
- },
- "order_date_date": {
- "type": "string"
- },
- "order_date_other": {
- "type": "string"
- },
- "order_date_type": {
- "enum": [
- "signature",
- "date",
- "other"
- ],
- "type": "string"
- },
- "payment_period": {
- "type": "number"
- },
- "payment_period_timeframe": {
- "enum": [
- "Customer's receipt of invoice",
- "date of invoice"
- ],
- "type": "string"
- },
- "payment_period_unit": {
- "enum": [
- "day(s)",
- "week(s)",
- "month(s)",
- "marketplace_acceptance"
- ],
- "type": "string"
- },
- "payment_process_automatic_frequency": {
- "enum": [
- "monthly",
- "quarterly",
- "semiannually",
- "annually"
- ],
- "type": "string"
- },
- "payment_process_type": {
- "enum": [
- "automatic",
- "invoice",
- "custom",
- "marketplace_acceptance"
- ],
- "type": "string"
- },
- "payment_process_type_custom_val": {
- "type": "string"
- },
- "payment_process_type_invoice_amount": {
- "type": "number"
- },
- "payment_process_type_invoice_custom_unit": {
- "type": "string"
- },
- "payment_process_type_invoice_duration": {
- "enum": [
- "day",
- "week",
- "month",
- "year",
- "day(s)",
- "week(s)",
- "month(s)",
- "year(s)"
- ],
- "type": "string"
- },
- "payment_process_type_invoice_duration_start": {
- "enum": [
- "Customer's receipt of invoice",
- "date of invoice"
- ],
- "type": "string"
- },
- "payment_process_type_invoice_type": {
- "enum": [
- "monthly",
- "quarterly",
- "semiannually",
- "annually",
- "Custom unit"
- ],
- "type": "string"
- },
- "pilot_period_stripe_product_id": {
- "type": "string"
- },
- "service_credits_attributes": {
- "additionalProperties": {
- "additionalProperties": false,
- "properties": {
- "credit": {
- "type": "number"
- },
- "max": {
- "type": "number"
- },
- "min": {
- "type": "number"
- }
- },
- "type": "object"
- },
- "description": "Service credits. Use string keys such as \"0\", \"1\".",
- "propertyNames": {
- "type": "string"
- },
- "type": "object"
- },
- "subscription_auto_renew": {
- "enum": [
- "days",
- "subscription_end"
- ],
- "type": "string"
- },
- "subscription_period": {
- "type": "number"
- },
- "subscription_period_unit": {
- "type": "string"
- },
- "subscription_renewal_notice_days": {
- "type": "number"
- },
- "subscription_start_date": {
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "subscription_start_date_type": {
- "enum": [
- "effective_date",
- "date"
- ],
- "type": "string"
- },
- "underlying_agreement_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "use_limitations_attributes": {
- "additionalProperties": {
- "additionalProperties": false,
- "properties": {
- "amount": {
- "type": "number"
- },
- "limitation_type": {
- "type": "string"
- },
- "unit": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "description": "Use limitations. Use string keys such as \"0\", \"1\".",
- "propertyNames": {
- "type": "string"
- },
- "type": "object"
- }
- },
- "type": "object"
- },
- "custom_field_values": {
- "description": "Values for a custom template's fields, keyed by the field keys defined in the template's YAML definition. Only used when template_id is a custom template. Template defaults fill any fields you omit; a required field with no default and no submitted value returns a 400 naming the field. Values are validated against the field's input type: select and radio values must be one of the field's options, multiselect values are an array of selections each of which must be one of the field's options, number and currency values must be numeric, date values must be YYYY-MM-DD, and email values must be valid addresses. An invalid value returns a 400 naming the field."
- },
- "design_partner_attributes": {
- "additionalProperties": false,
- "description": "Override design partner terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "customer_description": {
- "type": "string"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_fees": {
- "type": "boolean"
- },
- "include_fees_amount": {
- "type": "number"
- },
- "include_fees_description": {
- "type": "string"
- },
- "include_fees_pay_by_amount": {
- "type": "string"
- },
- "include_fees_type": {
- "enum": [
- "default_language",
- "description"
- ],
- "type": "string"
- },
- "include_fees_unit": {
- "enum": [
- "month",
- "quarter",
- "year",
- "Term"
- ],
- "type": "string"
- },
- "include_program_appear_as_customer_private": {
- "type": "boolean"
- },
- "include_program_appear_as_customer_public": {
- "type": "boolean"
- },
- "include_program_case_study": {
- "type": "boolean"
- },
- "include_program_develop_functionality": {
- "type": "boolean"
- },
- "include_program_develop_functionality_val": {
- "type": "string"
- },
- "include_program_discount": {
- "type": "boolean"
- },
- "include_program_discount_amount": {
- "type": "number"
- },
- "include_program_discount_unit": {
- "enum": [
- "U.S. Dollars",
- "percent"
- ],
- "type": "string"
- },
- "include_program_participation_feedback": {
- "type": "boolean"
- },
- "include_program_participation_feedback_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_program_participation_feedback_unit": {
- "enum": [
- "month",
- "quarter",
- "year",
- "Term"
- ],
- "type": "string"
- },
- "include_program_partner_other": {
- "type": "boolean"
- },
- "include_program_partner_other_val": {
- "type": "string"
- },
- "include_program_provider_other": {
- "type": "boolean"
- },
- "include_program_provider_other_val": {
- "type": "string"
- },
- "include_program_reference": {
- "type": "boolean"
- },
- "product_description": {
- "type": "string"
- },
- "term_amount": {
- "type": "number"
- },
- "term_unit": {
- "enum": [
- "day(s)",
- "week(s)",
- "month(s)",
- "quarter(s)",
- "year(s)"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- "district_or_county": {
- "description": "The district or county for dispute resolution.",
- "type": "string"
- },
- "dpa_attributes": {
- "additionalProperties": false,
- "description": "Override dpa terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "approved_subprocessor_type": {
- "description": "`internal` lists approved subprocessors in the agreement (`subprocessors_attributes`); `external` points to a list published elsewhere.",
- "enum": [
- "internal",
- "external"
- ],
- "type": "string"
- },
- "cloud_service_product_name": {
- "type": "string"
- },
- "competent_supervisory_authority": {
- "type": "string"
- },
- "customer_description": {
- "type": "string"
- },
- "data_exporter_address_city": {
- "type": "string"
- },
- "data_exporter_address_country": {
- "type": "string"
- },
- "data_exporter_address_state": {
- "type": "string"
- },
- "data_exporter_address_street_address": {
- "type": "string"
- },
- "data_exporter_address_zipcode": {
- "type": "string"
- },
- "data_exporter_contact_details": {
- "type": "string"
- },
- "data_exporter_contact_name": {
- "type": "string"
- },
- "data_exporter_contact_position": {
- "type": "string"
- },
- "data_exporter_role": {
- "description": "Role of the data exporter. Overwritten to `Controller` when the agreement is created from a template.",
- "enum": [
- "Controller",
- "Processor"
- ],
- "type": "string"
- },
- "data_importer_address": {
- "type": "string"
- },
- "data_importer_address_city": {
- "type": "string"
- },
- "data_importer_address_country": {
- "type": "string"
- },
- "data_importer_address_state": {
- "type": "string"
- },
- "data_importer_address_street_address": {
- "type": "string"
- },
- "data_importer_address_zipcode": {
- "type": "string"
- },
- "data_importer_contact_details": {
- "type": "string"
- },
- "data_importer_contact_name": {
- "type": "string"
- },
- "data_importer_contact_position": {
- "type": "string"
- },
- "duration_of_processing": {
- "type": "string"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_covered_claim": {
- "type": "boolean"
- },
- "include_covered_claim_external_val": {
- "type": "string"
- },
- "include_covered_claim_internal_val": {
- "type": "string"
- },
- "include_covered_claim_type": {
- "description": "Which covered-claim text applies: `internal` uses `include_covered_claim_internal_val`, `external` uses `include_covered_claim_external_val`. Required when `include_covered_claim` is true.",
- "enum": [
- "internal",
- "external"
- ],
- "type": "string"
- },
- "include_data_subjects_custom": {
- "type": "boolean"
- },
- "include_data_subjects_custom_val": {
- "type": "string"
- },
- "include_data_subjects_employees": {
- "type": "boolean"
- },
- "include_data_subjects_end_users": {
- "type": "boolean"
- },
- "include_external_subprocessor_location": {
- "type": "string"
- },
- "include_frequency_of_transfer_continuous": {
- "type": "boolean"
- },
- "include_frequency_of_transfer_custom": {
- "type": "boolean"
- },
- "include_frequency_of_transfer_custom_val": {
- "type": "string"
- },
- "include_governing_country_eu": {
- "type": "boolean"
- },
- "include_governing_country_eu_val": {
- "type": "string"
- },
- "include_governing_country_uk": {
- "type": "boolean"
- },
- "include_governing_country_uk_val": {
- "type": "string"
- },
- "include_governing_law": {
- "type": "boolean"
- },
- "include_governing_law_country": {
- "type": "string"
- },
- "include_governing_law_state": {
- "type": "string"
- },
- "include_increased_claim_amount": {
- "description": "Legacy field. Stored but not shown on the DPA; use the `include_liability_cap*` fields instead.",
- "type": "boolean"
- },
- "include_increased_claim_amount_currency": {
- "description": "Legacy field. Stored but not shown on the DPA; use the `include_liability_cap*` fields instead."
- },
- "include_increased_claim_amount_qty": {
- "description": "Legacy field. Stored but not shown on the DPA; use the `include_liability_cap*` fields instead."
- },
- "include_increased_claim_amount_type": {
- "description": "Legacy field. Stored but not shown on the DPA; use the `include_liability_cap*` fields instead.",
- "type": "string"
- },
- "include_liability_cap": {
- "type": "boolean"
- },
- "include_liability_cap_amount_constant_external": {
- "type": "string"
- },
- "include_liability_cap_amount_constant_internal": {
- "type": "string"
- },
- "include_liability_cap_amount_currency_external": {
- "description": "Currency amount. Numbers and numeric strings (commas allowed) are both accepted."
- },
- "include_liability_cap_amount_currency_internal": {
- "description": "Currency amount. Numbers and numeric strings (commas allowed) are both accepted."
- },
- "include_liability_cap_csa_type": {
- "description": "Which liability cap values apply: the `_internal` or `_external` amount fields. Required when `include_liability_cap` is true.",
- "enum": [
- "internal",
- "external"
- ],
- "type": "string"
- },
- "include_personal_data_biographic_info": {
- "type": "boolean"
- },
- "include_personal_data_contact_info": {
- "type": "boolean"
- },
- "include_personal_data_custom": {
- "type": "boolean"
- },
- "include_personal_data_custom_val": {
- "type": "string"
- },
- "include_personal_data_employment_info": {
- "type": "boolean"
- },
- "include_personal_data_financial_info": {
- "type": "boolean"
- },
- "include_personal_data_location": {
- "type": "boolean"
- },
- "include_personal_data_name": {
- "type": "boolean"
- },
- "include_personal_data_transactional_info": {
- "type": "boolean"
- },
- "include_personal_data_user_activity_info": {
- "type": "boolean"
- },
- "include_processing_purpose_custom": {
- "type": "boolean"
- },
- "include_processing_purpose_custom_val": {
- "type": "string"
- },
- "include_processing_purpose_erasing": {
- "type": "boolean"
- },
- "include_processing_purpose_holding": {
- "type": "boolean"
- },
- "include_processing_purpose_protecting": {
- "type": "boolean"
- },
- "include_processing_purpose_receiving": {
- "type": "boolean"
- },
- "include_processing_purpose_returning": {
- "type": "boolean"
- },
- "include_processing_purpose_sharing": {
- "type": "boolean"
- },
- "include_processing_purpose_updating": {
- "type": "boolean"
- },
- "include_processing_purpose_using": {
- "type": "boolean"
- },
- "include_provider_security_contact_address": {
- "type": "boolean"
- },
- "include_provider_security_contact_address_city": {
- "type": "string"
- },
- "include_provider_security_contact_address_country": {
- "type": "string"
- },
- "include_provider_security_contact_address_state": {
- "type": "string"
- },
- "include_provider_security_contact_address_street_address": {
- "type": "string"
- },
- "include_provider_security_contact_address_zipcode": {
- "type": "string"
- },
- "include_provider_security_contact_email": {
- "type": "boolean"
- },
- "include_provider_security_contact_email_val": {
- "format": "email",
- "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-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": "boolean"
- },
- "confidentiality_nda_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "confidentiality_nda_description": {
- "type": "string"
- },
- "confidentiality_nda_include_loi": {
- "type": "boolean"
- },
- "confidentiality_nda_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "confidentiality_type": {
- "enum": [
- "mutual",
- "nda",
- "provider",
- "custom"
- ],
- "type": "string"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_custom_details": {
- "type": "boolean"
- },
- "include_custom_details_val": {
- "type": "string"
- },
- "include_fees": {
- "type": "boolean"
- },
- "include_fees_amount": {
- "type": "number"
- },
- "include_fees_amount_duration": {
- "enum": [
- "month",
- "year",
- "quarter"
- ],
- "type": "string"
- },
- "include_fees_include_amount": {
- "type": "boolean"
- },
- "include_fees_include_other": {
- "type": "boolean"
- },
- "include_fees_other": {
- "type": "string"
- },
- "include_functionality": {
- "type": "boolean"
- },
- "include_functionality_val": {
- "type": "string"
- },
- "include_launch_date": {
- "type": "boolean"
- },
- "include_launch_date_custom": {
- "type": "string"
- },
- "include_launch_date_date": {
- "format": "date-time",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$",
- "type": "string"
- },
- "include_launch_date_type": {
- "enum": [
- "date",
- "custom"
- ],
- "type": "string"
- },
- "product_name": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "manual_send": {
- "description": "When true, the agreement is marked as manually sent outside the platform.",
- "type": "boolean"
- },
- "message": {
- "type": "string"
- },
- "partnership_attributes": {
- "additionalProperties": false,
- "description": "Override partnership terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "effective_date": {
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "effective_date_type": {
- "enum": [
- "signature",
- "date"
- ],
- "type": "string"
- },
- "general_cap_amount_currency_val": {
- "type": "number"
- },
- "general_cap_amount_either_currency": {
- "type": "number"
- },
- "general_cap_amount_either_multiple": {
- "type": "number"
- },
- "general_cap_amount_multiple_val": {
- "type": "number"
- },
- "general_cap_amount_type": {
- "enum": [
- "multiple",
- "currency",
- "either",
- "base"
- ],
- "type": "string"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_additional_warranties": {
- "type": "boolean"
- },
- "include_additional_warranties_include_company": {
- "type": "boolean"
- },
- "include_additional_warranties_include_company_val": {
- "type": "string"
- },
- "include_additional_warranties_include_partner": {
- "type": "boolean"
- },
- "include_additional_warranties_include_partner_val": {
- "type": "string"
- },
- "include_brand_guidelines": {
- "type": "boolean"
- },
- "include_brand_guidelines_include_company": {
- "type": "boolean"
- },
- "include_brand_guidelines_include_company_val": {
- "type": "string"
- },
- "include_brand_guidelines_include_partner": {
- "type": "boolean"
- },
- "include_brand_guidelines_include_partner_val": {
- "type": "string"
- },
- "include_covered_claims": {
- "type": "boolean"
- },
- "include_covered_claims_company_claims": {
- "type": "string"
- },
- "include_covered_claims_include_company_claims": {
- "type": "boolean"
- },
- "include_covered_claims_include_partner_claims": {
- "type": "boolean"
- },
- "include_covered_claims_partner_claims": {
- "type": "string"
- },
- "include_dpa": {
- "type": "boolean"
- },
- "include_dpa_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_dpa_location": {
- "type": "string"
- },
- "include_dpa_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_increased_cap_amount": {
- "type": "boolean"
- },
- "include_increased_cap_amount_currency": {
- "type": "number"
- },
- "include_increased_cap_amount_either_currency": {
- "type": "number"
- },
- "include_increased_cap_amount_either_multiple": {
- "type": "string"
- },
- "include_increased_cap_amount_multiple": {
- "type": "string"
- },
- "include_increased_cap_amount_type": {
- "enum": [
- "multiple",
- "currency",
- "either"
- ],
- "type": "string"
- },
- "include_increased_claims": {
- "type": "boolean"
- },
- "include_increased_claims_include_confidentiality": {
- "type": "boolean"
- },
- "include_increased_claims_include_confidentiality_misconduct": {
- "type": "boolean"
- },
- "include_increased_claims_include_covered_claims": {
- "type": "boolean"
- },
- "include_increased_claims_include_misconduct": {
- "type": "boolean"
- },
- "include_increased_claims_include_other": {
- "type": "boolean"
- },
- "include_increased_claims_include_other_val": {
- "type": "string"
- },
- "include_unlimited_claims": {
- "type": "boolean"
- },
- "include_unlimited_claims_confidentiality": {
- "type": "boolean"
- },
- "include_unlimited_claims_confidentiality_misconduct": {
- "type": "boolean"
- },
- "include_unlimited_claims_covered_claims": {
- "type": "boolean"
- },
- "include_unlimited_claims_misconduct": {
- "type": "boolean"
- },
- "include_unlimited_claims_other": {
- "type": "boolean"
- },
- "include_unlimited_claims_other_val": {
- "type": "string"
- },
- "negotiations_allowed": {
- "type": "boolean"
- }
- },
- "type": "object"
- },
- "partnership_business_terms_attributes": {
- "additionalProperties": false,
- "description": "Override partnership business terms terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "end_date_after_effective_date_amount": {
- "type": "number"
- },
- "end_date_after_effective_date_unit": {
- "enum": [
- "month(s)",
- "quarter(s)",
- "year(s)"
- ],
- "type": "string"
- },
- "end_date_date": {
- "type": "string"
- },
- "end_date_type": {
- "enum": [
- "date",
- "effective date"
- ],
- "type": "string"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_obligations_company_brand": {
- "type": "boolean"
- },
- "include_obligations_company_promotion": {
- "type": "boolean"
- },
- "include_obligations_company_promotion_include_activities": {
- "type": "boolean"
- },
- "include_obligations_company_promotion_include_activities_val": {
- "type": "string"
- },
- "include_obligations_company_promotion_include_materials": {
- "type": "boolean"
- },
- "include_obligations_company_promotion_include_materials_val": {
- "type": "string"
- },
- "include_obligations_company_referral": {
- "type": "boolean"
- },
- "include_obligations_company_referral_include_criteria": {
- "type": "boolean"
- },
- "include_obligations_company_referral_include_criteria_val": {
- "type": "string"
- },
- "include_obligations_company_referral_include_pay_sch": {
- "type": "boolean"
- },
- "include_obligations_company_referral_include_pay_sch_amount": {
- "type": "number"
- },
- "include_obligations_company_referral_include_pay_sch_custom": {
- "type": "string"
- },
- "include_obligations_company_referral_include_pay_sch_unit": {
- "enum": [
- "U.S. Dollars",
- "percent"
- ],
- "type": "string"
- },
- "include_obligations_company_sponsorship": {
- "type": "boolean"
- },
- "include_obligations_company_sponsorship_include_benefits": {
- "type": "boolean"
- },
- "include_obligations_company_sponsorship_include_benefits_val": {
- "type": "string"
- },
- "include_obligations_company_sponsorship_include_payments": {
- "type": "boolean"
- },
- "include_obligations_company_sponsorship_include_payments_amount": {
- "type": "number"
- },
- "include_obligations_company_sponsorship_include_payments_unit": {
- "enum": [
- "U.S. Dollars",
- "percent"
- ],
- "type": "string"
- },
- "include_obligations_partner_brand": {
- "type": "boolean"
- },
- "include_obligations_partner_promotion": {
- "type": "boolean"
- },
- "include_obligations_partner_promotion_include_activities": {
- "type": "boolean"
- },
- "include_obligations_partner_promotion_include_activities_val": {
- "type": "string"
- },
- "include_obligations_partner_promotion_include_materials": {
- "type": "boolean"
- },
- "include_obligations_partner_promotion_include_materials_val": {
- "type": "string"
- },
- "include_obligations_partner_referral": {
- "type": "boolean"
- },
- "include_obligations_partner_referral_include_criteria": {
- "type": "boolean"
- },
- "include_obligations_partner_referral_include_criteria_val": {
- "type": "string"
- },
- "include_obligations_partner_referral_include_pay_sch": {
- "type": "boolean"
- },
- "include_obligations_partner_referral_include_pay_sch_amount": {
- "type": "number"
- },
- "include_obligations_partner_referral_include_pay_sch_custom": {
- "type": "string"
- },
- "include_obligations_partner_referral_include_pay_sch_unit": {
- "enum": [
- "U.S. Dollars",
- "percent"
- ],
- "type": "string"
- },
- "include_obligations_partner_sponsorship": {
- "type": "boolean"
- },
- "include_obligations_partner_sponsorship_include_benefits": {
- "type": "boolean"
- },
- "include_obligations_partner_sponsorship_include_benefits_val": {
- "type": "string"
- },
- "include_obligations_partner_sponsorship_include_payments": {
- "type": "boolean"
- },
- "include_obligations_partner_sponsorship_include_payments_amount": {
- "type": "number"
- },
- "include_obligations_partner_sponsorship_include_payments_unit": {
- "enum": [
- "U.S. Dollars",
- "percent"
- ],
- "type": "string"
- },
- "include_payment_process": {
- "type": "boolean"
- },
- "include_payment_process_company": {
- "type": "boolean"
- },
- "include_payment_process_company_include_address": {
- "type": "boolean"
- },
- "include_payment_process_company_include_address_city": {
- "type": "string"
- },
- "include_payment_process_company_include_address_country": {
- "type": "string"
- },
- "include_payment_process_company_include_address_state": {
- "type": "string"
- },
- "include_payment_process_company_include_address_street_address": {
- "type": "string"
- },
- "include_payment_process_company_include_address_zipcode": {
- "type": "string"
- },
- "include_payment_process_company_include_email": {
- "type": "boolean"
- },
- "include_payment_process_company_include_email_val": {
- "type": "string"
- },
- "include_payment_process_partner": {
- "type": "boolean"
- },
- "include_payment_process_partner_include_address": {
- "type": "boolean"
- },
- "include_payment_process_partner_include_address_city": {
- "type": "string"
- },
- "include_payment_process_partner_include_address_country": {
- "type": "string"
- },
- "include_payment_process_partner_include_address_state": {
- "type": "string"
- },
- "include_payment_process_partner_include_address_street_address": {
- "type": "string"
- },
- "include_payment_process_partner_include_address_zipcode": {
- "type": "string"
- },
- "include_payment_process_partner_include_email": {
- "type": "boolean"
- },
- "include_payment_process_partner_include_email_val": {
- "type": "string"
- },
- "include_payment_schedule": {
- "type": "boolean"
- },
- "include_payment_schedule_custom": {
- "type": "string"
- },
- "include_payment_schedule_specified_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_payment_schedule_specified_timeframe": {
- "enum": [
- "receipt",
- "date"
- ],
- "type": "string"
- },
- "include_payment_schedule_specified_unit": {
- "enum": [
- "day(s)",
- "week(s)",
- "month(s)",
- "quarter(s)",
- "year(s)"
- ],
- "type": "string"
- },
- "include_payment_schedule_type": {
- "enum": [
- "specified",
- "custom"
- ],
- "type": "string"
- },
- "negotiations_allowed": {
- "type": "boolean"
- },
- "territory_type": {
- "enum": [
- "worldwide",
- "custom"
- ],
- "type": "string"
- },
- "territory_type_val": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "payment_link_url": {
- "description": "A payment URL shown to the recipient after signing. Requires include_billing_workflow to be true and billing_workflow_type to be \"link\".",
- "type": "string"
- },
- "pilot_attributes": {
- "additionalProperties": false,
- "description": "Override pilot terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "fees_type": {
- "enum": [
- "free",
- "pilot_period_fees"
- ],
- "type": "string"
- },
- "general_cap_amount": {
- "type": "number"
- },
- "general_cap_amount_type": {
- "enum": [
- "preceding",
- "base",
- "period"
- ],
- "type": "string"
- },
- "general_cap_period_currency": {
- "type": "number"
- },
- "general_cap_period_qty": {
- "type": "number"
- },
- "general_cap_preceding_amount": {
- "type": "number"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_dpa": {
- "type": "boolean"
- },
- "include_dpa_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_dpa_location": {
- "type": "string"
- },
- "include_dpa_type": {
- "enum": [
- "description",
- "attachment",
- "standard"
- ],
- "type": "string"
- },
- "include_payment_process": {
- "type": "boolean"
- },
- "include_technical_support": {
- "type": "boolean"
- },
- "negotiations_allowed": {
- "type": "boolean"
- },
- "payment_process_automatic_frequency": {
- "enum": [
- "monthly",
- "quarterly",
- "annually",
- "once_per_period"
- ],
- "type": "string"
- },
- "payment_process_invoice_days": {
- "type": "number"
- },
- "payment_process_invoice_from": {
- "enum": [
- "receipt",
- "date"
- ],
- "type": "string"
- },
- "payment_process_invoice_timeframe": {
- "enum": [
- "days",
- "weeks",
- "months",
- "quarters",
- "years"
- ],
- "type": "string"
- },
- "payment_process_type": {
- "enum": [
- "automatic",
- "invoice"
- ],
- "type": "string"
- },
- "pilot_period_description": {
- "type": "string"
- },
- "pilot_period_fees_description": {
- "type": "string"
- },
- "product_description": {
- "type": "string"
- },
- "technical_support_description": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "psa_attributes": {
- "additionalProperties": false,
- "description": "Override psa terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "additional_changes": {
- "type": "string"
- },
- "customer_description": {
- "type": "string"
- },
- "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": {
- "enum": [
- "signature",
- "date"
- ],
- "type": "string"
- },
- "general_cap_amount": {
- "type": "number"
- },
- "general_cap_amount_type": {
- "enum": [
- "preceding",
- "base",
- "period"
- ],
- "type": "string"
- },
- "general_cap_period_currency": {
- "type": "number"
- },
- "general_cap_period_qty": {
- "type": "number"
- },
- "general_cap_preceding_amount": {
- "type": "number"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_additional_changes": {
- "type": "boolean"
- },
- "include_additional_warranties": {
- "type": "boolean"
- },
- "include_additional_warranties_by_customer": {
- "type": "string"
- },
- "include_additional_warranties_by_provider": {
- "type": "string"
- },
- "include_additional_warranties_include_by_customer": {
- "type": "boolean"
- },
- "include_additional_warranties_include_by_provider": {
- "type": "boolean"
- },
- "include_covered_claims": {
- "type": "boolean"
- },
- "include_covered_claims_customer_claims": {
- "type": "string"
- },
- "include_covered_claims_include_customer_claims": {
- "type": "boolean"
- },
- "include_covered_claims_include_provider_claims": {
- "type": "boolean"
- },
- "include_covered_claims_provider_claims": {
- "type": "string"
- },
- "include_customer_insurance_min": {
- "type": "boolean"
- },
- "include_customer_insurance_min_add_provider_com_gen_liability": {
- "type": "boolean"
- },
- "include_customer_insurance_min_add_provider_cyber_liability": {
- "type": "boolean"
- },
- "include_customer_insurance_min_add_provider_errors_omissions": {
- "type": "boolean"
- },
- "include_customer_insurance_min_auto_liability_aggregate": {
- "type": "number"
- },
- "include_customer_insurance_min_auto_liability_minimum": {
- "type": "number"
- },
- "include_customer_insurance_min_cyber_liability_aggregate": {
- "type": "number"
- },
- "include_customer_insurance_min_cyber_liability_minimum": {
- "type": "number"
- },
- "include_customer_insurance_min_employer_liability_aggregate": {
- "type": "number"
- },
- "include_customer_insurance_min_employer_liability_minimum": {
- "type": "number"
- },
- "include_customer_insurance_min_general_liability_aggregate": {
- "type": "number"
- },
- "include_customer_insurance_min_general_liability_minimum": {
- "type": "number"
- },
- "include_customer_insurance_min_include_add_provider": {
- "type": "boolean"
- },
- "include_customer_insurance_min_include_auto_liability": {
- "type": "boolean"
- },
- "include_customer_insurance_min_include_cyber_liability": {
- "type": "boolean"
- },
- "include_customer_insurance_min_include_employer_liability": {
- "type": "boolean"
- },
- "include_customer_insurance_min_include_general_liability": {
- "type": "boolean"
- },
- "include_customer_insurance_min_include_workers_comp": {
- "type": "boolean"
- },
- "include_customer_policies": {
- "type": "boolean"
- },
- "include_customer_policies_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_customer_policies_location": {
- "type": "string"
- },
- "include_customer_policies_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_dpa": {
- "type": "boolean"
- },
- "include_dpa_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_dpa_location": {
- "type": "string"
- },
- "include_dpa_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_increased_cap_amount": {
- "type": "boolean"
- },
- "include_increased_claims": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_confidentiality": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_confidentiality_negligence": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_privsec": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_privsec_negligence": {
- "type": "boolean"
- },
- "include_increased_claims_include_other": {
- "type": "boolean"
- },
- "include_increased_claims_indemnification_obligation": {
- "type": "boolean"
- },
- "include_increased_claims_negligence": {
- "type": "boolean"
- },
- "include_increased_claims_other": {
- "type": "string"
- },
- "include_provider_insurance_min": {
- "type": "boolean"
- },
- "include_provider_insurance_min_add_customer_com_gen_liability": {
- "type": "boolean"
- },
- "include_provider_insurance_min_add_customer_cyber_liability": {
- "type": "boolean"
- },
- "include_provider_insurance_min_add_customer_errors_omissions": {
- "type": "boolean"
- },
- "include_provider_insurance_min_auto_liability_aggregate": {
- "type": "number"
- },
- "include_provider_insurance_min_auto_liability_minimum": {
- "type": "number"
- },
- "include_provider_insurance_min_cyber_liability_aggregate": {
- "type": "number"
- },
- "include_provider_insurance_min_cyber_liability_minimum": {
- "type": "number"
- },
- "include_provider_insurance_min_employer_liability_aggregate": {
- "type": "number"
- },
- "include_provider_insurance_min_employer_liability_minimum": {
- "type": "number"
- },
- "include_provider_insurance_min_general_liability_aggregate": {
- "type": "number"
- },
- "include_provider_insurance_min_general_liability_minimum": {
- "type": "number"
- },
- "include_provider_insurance_min_include_add_customer": {
- "type": "boolean"
- },
- "include_provider_insurance_min_include_auto_liability": {
- "type": "boolean"
- },
- "include_provider_insurance_min_include_cyber_liability": {
- "type": "boolean"
- },
- "include_provider_insurance_min_include_employer_liability": {
- "type": "boolean"
- },
- "include_provider_insurance_min_include_general_liability": {
- "type": "boolean"
- },
- "include_provider_insurance_min_include_workers_comp": {
- "type": "boolean"
- },
- "include_publicity_rights": {
- "type": "boolean"
- },
- "include_publicity_rights_type": {
- "enum": [
- "public",
- "non-public"
- ],
- "type": "string"
- },
- "include_security_policy": {
- "type": "boolean"
- },
- "include_security_policy_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_security_policy_fedramp_auth": {
- "type": "boolean"
- },
- "include_security_policy_hitrust": {
- "type": "boolean"
- },
- "include_security_policy_include_annual_maintenance": {
- "type": "boolean"
- },
- "include_security_policy_include_other": {
- "type": "boolean"
- },
- "include_security_policy_include_other_val": {
- "type": "string"
- },
- "include_security_policy_iso27001": {
- "type": "boolean"
- },
- "include_security_policy_location": {
- "type": "string"
- },
- "include_security_policy_pci1": {
- "type": "boolean"
- },
- "include_security_policy_pci2": {
- "type": "boolean"
- },
- "include_security_policy_penetration_testing": {
- "type": "boolean"
- },
- "include_security_policy_soc2_type1": {
- "type": "boolean"
- },
- "include_security_policy_soc2_type2": {
- "type": "boolean"
- },
- "include_security_policy_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_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": "string"
- },
- "increased_cap_amount_currency": {
- "type": "number"
- },
- "increased_cap_amount_period_currency": {
- "type": "number"
- },
- "increased_cap_amount_period_qty": {
- "type": "number"
- },
- "increased_cap_amount_qty": {
- "type": "number"
- },
- "increased_cap_amount_type": {
- "enum": [
- "qty",
- "currency",
- "period"
- ],
- "type": "string"
- },
- "negotiations_allowed": {
- "type": "boolean"
- },
- "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": "string"
- },
- "include_deliverables": {
- "type": "boolean"
- },
- "include_deliverables_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_deliverables_description": {
- "type": "string"
- },
- "include_deliverables_include_acceptance": {
- "type": "boolean"
- },
- "include_deliverables_include_attachment": {
- "type": "boolean"
- },
- "include_deliverables_include_draft_deliverables": {
- "type": "boolean"
- },
- "include_deliverables_rejection_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_deliverables_rejection_unit": {
- "enum": [
- "hours",
- "days",
- "weeks",
- "months"
- ],
- "type": "string"
- },
- "include_deliverables_resubmission_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_deliverables_resubmission_unit": {
- "enum": [
- "hours",
- "days",
- "weeks",
- "months"
- ],
- "type": "string"
- },
- "include_fees_other": {
- "type": "boolean"
- },
- "include_fees_other_val": {
- "type": "string"
- },
- "include_fees_table": {
- "type": "boolean"
- },
- "include_fees_table_total": {
- "type": "boolean"
- },
- "include_fees_travel": {
- "type": "boolean"
- },
- "include_fees_travel_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_fees_travel_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_fees_travel_val": {
- "type": "string"
- },
- "include_third_party_customer": {
- "type": "boolean"
- },
- "include_third_party_include_description": {
- "type": "boolean"
- },
- "include_third_party_include_description_val": {
- "type": "string"
- },
- "include_third_party_materials": {
- "type": "boolean"
- },
- "include_third_party_provider": {
- "type": "boolean"
- },
- "include_time_of_assignment": {
- "type": "boolean"
- },
- "include_time_of_assignment_type": {
- "enum": [
- "created",
- "paid"
- ],
- "type": "string"
- },
- "invoice_period_description": {
- "type": "string"
- },
- "negotiations_allowed": {
- "type": "boolean"
- },
- "payment_period": {
- "type": "number"
- },
- "payment_period_other": {
- "type": "string"
- },
- "payment_period_timeframe": {
- "enum": [
- "receipt",
- "invoice",
- "Customer's receipt of invoice",
- "date of invoice"
- ],
- "type": "string"
- },
- "payment_period_type": {
- "enum": [
- "standard",
- "other"
- ],
- "type": "string"
- },
- "payment_period_unit": {
- "enum": [
- "day(s)",
- "week(s)",
- "month(s)",
- "quarter(s)",
- "year(s)"
- ],
- "type": "string"
- },
- "quantity": {
- "type": "number"
- },
- "services_description": {
- "type": "string"
- },
- "sow_date": {
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "sow_date_type": {
- "enum": [
- "signature",
- "date"
- ],
- "type": "string"
- },
- "sow_term_amount": {
- "type": "number"
- },
- "sow_term_date": {
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "sow_term_type": {
- "enum": [
- "deliverables",
- "period",
- "date"
- ],
- "type": "string"
- },
- "sow_term_unit": {
- "enum": [
- "month(s)",
- "quarter(s)",
- "year(s)"
- ],
- "type": "string"
- },
- "type": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "recipient_email": {
- "format": "email",
- "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-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": {
- "enum": [
- "signature",
- "date"
- ],
- "type": "string"
- },
- "general_cap_amount": {
- "type": "number"
- },
- "general_cap_amount_type": {
- "enum": [
- "preceding",
- "base",
- "period"
- ],
- "type": "string"
- },
- "general_cap_period_currency": {
- "type": "number"
- },
- "general_cap_period_qty": {
- "type": "number"
- },
- "general_cap_preceding_amount": {
- "type": "number"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_additional_warranties": {
- "type": "boolean"
- },
- "include_additional_warranties_by_customer": {
- "type": "string"
- },
- "include_additional_warranties_by_provider": {
- "type": "string"
- },
- "include_additional_warranties_include_by_customer": {
- "type": "boolean"
- },
- "include_additional_warranties_include_by_provider": {
- "type": "boolean"
- },
- "include_ai_addendum": {
- "type": "boolean"
- },
- "include_ai_addendum_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_covered_claims": {
- "type": "boolean"
- },
- "include_covered_claims_customer_claims": {
- "type": "string"
- },
- "include_covered_claims_include_customer_claims": {
- "type": "boolean"
- },
- "include_covered_claims_include_provider_claims": {
- "type": "boolean"
- },
- "include_covered_claims_provider_claims": {
- "type": "string"
- },
- "include_dpa": {
- "type": "boolean"
- },
- "include_dpa_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_dpa_location": {
- "type": "string"
- },
- "include_dpa_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_increased_cap_amount": {
- "type": "boolean"
- },
- "include_increased_claims": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_confidentiality": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_confidentiality_negligence": {
- "type": "boolean"
- },
- "include_increased_claims_include_other": {
- "type": "boolean"
- },
- "include_increased_claims_indemnification_obligation": {
- "type": "boolean"
- },
- "include_increased_claims_negligence": {
- "type": "boolean"
- },
- "include_increased_claims_other": {
- "type": "string"
- },
- "include_increased_claims_restrictions": {
- "type": "boolean"
- },
- "include_unlimited_claims": {
- "type": "boolean"
- },
- "include_unlimited_claims_breach_of_confidentiality": {
- "type": "boolean"
- },
- "include_unlimited_claims_breach_of_confidentiality_negligence": {
- "type": "boolean"
- },
- "include_unlimited_claims_include_other": {
- "type": "boolean"
- },
- "include_unlimited_claims_indemnification_obligation": {
- "type": "boolean"
- },
- "include_unlimited_claims_license_or_restrictions": {
- "type": "boolean"
- },
- "include_unlimited_claims_negligence": {
- "type": "boolean"
- },
- "include_unlimited_claims_other": {
- "type": "string"
- },
- "increased_cap_amount_currency": {
- "type": "number"
- },
- "increased_cap_amount_period_currency": {
- "type": "number"
- },
- "increased_cap_amount_period_qty": {
- "type": "number"
- },
- "increased_cap_amount_qty": {
- "type": "number"
- },
- "increased_cap_amount_type": {
- "enum": [
- "qty",
- "currency",
- "period"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- "software_license_order_form_attributes": {
- "additionalProperties": false,
- "description": "Override software license order form terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "additional_changes": {
- "type": "string"
- },
- "deletion_procedure_include_custom": {
- "type": "boolean"
- },
- "deletion_procedure_include_custom_description": {
- "type": "string"
- },
- "deletion_procedure_include_customer_disable": {
- "type": "boolean"
- },
- "deletion_procedure_include_customer_proof": {
- "type": "boolean"
- },
- "deletion_procedure_include_provider_disable": {
- "type": "boolean"
- },
- "fee_custom_unit": {
- "type": "string"
- },
- "fee_period": {
- "enum": [
- "Subscription Period",
- "month",
- "year",
- "Custom unit"
- ],
- "type": "string"
- },
- "fees_attributes": {
- "additionalProperties": {
- "anyOf": [
- {
- "additionalProperties": false,
- "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": {
- "enum": [
- "USD",
- "EUR",
- "GBP",
- "CAD",
- "AUD",
- "SGD",
- "ILS",
- "JPY",
- "CHF",
- "HKD"
- ],
- "type": "string"
- },
- "fees_include_fee_increase_upon_renewal": {
- "type": "boolean"
- },
- "fees_include_fee_increase_upon_renewal_fee": {
- "type": "number"
- },
- "fees_include_fee_increase_upon_renewal_type": {
- "enum": [
- "will",
- "may"
- ],
- "type": "string"
- },
- "fees_inclusive_of_taxes": {
- "type": "boolean"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_additional_changes": {
- "type": "boolean"
- },
- "include_license_compliance_verification": {
- "type": "boolean"
- },
- "include_license_compliance_verification_description": {
- "type": "string"
- },
- "include_license_limits": {
- "type": "boolean"
- },
- "include_license_limits_description": {
- "type": "string"
- },
- "include_payment_process_include_billing_email": {
- "type": "boolean"
- },
- "include_pilot_period": {
- "type": "boolean"
- },
- "include_pilot_period_duration_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_pilot_period_duration_type": {
- "enum": [
- "day",
- "week",
- "month"
- ],
- "type": "string"
- },
- "include_pilot_period_include_fees": {
- "type": "boolean"
- },
- "include_pilot_period_include_fees_amount": {
- "type": "number"
- },
- "include_pilot_period_include_modifications": {
- "type": "boolean"
- },
- "include_pilot_period_include_modifications_description": {
- "type": "string"
- },
- "include_services": {
- "type": "boolean"
- },
- "include_services_description": {
- "type": "string"
- },
- "negotiations_allowed": {
- "type": "boolean"
- },
- "order_date_date": {
- "type": "string"
- },
- "order_date_type": {
- "enum": [
- "signature",
- "date",
- "other"
- ],
- "type": "string"
- },
- "payment_process_automatic_frequency": {
- "enum": [
- "monthly",
- "quarterly",
- "semiannually",
- "annually"
- ],
- "type": "string"
- },
- "payment_process_type": {
- "enum": [
- "automatic",
- "invoice",
- "custom"
- ],
- "type": "string"
- },
- "payment_process_type_custom_val": {
- "type": "string"
- },
- "payment_process_type_invoice_amount": {
- "type": "number"
- },
- "payment_process_type_invoice_custom_unit": {
- "type": "string"
- },
- "payment_process_type_invoice_duration": {
- "enum": [
- "day",
- "week",
- "month",
- "year",
- "day(s)",
- "week(s)",
- "month(s)",
- "year(s)"
- ],
- "type": "string"
- },
- "payment_process_type_invoice_duration_start": {
- "enum": [
- "Customer's receipt of invoice",
- "date of invoice"
- ],
- "type": "string"
- },
- "payment_process_type_invoice_type": {
- "enum": [
- "monthly",
- "quarterly",
- "semiannually",
- "annually",
- "Custom unit"
- ],
- "type": "string"
- },
- "permitted_uses_include_custom": {
- "type": "boolean"
- },
- "permitted_uses_include_custom_description": {
- "type": "string"
- },
- "permitted_uses_include_customers_affiliates": {
- "type": "boolean"
- },
- "permitted_uses_include_internal_business": {
- "type": "boolean"
- },
- "pilot_period_stripe_product_id": {
- "type": "string"
- },
- "software_description": {
- "type": "string"
- },
- "subscription_auto_renew": {
- "enum": [
- "days",
- "subscription_end"
- ],
- "type": "string"
- },
- "subscription_period": {
- "type": "number"
- },
- "subscription_period_unit": {
- "type": "string"
- },
- "subscription_renewal_notice_days": {
- "type": "number"
- },
- "warranty_period_description_amount": {
- "type": "number"
- },
- "warranty_period_description_duration": {
- "enum": [
- "day",
- "week",
- "month",
- "year"
- ],
- "type": "string"
- },
- "warranty_period_description_duration_start": {
- "enum": [
- "initial delivery of the Software",
- "delivery of the Software and each subsequent Update",
- "the Order Date"
- ],
- "type": "string"
- },
- "warranty_period_type": {
- "enum": [
- "description",
- "none"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- "test_agreement": {
- "description": "When true, marks the agreement as a test. Test agreements do not count against your monthly limit.",
- "type": "boolean"
- }
- },
- "required": [
- "recipient_name",
- "recipient_email"
- ],
- "type": "object"
- },
- "cc_users": {
- "items": {
- "format": "email",
- "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-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": {
- "enum": [
- "signature",
- "date"
- ],
- "type": "string"
- },
- "framework_terms_type": {
- "type": "string"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "parent_agreement_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "underlying_agreement_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "underlying_agreement_type": {
- "type": "string"
- },
- "underlying_agreement_val": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "baa_attributes": {
- "additionalProperties": false,
- "description": "Override baa terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "aggregation_limitations_permitted": {
- "type": "boolean"
- },
- "aggregation_limitations_permitted_val": {
- "type": "string"
- },
- "breach_notification_unit": {
- "enum": [
- "hours",
- "business days",
- "calendar days"
- ],
- "type": "string"
- },
- "breach_notification_val": {
- "type": "number"
- },
- "business_associate_relationship_type": {
- "enum": [
- "provider",
- "company"
- ],
- "type": "string"
- },
- "deidentification_limitations_include_purpose": {
- "type": "boolean"
- },
- "deidentification_limitations_include_requirements": {
- "type": "boolean"
- },
- "deidentification_limitations_permitted": {
- "type": "boolean"
- },
- "deidentification_limitations_purpose_val": {
- "type": "string"
- },
- "deidentification_limitations_requirements_val": {
- "type": "string"
- },
- "designated_record_set_provider_maintains": {
- "type": "boolean"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_aggregation_limitations": {
- "type": "boolean"
- },
- "include_deidentification_limitations": {
- "type": "boolean"
- },
- "include_limitations": {
- "type": "boolean"
- },
- "include_offshore_limitations": {
- "type": "boolean"
- },
- "include_subcontract_limitations": {
- "type": "boolean"
- },
- "offshore_limitations_permitted": {
- "type": "boolean"
- },
- "offshore_limitations_permitted_val": {
- "type": "string"
- },
- "subcontract_limitations_include_notice": {
- "type": "boolean"
- },
- "subcontract_limitations_include_permission": {
- "type": "boolean"
- },
- "subcontract_limitations_notice_val": {
- "type": "string"
- },
- "subcontract_limitations_permission_val": {
- "type": "string"
- },
- "subcontract_limitations_permitted": {
- "type": "boolean"
- },
- "underlying_agreement_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "underlying_agreement_type": {
- "enum": [
- "internal",
- "external",
- "none"
- ],
- "type": "string"
- },
- "underlying_agreement_val": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "billing_email": {
- "description": "Email of the billing contact. Used when include_billing_info is true.",
- "format": "email",
- "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-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": {
- "enum": [
- "AWS",
- "GCP",
- "Azure"
- ],
- "type": "string"
- },
- "effective_date_type": {
- "enum": [
- "signature",
- "date",
- "marketplace_acceptance"
- ],
- "type": "string"
- },
- "general_cap_amount": {
- "type": "number"
- },
- "general_cap_amount_type": {
- "enum": [
- "preceding",
- "base",
- "period"
- ],
- "type": "string"
- },
- "general_cap_period_currency": {
- "type": "number"
- },
- "general_cap_period_qty": {
- "type": "number"
- },
- "general_cap_preceding_amount": {
- "type": "number"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_acceptable_use_policy": {
- "type": "boolean"
- },
- "include_acceptable_use_policy_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_acceptable_use_policy_location": {
- "type": "string"
- },
- "include_acceptable_use_policy_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_additional_warranties": {
- "type": "boolean"
- },
- "include_additional_warranties_by_customer": {
- "type": "string"
- },
- "include_additional_warranties_by_provider": {
- "type": "string"
- },
- "include_additional_warranties_include_by_customer": {
- "type": "boolean"
- },
- "include_additional_warranties_include_by_provider": {
- "type": "boolean"
- },
- "include_ai_addendum": {
- "type": "boolean"
- },
- "include_ai_addendum_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_covered_claims": {
- "type": "boolean"
- },
- "include_covered_claims_customer_claims": {
- "type": "string"
- },
- "include_covered_claims_include_customer_claims": {
- "type": "boolean"
- },
- "include_covered_claims_include_provider_claims": {
- "type": "boolean"
- },
- "include_covered_claims_provider_claims": {
- "type": "string"
- },
- "include_dpa": {
- "type": "boolean"
- },
- "include_dpa_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_dpa_location": {
- "type": "string"
- },
- "include_dpa_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_increased_cap_amount": {
- "type": "boolean"
- },
- "include_increased_claims": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_confidentiality": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_confidentiality_negligence": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_privsec": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_privsec_negligence": {
- "type": "boolean"
- },
- "include_increased_claims_include_other": {
- "type": "boolean"
- },
- "include_increased_claims_indemnification_obligation": {
- "type": "boolean"
- },
- "include_increased_claims_other": {
- "type": "string"
- },
- "include_insurance_minimums": {
- "type": "boolean"
- },
- "include_insurance_minimums_add_customer": {
- "type": "boolean"
- },
- "include_insurance_minimums_add_customer_com_gen_liability": {
- "type": "boolean"
- },
- "include_insurance_minimums_add_customer_cyber_liability": {
- "type": "boolean"
- },
- "include_insurance_minimums_add_customer_errors_omissions": {
- "type": "boolean"
- },
- "include_insurance_minimums_additional_information": {
- "type": "boolean"
- },
- "include_insurance_minimums_additional_information_text": {
- "type": "string"
- },
- "include_insurance_minimums_cyber_liability_aggregate": {
- "type": "number"
- },
- "include_insurance_minimums_cyber_liability_minimum": {
- "type": "number"
- },
- "include_insurance_minimums_employer_liability_aggregate": {
- "type": "number"
- },
- "include_insurance_minimums_employer_liability_minimum": {
- "type": "number"
- },
- "include_insurance_minimums_general_liability_aggregate": {
- "type": "number"
- },
- "include_insurance_minimums_general_liability_minimum": {
- "type": "number"
- },
- "include_insurance_minimums_include_cyber_liability": {
- "type": "boolean"
- },
- "include_insurance_minimums_include_employer_liability": {
- "type": "boolean"
- },
- "include_insurance_minimums_include_general_liability": {
- "type": "boolean"
- },
- "include_insurance_minimums_include_workers_compensation": {
- "type": "boolean"
- },
- "include_publicity_rights": {
- "type": "boolean"
- },
- "include_publicity_rights_type": {
- "enum": [
- "public",
- "non-public"
- ],
- "type": "string"
- },
- "include_security_policy": {
- "type": "boolean"
- },
- "include_security_policy_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_security_policy_fedramp_auth": {
- "type": "boolean"
- },
- "include_security_policy_hipaa": {
- "type": "boolean"
- },
- "include_security_policy_hitrust": {
- "type": "boolean"
- },
- "include_security_policy_include_annual_maintenance": {
- "type": "boolean"
- },
- "include_security_policy_include_location": {
- "type": "boolean"
- },
- "include_security_policy_include_other": {
- "type": "boolean"
- },
- "include_security_policy_include_reasonable_efforts": {
- "type": "boolean"
- },
- "include_security_policy_iso27001": {
- "type": "boolean"
- },
- "include_security_policy_location": {
- "type": "string"
- },
- "include_security_policy_other": {
- "type": "string"
- },
- "include_security_policy_pci1": {
- "type": "boolean"
- },
- "include_security_policy_pci2": {
- "type": "boolean"
- },
- "include_security_policy_penetration_testing": {
- "type": "boolean"
- },
- "include_security_policy_soc2": {
- "type": "boolean"
- },
- "include_security_policy_soc2_type2": {
- "type": "boolean"
- },
- "include_security_policy_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_supercap": {
- "description": "CSA 3.0 renamed `include_increased_cap_amount` to `include_supercap`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_increased_cap_amount`. Sending the other spelling returns a 422.",
- "type": "boolean"
- },
- "include_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": "string"
- },
- "increased_cap_amount_currency": {
- "type": "number"
- },
- "increased_cap_amount_period_currency": {
- "type": "number"
- },
- "increased_cap_amount_period_qty": {
- "type": "number"
- },
- "increased_cap_amount_qty": {
- "type": "number"
- },
- "increased_cap_amount_type": {
- "enum": [
- "qty",
- "currency",
- "period"
- ],
- "type": "string"
- },
- "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": "string"
- },
- "affiliates_as_users": {
- "type": "boolean"
- },
- "cloud_service_description": {
- "type": "string"
- },
- "consumption_units": {
- "type": "string"
- },
- "fee_amount": {
- "type": "number"
- },
- "fee_custom_unit": {
- "type": "string"
- },
- "fee_period": {
- "enum": [
- "Subscription Period",
- "month",
- "year",
- "User",
- "Custom unit"
- ],
- "type": "string"
- },
- "fees_attributes": {
- "additionalProperties": {
- "anyOf": [
- {
- "additionalProperties": false,
- "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": {
- "enum": [
- "USD",
- "EUR",
- "GBP",
- "CAD",
- "AUD",
- "SGD",
- "ILS",
- "JPY",
- "CHF",
- "HKD"
- ],
- "type": "string"
- },
- "fees_include_fee_increase_upon_renewal": {
- "type": "boolean"
- },
- "fees_include_fee_increase_upon_renewal_fee": {
- "type": "number"
- },
- "fees_include_fee_increase_upon_renewal_type": {
- "enum": [
- "will",
- "may"
- ],
- "type": "string"
- },
- "fees_inclusive_of_taxes": {
- "type": "boolean"
- },
- "framework_terms_type": {
- "enum": [
- "new",
- "existing",
- "description"
- ],
- "type": "string"
- },
- "free_trial_days": {
- "type": "number"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_additional_changes": {
- "type": "boolean"
- },
- "include_additional_parameters_or_limitations": {
- "type": "boolean"
- },
- "include_consumption": {
- "type": "boolean"
- },
- "include_fees": {
- "type": "boolean"
- },
- "include_fees_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_fees_include_attachment": {
- "type": "boolean"
- },
- "include_fees_other": {
- "type": "boolean"
- },
- "include_fees_other_val": {
- "type": "string"
- },
- "include_fees_table": {
- "type": "boolean"
- },
- "include_fees_table_period": {
- "enum": [
- "Subscription Period",
- "month",
- "year",
- "User"
- ],
- "type": "string"
- },
- "include_free_trial": {
- "type": "boolean"
- },
- "include_max_users": {
- "type": "boolean"
- },
- "include_pilot_period": {
- "type": "boolean"
- },
- "include_pilot_period_duration_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_pilot_period_duration_type": {
- "enum": [
- "day",
- "week",
- "month"
- ],
- "type": "string"
- },
- "include_pilot_period_include_fees": {
- "type": "boolean"
- },
- "include_pilot_period_include_fees_amount": {
- "type": "number"
- },
- "include_pilot_period_include_modifications": {
- "type": "boolean"
- },
- "include_pilot_period_include_modifications_description": {
- "type": "string"
- },
- "include_product_support": {
- "type": "boolean"
- },
- "include_product_support_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_product_support_description": {
- "type": "string"
- },
- "include_product_support_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_professional_services": {
- "type": "boolean"
- },
- "include_professional_services_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_professional_services_custom_name": {
- "type": "string"
- },
- "include_professional_services_description": {
- "type": "string"
- },
- "include_professional_services_end_date": {
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "include_professional_services_fees_description": {
- "type": "string"
- },
- "include_professional_services_include_end_date": {
- "type": "boolean"
- },
- "include_professional_services_include_fees_description": {
- "type": "boolean"
- },
- "include_professional_services_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_sla": {
- "type": "boolean"
- },
- "include_sla_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_sla_description": {
- "type": "string"
- },
- "include_sla_include_response_time": {
- "type": "boolean"
- },
- "include_sla_include_response_time_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_sla_include_response_time_credit": {
- "type": "number"
- },
- "include_sla_include_response_time_duration": {
- "enum": [
- "hour",
- "day",
- "week",
- "month",
- "hours"
- ],
- "type": "string"
- },
- "include_sla_include_response_time_support_channel": {
- "type": "string"
- },
- "include_sla_include_target_uptime": {
- "type": "boolean"
- },
- "include_sla_maintenance_notice": {
- "type": "boolean"
- },
- "include_sla_maintenance_window": {
- "type": "boolean"
- },
- "include_sla_maintenance_window_type": {
- "enum": [
- "standard",
- "none"
- ],
- "type": "string"
- },
- "include_sla_standard_maintenance_notice_qty": {
- "type": "number"
- },
- "include_sla_standard_maintenance_notice_unit": {
- "enum": [
- "hour",
- "day",
- "week",
- "month"
- ],
- "type": "string"
- },
- "include_sla_standard_maintenance_window_end_time": {
- "type": "string"
- },
- "include_sla_standard_maintenance_window_friday": {
- "type": "boolean"
- },
- "include_sla_standard_maintenance_window_monday": {
- "type": "boolean"
- },
- "include_sla_standard_maintenance_window_saturday": {
- "type": "boolean"
- },
- "include_sla_standard_maintenance_window_start_time": {
- "type": "string"
- },
- "include_sla_standard_maintenance_window_sunday": {
- "type": "boolean"
- },
- "include_sla_standard_maintenance_window_thursday": {
- "type": "boolean"
- },
- "include_sla_standard_maintenance_window_time_zone": {
- "type": "string"
- },
- "include_sla_standard_maintenance_window_tuesday": {
- "type": "boolean"
- },
- "include_sla_standard_maintenance_window_wednesday": {
- "type": "boolean"
- },
- "include_sla_standard_target_uptime": {
- "type": "number"
- },
- "include_sla_type": {
- "enum": [
- "description",
- "standard",
- "attachment"
- ],
- "type": "string"
- },
- "include_subscription_start_date": {
- "type": "boolean"
- },
- "include_subscription_start_date_date": {
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "include_usage_review": {
- "type": "boolean"
- },
- "include_usage_review_val": {
- "type": "string"
- },
- "include_use_limitations": {
- "type": "boolean"
- },
- "include_use_limitations_val": {
- "type": "string"
- },
- "invoice_period": {
- "enum": [
- "monthly",
- "quarterly",
- "semiannually",
- "annually",
- "Custom unit",
- "Monthly",
- "Quarterly",
- "Semiannually",
- "Annually"
- ],
- "type": "string"
- },
- "invoice_period_custom_unit": {
- "type": "string"
- },
- "max_consumption": {
- "type": "number"
- },
- "max_users": {
- "type": "number"
- },
- "negotiations_allowed": {
- "type": "boolean"
- },
- "order_date_date": {
- "type": "string"
- },
- "order_date_other": {
- "type": "string"
- },
- "order_date_type": {
- "enum": [
- "signature",
- "date",
- "other"
- ],
- "type": "string"
- },
- "payment_period": {
- "type": "number"
- },
- "payment_period_timeframe": {
- "enum": [
- "Customer's receipt of invoice",
- "date of invoice"
- ],
- "type": "string"
- },
- "payment_period_unit": {
- "enum": [
- "day(s)",
- "week(s)",
- "month(s)",
- "marketplace_acceptance"
- ],
- "type": "string"
- },
- "payment_process_automatic_frequency": {
- "enum": [
- "monthly",
- "quarterly",
- "semiannually",
- "annually"
- ],
- "type": "string"
- },
- "payment_process_type": {
- "enum": [
- "automatic",
- "invoice",
- "custom",
- "marketplace_acceptance"
- ],
- "type": "string"
- },
- "payment_process_type_custom_val": {
- "type": "string"
- },
- "payment_process_type_invoice_amount": {
- "type": "number"
- },
- "payment_process_type_invoice_custom_unit": {
- "type": "string"
- },
- "payment_process_type_invoice_duration": {
- "enum": [
- "day",
- "week",
- "month",
- "year",
- "day(s)",
- "week(s)",
- "month(s)",
- "year(s)"
- ],
- "type": "string"
- },
- "payment_process_type_invoice_duration_start": {
- "enum": [
- "Customer's receipt of invoice",
- "date of invoice"
- ],
- "type": "string"
- },
- "payment_process_type_invoice_type": {
- "enum": [
- "monthly",
- "quarterly",
- "semiannually",
- "annually",
- "Custom unit"
- ],
- "type": "string"
- },
- "pilot_period_stripe_product_id": {
- "type": "string"
- },
- "service_credits_attributes": {
- "additionalProperties": {
- "additionalProperties": false,
- "properties": {
- "credit": {
- "type": "number"
- },
- "max": {
- "type": "number"
- },
- "min": {
- "type": "number"
- }
- },
- "type": "object"
- },
- "description": "Service credits. Use string keys such as \"0\", \"1\".",
- "propertyNames": {
- "type": "string"
- },
- "type": "object"
- },
- "subscription_auto_renew": {
- "enum": [
- "days",
- "subscription_end"
- ],
- "type": "string"
- },
- "subscription_period": {
- "type": "number"
- },
- "subscription_period_unit": {
- "type": "string"
- },
- "subscription_renewal_notice_days": {
- "type": "number"
- },
- "subscription_start_date": {
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "subscription_start_date_type": {
- "enum": [
- "effective_date",
- "date"
- ],
- "type": "string"
- },
- "underlying_agreement_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "use_limitations_attributes": {
- "additionalProperties": {
- "additionalProperties": false,
- "properties": {
- "amount": {
- "type": "number"
- },
- "limitation_type": {
- "type": "string"
- },
- "unit": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "description": "Use limitations. Use string keys such as \"0\", \"1\".",
- "propertyNames": {
- "type": "string"
- },
- "type": "object"
- }
- },
- "type": "object"
- },
- "custom_field_values": {
- "description": "Values for a custom template's fields, keyed by the field keys defined in the template's YAML definition. Only used when template_id is a custom template. Template defaults fill any fields you omit; a required field with no default and no submitted value returns a 400 naming the field. Values are validated against the field's input type: select and radio values must be one of the field's options, multiselect values are an array of selections each of which must be one of the field's options, number and currency values must be numeric, date values must be YYYY-MM-DD, and email values must be valid addresses. An invalid value returns a 400 naming the field."
- },
- "design_partner_attributes": {
- "additionalProperties": false,
- "description": "Override design partner terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "customer_description": {
- "type": "string"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_fees": {
- "type": "boolean"
- },
- "include_fees_amount": {
- "type": "number"
- },
- "include_fees_description": {
- "type": "string"
- },
- "include_fees_pay_by_amount": {
- "type": "string"
- },
- "include_fees_type": {
- "enum": [
- "default_language",
- "description"
- ],
- "type": "string"
- },
- "include_fees_unit": {
- "enum": [
- "month",
- "quarter",
- "year",
- "Term"
- ],
- "type": "string"
- },
- "include_program_appear_as_customer_private": {
- "type": "boolean"
- },
- "include_program_appear_as_customer_public": {
- "type": "boolean"
- },
- "include_program_case_study": {
- "type": "boolean"
- },
- "include_program_develop_functionality": {
- "type": "boolean"
- },
- "include_program_develop_functionality_val": {
- "type": "string"
- },
- "include_program_discount": {
- "type": "boolean"
- },
- "include_program_discount_amount": {
- "type": "number"
- },
- "include_program_discount_unit": {
- "enum": [
- "U.S. Dollars",
- "percent"
- ],
- "type": "string"
- },
- "include_program_participation_feedback": {
- "type": "boolean"
- },
- "include_program_participation_feedback_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_program_participation_feedback_unit": {
- "enum": [
- "month",
- "quarter",
- "year",
- "Term"
- ],
- "type": "string"
- },
- "include_program_partner_other": {
- "type": "boolean"
- },
- "include_program_partner_other_val": {
- "type": "string"
- },
- "include_program_provider_other": {
- "type": "boolean"
- },
- "include_program_provider_other_val": {
- "type": "string"
- },
- "include_program_reference": {
- "type": "boolean"
- },
- "product_description": {
- "type": "string"
- },
- "term_amount": {
- "type": "number"
- },
- "term_unit": {
- "enum": [
- "day(s)",
- "week(s)",
- "month(s)",
- "quarter(s)",
- "year(s)"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- "district_or_county": {
- "description": "The district or county for dispute resolution.",
- "type": "string"
- },
- "dpa_attributes": {
- "additionalProperties": false,
- "description": "Override dpa terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "approved_subprocessor_type": {
- "description": "`internal` lists approved subprocessors in the agreement (`subprocessors_attributes`); `external` points to a list published elsewhere.",
- "enum": [
- "internal",
- "external"
- ],
- "type": "string"
- },
- "cloud_service_product_name": {
- "type": "string"
- },
- "competent_supervisory_authority": {
- "type": "string"
- },
- "customer_description": {
- "type": "string"
- },
- "data_exporter_address_city": {
- "type": "string"
- },
- "data_exporter_address_country": {
- "type": "string"
- },
- "data_exporter_address_state": {
- "type": "string"
- },
- "data_exporter_address_street_address": {
- "type": "string"
- },
- "data_exporter_address_zipcode": {
- "type": "string"
- },
- "data_exporter_contact_details": {
- "type": "string"
- },
- "data_exporter_contact_name": {
- "type": "string"
- },
- "data_exporter_contact_position": {
- "type": "string"
- },
- "data_exporter_role": {
- "description": "Role of the data exporter. Overwritten to `Controller` when the agreement is created from a template.",
- "enum": [
- "Controller",
- "Processor"
- ],
- "type": "string"
- },
- "data_importer_address": {
- "type": "string"
- },
- "data_importer_address_city": {
- "type": "string"
- },
- "data_importer_address_country": {
- "type": "string"
- },
- "data_importer_address_state": {
- "type": "string"
- },
- "data_importer_address_street_address": {
- "type": "string"
- },
- "data_importer_address_zipcode": {
- "type": "string"
- },
- "data_importer_contact_details": {
- "type": "string"
- },
- "data_importer_contact_name": {
- "type": "string"
- },
- "data_importer_contact_position": {
- "type": "string"
- },
- "duration_of_processing": {
- "type": "string"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_covered_claim": {
- "type": "boolean"
- },
- "include_covered_claim_external_val": {
- "type": "string"
- },
- "include_covered_claim_internal_val": {
- "type": "string"
- },
- "include_covered_claim_type": {
- "description": "Which covered-claim text applies: `internal` uses `include_covered_claim_internal_val`, `external` uses `include_covered_claim_external_val`. Required when `include_covered_claim` is true.",
- "enum": [
- "internal",
- "external"
- ],
- "type": "string"
- },
- "include_data_subjects_custom": {
- "type": "boolean"
- },
- "include_data_subjects_custom_val": {
- "type": "string"
- },
- "include_data_subjects_employees": {
- "type": "boolean"
- },
- "include_data_subjects_end_users": {
- "type": "boolean"
- },
- "include_external_subprocessor_location": {
- "type": "string"
- },
- "include_frequency_of_transfer_continuous": {
- "type": "boolean"
- },
- "include_frequency_of_transfer_custom": {
- "type": "boolean"
- },
- "include_frequency_of_transfer_custom_val": {
- "type": "string"
- },
- "include_governing_country_eu": {
- "type": "boolean"
- },
- "include_governing_country_eu_val": {
- "type": "string"
- },
- "include_governing_country_uk": {
- "type": "boolean"
- },
- "include_governing_country_uk_val": {
- "type": "string"
- },
- "include_governing_law": {
- "type": "boolean"
- },
- "include_governing_law_country": {
- "type": "string"
- },
- "include_governing_law_state": {
- "type": "string"
- },
- "include_increased_claim_amount": {
- "description": "Legacy field. Stored but not shown on the DPA; use the `include_liability_cap*` fields instead.",
- "type": "boolean"
- },
- "include_increased_claim_amount_currency": {
- "description": "Legacy field. Stored but not shown on the DPA; use the `include_liability_cap*` fields instead."
- },
- "include_increased_claim_amount_qty": {
- "description": "Legacy field. Stored but not shown on the DPA; use the `include_liability_cap*` fields instead."
- },
- "include_increased_claim_amount_type": {
- "description": "Legacy field. Stored but not shown on the DPA; use the `include_liability_cap*` fields instead.",
- "type": "string"
- },
- "include_liability_cap": {
- "type": "boolean"
- },
- "include_liability_cap_amount_constant_external": {
- "type": "string"
- },
- "include_liability_cap_amount_constant_internal": {
- "type": "string"
- },
- "include_liability_cap_amount_currency_external": {
- "description": "Currency amount. Numbers and numeric strings (commas allowed) are both accepted."
- },
- "include_liability_cap_amount_currency_internal": {
- "description": "Currency amount. Numbers and numeric strings (commas allowed) are both accepted."
- },
- "include_liability_cap_csa_type": {
- "description": "Which liability cap values apply: the `_internal` or `_external` amount fields. Required when `include_liability_cap` is true.",
- "enum": [
- "internal",
- "external"
- ],
- "type": "string"
- },
- "include_personal_data_biographic_info": {
- "type": "boolean"
- },
- "include_personal_data_contact_info": {
- "type": "boolean"
- },
- "include_personal_data_custom": {
- "type": "boolean"
- },
- "include_personal_data_custom_val": {
- "type": "string"
- },
- "include_personal_data_employment_info": {
- "type": "boolean"
- },
- "include_personal_data_financial_info": {
- "type": "boolean"
- },
- "include_personal_data_location": {
- "type": "boolean"
- },
- "include_personal_data_name": {
- "type": "boolean"
- },
- "include_personal_data_transactional_info": {
- "type": "boolean"
- },
- "include_personal_data_user_activity_info": {
- "type": "boolean"
- },
- "include_processing_purpose_custom": {
- "type": "boolean"
- },
- "include_processing_purpose_custom_val": {
- "type": "string"
- },
- "include_processing_purpose_erasing": {
- "type": "boolean"
- },
- "include_processing_purpose_holding": {
- "type": "boolean"
- },
- "include_processing_purpose_protecting": {
- "type": "boolean"
- },
- "include_processing_purpose_receiving": {
- "type": "boolean"
- },
- "include_processing_purpose_returning": {
- "type": "boolean"
- },
- "include_processing_purpose_sharing": {
- "type": "boolean"
- },
- "include_processing_purpose_updating": {
- "type": "boolean"
- },
- "include_processing_purpose_using": {
- "type": "boolean"
- },
- "include_provider_security_contact_address": {
- "type": "boolean"
- },
- "include_provider_security_contact_address_city": {
- "type": "string"
- },
- "include_provider_security_contact_address_country": {
- "type": "string"
- },
- "include_provider_security_contact_address_state": {
- "type": "string"
- },
- "include_provider_security_contact_address_street_address": {
- "type": "string"
- },
- "include_provider_security_contact_address_zipcode": {
- "type": "string"
- },
- "include_provider_security_contact_email": {
- "type": "boolean"
- },
- "include_provider_security_contact_email_val": {
- "format": "email",
- "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-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": "boolean"
- },
- "confidentiality_nda_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "confidentiality_nda_description": {
- "type": "string"
- },
- "confidentiality_nda_include_loi": {
- "type": "boolean"
- },
- "confidentiality_nda_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "confidentiality_type": {
- "enum": [
- "mutual",
- "nda",
- "provider",
- "custom"
- ],
- "type": "string"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_custom_details": {
- "type": "boolean"
- },
- "include_custom_details_val": {
- "type": "string"
- },
- "include_fees": {
- "type": "boolean"
- },
- "include_fees_amount": {
- "type": "number"
- },
- "include_fees_amount_duration": {
- "enum": [
- "month",
- "year",
- "quarter"
- ],
- "type": "string"
- },
- "include_fees_include_amount": {
- "type": "boolean"
- },
- "include_fees_include_other": {
- "type": "boolean"
- },
- "include_fees_other": {
- "type": "string"
- },
- "include_functionality": {
- "type": "boolean"
- },
- "include_functionality_val": {
- "type": "string"
- },
- "include_launch_date": {
- "type": "boolean"
- },
- "include_launch_date_custom": {
- "type": "string"
- },
- "include_launch_date_date": {
- "format": "date-time",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$",
- "type": "string"
- },
- "include_launch_date_type": {
- "enum": [
- "date",
- "custom"
- ],
- "type": "string"
- },
- "product_name": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "manual_send": {
- "description": "When true, the agreement is marked as manually sent outside the platform.",
- "type": "boolean"
- },
- "message": {
- "type": "string"
- },
- "partnership_attributes": {
- "additionalProperties": false,
- "description": "Override partnership terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "effective_date": {
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "effective_date_type": {
- "enum": [
- "signature",
- "date"
- ],
- "type": "string"
- },
- "general_cap_amount_currency_val": {
- "type": "number"
- },
- "general_cap_amount_either_currency": {
- "type": "number"
- },
- "general_cap_amount_either_multiple": {
- "type": "number"
- },
- "general_cap_amount_multiple_val": {
- "type": "number"
- },
- "general_cap_amount_type": {
- "enum": [
- "multiple",
- "currency",
- "either",
- "base"
- ],
- "type": "string"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_additional_warranties": {
- "type": "boolean"
- },
- "include_additional_warranties_include_company": {
- "type": "boolean"
- },
- "include_additional_warranties_include_company_val": {
- "type": "string"
- },
- "include_additional_warranties_include_partner": {
- "type": "boolean"
- },
- "include_additional_warranties_include_partner_val": {
- "type": "string"
- },
- "include_brand_guidelines": {
- "type": "boolean"
- },
- "include_brand_guidelines_include_company": {
- "type": "boolean"
- },
- "include_brand_guidelines_include_company_val": {
- "type": "string"
- },
- "include_brand_guidelines_include_partner": {
- "type": "boolean"
- },
- "include_brand_guidelines_include_partner_val": {
- "type": "string"
- },
- "include_covered_claims": {
- "type": "boolean"
- },
- "include_covered_claims_company_claims": {
- "type": "string"
- },
- "include_covered_claims_include_company_claims": {
- "type": "boolean"
- },
- "include_covered_claims_include_partner_claims": {
- "type": "boolean"
- },
- "include_covered_claims_partner_claims": {
- "type": "string"
- },
- "include_dpa": {
- "type": "boolean"
- },
- "include_dpa_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_dpa_location": {
- "type": "string"
- },
- "include_dpa_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_increased_cap_amount": {
- "type": "boolean"
- },
- "include_increased_cap_amount_currency": {
- "type": "number"
- },
- "include_increased_cap_amount_either_currency": {
- "type": "number"
- },
- "include_increased_cap_amount_either_multiple": {
- "type": "string"
- },
- "include_increased_cap_amount_multiple": {
- "type": "string"
- },
- "include_increased_cap_amount_type": {
- "enum": [
- "multiple",
- "currency",
- "either"
- ],
- "type": "string"
- },
- "include_increased_claims": {
- "type": "boolean"
- },
- "include_increased_claims_include_confidentiality": {
- "type": "boolean"
- },
- "include_increased_claims_include_confidentiality_misconduct": {
- "type": "boolean"
- },
- "include_increased_claims_include_covered_claims": {
- "type": "boolean"
- },
- "include_increased_claims_include_misconduct": {
- "type": "boolean"
- },
- "include_increased_claims_include_other": {
- "type": "boolean"
- },
- "include_increased_claims_include_other_val": {
- "type": "string"
- },
- "include_unlimited_claims": {
- "type": "boolean"
- },
- "include_unlimited_claims_confidentiality": {
- "type": "boolean"
- },
- "include_unlimited_claims_confidentiality_misconduct": {
- "type": "boolean"
- },
- "include_unlimited_claims_covered_claims": {
- "type": "boolean"
- },
- "include_unlimited_claims_misconduct": {
- "type": "boolean"
- },
- "include_unlimited_claims_other": {
- "type": "boolean"
- },
- "include_unlimited_claims_other_val": {
- "type": "string"
- },
- "negotiations_allowed": {
- "type": "boolean"
- }
- },
- "type": "object"
- },
- "partnership_business_terms_attributes": {
- "additionalProperties": false,
- "description": "Override partnership business terms terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "end_date_after_effective_date_amount": {
- "type": "number"
- },
- "end_date_after_effective_date_unit": {
- "enum": [
- "month(s)",
- "quarter(s)",
- "year(s)"
- ],
- "type": "string"
- },
- "end_date_date": {
- "type": "string"
- },
- "end_date_type": {
- "enum": [
- "date",
- "effective date"
- ],
- "type": "string"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_obligations_company_brand": {
- "type": "boolean"
- },
- "include_obligations_company_promotion": {
- "type": "boolean"
- },
- "include_obligations_company_promotion_include_activities": {
- "type": "boolean"
- },
- "include_obligations_company_promotion_include_activities_val": {
- "type": "string"
- },
- "include_obligations_company_promotion_include_materials": {
- "type": "boolean"
- },
- "include_obligations_company_promotion_include_materials_val": {
- "type": "string"
- },
- "include_obligations_company_referral": {
- "type": "boolean"
- },
- "include_obligations_company_referral_include_criteria": {
- "type": "boolean"
- },
- "include_obligations_company_referral_include_criteria_val": {
- "type": "string"
- },
- "include_obligations_company_referral_include_pay_sch": {
- "type": "boolean"
- },
- "include_obligations_company_referral_include_pay_sch_amount": {
- "type": "number"
- },
- "include_obligations_company_referral_include_pay_sch_custom": {
- "type": "string"
- },
- "include_obligations_company_referral_include_pay_sch_unit": {
- "enum": [
- "U.S. Dollars",
- "percent"
- ],
- "type": "string"
- },
- "include_obligations_company_sponsorship": {
- "type": "boolean"
- },
- "include_obligations_company_sponsorship_include_benefits": {
- "type": "boolean"
- },
- "include_obligations_company_sponsorship_include_benefits_val": {
- "type": "string"
- },
- "include_obligations_company_sponsorship_include_payments": {
- "type": "boolean"
- },
- "include_obligations_company_sponsorship_include_payments_amount": {
- "type": "number"
- },
- "include_obligations_company_sponsorship_include_payments_unit": {
- "enum": [
- "U.S. Dollars",
- "percent"
- ],
- "type": "string"
- },
- "include_obligations_partner_brand": {
- "type": "boolean"
- },
- "include_obligations_partner_promotion": {
- "type": "boolean"
- },
- "include_obligations_partner_promotion_include_activities": {
- "type": "boolean"
- },
- "include_obligations_partner_promotion_include_activities_val": {
- "type": "string"
- },
- "include_obligations_partner_promotion_include_materials": {
- "type": "boolean"
- },
- "include_obligations_partner_promotion_include_materials_val": {
- "type": "string"
- },
- "include_obligations_partner_referral": {
- "type": "boolean"
- },
- "include_obligations_partner_referral_include_criteria": {
- "type": "boolean"
- },
- "include_obligations_partner_referral_include_criteria_val": {
- "type": "string"
- },
- "include_obligations_partner_referral_include_pay_sch": {
- "type": "boolean"
- },
- "include_obligations_partner_referral_include_pay_sch_amount": {
- "type": "number"
- },
- "include_obligations_partner_referral_include_pay_sch_custom": {
- "type": "string"
- },
- "include_obligations_partner_referral_include_pay_sch_unit": {
- "enum": [
- "U.S. Dollars",
- "percent"
- ],
- "type": "string"
- },
- "include_obligations_partner_sponsorship": {
- "type": "boolean"
- },
- "include_obligations_partner_sponsorship_include_benefits": {
- "type": "boolean"
- },
- "include_obligations_partner_sponsorship_include_benefits_val": {
- "type": "string"
- },
- "include_obligations_partner_sponsorship_include_payments": {
- "type": "boolean"
- },
- "include_obligations_partner_sponsorship_include_payments_amount": {
- "type": "number"
- },
- "include_obligations_partner_sponsorship_include_payments_unit": {
- "enum": [
- "U.S. Dollars",
- "percent"
- ],
- "type": "string"
- },
- "include_payment_process": {
- "type": "boolean"
- },
- "include_payment_process_company": {
- "type": "boolean"
- },
- "include_payment_process_company_include_address": {
- "type": "boolean"
- },
- "include_payment_process_company_include_address_city": {
- "type": "string"
- },
- "include_payment_process_company_include_address_country": {
- "type": "string"
- },
- "include_payment_process_company_include_address_state": {
- "type": "string"
- },
- "include_payment_process_company_include_address_street_address": {
- "type": "string"
- },
- "include_payment_process_company_include_address_zipcode": {
- "type": "string"
- },
- "include_payment_process_company_include_email": {
- "type": "boolean"
- },
- "include_payment_process_company_include_email_val": {
- "type": "string"
- },
- "include_payment_process_partner": {
- "type": "boolean"
- },
- "include_payment_process_partner_include_address": {
- "type": "boolean"
- },
- "include_payment_process_partner_include_address_city": {
- "type": "string"
- },
- "include_payment_process_partner_include_address_country": {
- "type": "string"
- },
- "include_payment_process_partner_include_address_state": {
- "type": "string"
- },
- "include_payment_process_partner_include_address_street_address": {
- "type": "string"
- },
- "include_payment_process_partner_include_address_zipcode": {
- "type": "string"
- },
- "include_payment_process_partner_include_email": {
- "type": "boolean"
- },
- "include_payment_process_partner_include_email_val": {
- "type": "string"
- },
- "include_payment_schedule": {
- "type": "boolean"
- },
- "include_payment_schedule_custom": {
- "type": "string"
- },
- "include_payment_schedule_specified_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_payment_schedule_specified_timeframe": {
- "enum": [
- "receipt",
- "date"
- ],
- "type": "string"
- },
- "include_payment_schedule_specified_unit": {
- "enum": [
- "day(s)",
- "week(s)",
- "month(s)",
- "quarter(s)",
- "year(s)"
- ],
- "type": "string"
- },
- "include_payment_schedule_type": {
- "enum": [
- "specified",
- "custom"
- ],
- "type": "string"
- },
- "negotiations_allowed": {
- "type": "boolean"
- },
- "territory_type": {
- "enum": [
- "worldwide",
- "custom"
- ],
- "type": "string"
- },
- "territory_type_val": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "payment_link_url": {
- "description": "A payment URL shown to the recipient after signing. Requires include_billing_workflow to be true and billing_workflow_type to be \"link\".",
- "type": "string"
- },
- "pilot_attributes": {
- "additionalProperties": false,
- "description": "Override pilot terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "fees_type": {
- "enum": [
- "free",
- "pilot_period_fees"
- ],
- "type": "string"
- },
- "general_cap_amount": {
- "type": "number"
- },
- "general_cap_amount_type": {
- "enum": [
- "preceding",
- "base",
- "period"
- ],
- "type": "string"
- },
- "general_cap_period_currency": {
- "type": "number"
- },
- "general_cap_period_qty": {
- "type": "number"
- },
- "general_cap_preceding_amount": {
- "type": "number"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_dpa": {
- "type": "boolean"
- },
- "include_dpa_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_dpa_location": {
- "type": "string"
- },
- "include_dpa_type": {
- "enum": [
- "description",
- "attachment",
- "standard"
- ],
- "type": "string"
- },
- "include_payment_process": {
- "type": "boolean"
- },
- "include_technical_support": {
- "type": "boolean"
- },
- "negotiations_allowed": {
- "type": "boolean"
- },
- "payment_process_automatic_frequency": {
- "enum": [
- "monthly",
- "quarterly",
- "annually",
- "once_per_period"
- ],
- "type": "string"
- },
- "payment_process_invoice_days": {
- "type": "number"
- },
- "payment_process_invoice_from": {
- "enum": [
- "receipt",
- "date"
- ],
- "type": "string"
- },
- "payment_process_invoice_timeframe": {
- "enum": [
- "days",
- "weeks",
- "months",
- "quarters",
- "years"
- ],
- "type": "string"
- },
- "payment_process_type": {
- "enum": [
- "automatic",
- "invoice"
- ],
- "type": "string"
- },
- "pilot_period_description": {
- "type": "string"
- },
- "pilot_period_fees_description": {
- "type": "string"
- },
- "product_description": {
- "type": "string"
- },
- "technical_support_description": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "psa_attributes": {
- "additionalProperties": false,
- "description": "Override psa terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "additional_changes": {
- "type": "string"
- },
- "customer_description": {
- "type": "string"
- },
- "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": {
- "enum": [
- "signature",
- "date"
- ],
- "type": "string"
- },
- "general_cap_amount": {
- "type": "number"
- },
- "general_cap_amount_type": {
- "enum": [
- "preceding",
- "base",
- "period"
- ],
- "type": "string"
- },
- "general_cap_period_currency": {
- "type": "number"
- },
- "general_cap_period_qty": {
- "type": "number"
- },
- "general_cap_preceding_amount": {
- "type": "number"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_additional_changes": {
- "type": "boolean"
- },
- "include_additional_warranties": {
- "type": "boolean"
- },
- "include_additional_warranties_by_customer": {
- "type": "string"
- },
- "include_additional_warranties_by_provider": {
- "type": "string"
- },
- "include_additional_warranties_include_by_customer": {
- "type": "boolean"
- },
- "include_additional_warranties_include_by_provider": {
- "type": "boolean"
- },
- "include_covered_claims": {
- "type": "boolean"
- },
- "include_covered_claims_customer_claims": {
- "type": "string"
- },
- "include_covered_claims_include_customer_claims": {
- "type": "boolean"
- },
- "include_covered_claims_include_provider_claims": {
- "type": "boolean"
- },
- "include_covered_claims_provider_claims": {
- "type": "string"
- },
- "include_customer_insurance_min": {
- "type": "boolean"
- },
- "include_customer_insurance_min_add_provider_com_gen_liability": {
- "type": "boolean"
- },
- "include_customer_insurance_min_add_provider_cyber_liability": {
- "type": "boolean"
- },
- "include_customer_insurance_min_add_provider_errors_omissions": {
- "type": "boolean"
- },
- "include_customer_insurance_min_auto_liability_aggregate": {
- "type": "number"
- },
- "include_customer_insurance_min_auto_liability_minimum": {
- "type": "number"
- },
- "include_customer_insurance_min_cyber_liability_aggregate": {
- "type": "number"
- },
- "include_customer_insurance_min_cyber_liability_minimum": {
- "type": "number"
- },
- "include_customer_insurance_min_employer_liability_aggregate": {
- "type": "number"
- },
- "include_customer_insurance_min_employer_liability_minimum": {
- "type": "number"
- },
- "include_customer_insurance_min_general_liability_aggregate": {
- "type": "number"
- },
- "include_customer_insurance_min_general_liability_minimum": {
- "type": "number"
- },
- "include_customer_insurance_min_include_add_provider": {
- "type": "boolean"
- },
- "include_customer_insurance_min_include_auto_liability": {
- "type": "boolean"
- },
- "include_customer_insurance_min_include_cyber_liability": {
- "type": "boolean"
- },
- "include_customer_insurance_min_include_employer_liability": {
- "type": "boolean"
- },
- "include_customer_insurance_min_include_general_liability": {
- "type": "boolean"
- },
- "include_customer_insurance_min_include_workers_comp": {
- "type": "boolean"
- },
- "include_customer_policies": {
- "type": "boolean"
- },
- "include_customer_policies_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_customer_policies_location": {
- "type": "string"
- },
- "include_customer_policies_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_dpa": {
- "type": "boolean"
- },
- "include_dpa_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_dpa_location": {
- "type": "string"
- },
- "include_dpa_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_increased_cap_amount": {
- "type": "boolean"
- },
- "include_increased_claims": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_confidentiality": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_confidentiality_negligence": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_privsec": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_privsec_negligence": {
- "type": "boolean"
- },
- "include_increased_claims_include_other": {
- "type": "boolean"
- },
- "include_increased_claims_indemnification_obligation": {
- "type": "boolean"
- },
- "include_increased_claims_negligence": {
- "type": "boolean"
- },
- "include_increased_claims_other": {
- "type": "string"
- },
- "include_provider_insurance_min": {
- "type": "boolean"
- },
- "include_provider_insurance_min_add_customer_com_gen_liability": {
- "type": "boolean"
- },
- "include_provider_insurance_min_add_customer_cyber_liability": {
- "type": "boolean"
- },
- "include_provider_insurance_min_add_customer_errors_omissions": {
- "type": "boolean"
- },
- "include_provider_insurance_min_auto_liability_aggregate": {
- "type": "number"
- },
- "include_provider_insurance_min_auto_liability_minimum": {
- "type": "number"
- },
- "include_provider_insurance_min_cyber_liability_aggregate": {
- "type": "number"
- },
- "include_provider_insurance_min_cyber_liability_minimum": {
- "type": "number"
- },
- "include_provider_insurance_min_employer_liability_aggregate": {
- "type": "number"
- },
- "include_provider_insurance_min_employer_liability_minimum": {
- "type": "number"
- },
- "include_provider_insurance_min_general_liability_aggregate": {
- "type": "number"
- },
- "include_provider_insurance_min_general_liability_minimum": {
- "type": "number"
- },
- "include_provider_insurance_min_include_add_customer": {
- "type": "boolean"
- },
- "include_provider_insurance_min_include_auto_liability": {
- "type": "boolean"
- },
- "include_provider_insurance_min_include_cyber_liability": {
- "type": "boolean"
- },
- "include_provider_insurance_min_include_employer_liability": {
- "type": "boolean"
- },
- "include_provider_insurance_min_include_general_liability": {
- "type": "boolean"
- },
- "include_provider_insurance_min_include_workers_comp": {
- "type": "boolean"
- },
- "include_publicity_rights": {
- "type": "boolean"
- },
- "include_publicity_rights_type": {
- "enum": [
- "public",
- "non-public"
- ],
- "type": "string"
- },
- "include_security_policy": {
- "type": "boolean"
- },
- "include_security_policy_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_security_policy_fedramp_auth": {
- "type": "boolean"
- },
- "include_security_policy_hitrust": {
- "type": "boolean"
- },
- "include_security_policy_include_annual_maintenance": {
- "type": "boolean"
- },
- "include_security_policy_include_other": {
- "type": "boolean"
- },
- "include_security_policy_include_other_val": {
- "type": "string"
- },
- "include_security_policy_iso27001": {
- "type": "boolean"
- },
- "include_security_policy_location": {
- "type": "string"
- },
- "include_security_policy_pci1": {
- "type": "boolean"
- },
- "include_security_policy_pci2": {
- "type": "boolean"
- },
- "include_security_policy_penetration_testing": {
- "type": "boolean"
- },
- "include_security_policy_soc2_type1": {
- "type": "boolean"
- },
- "include_security_policy_soc2_type2": {
- "type": "boolean"
- },
- "include_security_policy_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_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": "string"
- },
- "increased_cap_amount_currency": {
- "type": "number"
- },
- "increased_cap_amount_period_currency": {
- "type": "number"
- },
- "increased_cap_amount_period_qty": {
- "type": "number"
- },
- "increased_cap_amount_qty": {
- "type": "number"
- },
- "increased_cap_amount_type": {
- "enum": [
- "qty",
- "currency",
- "period"
- ],
- "type": "string"
- },
- "negotiations_allowed": {
- "type": "boolean"
- },
- "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": "string"
- },
- "include_deliverables": {
- "type": "boolean"
- },
- "include_deliverables_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_deliverables_description": {
- "type": "string"
- },
- "include_deliverables_include_acceptance": {
- "type": "boolean"
- },
- "include_deliverables_include_attachment": {
- "type": "boolean"
- },
- "include_deliverables_include_draft_deliverables": {
- "type": "boolean"
- },
- "include_deliverables_rejection_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_deliverables_rejection_unit": {
- "enum": [
- "hours",
- "days",
- "weeks",
- "months"
- ],
- "type": "string"
- },
- "include_deliverables_resubmission_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_deliverables_resubmission_unit": {
- "enum": [
- "hours",
- "days",
- "weeks",
- "months"
- ],
- "type": "string"
- },
- "include_fees_other": {
- "type": "boolean"
- },
- "include_fees_other_val": {
- "type": "string"
- },
- "include_fees_table": {
- "type": "boolean"
- },
- "include_fees_table_total": {
- "type": "boolean"
- },
- "include_fees_travel": {
- "type": "boolean"
- },
- "include_fees_travel_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_fees_travel_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_fees_travel_val": {
- "type": "string"
- },
- "include_third_party_customer": {
- "type": "boolean"
- },
- "include_third_party_include_description": {
- "type": "boolean"
- },
- "include_third_party_include_description_val": {
- "type": "string"
- },
- "include_third_party_materials": {
- "type": "boolean"
- },
- "include_third_party_provider": {
- "type": "boolean"
- },
- "include_time_of_assignment": {
- "type": "boolean"
- },
- "include_time_of_assignment_type": {
- "enum": [
- "created",
- "paid"
- ],
- "type": "string"
- },
- "invoice_period_description": {
- "type": "string"
- },
- "negotiations_allowed": {
- "type": "boolean"
- },
- "payment_period": {
- "type": "number"
- },
- "payment_period_other": {
- "type": "string"
- },
- "payment_period_timeframe": {
- "enum": [
- "receipt",
- "invoice",
- "Customer's receipt of invoice",
- "date of invoice"
- ],
- "type": "string"
- },
- "payment_period_type": {
- "enum": [
- "standard",
- "other"
- ],
- "type": "string"
- },
- "payment_period_unit": {
- "enum": [
- "day(s)",
- "week(s)",
- "month(s)",
- "quarter(s)",
- "year(s)"
- ],
- "type": "string"
- },
- "quantity": {
- "type": "number"
- },
- "services_description": {
- "type": "string"
- },
- "sow_date": {
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "sow_date_type": {
- "enum": [
- "signature",
- "date"
- ],
- "type": "string"
- },
- "sow_term_amount": {
- "type": "number"
- },
- "sow_term_date": {
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "sow_term_type": {
- "enum": [
- "deliverables",
- "period",
- "date"
- ],
- "type": "string"
- },
- "sow_term_unit": {
- "enum": [
- "month(s)",
- "quarter(s)",
- "year(s)"
- ],
- "type": "string"
- },
- "type": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "recipient_email": {
- "format": "email",
- "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-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": {
- "enum": [
- "signature",
- "date"
- ],
- "type": "string"
- },
- "general_cap_amount": {
- "type": "number"
- },
- "general_cap_amount_type": {
- "enum": [
- "preceding",
- "base",
- "period"
- ],
- "type": "string"
- },
- "general_cap_period_currency": {
- "type": "number"
- },
- "general_cap_period_qty": {
- "type": "number"
- },
- "general_cap_preceding_amount": {
- "type": "number"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_additional_warranties": {
- "type": "boolean"
- },
- "include_additional_warranties_by_customer": {
- "type": "string"
- },
- "include_additional_warranties_by_provider": {
- "type": "string"
- },
- "include_additional_warranties_include_by_customer": {
- "type": "boolean"
- },
- "include_additional_warranties_include_by_provider": {
- "type": "boolean"
- },
- "include_ai_addendum": {
- "type": "boolean"
- },
- "include_ai_addendum_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_covered_claims": {
- "type": "boolean"
- },
- "include_covered_claims_customer_claims": {
- "type": "string"
- },
- "include_covered_claims_include_customer_claims": {
- "type": "boolean"
- },
- "include_covered_claims_include_provider_claims": {
- "type": "boolean"
- },
- "include_covered_claims_provider_claims": {
- "type": "string"
- },
- "include_dpa": {
- "type": "boolean"
- },
- "include_dpa_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_dpa_location": {
- "type": "string"
- },
- "include_dpa_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_increased_cap_amount": {
- "type": "boolean"
- },
- "include_increased_claims": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_confidentiality": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_confidentiality_negligence": {
- "type": "boolean"
- },
- "include_increased_claims_include_other": {
- "type": "boolean"
- },
- "include_increased_claims_indemnification_obligation": {
- "type": "boolean"
- },
- "include_increased_claims_negligence": {
- "type": "boolean"
- },
- "include_increased_claims_other": {
- "type": "string"
- },
- "include_increased_claims_restrictions": {
- "type": "boolean"
- },
- "include_unlimited_claims": {
- "type": "boolean"
- },
- "include_unlimited_claims_breach_of_confidentiality": {
- "type": "boolean"
- },
- "include_unlimited_claims_breach_of_confidentiality_negligence": {
- "type": "boolean"
- },
- "include_unlimited_claims_include_other": {
- "type": "boolean"
- },
- "include_unlimited_claims_indemnification_obligation": {
- "type": "boolean"
- },
- "include_unlimited_claims_license_or_restrictions": {
- "type": "boolean"
- },
- "include_unlimited_claims_negligence": {
- "type": "boolean"
- },
- "include_unlimited_claims_other": {
- "type": "string"
- },
- "increased_cap_amount_currency": {
- "type": "number"
- },
- "increased_cap_amount_period_currency": {
- "type": "number"
- },
- "increased_cap_amount_period_qty": {
- "type": "number"
- },
- "increased_cap_amount_qty": {
- "type": "number"
- },
- "increased_cap_amount_type": {
- "enum": [
- "qty",
- "currency",
- "period"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- "software_license_order_form_attributes": {
- "additionalProperties": false,
- "description": "Override software license order form terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "additional_changes": {
- "type": "string"
- },
- "deletion_procedure_include_custom": {
- "type": "boolean"
- },
- "deletion_procedure_include_custom_description": {
- "type": "string"
- },
- "deletion_procedure_include_customer_disable": {
- "type": "boolean"
- },
- "deletion_procedure_include_customer_proof": {
- "type": "boolean"
- },
- "deletion_procedure_include_provider_disable": {
- "type": "boolean"
- },
- "fee_custom_unit": {
- "type": "string"
- },
- "fee_period": {
- "enum": [
- "Subscription Period",
- "month",
- "year",
- "Custom unit"
- ],
- "type": "string"
- },
- "fees_attributes": {
- "additionalProperties": {
- "anyOf": [
- {
- "additionalProperties": false,
- "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": {
- "enum": [
- "USD",
- "EUR",
- "GBP",
- "CAD",
- "AUD",
- "SGD",
- "ILS",
- "JPY",
- "CHF",
- "HKD"
- ],
- "type": "string"
- },
- "fees_include_fee_increase_upon_renewal": {
- "type": "boolean"
- },
- "fees_include_fee_increase_upon_renewal_fee": {
- "type": "number"
- },
- "fees_include_fee_increase_upon_renewal_type": {
- "enum": [
- "will",
- "may"
- ],
- "type": "string"
- },
- "fees_inclusive_of_taxes": {
- "type": "boolean"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_additional_changes": {
- "type": "boolean"
- },
- "include_license_compliance_verification": {
- "type": "boolean"
- },
- "include_license_compliance_verification_description": {
- "type": "string"
- },
- "include_license_limits": {
- "type": "boolean"
- },
- "include_license_limits_description": {
- "type": "string"
- },
- "include_payment_process_include_billing_email": {
- "type": "boolean"
- },
- "include_pilot_period": {
- "type": "boolean"
- },
- "include_pilot_period_duration_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_pilot_period_duration_type": {
- "enum": [
- "day",
- "week",
- "month"
- ],
- "type": "string"
- },
- "include_pilot_period_include_fees": {
- "type": "boolean"
- },
- "include_pilot_period_include_fees_amount": {
- "type": "number"
- },
- "include_pilot_period_include_modifications": {
- "type": "boolean"
- },
- "include_pilot_period_include_modifications_description": {
- "type": "string"
- },
- "include_services": {
- "type": "boolean"
- },
- "include_services_description": {
- "type": "string"
- },
- "negotiations_allowed": {
- "type": "boolean"
- },
- "order_date_date": {
- "type": "string"
- },
- "order_date_type": {
- "enum": [
- "signature",
- "date",
- "other"
- ],
- "type": "string"
- },
- "payment_process_automatic_frequency": {
- "enum": [
- "monthly",
- "quarterly",
- "semiannually",
- "annually"
- ],
- "type": "string"
- },
- "payment_process_type": {
- "enum": [
- "automatic",
- "invoice",
- "custom"
- ],
- "type": "string"
- },
- "payment_process_type_custom_val": {
- "type": "string"
- },
- "payment_process_type_invoice_amount": {
- "type": "number"
- },
- "payment_process_type_invoice_custom_unit": {
- "type": "string"
- },
- "payment_process_type_invoice_duration": {
- "enum": [
- "day",
- "week",
- "month",
- "year",
- "day(s)",
- "week(s)",
- "month(s)",
- "year(s)"
- ],
- "type": "string"
- },
- "payment_process_type_invoice_duration_start": {
- "enum": [
- "Customer's receipt of invoice",
- "date of invoice"
- ],
- "type": "string"
- },
- "payment_process_type_invoice_type": {
- "enum": [
- "monthly",
- "quarterly",
- "semiannually",
- "annually",
- "Custom unit"
- ],
- "type": "string"
- },
- "permitted_uses_include_custom": {
- "type": "boolean"
- },
- "permitted_uses_include_custom_description": {
- "type": "string"
- },
- "permitted_uses_include_customers_affiliates": {
- "type": "boolean"
- },
- "permitted_uses_include_internal_business": {
- "type": "boolean"
- },
- "pilot_period_stripe_product_id": {
- "type": "string"
- },
- "software_description": {
- "type": "string"
- },
- "subscription_auto_renew": {
- "enum": [
- "days",
- "subscription_end"
- ],
- "type": "string"
- },
- "subscription_period": {
- "type": "number"
- },
- "subscription_period_unit": {
- "type": "string"
- },
- "subscription_renewal_notice_days": {
- "type": "number"
- },
- "warranty_period_description_amount": {
- "type": "number"
- },
- "warranty_period_description_duration": {
- "enum": [
- "day",
- "week",
- "month",
- "year"
- ],
- "type": "string"
- },
- "warranty_period_description_duration_start": {
- "enum": [
- "initial delivery of the Software",
- "delivery of the Software and each subsequent Update",
- "the Order Date"
- ],
- "type": "string"
- },
- "warranty_period_type": {
- "enum": [
- "description",
- "none"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- "test_agreement": {
- "description": "When true, marks the agreement as a test. Test agreements do not count against your monthly limit.",
- "type": "boolean"
- }
- },
- "required": [
- "recipient_name",
- "recipient_email"
- ],
- "type": "object"
- },
- "cc_users": {
- "items": {
- "format": "email",
- "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
- "type": "string"
- },
- "type": "array"
- },
- "draft": {
- "description": "When true, the agreement is saved as a draft and not sent to the recipient. Use POST /v1/agreements/{id}/send to send a draft agreement later.",
- "type": "boolean"
- },
- "owner_email": {
- "description": "Email address of the agreement owner (sender).",
- "type": "string"
- },
- "signer_id": {
- "description": "User id of the signer from the owner's organization.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "template_id": {
- "description": "UUID of a template from `GET /v1/templates`. Accepts both Common Paper standard templates and uploaded PDF templates (`type` `uploaded_template`).",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- }
- },
- "required": [
- "template_id",
- "owner_email",
- "signer_id",
- "agreement"
- ],
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "agreement": {
- "additionalProperties": {},
- "properties": {
- "amendment_attributes": {
- "additionalProperties": false,
- "description": "Override amendment terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "amended_terms_attributes": {
- "additionalProperties": {
- "additionalProperties": false,
- "properties": {
- "description": {
- "type": "string"
- },
- "term": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "description": "Amended terms. Use string keys such as \"0\", \"1\".",
- "propertyNames": {
- "type": "string"
- },
- "type": "object"
- },
- "amendment_date": {
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "amendment_date_type": {
- "enum": [
- "signature",
- "date"
- ],
- "type": "string"
- },
- "framework_terms_type": {
- "type": "string"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "parent_agreement_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "underlying_agreement_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "underlying_agreement_type": {
- "type": "string"
- },
- "underlying_agreement_val": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "baa_attributes": {
- "additionalProperties": false,
- "description": "Override baa terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "aggregation_limitations_permitted": {
- "type": "boolean"
- },
- "aggregation_limitations_permitted_val": {
- "type": "string"
- },
- "breach_notification_unit": {
- "enum": [
- "hours",
- "business days",
- "calendar days"
- ],
- "type": "string"
- },
- "breach_notification_val": {
- "type": "number"
- },
- "business_associate_relationship_type": {
- "enum": [
- "provider",
- "company"
- ],
- "type": "string"
- },
- "deidentification_limitations_include_purpose": {
- "type": "boolean"
- },
- "deidentification_limitations_include_requirements": {
- "type": "boolean"
- },
- "deidentification_limitations_permitted": {
- "type": "boolean"
- },
- "deidentification_limitations_purpose_val": {
- "type": "string"
- },
- "deidentification_limitations_requirements_val": {
- "type": "string"
- },
- "designated_record_set_provider_maintains": {
- "type": "boolean"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_aggregation_limitations": {
- "type": "boolean"
- },
- "include_deidentification_limitations": {
- "type": "boolean"
- },
- "include_limitations": {
- "type": "boolean"
- },
- "include_offshore_limitations": {
- "type": "boolean"
- },
- "include_subcontract_limitations": {
- "type": "boolean"
- },
- "offshore_limitations_permitted": {
- "type": "boolean"
- },
- "offshore_limitations_permitted_val": {
- "type": "string"
- },
- "subcontract_limitations_include_notice": {
- "type": "boolean"
- },
- "subcontract_limitations_include_permission": {
- "type": "boolean"
- },
- "subcontract_limitations_notice_val": {
- "type": "string"
- },
- "subcontract_limitations_permission_val": {
- "type": "string"
- },
- "subcontract_limitations_permitted": {
- "type": "boolean"
- },
- "underlying_agreement_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "underlying_agreement_type": {
- "enum": [
- "internal",
- "external",
- "none"
- ],
- "type": "string"
- },
- "underlying_agreement_val": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "billing_email": {
- "description": "Email of the billing contact. Used when include_billing_info is true.",
- "format": "email",
- "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-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": {
- "enum": [
- "AWS",
- "GCP",
- "Azure"
- ],
- "type": "string"
- },
- "effective_date_type": {
- "enum": [
- "signature",
- "date",
- "marketplace_acceptance"
- ],
- "type": "string"
- },
- "general_cap_amount": {
- "type": "number"
- },
- "general_cap_amount_type": {
- "enum": [
- "preceding",
- "base",
- "period"
- ],
- "type": "string"
- },
- "general_cap_period_currency": {
- "type": "number"
- },
- "general_cap_period_qty": {
- "type": "number"
- },
- "general_cap_preceding_amount": {
- "type": "number"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_acceptable_use_policy": {
- "type": "boolean"
- },
- "include_acceptable_use_policy_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_acceptable_use_policy_location": {
- "type": "string"
- },
- "include_acceptable_use_policy_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_additional_warranties": {
- "type": "boolean"
- },
- "include_additional_warranties_by_customer": {
- "type": "string"
- },
- "include_additional_warranties_by_provider": {
- "type": "string"
- },
- "include_additional_warranties_include_by_customer": {
- "type": "boolean"
- },
- "include_additional_warranties_include_by_provider": {
- "type": "boolean"
- },
- "include_ai_addendum": {
- "type": "boolean"
- },
- "include_ai_addendum_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_covered_claims": {
- "type": "boolean"
- },
- "include_covered_claims_customer_claims": {
- "type": "string"
- },
- "include_covered_claims_include_customer_claims": {
- "type": "boolean"
- },
- "include_covered_claims_include_provider_claims": {
- "type": "boolean"
- },
- "include_covered_claims_provider_claims": {
- "type": "string"
- },
- "include_dpa": {
- "type": "boolean"
- },
- "include_dpa_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_dpa_location": {
- "type": "string"
- },
- "include_dpa_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_increased_cap_amount": {
- "type": "boolean"
- },
- "include_increased_claims": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_confidentiality": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_confidentiality_negligence": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_privsec": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_privsec_negligence": {
- "type": "boolean"
- },
- "include_increased_claims_include_other": {
- "type": "boolean"
- },
- "include_increased_claims_indemnification_obligation": {
- "type": "boolean"
- },
- "include_increased_claims_other": {
- "type": "string"
- },
- "include_insurance_minimums": {
- "type": "boolean"
- },
- "include_insurance_minimums_add_customer": {
- "type": "boolean"
- },
- "include_insurance_minimums_add_customer_com_gen_liability": {
- "type": "boolean"
- },
- "include_insurance_minimums_add_customer_cyber_liability": {
- "type": "boolean"
- },
- "include_insurance_minimums_add_customer_errors_omissions": {
- "type": "boolean"
- },
- "include_insurance_minimums_additional_information": {
- "type": "boolean"
- },
- "include_insurance_minimums_additional_information_text": {
- "type": "string"
- },
- "include_insurance_minimums_cyber_liability_aggregate": {
- "type": "number"
- },
- "include_insurance_minimums_cyber_liability_minimum": {
- "type": "number"
- },
- "include_insurance_minimums_employer_liability_aggregate": {
- "type": "number"
- },
- "include_insurance_minimums_employer_liability_minimum": {
- "type": "number"
- },
- "include_insurance_minimums_general_liability_aggregate": {
- "type": "number"
- },
- "include_insurance_minimums_general_liability_minimum": {
- "type": "number"
- },
- "include_insurance_minimums_include_cyber_liability": {
- "type": "boolean"
- },
- "include_insurance_minimums_include_employer_liability": {
- "type": "boolean"
- },
- "include_insurance_minimums_include_general_liability": {
- "type": "boolean"
- },
- "include_insurance_minimums_include_workers_compensation": {
- "type": "boolean"
- },
- "include_publicity_rights": {
- "type": "boolean"
- },
- "include_publicity_rights_type": {
- "enum": [
- "public",
- "non-public"
- ],
- "type": "string"
- },
- "include_security_policy": {
- "type": "boolean"
- },
- "include_security_policy_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_security_policy_fedramp_auth": {
- "type": "boolean"
- },
- "include_security_policy_hipaa": {
- "type": "boolean"
- },
- "include_security_policy_hitrust": {
- "type": "boolean"
- },
- "include_security_policy_include_annual_maintenance": {
- "type": "boolean"
- },
- "include_security_policy_include_location": {
- "type": "boolean"
- },
- "include_security_policy_include_other": {
- "type": "boolean"
- },
- "include_security_policy_include_reasonable_efforts": {
- "type": "boolean"
- },
- "include_security_policy_iso27001": {
- "type": "boolean"
- },
- "include_security_policy_location": {
- "type": "string"
- },
- "include_security_policy_other": {
- "type": "string"
- },
- "include_security_policy_pci1": {
- "type": "boolean"
- },
- "include_security_policy_pci2": {
- "type": "boolean"
- },
- "include_security_policy_penetration_testing": {
- "type": "boolean"
- },
- "include_security_policy_soc2": {
- "type": "boolean"
- },
- "include_security_policy_soc2_type2": {
- "type": "boolean"
- },
- "include_security_policy_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_supercap": {
- "description": "CSA 3.0 renamed `include_increased_cap_amount` to `include_supercap`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_increased_cap_amount`. Sending the other spelling returns a 422.",
- "type": "boolean"
- },
- "include_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": "string"
- },
- "increased_cap_amount_currency": {
- "type": "number"
- },
- "increased_cap_amount_period_currency": {
- "type": "number"
- },
- "increased_cap_amount_period_qty": {
- "type": "number"
- },
- "increased_cap_amount_qty": {
- "type": "number"
- },
- "increased_cap_amount_type": {
- "enum": [
- "qty",
- "currency",
- "period"
- ],
- "type": "string"
- },
- "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": "string"
- },
- "affiliates_as_users": {
- "type": "boolean"
- },
- "cloud_service_description": {
- "type": "string"
- },
- "consumption_units": {
- "type": "string"
- },
- "fee_amount": {
- "type": "number"
- },
- "fee_custom_unit": {
- "type": "string"
- },
- "fee_period": {
- "enum": [
- "Subscription Period",
- "month",
- "year",
- "User",
- "Custom unit"
- ],
- "type": "string"
- },
- "fees_attributes": {
- "additionalProperties": {
- "anyOf": [
- {
- "additionalProperties": false,
- "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": {
- "enum": [
- "USD",
- "EUR",
- "GBP",
- "CAD",
- "AUD",
- "SGD",
- "ILS",
- "JPY",
- "CHF",
- "HKD"
- ],
- "type": "string"
- },
- "fees_include_fee_increase_upon_renewal": {
- "type": "boolean"
- },
- "fees_include_fee_increase_upon_renewal_fee": {
- "type": "number"
- },
- "fees_include_fee_increase_upon_renewal_type": {
- "enum": [
- "will",
- "may"
- ],
- "type": "string"
- },
- "fees_inclusive_of_taxes": {
- "type": "boolean"
- },
- "framework_terms_type": {
- "enum": [
- "new",
- "existing",
- "description"
- ],
- "type": "string"
- },
- "free_trial_days": {
- "type": "number"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_additional_changes": {
- "type": "boolean"
- },
- "include_additional_parameters_or_limitations": {
- "type": "boolean"
- },
- "include_consumption": {
- "type": "boolean"
- },
- "include_fees": {
- "type": "boolean"
- },
- "include_fees_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_fees_include_attachment": {
- "type": "boolean"
- },
- "include_fees_other": {
- "type": "boolean"
- },
- "include_fees_other_val": {
- "type": "string"
- },
- "include_fees_table": {
- "type": "boolean"
- },
- "include_fees_table_period": {
- "enum": [
- "Subscription Period",
- "month",
- "year",
- "User"
- ],
- "type": "string"
- },
- "include_free_trial": {
- "type": "boolean"
- },
- "include_max_users": {
- "type": "boolean"
- },
- "include_pilot_period": {
- "type": "boolean"
- },
- "include_pilot_period_duration_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_pilot_period_duration_type": {
- "enum": [
- "day",
- "week",
- "month"
- ],
- "type": "string"
- },
- "include_pilot_period_include_fees": {
- "type": "boolean"
- },
- "include_pilot_period_include_fees_amount": {
- "type": "number"
- },
- "include_pilot_period_include_modifications": {
- "type": "boolean"
- },
- "include_pilot_period_include_modifications_description": {
- "type": "string"
- },
- "include_product_support": {
- "type": "boolean"
- },
- "include_product_support_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_product_support_description": {
- "type": "string"
- },
- "include_product_support_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_professional_services": {
- "type": "boolean"
- },
- "include_professional_services_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_professional_services_custom_name": {
- "type": "string"
- },
- "include_professional_services_description": {
- "type": "string"
- },
- "include_professional_services_end_date": {
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "include_professional_services_fees_description": {
- "type": "string"
- },
- "include_professional_services_include_end_date": {
- "type": "boolean"
- },
- "include_professional_services_include_fees_description": {
- "type": "boolean"
- },
- "include_professional_services_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_sla": {
- "type": "boolean"
- },
- "include_sla_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_sla_description": {
- "type": "string"
- },
- "include_sla_include_response_time": {
- "type": "boolean"
- },
- "include_sla_include_response_time_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_sla_include_response_time_credit": {
- "type": "number"
- },
- "include_sla_include_response_time_duration": {
- "enum": [
- "hour",
- "day",
- "week",
- "month",
- "hours"
- ],
- "type": "string"
- },
- "include_sla_include_response_time_support_channel": {
- "type": "string"
- },
- "include_sla_include_target_uptime": {
- "type": "boolean"
- },
- "include_sla_maintenance_notice": {
- "type": "boolean"
- },
- "include_sla_maintenance_window": {
- "type": "boolean"
- },
- "include_sla_maintenance_window_type": {
- "enum": [
- "standard",
- "none"
- ],
- "type": "string"
- },
- "include_sla_standard_maintenance_notice_qty": {
- "type": "number"
- },
- "include_sla_standard_maintenance_notice_unit": {
- "enum": [
- "hour",
- "day",
- "week",
- "month"
- ],
- "type": "string"
- },
- "include_sla_standard_maintenance_window_end_time": {
- "type": "string"
- },
- "include_sla_standard_maintenance_window_friday": {
- "type": "boolean"
- },
- "include_sla_standard_maintenance_window_monday": {
- "type": "boolean"
- },
- "include_sla_standard_maintenance_window_saturday": {
- "type": "boolean"
- },
- "include_sla_standard_maintenance_window_start_time": {
- "type": "string"
- },
- "include_sla_standard_maintenance_window_sunday": {
- "type": "boolean"
- },
- "include_sla_standard_maintenance_window_thursday": {
- "type": "boolean"
- },
- "include_sla_standard_maintenance_window_time_zone": {
- "type": "string"
- },
- "include_sla_standard_maintenance_window_tuesday": {
- "type": "boolean"
- },
- "include_sla_standard_maintenance_window_wednesday": {
- "type": "boolean"
- },
- "include_sla_standard_target_uptime": {
- "type": "number"
- },
- "include_sla_type": {
- "enum": [
- "description",
- "standard",
- "attachment"
- ],
- "type": "string"
- },
- "include_subscription_start_date": {
- "type": "boolean"
- },
- "include_subscription_start_date_date": {
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "include_usage_review": {
- "type": "boolean"
- },
- "include_usage_review_val": {
- "type": "string"
- },
- "include_use_limitations": {
- "type": "boolean"
- },
- "include_use_limitations_val": {
- "type": "string"
- },
- "invoice_period": {
- "enum": [
- "monthly",
- "quarterly",
- "semiannually",
- "annually",
- "Custom unit",
- "Monthly",
- "Quarterly",
- "Semiannually",
- "Annually"
- ],
- "type": "string"
- },
- "invoice_period_custom_unit": {
- "type": "string"
- },
- "max_consumption": {
- "type": "number"
- },
- "max_users": {
- "type": "number"
- },
- "negotiations_allowed": {
- "type": "boolean"
- },
- "order_date_date": {
- "type": "string"
- },
- "order_date_other": {
- "type": "string"
- },
- "order_date_type": {
- "enum": [
- "signature",
- "date",
- "other"
- ],
- "type": "string"
- },
- "payment_period": {
- "type": "number"
- },
- "payment_period_timeframe": {
- "enum": [
- "Customer's receipt of invoice",
- "date of invoice"
- ],
- "type": "string"
- },
- "payment_period_unit": {
- "enum": [
- "day(s)",
- "week(s)",
- "month(s)",
- "marketplace_acceptance"
- ],
- "type": "string"
- },
- "payment_process_automatic_frequency": {
- "enum": [
- "monthly",
- "quarterly",
- "semiannually",
- "annually"
- ],
- "type": "string"
- },
- "payment_process_type": {
- "enum": [
- "automatic",
- "invoice",
- "custom",
- "marketplace_acceptance"
- ],
- "type": "string"
- },
- "payment_process_type_custom_val": {
- "type": "string"
- },
- "payment_process_type_invoice_amount": {
- "type": "number"
- },
- "payment_process_type_invoice_custom_unit": {
- "type": "string"
- },
- "payment_process_type_invoice_duration": {
- "enum": [
- "day",
- "week",
- "month",
- "year",
- "day(s)",
- "week(s)",
- "month(s)",
- "year(s)"
- ],
- "type": "string"
- },
- "payment_process_type_invoice_duration_start": {
- "enum": [
- "Customer's receipt of invoice",
- "date of invoice"
- ],
- "type": "string"
- },
- "payment_process_type_invoice_type": {
- "enum": [
- "monthly",
- "quarterly",
- "semiannually",
- "annually",
- "Custom unit"
- ],
- "type": "string"
- },
- "pilot_period_stripe_product_id": {
- "type": "string"
- },
- "service_credits_attributes": {
- "additionalProperties": {
- "additionalProperties": false,
- "properties": {
- "credit": {
- "type": "number"
- },
- "max": {
- "type": "number"
- },
- "min": {
- "type": "number"
- }
- },
- "type": "object"
- },
- "description": "Service credits. Use string keys such as \"0\", \"1\".",
- "propertyNames": {
- "type": "string"
- },
- "type": "object"
- },
- "subscription_auto_renew": {
- "enum": [
- "days",
- "subscription_end"
- ],
- "type": "string"
- },
- "subscription_period": {
- "type": "number"
- },
- "subscription_period_unit": {
- "type": "string"
- },
- "subscription_renewal_notice_days": {
- "type": "number"
- },
- "subscription_start_date": {
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "subscription_start_date_type": {
- "enum": [
- "effective_date",
- "date"
- ],
- "type": "string"
- },
- "underlying_agreement_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "use_limitations_attributes": {
- "additionalProperties": {
- "additionalProperties": false,
- "properties": {
- "amount": {
- "type": "number"
- },
- "limitation_type": {
- "type": "string"
- },
- "unit": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "description": "Use limitations. Use string keys such as \"0\", \"1\".",
- "propertyNames": {
- "type": "string"
- },
- "type": "object"
- }
- },
- "type": "object"
- },
- "custom_field_values": {
- "description": "Values for a custom template's fields, keyed by the field keys defined in the template's YAML definition. Only used when template_id is a custom template. Template defaults fill any fields you omit; a required field with no default and no submitted value returns a 400 naming the field. Values are validated against the field's input type: select and radio values must be one of the field's options, multiselect values are an array of selections each of which must be one of the field's options, number and currency values must be numeric, date values must be YYYY-MM-DD, and email values must be valid addresses. An invalid value returns a 400 naming the field."
- },
- "design_partner_attributes": {
- "additionalProperties": false,
- "description": "Override design partner terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "customer_description": {
- "type": "string"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_fees": {
- "type": "boolean"
- },
- "include_fees_amount": {
- "type": "number"
- },
- "include_fees_description": {
- "type": "string"
- },
- "include_fees_pay_by_amount": {
- "type": "string"
- },
- "include_fees_type": {
- "enum": [
- "default_language",
- "description"
- ],
- "type": "string"
- },
- "include_fees_unit": {
- "enum": [
- "month",
- "quarter",
- "year",
- "Term"
- ],
- "type": "string"
- },
- "include_program_appear_as_customer_private": {
- "type": "boolean"
- },
- "include_program_appear_as_customer_public": {
- "type": "boolean"
- },
- "include_program_case_study": {
- "type": "boolean"
- },
- "include_program_develop_functionality": {
- "type": "boolean"
- },
- "include_program_develop_functionality_val": {
- "type": "string"
- },
- "include_program_discount": {
- "type": "boolean"
- },
- "include_program_discount_amount": {
- "type": "number"
- },
- "include_program_discount_unit": {
- "enum": [
- "U.S. Dollars",
- "percent"
- ],
- "type": "string"
- },
- "include_program_participation_feedback": {
- "type": "boolean"
- },
- "include_program_participation_feedback_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_program_participation_feedback_unit": {
- "enum": [
- "month",
- "quarter",
- "year",
- "Term"
- ],
- "type": "string"
- },
- "include_program_partner_other": {
- "type": "boolean"
- },
- "include_program_partner_other_val": {
- "type": "string"
- },
- "include_program_provider_other": {
- "type": "boolean"
- },
- "include_program_provider_other_val": {
- "type": "string"
- },
- "include_program_reference": {
- "type": "boolean"
- },
- "product_description": {
- "type": "string"
- },
- "term_amount": {
- "type": "number"
- },
- "term_unit": {
- "enum": [
- "day(s)",
- "week(s)",
- "month(s)",
- "quarter(s)",
- "year(s)"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- "district_or_county": {
- "description": "The district or county for dispute resolution.",
- "type": "string"
- },
- "dpa_attributes": {
- "additionalProperties": false,
- "description": "Override dpa terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "approved_subprocessor_type": {
- "description": "`internal` lists approved subprocessors in the agreement (`subprocessors_attributes`); `external` points to a list published elsewhere.",
- "enum": [
- "internal",
- "external"
- ],
- "type": "string"
- },
- "cloud_service_product_name": {
- "type": "string"
- },
- "competent_supervisory_authority": {
- "type": "string"
- },
- "customer_description": {
- "type": "string"
- },
- "data_exporter_address_city": {
- "type": "string"
- },
- "data_exporter_address_country": {
- "type": "string"
- },
- "data_exporter_address_state": {
- "type": "string"
- },
- "data_exporter_address_street_address": {
- "type": "string"
- },
- "data_exporter_address_zipcode": {
- "type": "string"
- },
- "data_exporter_contact_details": {
- "type": "string"
- },
- "data_exporter_contact_name": {
- "type": "string"
- },
- "data_exporter_contact_position": {
- "type": "string"
- },
- "data_exporter_role": {
- "description": "Role of the data exporter. Overwritten to `Controller` when the agreement is created from a template.",
- "enum": [
- "Controller",
- "Processor"
- ],
- "type": "string"
- },
- "data_importer_address": {
- "type": "string"
- },
- "data_importer_address_city": {
- "type": "string"
- },
- "data_importer_address_country": {
- "type": "string"
- },
- "data_importer_address_state": {
- "type": "string"
- },
- "data_importer_address_street_address": {
- "type": "string"
- },
- "data_importer_address_zipcode": {
- "type": "string"
- },
- "data_importer_contact_details": {
- "type": "string"
- },
- "data_importer_contact_name": {
- "type": "string"
- },
- "data_importer_contact_position": {
- "type": "string"
- },
- "duration_of_processing": {
- "type": "string"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_covered_claim": {
- "type": "boolean"
- },
- "include_covered_claim_external_val": {
- "type": "string"
- },
- "include_covered_claim_internal_val": {
- "type": "string"
- },
- "include_covered_claim_type": {
- "description": "Which covered-claim text applies: `internal` uses `include_covered_claim_internal_val`, `external` uses `include_covered_claim_external_val`. Required when `include_covered_claim` is true.",
- "enum": [
- "internal",
- "external"
- ],
- "type": "string"
- },
- "include_data_subjects_custom": {
- "type": "boolean"
- },
- "include_data_subjects_custom_val": {
- "type": "string"
- },
- "include_data_subjects_employees": {
- "type": "boolean"
- },
- "include_data_subjects_end_users": {
- "type": "boolean"
- },
- "include_external_subprocessor_location": {
- "type": "string"
- },
- "include_frequency_of_transfer_continuous": {
- "type": "boolean"
- },
- "include_frequency_of_transfer_custom": {
- "type": "boolean"
- },
- "include_frequency_of_transfer_custom_val": {
- "type": "string"
- },
- "include_governing_country_eu": {
- "type": "boolean"
- },
- "include_governing_country_eu_val": {
- "type": "string"
- },
- "include_governing_country_uk": {
- "type": "boolean"
- },
- "include_governing_country_uk_val": {
- "type": "string"
- },
- "include_governing_law": {
- "type": "boolean"
- },
- "include_governing_law_country": {
- "type": "string"
- },
- "include_governing_law_state": {
- "type": "string"
- },
- "include_increased_claim_amount": {
- "description": "Legacy field. Stored but not shown on the DPA; use the `include_liability_cap*` fields instead.",
- "type": "boolean"
- },
- "include_increased_claim_amount_currency": {
- "description": "Legacy field. Stored but not shown on the DPA; use the `include_liability_cap*` fields instead."
- },
- "include_increased_claim_amount_qty": {
- "description": "Legacy field. Stored but not shown on the DPA; use the `include_liability_cap*` fields instead."
- },
- "include_increased_claim_amount_type": {
- "description": "Legacy field. Stored but not shown on the DPA; use the `include_liability_cap*` fields instead.",
- "type": "string"
- },
- "include_liability_cap": {
- "type": "boolean"
- },
- "include_liability_cap_amount_constant_external": {
- "type": "string"
- },
- "include_liability_cap_amount_constant_internal": {
- "type": "string"
- },
- "include_liability_cap_amount_currency_external": {
- "description": "Currency amount. Numbers and numeric strings (commas allowed) are both accepted."
- },
- "include_liability_cap_amount_currency_internal": {
- "description": "Currency amount. Numbers and numeric strings (commas allowed) are both accepted."
- },
- "include_liability_cap_csa_type": {
- "description": "Which liability cap values apply: the `_internal` or `_external` amount fields. Required when `include_liability_cap` is true.",
- "enum": [
- "internal",
- "external"
- ],
- "type": "string"
- },
- "include_personal_data_biographic_info": {
- "type": "boolean"
- },
- "include_personal_data_contact_info": {
- "type": "boolean"
- },
- "include_personal_data_custom": {
- "type": "boolean"
- },
- "include_personal_data_custom_val": {
- "type": "string"
- },
- "include_personal_data_employment_info": {
- "type": "boolean"
- },
- "include_personal_data_financial_info": {
- "type": "boolean"
- },
- "include_personal_data_location": {
- "type": "boolean"
- },
- "include_personal_data_name": {
- "type": "boolean"
- },
- "include_personal_data_transactional_info": {
- "type": "boolean"
- },
- "include_personal_data_user_activity_info": {
- "type": "boolean"
- },
- "include_processing_purpose_custom": {
- "type": "boolean"
- },
- "include_processing_purpose_custom_val": {
- "type": "string"
- },
- "include_processing_purpose_erasing": {
- "type": "boolean"
- },
- "include_processing_purpose_holding": {
- "type": "boolean"
- },
- "include_processing_purpose_protecting": {
- "type": "boolean"
- },
- "include_processing_purpose_receiving": {
- "type": "boolean"
- },
- "include_processing_purpose_returning": {
- "type": "boolean"
- },
- "include_processing_purpose_sharing": {
- "type": "boolean"
- },
- "include_processing_purpose_updating": {
- "type": "boolean"
- },
- "include_processing_purpose_using": {
- "type": "boolean"
- },
- "include_provider_security_contact_address": {
- "type": "boolean"
- },
- "include_provider_security_contact_address_city": {
- "type": "string"
- },
- "include_provider_security_contact_address_country": {
- "type": "string"
- },
- "include_provider_security_contact_address_state": {
- "type": "string"
- },
- "include_provider_security_contact_address_street_address": {
- "type": "string"
- },
- "include_provider_security_contact_address_zipcode": {
- "type": "string"
- },
- "include_provider_security_contact_email": {
- "type": "boolean"
- },
- "include_provider_security_contact_email_val": {
- "format": "email",
- "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-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": "boolean"
- },
- "confidentiality_nda_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "confidentiality_nda_description": {
- "type": "string"
- },
- "confidentiality_nda_include_loi": {
- "type": "boolean"
- },
- "confidentiality_nda_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "confidentiality_type": {
- "enum": [
- "mutual",
- "nda",
- "provider",
- "custom"
- ],
- "type": "string"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_custom_details": {
- "type": "boolean"
- },
- "include_custom_details_val": {
- "type": "string"
- },
- "include_fees": {
- "type": "boolean"
- },
- "include_fees_amount": {
- "type": "number"
- },
- "include_fees_amount_duration": {
- "enum": [
- "month",
- "year",
- "quarter"
- ],
- "type": "string"
- },
- "include_fees_include_amount": {
- "type": "boolean"
- },
- "include_fees_include_other": {
- "type": "boolean"
- },
- "include_fees_other": {
- "type": "string"
- },
- "include_functionality": {
- "type": "boolean"
- },
- "include_functionality_val": {
- "type": "string"
- },
- "include_launch_date": {
- "type": "boolean"
- },
- "include_launch_date_custom": {
- "type": "string"
- },
- "include_launch_date_date": {
- "format": "date-time",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$",
- "type": "string"
- },
- "include_launch_date_type": {
- "enum": [
- "date",
- "custom"
- ],
- "type": "string"
- },
- "product_name": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "manual_send": {
- "description": "When true, the agreement is marked as manually sent outside the platform.",
- "type": "boolean"
- },
- "message": {
- "type": "string"
- },
- "partnership_attributes": {
- "additionalProperties": false,
- "description": "Override partnership terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "effective_date": {
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "effective_date_type": {
- "enum": [
- "signature",
- "date"
- ],
- "type": "string"
- },
- "general_cap_amount_currency_val": {
- "type": "number"
- },
- "general_cap_amount_either_currency": {
- "type": "number"
- },
- "general_cap_amount_either_multiple": {
- "type": "number"
- },
- "general_cap_amount_multiple_val": {
- "type": "number"
- },
- "general_cap_amount_type": {
- "enum": [
- "multiple",
- "currency",
- "either",
- "base"
- ],
- "type": "string"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_additional_warranties": {
- "type": "boolean"
- },
- "include_additional_warranties_include_company": {
- "type": "boolean"
- },
- "include_additional_warranties_include_company_val": {
- "type": "string"
- },
- "include_additional_warranties_include_partner": {
- "type": "boolean"
- },
- "include_additional_warranties_include_partner_val": {
- "type": "string"
- },
- "include_brand_guidelines": {
- "type": "boolean"
- },
- "include_brand_guidelines_include_company": {
- "type": "boolean"
- },
- "include_brand_guidelines_include_company_val": {
- "type": "string"
- },
- "include_brand_guidelines_include_partner": {
- "type": "boolean"
- },
- "include_brand_guidelines_include_partner_val": {
- "type": "string"
- },
- "include_covered_claims": {
- "type": "boolean"
- },
- "include_covered_claims_company_claims": {
- "type": "string"
- },
- "include_covered_claims_include_company_claims": {
- "type": "boolean"
- },
- "include_covered_claims_include_partner_claims": {
- "type": "boolean"
- },
- "include_covered_claims_partner_claims": {
- "type": "string"
- },
- "include_dpa": {
- "type": "boolean"
- },
- "include_dpa_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_dpa_location": {
- "type": "string"
- },
- "include_dpa_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_increased_cap_amount": {
- "type": "boolean"
- },
- "include_increased_cap_amount_currency": {
- "type": "number"
- },
- "include_increased_cap_amount_either_currency": {
- "type": "number"
- },
- "include_increased_cap_amount_either_multiple": {
- "type": "string"
- },
- "include_increased_cap_amount_multiple": {
- "type": "string"
- },
- "include_increased_cap_amount_type": {
- "enum": [
- "multiple",
- "currency",
- "either"
- ],
- "type": "string"
- },
- "include_increased_claims": {
- "type": "boolean"
- },
- "include_increased_claims_include_confidentiality": {
- "type": "boolean"
- },
- "include_increased_claims_include_confidentiality_misconduct": {
- "type": "boolean"
- },
- "include_increased_claims_include_covered_claims": {
- "type": "boolean"
- },
- "include_increased_claims_include_misconduct": {
- "type": "boolean"
- },
- "include_increased_claims_include_other": {
- "type": "boolean"
- },
- "include_increased_claims_include_other_val": {
- "type": "string"
- },
- "include_unlimited_claims": {
- "type": "boolean"
- },
- "include_unlimited_claims_confidentiality": {
- "type": "boolean"
- },
- "include_unlimited_claims_confidentiality_misconduct": {
- "type": "boolean"
- },
- "include_unlimited_claims_covered_claims": {
- "type": "boolean"
- },
- "include_unlimited_claims_misconduct": {
- "type": "boolean"
- },
- "include_unlimited_claims_other": {
- "type": "boolean"
- },
- "include_unlimited_claims_other_val": {
- "type": "string"
- },
- "negotiations_allowed": {
- "type": "boolean"
- }
- },
- "type": "object"
- },
- "partnership_business_terms_attributes": {
- "additionalProperties": false,
- "description": "Override partnership business terms terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "end_date_after_effective_date_amount": {
- "type": "number"
- },
- "end_date_after_effective_date_unit": {
- "enum": [
- "month(s)",
- "quarter(s)",
- "year(s)"
- ],
- "type": "string"
- },
- "end_date_date": {
- "type": "string"
- },
- "end_date_type": {
- "enum": [
- "date",
- "effective date"
- ],
- "type": "string"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_obligations_company_brand": {
- "type": "boolean"
- },
- "include_obligations_company_promotion": {
- "type": "boolean"
- },
- "include_obligations_company_promotion_include_activities": {
- "type": "boolean"
- },
- "include_obligations_company_promotion_include_activities_val": {
- "type": "string"
- },
- "include_obligations_company_promotion_include_materials": {
- "type": "boolean"
- },
- "include_obligations_company_promotion_include_materials_val": {
- "type": "string"
- },
- "include_obligations_company_referral": {
- "type": "boolean"
- },
- "include_obligations_company_referral_include_criteria": {
- "type": "boolean"
- },
- "include_obligations_company_referral_include_criteria_val": {
- "type": "string"
- },
- "include_obligations_company_referral_include_pay_sch": {
- "type": "boolean"
- },
- "include_obligations_company_referral_include_pay_sch_amount": {
- "type": "number"
- },
- "include_obligations_company_referral_include_pay_sch_custom": {
- "type": "string"
- },
- "include_obligations_company_referral_include_pay_sch_unit": {
- "enum": [
- "U.S. Dollars",
- "percent"
- ],
- "type": "string"
- },
- "include_obligations_company_sponsorship": {
- "type": "boolean"
- },
- "include_obligations_company_sponsorship_include_benefits": {
- "type": "boolean"
- },
- "include_obligations_company_sponsorship_include_benefits_val": {
- "type": "string"
- },
- "include_obligations_company_sponsorship_include_payments": {
- "type": "boolean"
- },
- "include_obligations_company_sponsorship_include_payments_amount": {
- "type": "number"
- },
- "include_obligations_company_sponsorship_include_payments_unit": {
- "enum": [
- "U.S. Dollars",
- "percent"
- ],
- "type": "string"
- },
- "include_obligations_partner_brand": {
- "type": "boolean"
- },
- "include_obligations_partner_promotion": {
- "type": "boolean"
- },
- "include_obligations_partner_promotion_include_activities": {
- "type": "boolean"
- },
- "include_obligations_partner_promotion_include_activities_val": {
- "type": "string"
- },
- "include_obligations_partner_promotion_include_materials": {
- "type": "boolean"
- },
- "include_obligations_partner_promotion_include_materials_val": {
- "type": "string"
- },
- "include_obligations_partner_referral": {
- "type": "boolean"
- },
- "include_obligations_partner_referral_include_criteria": {
- "type": "boolean"
- },
- "include_obligations_partner_referral_include_criteria_val": {
- "type": "string"
- },
- "include_obligations_partner_referral_include_pay_sch": {
- "type": "boolean"
- },
- "include_obligations_partner_referral_include_pay_sch_amount": {
- "type": "number"
- },
- "include_obligations_partner_referral_include_pay_sch_custom": {
- "type": "string"
- },
- "include_obligations_partner_referral_include_pay_sch_unit": {
- "enum": [
- "U.S. Dollars",
- "percent"
- ],
- "type": "string"
- },
- "include_obligations_partner_sponsorship": {
- "type": "boolean"
- },
- "include_obligations_partner_sponsorship_include_benefits": {
- "type": "boolean"
- },
- "include_obligations_partner_sponsorship_include_benefits_val": {
- "type": "string"
- },
- "include_obligations_partner_sponsorship_include_payments": {
- "type": "boolean"
- },
- "include_obligations_partner_sponsorship_include_payments_amount": {
- "type": "number"
- },
- "include_obligations_partner_sponsorship_include_payments_unit": {
- "enum": [
- "U.S. Dollars",
- "percent"
- ],
- "type": "string"
- },
- "include_payment_process": {
- "type": "boolean"
- },
- "include_payment_process_company": {
- "type": "boolean"
- },
- "include_payment_process_company_include_address": {
- "type": "boolean"
- },
- "include_payment_process_company_include_address_city": {
- "type": "string"
- },
- "include_payment_process_company_include_address_country": {
- "type": "string"
- },
- "include_payment_process_company_include_address_state": {
- "type": "string"
- },
- "include_payment_process_company_include_address_street_address": {
- "type": "string"
- },
- "include_payment_process_company_include_address_zipcode": {
- "type": "string"
- },
- "include_payment_process_company_include_email": {
- "type": "boolean"
- },
- "include_payment_process_company_include_email_val": {
- "type": "string"
- },
- "include_payment_process_partner": {
- "type": "boolean"
- },
- "include_payment_process_partner_include_address": {
- "type": "boolean"
- },
- "include_payment_process_partner_include_address_city": {
- "type": "string"
- },
- "include_payment_process_partner_include_address_country": {
- "type": "string"
- },
- "include_payment_process_partner_include_address_state": {
- "type": "string"
- },
- "include_payment_process_partner_include_address_street_address": {
- "type": "string"
- },
- "include_payment_process_partner_include_address_zipcode": {
- "type": "string"
- },
- "include_payment_process_partner_include_email": {
- "type": "boolean"
- },
- "include_payment_process_partner_include_email_val": {
- "type": "string"
- },
- "include_payment_schedule": {
- "type": "boolean"
- },
- "include_payment_schedule_custom": {
- "type": "string"
- },
- "include_payment_schedule_specified_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_payment_schedule_specified_timeframe": {
- "enum": [
- "receipt",
- "date"
- ],
- "type": "string"
- },
- "include_payment_schedule_specified_unit": {
- "enum": [
- "day(s)",
- "week(s)",
- "month(s)",
- "quarter(s)",
- "year(s)"
- ],
- "type": "string"
- },
- "include_payment_schedule_type": {
- "enum": [
- "specified",
- "custom"
- ],
- "type": "string"
- },
- "negotiations_allowed": {
- "type": "boolean"
- },
- "territory_type": {
- "enum": [
- "worldwide",
- "custom"
- ],
- "type": "string"
- },
- "territory_type_val": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "payment_link_url": {
- "description": "A payment URL shown to the recipient after signing. Requires include_billing_workflow to be true and billing_workflow_type to be \"link\".",
- "type": "string"
- },
- "pilot_attributes": {
- "additionalProperties": false,
- "description": "Override pilot terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "fees_type": {
- "enum": [
- "free",
- "pilot_period_fees"
- ],
- "type": "string"
- },
- "general_cap_amount": {
- "type": "number"
- },
- "general_cap_amount_type": {
- "enum": [
- "preceding",
- "base",
- "period"
- ],
- "type": "string"
- },
- "general_cap_period_currency": {
- "type": "number"
- },
- "general_cap_period_qty": {
- "type": "number"
- },
- "general_cap_preceding_amount": {
- "type": "number"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_dpa": {
- "type": "boolean"
- },
- "include_dpa_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_dpa_location": {
- "type": "string"
- },
- "include_dpa_type": {
- "enum": [
- "description",
- "attachment",
- "standard"
- ],
- "type": "string"
- },
- "include_payment_process": {
- "type": "boolean"
- },
- "include_technical_support": {
- "type": "boolean"
- },
- "negotiations_allowed": {
- "type": "boolean"
- },
- "payment_process_automatic_frequency": {
- "enum": [
- "monthly",
- "quarterly",
- "annually",
- "once_per_period"
- ],
- "type": "string"
- },
- "payment_process_invoice_days": {
- "type": "number"
- },
- "payment_process_invoice_from": {
- "enum": [
- "receipt",
- "date"
- ],
- "type": "string"
- },
- "payment_process_invoice_timeframe": {
- "enum": [
- "days",
- "weeks",
- "months",
- "quarters",
- "years"
- ],
- "type": "string"
- },
- "payment_process_type": {
- "enum": [
- "automatic",
- "invoice"
- ],
- "type": "string"
- },
- "pilot_period_description": {
- "type": "string"
- },
- "pilot_period_fees_description": {
- "type": "string"
- },
- "product_description": {
- "type": "string"
- },
- "technical_support_description": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "psa_attributes": {
- "additionalProperties": false,
- "description": "Override psa terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "additional_changes": {
- "type": "string"
- },
- "customer_description": {
- "type": "string"
- },
- "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": {
- "enum": [
- "signature",
- "date"
- ],
- "type": "string"
- },
- "general_cap_amount": {
- "type": "number"
- },
- "general_cap_amount_type": {
- "enum": [
- "preceding",
- "base",
- "period"
- ],
- "type": "string"
- },
- "general_cap_period_currency": {
- "type": "number"
- },
- "general_cap_period_qty": {
- "type": "number"
- },
- "general_cap_preceding_amount": {
- "type": "number"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_additional_changes": {
- "type": "boolean"
- },
- "include_additional_warranties": {
- "type": "boolean"
- },
- "include_additional_warranties_by_customer": {
- "type": "string"
- },
- "include_additional_warranties_by_provider": {
- "type": "string"
- },
- "include_additional_warranties_include_by_customer": {
- "type": "boolean"
- },
- "include_additional_warranties_include_by_provider": {
- "type": "boolean"
- },
- "include_covered_claims": {
- "type": "boolean"
- },
- "include_covered_claims_customer_claims": {
- "type": "string"
- },
- "include_covered_claims_include_customer_claims": {
- "type": "boolean"
- },
- "include_covered_claims_include_provider_claims": {
- "type": "boolean"
- },
- "include_covered_claims_provider_claims": {
- "type": "string"
- },
- "include_customer_insurance_min": {
- "type": "boolean"
- },
- "include_customer_insurance_min_add_provider_com_gen_liability": {
- "type": "boolean"
- },
- "include_customer_insurance_min_add_provider_cyber_liability": {
- "type": "boolean"
- },
- "include_customer_insurance_min_add_provider_errors_omissions": {
- "type": "boolean"
- },
- "include_customer_insurance_min_auto_liability_aggregate": {
- "type": "number"
- },
- "include_customer_insurance_min_auto_liability_minimum": {
- "type": "number"
- },
- "include_customer_insurance_min_cyber_liability_aggregate": {
- "type": "number"
- },
- "include_customer_insurance_min_cyber_liability_minimum": {
- "type": "number"
- },
- "include_customer_insurance_min_employer_liability_aggregate": {
- "type": "number"
- },
- "include_customer_insurance_min_employer_liability_minimum": {
- "type": "number"
- },
- "include_customer_insurance_min_general_liability_aggregate": {
- "type": "number"
- },
- "include_customer_insurance_min_general_liability_minimum": {
- "type": "number"
- },
- "include_customer_insurance_min_include_add_provider": {
- "type": "boolean"
- },
- "include_customer_insurance_min_include_auto_liability": {
- "type": "boolean"
- },
- "include_customer_insurance_min_include_cyber_liability": {
- "type": "boolean"
- },
- "include_customer_insurance_min_include_employer_liability": {
- "type": "boolean"
- },
- "include_customer_insurance_min_include_general_liability": {
- "type": "boolean"
- },
- "include_customer_insurance_min_include_workers_comp": {
- "type": "boolean"
- },
- "include_customer_policies": {
- "type": "boolean"
- },
- "include_customer_policies_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_customer_policies_location": {
- "type": "string"
- },
- "include_customer_policies_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_dpa": {
- "type": "boolean"
- },
- "include_dpa_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_dpa_location": {
- "type": "string"
- },
- "include_dpa_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_increased_cap_amount": {
- "type": "boolean"
- },
- "include_increased_claims": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_confidentiality": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_confidentiality_negligence": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_privsec": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_privsec_negligence": {
- "type": "boolean"
- },
- "include_increased_claims_include_other": {
- "type": "boolean"
- },
- "include_increased_claims_indemnification_obligation": {
- "type": "boolean"
- },
- "include_increased_claims_negligence": {
- "type": "boolean"
- },
- "include_increased_claims_other": {
- "type": "string"
- },
- "include_provider_insurance_min": {
- "type": "boolean"
- },
- "include_provider_insurance_min_add_customer_com_gen_liability": {
- "type": "boolean"
- },
- "include_provider_insurance_min_add_customer_cyber_liability": {
- "type": "boolean"
- },
- "include_provider_insurance_min_add_customer_errors_omissions": {
- "type": "boolean"
- },
- "include_provider_insurance_min_auto_liability_aggregate": {
- "type": "number"
- },
- "include_provider_insurance_min_auto_liability_minimum": {
- "type": "number"
- },
- "include_provider_insurance_min_cyber_liability_aggregate": {
- "type": "number"
- },
- "include_provider_insurance_min_cyber_liability_minimum": {
- "type": "number"
- },
- "include_provider_insurance_min_employer_liability_aggregate": {
- "type": "number"
- },
- "include_provider_insurance_min_employer_liability_minimum": {
- "type": "number"
- },
- "include_provider_insurance_min_general_liability_aggregate": {
- "type": "number"
- },
- "include_provider_insurance_min_general_liability_minimum": {
- "type": "number"
- },
- "include_provider_insurance_min_include_add_customer": {
- "type": "boolean"
- },
- "include_provider_insurance_min_include_auto_liability": {
- "type": "boolean"
- },
- "include_provider_insurance_min_include_cyber_liability": {
- "type": "boolean"
- },
- "include_provider_insurance_min_include_employer_liability": {
- "type": "boolean"
- },
- "include_provider_insurance_min_include_general_liability": {
- "type": "boolean"
- },
- "include_provider_insurance_min_include_workers_comp": {
- "type": "boolean"
- },
- "include_publicity_rights": {
- "type": "boolean"
- },
- "include_publicity_rights_type": {
- "enum": [
- "public",
- "non-public"
- ],
- "type": "string"
- },
- "include_security_policy": {
- "type": "boolean"
- },
- "include_security_policy_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_security_policy_fedramp_auth": {
- "type": "boolean"
- },
- "include_security_policy_hitrust": {
- "type": "boolean"
- },
- "include_security_policy_include_annual_maintenance": {
- "type": "boolean"
- },
- "include_security_policy_include_other": {
- "type": "boolean"
- },
- "include_security_policy_include_other_val": {
- "type": "string"
- },
- "include_security_policy_iso27001": {
- "type": "boolean"
- },
- "include_security_policy_location": {
- "type": "string"
- },
- "include_security_policy_pci1": {
- "type": "boolean"
- },
- "include_security_policy_pci2": {
- "type": "boolean"
- },
- "include_security_policy_penetration_testing": {
- "type": "boolean"
- },
- "include_security_policy_soc2_type1": {
- "type": "boolean"
- },
- "include_security_policy_soc2_type2": {
- "type": "boolean"
- },
- "include_security_policy_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_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": "string"
- },
- "increased_cap_amount_currency": {
- "type": "number"
- },
- "increased_cap_amount_period_currency": {
- "type": "number"
- },
- "increased_cap_amount_period_qty": {
- "type": "number"
- },
- "increased_cap_amount_qty": {
- "type": "number"
- },
- "increased_cap_amount_type": {
- "enum": [
- "qty",
- "currency",
- "period"
- ],
- "type": "string"
- },
- "negotiations_allowed": {
- "type": "boolean"
- },
- "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": "string"
- },
- "include_deliverables": {
- "type": "boolean"
- },
- "include_deliverables_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_deliverables_description": {
- "type": "string"
- },
- "include_deliverables_include_acceptance": {
- "type": "boolean"
- },
- "include_deliverables_include_attachment": {
- "type": "boolean"
- },
- "include_deliverables_include_draft_deliverables": {
- "type": "boolean"
- },
- "include_deliverables_rejection_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_deliverables_rejection_unit": {
- "enum": [
- "hours",
- "days",
- "weeks",
- "months"
- ],
- "type": "string"
- },
- "include_deliverables_resubmission_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_deliverables_resubmission_unit": {
- "enum": [
- "hours",
- "days",
- "weeks",
- "months"
- ],
- "type": "string"
- },
- "include_fees_other": {
- "type": "boolean"
- },
- "include_fees_other_val": {
- "type": "string"
- },
- "include_fees_table": {
- "type": "boolean"
- },
- "include_fees_table_total": {
- "type": "boolean"
- },
- "include_fees_travel": {
- "type": "boolean"
- },
- "include_fees_travel_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_fees_travel_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_fees_travel_val": {
- "type": "string"
- },
- "include_third_party_customer": {
- "type": "boolean"
- },
- "include_third_party_include_description": {
- "type": "boolean"
- },
- "include_third_party_include_description_val": {
- "type": "string"
- },
- "include_third_party_materials": {
- "type": "boolean"
- },
- "include_third_party_provider": {
- "type": "boolean"
- },
- "include_time_of_assignment": {
- "type": "boolean"
- },
- "include_time_of_assignment_type": {
- "enum": [
- "created",
- "paid"
- ],
- "type": "string"
- },
- "invoice_period_description": {
- "type": "string"
- },
- "negotiations_allowed": {
- "type": "boolean"
- },
- "payment_period": {
- "type": "number"
- },
- "payment_period_other": {
- "type": "string"
- },
- "payment_period_timeframe": {
- "enum": [
- "receipt",
- "invoice",
- "Customer's receipt of invoice",
- "date of invoice"
- ],
- "type": "string"
- },
- "payment_period_type": {
- "enum": [
- "standard",
- "other"
- ],
- "type": "string"
- },
- "payment_period_unit": {
- "enum": [
- "day(s)",
- "week(s)",
- "month(s)",
- "quarter(s)",
- "year(s)"
- ],
- "type": "string"
- },
- "quantity": {
- "type": "number"
- },
- "services_description": {
- "type": "string"
- },
- "sow_date": {
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "sow_date_type": {
- "enum": [
- "signature",
- "date"
- ],
- "type": "string"
- },
- "sow_term_amount": {
- "type": "number"
- },
- "sow_term_date": {
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "sow_term_type": {
- "enum": [
- "deliverables",
- "period",
- "date"
- ],
- "type": "string"
- },
- "sow_term_unit": {
- "enum": [
- "month(s)",
- "quarter(s)",
- "year(s)"
- ],
- "type": "string"
- },
- "type": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "recipient_email": {
- "format": "email",
- "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-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": {
- "enum": [
- "signature",
- "date"
- ],
- "type": "string"
- },
- "general_cap_amount": {
- "type": "number"
- },
- "general_cap_amount_type": {
- "enum": [
- "preceding",
- "base",
- "period"
- ],
- "type": "string"
- },
- "general_cap_period_currency": {
- "type": "number"
- },
- "general_cap_period_qty": {
- "type": "number"
- },
- "general_cap_preceding_amount": {
- "type": "number"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_additional_warranties": {
- "type": "boolean"
- },
- "include_additional_warranties_by_customer": {
- "type": "string"
- },
- "include_additional_warranties_by_provider": {
- "type": "string"
- },
- "include_additional_warranties_include_by_customer": {
- "type": "boolean"
- },
- "include_additional_warranties_include_by_provider": {
- "type": "boolean"
- },
- "include_ai_addendum": {
- "type": "boolean"
- },
- "include_ai_addendum_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_covered_claims": {
- "type": "boolean"
- },
- "include_covered_claims_customer_claims": {
- "type": "string"
- },
- "include_covered_claims_include_customer_claims": {
- "type": "boolean"
- },
- "include_covered_claims_include_provider_claims": {
- "type": "boolean"
- },
- "include_covered_claims_provider_claims": {
- "type": "string"
- },
- "include_dpa": {
- "type": "boolean"
- },
- "include_dpa_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_dpa_location": {
- "type": "string"
- },
- "include_dpa_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_increased_cap_amount": {
- "type": "boolean"
- },
- "include_increased_claims": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_confidentiality": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_confidentiality_negligence": {
- "type": "boolean"
- },
- "include_increased_claims_include_other": {
- "type": "boolean"
- },
- "include_increased_claims_indemnification_obligation": {
- "type": "boolean"
- },
- "include_increased_claims_negligence": {
- "type": "boolean"
- },
- "include_increased_claims_other": {
- "type": "string"
- },
- "include_increased_claims_restrictions": {
- "type": "boolean"
- },
- "include_unlimited_claims": {
- "type": "boolean"
- },
- "include_unlimited_claims_breach_of_confidentiality": {
- "type": "boolean"
- },
- "include_unlimited_claims_breach_of_confidentiality_negligence": {
- "type": "boolean"
- },
- "include_unlimited_claims_include_other": {
- "type": "boolean"
- },
- "include_unlimited_claims_indemnification_obligation": {
- "type": "boolean"
- },
- "include_unlimited_claims_license_or_restrictions": {
- "type": "boolean"
- },
- "include_unlimited_claims_negligence": {
- "type": "boolean"
- },
- "include_unlimited_claims_other": {
- "type": "string"
- },
- "increased_cap_amount_currency": {
- "type": "number"
- },
- "increased_cap_amount_period_currency": {
- "type": "number"
- },
- "increased_cap_amount_period_qty": {
- "type": "number"
- },
- "increased_cap_amount_qty": {
- "type": "number"
- },
- "increased_cap_amount_type": {
- "enum": [
- "qty",
- "currency",
- "period"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- "software_license_order_form_attributes": {
- "additionalProperties": false,
- "description": "Override software license order form terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "additional_changes": {
- "type": "string"
- },
- "deletion_procedure_include_custom": {
- "type": "boolean"
- },
- "deletion_procedure_include_custom_description": {
- "type": "string"
- },
- "deletion_procedure_include_customer_disable": {
- "type": "boolean"
- },
- "deletion_procedure_include_customer_proof": {
- "type": "boolean"
- },
- "deletion_procedure_include_provider_disable": {
- "type": "boolean"
- },
- "fee_custom_unit": {
- "type": "string"
- },
- "fee_period": {
- "enum": [
- "Subscription Period",
- "month",
- "year",
- "Custom unit"
- ],
- "type": "string"
- },
- "fees_attributes": {
- "additionalProperties": {
- "anyOf": [
- {
- "additionalProperties": false,
- "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": {
- "enum": [
- "USD",
- "EUR",
- "GBP",
- "CAD",
- "AUD",
- "SGD",
- "ILS",
- "JPY",
- "CHF",
- "HKD"
- ],
- "type": "string"
- },
- "fees_include_fee_increase_upon_renewal": {
- "type": "boolean"
- },
- "fees_include_fee_increase_upon_renewal_fee": {
- "type": "number"
- },
- "fees_include_fee_increase_upon_renewal_type": {
- "enum": [
- "will",
- "may"
- ],
- "type": "string"
- },
- "fees_inclusive_of_taxes": {
- "type": "boolean"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_additional_changes": {
- "type": "boolean"
- },
- "include_license_compliance_verification": {
- "type": "boolean"
- },
- "include_license_compliance_verification_description": {
- "type": "string"
- },
- "include_license_limits": {
- "type": "boolean"
- },
- "include_license_limits_description": {
- "type": "string"
- },
- "include_payment_process_include_billing_email": {
- "type": "boolean"
- },
- "include_pilot_period": {
- "type": "boolean"
- },
- "include_pilot_period_duration_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_pilot_period_duration_type": {
- "enum": [
- "day",
- "week",
- "month"
- ],
- "type": "string"
- },
- "include_pilot_period_include_fees": {
- "type": "boolean"
- },
- "include_pilot_period_include_fees_amount": {
- "type": "number"
- },
- "include_pilot_period_include_modifications": {
- "type": "boolean"
- },
- "include_pilot_period_include_modifications_description": {
- "type": "string"
- },
- "include_services": {
- "type": "boolean"
- },
- "include_services_description": {
- "type": "string"
- },
- "negotiations_allowed": {
- "type": "boolean"
- },
- "order_date_date": {
- "type": "string"
- },
- "order_date_type": {
- "enum": [
- "signature",
- "date",
- "other"
- ],
- "type": "string"
- },
- "payment_process_automatic_frequency": {
- "enum": [
- "monthly",
- "quarterly",
- "semiannually",
- "annually"
- ],
- "type": "string"
- },
- "payment_process_type": {
- "enum": [
- "automatic",
- "invoice",
- "custom"
- ],
- "type": "string"
- },
- "payment_process_type_custom_val": {
- "type": "string"
- },
- "payment_process_type_invoice_amount": {
- "type": "number"
- },
- "payment_process_type_invoice_custom_unit": {
- "type": "string"
- },
- "payment_process_type_invoice_duration": {
- "enum": [
- "day",
- "week",
- "month",
- "year",
- "day(s)",
- "week(s)",
- "month(s)",
- "year(s)"
- ],
- "type": "string"
- },
- "payment_process_type_invoice_duration_start": {
- "enum": [
- "Customer's receipt of invoice",
- "date of invoice"
- ],
- "type": "string"
- },
- "payment_process_type_invoice_type": {
- "enum": [
- "monthly",
- "quarterly",
- "semiannually",
- "annually",
- "Custom unit"
- ],
- "type": "string"
- },
- "permitted_uses_include_custom": {
- "type": "boolean"
- },
- "permitted_uses_include_custom_description": {
- "type": "string"
- },
- "permitted_uses_include_customers_affiliates": {
- "type": "boolean"
- },
- "permitted_uses_include_internal_business": {
- "type": "boolean"
- },
- "pilot_period_stripe_product_id": {
- "type": "string"
- },
- "software_description": {
- "type": "string"
- },
- "subscription_auto_renew": {
- "enum": [
- "days",
- "subscription_end"
- ],
- "type": "string"
- },
- "subscription_period": {
- "type": "number"
- },
- "subscription_period_unit": {
- "type": "string"
- },
- "subscription_renewal_notice_days": {
- "type": "number"
- },
- "warranty_period_description_amount": {
- "type": "number"
- },
- "warranty_period_description_duration": {
- "enum": [
- "day",
- "week",
- "month",
- "year"
- ],
- "type": "string"
- },
- "warranty_period_description_duration_start": {
- "enum": [
- "initial delivery of the Software",
- "delivery of the Software and each subsequent Update",
- "the Order Date"
- ],
- "type": "string"
- },
- "warranty_period_type": {
- "enum": [
- "description",
- "none"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- "test_agreement": {
- "description": "When true, marks the agreement as a test. Test agreements do not count against your monthly limit.",
- "type": "boolean"
- }
- },
- "required": [
- "recipient_name",
- "recipient_email"
- ],
- "type": "object"
- },
- "cc_users": {
- "items": {
- "format": "email",
- "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-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": {
- "enum": [
- "signature",
- "date"
- ],
- "type": "string"
- },
- "framework_terms_type": {
- "type": "string"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "parent_agreement_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "underlying_agreement_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "underlying_agreement_type": {
- "type": "string"
- },
- "underlying_agreement_val": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "baa_attributes": {
- "additionalProperties": false,
- "description": "Override baa terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "aggregation_limitations_permitted": {
- "type": "boolean"
- },
- "aggregation_limitations_permitted_val": {
- "type": "string"
- },
- "breach_notification_unit": {
- "enum": [
- "hours",
- "business days",
- "calendar days"
- ],
- "type": "string"
- },
- "breach_notification_val": {
- "type": "number"
- },
- "business_associate_relationship_type": {
- "enum": [
- "provider",
- "company"
- ],
- "type": "string"
- },
- "deidentification_limitations_include_purpose": {
- "type": "boolean"
- },
- "deidentification_limitations_include_requirements": {
- "type": "boolean"
- },
- "deidentification_limitations_permitted": {
- "type": "boolean"
- },
- "deidentification_limitations_purpose_val": {
- "type": "string"
- },
- "deidentification_limitations_requirements_val": {
- "type": "string"
- },
- "designated_record_set_provider_maintains": {
- "type": "boolean"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_aggregation_limitations": {
- "type": "boolean"
- },
- "include_deidentification_limitations": {
- "type": "boolean"
- },
- "include_limitations": {
- "type": "boolean"
- },
- "include_offshore_limitations": {
- "type": "boolean"
- },
- "include_subcontract_limitations": {
- "type": "boolean"
- },
- "offshore_limitations_permitted": {
- "type": "boolean"
- },
- "offshore_limitations_permitted_val": {
- "type": "string"
- },
- "subcontract_limitations_include_notice": {
- "type": "boolean"
- },
- "subcontract_limitations_include_permission": {
- "type": "boolean"
- },
- "subcontract_limitations_notice_val": {
- "type": "string"
- },
- "subcontract_limitations_permission_val": {
- "type": "string"
- },
- "subcontract_limitations_permitted": {
- "type": "boolean"
- },
- "underlying_agreement_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "underlying_agreement_type": {
- "enum": [
- "internal",
- "external",
- "none"
- ],
- "type": "string"
- },
- "underlying_agreement_val": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "billing_email": {
- "description": "Email of the billing contact. Used when include_billing_info is true.",
- "format": "email",
- "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-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": {
- "enum": [
- "AWS",
- "GCP",
- "Azure"
- ],
- "type": "string"
- },
- "effective_date_type": {
- "enum": [
- "signature",
- "date",
- "marketplace_acceptance"
- ],
- "type": "string"
- },
- "general_cap_amount": {
- "type": "number"
- },
- "general_cap_amount_type": {
- "enum": [
- "preceding",
- "base",
- "period"
- ],
- "type": "string"
- },
- "general_cap_period_currency": {
- "type": "number"
- },
- "general_cap_period_qty": {
- "type": "number"
- },
- "general_cap_preceding_amount": {
- "type": "number"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_acceptable_use_policy": {
- "type": "boolean"
- },
- "include_acceptable_use_policy_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_acceptable_use_policy_location": {
- "type": "string"
- },
- "include_acceptable_use_policy_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_additional_warranties": {
- "type": "boolean"
- },
- "include_additional_warranties_by_customer": {
- "type": "string"
- },
- "include_additional_warranties_by_provider": {
- "type": "string"
- },
- "include_additional_warranties_include_by_customer": {
- "type": "boolean"
- },
- "include_additional_warranties_include_by_provider": {
- "type": "boolean"
- },
- "include_ai_addendum": {
- "type": "boolean"
- },
- "include_ai_addendum_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_covered_claims": {
- "type": "boolean"
- },
- "include_covered_claims_customer_claims": {
- "type": "string"
- },
- "include_covered_claims_include_customer_claims": {
- "type": "boolean"
- },
- "include_covered_claims_include_provider_claims": {
- "type": "boolean"
- },
- "include_covered_claims_provider_claims": {
- "type": "string"
- },
- "include_dpa": {
- "type": "boolean"
- },
- "include_dpa_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_dpa_location": {
- "type": "string"
- },
- "include_dpa_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_increased_cap_amount": {
- "type": "boolean"
- },
- "include_increased_claims": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_confidentiality": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_confidentiality_negligence": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_privsec": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_privsec_negligence": {
- "type": "boolean"
- },
- "include_increased_claims_include_other": {
- "type": "boolean"
- },
- "include_increased_claims_indemnification_obligation": {
- "type": "boolean"
- },
- "include_increased_claims_other": {
- "type": "string"
- },
- "include_insurance_minimums": {
- "type": "boolean"
- },
- "include_insurance_minimums_add_customer": {
- "type": "boolean"
- },
- "include_insurance_minimums_add_customer_com_gen_liability": {
- "type": "boolean"
- },
- "include_insurance_minimums_add_customer_cyber_liability": {
- "type": "boolean"
- },
- "include_insurance_minimums_add_customer_errors_omissions": {
- "type": "boolean"
- },
- "include_insurance_minimums_additional_information": {
- "type": "boolean"
- },
- "include_insurance_minimums_additional_information_text": {
- "type": "string"
- },
- "include_insurance_minimums_cyber_liability_aggregate": {
- "type": "number"
- },
- "include_insurance_minimums_cyber_liability_minimum": {
- "type": "number"
- },
- "include_insurance_minimums_employer_liability_aggregate": {
- "type": "number"
- },
- "include_insurance_minimums_employer_liability_minimum": {
- "type": "number"
- },
- "include_insurance_minimums_general_liability_aggregate": {
- "type": "number"
- },
- "include_insurance_minimums_general_liability_minimum": {
- "type": "number"
- },
- "include_insurance_minimums_include_cyber_liability": {
- "type": "boolean"
- },
- "include_insurance_minimums_include_employer_liability": {
- "type": "boolean"
- },
- "include_insurance_minimums_include_general_liability": {
- "type": "boolean"
- },
- "include_insurance_minimums_include_workers_compensation": {
- "type": "boolean"
- },
- "include_publicity_rights": {
- "type": "boolean"
- },
- "include_publicity_rights_type": {
- "enum": [
- "public",
- "non-public"
- ],
- "type": "string"
- },
- "include_security_policy": {
- "type": "boolean"
- },
- "include_security_policy_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_security_policy_fedramp_auth": {
- "type": "boolean"
- },
- "include_security_policy_hipaa": {
- "type": "boolean"
- },
- "include_security_policy_hitrust": {
- "type": "boolean"
- },
- "include_security_policy_include_annual_maintenance": {
- "type": "boolean"
- },
- "include_security_policy_include_location": {
- "type": "boolean"
- },
- "include_security_policy_include_other": {
- "type": "boolean"
- },
- "include_security_policy_include_reasonable_efforts": {
- "type": "boolean"
- },
- "include_security_policy_iso27001": {
- "type": "boolean"
- },
- "include_security_policy_location": {
- "type": "string"
- },
- "include_security_policy_other": {
- "type": "string"
- },
- "include_security_policy_pci1": {
- "type": "boolean"
- },
- "include_security_policy_pci2": {
- "type": "boolean"
- },
- "include_security_policy_penetration_testing": {
- "type": "boolean"
- },
- "include_security_policy_soc2": {
- "type": "boolean"
- },
- "include_security_policy_soc2_type2": {
- "type": "boolean"
- },
- "include_security_policy_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_supercap": {
- "description": "CSA 3.0 renamed `include_increased_cap_amount` to `include_supercap`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_increased_cap_amount`. Sending the other spelling returns a 422.",
- "type": "boolean"
- },
- "include_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": "string"
- },
- "increased_cap_amount_currency": {
- "type": "number"
- },
- "increased_cap_amount_period_currency": {
- "type": "number"
- },
- "increased_cap_amount_period_qty": {
- "type": "number"
- },
- "increased_cap_amount_qty": {
- "type": "number"
- },
- "increased_cap_amount_type": {
- "enum": [
- "qty",
- "currency",
- "period"
- ],
- "type": "string"
- },
- "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": "string"
- },
- "affiliates_as_users": {
- "type": "boolean"
- },
- "cloud_service_description": {
- "type": "string"
- },
- "consumption_units": {
- "type": "string"
- },
- "fee_amount": {
- "type": "number"
- },
- "fee_custom_unit": {
- "type": "string"
- },
- "fee_period": {
- "enum": [
- "Subscription Period",
- "month",
- "year",
- "User",
- "Custom unit"
- ],
- "type": "string"
- },
- "fees_attributes": {
- "additionalProperties": {
- "anyOf": [
- {
- "additionalProperties": false,
- "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": {
- "enum": [
- "USD",
- "EUR",
- "GBP",
- "CAD",
- "AUD",
- "SGD",
- "ILS",
- "JPY",
- "CHF",
- "HKD"
- ],
- "type": "string"
- },
- "fees_include_fee_increase_upon_renewal": {
- "type": "boolean"
- },
- "fees_include_fee_increase_upon_renewal_fee": {
- "type": "number"
- },
- "fees_include_fee_increase_upon_renewal_type": {
- "enum": [
- "will",
- "may"
- ],
- "type": "string"
- },
- "fees_inclusive_of_taxes": {
- "type": "boolean"
- },
- "framework_terms_type": {
- "enum": [
- "new",
- "existing",
- "description"
- ],
- "type": "string"
- },
- "free_trial_days": {
- "type": "number"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_additional_changes": {
- "type": "boolean"
- },
- "include_additional_parameters_or_limitations": {
- "type": "boolean"
- },
- "include_consumption": {
- "type": "boolean"
- },
- "include_fees": {
- "type": "boolean"
- },
- "include_fees_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_fees_include_attachment": {
- "type": "boolean"
- },
- "include_fees_other": {
- "type": "boolean"
- },
- "include_fees_other_val": {
- "type": "string"
- },
- "include_fees_table": {
- "type": "boolean"
- },
- "include_fees_table_period": {
- "enum": [
- "Subscription Period",
- "month",
- "year",
- "User"
- ],
- "type": "string"
- },
- "include_free_trial": {
- "type": "boolean"
- },
- "include_max_users": {
- "type": "boolean"
- },
- "include_pilot_period": {
- "type": "boolean"
- },
- "include_pilot_period_duration_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_pilot_period_duration_type": {
- "enum": [
- "day",
- "week",
- "month"
- ],
- "type": "string"
- },
- "include_pilot_period_include_fees": {
- "type": "boolean"
- },
- "include_pilot_period_include_fees_amount": {
- "type": "number"
- },
- "include_pilot_period_include_modifications": {
- "type": "boolean"
- },
- "include_pilot_period_include_modifications_description": {
- "type": "string"
- },
- "include_product_support": {
- "type": "boolean"
- },
- "include_product_support_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_product_support_description": {
- "type": "string"
- },
- "include_product_support_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_professional_services": {
- "type": "boolean"
- },
- "include_professional_services_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_professional_services_custom_name": {
- "type": "string"
- },
- "include_professional_services_description": {
- "type": "string"
- },
- "include_professional_services_end_date": {
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "include_professional_services_fees_description": {
- "type": "string"
- },
- "include_professional_services_include_end_date": {
- "type": "boolean"
- },
- "include_professional_services_include_fees_description": {
- "type": "boolean"
- },
- "include_professional_services_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_sla": {
- "type": "boolean"
- },
- "include_sla_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_sla_description": {
- "type": "string"
- },
- "include_sla_include_response_time": {
- "type": "boolean"
- },
- "include_sla_include_response_time_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_sla_include_response_time_credit": {
- "type": "number"
- },
- "include_sla_include_response_time_duration": {
- "enum": [
- "hour",
- "day",
- "week",
- "month",
- "hours"
- ],
- "type": "string"
- },
- "include_sla_include_response_time_support_channel": {
- "type": "string"
- },
- "include_sla_include_target_uptime": {
- "type": "boolean"
- },
- "include_sla_maintenance_notice": {
- "type": "boolean"
- },
- "include_sla_maintenance_window": {
- "type": "boolean"
- },
- "include_sla_maintenance_window_type": {
- "enum": [
- "standard",
- "none"
- ],
- "type": "string"
- },
- "include_sla_standard_maintenance_notice_qty": {
- "type": "number"
- },
- "include_sla_standard_maintenance_notice_unit": {
- "enum": [
- "hour",
- "day",
- "week",
- "month"
- ],
- "type": "string"
- },
- "include_sla_standard_maintenance_window_end_time": {
- "type": "string"
- },
- "include_sla_standard_maintenance_window_friday": {
- "type": "boolean"
- },
- "include_sla_standard_maintenance_window_monday": {
- "type": "boolean"
- },
- "include_sla_standard_maintenance_window_saturday": {
- "type": "boolean"
- },
- "include_sla_standard_maintenance_window_start_time": {
- "type": "string"
- },
- "include_sla_standard_maintenance_window_sunday": {
- "type": "boolean"
- },
- "include_sla_standard_maintenance_window_thursday": {
- "type": "boolean"
- },
- "include_sla_standard_maintenance_window_time_zone": {
- "type": "string"
- },
- "include_sla_standard_maintenance_window_tuesday": {
- "type": "boolean"
- },
- "include_sla_standard_maintenance_window_wednesday": {
- "type": "boolean"
- },
- "include_sla_standard_target_uptime": {
- "type": "number"
- },
- "include_sla_type": {
- "enum": [
- "description",
- "standard",
- "attachment"
- ],
- "type": "string"
- },
- "include_subscription_start_date": {
- "type": "boolean"
- },
- "include_subscription_start_date_date": {
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "include_usage_review": {
- "type": "boolean"
- },
- "include_usage_review_val": {
- "type": "string"
- },
- "include_use_limitations": {
- "type": "boolean"
- },
- "include_use_limitations_val": {
- "type": "string"
- },
- "invoice_period": {
- "enum": [
- "monthly",
- "quarterly",
- "semiannually",
- "annually",
- "Custom unit",
- "Monthly",
- "Quarterly",
- "Semiannually",
- "Annually"
- ],
- "type": "string"
- },
- "invoice_period_custom_unit": {
- "type": "string"
- },
- "max_consumption": {
- "type": "number"
- },
- "max_users": {
- "type": "number"
- },
- "negotiations_allowed": {
- "type": "boolean"
- },
- "order_date_date": {
- "type": "string"
- },
- "order_date_other": {
- "type": "string"
- },
- "order_date_type": {
- "enum": [
- "signature",
- "date",
- "other"
- ],
- "type": "string"
- },
- "payment_period": {
- "type": "number"
- },
- "payment_period_timeframe": {
- "enum": [
- "Customer's receipt of invoice",
- "date of invoice"
- ],
- "type": "string"
- },
- "payment_period_unit": {
- "enum": [
- "day(s)",
- "week(s)",
- "month(s)",
- "marketplace_acceptance"
- ],
- "type": "string"
- },
- "payment_process_automatic_frequency": {
- "enum": [
- "monthly",
- "quarterly",
- "semiannually",
- "annually"
- ],
- "type": "string"
- },
- "payment_process_type": {
- "enum": [
- "automatic",
- "invoice",
- "custom",
- "marketplace_acceptance"
- ],
- "type": "string"
- },
- "payment_process_type_custom_val": {
- "type": "string"
- },
- "payment_process_type_invoice_amount": {
- "type": "number"
- },
- "payment_process_type_invoice_custom_unit": {
- "type": "string"
- },
- "payment_process_type_invoice_duration": {
- "enum": [
- "day",
- "week",
- "month",
- "year",
- "day(s)",
- "week(s)",
- "month(s)",
- "year(s)"
- ],
- "type": "string"
- },
- "payment_process_type_invoice_duration_start": {
- "enum": [
- "Customer's receipt of invoice",
- "date of invoice"
- ],
- "type": "string"
- },
- "payment_process_type_invoice_type": {
- "enum": [
- "monthly",
- "quarterly",
- "semiannually",
- "annually",
- "Custom unit"
- ],
- "type": "string"
- },
- "pilot_period_stripe_product_id": {
- "type": "string"
- },
- "service_credits_attributes": {
- "additionalProperties": {
- "additionalProperties": false,
- "properties": {
- "credit": {
- "type": "number"
- },
- "max": {
- "type": "number"
- },
- "min": {
- "type": "number"
- }
- },
- "type": "object"
- },
- "description": "Service credits. Use string keys such as \"0\", \"1\".",
- "propertyNames": {
- "type": "string"
- },
- "type": "object"
- },
- "subscription_auto_renew": {
- "enum": [
- "days",
- "subscription_end"
- ],
- "type": "string"
- },
- "subscription_period": {
- "type": "number"
- },
- "subscription_period_unit": {
- "type": "string"
- },
- "subscription_renewal_notice_days": {
- "type": "number"
- },
- "subscription_start_date": {
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "subscription_start_date_type": {
- "enum": [
- "effective_date",
- "date"
- ],
- "type": "string"
- },
- "underlying_agreement_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "use_limitations_attributes": {
- "additionalProperties": {
- "additionalProperties": false,
- "properties": {
- "amount": {
- "type": "number"
- },
- "limitation_type": {
- "type": "string"
- },
- "unit": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "description": "Use limitations. Use string keys such as \"0\", \"1\".",
- "propertyNames": {
- "type": "string"
- },
- "type": "object"
- }
- },
- "type": "object"
- },
- "custom_field_values": {
- "description": "Values for a custom template's fields, keyed by the field keys defined in the template's YAML definition. Only used when template_id is a custom template. Template defaults fill any fields you omit; a required field with no default and no submitted value returns a 400 naming the field. Values are validated against the field's input type: select and radio values must be one of the field's options, multiselect values are an array of selections each of which must be one of the field's options, number and currency values must be numeric, date values must be YYYY-MM-DD, and email values must be valid addresses. An invalid value returns a 400 naming the field."
- },
- "design_partner_attributes": {
- "additionalProperties": false,
- "description": "Override design partner terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "customer_description": {
- "type": "string"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_fees": {
- "type": "boolean"
- },
- "include_fees_amount": {
- "type": "number"
- },
- "include_fees_description": {
- "type": "string"
- },
- "include_fees_pay_by_amount": {
- "type": "string"
- },
- "include_fees_type": {
- "enum": [
- "default_language",
- "description"
- ],
- "type": "string"
- },
- "include_fees_unit": {
- "enum": [
- "month",
- "quarter",
- "year",
- "Term"
- ],
- "type": "string"
- },
- "include_program_appear_as_customer_private": {
- "type": "boolean"
- },
- "include_program_appear_as_customer_public": {
- "type": "boolean"
- },
- "include_program_case_study": {
- "type": "boolean"
- },
- "include_program_develop_functionality": {
- "type": "boolean"
- },
- "include_program_develop_functionality_val": {
- "type": "string"
- },
- "include_program_discount": {
- "type": "boolean"
- },
- "include_program_discount_amount": {
- "type": "number"
- },
- "include_program_discount_unit": {
- "enum": [
- "U.S. Dollars",
- "percent"
- ],
- "type": "string"
- },
- "include_program_participation_feedback": {
- "type": "boolean"
- },
- "include_program_participation_feedback_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_program_participation_feedback_unit": {
- "enum": [
- "month",
- "quarter",
- "year",
- "Term"
- ],
- "type": "string"
- },
- "include_program_partner_other": {
- "type": "boolean"
- },
- "include_program_partner_other_val": {
- "type": "string"
- },
- "include_program_provider_other": {
- "type": "boolean"
- },
- "include_program_provider_other_val": {
- "type": "string"
- },
- "include_program_reference": {
- "type": "boolean"
- },
- "product_description": {
- "type": "string"
- },
- "term_amount": {
- "type": "number"
- },
- "term_unit": {
- "enum": [
- "day(s)",
- "week(s)",
- "month(s)",
- "quarter(s)",
- "year(s)"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- "district_or_county": {
- "description": "The district or county for dispute resolution.",
- "type": "string"
- },
- "dpa_attributes": {
- "additionalProperties": false,
- "description": "Override dpa terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "approved_subprocessor_type": {
- "description": "`internal` lists approved subprocessors in the agreement (`subprocessors_attributes`); `external` points to a list published elsewhere.",
- "enum": [
- "internal",
- "external"
- ],
- "type": "string"
- },
- "cloud_service_product_name": {
- "type": "string"
- },
- "competent_supervisory_authority": {
- "type": "string"
- },
- "customer_description": {
- "type": "string"
- },
- "data_exporter_address_city": {
- "type": "string"
- },
- "data_exporter_address_country": {
- "type": "string"
- },
- "data_exporter_address_state": {
- "type": "string"
- },
- "data_exporter_address_street_address": {
- "type": "string"
- },
- "data_exporter_address_zipcode": {
- "type": "string"
- },
- "data_exporter_contact_details": {
- "type": "string"
- },
- "data_exporter_contact_name": {
- "type": "string"
- },
- "data_exporter_contact_position": {
- "type": "string"
- },
- "data_exporter_role": {
- "description": "Role of the data exporter. Overwritten to `Controller` when the agreement is created from a template.",
- "enum": [
- "Controller",
- "Processor"
- ],
- "type": "string"
- },
- "data_importer_address": {
- "type": "string"
- },
- "data_importer_address_city": {
- "type": "string"
- },
- "data_importer_address_country": {
- "type": "string"
- },
- "data_importer_address_state": {
- "type": "string"
- },
- "data_importer_address_street_address": {
- "type": "string"
- },
- "data_importer_address_zipcode": {
- "type": "string"
- },
- "data_importer_contact_details": {
- "type": "string"
- },
- "data_importer_contact_name": {
- "type": "string"
- },
- "data_importer_contact_position": {
- "type": "string"
- },
- "duration_of_processing": {
- "type": "string"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_covered_claim": {
- "type": "boolean"
- },
- "include_covered_claim_external_val": {
- "type": "string"
- },
- "include_covered_claim_internal_val": {
- "type": "string"
- },
- "include_covered_claim_type": {
- "description": "Which covered-claim text applies: `internal` uses `include_covered_claim_internal_val`, `external` uses `include_covered_claim_external_val`. Required when `include_covered_claim` is true.",
- "enum": [
- "internal",
- "external"
- ],
- "type": "string"
- },
- "include_data_subjects_custom": {
- "type": "boolean"
- },
- "include_data_subjects_custom_val": {
- "type": "string"
- },
- "include_data_subjects_employees": {
- "type": "boolean"
- },
- "include_data_subjects_end_users": {
- "type": "boolean"
- },
- "include_external_subprocessor_location": {
- "type": "string"
- },
- "include_frequency_of_transfer_continuous": {
- "type": "boolean"
- },
- "include_frequency_of_transfer_custom": {
- "type": "boolean"
- },
- "include_frequency_of_transfer_custom_val": {
- "type": "string"
- },
- "include_governing_country_eu": {
- "type": "boolean"
- },
- "include_governing_country_eu_val": {
- "type": "string"
- },
- "include_governing_country_uk": {
- "type": "boolean"
- },
- "include_governing_country_uk_val": {
- "type": "string"
- },
- "include_governing_law": {
- "type": "boolean"
- },
- "include_governing_law_country": {
- "type": "string"
- },
- "include_governing_law_state": {
- "type": "string"
- },
- "include_increased_claim_amount": {
- "description": "Legacy field. Stored but not shown on the DPA; use the `include_liability_cap*` fields instead.",
- "type": "boolean"
- },
- "include_increased_claim_amount_currency": {
- "description": "Legacy field. Stored but not shown on the DPA; use the `include_liability_cap*` fields instead."
- },
- "include_increased_claim_amount_qty": {
- "description": "Legacy field. Stored but not shown on the DPA; use the `include_liability_cap*` fields instead."
- },
- "include_increased_claim_amount_type": {
- "description": "Legacy field. Stored but not shown on the DPA; use the `include_liability_cap*` fields instead.",
- "type": "string"
- },
- "include_liability_cap": {
- "type": "boolean"
- },
- "include_liability_cap_amount_constant_external": {
- "type": "string"
- },
- "include_liability_cap_amount_constant_internal": {
- "type": "string"
- },
- "include_liability_cap_amount_currency_external": {
- "description": "Currency amount. Numbers and numeric strings (commas allowed) are both accepted."
- },
- "include_liability_cap_amount_currency_internal": {
- "description": "Currency amount. Numbers and numeric strings (commas allowed) are both accepted."
- },
- "include_liability_cap_csa_type": {
- "description": "Which liability cap values apply: the `_internal` or `_external` amount fields. Required when `include_liability_cap` is true.",
- "enum": [
- "internal",
- "external"
- ],
- "type": "string"
- },
- "include_personal_data_biographic_info": {
- "type": "boolean"
- },
- "include_personal_data_contact_info": {
- "type": "boolean"
- },
- "include_personal_data_custom": {
- "type": "boolean"
- },
- "include_personal_data_custom_val": {
- "type": "string"
- },
- "include_personal_data_employment_info": {
- "type": "boolean"
- },
- "include_personal_data_financial_info": {
- "type": "boolean"
- },
- "include_personal_data_location": {
- "type": "boolean"
- },
- "include_personal_data_name": {
- "type": "boolean"
- },
- "include_personal_data_transactional_info": {
- "type": "boolean"
- },
- "include_personal_data_user_activity_info": {
- "type": "boolean"
- },
- "include_processing_purpose_custom": {
- "type": "boolean"
- },
- "include_processing_purpose_custom_val": {
- "type": "string"
- },
- "include_processing_purpose_erasing": {
- "type": "boolean"
- },
- "include_processing_purpose_holding": {
- "type": "boolean"
- },
- "include_processing_purpose_protecting": {
- "type": "boolean"
- },
- "include_processing_purpose_receiving": {
- "type": "boolean"
- },
- "include_processing_purpose_returning": {
- "type": "boolean"
- },
- "include_processing_purpose_sharing": {
- "type": "boolean"
- },
- "include_processing_purpose_updating": {
- "type": "boolean"
- },
- "include_processing_purpose_using": {
- "type": "boolean"
- },
- "include_provider_security_contact_address": {
- "type": "boolean"
- },
- "include_provider_security_contact_address_city": {
- "type": "string"
- },
- "include_provider_security_contact_address_country": {
- "type": "string"
- },
- "include_provider_security_contact_address_state": {
- "type": "string"
- },
- "include_provider_security_contact_address_street_address": {
- "type": "string"
- },
- "include_provider_security_contact_address_zipcode": {
- "type": "string"
- },
- "include_provider_security_contact_email": {
- "type": "boolean"
- },
- "include_provider_security_contact_email_val": {
- "format": "email",
- "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-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": "boolean"
- },
- "confidentiality_nda_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "confidentiality_nda_description": {
- "type": "string"
- },
- "confidentiality_nda_include_loi": {
- "type": "boolean"
- },
- "confidentiality_nda_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "confidentiality_type": {
- "enum": [
- "mutual",
- "nda",
- "provider",
- "custom"
- ],
- "type": "string"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_custom_details": {
- "type": "boolean"
- },
- "include_custom_details_val": {
- "type": "string"
- },
- "include_fees": {
- "type": "boolean"
- },
- "include_fees_amount": {
- "type": "number"
- },
- "include_fees_amount_duration": {
- "enum": [
- "month",
- "year",
- "quarter"
- ],
- "type": "string"
- },
- "include_fees_include_amount": {
- "type": "boolean"
- },
- "include_fees_include_other": {
- "type": "boolean"
- },
- "include_fees_other": {
- "type": "string"
- },
- "include_functionality": {
- "type": "boolean"
- },
- "include_functionality_val": {
- "type": "string"
- },
- "include_launch_date": {
- "type": "boolean"
- },
- "include_launch_date_custom": {
- "type": "string"
- },
- "include_launch_date_date": {
- "format": "date-time",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$",
- "type": "string"
- },
- "include_launch_date_type": {
- "enum": [
- "date",
- "custom"
- ],
- "type": "string"
- },
- "product_name": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "manual_send": {
- "description": "When true, the agreement is marked as manually sent outside the platform.",
- "type": "boolean"
- },
- "message": {
- "type": "string"
- },
- "partnership_attributes": {
- "additionalProperties": false,
- "description": "Override partnership terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "effective_date": {
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "effective_date_type": {
- "enum": [
- "signature",
- "date"
- ],
- "type": "string"
- },
- "general_cap_amount_currency_val": {
- "type": "number"
- },
- "general_cap_amount_either_currency": {
- "type": "number"
- },
- "general_cap_amount_either_multiple": {
- "type": "number"
- },
- "general_cap_amount_multiple_val": {
- "type": "number"
- },
- "general_cap_amount_type": {
- "enum": [
- "multiple",
- "currency",
- "either",
- "base"
- ],
- "type": "string"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_additional_warranties": {
- "type": "boolean"
- },
- "include_additional_warranties_include_company": {
- "type": "boolean"
- },
- "include_additional_warranties_include_company_val": {
- "type": "string"
- },
- "include_additional_warranties_include_partner": {
- "type": "boolean"
- },
- "include_additional_warranties_include_partner_val": {
- "type": "string"
- },
- "include_brand_guidelines": {
- "type": "boolean"
- },
- "include_brand_guidelines_include_company": {
- "type": "boolean"
- },
- "include_brand_guidelines_include_company_val": {
- "type": "string"
- },
- "include_brand_guidelines_include_partner": {
- "type": "boolean"
- },
- "include_brand_guidelines_include_partner_val": {
- "type": "string"
- },
- "include_covered_claims": {
- "type": "boolean"
- },
- "include_covered_claims_company_claims": {
- "type": "string"
- },
- "include_covered_claims_include_company_claims": {
- "type": "boolean"
- },
- "include_covered_claims_include_partner_claims": {
- "type": "boolean"
- },
- "include_covered_claims_partner_claims": {
- "type": "string"
- },
- "include_dpa": {
- "type": "boolean"
- },
- "include_dpa_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_dpa_location": {
- "type": "string"
- },
- "include_dpa_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_increased_cap_amount": {
- "type": "boolean"
- },
- "include_increased_cap_amount_currency": {
- "type": "number"
- },
- "include_increased_cap_amount_either_currency": {
- "type": "number"
- },
- "include_increased_cap_amount_either_multiple": {
- "type": "string"
- },
- "include_increased_cap_amount_multiple": {
- "type": "string"
- },
- "include_increased_cap_amount_type": {
- "enum": [
- "multiple",
- "currency",
- "either"
- ],
- "type": "string"
- },
- "include_increased_claims": {
- "type": "boolean"
- },
- "include_increased_claims_include_confidentiality": {
- "type": "boolean"
- },
- "include_increased_claims_include_confidentiality_misconduct": {
- "type": "boolean"
- },
- "include_increased_claims_include_covered_claims": {
- "type": "boolean"
- },
- "include_increased_claims_include_misconduct": {
- "type": "boolean"
- },
- "include_increased_claims_include_other": {
- "type": "boolean"
- },
- "include_increased_claims_include_other_val": {
- "type": "string"
- },
- "include_unlimited_claims": {
- "type": "boolean"
- },
- "include_unlimited_claims_confidentiality": {
- "type": "boolean"
- },
- "include_unlimited_claims_confidentiality_misconduct": {
- "type": "boolean"
- },
- "include_unlimited_claims_covered_claims": {
- "type": "boolean"
- },
- "include_unlimited_claims_misconduct": {
- "type": "boolean"
- },
- "include_unlimited_claims_other": {
- "type": "boolean"
- },
- "include_unlimited_claims_other_val": {
- "type": "string"
- },
- "negotiations_allowed": {
- "type": "boolean"
- }
- },
- "type": "object"
- },
- "partnership_business_terms_attributes": {
- "additionalProperties": false,
- "description": "Override partnership business terms terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "end_date_after_effective_date_amount": {
- "type": "number"
- },
- "end_date_after_effective_date_unit": {
- "enum": [
- "month(s)",
- "quarter(s)",
- "year(s)"
- ],
- "type": "string"
- },
- "end_date_date": {
- "type": "string"
- },
- "end_date_type": {
- "enum": [
- "date",
- "effective date"
- ],
- "type": "string"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_obligations_company_brand": {
- "type": "boolean"
- },
- "include_obligations_company_promotion": {
- "type": "boolean"
- },
- "include_obligations_company_promotion_include_activities": {
- "type": "boolean"
- },
- "include_obligations_company_promotion_include_activities_val": {
- "type": "string"
- },
- "include_obligations_company_promotion_include_materials": {
- "type": "boolean"
- },
- "include_obligations_company_promotion_include_materials_val": {
- "type": "string"
- },
- "include_obligations_company_referral": {
- "type": "boolean"
- },
- "include_obligations_company_referral_include_criteria": {
- "type": "boolean"
- },
- "include_obligations_company_referral_include_criteria_val": {
- "type": "string"
- },
- "include_obligations_company_referral_include_pay_sch": {
- "type": "boolean"
- },
- "include_obligations_company_referral_include_pay_sch_amount": {
- "type": "number"
- },
- "include_obligations_company_referral_include_pay_sch_custom": {
- "type": "string"
- },
- "include_obligations_company_referral_include_pay_sch_unit": {
- "enum": [
- "U.S. Dollars",
- "percent"
- ],
- "type": "string"
- },
- "include_obligations_company_sponsorship": {
- "type": "boolean"
- },
- "include_obligations_company_sponsorship_include_benefits": {
- "type": "boolean"
- },
- "include_obligations_company_sponsorship_include_benefits_val": {
- "type": "string"
- },
- "include_obligations_company_sponsorship_include_payments": {
- "type": "boolean"
- },
- "include_obligations_company_sponsorship_include_payments_amount": {
- "type": "number"
- },
- "include_obligations_company_sponsorship_include_payments_unit": {
- "enum": [
- "U.S. Dollars",
- "percent"
- ],
- "type": "string"
- },
- "include_obligations_partner_brand": {
- "type": "boolean"
- },
- "include_obligations_partner_promotion": {
- "type": "boolean"
- },
- "include_obligations_partner_promotion_include_activities": {
- "type": "boolean"
- },
- "include_obligations_partner_promotion_include_activities_val": {
- "type": "string"
- },
- "include_obligations_partner_promotion_include_materials": {
- "type": "boolean"
- },
- "include_obligations_partner_promotion_include_materials_val": {
- "type": "string"
- },
- "include_obligations_partner_referral": {
- "type": "boolean"
- },
- "include_obligations_partner_referral_include_criteria": {
- "type": "boolean"
- },
- "include_obligations_partner_referral_include_criteria_val": {
- "type": "string"
- },
- "include_obligations_partner_referral_include_pay_sch": {
- "type": "boolean"
- },
- "include_obligations_partner_referral_include_pay_sch_amount": {
- "type": "number"
- },
- "include_obligations_partner_referral_include_pay_sch_custom": {
- "type": "string"
- },
- "include_obligations_partner_referral_include_pay_sch_unit": {
- "enum": [
- "U.S. Dollars",
- "percent"
- ],
- "type": "string"
- },
- "include_obligations_partner_sponsorship": {
- "type": "boolean"
- },
- "include_obligations_partner_sponsorship_include_benefits": {
- "type": "boolean"
- },
- "include_obligations_partner_sponsorship_include_benefits_val": {
- "type": "string"
- },
- "include_obligations_partner_sponsorship_include_payments": {
- "type": "boolean"
- },
- "include_obligations_partner_sponsorship_include_payments_amount": {
- "type": "number"
- },
- "include_obligations_partner_sponsorship_include_payments_unit": {
- "enum": [
- "U.S. Dollars",
- "percent"
- ],
- "type": "string"
- },
- "include_payment_process": {
- "type": "boolean"
- },
- "include_payment_process_company": {
- "type": "boolean"
- },
- "include_payment_process_company_include_address": {
- "type": "boolean"
- },
- "include_payment_process_company_include_address_city": {
- "type": "string"
- },
- "include_payment_process_company_include_address_country": {
- "type": "string"
- },
- "include_payment_process_company_include_address_state": {
- "type": "string"
- },
- "include_payment_process_company_include_address_street_address": {
- "type": "string"
- },
- "include_payment_process_company_include_address_zipcode": {
- "type": "string"
- },
- "include_payment_process_company_include_email": {
- "type": "boolean"
- },
- "include_payment_process_company_include_email_val": {
- "type": "string"
- },
- "include_payment_process_partner": {
- "type": "boolean"
- },
- "include_payment_process_partner_include_address": {
- "type": "boolean"
- },
- "include_payment_process_partner_include_address_city": {
- "type": "string"
- },
- "include_payment_process_partner_include_address_country": {
- "type": "string"
- },
- "include_payment_process_partner_include_address_state": {
- "type": "string"
- },
- "include_payment_process_partner_include_address_street_address": {
- "type": "string"
- },
- "include_payment_process_partner_include_address_zipcode": {
- "type": "string"
- },
- "include_payment_process_partner_include_email": {
- "type": "boolean"
- },
- "include_payment_process_partner_include_email_val": {
- "type": "string"
- },
- "include_payment_schedule": {
- "type": "boolean"
- },
- "include_payment_schedule_custom": {
- "type": "string"
- },
- "include_payment_schedule_specified_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_payment_schedule_specified_timeframe": {
- "enum": [
- "receipt",
- "date"
- ],
- "type": "string"
- },
- "include_payment_schedule_specified_unit": {
- "enum": [
- "day(s)",
- "week(s)",
- "month(s)",
- "quarter(s)",
- "year(s)"
- ],
- "type": "string"
- },
- "include_payment_schedule_type": {
- "enum": [
- "specified",
- "custom"
- ],
- "type": "string"
- },
- "negotiations_allowed": {
- "type": "boolean"
- },
- "territory_type": {
- "enum": [
- "worldwide",
- "custom"
- ],
- "type": "string"
- },
- "territory_type_val": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "payment_link_url": {
- "description": "A payment URL shown to the recipient after signing. Requires include_billing_workflow to be true and billing_workflow_type to be \"link\".",
- "type": "string"
- },
- "pilot_attributes": {
- "additionalProperties": false,
- "description": "Override pilot terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "fees_type": {
- "enum": [
- "free",
- "pilot_period_fees"
- ],
- "type": "string"
- },
- "general_cap_amount": {
- "type": "number"
- },
- "general_cap_amount_type": {
- "enum": [
- "preceding",
- "base",
- "period"
- ],
- "type": "string"
- },
- "general_cap_period_currency": {
- "type": "number"
- },
- "general_cap_period_qty": {
- "type": "number"
- },
- "general_cap_preceding_amount": {
- "type": "number"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_dpa": {
- "type": "boolean"
- },
- "include_dpa_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_dpa_location": {
- "type": "string"
- },
- "include_dpa_type": {
- "enum": [
- "description",
- "attachment",
- "standard"
- ],
- "type": "string"
- },
- "include_payment_process": {
- "type": "boolean"
- },
- "include_technical_support": {
- "type": "boolean"
- },
- "negotiations_allowed": {
- "type": "boolean"
- },
- "payment_process_automatic_frequency": {
- "enum": [
- "monthly",
- "quarterly",
- "annually",
- "once_per_period"
- ],
- "type": "string"
- },
- "payment_process_invoice_days": {
- "type": "number"
- },
- "payment_process_invoice_from": {
- "enum": [
- "receipt",
- "date"
- ],
- "type": "string"
- },
- "payment_process_invoice_timeframe": {
- "enum": [
- "days",
- "weeks",
- "months",
- "quarters",
- "years"
- ],
- "type": "string"
- },
- "payment_process_type": {
- "enum": [
- "automatic",
- "invoice"
- ],
- "type": "string"
- },
- "pilot_period_description": {
- "type": "string"
- },
- "pilot_period_fees_description": {
- "type": "string"
- },
- "product_description": {
- "type": "string"
- },
- "technical_support_description": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "psa_attributes": {
- "additionalProperties": false,
- "description": "Override psa terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "additional_changes": {
- "type": "string"
- },
- "customer_description": {
- "type": "string"
- },
- "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": {
- "enum": [
- "signature",
- "date"
- ],
- "type": "string"
- },
- "general_cap_amount": {
- "type": "number"
- },
- "general_cap_amount_type": {
- "enum": [
- "preceding",
- "base",
- "period"
- ],
- "type": "string"
- },
- "general_cap_period_currency": {
- "type": "number"
- },
- "general_cap_period_qty": {
- "type": "number"
- },
- "general_cap_preceding_amount": {
- "type": "number"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_additional_changes": {
- "type": "boolean"
- },
- "include_additional_warranties": {
- "type": "boolean"
- },
- "include_additional_warranties_by_customer": {
- "type": "string"
- },
- "include_additional_warranties_by_provider": {
- "type": "string"
- },
- "include_additional_warranties_include_by_customer": {
- "type": "boolean"
- },
- "include_additional_warranties_include_by_provider": {
- "type": "boolean"
- },
- "include_covered_claims": {
- "type": "boolean"
- },
- "include_covered_claims_customer_claims": {
- "type": "string"
- },
- "include_covered_claims_include_customer_claims": {
- "type": "boolean"
- },
- "include_covered_claims_include_provider_claims": {
- "type": "boolean"
- },
- "include_covered_claims_provider_claims": {
- "type": "string"
- },
- "include_customer_insurance_min": {
- "type": "boolean"
- },
- "include_customer_insurance_min_add_provider_com_gen_liability": {
- "type": "boolean"
- },
- "include_customer_insurance_min_add_provider_cyber_liability": {
- "type": "boolean"
- },
- "include_customer_insurance_min_add_provider_errors_omissions": {
- "type": "boolean"
- },
- "include_customer_insurance_min_auto_liability_aggregate": {
- "type": "number"
- },
- "include_customer_insurance_min_auto_liability_minimum": {
- "type": "number"
- },
- "include_customer_insurance_min_cyber_liability_aggregate": {
- "type": "number"
- },
- "include_customer_insurance_min_cyber_liability_minimum": {
- "type": "number"
- },
- "include_customer_insurance_min_employer_liability_aggregate": {
- "type": "number"
- },
- "include_customer_insurance_min_employer_liability_minimum": {
- "type": "number"
- },
- "include_customer_insurance_min_general_liability_aggregate": {
- "type": "number"
- },
- "include_customer_insurance_min_general_liability_minimum": {
- "type": "number"
- },
- "include_customer_insurance_min_include_add_provider": {
- "type": "boolean"
- },
- "include_customer_insurance_min_include_auto_liability": {
- "type": "boolean"
- },
- "include_customer_insurance_min_include_cyber_liability": {
- "type": "boolean"
- },
- "include_customer_insurance_min_include_employer_liability": {
- "type": "boolean"
- },
- "include_customer_insurance_min_include_general_liability": {
- "type": "boolean"
- },
- "include_customer_insurance_min_include_workers_comp": {
- "type": "boolean"
- },
- "include_customer_policies": {
- "type": "boolean"
- },
- "include_customer_policies_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_customer_policies_location": {
- "type": "string"
- },
- "include_customer_policies_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_dpa": {
- "type": "boolean"
- },
- "include_dpa_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_dpa_location": {
- "type": "string"
- },
- "include_dpa_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_increased_cap_amount": {
- "type": "boolean"
- },
- "include_increased_claims": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_confidentiality": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_confidentiality_negligence": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_privsec": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_privsec_negligence": {
- "type": "boolean"
- },
- "include_increased_claims_include_other": {
- "type": "boolean"
- },
- "include_increased_claims_indemnification_obligation": {
- "type": "boolean"
- },
- "include_increased_claims_negligence": {
- "type": "boolean"
- },
- "include_increased_claims_other": {
- "type": "string"
- },
- "include_provider_insurance_min": {
- "type": "boolean"
- },
- "include_provider_insurance_min_add_customer_com_gen_liability": {
- "type": "boolean"
- },
- "include_provider_insurance_min_add_customer_cyber_liability": {
- "type": "boolean"
- },
- "include_provider_insurance_min_add_customer_errors_omissions": {
- "type": "boolean"
- },
- "include_provider_insurance_min_auto_liability_aggregate": {
- "type": "number"
- },
- "include_provider_insurance_min_auto_liability_minimum": {
- "type": "number"
- },
- "include_provider_insurance_min_cyber_liability_aggregate": {
- "type": "number"
- },
- "include_provider_insurance_min_cyber_liability_minimum": {
- "type": "number"
- },
- "include_provider_insurance_min_employer_liability_aggregate": {
- "type": "number"
- },
- "include_provider_insurance_min_employer_liability_minimum": {
- "type": "number"
- },
- "include_provider_insurance_min_general_liability_aggregate": {
- "type": "number"
- },
- "include_provider_insurance_min_general_liability_minimum": {
- "type": "number"
- },
- "include_provider_insurance_min_include_add_customer": {
- "type": "boolean"
- },
- "include_provider_insurance_min_include_auto_liability": {
- "type": "boolean"
- },
- "include_provider_insurance_min_include_cyber_liability": {
- "type": "boolean"
- },
- "include_provider_insurance_min_include_employer_liability": {
- "type": "boolean"
- },
- "include_provider_insurance_min_include_general_liability": {
- "type": "boolean"
- },
- "include_provider_insurance_min_include_workers_comp": {
- "type": "boolean"
- },
- "include_publicity_rights": {
- "type": "boolean"
- },
- "include_publicity_rights_type": {
- "enum": [
- "public",
- "non-public"
- ],
- "type": "string"
- },
- "include_security_policy": {
- "type": "boolean"
- },
- "include_security_policy_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_security_policy_fedramp_auth": {
- "type": "boolean"
- },
- "include_security_policy_hitrust": {
- "type": "boolean"
- },
- "include_security_policy_include_annual_maintenance": {
- "type": "boolean"
- },
- "include_security_policy_include_other": {
- "type": "boolean"
- },
- "include_security_policy_include_other_val": {
- "type": "string"
- },
- "include_security_policy_iso27001": {
- "type": "boolean"
- },
- "include_security_policy_location": {
- "type": "string"
- },
- "include_security_policy_pci1": {
- "type": "boolean"
- },
- "include_security_policy_pci2": {
- "type": "boolean"
- },
- "include_security_policy_penetration_testing": {
- "type": "boolean"
- },
- "include_security_policy_soc2_type1": {
- "type": "boolean"
- },
- "include_security_policy_soc2_type2": {
- "type": "boolean"
- },
- "include_security_policy_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_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": "string"
- },
- "increased_cap_amount_currency": {
- "type": "number"
- },
- "increased_cap_amount_period_currency": {
- "type": "number"
- },
- "increased_cap_amount_period_qty": {
- "type": "number"
- },
- "increased_cap_amount_qty": {
- "type": "number"
- },
- "increased_cap_amount_type": {
- "enum": [
- "qty",
- "currency",
- "period"
- ],
- "type": "string"
- },
- "negotiations_allowed": {
- "type": "boolean"
- },
- "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": "string"
- },
- "include_deliverables": {
- "type": "boolean"
- },
- "include_deliverables_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_deliverables_description": {
- "type": "string"
- },
- "include_deliverables_include_acceptance": {
- "type": "boolean"
- },
- "include_deliverables_include_attachment": {
- "type": "boolean"
- },
- "include_deliverables_include_draft_deliverables": {
- "type": "boolean"
- },
- "include_deliverables_rejection_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_deliverables_rejection_unit": {
- "enum": [
- "hours",
- "days",
- "weeks",
- "months"
- ],
- "type": "string"
- },
- "include_deliverables_resubmission_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_deliverables_resubmission_unit": {
- "enum": [
- "hours",
- "days",
- "weeks",
- "months"
- ],
- "type": "string"
- },
- "include_fees_other": {
- "type": "boolean"
- },
- "include_fees_other_val": {
- "type": "string"
- },
- "include_fees_table": {
- "type": "boolean"
- },
- "include_fees_table_total": {
- "type": "boolean"
- },
- "include_fees_travel": {
- "type": "boolean"
- },
- "include_fees_travel_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_fees_travel_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_fees_travel_val": {
- "type": "string"
- },
- "include_third_party_customer": {
- "type": "boolean"
- },
- "include_third_party_include_description": {
- "type": "boolean"
- },
- "include_third_party_include_description_val": {
- "type": "string"
- },
- "include_third_party_materials": {
- "type": "boolean"
- },
- "include_third_party_provider": {
- "type": "boolean"
- },
- "include_time_of_assignment": {
- "type": "boolean"
- },
- "include_time_of_assignment_type": {
- "enum": [
- "created",
- "paid"
- ],
- "type": "string"
- },
- "invoice_period_description": {
- "type": "string"
- },
- "negotiations_allowed": {
- "type": "boolean"
- },
- "payment_period": {
- "type": "number"
- },
- "payment_period_other": {
- "type": "string"
- },
- "payment_period_timeframe": {
- "enum": [
- "receipt",
- "invoice",
- "Customer's receipt of invoice",
- "date of invoice"
- ],
- "type": "string"
- },
- "payment_period_type": {
- "enum": [
- "standard",
- "other"
- ],
- "type": "string"
- },
- "payment_period_unit": {
- "enum": [
- "day(s)",
- "week(s)",
- "month(s)",
- "quarter(s)",
- "year(s)"
- ],
- "type": "string"
- },
- "quantity": {
- "type": "number"
- },
- "services_description": {
- "type": "string"
- },
- "sow_date": {
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "sow_date_type": {
- "enum": [
- "signature",
- "date"
- ],
- "type": "string"
- },
- "sow_term_amount": {
- "type": "number"
- },
- "sow_term_date": {
- "format": "date",
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
- "type": "string"
- },
- "sow_term_type": {
- "enum": [
- "deliverables",
- "period",
- "date"
- ],
- "type": "string"
- },
- "sow_term_unit": {
- "enum": [
- "month(s)",
- "quarter(s)",
- "year(s)"
- ],
- "type": "string"
- },
- "type": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "recipient_email": {
- "format": "email",
- "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-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": {
- "enum": [
- "signature",
- "date"
- ],
- "type": "string"
- },
- "general_cap_amount": {
- "type": "number"
- },
- "general_cap_amount_type": {
- "enum": [
- "preceding",
- "base",
- "period"
- ],
- "type": "string"
- },
- "general_cap_period_currency": {
- "type": "number"
- },
- "general_cap_period_qty": {
- "type": "number"
- },
- "general_cap_preceding_amount": {
- "type": "number"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_additional_warranties": {
- "type": "boolean"
- },
- "include_additional_warranties_by_customer": {
- "type": "string"
- },
- "include_additional_warranties_by_provider": {
- "type": "string"
- },
- "include_additional_warranties_include_by_customer": {
- "type": "boolean"
- },
- "include_additional_warranties_include_by_provider": {
- "type": "boolean"
- },
- "include_ai_addendum": {
- "type": "boolean"
- },
- "include_ai_addendum_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_covered_claims": {
- "type": "boolean"
- },
- "include_covered_claims_customer_claims": {
- "type": "string"
- },
- "include_covered_claims_include_customer_claims": {
- "type": "boolean"
- },
- "include_covered_claims_include_provider_claims": {
- "type": "boolean"
- },
- "include_covered_claims_provider_claims": {
- "type": "string"
- },
- "include_dpa": {
- "type": "boolean"
- },
- "include_dpa_attachment_id": {
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_dpa_location": {
- "type": "string"
- },
- "include_dpa_type": {
- "enum": [
- "description",
- "attachment"
- ],
- "type": "string"
- },
- "include_increased_cap_amount": {
- "type": "boolean"
- },
- "include_increased_claims": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_confidentiality": {
- "type": "boolean"
- },
- "include_increased_claims_breach_of_confidentiality_negligence": {
- "type": "boolean"
- },
- "include_increased_claims_include_other": {
- "type": "boolean"
- },
- "include_increased_claims_indemnification_obligation": {
- "type": "boolean"
- },
- "include_increased_claims_negligence": {
- "type": "boolean"
- },
- "include_increased_claims_other": {
- "type": "string"
- },
- "include_increased_claims_restrictions": {
- "type": "boolean"
- },
- "include_unlimited_claims": {
- "type": "boolean"
- },
- "include_unlimited_claims_breach_of_confidentiality": {
- "type": "boolean"
- },
- "include_unlimited_claims_breach_of_confidentiality_negligence": {
- "type": "boolean"
- },
- "include_unlimited_claims_include_other": {
- "type": "boolean"
- },
- "include_unlimited_claims_indemnification_obligation": {
- "type": "boolean"
- },
- "include_unlimited_claims_license_or_restrictions": {
- "type": "boolean"
- },
- "include_unlimited_claims_negligence": {
- "type": "boolean"
- },
- "include_unlimited_claims_other": {
- "type": "string"
- },
- "increased_cap_amount_currency": {
- "type": "number"
- },
- "increased_cap_amount_period_currency": {
- "type": "number"
- },
- "increased_cap_amount_period_qty": {
- "type": "number"
- },
- "increased_cap_amount_qty": {
- "type": "number"
- },
- "increased_cap_amount_type": {
- "enum": [
- "qty",
- "currency",
- "period"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- "software_license_order_form_attributes": {
- "additionalProperties": false,
- "description": "Override software license order form terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
- "properties": {
- "additional_changes": {
- "type": "string"
- },
- "deletion_procedure_include_custom": {
- "type": "boolean"
- },
- "deletion_procedure_include_custom_description": {
- "type": "string"
- },
- "deletion_procedure_include_customer_disable": {
- "type": "boolean"
- },
- "deletion_procedure_include_customer_proof": {
- "type": "boolean"
- },
- "deletion_procedure_include_provider_disable": {
- "type": "boolean"
- },
- "fee_custom_unit": {
- "type": "string"
- },
- "fee_period": {
- "enum": [
- "Subscription Period",
- "month",
- "year",
- "Custom unit"
- ],
- "type": "string"
- },
- "fees_attributes": {
- "additionalProperties": {
- "anyOf": [
- {
- "additionalProperties": false,
- "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": {
- "enum": [
- "USD",
- "EUR",
- "GBP",
- "CAD",
- "AUD",
- "SGD",
- "ILS",
- "JPY",
- "CHF",
- "HKD"
- ],
- "type": "string"
- },
- "fees_include_fee_increase_upon_renewal": {
- "type": "boolean"
- },
- "fees_include_fee_increase_upon_renewal_fee": {
- "type": "number"
- },
- "fees_include_fee_increase_upon_renewal_type": {
- "enum": [
- "will",
- "may"
- ],
- "type": "string"
- },
- "fees_inclusive_of_taxes": {
- "type": "boolean"
- },
- "id": {
- "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "include_additional_changes": {
- "type": "boolean"
- },
- "include_license_compliance_verification": {
- "type": "boolean"
- },
- "include_license_compliance_verification_description": {
- "type": "string"
- },
- "include_license_limits": {
- "type": "boolean"
- },
- "include_license_limits_description": {
- "type": "string"
- },
- "include_payment_process_include_billing_email": {
- "type": "boolean"
- },
- "include_pilot_period": {
- "type": "boolean"
- },
- "include_pilot_period_duration_amount": {
- "maximum": 9007199254740991,
- "minimum": -9007199254740991,
- "type": "integer"
- },
- "include_pilot_period_duration_type": {
- "enum": [
- "day",
- "week",
- "month"
- ],
- "type": "string"
- },
- "include_pilot_period_include_fees": {
- "type": "boolean"
- },
- "include_pilot_period_include_fees_amount": {
- "type": "number"
- },
- "include_pilot_period_include_modifications": {
- "type": "boolean"
- },
- "include_pilot_period_include_modifications_description": {
- "type": "string"
- },
- "include_services": {
- "type": "boolean"
- },
- "include_services_description": {
- "type": "string"
- },
- "negotiations_allowed": {
- "type": "boolean"
- },
- "order_date_date": {
- "type": "string"
- },
- "order_date_type": {
- "enum": [
- "signature",
- "date",
- "other"
- ],
- "type": "string"
- },
- "payment_process_automatic_frequency": {
- "enum": [
- "monthly",
- "quarterly",
- "semiannually",
- "annually"
- ],
- "type": "string"
- },
- "payment_process_type": {
- "enum": [
- "automatic",
- "invoice",
- "custom"
- ],
- "type": "string"
- },
- "payment_process_type_custom_val": {
- "type": "string"
- },
- "payment_process_type_invoice_amount": {
- "type": "number"
- },
- "payment_process_type_invoice_custom_unit": {
- "type": "string"
- },
- "payment_process_type_invoice_duration": {
- "enum": [
- "day",
- "week",
- "month",
- "year",
- "day(s)",
- "week(s)",
- "month(s)",
- "year(s)"
- ],
- "type": "string"
- },
- "payment_process_type_invoice_duration_start": {
- "enum": [
- "Customer's receipt of invoice",
- "date of invoice"
- ],
- "type": "string"
- },
- "payment_process_type_invoice_type": {
- "enum": [
- "monthly",
- "quarterly",
- "semiannually",
- "annually",
- "Custom unit"
- ],
- "type": "string"
- },
- "permitted_uses_include_custom": {
- "type": "boolean"
- },
- "permitted_uses_include_custom_description": {
- "type": "string"
- },
- "permitted_uses_include_customers_affiliates": {
- "type": "boolean"
- },
- "permitted_uses_include_internal_business": {
- "type": "boolean"
- },
- "pilot_period_stripe_product_id": {
- "type": "string"
- },
- "software_description": {
- "type": "string"
- },
- "subscription_auto_renew": {
- "enum": [
- "days",
- "subscription_end"
- ],
- "type": "string"
- },
- "subscription_period": {
- "type": "number"
- },
- "subscription_period_unit": {
- "type": "string"
- },
- "subscription_renewal_notice_days": {
- "type": "number"
- },
- "warranty_period_description_amount": {
- "type": "number"
- },
- "warranty_period_description_duration": {
- "enum": [
- "day",
- "week",
- "month",
- "year"
- ],
- "type": "string"
- },
- "warranty_period_description_duration_start": {
- "enum": [
- "initial delivery of the Software",
- "delivery of the Software and each subsequent Update",
- "the Order Date"
- ],
- "type": "string"
- },
- "warranty_period_type": {
- "enum": [
- "description",
- "none"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- "test_agreement": {
- "description": "When true, marks the agreement as a test. Test agreements do not count against your monthly limit.",
- "type": "boolean"
- }
- },
- "required": [
- "recipient_name",
- "recipient_email"
- ],
- "type": "object"
- },
- "cc_users": {
- "items": {
- "format": "email",
- "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
- "type": "string"
- },
- "type": "array"
- },
- "draft": {
- "description": "When true, the agreement is saved as a draft and not sent to the recipient. Use POST /v1/agreements/{id}/send to send a draft agreement later.",
- "type": "boolean"
- },
- "owner_id": {
- "description": "User id of the agreement owner (sender).",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "signer_id": {
- "description": "User id of the signer from the owner's organization.",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- },
- "template_id": {
- "description": "UUID of a template from `GET /v1/templates`. Accepts both Common Paper standard templates and uploaded PDF templates (`type` `uploaded_template`).",
- "format": "uuid",
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
- "type": "string"
- }
- },
- "required": [
- "template_id",
- "owner_id",
- "signer_id",
- "agreement"
- ],
- "type": "object"
- }
-]New value: +[
+ {
+ "additionalProperties": false,
+ "properties": {
+ "agreement": {
+ "additionalProperties": {},
+ "properties": {
+ "amendment_attributes": {
+ "additionalProperties": false,
+ "description": "Override amendment terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "amended_terms_attributes": {
+ "additionalProperties": {
+ "additionalProperties": false,
+ "properties": {
+ "description": {
+ "type": "string"
+ },
+ "term": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "description": "Amended terms. Use string keys such as \"0\", \"1\".",
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+ },
+ "amendment_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "amendment_date_type": {
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "type": "string"
+ },
+ "framework_terms_type": {
+ "type": "string"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "parent_agreement_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "underlying_agreement_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "underlying_agreement_type": {
+ "type": "string"
+ },
+ "underlying_agreement_val": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "baa_attributes": {
+ "additionalProperties": false,
+ "description": "Override baa terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "aggregation_limitations_permitted": {
+ "type": "boolean"
+ },
+ "aggregation_limitations_permitted_val": {
+ "type": "string"
+ },
+ "breach_notification_unit": {
+ "enum": [
+ "hours",
+ "business days",
+ "calendar days"
+ ],
+ "type": "string"
+ },
+ "breach_notification_val": {
+ "type": "number"
+ },
+ "business_associate_relationship_type": {
+ "enum": [
+ "provider",
+ "company"
+ ],
+ "type": "string"
+ },
+ "deidentification_limitations_include_purpose": {
+ "type": "boolean"
+ },
+ "deidentification_limitations_include_requirements": {
+ "type": "boolean"
+ },
+ "deidentification_limitations_permitted": {
+ "type": "boolean"
+ },
+ "deidentification_limitations_purpose_val": {
+ "type": "string"
+ },
+ "deidentification_limitations_requirements_val": {
+ "type": "string"
+ },
+ "designated_record_set_provider_maintains": {
+ "type": "boolean"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_aggregation_limitations": {
+ "type": "boolean"
+ },
+ "include_deidentification_limitations": {
+ "type": "boolean"
+ },
+ "include_limitations": {
+ "type": "boolean"
+ },
+ "include_offshore_limitations": {
+ "type": "boolean"
+ },
+ "include_subcontract_limitations": {
+ "type": "boolean"
+ },
+ "offshore_limitations_permitted": {
+ "type": "boolean"
+ },
+ "offshore_limitations_permitted_val": {
+ "type": "string"
+ },
+ "subcontract_limitations_include_notice": {
+ "type": "boolean"
+ },
+ "subcontract_limitations_include_permission": {
+ "type": "boolean"
+ },
+ "subcontract_limitations_notice_val": {
+ "type": "string"
+ },
+ "subcontract_limitations_permission_val": {
+ "type": "string"
+ },
+ "subcontract_limitations_permitted": {
+ "type": "boolean"
+ },
+ "underlying_agreement_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "underlying_agreement_type": {
+ "enum": [
+ "internal",
+ "external",
+ "none"
+ ],
+ "type": "string"
+ },
+ "underlying_agreement_val": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "billing_email": {
+ "description": "Email of the billing contact. Used when include_billing_info is true.",
+ "format": "email",
+ "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "billing_name": {
+ "description": "Name of the billing contact. Used when include_billing_info is true.",
+ "type": "string"
+ },
+ "billing_workflow_type": {
+ "description": "The type of billing workflow. Use \"link\" to provide a payment_link_url, or \"stripe\" for Stripe-managed billing.",
+ "enum": [
+ "link",
+ "stripe"
+ ],
+ "type": "string"
+ },
+ "chosen_courts_country": {
+ "description": "The country in which disputes will be resolved.",
+ "type": "string"
+ },
+ "chosen_courts_region": {
+ "description": "The state or region in which disputes will be resolved.",
+ "type": "string"
+ },
+ "csa_attributes": {
+ "additionalProperties": false,
+ "description": "Override csa terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "customer_description": {
+ "type": "string"
+ },
+ "effective_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "effective_date_marketplace": {
+ "enum": [
+ "AWS",
+ "GCP",
+ "Azure"
+ ],
+ "type": "string"
+ },
+ "effective_date_type": {
+ "enum": [
+ "signature",
+ "date",
+ "marketplace_acceptance"
+ ],
+ "type": "string"
+ },
+ "general_cap_amount": {
+ "type": "number"
+ },
+ "general_cap_amount_type": {
+ "enum": [
+ "preceding",
+ "base",
+ "period"
+ ],
+ "type": "string"
+ },
+ "general_cap_period_currency": {
+ "type": "number"
+ },
+ "general_cap_period_qty": {
+ "type": "number"
+ },
+ "general_cap_preceding_amount": {
+ "type": "number"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_acceptable_use_policy": {
+ "type": "boolean"
+ },
+ "include_acceptable_use_policy_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_acceptable_use_policy_location": {
+ "type": "string"
+ },
+ "include_acceptable_use_policy_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_additional_warranties": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_by_customer": {
+ "type": "string"
+ },
+ "include_additional_warranties_by_provider": {
+ "type": "string"
+ },
+ "include_additional_warranties_include_by_customer": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_include_by_provider": {
+ "type": "boolean"
+ },
+ "include_ai_addendum": {
+ "type": "boolean"
+ },
+ "include_ai_addendum_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_covered_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_customer_claims": {
+ "type": "string"
+ },
+ "include_covered_claims_include_customer_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_include_provider_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_provider_claims": {
+ "type": "string"
+ },
+ "include_dpa": {
+ "type": "boolean"
+ },
+ "include_dpa_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_dpa_location": {
+ "type": "string"
+ },
+ "include_dpa_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_increased_cap_amount": {
+ "type": "boolean"
+ },
+ "include_increased_claims": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_confidentiality": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_confidentiality_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_privsec": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_privsec_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_other": {
+ "type": "boolean"
+ },
+ "include_increased_claims_indemnification_obligation": {
+ "type": "boolean"
+ },
+ "include_increased_claims_other": {
+ "type": "string"
+ },
+ "include_insurance_minimums": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_add_customer": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_add_customer_com_gen_liability": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_add_customer_cyber_liability": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_add_customer_errors_omissions": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_additional_information": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_additional_information_text": {
+ "type": "string"
+ },
+ "include_insurance_minimums_cyber_liability_aggregate": {
+ "type": "number"
+ },
+ "include_insurance_minimums_cyber_liability_minimum": {
+ "type": "number"
+ },
+ "include_insurance_minimums_employer_liability_aggregate": {
+ "type": "number"
+ },
+ "include_insurance_minimums_employer_liability_minimum": {
+ "type": "number"
+ },
+ "include_insurance_minimums_general_liability_aggregate": {
+ "type": "number"
+ },
+ "include_insurance_minimums_general_liability_minimum": {
+ "type": "number"
+ },
+ "include_insurance_minimums_include_cyber_liability": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_include_employer_liability": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_include_general_liability": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_include_workers_compensation": {
+ "type": "boolean"
+ },
+ "include_publicity_rights": {
+ "type": "boolean"
+ },
+ "include_publicity_rights_type": {
+ "enum": [
+ "public",
+ "non-public"
+ ],
+ "type": "string"
+ },
+ "include_security_policy": {
+ "type": "boolean"
+ },
+ "include_security_policy_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_security_policy_fedramp_auth": {
+ "type": "boolean"
+ },
+ "include_security_policy_hipaa": {
+ "type": "boolean"
+ },
+ "include_security_policy_hitrust": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_annual_maintenance": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_location": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_other": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_reasonable_efforts": {
+ "type": "boolean"
+ },
+ "include_security_policy_iso27001": {
+ "type": "boolean"
+ },
+ "include_security_policy_location": {
+ "type": "string"
+ },
+ "include_security_policy_other": {
+ "type": "string"
+ },
+ "include_security_policy_pci1": {
+ "type": "boolean"
+ },
+ "include_security_policy_pci2": {
+ "type": "boolean"
+ },
+ "include_security_policy_penetration_testing": {
+ "type": "boolean"
+ },
+ "include_security_policy_soc2": {
+ "type": "boolean"
+ },
+ "include_security_policy_soc2_type2": {
+ "type": "boolean"
+ },
+ "include_security_policy_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_supercap": {
+ "description": "CSA 3.0 renamed `include_increased_cap_amount` to `include_supercap`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_increased_cap_amount`. Sending the other spelling returns a 422.",
+ "type": "boolean"
+ },
+ "include_uncapped_claims": {
+ "description": "CSA 3.0 renamed `include_unlimited_claims` to `include_uncapped_claims`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims`. Sending the other spelling returns a 422.",
+ "type": "boolean"
+ },
+ "include_uncapped_claims_breach_of_confidentiality": {
+ "description": "CSA 3.0 renamed `include_unlimited_claims_breach_of_confidentiality` to `include_uncapped_claims_breach_of_confidentiality`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_breach_of_confidentiality`. Sending the other spelling returns a 422.",
+ "type": "boolean"
+ },
+ "include_uncapped_claims_breach_of_confidentiality_negligence": {
+ "description": "CSA 3.0 renamed `include_unlimited_claims_breach_of_confidentiality_negligence` to `include_uncapped_claims_breach_of_confidentiality_negligence`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_breach_of_confidentiality_negligence`. Sending the other spelling returns a 422.",
+ "type": "boolean"
+ },
+ "include_uncapped_claims_breach_of_privsec": {
+ "description": "CSA 3.0 renamed `include_unlimited_claims_breach_of_privsec` to `include_uncapped_claims_breach_of_privsec`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_breach_of_privsec`. Sending the other spelling returns a 422.",
+ "type": "boolean"
+ },
+ "include_uncapped_claims_breach_of_privsec_negligence": {
+ "description": "CSA 3.0 renamed `include_unlimited_claims_breach_of_privsec_negligence` to `include_uncapped_claims_breach_of_privsec_negligence`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_breach_of_privsec_negligence`. Sending the other spelling returns a 422.",
+ "type": "boolean"
+ },
+ "include_uncapped_claims_include_other": {
+ "description": "CSA 3.0 renamed `include_unlimited_claims_include_other` to `include_uncapped_claims_include_other`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_include_other`. Sending the other spelling returns a 422.",
+ "type": "boolean"
+ },
+ "include_uncapped_claims_indemnification_obligation": {
+ "description": "CSA 3.0 renamed `include_unlimited_claims_indemnification_obligation` to `include_uncapped_claims_indemnification_obligation`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_indemnification_obligation`. Sending the other spelling returns a 422.",
+ "type": "boolean"
+ },
+ "include_uncapped_claims_other": {
+ "description": "CSA 3.0 renamed `include_unlimited_claims_other` to `include_uncapped_claims_other`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_other`. Sending the other spelling returns a 422.",
+ "type": "boolean"
+ },
+ "include_unlimited_claims": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_confidentiality": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_confidentiality_negligence": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_privsec": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_privsec_negligence": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_include_other": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_indemnification_obligation": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_other": {
+ "type": "string"
+ },
+ "increased_cap_amount_currency": {
+ "type": "number"
+ },
+ "increased_cap_amount_period_currency": {
+ "type": "number"
+ },
+ "increased_cap_amount_period_qty": {
+ "type": "number"
+ },
+ "increased_cap_amount_qty": {
+ "type": "number"
+ },
+ "increased_cap_amount_type": {
+ "enum": [
+ "qty",
+ "currency",
+ "period"
+ ],
+ "type": "string"
+ },
+ "provider": {
+ "type": "string"
+ },
+ "supercap_currency": {
+ "description": "CSA 3.0 renamed `increased_cap_amount_currency` to `supercap_currency`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `increased_cap_amount_currency`. Sending the other spelling returns a 422.",
+ "type": "number"
+ },
+ "supercap_period_currency": {
+ "description": "CSA 3.0 renamed `increased_cap_amount_period_currency` to `supercap_period_currency`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `increased_cap_amount_period_currency`. Sending the other spelling returns a 422.",
+ "type": "number"
+ },
+ "supercap_period_qty": {
+ "description": "CSA 3.0 renamed `increased_cap_amount_period_qty` to `supercap_period_qty`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `increased_cap_amount_period_qty`. Sending the other spelling returns a 422.",
+ "type": "number"
+ },
+ "supercap_qty": {
+ "description": "CSA 3.0 renamed `increased_cap_amount_qty` to `supercap_qty`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `increased_cap_amount_qty`. Sending the other spelling returns a 422.",
+ "type": "number"
+ },
+ "supercap_type": {
+ "description": "CSA 3.0 renamed `increased_cap_amount_type` to `supercap_type`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `increased_cap_amount_type`. Sending the other spelling returns a 422.",
+ "type": "number"
+ }
+ },
+ "type": "object"
+ },
+ "csa_order_form_attributes": {
+ "additionalProperties": false,
+ "description": "Override csa order form terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "additional_changes": {
+ "type": "string"
+ },
+ "additional_parameters_or_limitations": {
+ "type": "string"
+ },
+ "affiliates_as_users": {
+ "type": "boolean"
+ },
+ "cloud_service_description": {
+ "type": "string"
+ },
+ "consumption_units": {
+ "type": "string"
+ },
+ "fee_amount": {
+ "type": "number"
+ },
+ "fee_custom_unit": {
+ "type": "string"
+ },
+ "fee_period": {
+ "enum": [
+ "Subscription Period",
+ "month",
+ "year",
+ "User",
+ "Custom unit"
+ ],
+ "type": "string"
+ },
+ "fees_attributes": {
+ "additionalProperties": {
+ "anyOf": [
+ {
+ "additionalProperties": false,
+ "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": {
+ "enum": [
+ "USD",
+ "EUR",
+ "GBP",
+ "CAD",
+ "AUD",
+ "SGD",
+ "ILS",
+ "JPY",
+ "CHF",
+ "HKD"
+ ],
+ "type": "string"
+ },
+ "fees_include_fee_increase_upon_renewal": {
+ "type": "boolean"
+ },
+ "fees_include_fee_increase_upon_renewal_fee": {
+ "type": "number"
+ },
+ "fees_include_fee_increase_upon_renewal_type": {
+ "enum": [
+ "will",
+ "may"
+ ],
+ "type": "string"
+ },
+ "fees_inclusive_of_taxes": {
+ "type": "boolean"
+ },
+ "framework_terms_type": {
+ "enum": [
+ "new",
+ "existing",
+ "description"
+ ],
+ "type": "string"
+ },
+ "free_trial_days": {
+ "type": "number"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_additional_changes": {
+ "type": "boolean"
+ },
+ "include_additional_parameters_or_limitations": {
+ "type": "boolean"
+ },
+ "include_consumption": {
+ "type": "boolean"
+ },
+ "include_fees": {
+ "type": "boolean"
+ },
+ "include_fees_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_fees_include_attachment": {
+ "type": "boolean"
+ },
+ "include_fees_other": {
+ "type": "boolean"
+ },
+ "include_fees_other_val": {
+ "type": "string"
+ },
+ "include_fees_table": {
+ "type": "boolean"
+ },
+ "include_fees_table_period": {
+ "enum": [
+ "Subscription Period",
+ "month",
+ "year",
+ "User"
+ ],
+ "type": "string"
+ },
+ "include_free_trial": {
+ "type": "boolean"
+ },
+ "include_max_users": {
+ "type": "boolean"
+ },
+ "include_pilot_period": {
+ "type": "boolean"
+ },
+ "include_pilot_period_duration_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_pilot_period_duration_type": {
+ "enum": [
+ "day",
+ "week",
+ "month"
+ ],
+ "type": "string"
+ },
+ "include_pilot_period_include_fees": {
+ "type": "boolean"
+ },
+ "include_pilot_period_include_fees_amount": {
+ "type": "number"
+ },
+ "include_pilot_period_include_modifications": {
+ "type": "boolean"
+ },
+ "include_pilot_period_include_modifications_description": {
+ "type": "string"
+ },
+ "include_product_support": {
+ "type": "boolean"
+ },
+ "include_product_support_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_product_support_description": {
+ "type": "string"
+ },
+ "include_product_support_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_professional_services": {
+ "type": "boolean"
+ },
+ "include_professional_services_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_professional_services_custom_name": {
+ "type": "string"
+ },
+ "include_professional_services_description": {
+ "type": "string"
+ },
+ "include_professional_services_end_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "include_professional_services_fees_description": {
+ "type": "string"
+ },
+ "include_professional_services_include_end_date": {
+ "type": "boolean"
+ },
+ "include_professional_services_include_fees_description": {
+ "type": "boolean"
+ },
+ "include_professional_services_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_sla": {
+ "type": "boolean"
+ },
+ "include_sla_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_sla_description": {
+ "type": "string"
+ },
+ "include_sla_include_response_time": {
+ "type": "boolean"
+ },
+ "include_sla_include_response_time_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_sla_include_response_time_credit": {
+ "type": "number"
+ },
+ "include_sla_include_response_time_duration": {
+ "enum": [
+ "hour",
+ "day",
+ "week",
+ "month",
+ "hours"
+ ],
+ "type": "string"
+ },
+ "include_sla_include_response_time_support_channel": {
+ "type": "string"
+ },
+ "include_sla_include_target_uptime": {
+ "type": "boolean"
+ },
+ "include_sla_maintenance_notice": {
+ "type": "boolean"
+ },
+ "include_sla_maintenance_window": {
+ "type": "boolean"
+ },
+ "include_sla_maintenance_window_type": {
+ "enum": [
+ "standard",
+ "none"
+ ],
+ "type": "string"
+ },
+ "include_sla_standard_maintenance_notice_qty": {
+ "type": "number"
+ },
+ "include_sla_standard_maintenance_notice_unit": {
+ "enum": [
+ "hour",
+ "day",
+ "week",
+ "month"
+ ],
+ "type": "string"
+ },
+ "include_sla_standard_maintenance_window_end_time": {
+ "type": "string"
+ },
+ "include_sla_standard_maintenance_window_friday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_monday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_saturday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_start_time": {
+ "type": "string"
+ },
+ "include_sla_standard_maintenance_window_sunday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_thursday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_time_zone": {
+ "type": "string"
+ },
+ "include_sla_standard_maintenance_window_tuesday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_wednesday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_target_uptime": {
+ "type": "number"
+ },
+ "include_sla_type": {
+ "enum": [
+ "description",
+ "standard",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_subscription_start_date": {
+ "type": "boolean"
+ },
+ "include_subscription_start_date_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "include_usage_review": {
+ "type": "boolean"
+ },
+ "include_usage_review_val": {
+ "type": "string"
+ },
+ "include_use_limitations": {
+ "type": "boolean"
+ },
+ "include_use_limitations_val": {
+ "type": "string"
+ },
+ "invoice_period": {
+ "enum": [
+ "monthly",
+ "quarterly",
+ "semiannually",
+ "annually",
+ "Custom unit",
+ "Monthly",
+ "Quarterly",
+ "Semiannually",
+ "Annually"
+ ],
+ "type": "string"
+ },
+ "invoice_period_custom_unit": {
+ "type": "string"
+ },
+ "max_consumption": {
+ "type": "number"
+ },
+ "max_users": {
+ "type": "number"
+ },
+ "negotiations_allowed": {
+ "description": "When true, the recipient can propose changes to the order form, even when the agreement-level `negotiations_allowed` is false. This only covers the order form.",
+ "type": "boolean"
+ },
+ "order_date_date": {
+ "type": "string"
+ },
+ "order_date_other": {
+ "type": "string"
+ },
+ "order_date_type": {
+ "enum": [
+ "signature",
+ "date",
+ "other"
+ ],
+ "type": "string"
+ },
+ "payment_period": {
+ "type": "number"
+ },
+ "payment_period_timeframe": {
+ "enum": [
+ "Customer's receipt of invoice",
+ "date of invoice"
+ ],
+ "type": "string"
+ },
+ "payment_period_unit": {
+ "enum": [
+ "day(s)",
+ "week(s)",
+ "month(s)",
+ "marketplace_acceptance"
+ ],
+ "type": "string"
+ },
+ "payment_process_automatic_frequency": {
+ "enum": [
+ "monthly",
+ "quarterly",
+ "semiannually",
+ "annually"
+ ],
+ "type": "string"
+ },
+ "payment_process_type": {
+ "enum": [
+ "automatic",
+ "invoice",
+ "custom",
+ "marketplace_acceptance"
+ ],
+ "type": "string"
+ },
+ "payment_process_type_custom_val": {
+ "type": "string"
+ },
+ "payment_process_type_invoice_amount": {
+ "type": "number"
+ },
+ "payment_process_type_invoice_custom_unit": {
+ "type": "string"
+ },
+ "payment_process_type_invoice_duration": {
+ "enum": [
+ "day",
+ "week",
+ "month",
+ "year",
+ "day(s)",
+ "week(s)",
+ "month(s)",
+ "year(s)"
+ ],
+ "type": "string"
+ },
+ "payment_process_type_invoice_duration_start": {
+ "enum": [
+ "Customer's receipt of invoice",
+ "date of invoice"
+ ],
+ "type": "string"
+ },
+ "payment_process_type_invoice_type": {
+ "enum": [
+ "monthly",
+ "quarterly",
+ "semiannually",
+ "annually",
+ "Custom unit"
+ ],
+ "type": "string"
+ },
+ "pilot_period_stripe_product_id": {
+ "type": "string"
+ },
+ "service_credits_attributes": {
+ "additionalProperties": {
+ "additionalProperties": false,
+ "properties": {
+ "credit": {
+ "type": "number"
+ },
+ "max": {
+ "type": "number"
+ },
+ "min": {
+ "type": "number"
+ }
+ },
+ "type": "object"
+ },
+ "description": "Service credits. Use string keys such as \"0\", \"1\".",
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+ },
+ "subscription_auto_renew": {
+ "enum": [
+ "days",
+ "subscription_end"
+ ],
+ "type": "string"
+ },
+ "subscription_period": {
+ "type": "number"
+ },
+ "subscription_period_unit": {
+ "type": "string"
+ },
+ "subscription_renewal_notice_days": {
+ "type": "number"
+ },
+ "subscription_start_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "subscription_start_date_type": {
+ "enum": [
+ "effective_date",
+ "date"
+ ],
+ "type": "string"
+ },
+ "underlying_agreement_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "use_limitations_attributes": {
+ "additionalProperties": {
+ "additionalProperties": false,
+ "properties": {
+ "amount": {
+ "type": "number"
+ },
+ "limitation_type": {
+ "type": "string"
+ },
+ "unit": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "description": "Use limitations. Use string keys such as \"0\", \"1\".",
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+ }
+ },
+ "type": "object"
+ },
+ "custom_field_values": {
+ "description": "Values for a custom template's fields, keyed by the field keys defined in the template's YAML definition. Only used when template_id is a custom template. Template defaults fill any fields you omit; a required field with no default and no submitted value returns a 400 naming the field. Values are validated against the field's input type: select and radio values must be one of the field's options, multiselect values are an array of selections each of which must be one of the field's options, number and currency values must be numeric, date values must be YYYY-MM-DD, and email values must be valid addresses. An invalid value returns a 400 naming the field."
+ },
+ "design_partner_attributes": {
+ "additionalProperties": false,
+ "description": "Override design partner terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "customer_description": {
+ "type": "string"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_fees": {
+ "type": "boolean"
+ },
+ "include_fees_amount": {
+ "type": "number"
+ },
+ "include_fees_description": {
+ "type": "string"
+ },
+ "include_fees_pay_by_amount": {
+ "type": "string"
+ },
+ "include_fees_type": {
+ "enum": [
+ "default_language",
+ "description"
+ ],
+ "type": "string"
+ },
+ "include_fees_unit": {
+ "enum": [
+ "month",
+ "quarter",
+ "year",
+ "Term"
+ ],
+ "type": "string"
+ },
+ "include_program_appear_as_customer_private": {
+ "type": "boolean"
+ },
+ "include_program_appear_as_customer_public": {
+ "type": "boolean"
+ },
+ "include_program_case_study": {
+ "type": "boolean"
+ },
+ "include_program_develop_functionality": {
+ "type": "boolean"
+ },
+ "include_program_develop_functionality_val": {
+ "type": "string"
+ },
+ "include_program_discount": {
+ "type": "boolean"
+ },
+ "include_program_discount_amount": {
+ "type": "number"
+ },
+ "include_program_discount_unit": {
+ "enum": [
+ "U.S. Dollars",
+ "percent"
+ ],
+ "type": "string"
+ },
+ "include_program_participation_feedback": {
+ "type": "boolean"
+ },
+ "include_program_participation_feedback_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_program_participation_feedback_unit": {
+ "enum": [
+ "month",
+ "quarter",
+ "year",
+ "Term"
+ ],
+ "type": "string"
+ },
+ "include_program_partner_other": {
+ "type": "boolean"
+ },
+ "include_program_partner_other_val": {
+ "type": "string"
+ },
+ "include_program_provider_other": {
+ "type": "boolean"
+ },
+ "include_program_provider_other_val": {
+ "type": "string"
+ },
+ "include_program_reference": {
+ "type": "boolean"
+ },
+ "product_description": {
+ "type": "string"
+ },
+ "term_amount": {
+ "type": "number"
+ },
+ "term_unit": {
+ "enum": [
+ "day(s)",
+ "week(s)",
+ "month(s)",
+ "quarter(s)",
+ "year(s)"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "district_or_county": {
+ "description": "The district or county for dispute resolution.",
+ "type": "string"
+ },
+ "dpa_attributes": {
+ "additionalProperties": false,
+ "description": "Override dpa terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "approved_subprocessor_type": {
+ "description": "`internal` lists approved subprocessors in the agreement (`subprocessors_attributes`); `external` points to a list published elsewhere.",
+ "enum": [
+ "internal",
+ "external"
+ ],
+ "type": "string"
+ },
+ "cloud_service_product_name": {
+ "type": "string"
+ },
+ "competent_supervisory_authority": {
+ "type": "string"
+ },
+ "customer_description": {
+ "type": "string"
+ },
+ "data_exporter_address_city": {
+ "type": "string"
+ },
+ "data_exporter_address_country": {
+ "type": "string"
+ },
+ "data_exporter_address_state": {
+ "type": "string"
+ },
+ "data_exporter_address_street_address": {
+ "type": "string"
+ },
+ "data_exporter_address_zipcode": {
+ "type": "string"
+ },
+ "data_exporter_contact_details": {
+ "type": "string"
+ },
+ "data_exporter_contact_name": {
+ "type": "string"
+ },
+ "data_exporter_contact_position": {
+ "type": "string"
+ },
+ "data_exporter_role": {
+ "description": "Role of the data exporter. Overwritten to `Controller` when the agreement is created from a template.",
+ "enum": [
+ "Controller",
+ "Processor"
+ ],
+ "type": "string"
+ },
+ "data_importer_address": {
+ "type": "string"
+ },
+ "data_importer_address_city": {
+ "type": "string"
+ },
+ "data_importer_address_country": {
+ "type": "string"
+ },
+ "data_importer_address_state": {
+ "type": "string"
+ },
+ "data_importer_address_street_address": {
+ "type": "string"
+ },
+ "data_importer_address_zipcode": {
+ "type": "string"
+ },
+ "data_importer_contact_details": {
+ "type": "string"
+ },
+ "data_importer_contact_name": {
+ "type": "string"
+ },
+ "data_importer_contact_position": {
+ "type": "string"
+ },
+ "duration_of_processing": {
+ "type": "string"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_covered_claim": {
+ "type": "boolean"
+ },
+ "include_covered_claim_external_val": {
+ "type": "string"
+ },
+ "include_covered_claim_internal_val": {
+ "type": "string"
+ },
+ "include_covered_claim_type": {
+ "description": "Which covered-claim text applies: `internal` uses `include_covered_claim_internal_val`, `external` uses `include_covered_claim_external_val`. Required when `include_covered_claim` is true.",
+ "enum": [
+ "internal",
+ "external"
+ ],
+ "type": "string"
+ },
+ "include_data_subjects_custom": {
+ "type": "boolean"
+ },
+ "include_data_subjects_custom_val": {
+ "type": "string"
+ },
+ "include_data_subjects_employees": {
+ "type": "boolean"
+ },
+ "include_data_subjects_end_users": {
+ "type": "boolean"
+ },
+ "include_external_subprocessor_location": {
+ "type": "string"
+ },
+ "include_frequency_of_transfer_continuous": {
+ "type": "boolean"
+ },
+ "include_frequency_of_transfer_custom": {
+ "type": "boolean"
+ },
+ "include_frequency_of_transfer_custom_val": {
+ "type": "string"
+ },
+ "include_governing_country_eu": {
+ "type": "boolean"
+ },
+ "include_governing_country_eu_val": {
+ "type": "string"
+ },
+ "include_governing_country_uk": {
+ "type": "boolean"
+ },
+ "include_governing_country_uk_val": {
+ "type": "string"
+ },
+ "include_governing_law": {
+ "type": "boolean"
+ },
+ "include_governing_law_country": {
+ "type": "string"
+ },
+ "include_governing_law_state": {
+ "type": "string"
+ },
+ "include_increased_claim_amount": {
+ "description": "Legacy field. Stored but not shown on the DPA; use the `include_liability_cap*` fields instead.",
+ "type": "boolean"
+ },
+ "include_increased_claim_amount_currency": {
+ "description": "Legacy field. Stored but not shown on the DPA; use the `include_liability_cap*` fields instead."
+ },
+ "include_increased_claim_amount_qty": {
+ "description": "Legacy field. Stored but not shown on the DPA; use the `include_liability_cap*` fields instead."
+ },
+ "include_increased_claim_amount_type": {
+ "description": "Legacy field. Stored but not shown on the DPA; use the `include_liability_cap*` fields instead.",
+ "type": "string"
+ },
+ "include_liability_cap": {
+ "type": "boolean"
+ },
+ "include_liability_cap_amount_constant_external": {
+ "type": "string"
+ },
+ "include_liability_cap_amount_constant_internal": {
+ "type": "string"
+ },
+ "include_liability_cap_amount_currency_external": {
+ "description": "Currency amount. Numbers and numeric strings (commas allowed) are both accepted."
+ },
+ "include_liability_cap_amount_currency_internal": {
+ "description": "Currency amount. Numbers and numeric strings (commas allowed) are both accepted."
+ },
+ "include_liability_cap_csa_type": {
+ "description": "Which liability cap values apply: the `_internal` or `_external` amount fields. Required when `include_liability_cap` is true.",
+ "enum": [
+ "internal",
+ "external"
+ ],
+ "type": "string"
+ },
+ "include_personal_data_biographic_info": {
+ "type": "boolean"
+ },
+ "include_personal_data_contact_info": {
+ "type": "boolean"
+ },
+ "include_personal_data_custom": {
+ "type": "boolean"
+ },
+ "include_personal_data_custom_val": {
+ "type": "string"
+ },
+ "include_personal_data_employment_info": {
+ "type": "boolean"
+ },
+ "include_personal_data_financial_info": {
+ "type": "boolean"
+ },
+ "include_personal_data_location": {
+ "type": "boolean"
+ },
+ "include_personal_data_name": {
+ "type": "boolean"
+ },
+ "include_personal_data_transactional_info": {
+ "type": "boolean"
+ },
+ "include_personal_data_user_activity_info": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_custom": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_custom_val": {
+ "type": "string"
+ },
+ "include_processing_purpose_erasing": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_holding": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_protecting": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_receiving": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_returning": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_sharing": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_updating": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_using": {
+ "type": "boolean"
+ },
+ "include_provider_security_contact_address": {
+ "type": "boolean"
+ },
+ "include_provider_security_contact_address_city": {
+ "type": "string"
+ },
+ "include_provider_security_contact_address_country": {
+ "type": "string"
+ },
+ "include_provider_security_contact_address_state": {
+ "type": "string"
+ },
+ "include_provider_security_contact_address_street_address": {
+ "type": "string"
+ },
+ "include_provider_security_contact_address_zipcode": {
+ "type": "string"
+ },
+ "include_provider_security_contact_email": {
+ "type": "boolean"
+ },
+ "include_provider_security_contact_email_val": {
+ "format": "email",
+ "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "include_security_measures_accountability": {
+ "type": "boolean"
+ },
+ "include_security_measures_accountability_val": {
+ "type": "string"
+ },
+ "include_security_measures_certification_or_assurance": {
+ "type": "boolean"
+ },
+ "include_security_measures_certification_or_assurance_val": {
+ "type": "string"
+ },
+ "include_security_measures_confidentiality_integrity": {
+ "type": "boolean"
+ },
+ "include_security_measures_confidentiality_integrity_val": {
+ "type": "string"
+ },
+ "include_security_measures_data_at_rest": {
+ "type": "boolean"
+ },
+ "include_security_measures_data_at_rest_val": {
+ "type": "string"
+ },
+ "include_security_measures_data_minimization": {
+ "type": "boolean"
+ },
+ "include_security_measures_data_minimization_val": {
+ "type": "string"
+ },
+ "include_security_measures_data_quality": {
+ "type": "boolean"
+ },
+ "include_security_measures_data_quality_val": {
+ "type": "string"
+ },
+ "include_security_measures_data_retention": {
+ "type": "boolean"
+ },
+ "include_security_measures_data_retention_val": {
+ "type": "string"
+ },
+ "include_security_measures_data_transmission": {
+ "type": "boolean"
+ },
+ "include_security_measures_data_transmission_val": {
+ "type": "string"
+ },
+ "include_security_measures_event_logging": {
+ "type": "boolean"
+ },
+ "include_security_measures_event_logging_val": {
+ "type": "string"
+ },
+ "include_security_measures_identity_auth": {
+ "type": "boolean"
+ },
+ "include_security_measures_identity_auth_val": {
+ "type": "string"
+ },
+ "include_security_measures_it_security_governance": {
+ "type": "boolean"
+ },
+ "include_security_measures_it_security_governance_val": {
+ "type": "string"
+ },
+ "include_security_measures_physical_security": {
+ "type": "boolean"
+ },
+ "include_security_measures_physical_security_val": {
+ "type": "string"
+ },
+ "include_security_measures_portability_and_erasure": {
+ "type": "boolean"
+ },
+ "include_security_measures_portability_and_erasure_val": {
+ "type": "string"
+ },
+ "include_security_measures_pseudonym_encryption": {
+ "type": "boolean"
+ },
+ "include_security_measures_pseudonym_encryption_val": {
+ "type": "string"
+ },
+ "include_security_measures_restore_data_access": {
+ "type": "boolean"
+ },
+ "include_security_measures_restore_data_access_val": {
+ "type": "string"
+ },
+ "include_security_measures_security_policy": {
+ "type": "boolean"
+ },
+ "include_security_measures_system_configuration": {
+ "type": "boolean"
+ },
+ "include_security_measures_system_configuration_val": {
+ "type": "string"
+ },
+ "include_security_measures_testing_assessment": {
+ "type": "boolean"
+ },
+ "include_security_measures_testing_assessment_val": {
+ "type": "string"
+ },
+ "include_security_policy": {
+ "type": "boolean"
+ },
+ "include_security_policy_fedramp_auth": {
+ "type": "boolean"
+ },
+ "include_security_policy_hipaa": {
+ "type": "boolean"
+ },
+ "include_security_policy_hitrust": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_other": {
+ "type": "boolean"
+ },
+ "include_security_policy_iso27001": {
+ "type": "boolean"
+ },
+ "include_security_policy_other": {
+ "type": "string"
+ },
+ "include_security_policy_pci1": {
+ "type": "boolean"
+ },
+ "include_security_policy_pci2": {
+ "type": "boolean"
+ },
+ "include_security_policy_penetration_testing": {
+ "type": "boolean"
+ },
+ "include_security_policy_soc2": {
+ "type": "boolean"
+ },
+ "include_security_policy_soc2_type2": {
+ "type": "boolean"
+ },
+ "include_sensitive_data_restrictions_custom": {
+ "type": "boolean"
+ },
+ "include_sensitive_data_restrictions_custom_val": {
+ "type": "string"
+ },
+ "include_sensitive_data_restrictions_security_policy": {
+ "type": "boolean"
+ },
+ "include_service_provider_relationship": {
+ "type": "boolean"
+ },
+ "include_special_category_data": {
+ "type": "boolean"
+ },
+ "provider": {
+ "type": "string"
+ },
+ "security_policy_available_at": {
+ "type": "string"
+ },
+ "security_policy_type": {
+ "description": "Where the Security Policy is defined. For `external`, set `security_policy_available_at`.",
+ "enum": [
+ "defined in agreement",
+ "provider service",
+ "external"
+ ],
+ "type": "string"
+ },
+ "subprocessors_attributes": {
+ "additionalProperties": {
+ "additionalProperties": false,
+ "properties": {
+ "_destroy": {
+ "description": "Set to true with `id` to remove that subprocessor.",
+ "type": "boolean"
+ },
+ "country": {
+ "type": "string"
+ },
+ "id": {
+ "description": "ID of an existing subprocessor to update or remove. Omit to add a new subprocessor.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "processing_task": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "description": "Subprocessors, keyed by string index such as \"0\", \"1\". On create these are added to the template's subprocessors. On a draft update, an entry without `id` adds a new subprocessor; pass `id` to change one and `id` with `_destroy: true` to remove one.",
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+ },
+ "underlying_agreement_id": {
+ "description": "ID of the CSA this DPA supplements when `underlying_agreement_type` is `internal`.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "underlying_agreement_type": {
+ "description": "`internal` links a CSA in Common Paper (`underlying_agreement_id`); `external` describes another agreement in `underlying_agreement_val` (required). Omit for none.",
+ "enum": [
+ "internal",
+ "external"
+ ],
+ "type": "string"
+ },
+ "underlying_agreement_val": {
+ "description": "Description of the agreement this DPA supplements. Required when `underlying_agreement_type` is `external`.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "framework_terms_description": {
+ "description": "Custom framework terms description. Only used when framework_terms_type is \"description\".",
+ "type": "string"
+ },
+ "framework_terms_type": {
+ "description": "How framework terms are specified. Use \"new\" for standard terms or \"description\" to provide a custom framework_terms_description.",
+ "enum": [
+ "new",
+ "description"
+ ],
+ "type": "string"
+ },
+ "governing_law_country": {
+ "description": "The country whose laws govern the agreement.",
+ "type": "string"
+ },
+ "governing_law_region": {
+ "description": "The state or region whose laws govern the agreement.",
+ "type": "string"
+ },
+ "include_automated_payment_reminders": {
+ "description": "When true, automatically sends payment reminder emails.",
+ "type": "boolean"
+ },
+ "include_billing_info": {
+ "description": "When true, billing contact information (billing_name, billing_email) is included.",
+ "type": "boolean"
+ },
+ "include_billing_workflow": {
+ "description": "When true, enables a billing workflow after signing.",
+ "type": "boolean"
+ },
+ "include_expiration_date": {
+ "description": "Expiration date in YYYY-MM-DD format. Use when include_expiration_type is \"date\".",
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "include_expiration_days": {
+ "description": "Number of days until the agreement expires. Use when include_expiration_type is \"days\".",
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_expiration_type": {
+ "description": "How to set expiration: \"none\" (default), \"days\" (use include_expiration_days), or \"date\" (use include_expiration_date).",
+ "enum": [
+ "none",
+ "days",
+ "date"
+ ],
+ "type": "string"
+ },
+ "include_terms": {
+ "description": "When true, the standard terms are included with the agreement.",
+ "type": "boolean"
+ },
+ "loi_attributes": {
+ "additionalProperties": false,
+ "description": "Override loi terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "confidentiality_custom": {
+ "type": "string"
+ },
+ "confidentiality_mutual_include_loi": {
+ "type": "boolean"
+ },
+ "confidentiality_nda_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "confidentiality_nda_description": {
+ "type": "string"
+ },
+ "confidentiality_nda_include_loi": {
+ "type": "boolean"
+ },
+ "confidentiality_nda_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "confidentiality_type": {
+ "enum": [
+ "mutual",
+ "nda",
+ "provider",
+ "custom"
+ ],
+ "type": "string"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_custom_details": {
+ "type": "boolean"
+ },
+ "include_custom_details_val": {
+ "type": "string"
+ },
+ "include_fees": {
+ "type": "boolean"
+ },
+ "include_fees_amount": {
+ "type": "number"
+ },
+ "include_fees_amount_duration": {
+ "enum": [
+ "month",
+ "year",
+ "quarter"
+ ],
+ "type": "string"
+ },
+ "include_fees_include_amount": {
+ "type": "boolean"
+ },
+ "include_fees_include_other": {
+ "type": "boolean"
+ },
+ "include_fees_other": {
+ "type": "string"
+ },
+ "include_functionality": {
+ "type": "boolean"
+ },
+ "include_functionality_val": {
+ "type": "string"
+ },
+ "include_launch_date": {
+ "type": "boolean"
+ },
+ "include_launch_date_custom": {
+ "type": "string"
+ },
+ "include_launch_date_date": {
+ "format": "date-time",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$",
+ "type": "string"
+ },
+ "include_launch_date_type": {
+ "enum": [
+ "date",
+ "custom"
+ ],
+ "type": "string"
+ },
+ "product_name": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "manual_send": {
+ "description": "When true, the agreement is marked as manually sent outside the platform.",
+ "type": "boolean"
+ },
+ "message": {
+ "type": "string"
+ },
+ "negotiations_allowed": {
+ "description": "When true, the recipient can propose changes to the legal terms. For agreement types without separate business terms, that covers every term. CSA order forms, PSA statements of work, partnership business terms and software license order forms have their own `negotiations_allowed` flag.",
+ "type": "boolean"
+ },
+ "partnership_attributes": {
+ "additionalProperties": false,
+ "description": "Override partnership terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "effective_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "effective_date_type": {
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "type": "string"
+ },
+ "general_cap_amount_currency_val": {
+ "type": "number"
+ },
+ "general_cap_amount_either_currency": {
+ "type": "number"
+ },
+ "general_cap_amount_either_multiple": {
+ "type": "number"
+ },
+ "general_cap_amount_multiple_val": {
+ "type": "number"
+ },
+ "general_cap_amount_type": {
+ "enum": [
+ "multiple",
+ "currency",
+ "either",
+ "base"
+ ],
+ "type": "string"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_additional_warranties": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_include_company": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_include_company_val": {
+ "type": "string"
+ },
+ "include_additional_warranties_include_partner": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_include_partner_val": {
+ "type": "string"
+ },
+ "include_brand_guidelines": {
+ "type": "boolean"
+ },
+ "include_brand_guidelines_include_company": {
+ "type": "boolean"
+ },
+ "include_brand_guidelines_include_company_val": {
+ "type": "string"
+ },
+ "include_brand_guidelines_include_partner": {
+ "type": "boolean"
+ },
+ "include_brand_guidelines_include_partner_val": {
+ "type": "string"
+ },
+ "include_covered_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_company_claims": {
+ "type": "string"
+ },
+ "include_covered_claims_include_company_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_include_partner_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_partner_claims": {
+ "type": "string"
+ },
+ "include_dpa": {
+ "type": "boolean"
+ },
+ "include_dpa_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_dpa_location": {
+ "type": "string"
+ },
+ "include_dpa_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_increased_cap_amount": {
+ "type": "boolean"
+ },
+ "include_increased_cap_amount_currency": {
+ "type": "number"
+ },
+ "include_increased_cap_amount_either_currency": {
+ "type": "number"
+ },
+ "include_increased_cap_amount_either_multiple": {
+ "type": "string"
+ },
+ "include_increased_cap_amount_multiple": {
+ "type": "string"
+ },
+ "include_increased_cap_amount_type": {
+ "enum": [
+ "multiple",
+ "currency",
+ "either"
+ ],
+ "type": "string"
+ },
+ "include_increased_claims": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_confidentiality": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_confidentiality_misconduct": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_covered_claims": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_misconduct": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_other": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_other_val": {
+ "type": "string"
+ },
+ "include_unlimited_claims": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_confidentiality": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_confidentiality_misconduct": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_covered_claims": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_misconduct": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_other": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_other_val": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "partnership_business_terms_attributes": {
+ "additionalProperties": false,
+ "description": "Override partnership business terms terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "end_date_after_effective_date_amount": {
+ "type": "number"
+ },
+ "end_date_after_effective_date_unit": {
+ "enum": [
+ "month(s)",
+ "quarter(s)",
+ "year(s)"
+ ],
+ "type": "string"
+ },
+ "end_date_date": {
+ "type": "string"
+ },
+ "end_date_type": {
+ "enum": [
+ "date",
+ "effective date"
+ ],
+ "type": "string"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_obligations_company_brand": {
+ "type": "boolean"
+ },
+ "include_obligations_company_promotion": {
+ "type": "boolean"
+ },
+ "include_obligations_company_promotion_include_activities": {
+ "type": "boolean"
+ },
+ "include_obligations_company_promotion_include_activities_val": {
+ "type": "string"
+ },
+ "include_obligations_company_promotion_include_materials": {
+ "type": "boolean"
+ },
+ "include_obligations_company_promotion_include_materials_val": {
+ "type": "string"
+ },
+ "include_obligations_company_referral": {
+ "type": "boolean"
+ },
+ "include_obligations_company_referral_include_criteria": {
+ "type": "boolean"
+ },
+ "include_obligations_company_referral_include_criteria_val": {
+ "type": "string"
+ },
+ "include_obligations_company_referral_include_pay_sch": {
+ "type": "boolean"
+ },
+ "include_obligations_company_referral_include_pay_sch_amount": {
+ "type": "number"
+ },
+ "include_obligations_company_referral_include_pay_sch_custom": {
+ "type": "string"
+ },
+ "include_obligations_company_referral_include_pay_sch_unit": {
+ "enum": [
+ "U.S. Dollars",
+ "percent"
+ ],
+ "type": "string"
+ },
+ "include_obligations_company_sponsorship": {
+ "type": "boolean"
+ },
+ "include_obligations_company_sponsorship_include_benefits": {
+ "type": "boolean"
+ },
+ "include_obligations_company_sponsorship_include_benefits_val": {
+ "type": "string"
+ },
+ "include_obligations_company_sponsorship_include_payments": {
+ "type": "boolean"
+ },
+ "include_obligations_company_sponsorship_include_payments_amount": {
+ "type": "number"
+ },
+ "include_obligations_company_sponsorship_include_payments_unit": {
+ "enum": [
+ "U.S. Dollars",
+ "percent"
+ ],
+ "type": "string"
+ },
+ "include_obligations_partner_brand": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_promotion": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_promotion_include_activities": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_promotion_include_activities_val": {
+ "type": "string"
+ },
+ "include_obligations_partner_promotion_include_materials": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_promotion_include_materials_val": {
+ "type": "string"
+ },
+ "include_obligations_partner_referral": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_referral_include_criteria": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_referral_include_criteria_val": {
+ "type": "string"
+ },
+ "include_obligations_partner_referral_include_pay_sch": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_referral_include_pay_sch_amount": {
+ "type": "number"
+ },
+ "include_obligations_partner_referral_include_pay_sch_custom": {
+ "type": "string"
+ },
+ "include_obligations_partner_referral_include_pay_sch_unit": {
+ "enum": [
+ "U.S. Dollars",
+ "percent"
+ ],
+ "type": "string"
+ },
+ "include_obligations_partner_sponsorship": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_sponsorship_include_benefits": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_sponsorship_include_benefits_val": {
+ "type": "string"
+ },
+ "include_obligations_partner_sponsorship_include_payments": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_sponsorship_include_payments_amount": {
+ "type": "number"
+ },
+ "include_obligations_partner_sponsorship_include_payments_unit": {
+ "enum": [
+ "U.S. Dollars",
+ "percent"
+ ],
+ "type": "string"
+ },
+ "include_payment_process": {
+ "type": "boolean"
+ },
+ "include_payment_process_company": {
+ "type": "boolean"
+ },
+ "include_payment_process_company_include_address": {
+ "type": "boolean"
+ },
+ "include_payment_process_company_include_address_city": {
+ "type": "string"
+ },
+ "include_payment_process_company_include_address_country": {
+ "type": "string"
+ },
+ "include_payment_process_company_include_address_state": {
+ "type": "string"
+ },
+ "include_payment_process_company_include_address_street_address": {
+ "type": "string"
+ },
+ "include_payment_process_company_include_address_zipcode": {
+ "type": "string"
+ },
+ "include_payment_process_company_include_email": {
+ "type": "boolean"
+ },
+ "include_payment_process_company_include_email_val": {
+ "type": "string"
+ },
+ "include_payment_process_partner": {
+ "type": "boolean"
+ },
+ "include_payment_process_partner_include_address": {
+ "type": "boolean"
+ },
+ "include_payment_process_partner_include_address_city": {
+ "type": "string"
+ },
+ "include_payment_process_partner_include_address_country": {
+ "type": "string"
+ },
+ "include_payment_process_partner_include_address_state": {
+ "type": "string"
+ },
+ "include_payment_process_partner_include_address_street_address": {
+ "type": "string"
+ },
+ "include_payment_process_partner_include_address_zipcode": {
+ "type": "string"
+ },
+ "include_payment_process_partner_include_email": {
+ "type": "boolean"
+ },
+ "include_payment_process_partner_include_email_val": {
+ "type": "string"
+ },
+ "include_payment_schedule": {
+ "type": "boolean"
+ },
+ "include_payment_schedule_custom": {
+ "type": "string"
+ },
+ "include_payment_schedule_specified_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_payment_schedule_specified_timeframe": {
+ "enum": [
+ "receipt",
+ "date"
+ ],
+ "type": "string"
+ },
+ "include_payment_schedule_specified_unit": {
+ "enum": [
+ "day(s)",
+ "week(s)",
+ "month(s)",
+ "quarter(s)",
+ "year(s)"
+ ],
+ "type": "string"
+ },
+ "include_payment_schedule_type": {
+ "enum": [
+ "specified",
+ "custom"
+ ],
+ "type": "string"
+ },
+ "negotiations_allowed": {
+ "description": "When true, the recipient can propose changes to the business terms, even when the agreement-level `negotiations_allowed` is false. This only covers the business terms.",
+ "type": "boolean"
+ },
+ "territory_type": {
+ "enum": [
+ "worldwide",
+ "custom"
+ ],
+ "type": "string"
+ },
+ "territory_type_val": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "payment_link_url": {
+ "description": "A payment URL shown to the recipient after signing. Requires include_billing_workflow to be true and billing_workflow_type to be \"link\".",
+ "type": "string"
+ },
+ "pilot_attributes": {
+ "additionalProperties": false,
+ "description": "Override pilot terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "fees_type": {
+ "enum": [
+ "free",
+ "pilot_period_fees"
+ ],
+ "type": "string"
+ },
+ "general_cap_amount": {
+ "type": "number"
+ },
+ "general_cap_amount_type": {
+ "enum": [
+ "preceding",
+ "base",
+ "period"
+ ],
+ "type": "string"
+ },
+ "general_cap_period_currency": {
+ "type": "number"
+ },
+ "general_cap_period_qty": {
+ "type": "number"
+ },
+ "general_cap_preceding_amount": {
+ "type": "number"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_dpa": {
+ "type": "boolean"
+ },
+ "include_dpa_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_dpa_location": {
+ "type": "string"
+ },
+ "include_dpa_type": {
+ "enum": [
+ "description",
+ "attachment",
+ "standard"
+ ],
+ "type": "string"
+ },
+ "include_payment_process": {
+ "type": "boolean"
+ },
+ "include_technical_support": {
+ "type": "boolean"
+ },
+ "payment_process_automatic_frequency": {
+ "enum": [
+ "monthly",
+ "quarterly",
+ "annually",
+ "once_per_period"
+ ],
+ "type": "string"
+ },
+ "payment_process_invoice_days": {
+ "type": "number"
+ },
+ "payment_process_invoice_from": {
+ "enum": [
+ "receipt",
+ "date"
+ ],
+ "type": "string"
+ },
+ "payment_process_invoice_timeframe": {
+ "enum": [
+ "days",
+ "weeks",
+ "months",
+ "quarters",
+ "years"
+ ],
+ "type": "string"
+ },
+ "payment_process_type": {
+ "enum": [
+ "automatic",
+ "invoice"
+ ],
+ "type": "string"
+ },
+ "pilot_period_description": {
+ "type": "string"
+ },
+ "pilot_period_fees_description": {
+ "type": "string"
+ },
+ "product_description": {
+ "type": "string"
+ },
+ "technical_support_description": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "psa_attributes": {
+ "additionalProperties": false,
+ "description": "Override psa terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "additional_changes": {
+ "type": "string"
+ },
+ "customer_description": {
+ "type": "string"
+ },
+ "effective_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "effective_date_type": {
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "type": "string"
+ },
+ "general_cap_amount": {
+ "type": "number"
+ },
+ "general_cap_amount_type": {
+ "enum": [
+ "preceding",
+ "base",
+ "period"
+ ],
+ "type": "string"
+ },
+ "general_cap_period_currency": {
+ "type": "number"
+ },
+ "general_cap_period_qty": {
+ "type": "number"
+ },
+ "general_cap_preceding_amount": {
+ "type": "number"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_additional_changes": {
+ "type": "boolean"
+ },
+ "include_additional_warranties": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_by_customer": {
+ "type": "string"
+ },
+ "include_additional_warranties_by_provider": {
+ "type": "string"
+ },
+ "include_additional_warranties_include_by_customer": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_include_by_provider": {
+ "type": "boolean"
+ },
+ "include_covered_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_customer_claims": {
+ "type": "string"
+ },
+ "include_covered_claims_include_customer_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_include_provider_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_provider_claims": {
+ "type": "string"
+ },
+ "include_customer_insurance_min": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_add_provider_com_gen_liability": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_add_provider_cyber_liability": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_add_provider_errors_omissions": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_auto_liability_aggregate": {
+ "type": "number"
+ },
+ "include_customer_insurance_min_auto_liability_minimum": {
+ "type": "number"
+ },
+ "include_customer_insurance_min_cyber_liability_aggregate": {
+ "type": "number"
+ },
+ "include_customer_insurance_min_cyber_liability_minimum": {
+ "type": "number"
+ },
+ "include_customer_insurance_min_employer_liability_aggregate": {
+ "type": "number"
+ },
+ "include_customer_insurance_min_employer_liability_minimum": {
+ "type": "number"
+ },
+ "include_customer_insurance_min_general_liability_aggregate": {
+ "type": "number"
+ },
+ "include_customer_insurance_min_general_liability_minimum": {
+ "type": "number"
+ },
+ "include_customer_insurance_min_include_add_provider": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_include_auto_liability": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_include_cyber_liability": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_include_employer_liability": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_include_general_liability": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_include_workers_comp": {
+ "type": "boolean"
+ },
+ "include_customer_policies": {
+ "type": "boolean"
+ },
+ "include_customer_policies_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_customer_policies_location": {
+ "type": "string"
+ },
+ "include_customer_policies_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_dpa": {
+ "type": "boolean"
+ },
+ "include_dpa_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_dpa_location": {
+ "type": "string"
+ },
+ "include_dpa_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_increased_cap_amount": {
+ "type": "boolean"
+ },
+ "include_increased_claims": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_confidentiality": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_confidentiality_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_privsec": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_privsec_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_other": {
+ "type": "boolean"
+ },
+ "include_increased_claims_indemnification_obligation": {
+ "type": "boolean"
+ },
+ "include_increased_claims_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_other": {
+ "type": "string"
+ },
+ "include_provider_insurance_min": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_add_customer_com_gen_liability": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_add_customer_cyber_liability": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_add_customer_errors_omissions": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_auto_liability_aggregate": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_auto_liability_minimum": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_cyber_liability_aggregate": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_cyber_liability_minimum": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_employer_liability_aggregate": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_employer_liability_minimum": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_general_liability_aggregate": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_general_liability_minimum": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_include_add_customer": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_include_auto_liability": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_include_cyber_liability": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_include_employer_liability": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_include_general_liability": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_include_workers_comp": {
+ "type": "boolean"
+ },
+ "include_publicity_rights": {
+ "type": "boolean"
+ },
+ "include_publicity_rights_type": {
+ "enum": [
+ "public",
+ "non-public"
+ ],
+ "type": "string"
+ },
+ "include_security_policy": {
+ "type": "boolean"
+ },
+ "include_security_policy_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_security_policy_fedramp_auth": {
+ "type": "boolean"
+ },
+ "include_security_policy_hitrust": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_annual_maintenance": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_other": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_other_val": {
+ "type": "string"
+ },
+ "include_security_policy_iso27001": {
+ "type": "boolean"
+ },
+ "include_security_policy_location": {
+ "type": "string"
+ },
+ "include_security_policy_pci1": {
+ "type": "boolean"
+ },
+ "include_security_policy_pci2": {
+ "type": "boolean"
+ },
+ "include_security_policy_penetration_testing": {
+ "type": "boolean"
+ },
+ "include_security_policy_soc2_type1": {
+ "type": "boolean"
+ },
+ "include_security_policy_soc2_type2": {
+ "type": "boolean"
+ },
+ "include_security_policy_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_unlimited_claims": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_confidentiality": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_confidentiality_negligence": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_privsec": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_privsec_negligence": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_include_other": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_indemnification_obligation": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_negligence": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_other": {
+ "type": "string"
+ },
+ "increased_cap_amount_currency": {
+ "type": "number"
+ },
+ "increased_cap_amount_period_currency": {
+ "type": "number"
+ },
+ "increased_cap_amount_period_qty": {
+ "type": "number"
+ },
+ "increased_cap_amount_qty": {
+ "type": "number"
+ },
+ "increased_cap_amount_type": {
+ "enum": [
+ "qty",
+ "currency",
+ "period"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "psa_statement_of_work_attributes": {
+ "additionalProperties": false,
+ "description": "Override psa statement of work terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "additional_changes": {
+ "type": "string"
+ },
+ "cost": {
+ "type": "number"
+ },
+ "description": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "fees_attributes": {
+ "additionalProperties": {
+ "anyOf": [
+ {
+ "additionalProperties": false,
+ "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": "string"
+ },
+ "include_deliverables": {
+ "type": "boolean"
+ },
+ "include_deliverables_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_deliverables_description": {
+ "type": "string"
+ },
+ "include_deliverables_include_acceptance": {
+ "type": "boolean"
+ },
+ "include_deliverables_include_attachment": {
+ "type": "boolean"
+ },
+ "include_deliverables_include_draft_deliverables": {
+ "type": "boolean"
+ },
+ "include_deliverables_rejection_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_deliverables_rejection_unit": {
+ "enum": [
+ "hours",
+ "days",
+ "weeks",
+ "months"
+ ],
+ "type": "string"
+ },
+ "include_deliverables_resubmission_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_deliverables_resubmission_unit": {
+ "enum": [
+ "hours",
+ "days",
+ "weeks",
+ "months"
+ ],
+ "type": "string"
+ },
+ "include_fees_other": {
+ "type": "boolean"
+ },
+ "include_fees_other_val": {
+ "type": "string"
+ },
+ "include_fees_table": {
+ "type": "boolean"
+ },
+ "include_fees_table_total": {
+ "type": "boolean"
+ },
+ "include_fees_travel": {
+ "type": "boolean"
+ },
+ "include_fees_travel_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_fees_travel_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_fees_travel_val": {
+ "type": "string"
+ },
+ "include_third_party_customer": {
+ "type": "boolean"
+ },
+ "include_third_party_include_description": {
+ "type": "boolean"
+ },
+ "include_third_party_include_description_val": {
+ "type": "string"
+ },
+ "include_third_party_materials": {
+ "type": "boolean"
+ },
+ "include_third_party_provider": {
+ "type": "boolean"
+ },
+ "include_time_of_assignment": {
+ "type": "boolean"
+ },
+ "include_time_of_assignment_type": {
+ "enum": [
+ "created",
+ "paid"
+ ],
+ "type": "string"
+ },
+ "invoice_period_description": {
+ "type": "string"
+ },
+ "negotiations_allowed": {
+ "description": "When true, the recipient can propose changes to the statement of work, even when the agreement-level `negotiations_allowed` is false. This only covers the statement of work.",
+ "type": "boolean"
+ },
+ "payment_period": {
+ "type": "number"
+ },
+ "payment_period_other": {
+ "type": "string"
+ },
+ "payment_period_timeframe": {
+ "enum": [
+ "receipt",
+ "invoice",
+ "Customer's receipt of invoice",
+ "date of invoice"
+ ],
+ "type": "string"
+ },
+ "payment_period_type": {
+ "enum": [
+ "standard",
+ "other"
+ ],
+ "type": "string"
+ },
+ "payment_period_unit": {
+ "enum": [
+ "day(s)",
+ "week(s)",
+ "month(s)",
+ "quarter(s)",
+ "year(s)"
+ ],
+ "type": "string"
+ },
+ "quantity": {
+ "type": "number"
+ },
+ "services_description": {
+ "type": "string"
+ },
+ "sow_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "sow_date_type": {
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "type": "string"
+ },
+ "sow_term_amount": {
+ "type": "number"
+ },
+ "sow_term_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "sow_term_type": {
+ "enum": [
+ "deliverables",
+ "period",
+ "date"
+ ],
+ "type": "string"
+ },
+ "sow_term_unit": {
+ "enum": [
+ "month(s)",
+ "quarter(s)",
+ "year(s)"
+ ],
+ "type": "string"
+ },
+ "type": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "recipient_email": {
+ "format": "email",
+ "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-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_last_to_sign": {
+ "description": "When true, your signer signs after the recipient.",
+ "type": "boolean"
+ },
+ "sender_notice_email_address": {
+ "description": "Email address for legal notices to the sender.",
+ "format": "email",
+ "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-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": {
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "type": "string"
+ },
+ "general_cap_amount": {
+ "type": "number"
+ },
+ "general_cap_amount_type": {
+ "enum": [
+ "preceding",
+ "base",
+ "period"
+ ],
+ "type": "string"
+ },
+ "general_cap_period_currency": {
+ "type": "number"
+ },
+ "general_cap_period_qty": {
+ "type": "number"
+ },
+ "general_cap_preceding_amount": {
+ "type": "number"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_additional_warranties": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_by_customer": {
+ "type": "string"
+ },
+ "include_additional_warranties_by_provider": {
+ "type": "string"
+ },
+ "include_additional_warranties_include_by_customer": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_include_by_provider": {
+ "type": "boolean"
+ },
+ "include_ai_addendum": {
+ "type": "boolean"
+ },
+ "include_ai_addendum_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_covered_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_customer_claims": {
+ "type": "string"
+ },
+ "include_covered_claims_include_customer_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_include_provider_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_provider_claims": {
+ "type": "string"
+ },
+ "include_dpa": {
+ "type": "boolean"
+ },
+ "include_dpa_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_dpa_location": {
+ "type": "string"
+ },
+ "include_dpa_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_increased_cap_amount": {
+ "type": "boolean"
+ },
+ "include_increased_claims": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_confidentiality": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_confidentiality_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_other": {
+ "type": "boolean"
+ },
+ "include_increased_claims_indemnification_obligation": {
+ "type": "boolean"
+ },
+ "include_increased_claims_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_other": {
+ "type": "string"
+ },
+ "include_increased_claims_restrictions": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_confidentiality": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_confidentiality_negligence": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_include_other": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_indemnification_obligation": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_license_or_restrictions": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_negligence": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_other": {
+ "type": "string"
+ },
+ "increased_cap_amount_currency": {
+ "type": "number"
+ },
+ "increased_cap_amount_period_currency": {
+ "type": "number"
+ },
+ "increased_cap_amount_period_qty": {
+ "type": "number"
+ },
+ "increased_cap_amount_qty": {
+ "type": "number"
+ },
+ "increased_cap_amount_type": {
+ "enum": [
+ "qty",
+ "currency",
+ "period"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "software_license_order_form_attributes": {
+ "additionalProperties": false,
+ "description": "Override software license order form terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "additional_changes": {
+ "type": "string"
+ },
+ "deletion_procedure_include_custom": {
+ "type": "boolean"
+ },
+ "deletion_procedure_include_custom_description": {
+ "type": "string"
+ },
+ "deletion_procedure_include_customer_disable": {
+ "type": "boolean"
+ },
+ "deletion_procedure_include_customer_proof": {
+ "type": "boolean"
+ },
+ "deletion_procedure_include_provider_disable": {
+ "type": "boolean"
+ },
+ "fee_custom_unit": {
+ "type": "string"
+ },
+ "fee_period": {
+ "enum": [
+ "Subscription Period",
+ "month",
+ "year",
+ "Custom unit"
+ ],
+ "type": "string"
+ },
+ "fees_attributes": {
+ "additionalProperties": {
+ "anyOf": [
+ {
+ "additionalProperties": false,
+ "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": {
+ "enum": [
+ "USD",
+ "EUR",
+ "GBP",
+ "CAD",
+ "AUD",
+ "SGD",
+ "ILS",
+ "JPY",
+ "CHF",
+ "HKD"
+ ],
+ "type": "string"
+ },
+ "fees_include_fee_increase_upon_renewal": {
+ "type": "boolean"
+ },
+ "fees_include_fee_increase_upon_renewal_fee": {
+ "type": "number"
+ },
+ "fees_include_fee_increase_upon_renewal_type": {
+ "enum": [
+ "will",
+ "may"
+ ],
+ "type": "string"
+ },
+ "fees_inclusive_of_taxes": {
+ "type": "boolean"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_additional_changes": {
+ "type": "boolean"
+ },
+ "include_license_compliance_verification": {
+ "type": "boolean"
+ },
+ "include_license_compliance_verification_description": {
+ "type": "string"
+ },
+ "include_license_limits": {
+ "type": "boolean"
+ },
+ "include_license_limits_description": {
+ "type": "string"
+ },
+ "include_payment_process_include_billing_email": {
+ "type": "boolean"
+ },
+ "include_pilot_period": {
+ "type": "boolean"
+ },
+ "include_pilot_period_duration_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_pilot_period_duration_type": {
+ "enum": [
+ "day",
+ "week",
+ "month"
+ ],
+ "type": "string"
+ },
+ "include_pilot_period_include_fees": {
+ "type": "boolean"
+ },
+ "include_pilot_period_include_fees_amount": {
+ "type": "number"
+ },
+ "include_pilot_period_include_modifications": {
+ "type": "boolean"
+ },
+ "include_pilot_period_include_modifications_description": {
+ "type": "string"
+ },
+ "include_services": {
+ "type": "boolean"
+ },
+ "include_services_description": {
+ "type": "string"
+ },
+ "negotiations_allowed": {
+ "description": "When true, the recipient can propose changes to the order form, even when the agreement-level `negotiations_allowed` is false. This only covers the order form.",
+ "type": "boolean"
+ },
+ "order_date_date": {
+ "type": "string"
+ },
+ "order_date_type": {
+ "enum": [
+ "signature",
+ "date",
+ "other"
+ ],
+ "type": "string"
+ },
+ "payment_process_automatic_frequency": {
+ "enum": [
+ "monthly",
+ "quarterly",
+ "semiannually",
+ "annually"
+ ],
+ "type": "string"
+ },
+ "payment_process_type": {
+ "enum": [
+ "automatic",
+ "invoice",
+ "custom"
+ ],
+ "type": "string"
+ },
+ "payment_process_type_custom_val": {
+ "type": "string"
+ },
+ "payment_process_type_invoice_amount": {
+ "type": "number"
+ },
+ "payment_process_type_invoice_custom_unit": {
+ "type": "string"
+ },
+ "payment_process_type_invoice_duration": {
+ "enum": [
+ "day",
+ "week",
+ "month",
+ "year",
+ "day(s)",
+ "week(s)",
+ "month(s)",
+ "year(s)"
+ ],
+ "type": "string"
+ },
+ "payment_process_type_invoice_duration_start": {
+ "enum": [
+ "Customer's receipt of invoice",
+ "date of invoice"
+ ],
+ "type": "string"
+ },
+ "payment_process_type_invoice_type": {
+ "enum": [
+ "monthly",
+ "quarterly",
+ "semiannually",
+ "annually",
+ "Custom unit"
+ ],
+ "type": "string"
+ },
+ "permitted_uses_include_custom": {
+ "type": "boolean"
+ },
+ "permitted_uses_include_custom_description": {
+ "type": "string"
+ },
+ "permitted_uses_include_customers_affiliates": {
+ "type": "boolean"
+ },
+ "permitted_uses_include_internal_business": {
+ "type": "boolean"
+ },
+ "pilot_period_stripe_product_id": {
+ "type": "string"
+ },
+ "software_description": {
+ "type": "string"
+ },
+ "subscription_auto_renew": {
+ "enum": [
+ "days",
+ "subscription_end"
+ ],
+ "type": "string"
+ },
+ "subscription_period": {
+ "type": "number"
+ },
+ "subscription_period_unit": {
+ "type": "string"
+ },
+ "subscription_renewal_notice_days": {
+ "type": "number"
+ },
+ "warranty_period_description_amount": {
+ "type": "number"
+ },
+ "warranty_period_description_duration": {
+ "enum": [
+ "day",
+ "week",
+ "month",
+ "year"
+ ],
+ "type": "string"
+ },
+ "warranty_period_description_duration_start": {
+ "enum": [
+ "initial delivery of the Software",
+ "delivery of the Software and each subsequent Update",
+ "the Order Date"
+ ],
+ "type": "string"
+ },
+ "warranty_period_type": {
+ "enum": [
+ "description",
+ "none"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "test_agreement": {
+ "description": "When true, marks the agreement as a test. Test agreements do not count against your monthly limit.",
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "recipient_name",
+ "recipient_email"
+ ],
+ "type": "object"
+ },
+ "cc_users": {
+ "items": {
+ "format": "email",
+ "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-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": {
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "type": "string"
+ },
+ "framework_terms_type": {
+ "type": "string"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "parent_agreement_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "underlying_agreement_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "underlying_agreement_type": {
+ "type": "string"
+ },
+ "underlying_agreement_val": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "baa_attributes": {
+ "additionalProperties": false,
+ "description": "Override baa terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "aggregation_limitations_permitted": {
+ "type": "boolean"
+ },
+ "aggregation_limitations_permitted_val": {
+ "type": "string"
+ },
+ "breach_notification_unit": {
+ "enum": [
+ "hours",
+ "business days",
+ "calendar days"
+ ],
+ "type": "string"
+ },
+ "breach_notification_val": {
+ "type": "number"
+ },
+ "business_associate_relationship_type": {
+ "enum": [
+ "provider",
+ "company"
+ ],
+ "type": "string"
+ },
+ "deidentification_limitations_include_purpose": {
+ "type": "boolean"
+ },
+ "deidentification_limitations_include_requirements": {
+ "type": "boolean"
+ },
+ "deidentification_limitations_permitted": {
+ "type": "boolean"
+ },
+ "deidentification_limitations_purpose_val": {
+ "type": "string"
+ },
+ "deidentification_limitations_requirements_val": {
+ "type": "string"
+ },
+ "designated_record_set_provider_maintains": {
+ "type": "boolean"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_aggregation_limitations": {
+ "type": "boolean"
+ },
+ "include_deidentification_limitations": {
+ "type": "boolean"
+ },
+ "include_limitations": {
+ "type": "boolean"
+ },
+ "include_offshore_limitations": {
+ "type": "boolean"
+ },
+ "include_subcontract_limitations": {
+ "type": "boolean"
+ },
+ "offshore_limitations_permitted": {
+ "type": "boolean"
+ },
+ "offshore_limitations_permitted_val": {
+ "type": "string"
+ },
+ "subcontract_limitations_include_notice": {
+ "type": "boolean"
+ },
+ "subcontract_limitations_include_permission": {
+ "type": "boolean"
+ },
+ "subcontract_limitations_notice_val": {
+ "type": "string"
+ },
+ "subcontract_limitations_permission_val": {
+ "type": "string"
+ },
+ "subcontract_limitations_permitted": {
+ "type": "boolean"
+ },
+ "underlying_agreement_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "underlying_agreement_type": {
+ "enum": [
+ "internal",
+ "external",
+ "none"
+ ],
+ "type": "string"
+ },
+ "underlying_agreement_val": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "billing_email": {
+ "description": "Email of the billing contact. Used when include_billing_info is true.",
+ "format": "email",
+ "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "billing_name": {
+ "description": "Name of the billing contact. Used when include_billing_info is true.",
+ "type": "string"
+ },
+ "billing_workflow_type": {
+ "description": "The type of billing workflow. Use \"link\" to provide a payment_link_url, or \"stripe\" for Stripe-managed billing.",
+ "enum": [
+ "link",
+ "stripe"
+ ],
+ "type": "string"
+ },
+ "chosen_courts_country": {
+ "description": "The country in which disputes will be resolved.",
+ "type": "string"
+ },
+ "chosen_courts_region": {
+ "description": "The state or region in which disputes will be resolved.",
+ "type": "string"
+ },
+ "csa_attributes": {
+ "additionalProperties": false,
+ "description": "Override csa terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "customer_description": {
+ "type": "string"
+ },
+ "effective_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "effective_date_marketplace": {
+ "enum": [
+ "AWS",
+ "GCP",
+ "Azure"
+ ],
+ "type": "string"
+ },
+ "effective_date_type": {
+ "enum": [
+ "signature",
+ "date",
+ "marketplace_acceptance"
+ ],
+ "type": "string"
+ },
+ "general_cap_amount": {
+ "type": "number"
+ },
+ "general_cap_amount_type": {
+ "enum": [
+ "preceding",
+ "base",
+ "period"
+ ],
+ "type": "string"
+ },
+ "general_cap_period_currency": {
+ "type": "number"
+ },
+ "general_cap_period_qty": {
+ "type": "number"
+ },
+ "general_cap_preceding_amount": {
+ "type": "number"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_acceptable_use_policy": {
+ "type": "boolean"
+ },
+ "include_acceptable_use_policy_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_acceptable_use_policy_location": {
+ "type": "string"
+ },
+ "include_acceptable_use_policy_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_additional_warranties": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_by_customer": {
+ "type": "string"
+ },
+ "include_additional_warranties_by_provider": {
+ "type": "string"
+ },
+ "include_additional_warranties_include_by_customer": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_include_by_provider": {
+ "type": "boolean"
+ },
+ "include_ai_addendum": {
+ "type": "boolean"
+ },
+ "include_ai_addendum_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_covered_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_customer_claims": {
+ "type": "string"
+ },
+ "include_covered_claims_include_customer_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_include_provider_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_provider_claims": {
+ "type": "string"
+ },
+ "include_dpa": {
+ "type": "boolean"
+ },
+ "include_dpa_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_dpa_location": {
+ "type": "string"
+ },
+ "include_dpa_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_increased_cap_amount": {
+ "type": "boolean"
+ },
+ "include_increased_claims": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_confidentiality": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_confidentiality_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_privsec": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_privsec_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_other": {
+ "type": "boolean"
+ },
+ "include_increased_claims_indemnification_obligation": {
+ "type": "boolean"
+ },
+ "include_increased_claims_other": {
+ "type": "string"
+ },
+ "include_insurance_minimums": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_add_customer": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_add_customer_com_gen_liability": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_add_customer_cyber_liability": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_add_customer_errors_omissions": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_additional_information": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_additional_information_text": {
+ "type": "string"
+ },
+ "include_insurance_minimums_cyber_liability_aggregate": {
+ "type": "number"
+ },
+ "include_insurance_minimums_cyber_liability_minimum": {
+ "type": "number"
+ },
+ "include_insurance_minimums_employer_liability_aggregate": {
+ "type": "number"
+ },
+ "include_insurance_minimums_employer_liability_minimum": {
+ "type": "number"
+ },
+ "include_insurance_minimums_general_liability_aggregate": {
+ "type": "number"
+ },
+ "include_insurance_minimums_general_liability_minimum": {
+ "type": "number"
+ },
+ "include_insurance_minimums_include_cyber_liability": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_include_employer_liability": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_include_general_liability": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_include_workers_compensation": {
+ "type": "boolean"
+ },
+ "include_publicity_rights": {
+ "type": "boolean"
+ },
+ "include_publicity_rights_type": {
+ "enum": [
+ "public",
+ "non-public"
+ ],
+ "type": "string"
+ },
+ "include_security_policy": {
+ "type": "boolean"
+ },
+ "include_security_policy_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_security_policy_fedramp_auth": {
+ "type": "boolean"
+ },
+ "include_security_policy_hipaa": {
+ "type": "boolean"
+ },
+ "include_security_policy_hitrust": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_annual_maintenance": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_location": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_other": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_reasonable_efforts": {
+ "type": "boolean"
+ },
+ "include_security_policy_iso27001": {
+ "type": "boolean"
+ },
+ "include_security_policy_location": {
+ "type": "string"
+ },
+ "include_security_policy_other": {
+ "type": "string"
+ },
+ "include_security_policy_pci1": {
+ "type": "boolean"
+ },
+ "include_security_policy_pci2": {
+ "type": "boolean"
+ },
+ "include_security_policy_penetration_testing": {
+ "type": "boolean"
+ },
+ "include_security_policy_soc2": {
+ "type": "boolean"
+ },
+ "include_security_policy_soc2_type2": {
+ "type": "boolean"
+ },
+ "include_security_policy_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_supercap": {
+ "description": "CSA 3.0 renamed `include_increased_cap_amount` to `include_supercap`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_increased_cap_amount`. Sending the other spelling returns a 422.",
+ "type": "boolean"
+ },
+ "include_uncapped_claims": {
+ "description": "CSA 3.0 renamed `include_unlimited_claims` to `include_uncapped_claims`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims`. Sending the other spelling returns a 422.",
+ "type": "boolean"
+ },
+ "include_uncapped_claims_breach_of_confidentiality": {
+ "description": "CSA 3.0 renamed `include_unlimited_claims_breach_of_confidentiality` to `include_uncapped_claims_breach_of_confidentiality`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_breach_of_confidentiality`. Sending the other spelling returns a 422.",
+ "type": "boolean"
+ },
+ "include_uncapped_claims_breach_of_confidentiality_negligence": {
+ "description": "CSA 3.0 renamed `include_unlimited_claims_breach_of_confidentiality_negligence` to `include_uncapped_claims_breach_of_confidentiality_negligence`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_breach_of_confidentiality_negligence`. Sending the other spelling returns a 422.",
+ "type": "boolean"
+ },
+ "include_uncapped_claims_breach_of_privsec": {
+ "description": "CSA 3.0 renamed `include_unlimited_claims_breach_of_privsec` to `include_uncapped_claims_breach_of_privsec`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_breach_of_privsec`. Sending the other spelling returns a 422.",
+ "type": "boolean"
+ },
+ "include_uncapped_claims_breach_of_privsec_negligence": {
+ "description": "CSA 3.0 renamed `include_unlimited_claims_breach_of_privsec_negligence` to `include_uncapped_claims_breach_of_privsec_negligence`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_breach_of_privsec_negligence`. Sending the other spelling returns a 422.",
+ "type": "boolean"
+ },
+ "include_uncapped_claims_include_other": {
+ "description": "CSA 3.0 renamed `include_unlimited_claims_include_other` to `include_uncapped_claims_include_other`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_include_other`. Sending the other spelling returns a 422.",
+ "type": "boolean"
+ },
+ "include_uncapped_claims_indemnification_obligation": {
+ "description": "CSA 3.0 renamed `include_unlimited_claims_indemnification_obligation` to `include_uncapped_claims_indemnification_obligation`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_indemnification_obligation`. Sending the other spelling returns a 422.",
+ "type": "boolean"
+ },
+ "include_uncapped_claims_other": {
+ "description": "CSA 3.0 renamed `include_unlimited_claims_other` to `include_uncapped_claims_other`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_other`. Sending the other spelling returns a 422.",
+ "type": "boolean"
+ },
+ "include_unlimited_claims": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_confidentiality": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_confidentiality_negligence": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_privsec": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_privsec_negligence": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_include_other": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_indemnification_obligation": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_other": {
+ "type": "string"
+ },
+ "increased_cap_amount_currency": {
+ "type": "number"
+ },
+ "increased_cap_amount_period_currency": {
+ "type": "number"
+ },
+ "increased_cap_amount_period_qty": {
+ "type": "number"
+ },
+ "increased_cap_amount_qty": {
+ "type": "number"
+ },
+ "increased_cap_amount_type": {
+ "enum": [
+ "qty",
+ "currency",
+ "period"
+ ],
+ "type": "string"
+ },
+ "provider": {
+ "type": "string"
+ },
+ "supercap_currency": {
+ "description": "CSA 3.0 renamed `increased_cap_amount_currency` to `supercap_currency`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `increased_cap_amount_currency`. Sending the other spelling returns a 422.",
+ "type": "number"
+ },
+ "supercap_period_currency": {
+ "description": "CSA 3.0 renamed `increased_cap_amount_period_currency` to `supercap_period_currency`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `increased_cap_amount_period_currency`. Sending the other spelling returns a 422.",
+ "type": "number"
+ },
+ "supercap_period_qty": {
+ "description": "CSA 3.0 renamed `increased_cap_amount_period_qty` to `supercap_period_qty`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `increased_cap_amount_period_qty`. Sending the other spelling returns a 422.",
+ "type": "number"
+ },
+ "supercap_qty": {
+ "description": "CSA 3.0 renamed `increased_cap_amount_qty` to `supercap_qty`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `increased_cap_amount_qty`. Sending the other spelling returns a 422.",
+ "type": "number"
+ },
+ "supercap_type": {
+ "description": "CSA 3.0 renamed `increased_cap_amount_type` to `supercap_type`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `increased_cap_amount_type`. Sending the other spelling returns a 422.",
+ "type": "number"
+ }
+ },
+ "type": "object"
+ },
+ "csa_order_form_attributes": {
+ "additionalProperties": false,
+ "description": "Override csa order form terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "additional_changes": {
+ "type": "string"
+ },
+ "additional_parameters_or_limitations": {
+ "type": "string"
+ },
+ "affiliates_as_users": {
+ "type": "boolean"
+ },
+ "cloud_service_description": {
+ "type": "string"
+ },
+ "consumption_units": {
+ "type": "string"
+ },
+ "fee_amount": {
+ "type": "number"
+ },
+ "fee_custom_unit": {
+ "type": "string"
+ },
+ "fee_period": {
+ "enum": [
+ "Subscription Period",
+ "month",
+ "year",
+ "User",
+ "Custom unit"
+ ],
+ "type": "string"
+ },
+ "fees_attributes": {
+ "additionalProperties": {
+ "anyOf": [
+ {
+ "additionalProperties": false,
+ "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": {
+ "enum": [
+ "USD",
+ "EUR",
+ "GBP",
+ "CAD",
+ "AUD",
+ "SGD",
+ "ILS",
+ "JPY",
+ "CHF",
+ "HKD"
+ ],
+ "type": "string"
+ },
+ "fees_include_fee_increase_upon_renewal": {
+ "type": "boolean"
+ },
+ "fees_include_fee_increase_upon_renewal_fee": {
+ "type": "number"
+ },
+ "fees_include_fee_increase_upon_renewal_type": {
+ "enum": [
+ "will",
+ "may"
+ ],
+ "type": "string"
+ },
+ "fees_inclusive_of_taxes": {
+ "type": "boolean"
+ },
+ "framework_terms_type": {
+ "enum": [
+ "new",
+ "existing",
+ "description"
+ ],
+ "type": "string"
+ },
+ "free_trial_days": {
+ "type": "number"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_additional_changes": {
+ "type": "boolean"
+ },
+ "include_additional_parameters_or_limitations": {
+ "type": "boolean"
+ },
+ "include_consumption": {
+ "type": "boolean"
+ },
+ "include_fees": {
+ "type": "boolean"
+ },
+ "include_fees_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_fees_include_attachment": {
+ "type": "boolean"
+ },
+ "include_fees_other": {
+ "type": "boolean"
+ },
+ "include_fees_other_val": {
+ "type": "string"
+ },
+ "include_fees_table": {
+ "type": "boolean"
+ },
+ "include_fees_table_period": {
+ "enum": [
+ "Subscription Period",
+ "month",
+ "year",
+ "User"
+ ],
+ "type": "string"
+ },
+ "include_free_trial": {
+ "type": "boolean"
+ },
+ "include_max_users": {
+ "type": "boolean"
+ },
+ "include_pilot_period": {
+ "type": "boolean"
+ },
+ "include_pilot_period_duration_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_pilot_period_duration_type": {
+ "enum": [
+ "day",
+ "week",
+ "month"
+ ],
+ "type": "string"
+ },
+ "include_pilot_period_include_fees": {
+ "type": "boolean"
+ },
+ "include_pilot_period_include_fees_amount": {
+ "type": "number"
+ },
+ "include_pilot_period_include_modifications": {
+ "type": "boolean"
+ },
+ "include_pilot_period_include_modifications_description": {
+ "type": "string"
+ },
+ "include_product_support": {
+ "type": "boolean"
+ },
+ "include_product_support_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_product_support_description": {
+ "type": "string"
+ },
+ "include_product_support_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_professional_services": {
+ "type": "boolean"
+ },
+ "include_professional_services_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_professional_services_custom_name": {
+ "type": "string"
+ },
+ "include_professional_services_description": {
+ "type": "string"
+ },
+ "include_professional_services_end_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "include_professional_services_fees_description": {
+ "type": "string"
+ },
+ "include_professional_services_include_end_date": {
+ "type": "boolean"
+ },
+ "include_professional_services_include_fees_description": {
+ "type": "boolean"
+ },
+ "include_professional_services_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_sla": {
+ "type": "boolean"
+ },
+ "include_sla_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_sla_description": {
+ "type": "string"
+ },
+ "include_sla_include_response_time": {
+ "type": "boolean"
+ },
+ "include_sla_include_response_time_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_sla_include_response_time_credit": {
+ "type": "number"
+ },
+ "include_sla_include_response_time_duration": {
+ "enum": [
+ "hour",
+ "day",
+ "week",
+ "month",
+ "hours"
+ ],
+ "type": "string"
+ },
+ "include_sla_include_response_time_support_channel": {
+ "type": "string"
+ },
+ "include_sla_include_target_uptime": {
+ "type": "boolean"
+ },
+ "include_sla_maintenance_notice": {
+ "type": "boolean"
+ },
+ "include_sla_maintenance_window": {
+ "type": "boolean"
+ },
+ "include_sla_maintenance_window_type": {
+ "enum": [
+ "standard",
+ "none"
+ ],
+ "type": "string"
+ },
+ "include_sla_standard_maintenance_notice_qty": {
+ "type": "number"
+ },
+ "include_sla_standard_maintenance_notice_unit": {
+ "enum": [
+ "hour",
+ "day",
+ "week",
+ "month"
+ ],
+ "type": "string"
+ },
+ "include_sla_standard_maintenance_window_end_time": {
+ "type": "string"
+ },
+ "include_sla_standard_maintenance_window_friday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_monday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_saturday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_start_time": {
+ "type": "string"
+ },
+ "include_sla_standard_maintenance_window_sunday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_thursday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_time_zone": {
+ "type": "string"
+ },
+ "include_sla_standard_maintenance_window_tuesday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_wednesday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_target_uptime": {
+ "type": "number"
+ },
+ "include_sla_type": {
+ "enum": [
+ "description",
+ "standard",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_subscription_start_date": {
+ "type": "boolean"
+ },
+ "include_subscription_start_date_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "include_usage_review": {
+ "type": "boolean"
+ },
+ "include_usage_review_val": {
+ "type": "string"
+ },
+ "include_use_limitations": {
+ "type": "boolean"
+ },
+ "include_use_limitations_val": {
+ "type": "string"
+ },
+ "invoice_period": {
+ "enum": [
+ "monthly",
+ "quarterly",
+ "semiannually",
+ "annually",
+ "Custom unit",
+ "Monthly",
+ "Quarterly",
+ "Semiannually",
+ "Annually"
+ ],
+ "type": "string"
+ },
+ "invoice_period_custom_unit": {
+ "type": "string"
+ },
+ "max_consumption": {
+ "type": "number"
+ },
+ "max_users": {
+ "type": "number"
+ },
+ "negotiations_allowed": {
+ "description": "When true, the recipient can propose changes to the order form, even when the agreement-level `negotiations_allowed` is false. This only covers the order form.",
+ "type": "boolean"
+ },
+ "order_date_date": {
+ "type": "string"
+ },
+ "order_date_other": {
+ "type": "string"
+ },
+ "order_date_type": {
+ "enum": [
+ "signature",
+ "date",
+ "other"
+ ],
+ "type": "string"
+ },
+ "payment_period": {
+ "type": "number"
+ },
+ "payment_period_timeframe": {
+ "enum": [
+ "Customer's receipt of invoice",
+ "date of invoice"
+ ],
+ "type": "string"
+ },
+ "payment_period_unit": {
+ "enum": [
+ "day(s)",
+ "week(s)",
+ "month(s)",
+ "marketplace_acceptance"
+ ],
+ "type": "string"
+ },
+ "payment_process_automatic_frequency": {
+ "enum": [
+ "monthly",
+ "quarterly",
+ "semiannually",
+ "annually"
+ ],
+ "type": "string"
+ },
+ "payment_process_type": {
+ "enum": [
+ "automatic",
+ "invoice",
+ "custom",
+ "marketplace_acceptance"
+ ],
+ "type": "string"
+ },
+ "payment_process_type_custom_val": {
+ "type": "string"
+ },
+ "payment_process_type_invoice_amount": {
+ "type": "number"
+ },
+ "payment_process_type_invoice_custom_unit": {
+ "type": "string"
+ },
+ "payment_process_type_invoice_duration": {
+ "enum": [
+ "day",
+ "week",
+ "month",
+ "year",
+ "day(s)",
+ "week(s)",
+ "month(s)",
+ "year(s)"
+ ],
+ "type": "string"
+ },
+ "payment_process_type_invoice_duration_start": {
+ "enum": [
+ "Customer's receipt of invoice",
+ "date of invoice"
+ ],
+ "type": "string"
+ },
+ "payment_process_type_invoice_type": {
+ "enum": [
+ "monthly",
+ "quarterly",
+ "semiannually",
+ "annually",
+ "Custom unit"
+ ],
+ "type": "string"
+ },
+ "pilot_period_stripe_product_id": {
+ "type": "string"
+ },
+ "service_credits_attributes": {
+ "additionalProperties": {
+ "additionalProperties": false,
+ "properties": {
+ "credit": {
+ "type": "number"
+ },
+ "max": {
+ "type": "number"
+ },
+ "min": {
+ "type": "number"
+ }
+ },
+ "type": "object"
+ },
+ "description": "Service credits. Use string keys such as \"0\", \"1\".",
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+ },
+ "subscription_auto_renew": {
+ "enum": [
+ "days",
+ "subscription_end"
+ ],
+ "type": "string"
+ },
+ "subscription_period": {
+ "type": "number"
+ },
+ "subscription_period_unit": {
+ "type": "string"
+ },
+ "subscription_renewal_notice_days": {
+ "type": "number"
+ },
+ "subscription_start_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "subscription_start_date_type": {
+ "enum": [
+ "effective_date",
+ "date"
+ ],
+ "type": "string"
+ },
+ "underlying_agreement_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "use_limitations_attributes": {
+ "additionalProperties": {
+ "additionalProperties": false,
+ "properties": {
+ "amount": {
+ "type": "number"
+ },
+ "limitation_type": {
+ "type": "string"
+ },
+ "unit": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "description": "Use limitations. Use string keys such as \"0\", \"1\".",
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+ }
+ },
+ "type": "object"
+ },
+ "custom_field_values": {
+ "description": "Values for a custom template's fields, keyed by the field keys defined in the template's YAML definition. Only used when template_id is a custom template. Template defaults fill any fields you omit; a required field with no default and no submitted value returns a 400 naming the field. Values are validated against the field's input type: select and radio values must be one of the field's options, multiselect values are an array of selections each of which must be one of the field's options, number and currency values must be numeric, date values must be YYYY-MM-DD, and email values must be valid addresses. An invalid value returns a 400 naming the field."
+ },
+ "design_partner_attributes": {
+ "additionalProperties": false,
+ "description": "Override design partner terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "customer_description": {
+ "type": "string"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_fees": {
+ "type": "boolean"
+ },
+ "include_fees_amount": {
+ "type": "number"
+ },
+ "include_fees_description": {
+ "type": "string"
+ },
+ "include_fees_pay_by_amount": {
+ "type": "string"
+ },
+ "include_fees_type": {
+ "enum": [
+ "default_language",
+ "description"
+ ],
+ "type": "string"
+ },
+ "include_fees_unit": {
+ "enum": [
+ "month",
+ "quarter",
+ "year",
+ "Term"
+ ],
+ "type": "string"
+ },
+ "include_program_appear_as_customer_private": {
+ "type": "boolean"
+ },
+ "include_program_appear_as_customer_public": {
+ "type": "boolean"
+ },
+ "include_program_case_study": {
+ "type": "boolean"
+ },
+ "include_program_develop_functionality": {
+ "type": "boolean"
+ },
+ "include_program_develop_functionality_val": {
+ "type": "string"
+ },
+ "include_program_discount": {
+ "type": "boolean"
+ },
+ "include_program_discount_amount": {
+ "type": "number"
+ },
+ "include_program_discount_unit": {
+ "enum": [
+ "U.S. Dollars",
+ "percent"
+ ],
+ "type": "string"
+ },
+ "include_program_participation_feedback": {
+ "type": "boolean"
+ },
+ "include_program_participation_feedback_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_program_participation_feedback_unit": {
+ "enum": [
+ "month",
+ "quarter",
+ "year",
+ "Term"
+ ],
+ "type": "string"
+ },
+ "include_program_partner_other": {
+ "type": "boolean"
+ },
+ "include_program_partner_other_val": {
+ "type": "string"
+ },
+ "include_program_provider_other": {
+ "type": "boolean"
+ },
+ "include_program_provider_other_val": {
+ "type": "string"
+ },
+ "include_program_reference": {
+ "type": "boolean"
+ },
+ "product_description": {
+ "type": "string"
+ },
+ "term_amount": {
+ "type": "number"
+ },
+ "term_unit": {
+ "enum": [
+ "day(s)",
+ "week(s)",
+ "month(s)",
+ "quarter(s)",
+ "year(s)"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "district_or_county": {
+ "description": "The district or county for dispute resolution.",
+ "type": "string"
+ },
+ "dpa_attributes": {
+ "additionalProperties": false,
+ "description": "Override dpa terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "approved_subprocessor_type": {
+ "description": "`internal` lists approved subprocessors in the agreement (`subprocessors_attributes`); `external` points to a list published elsewhere.",
+ "enum": [
+ "internal",
+ "external"
+ ],
+ "type": "string"
+ },
+ "cloud_service_product_name": {
+ "type": "string"
+ },
+ "competent_supervisory_authority": {
+ "type": "string"
+ },
+ "customer_description": {
+ "type": "string"
+ },
+ "data_exporter_address_city": {
+ "type": "string"
+ },
+ "data_exporter_address_country": {
+ "type": "string"
+ },
+ "data_exporter_address_state": {
+ "type": "string"
+ },
+ "data_exporter_address_street_address": {
+ "type": "string"
+ },
+ "data_exporter_address_zipcode": {
+ "type": "string"
+ },
+ "data_exporter_contact_details": {
+ "type": "string"
+ },
+ "data_exporter_contact_name": {
+ "type": "string"
+ },
+ "data_exporter_contact_position": {
+ "type": "string"
+ },
+ "data_exporter_role": {
+ "description": "Role of the data exporter. Overwritten to `Controller` when the agreement is created from a template.",
+ "enum": [
+ "Controller",
+ "Processor"
+ ],
+ "type": "string"
+ },
+ "data_importer_address": {
+ "type": "string"
+ },
+ "data_importer_address_city": {
+ "type": "string"
+ },
+ "data_importer_address_country": {
+ "type": "string"
+ },
+ "data_importer_address_state": {
+ "type": "string"
+ },
+ "data_importer_address_street_address": {
+ "type": "string"
+ },
+ "data_importer_address_zipcode": {
+ "type": "string"
+ },
+ "data_importer_contact_details": {
+ "type": "string"
+ },
+ "data_importer_contact_name": {
+ "type": "string"
+ },
+ "data_importer_contact_position": {
+ "type": "string"
+ },
+ "duration_of_processing": {
+ "type": "string"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_covered_claim": {
+ "type": "boolean"
+ },
+ "include_covered_claim_external_val": {
+ "type": "string"
+ },
+ "include_covered_claim_internal_val": {
+ "type": "string"
+ },
+ "include_covered_claim_type": {
+ "description": "Which covered-claim text applies: `internal` uses `include_covered_claim_internal_val`, `external` uses `include_covered_claim_external_val`. Required when `include_covered_claim` is true.",
+ "enum": [
+ "internal",
+ "external"
+ ],
+ "type": "string"
+ },
+ "include_data_subjects_custom": {
+ "type": "boolean"
+ },
+ "include_data_subjects_custom_val": {
+ "type": "string"
+ },
+ "include_data_subjects_employees": {
+ "type": "boolean"
+ },
+ "include_data_subjects_end_users": {
+ "type": "boolean"
+ },
+ "include_external_subprocessor_location": {
+ "type": "string"
+ },
+ "include_frequency_of_transfer_continuous": {
+ "type": "boolean"
+ },
+ "include_frequency_of_transfer_custom": {
+ "type": "boolean"
+ },
+ "include_frequency_of_transfer_custom_val": {
+ "type": "string"
+ },
+ "include_governing_country_eu": {
+ "type": "boolean"
+ },
+ "include_governing_country_eu_val": {
+ "type": "string"
+ },
+ "include_governing_country_uk": {
+ "type": "boolean"
+ },
+ "include_governing_country_uk_val": {
+ "type": "string"
+ },
+ "include_governing_law": {
+ "type": "boolean"
+ },
+ "include_governing_law_country": {
+ "type": "string"
+ },
+ "include_governing_law_state": {
+ "type": "string"
+ },
+ "include_increased_claim_amount": {
+ "description": "Legacy field. Stored but not shown on the DPA; use the `include_liability_cap*` fields instead.",
+ "type": "boolean"
+ },
+ "include_increased_claim_amount_currency": {
+ "description": "Legacy field. Stored but not shown on the DPA; use the `include_liability_cap*` fields instead."
+ },
+ "include_increased_claim_amount_qty": {
+ "description": "Legacy field. Stored but not shown on the DPA; use the `include_liability_cap*` fields instead."
+ },
+ "include_increased_claim_amount_type": {
+ "description": "Legacy field. Stored but not shown on the DPA; use the `include_liability_cap*` fields instead.",
+ "type": "string"
+ },
+ "include_liability_cap": {
+ "type": "boolean"
+ },
+ "include_liability_cap_amount_constant_external": {
+ "type": "string"
+ },
+ "include_liability_cap_amount_constant_internal": {
+ "type": "string"
+ },
+ "include_liability_cap_amount_currency_external": {
+ "description": "Currency amount. Numbers and numeric strings (commas allowed) are both accepted."
+ },
+ "include_liability_cap_amount_currency_internal": {
+ "description": "Currency amount. Numbers and numeric strings (commas allowed) are both accepted."
+ },
+ "include_liability_cap_csa_type": {
+ "description": "Which liability cap values apply: the `_internal` or `_external` amount fields. Required when `include_liability_cap` is true.",
+ "enum": [
+ "internal",
+ "external"
+ ],
+ "type": "string"
+ },
+ "include_personal_data_biographic_info": {
+ "type": "boolean"
+ },
+ "include_personal_data_contact_info": {
+ "type": "boolean"
+ },
+ "include_personal_data_custom": {
+ "type": "boolean"
+ },
+ "include_personal_data_custom_val": {
+ "type": "string"
+ },
+ "include_personal_data_employment_info": {
+ "type": "boolean"
+ },
+ "include_personal_data_financial_info": {
+ "type": "boolean"
+ },
+ "include_personal_data_location": {
+ "type": "boolean"
+ },
+ "include_personal_data_name": {
+ "type": "boolean"
+ },
+ "include_personal_data_transactional_info": {
+ "type": "boolean"
+ },
+ "include_personal_data_user_activity_info": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_custom": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_custom_val": {
+ "type": "string"
+ },
+ "include_processing_purpose_erasing": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_holding": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_protecting": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_receiving": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_returning": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_sharing": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_updating": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_using": {
+ "type": "boolean"
+ },
+ "include_provider_security_contact_address": {
+ "type": "boolean"
+ },
+ "include_provider_security_contact_address_city": {
+ "type": "string"
+ },
+ "include_provider_security_contact_address_country": {
+ "type": "string"
+ },
+ "include_provider_security_contact_address_state": {
+ "type": "string"
+ },
+ "include_provider_security_contact_address_street_address": {
+ "type": "string"
+ },
+ "include_provider_security_contact_address_zipcode": {
+ "type": "string"
+ },
+ "include_provider_security_contact_email": {
+ "type": "boolean"
+ },
+ "include_provider_security_contact_email_val": {
+ "format": "email",
+ "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "include_security_measures_accountability": {
+ "type": "boolean"
+ },
+ "include_security_measures_accountability_val": {
+ "type": "string"
+ },
+ "include_security_measures_certification_or_assurance": {
+ "type": "boolean"
+ },
+ "include_security_measures_certification_or_assurance_val": {
+ "type": "string"
+ },
+ "include_security_measures_confidentiality_integrity": {
+ "type": "boolean"
+ },
+ "include_security_measures_confidentiality_integrity_val": {
+ "type": "string"
+ },
+ "include_security_measures_data_at_rest": {
+ "type": "boolean"
+ },
+ "include_security_measures_data_at_rest_val": {
+ "type": "string"
+ },
+ "include_security_measures_data_minimization": {
+ "type": "boolean"
+ },
+ "include_security_measures_data_minimization_val": {
+ "type": "string"
+ },
+ "include_security_measures_data_quality": {
+ "type": "boolean"
+ },
+ "include_security_measures_data_quality_val": {
+ "type": "string"
+ },
+ "include_security_measures_data_retention": {
+ "type": "boolean"
+ },
+ "include_security_measures_data_retention_val": {
+ "type": "string"
+ },
+ "include_security_measures_data_transmission": {
+ "type": "boolean"
+ },
+ "include_security_measures_data_transmission_val": {
+ "type": "string"
+ },
+ "include_security_measures_event_logging": {
+ "type": "boolean"
+ },
+ "include_security_measures_event_logging_val": {
+ "type": "string"
+ },
+ "include_security_measures_identity_auth": {
+ "type": "boolean"
+ },
+ "include_security_measures_identity_auth_val": {
+ "type": "string"
+ },
+ "include_security_measures_it_security_governance": {
+ "type": "boolean"
+ },
+ "include_security_measures_it_security_governance_val": {
+ "type": "string"
+ },
+ "include_security_measures_physical_security": {
+ "type": "boolean"
+ },
+ "include_security_measures_physical_security_val": {
+ "type": "string"
+ },
+ "include_security_measures_portability_and_erasure": {
+ "type": "boolean"
+ },
+ "include_security_measures_portability_and_erasure_val": {
+ "type": "string"
+ },
+ "include_security_measures_pseudonym_encryption": {
+ "type": "boolean"
+ },
+ "include_security_measures_pseudonym_encryption_val": {
+ "type": "string"
+ },
+ "include_security_measures_restore_data_access": {
+ "type": "boolean"
+ },
+ "include_security_measures_restore_data_access_val": {
+ "type": "string"
+ },
+ "include_security_measures_security_policy": {
+ "type": "boolean"
+ },
+ "include_security_measures_system_configuration": {
+ "type": "boolean"
+ },
+ "include_security_measures_system_configuration_val": {
+ "type": "string"
+ },
+ "include_security_measures_testing_assessment": {
+ "type": "boolean"
+ },
+ "include_security_measures_testing_assessment_val": {
+ "type": "string"
+ },
+ "include_security_policy": {
+ "type": "boolean"
+ },
+ "include_security_policy_fedramp_auth": {
+ "type": "boolean"
+ },
+ "include_security_policy_hipaa": {
+ "type": "boolean"
+ },
+ "include_security_policy_hitrust": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_other": {
+ "type": "boolean"
+ },
+ "include_security_policy_iso27001": {
+ "type": "boolean"
+ },
+ "include_security_policy_other": {
+ "type": "string"
+ },
+ "include_security_policy_pci1": {
+ "type": "boolean"
+ },
+ "include_security_policy_pci2": {
+ "type": "boolean"
+ },
+ "include_security_policy_penetration_testing": {
+ "type": "boolean"
+ },
+ "include_security_policy_soc2": {
+ "type": "boolean"
+ },
+ "include_security_policy_soc2_type2": {
+ "type": "boolean"
+ },
+ "include_sensitive_data_restrictions_custom": {
+ "type": "boolean"
+ },
+ "include_sensitive_data_restrictions_custom_val": {
+ "type": "string"
+ },
+ "include_sensitive_data_restrictions_security_policy": {
+ "type": "boolean"
+ },
+ "include_service_provider_relationship": {
+ "type": "boolean"
+ },
+ "include_special_category_data": {
+ "type": "boolean"
+ },
+ "provider": {
+ "type": "string"
+ },
+ "security_policy_available_at": {
+ "type": "string"
+ },
+ "security_policy_type": {
+ "description": "Where the Security Policy is defined. For `external`, set `security_policy_available_at`.",
+ "enum": [
+ "defined in agreement",
+ "provider service",
+ "external"
+ ],
+ "type": "string"
+ },
+ "subprocessors_attributes": {
+ "additionalProperties": {
+ "additionalProperties": false,
+ "properties": {
+ "_destroy": {
+ "description": "Set to true with `id` to remove that subprocessor.",
+ "type": "boolean"
+ },
+ "country": {
+ "type": "string"
+ },
+ "id": {
+ "description": "ID of an existing subprocessor to update or remove. Omit to add a new subprocessor.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "processing_task": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "description": "Subprocessors, keyed by string index such as \"0\", \"1\". On create these are added to the template's subprocessors. On a draft update, an entry without `id` adds a new subprocessor; pass `id` to change one and `id` with `_destroy: true` to remove one.",
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+ },
+ "underlying_agreement_id": {
+ "description": "ID of the CSA this DPA supplements when `underlying_agreement_type` is `internal`.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "underlying_agreement_type": {
+ "description": "`internal` links a CSA in Common Paper (`underlying_agreement_id`); `external` describes another agreement in `underlying_agreement_val` (required). Omit for none.",
+ "enum": [
+ "internal",
+ "external"
+ ],
+ "type": "string"
+ },
+ "underlying_agreement_val": {
+ "description": "Description of the agreement this DPA supplements. Required when `underlying_agreement_type` is `external`.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "framework_terms_description": {
+ "description": "Custom framework terms description. Only used when framework_terms_type is \"description\".",
+ "type": "string"
+ },
+ "framework_terms_type": {
+ "description": "How framework terms are specified. Use \"new\" for standard terms or \"description\" to provide a custom framework_terms_description.",
+ "enum": [
+ "new",
+ "description"
+ ],
+ "type": "string"
+ },
+ "governing_law_country": {
+ "description": "The country whose laws govern the agreement.",
+ "type": "string"
+ },
+ "governing_law_region": {
+ "description": "The state or region whose laws govern the agreement.",
+ "type": "string"
+ },
+ "include_automated_payment_reminders": {
+ "description": "When true, automatically sends payment reminder emails.",
+ "type": "boolean"
+ },
+ "include_billing_info": {
+ "description": "When true, billing contact information (billing_name, billing_email) is included.",
+ "type": "boolean"
+ },
+ "include_billing_workflow": {
+ "description": "When true, enables a billing workflow after signing.",
+ "type": "boolean"
+ },
+ "include_expiration_date": {
+ "description": "Expiration date in YYYY-MM-DD format. Use when include_expiration_type is \"date\".",
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "include_expiration_days": {
+ "description": "Number of days until the agreement expires. Use when include_expiration_type is \"days\".",
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_expiration_type": {
+ "description": "How to set expiration: \"none\" (default), \"days\" (use include_expiration_days), or \"date\" (use include_expiration_date).",
+ "enum": [
+ "none",
+ "days",
+ "date"
+ ],
+ "type": "string"
+ },
+ "include_terms": {
+ "description": "When true, the standard terms are included with the agreement.",
+ "type": "boolean"
+ },
+ "loi_attributes": {
+ "additionalProperties": false,
+ "description": "Override loi terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "confidentiality_custom": {
+ "type": "string"
+ },
+ "confidentiality_mutual_include_loi": {
+ "type": "boolean"
+ },
+ "confidentiality_nda_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "confidentiality_nda_description": {
+ "type": "string"
+ },
+ "confidentiality_nda_include_loi": {
+ "type": "boolean"
+ },
+ "confidentiality_nda_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "confidentiality_type": {
+ "enum": [
+ "mutual",
+ "nda",
+ "provider",
+ "custom"
+ ],
+ "type": "string"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_custom_details": {
+ "type": "boolean"
+ },
+ "include_custom_details_val": {
+ "type": "string"
+ },
+ "include_fees": {
+ "type": "boolean"
+ },
+ "include_fees_amount": {
+ "type": "number"
+ },
+ "include_fees_amount_duration": {
+ "enum": [
+ "month",
+ "year",
+ "quarter"
+ ],
+ "type": "string"
+ },
+ "include_fees_include_amount": {
+ "type": "boolean"
+ },
+ "include_fees_include_other": {
+ "type": "boolean"
+ },
+ "include_fees_other": {
+ "type": "string"
+ },
+ "include_functionality": {
+ "type": "boolean"
+ },
+ "include_functionality_val": {
+ "type": "string"
+ },
+ "include_launch_date": {
+ "type": "boolean"
+ },
+ "include_launch_date_custom": {
+ "type": "string"
+ },
+ "include_launch_date_date": {
+ "format": "date-time",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$",
+ "type": "string"
+ },
+ "include_launch_date_type": {
+ "enum": [
+ "date",
+ "custom"
+ ],
+ "type": "string"
+ },
+ "product_name": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "manual_send": {
+ "description": "When true, the agreement is marked as manually sent outside the platform.",
+ "type": "boolean"
+ },
+ "message": {
+ "type": "string"
+ },
+ "negotiations_allowed": {
+ "description": "When true, the recipient can propose changes to the legal terms. For agreement types without separate business terms, that covers every term. CSA order forms, PSA statements of work, partnership business terms and software license order forms have their own `negotiations_allowed` flag.",
+ "type": "boolean"
+ },
+ "partnership_attributes": {
+ "additionalProperties": false,
+ "description": "Override partnership terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "effective_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "effective_date_type": {
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "type": "string"
+ },
+ "general_cap_amount_currency_val": {
+ "type": "number"
+ },
+ "general_cap_amount_either_currency": {
+ "type": "number"
+ },
+ "general_cap_amount_either_multiple": {
+ "type": "number"
+ },
+ "general_cap_amount_multiple_val": {
+ "type": "number"
+ },
+ "general_cap_amount_type": {
+ "enum": [
+ "multiple",
+ "currency",
+ "either",
+ "base"
+ ],
+ "type": "string"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_additional_warranties": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_include_company": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_include_company_val": {
+ "type": "string"
+ },
+ "include_additional_warranties_include_partner": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_include_partner_val": {
+ "type": "string"
+ },
+ "include_brand_guidelines": {
+ "type": "boolean"
+ },
+ "include_brand_guidelines_include_company": {
+ "type": "boolean"
+ },
+ "include_brand_guidelines_include_company_val": {
+ "type": "string"
+ },
+ "include_brand_guidelines_include_partner": {
+ "type": "boolean"
+ },
+ "include_brand_guidelines_include_partner_val": {
+ "type": "string"
+ },
+ "include_covered_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_company_claims": {
+ "type": "string"
+ },
+ "include_covered_claims_include_company_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_include_partner_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_partner_claims": {
+ "type": "string"
+ },
+ "include_dpa": {
+ "type": "boolean"
+ },
+ "include_dpa_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_dpa_location": {
+ "type": "string"
+ },
+ "include_dpa_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_increased_cap_amount": {
+ "type": "boolean"
+ },
+ "include_increased_cap_amount_currency": {
+ "type": "number"
+ },
+ "include_increased_cap_amount_either_currency": {
+ "type": "number"
+ },
+ "include_increased_cap_amount_either_multiple": {
+ "type": "string"
+ },
+ "include_increased_cap_amount_multiple": {
+ "type": "string"
+ },
+ "include_increased_cap_amount_type": {
+ "enum": [
+ "multiple",
+ "currency",
+ "either"
+ ],
+ "type": "string"
+ },
+ "include_increased_claims": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_confidentiality": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_confidentiality_misconduct": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_covered_claims": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_misconduct": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_other": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_other_val": {
+ "type": "string"
+ },
+ "include_unlimited_claims": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_confidentiality": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_confidentiality_misconduct": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_covered_claims": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_misconduct": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_other": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_other_val": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "partnership_business_terms_attributes": {
+ "additionalProperties": false,
+ "description": "Override partnership business terms terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "end_date_after_effective_date_amount": {
+ "type": "number"
+ },
+ "end_date_after_effective_date_unit": {
+ "enum": [
+ "month(s)",
+ "quarter(s)",
+ "year(s)"
+ ],
+ "type": "string"
+ },
+ "end_date_date": {
+ "type": "string"
+ },
+ "end_date_type": {
+ "enum": [
+ "date",
+ "effective date"
+ ],
+ "type": "string"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_obligations_company_brand": {
+ "type": "boolean"
+ },
+ "include_obligations_company_promotion": {
+ "type": "boolean"
+ },
+ "include_obligations_company_promotion_include_activities": {
+ "type": "boolean"
+ },
+ "include_obligations_company_promotion_include_activities_val": {
+ "type": "string"
+ },
+ "include_obligations_company_promotion_include_materials": {
+ "type": "boolean"
+ },
+ "include_obligations_company_promotion_include_materials_val": {
+ "type": "string"
+ },
+ "include_obligations_company_referral": {
+ "type": "boolean"
+ },
+ "include_obligations_company_referral_include_criteria": {
+ "type": "boolean"
+ },
+ "include_obligations_company_referral_include_criteria_val": {
+ "type": "string"
+ },
+ "include_obligations_company_referral_include_pay_sch": {
+ "type": "boolean"
+ },
+ "include_obligations_company_referral_include_pay_sch_amount": {
+ "type": "number"
+ },
+ "include_obligations_company_referral_include_pay_sch_custom": {
+ "type": "string"
+ },
+ "include_obligations_company_referral_include_pay_sch_unit": {
+ "enum": [
+ "U.S. Dollars",
+ "percent"
+ ],
+ "type": "string"
+ },
+ "include_obligations_company_sponsorship": {
+ "type": "boolean"
+ },
+ "include_obligations_company_sponsorship_include_benefits": {
+ "type": "boolean"
+ },
+ "include_obligations_company_sponsorship_include_benefits_val": {
+ "type": "string"
+ },
+ "include_obligations_company_sponsorship_include_payments": {
+ "type": "boolean"
+ },
+ "include_obligations_company_sponsorship_include_payments_amount": {
+ "type": "number"
+ },
+ "include_obligations_company_sponsorship_include_payments_unit": {
+ "enum": [
+ "U.S. Dollars",
+ "percent"
+ ],
+ "type": "string"
+ },
+ "include_obligations_partner_brand": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_promotion": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_promotion_include_activities": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_promotion_include_activities_val": {
+ "type": "string"
+ },
+ "include_obligations_partner_promotion_include_materials": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_promotion_include_materials_val": {
+ "type": "string"
+ },
+ "include_obligations_partner_referral": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_referral_include_criteria": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_referral_include_criteria_val": {
+ "type": "string"
+ },
+ "include_obligations_partner_referral_include_pay_sch": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_referral_include_pay_sch_amount": {
+ "type": "number"
+ },
+ "include_obligations_partner_referral_include_pay_sch_custom": {
+ "type": "string"
+ },
+ "include_obligations_partner_referral_include_pay_sch_unit": {
+ "enum": [
+ "U.S. Dollars",
+ "percent"
+ ],
+ "type": "string"
+ },
+ "include_obligations_partner_sponsorship": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_sponsorship_include_benefits": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_sponsorship_include_benefits_val": {
+ "type": "string"
+ },
+ "include_obligations_partner_sponsorship_include_payments": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_sponsorship_include_payments_amount": {
+ "type": "number"
+ },
+ "include_obligations_partner_sponsorship_include_payments_unit": {
+ "enum": [
+ "U.S. Dollars",
+ "percent"
+ ],
+ "type": "string"
+ },
+ "include_payment_process": {
+ "type": "boolean"
+ },
+ "include_payment_process_company": {
+ "type": "boolean"
+ },
+ "include_payment_process_company_include_address": {
+ "type": "boolean"
+ },
+ "include_payment_process_company_include_address_city": {
+ "type": "string"
+ },
+ "include_payment_process_company_include_address_country": {
+ "type": "string"
+ },
+ "include_payment_process_company_include_address_state": {
+ "type": "string"
+ },
+ "include_payment_process_company_include_address_street_address": {
+ "type": "string"
+ },
+ "include_payment_process_company_include_address_zipcode": {
+ "type": "string"
+ },
+ "include_payment_process_company_include_email": {
+ "type": "boolean"
+ },
+ "include_payment_process_company_include_email_val": {
+ "type": "string"
+ },
+ "include_payment_process_partner": {
+ "type": "boolean"
+ },
+ "include_payment_process_partner_include_address": {
+ "type": "boolean"
+ },
+ "include_payment_process_partner_include_address_city": {
+ "type": "string"
+ },
+ "include_payment_process_partner_include_address_country": {
+ "type": "string"
+ },
+ "include_payment_process_partner_include_address_state": {
+ "type": "string"
+ },
+ "include_payment_process_partner_include_address_street_address": {
+ "type": "string"
+ },
+ "include_payment_process_partner_include_address_zipcode": {
+ "type": "string"
+ },
+ "include_payment_process_partner_include_email": {
+ "type": "boolean"
+ },
+ "include_payment_process_partner_include_email_val": {
+ "type": "string"
+ },
+ "include_payment_schedule": {
+ "type": "boolean"
+ },
+ "include_payment_schedule_custom": {
+ "type": "string"
+ },
+ "include_payment_schedule_specified_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_payment_schedule_specified_timeframe": {
+ "enum": [
+ "receipt",
+ "date"
+ ],
+ "type": "string"
+ },
+ "include_payment_schedule_specified_unit": {
+ "enum": [
+ "day(s)",
+ "week(s)",
+ "month(s)",
+ "quarter(s)",
+ "year(s)"
+ ],
+ "type": "string"
+ },
+ "include_payment_schedule_type": {
+ "enum": [
+ "specified",
+ "custom"
+ ],
+ "type": "string"
+ },
+ "negotiations_allowed": {
+ "description": "When true, the recipient can propose changes to the business terms, even when the agreement-level `negotiations_allowed` is false. This only covers the business terms.",
+ "type": "boolean"
+ },
+ "territory_type": {
+ "enum": [
+ "worldwide",
+ "custom"
+ ],
+ "type": "string"
+ },
+ "territory_type_val": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "payment_link_url": {
+ "description": "A payment URL shown to the recipient after signing. Requires include_billing_workflow to be true and billing_workflow_type to be \"link\".",
+ "type": "string"
+ },
+ "pilot_attributes": {
+ "additionalProperties": false,
+ "description": "Override pilot terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "fees_type": {
+ "enum": [
+ "free",
+ "pilot_period_fees"
+ ],
+ "type": "string"
+ },
+ "general_cap_amount": {
+ "type": "number"
+ },
+ "general_cap_amount_type": {
+ "enum": [
+ "preceding",
+ "base",
+ "period"
+ ],
+ "type": "string"
+ },
+ "general_cap_period_currency": {
+ "type": "number"
+ },
+ "general_cap_period_qty": {
+ "type": "number"
+ },
+ "general_cap_preceding_amount": {
+ "type": "number"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_dpa": {
+ "type": "boolean"
+ },
+ "include_dpa_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_dpa_location": {
+ "type": "string"
+ },
+ "include_dpa_type": {
+ "enum": [
+ "description",
+ "attachment",
+ "standard"
+ ],
+ "type": "string"
+ },
+ "include_payment_process": {
+ "type": "boolean"
+ },
+ "include_technical_support": {
+ "type": "boolean"
+ },
+ "payment_process_automatic_frequency": {
+ "enum": [
+ "monthly",
+ "quarterly",
+ "annually",
+ "once_per_period"
+ ],
+ "type": "string"
+ },
+ "payment_process_invoice_days": {
+ "type": "number"
+ },
+ "payment_process_invoice_from": {
+ "enum": [
+ "receipt",
+ "date"
+ ],
+ "type": "string"
+ },
+ "payment_process_invoice_timeframe": {
+ "enum": [
+ "days",
+ "weeks",
+ "months",
+ "quarters",
+ "years"
+ ],
+ "type": "string"
+ },
+ "payment_process_type": {
+ "enum": [
+ "automatic",
+ "invoice"
+ ],
+ "type": "string"
+ },
+ "pilot_period_description": {
+ "type": "string"
+ },
+ "pilot_period_fees_description": {
+ "type": "string"
+ },
+ "product_description": {
+ "type": "string"
+ },
+ "technical_support_description": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "psa_attributes": {
+ "additionalProperties": false,
+ "description": "Override psa terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "additional_changes": {
+ "type": "string"
+ },
+ "customer_description": {
+ "type": "string"
+ },
+ "effective_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "effective_date_type": {
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "type": "string"
+ },
+ "general_cap_amount": {
+ "type": "number"
+ },
+ "general_cap_amount_type": {
+ "enum": [
+ "preceding",
+ "base",
+ "period"
+ ],
+ "type": "string"
+ },
+ "general_cap_period_currency": {
+ "type": "number"
+ },
+ "general_cap_period_qty": {
+ "type": "number"
+ },
+ "general_cap_preceding_amount": {
+ "type": "number"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_additional_changes": {
+ "type": "boolean"
+ },
+ "include_additional_warranties": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_by_customer": {
+ "type": "string"
+ },
+ "include_additional_warranties_by_provider": {
+ "type": "string"
+ },
+ "include_additional_warranties_include_by_customer": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_include_by_provider": {
+ "type": "boolean"
+ },
+ "include_covered_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_customer_claims": {
+ "type": "string"
+ },
+ "include_covered_claims_include_customer_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_include_provider_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_provider_claims": {
+ "type": "string"
+ },
+ "include_customer_insurance_min": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_add_provider_com_gen_liability": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_add_provider_cyber_liability": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_add_provider_errors_omissions": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_auto_liability_aggregate": {
+ "type": "number"
+ },
+ "include_customer_insurance_min_auto_liability_minimum": {
+ "type": "number"
+ },
+ "include_customer_insurance_min_cyber_liability_aggregate": {
+ "type": "number"
+ },
+ "include_customer_insurance_min_cyber_liability_minimum": {
+ "type": "number"
+ },
+ "include_customer_insurance_min_employer_liability_aggregate": {
+ "type": "number"
+ },
+ "include_customer_insurance_min_employer_liability_minimum": {
+ "type": "number"
+ },
+ "include_customer_insurance_min_general_liability_aggregate": {
+ "type": "number"
+ },
+ "include_customer_insurance_min_general_liability_minimum": {
+ "type": "number"
+ },
+ "include_customer_insurance_min_include_add_provider": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_include_auto_liability": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_include_cyber_liability": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_include_employer_liability": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_include_general_liability": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_include_workers_comp": {
+ "type": "boolean"
+ },
+ "include_customer_policies": {
+ "type": "boolean"
+ },
+ "include_customer_policies_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_customer_policies_location": {
+ "type": "string"
+ },
+ "include_customer_policies_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_dpa": {
+ "type": "boolean"
+ },
+ "include_dpa_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_dpa_location": {
+ "type": "string"
+ },
+ "include_dpa_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_increased_cap_amount": {
+ "type": "boolean"
+ },
+ "include_increased_claims": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_confidentiality": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_confidentiality_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_privsec": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_privsec_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_other": {
+ "type": "boolean"
+ },
+ "include_increased_claims_indemnification_obligation": {
+ "type": "boolean"
+ },
+ "include_increased_claims_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_other": {
+ "type": "string"
+ },
+ "include_provider_insurance_min": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_add_customer_com_gen_liability": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_add_customer_cyber_liability": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_add_customer_errors_omissions": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_auto_liability_aggregate": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_auto_liability_minimum": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_cyber_liability_aggregate": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_cyber_liability_minimum": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_employer_liability_aggregate": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_employer_liability_minimum": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_general_liability_aggregate": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_general_liability_minimum": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_include_add_customer": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_include_auto_liability": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_include_cyber_liability": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_include_employer_liability": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_include_general_liability": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_include_workers_comp": {
+ "type": "boolean"
+ },
+ "include_publicity_rights": {
+ "type": "boolean"
+ },
+ "include_publicity_rights_type": {
+ "enum": [
+ "public",
+ "non-public"
+ ],
+ "type": "string"
+ },
+ "include_security_policy": {
+ "type": "boolean"
+ },
+ "include_security_policy_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_security_policy_fedramp_auth": {
+ "type": "boolean"
+ },
+ "include_security_policy_hitrust": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_annual_maintenance": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_other": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_other_val": {
+ "type": "string"
+ },
+ "include_security_policy_iso27001": {
+ "type": "boolean"
+ },
+ "include_security_policy_location": {
+ "type": "string"
+ },
+ "include_security_policy_pci1": {
+ "type": "boolean"
+ },
+ "include_security_policy_pci2": {
+ "type": "boolean"
+ },
+ "include_security_policy_penetration_testing": {
+ "type": "boolean"
+ },
+ "include_security_policy_soc2_type1": {
+ "type": "boolean"
+ },
+ "include_security_policy_soc2_type2": {
+ "type": "boolean"
+ },
+ "include_security_policy_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_unlimited_claims": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_confidentiality": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_confidentiality_negligence": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_privsec": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_privsec_negligence": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_include_other": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_indemnification_obligation": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_negligence": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_other": {
+ "type": "string"
+ },
+ "increased_cap_amount_currency": {
+ "type": "number"
+ },
+ "increased_cap_amount_period_currency": {
+ "type": "number"
+ },
+ "increased_cap_amount_period_qty": {
+ "type": "number"
+ },
+ "increased_cap_amount_qty": {
+ "type": "number"
+ },
+ "increased_cap_amount_type": {
+ "enum": [
+ "qty",
+ "currency",
+ "period"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "psa_statement_of_work_attributes": {
+ "additionalProperties": false,
+ "description": "Override psa statement of work terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "additional_changes": {
+ "type": "string"
+ },
+ "cost": {
+ "type": "number"
+ },
+ "description": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "fees_attributes": {
+ "additionalProperties": {
+ "anyOf": [
+ {
+ "additionalProperties": false,
+ "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": "string"
+ },
+ "include_deliverables": {
+ "type": "boolean"
+ },
+ "include_deliverables_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_deliverables_description": {
+ "type": "string"
+ },
+ "include_deliverables_include_acceptance": {
+ "type": "boolean"
+ },
+ "include_deliverables_include_attachment": {
+ "type": "boolean"
+ },
+ "include_deliverables_include_draft_deliverables": {
+ "type": "boolean"
+ },
+ "include_deliverables_rejection_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_deliverables_rejection_unit": {
+ "enum": [
+ "hours",
+ "days",
+ "weeks",
+ "months"
+ ],
+ "type": "string"
+ },
+ "include_deliverables_resubmission_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_deliverables_resubmission_unit": {
+ "enum": [
+ "hours",
+ "days",
+ "weeks",
+ "months"
+ ],
+ "type": "string"
+ },
+ "include_fees_other": {
+ "type": "boolean"
+ },
+ "include_fees_other_val": {
+ "type": "string"
+ },
+ "include_fees_table": {
+ "type": "boolean"
+ },
+ "include_fees_table_total": {
+ "type": "boolean"
+ },
+ "include_fees_travel": {
+ "type": "boolean"
+ },
+ "include_fees_travel_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_fees_travel_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_fees_travel_val": {
+ "type": "string"
+ },
+ "include_third_party_customer": {
+ "type": "boolean"
+ },
+ "include_third_party_include_description": {
+ "type": "boolean"
+ },
+ "include_third_party_include_description_val": {
+ "type": "string"
+ },
+ "include_third_party_materials": {
+ "type": "boolean"
+ },
+ "include_third_party_provider": {
+ "type": "boolean"
+ },
+ "include_time_of_assignment": {
+ "type": "boolean"
+ },
+ "include_time_of_assignment_type": {
+ "enum": [
+ "created",
+ "paid"
+ ],
+ "type": "string"
+ },
+ "invoice_period_description": {
+ "type": "string"
+ },
+ "negotiations_allowed": {
+ "description": "When true, the recipient can propose changes to the statement of work, even when the agreement-level `negotiations_allowed` is false. This only covers the statement of work.",
+ "type": "boolean"
+ },
+ "payment_period": {
+ "type": "number"
+ },
+ "payment_period_other": {
+ "type": "string"
+ },
+ "payment_period_timeframe": {
+ "enum": [
+ "receipt",
+ "invoice",
+ "Customer's receipt of invoice",
+ "date of invoice"
+ ],
+ "type": "string"
+ },
+ "payment_period_type": {
+ "enum": [
+ "standard",
+ "other"
+ ],
+ "type": "string"
+ },
+ "payment_period_unit": {
+ "enum": [
+ "day(s)",
+ "week(s)",
+ "month(s)",
+ "quarter(s)",
+ "year(s)"
+ ],
+ "type": "string"
+ },
+ "quantity": {
+ "type": "number"
+ },
+ "services_description": {
+ "type": "string"
+ },
+ "sow_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "sow_date_type": {
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "type": "string"
+ },
+ "sow_term_amount": {
+ "type": "number"
+ },
+ "sow_term_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "sow_term_type": {
+ "enum": [
+ "deliverables",
+ "period",
+ "date"
+ ],
+ "type": "string"
+ },
+ "sow_term_unit": {
+ "enum": [
+ "month(s)",
+ "quarter(s)",
+ "year(s)"
+ ],
+ "type": "string"
+ },
+ "type": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "recipient_email": {
+ "format": "email",
+ "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-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_last_to_sign": {
+ "description": "When true, your signer signs after the recipient.",
+ "type": "boolean"
+ },
+ "sender_notice_email_address": {
+ "description": "Email address for legal notices to the sender.",
+ "format": "email",
+ "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-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": {
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "type": "string"
+ },
+ "general_cap_amount": {
+ "type": "number"
+ },
+ "general_cap_amount_type": {
+ "enum": [
+ "preceding",
+ "base",
+ "period"
+ ],
+ "type": "string"
+ },
+ "general_cap_period_currency": {
+ "type": "number"
+ },
+ "general_cap_period_qty": {
+ "type": "number"
+ },
+ "general_cap_preceding_amount": {
+ "type": "number"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_additional_warranties": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_by_customer": {
+ "type": "string"
+ },
+ "include_additional_warranties_by_provider": {
+ "type": "string"
+ },
+ "include_additional_warranties_include_by_customer": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_include_by_provider": {
+ "type": "boolean"
+ },
+ "include_ai_addendum": {
+ "type": "boolean"
+ },
+ "include_ai_addendum_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_covered_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_customer_claims": {
+ "type": "string"
+ },
+ "include_covered_claims_include_customer_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_include_provider_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_provider_claims": {
+ "type": "string"
+ },
+ "include_dpa": {
+ "type": "boolean"
+ },
+ "include_dpa_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_dpa_location": {
+ "type": "string"
+ },
+ "include_dpa_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_increased_cap_amount": {
+ "type": "boolean"
+ },
+ "include_increased_claims": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_confidentiality": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_confidentiality_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_other": {
+ "type": "boolean"
+ },
+ "include_increased_claims_indemnification_obligation": {
+ "type": "boolean"
+ },
+ "include_increased_claims_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_other": {
+ "type": "string"
+ },
+ "include_increased_claims_restrictions": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_confidentiality": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_confidentiality_negligence": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_include_other": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_indemnification_obligation": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_license_or_restrictions": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_negligence": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_other": {
+ "type": "string"
+ },
+ "increased_cap_amount_currency": {
+ "type": "number"
+ },
+ "increased_cap_amount_period_currency": {
+ "type": "number"
+ },
+ "increased_cap_amount_period_qty": {
+ "type": "number"
+ },
+ "increased_cap_amount_qty": {
+ "type": "number"
+ },
+ "increased_cap_amount_type": {
+ "enum": [
+ "qty",
+ "currency",
+ "period"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "software_license_order_form_attributes": {
+ "additionalProperties": false,
+ "description": "Override software license order form terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "additional_changes": {
+ "type": "string"
+ },
+ "deletion_procedure_include_custom": {
+ "type": "boolean"
+ },
+ "deletion_procedure_include_custom_description": {
+ "type": "string"
+ },
+ "deletion_procedure_include_customer_disable": {
+ "type": "boolean"
+ },
+ "deletion_procedure_include_customer_proof": {
+ "type": "boolean"
+ },
+ "deletion_procedure_include_provider_disable": {
+ "type": "boolean"
+ },
+ "fee_custom_unit": {
+ "type": "string"
+ },
+ "fee_period": {
+ "enum": [
+ "Subscription Period",
+ "month",
+ "year",
+ "Custom unit"
+ ],
+ "type": "string"
+ },
+ "fees_attributes": {
+ "additionalProperties": {
+ "anyOf": [
+ {
+ "additionalProperties": false,
+ "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": {
+ "enum": [
+ "USD",
+ "EUR",
+ "GBP",
+ "CAD",
+ "AUD",
+ "SGD",
+ "ILS",
+ "JPY",
+ "CHF",
+ "HKD"
+ ],
+ "type": "string"
+ },
+ "fees_include_fee_increase_upon_renewal": {
+ "type": "boolean"
+ },
+ "fees_include_fee_increase_upon_renewal_fee": {
+ "type": "number"
+ },
+ "fees_include_fee_increase_upon_renewal_type": {
+ "enum": [
+ "will",
+ "may"
+ ],
+ "type": "string"
+ },
+ "fees_inclusive_of_taxes": {
+ "type": "boolean"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_additional_changes": {
+ "type": "boolean"
+ },
+ "include_license_compliance_verification": {
+ "type": "boolean"
+ },
+ "include_license_compliance_verification_description": {
+ "type": "string"
+ },
+ "include_license_limits": {
+ "type": "boolean"
+ },
+ "include_license_limits_description": {
+ "type": "string"
+ },
+ "include_payment_process_include_billing_email": {
+ "type": "boolean"
+ },
+ "include_pilot_period": {
+ "type": "boolean"
+ },
+ "include_pilot_period_duration_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_pilot_period_duration_type": {
+ "enum": [
+ "day",
+ "week",
+ "month"
+ ],
+ "type": "string"
+ },
+ "include_pilot_period_include_fees": {
+ "type": "boolean"
+ },
+ "include_pilot_period_include_fees_amount": {
+ "type": "number"
+ },
+ "include_pilot_period_include_modifications": {
+ "type": "boolean"
+ },
+ "include_pilot_period_include_modifications_description": {
+ "type": "string"
+ },
+ "include_services": {
+ "type": "boolean"
+ },
+ "include_services_description": {
+ "type": "string"
+ },
+ "negotiations_allowed": {
+ "description": "When true, the recipient can propose changes to the order form, even when the agreement-level `negotiations_allowed` is false. This only covers the order form.",
+ "type": "boolean"
+ },
+ "order_date_date": {
+ "type": "string"
+ },
+ "order_date_type": {
+ "enum": [
+ "signature",
+ "date",
+ "other"
+ ],
+ "type": "string"
+ },
+ "payment_process_automatic_frequency": {
+ "enum": [
+ "monthly",
+ "quarterly",
+ "semiannually",
+ "annually"
+ ],
+ "type": "string"
+ },
+ "payment_process_type": {
+ "enum": [
+ "automatic",
+ "invoice",
+ "custom"
+ ],
+ "type": "string"
+ },
+ "payment_process_type_custom_val": {
+ "type": "string"
+ },
+ "payment_process_type_invoice_amount": {
+ "type": "number"
+ },
+ "payment_process_type_invoice_custom_unit": {
+ "type": "string"
+ },
+ "payment_process_type_invoice_duration": {
+ "enum": [
+ "day",
+ "week",
+ "month",
+ "year",
+ "day(s)",
+ "week(s)",
+ "month(s)",
+ "year(s)"
+ ],
+ "type": "string"
+ },
+ "payment_process_type_invoice_duration_start": {
+ "enum": [
+ "Customer's receipt of invoice",
+ "date of invoice"
+ ],
+ "type": "string"
+ },
+ "payment_process_type_invoice_type": {
+ "enum": [
+ "monthly",
+ "quarterly",
+ "semiannually",
+ "annually",
+ "Custom unit"
+ ],
+ "type": "string"
+ },
+ "permitted_uses_include_custom": {
+ "type": "boolean"
+ },
+ "permitted_uses_include_custom_description": {
+ "type": "string"
+ },
+ "permitted_uses_include_customers_affiliates": {
+ "type": "boolean"
+ },
+ "permitted_uses_include_internal_business": {
+ "type": "boolean"
+ },
+ "pilot_period_stripe_product_id": {
+ "type": "string"
+ },
+ "software_description": {
+ "type": "string"
+ },
+ "subscription_auto_renew": {
+ "enum": [
+ "days",
+ "subscription_end"
+ ],
+ "type": "string"
+ },
+ "subscription_period": {
+ "type": "number"
+ },
+ "subscription_period_unit": {
+ "type": "string"
+ },
+ "subscription_renewal_notice_days": {
+ "type": "number"
+ },
+ "warranty_period_description_amount": {
+ "type": "number"
+ },
+ "warranty_period_description_duration": {
+ "enum": [
+ "day",
+ "week",
+ "month",
+ "year"
+ ],
+ "type": "string"
+ },
+ "warranty_period_description_duration_start": {
+ "enum": [
+ "initial delivery of the Software",
+ "delivery of the Software and each subsequent Update",
+ "the Order Date"
+ ],
+ "type": "string"
+ },
+ "warranty_period_type": {
+ "enum": [
+ "description",
+ "none"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "test_agreement": {
+ "description": "When true, marks the agreement as a test. Test agreements do not count against your monthly limit.",
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "recipient_name",
+ "recipient_email"
+ ],
+ "type": "object"
+ },
+ "cc_users": {
+ "items": {
+ "format": "email",
+ "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "draft": {
+ "description": "When true, the agreement is saved as a draft and not sent to the recipient. Use POST /v1/agreements/{id}/send to send a draft agreement later.",
+ "type": "boolean"
+ },
+ "owner_email": {
+ "description": "Email address of the agreement owner (sender).",
+ "type": "string"
+ },
+ "signer_id": {
+ "description": "User id of the signer from the owner's organization.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "template_id": {
+ "description": "UUID of a template from `GET /v1/templates`. Accepts both Common Paper standard templates and uploaded PDF templates (`type` `uploaded_template`).",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ }
+ },
+ "required": [
+ "template_id",
+ "owner_email",
+ "signer_id",
+ "agreement"
+ ],
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "agreement": {
+ "additionalProperties": {},
+ "properties": {
+ "amendment_attributes": {
+ "additionalProperties": false,
+ "description": "Override amendment terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "amended_terms_attributes": {
+ "additionalProperties": {
+ "additionalProperties": false,
+ "properties": {
+ "description": {
+ "type": "string"
+ },
+ "term": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "description": "Amended terms. Use string keys such as \"0\", \"1\".",
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+ },
+ "amendment_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "amendment_date_type": {
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "type": "string"
+ },
+ "framework_terms_type": {
+ "type": "string"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "parent_agreement_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "underlying_agreement_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "underlying_agreement_type": {
+ "type": "string"
+ },
+ "underlying_agreement_val": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "baa_attributes": {
+ "additionalProperties": false,
+ "description": "Override baa terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "aggregation_limitations_permitted": {
+ "type": "boolean"
+ },
+ "aggregation_limitations_permitted_val": {
+ "type": "string"
+ },
+ "breach_notification_unit": {
+ "enum": [
+ "hours",
+ "business days",
+ "calendar days"
+ ],
+ "type": "string"
+ },
+ "breach_notification_val": {
+ "type": "number"
+ },
+ "business_associate_relationship_type": {
+ "enum": [
+ "provider",
+ "company"
+ ],
+ "type": "string"
+ },
+ "deidentification_limitations_include_purpose": {
+ "type": "boolean"
+ },
+ "deidentification_limitations_include_requirements": {
+ "type": "boolean"
+ },
+ "deidentification_limitations_permitted": {
+ "type": "boolean"
+ },
+ "deidentification_limitations_purpose_val": {
+ "type": "string"
+ },
+ "deidentification_limitations_requirements_val": {
+ "type": "string"
+ },
+ "designated_record_set_provider_maintains": {
+ "type": "boolean"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_aggregation_limitations": {
+ "type": "boolean"
+ },
+ "include_deidentification_limitations": {
+ "type": "boolean"
+ },
+ "include_limitations": {
+ "type": "boolean"
+ },
+ "include_offshore_limitations": {
+ "type": "boolean"
+ },
+ "include_subcontract_limitations": {
+ "type": "boolean"
+ },
+ "offshore_limitations_permitted": {
+ "type": "boolean"
+ },
+ "offshore_limitations_permitted_val": {
+ "type": "string"
+ },
+ "subcontract_limitations_include_notice": {
+ "type": "boolean"
+ },
+ "subcontract_limitations_include_permission": {
+ "type": "boolean"
+ },
+ "subcontract_limitations_notice_val": {
+ "type": "string"
+ },
+ "subcontract_limitations_permission_val": {
+ "type": "string"
+ },
+ "subcontract_limitations_permitted": {
+ "type": "boolean"
+ },
+ "underlying_agreement_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "underlying_agreement_type": {
+ "enum": [
+ "internal",
+ "external",
+ "none"
+ ],
+ "type": "string"
+ },
+ "underlying_agreement_val": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "billing_email": {
+ "description": "Email of the billing contact. Used when include_billing_info is true.",
+ "format": "email",
+ "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "billing_name": {
+ "description": "Name of the billing contact. Used when include_billing_info is true.",
+ "type": "string"
+ },
+ "billing_workflow_type": {
+ "description": "The type of billing workflow. Use \"link\" to provide a payment_link_url, or \"stripe\" for Stripe-managed billing.",
+ "enum": [
+ "link",
+ "stripe"
+ ],
+ "type": "string"
+ },
+ "chosen_courts_country": {
+ "description": "The country in which disputes will be resolved.",
+ "type": "string"
+ },
+ "chosen_courts_region": {
+ "description": "The state or region in which disputes will be resolved.",
+ "type": "string"
+ },
+ "csa_attributes": {
+ "additionalProperties": false,
+ "description": "Override csa terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "customer_description": {
+ "type": "string"
+ },
+ "effective_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "effective_date_marketplace": {
+ "enum": [
+ "AWS",
+ "GCP",
+ "Azure"
+ ],
+ "type": "string"
+ },
+ "effective_date_type": {
+ "enum": [
+ "signature",
+ "date",
+ "marketplace_acceptance"
+ ],
+ "type": "string"
+ },
+ "general_cap_amount": {
+ "type": "number"
+ },
+ "general_cap_amount_type": {
+ "enum": [
+ "preceding",
+ "base",
+ "period"
+ ],
+ "type": "string"
+ },
+ "general_cap_period_currency": {
+ "type": "number"
+ },
+ "general_cap_period_qty": {
+ "type": "number"
+ },
+ "general_cap_preceding_amount": {
+ "type": "number"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_acceptable_use_policy": {
+ "type": "boolean"
+ },
+ "include_acceptable_use_policy_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_acceptable_use_policy_location": {
+ "type": "string"
+ },
+ "include_acceptable_use_policy_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_additional_warranties": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_by_customer": {
+ "type": "string"
+ },
+ "include_additional_warranties_by_provider": {
+ "type": "string"
+ },
+ "include_additional_warranties_include_by_customer": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_include_by_provider": {
+ "type": "boolean"
+ },
+ "include_ai_addendum": {
+ "type": "boolean"
+ },
+ "include_ai_addendum_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_covered_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_customer_claims": {
+ "type": "string"
+ },
+ "include_covered_claims_include_customer_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_include_provider_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_provider_claims": {
+ "type": "string"
+ },
+ "include_dpa": {
+ "type": "boolean"
+ },
+ "include_dpa_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_dpa_location": {
+ "type": "string"
+ },
+ "include_dpa_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_increased_cap_amount": {
+ "type": "boolean"
+ },
+ "include_increased_claims": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_confidentiality": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_confidentiality_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_privsec": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_privsec_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_other": {
+ "type": "boolean"
+ },
+ "include_increased_claims_indemnification_obligation": {
+ "type": "boolean"
+ },
+ "include_increased_claims_other": {
+ "type": "string"
+ },
+ "include_insurance_minimums": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_add_customer": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_add_customer_com_gen_liability": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_add_customer_cyber_liability": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_add_customer_errors_omissions": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_additional_information": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_additional_information_text": {
+ "type": "string"
+ },
+ "include_insurance_minimums_cyber_liability_aggregate": {
+ "type": "number"
+ },
+ "include_insurance_minimums_cyber_liability_minimum": {
+ "type": "number"
+ },
+ "include_insurance_minimums_employer_liability_aggregate": {
+ "type": "number"
+ },
+ "include_insurance_minimums_employer_liability_minimum": {
+ "type": "number"
+ },
+ "include_insurance_minimums_general_liability_aggregate": {
+ "type": "number"
+ },
+ "include_insurance_minimums_general_liability_minimum": {
+ "type": "number"
+ },
+ "include_insurance_minimums_include_cyber_liability": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_include_employer_liability": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_include_general_liability": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_include_workers_compensation": {
+ "type": "boolean"
+ },
+ "include_publicity_rights": {
+ "type": "boolean"
+ },
+ "include_publicity_rights_type": {
+ "enum": [
+ "public",
+ "non-public"
+ ],
+ "type": "string"
+ },
+ "include_security_policy": {
+ "type": "boolean"
+ },
+ "include_security_policy_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_security_policy_fedramp_auth": {
+ "type": "boolean"
+ },
+ "include_security_policy_hipaa": {
+ "type": "boolean"
+ },
+ "include_security_policy_hitrust": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_annual_maintenance": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_location": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_other": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_reasonable_efforts": {
+ "type": "boolean"
+ },
+ "include_security_policy_iso27001": {
+ "type": "boolean"
+ },
+ "include_security_policy_location": {
+ "type": "string"
+ },
+ "include_security_policy_other": {
+ "type": "string"
+ },
+ "include_security_policy_pci1": {
+ "type": "boolean"
+ },
+ "include_security_policy_pci2": {
+ "type": "boolean"
+ },
+ "include_security_policy_penetration_testing": {
+ "type": "boolean"
+ },
+ "include_security_policy_soc2": {
+ "type": "boolean"
+ },
+ "include_security_policy_soc2_type2": {
+ "type": "boolean"
+ },
+ "include_security_policy_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_supercap": {
+ "description": "CSA 3.0 renamed `include_increased_cap_amount` to `include_supercap`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_increased_cap_amount`. Sending the other spelling returns a 422.",
+ "type": "boolean"
+ },
+ "include_uncapped_claims": {
+ "description": "CSA 3.0 renamed `include_unlimited_claims` to `include_uncapped_claims`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims`. Sending the other spelling returns a 422.",
+ "type": "boolean"
+ },
+ "include_uncapped_claims_breach_of_confidentiality": {
+ "description": "CSA 3.0 renamed `include_unlimited_claims_breach_of_confidentiality` to `include_uncapped_claims_breach_of_confidentiality`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_breach_of_confidentiality`. Sending the other spelling returns a 422.",
+ "type": "boolean"
+ },
+ "include_uncapped_claims_breach_of_confidentiality_negligence": {
+ "description": "CSA 3.0 renamed `include_unlimited_claims_breach_of_confidentiality_negligence` to `include_uncapped_claims_breach_of_confidentiality_negligence`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_breach_of_confidentiality_negligence`. Sending the other spelling returns a 422.",
+ "type": "boolean"
+ },
+ "include_uncapped_claims_breach_of_privsec": {
+ "description": "CSA 3.0 renamed `include_unlimited_claims_breach_of_privsec` to `include_uncapped_claims_breach_of_privsec`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_breach_of_privsec`. Sending the other spelling returns a 422.",
+ "type": "boolean"
+ },
+ "include_uncapped_claims_breach_of_privsec_negligence": {
+ "description": "CSA 3.0 renamed `include_unlimited_claims_breach_of_privsec_negligence` to `include_uncapped_claims_breach_of_privsec_negligence`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_breach_of_privsec_negligence`. Sending the other spelling returns a 422.",
+ "type": "boolean"
+ },
+ "include_uncapped_claims_include_other": {
+ "description": "CSA 3.0 renamed `include_unlimited_claims_include_other` to `include_uncapped_claims_include_other`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_include_other`. Sending the other spelling returns a 422.",
+ "type": "boolean"
+ },
+ "include_uncapped_claims_indemnification_obligation": {
+ "description": "CSA 3.0 renamed `include_unlimited_claims_indemnification_obligation` to `include_uncapped_claims_indemnification_obligation`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_indemnification_obligation`. Sending the other spelling returns a 422.",
+ "type": "boolean"
+ },
+ "include_uncapped_claims_other": {
+ "description": "CSA 3.0 renamed `include_unlimited_claims_other` to `include_uncapped_claims_other`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_other`. Sending the other spelling returns a 422.",
+ "type": "boolean"
+ },
+ "include_unlimited_claims": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_confidentiality": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_confidentiality_negligence": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_privsec": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_privsec_negligence": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_include_other": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_indemnification_obligation": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_other": {
+ "type": "string"
+ },
+ "increased_cap_amount_currency": {
+ "type": "number"
+ },
+ "increased_cap_amount_period_currency": {
+ "type": "number"
+ },
+ "increased_cap_amount_period_qty": {
+ "type": "number"
+ },
+ "increased_cap_amount_qty": {
+ "type": "number"
+ },
+ "increased_cap_amount_type": {
+ "enum": [
+ "qty",
+ "currency",
+ "period"
+ ],
+ "type": "string"
+ },
+ "provider": {
+ "type": "string"
+ },
+ "supercap_currency": {
+ "description": "CSA 3.0 renamed `increased_cap_amount_currency` to `supercap_currency`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `increased_cap_amount_currency`. Sending the other spelling returns a 422.",
+ "type": "number"
+ },
+ "supercap_period_currency": {
+ "description": "CSA 3.0 renamed `increased_cap_amount_period_currency` to `supercap_period_currency`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `increased_cap_amount_period_currency`. Sending the other spelling returns a 422.",
+ "type": "number"
+ },
+ "supercap_period_qty": {
+ "description": "CSA 3.0 renamed `increased_cap_amount_period_qty` to `supercap_period_qty`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `increased_cap_amount_period_qty`. Sending the other spelling returns a 422.",
+ "type": "number"
+ },
+ "supercap_qty": {
+ "description": "CSA 3.0 renamed `increased_cap_amount_qty` to `supercap_qty`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `increased_cap_amount_qty`. Sending the other spelling returns a 422.",
+ "type": "number"
+ },
+ "supercap_type": {
+ "description": "CSA 3.0 renamed `increased_cap_amount_type` to `supercap_type`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `increased_cap_amount_type`. Sending the other spelling returns a 422.",
+ "type": "number"
+ }
+ },
+ "type": "object"
+ },
+ "csa_order_form_attributes": {
+ "additionalProperties": false,
+ "description": "Override csa order form terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "additional_changes": {
+ "type": "string"
+ },
+ "additional_parameters_or_limitations": {
+ "type": "string"
+ },
+ "affiliates_as_users": {
+ "type": "boolean"
+ },
+ "cloud_service_description": {
+ "type": "string"
+ },
+ "consumption_units": {
+ "type": "string"
+ },
+ "fee_amount": {
+ "type": "number"
+ },
+ "fee_custom_unit": {
+ "type": "string"
+ },
+ "fee_period": {
+ "enum": [
+ "Subscription Period",
+ "month",
+ "year",
+ "User",
+ "Custom unit"
+ ],
+ "type": "string"
+ },
+ "fees_attributes": {
+ "additionalProperties": {
+ "anyOf": [
+ {
+ "additionalProperties": false,
+ "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": {
+ "enum": [
+ "USD",
+ "EUR",
+ "GBP",
+ "CAD",
+ "AUD",
+ "SGD",
+ "ILS",
+ "JPY",
+ "CHF",
+ "HKD"
+ ],
+ "type": "string"
+ },
+ "fees_include_fee_increase_upon_renewal": {
+ "type": "boolean"
+ },
+ "fees_include_fee_increase_upon_renewal_fee": {
+ "type": "number"
+ },
+ "fees_include_fee_increase_upon_renewal_type": {
+ "enum": [
+ "will",
+ "may"
+ ],
+ "type": "string"
+ },
+ "fees_inclusive_of_taxes": {
+ "type": "boolean"
+ },
+ "framework_terms_type": {
+ "enum": [
+ "new",
+ "existing",
+ "description"
+ ],
+ "type": "string"
+ },
+ "free_trial_days": {
+ "type": "number"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_additional_changes": {
+ "type": "boolean"
+ },
+ "include_additional_parameters_or_limitations": {
+ "type": "boolean"
+ },
+ "include_consumption": {
+ "type": "boolean"
+ },
+ "include_fees": {
+ "type": "boolean"
+ },
+ "include_fees_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_fees_include_attachment": {
+ "type": "boolean"
+ },
+ "include_fees_other": {
+ "type": "boolean"
+ },
+ "include_fees_other_val": {
+ "type": "string"
+ },
+ "include_fees_table": {
+ "type": "boolean"
+ },
+ "include_fees_table_period": {
+ "enum": [
+ "Subscription Period",
+ "month",
+ "year",
+ "User"
+ ],
+ "type": "string"
+ },
+ "include_free_trial": {
+ "type": "boolean"
+ },
+ "include_max_users": {
+ "type": "boolean"
+ },
+ "include_pilot_period": {
+ "type": "boolean"
+ },
+ "include_pilot_period_duration_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_pilot_period_duration_type": {
+ "enum": [
+ "day",
+ "week",
+ "month"
+ ],
+ "type": "string"
+ },
+ "include_pilot_period_include_fees": {
+ "type": "boolean"
+ },
+ "include_pilot_period_include_fees_amount": {
+ "type": "number"
+ },
+ "include_pilot_period_include_modifications": {
+ "type": "boolean"
+ },
+ "include_pilot_period_include_modifications_description": {
+ "type": "string"
+ },
+ "include_product_support": {
+ "type": "boolean"
+ },
+ "include_product_support_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_product_support_description": {
+ "type": "string"
+ },
+ "include_product_support_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_professional_services": {
+ "type": "boolean"
+ },
+ "include_professional_services_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_professional_services_custom_name": {
+ "type": "string"
+ },
+ "include_professional_services_description": {
+ "type": "string"
+ },
+ "include_professional_services_end_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "include_professional_services_fees_description": {
+ "type": "string"
+ },
+ "include_professional_services_include_end_date": {
+ "type": "boolean"
+ },
+ "include_professional_services_include_fees_description": {
+ "type": "boolean"
+ },
+ "include_professional_services_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_sla": {
+ "type": "boolean"
+ },
+ "include_sla_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_sla_description": {
+ "type": "string"
+ },
+ "include_sla_include_response_time": {
+ "type": "boolean"
+ },
+ "include_sla_include_response_time_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_sla_include_response_time_credit": {
+ "type": "number"
+ },
+ "include_sla_include_response_time_duration": {
+ "enum": [
+ "hour",
+ "day",
+ "week",
+ "month",
+ "hours"
+ ],
+ "type": "string"
+ },
+ "include_sla_include_response_time_support_channel": {
+ "type": "string"
+ },
+ "include_sla_include_target_uptime": {
+ "type": "boolean"
+ },
+ "include_sla_maintenance_notice": {
+ "type": "boolean"
+ },
+ "include_sla_maintenance_window": {
+ "type": "boolean"
+ },
+ "include_sla_maintenance_window_type": {
+ "enum": [
+ "standard",
+ "none"
+ ],
+ "type": "string"
+ },
+ "include_sla_standard_maintenance_notice_qty": {
+ "type": "number"
+ },
+ "include_sla_standard_maintenance_notice_unit": {
+ "enum": [
+ "hour",
+ "day",
+ "week",
+ "month"
+ ],
+ "type": "string"
+ },
+ "include_sla_standard_maintenance_window_end_time": {
+ "type": "string"
+ },
+ "include_sla_standard_maintenance_window_friday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_monday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_saturday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_start_time": {
+ "type": "string"
+ },
+ "include_sla_standard_maintenance_window_sunday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_thursday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_time_zone": {
+ "type": "string"
+ },
+ "include_sla_standard_maintenance_window_tuesday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_wednesday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_target_uptime": {
+ "type": "number"
+ },
+ "include_sla_type": {
+ "enum": [
+ "description",
+ "standard",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_subscription_start_date": {
+ "type": "boolean"
+ },
+ "include_subscription_start_date_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "include_usage_review": {
+ "type": "boolean"
+ },
+ "include_usage_review_val": {
+ "type": "string"
+ },
+ "include_use_limitations": {
+ "type": "boolean"
+ },
+ "include_use_limitations_val": {
+ "type": "string"
+ },
+ "invoice_period": {
+ "enum": [
+ "monthly",
+ "quarterly",
+ "semiannually",
+ "annually",
+ "Custom unit",
+ "Monthly",
+ "Quarterly",
+ "Semiannually",
+ "Annually"
+ ],
+ "type": "string"
+ },
+ "invoice_period_custom_unit": {
+ "type": "string"
+ },
+ "max_consumption": {
+ "type": "number"
+ },
+ "max_users": {
+ "type": "number"
+ },
+ "negotiations_allowed": {
+ "description": "When true, the recipient can propose changes to the order form, even when the agreement-level `negotiations_allowed` is false. This only covers the order form.",
+ "type": "boolean"
+ },
+ "order_date_date": {
+ "type": "string"
+ },
+ "order_date_other": {
+ "type": "string"
+ },
+ "order_date_type": {
+ "enum": [
+ "signature",
+ "date",
+ "other"
+ ],
+ "type": "string"
+ },
+ "payment_period": {
+ "type": "number"
+ },
+ "payment_period_timeframe": {
+ "enum": [
+ "Customer's receipt of invoice",
+ "date of invoice"
+ ],
+ "type": "string"
+ },
+ "payment_period_unit": {
+ "enum": [
+ "day(s)",
+ "week(s)",
+ "month(s)",
+ "marketplace_acceptance"
+ ],
+ "type": "string"
+ },
+ "payment_process_automatic_frequency": {
+ "enum": [
+ "monthly",
+ "quarterly",
+ "semiannually",
+ "annually"
+ ],
+ "type": "string"
+ },
+ "payment_process_type": {
+ "enum": [
+ "automatic",
+ "invoice",
+ "custom",
+ "marketplace_acceptance"
+ ],
+ "type": "string"
+ },
+ "payment_process_type_custom_val": {
+ "type": "string"
+ },
+ "payment_process_type_invoice_amount": {
+ "type": "number"
+ },
+ "payment_process_type_invoice_custom_unit": {
+ "type": "string"
+ },
+ "payment_process_type_invoice_duration": {
+ "enum": [
+ "day",
+ "week",
+ "month",
+ "year",
+ "day(s)",
+ "week(s)",
+ "month(s)",
+ "year(s)"
+ ],
+ "type": "string"
+ },
+ "payment_process_type_invoice_duration_start": {
+ "enum": [
+ "Customer's receipt of invoice",
+ "date of invoice"
+ ],
+ "type": "string"
+ },
+ "payment_process_type_invoice_type": {
+ "enum": [
+ "monthly",
+ "quarterly",
+ "semiannually",
+ "annually",
+ "Custom unit"
+ ],
+ "type": "string"
+ },
+ "pilot_period_stripe_product_id": {
+ "type": "string"
+ },
+ "service_credits_attributes": {
+ "additionalProperties": {
+ "additionalProperties": false,
+ "properties": {
+ "credit": {
+ "type": "number"
+ },
+ "max": {
+ "type": "number"
+ },
+ "min": {
+ "type": "number"
+ }
+ },
+ "type": "object"
+ },
+ "description": "Service credits. Use string keys such as \"0\", \"1\".",
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+ },
+ "subscription_auto_renew": {
+ "enum": [
+ "days",
+ "subscription_end"
+ ],
+ "type": "string"
+ },
+ "subscription_period": {
+ "type": "number"
+ },
+ "subscription_period_unit": {
+ "type": "string"
+ },
+ "subscription_renewal_notice_days": {
+ "type": "number"
+ },
+ "subscription_start_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "subscription_start_date_type": {
+ "enum": [
+ "effective_date",
+ "date"
+ ],
+ "type": "string"
+ },
+ "underlying_agreement_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "use_limitations_attributes": {
+ "additionalProperties": {
+ "additionalProperties": false,
+ "properties": {
+ "amount": {
+ "type": "number"
+ },
+ "limitation_type": {
+ "type": "string"
+ },
+ "unit": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "description": "Use limitations. Use string keys such as \"0\", \"1\".",
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+ }
+ },
+ "type": "object"
+ },
+ "custom_field_values": {
+ "description": "Values for a custom template's fields, keyed by the field keys defined in the template's YAML definition. Only used when template_id is a custom template. Template defaults fill any fields you omit; a required field with no default and no submitted value returns a 400 naming the field. Values are validated against the field's input type: select and radio values must be one of the field's options, multiselect values are an array of selections each of which must be one of the field's options, number and currency values must be numeric, date values must be YYYY-MM-DD, and email values must be valid addresses. An invalid value returns a 400 naming the field."
+ },
+ "design_partner_attributes": {
+ "additionalProperties": false,
+ "description": "Override design partner terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "customer_description": {
+ "type": "string"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_fees": {
+ "type": "boolean"
+ },
+ "include_fees_amount": {
+ "type": "number"
+ },
+ "include_fees_description": {
+ "type": "string"
+ },
+ "include_fees_pay_by_amount": {
+ "type": "string"
+ },
+ "include_fees_type": {
+ "enum": [
+ "default_language",
+ "description"
+ ],
+ "type": "string"
+ },
+ "include_fees_unit": {
+ "enum": [
+ "month",
+ "quarter",
+ "year",
+ "Term"
+ ],
+ "type": "string"
+ },
+ "include_program_appear_as_customer_private": {
+ "type": "boolean"
+ },
+ "include_program_appear_as_customer_public": {
+ "type": "boolean"
+ },
+ "include_program_case_study": {
+ "type": "boolean"
+ },
+ "include_program_develop_functionality": {
+ "type": "boolean"
+ },
+ "include_program_develop_functionality_val": {
+ "type": "string"
+ },
+ "include_program_discount": {
+ "type": "boolean"
+ },
+ "include_program_discount_amount": {
+ "type": "number"
+ },
+ "include_program_discount_unit": {
+ "enum": [
+ "U.S. Dollars",
+ "percent"
+ ],
+ "type": "string"
+ },
+ "include_program_participation_feedback": {
+ "type": "boolean"
+ },
+ "include_program_participation_feedback_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_program_participation_feedback_unit": {
+ "enum": [
+ "month",
+ "quarter",
+ "year",
+ "Term"
+ ],
+ "type": "string"
+ },
+ "include_program_partner_other": {
+ "type": "boolean"
+ },
+ "include_program_partner_other_val": {
+ "type": "string"
+ },
+ "include_program_provider_other": {
+ "type": "boolean"
+ },
+ "include_program_provider_other_val": {
+ "type": "string"
+ },
+ "include_program_reference": {
+ "type": "boolean"
+ },
+ "product_description": {
+ "type": "string"
+ },
+ "term_amount": {
+ "type": "number"
+ },
+ "term_unit": {
+ "enum": [
+ "day(s)",
+ "week(s)",
+ "month(s)",
+ "quarter(s)",
+ "year(s)"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "district_or_county": {
+ "description": "The district or county for dispute resolution.",
+ "type": "string"
+ },
+ "dpa_attributes": {
+ "additionalProperties": false,
+ "description": "Override dpa terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "approved_subprocessor_type": {
+ "description": "`internal` lists approved subprocessors in the agreement (`subprocessors_attributes`); `external` points to a list published elsewhere.",
+ "enum": [
+ "internal",
+ "external"
+ ],
+ "type": "string"
+ },
+ "cloud_service_product_name": {
+ "type": "string"
+ },
+ "competent_supervisory_authority": {
+ "type": "string"
+ },
+ "customer_description": {
+ "type": "string"
+ },
+ "data_exporter_address_city": {
+ "type": "string"
+ },
+ "data_exporter_address_country": {
+ "type": "string"
+ },
+ "data_exporter_address_state": {
+ "type": "string"
+ },
+ "data_exporter_address_street_address": {
+ "type": "string"
+ },
+ "data_exporter_address_zipcode": {
+ "type": "string"
+ },
+ "data_exporter_contact_details": {
+ "type": "string"
+ },
+ "data_exporter_contact_name": {
+ "type": "string"
+ },
+ "data_exporter_contact_position": {
+ "type": "string"
+ },
+ "data_exporter_role": {
+ "description": "Role of the data exporter. Overwritten to `Controller` when the agreement is created from a template.",
+ "enum": [
+ "Controller",
+ "Processor"
+ ],
+ "type": "string"
+ },
+ "data_importer_address": {
+ "type": "string"
+ },
+ "data_importer_address_city": {
+ "type": "string"
+ },
+ "data_importer_address_country": {
+ "type": "string"
+ },
+ "data_importer_address_state": {
+ "type": "string"
+ },
+ "data_importer_address_street_address": {
+ "type": "string"
+ },
+ "data_importer_address_zipcode": {
+ "type": "string"
+ },
+ "data_importer_contact_details": {
+ "type": "string"
+ },
+ "data_importer_contact_name": {
+ "type": "string"
+ },
+ "data_importer_contact_position": {
+ "type": "string"
+ },
+ "duration_of_processing": {
+ "type": "string"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_covered_claim": {
+ "type": "boolean"
+ },
+ "include_covered_claim_external_val": {
+ "type": "string"
+ },
+ "include_covered_claim_internal_val": {
+ "type": "string"
+ },
+ "include_covered_claim_type": {
+ "description": "Which covered-claim text applies: `internal` uses `include_covered_claim_internal_val`, `external` uses `include_covered_claim_external_val`. Required when `include_covered_claim` is true.",
+ "enum": [
+ "internal",
+ "external"
+ ],
+ "type": "string"
+ },
+ "include_data_subjects_custom": {
+ "type": "boolean"
+ },
+ "include_data_subjects_custom_val": {
+ "type": "string"
+ },
+ "include_data_subjects_employees": {
+ "type": "boolean"
+ },
+ "include_data_subjects_end_users": {
+ "type": "boolean"
+ },
+ "include_external_subprocessor_location": {
+ "type": "string"
+ },
+ "include_frequency_of_transfer_continuous": {
+ "type": "boolean"
+ },
+ "include_frequency_of_transfer_custom": {
+ "type": "boolean"
+ },
+ "include_frequency_of_transfer_custom_val": {
+ "type": "string"
+ },
+ "include_governing_country_eu": {
+ "type": "boolean"
+ },
+ "include_governing_country_eu_val": {
+ "type": "string"
+ },
+ "include_governing_country_uk": {
+ "type": "boolean"
+ },
+ "include_governing_country_uk_val": {
+ "type": "string"
+ },
+ "include_governing_law": {
+ "type": "boolean"
+ },
+ "include_governing_law_country": {
+ "type": "string"
+ },
+ "include_governing_law_state": {
+ "type": "string"
+ },
+ "include_increased_claim_amount": {
+ "description": "Legacy field. Stored but not shown on the DPA; use the `include_liability_cap*` fields instead.",
+ "type": "boolean"
+ },
+ "include_increased_claim_amount_currency": {
+ "description": "Legacy field. Stored but not shown on the DPA; use the `include_liability_cap*` fields instead."
+ },
+ "include_increased_claim_amount_qty": {
+ "description": "Legacy field. Stored but not shown on the DPA; use the `include_liability_cap*` fields instead."
+ },
+ "include_increased_claim_amount_type": {
+ "description": "Legacy field. Stored but not shown on the DPA; use the `include_liability_cap*` fields instead.",
+ "type": "string"
+ },
+ "include_liability_cap": {
+ "type": "boolean"
+ },
+ "include_liability_cap_amount_constant_external": {
+ "type": "string"
+ },
+ "include_liability_cap_amount_constant_internal": {
+ "type": "string"
+ },
+ "include_liability_cap_amount_currency_external": {
+ "description": "Currency amount. Numbers and numeric strings (commas allowed) are both accepted."
+ },
+ "include_liability_cap_amount_currency_internal": {
+ "description": "Currency amount. Numbers and numeric strings (commas allowed) are both accepted."
+ },
+ "include_liability_cap_csa_type": {
+ "description": "Which liability cap values apply: the `_internal` or `_external` amount fields. Required when `include_liability_cap` is true.",
+ "enum": [
+ "internal",
+ "external"
+ ],
+ "type": "string"
+ },
+ "include_personal_data_biographic_info": {
+ "type": "boolean"
+ },
+ "include_personal_data_contact_info": {
+ "type": "boolean"
+ },
+ "include_personal_data_custom": {
+ "type": "boolean"
+ },
+ "include_personal_data_custom_val": {
+ "type": "string"
+ },
+ "include_personal_data_employment_info": {
+ "type": "boolean"
+ },
+ "include_personal_data_financial_info": {
+ "type": "boolean"
+ },
+ "include_personal_data_location": {
+ "type": "boolean"
+ },
+ "include_personal_data_name": {
+ "type": "boolean"
+ },
+ "include_personal_data_transactional_info": {
+ "type": "boolean"
+ },
+ "include_personal_data_user_activity_info": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_custom": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_custom_val": {
+ "type": "string"
+ },
+ "include_processing_purpose_erasing": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_holding": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_protecting": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_receiving": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_returning": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_sharing": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_updating": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_using": {
+ "type": "boolean"
+ },
+ "include_provider_security_contact_address": {
+ "type": "boolean"
+ },
+ "include_provider_security_contact_address_city": {
+ "type": "string"
+ },
+ "include_provider_security_contact_address_country": {
+ "type": "string"
+ },
+ "include_provider_security_contact_address_state": {
+ "type": "string"
+ },
+ "include_provider_security_contact_address_street_address": {
+ "type": "string"
+ },
+ "include_provider_security_contact_address_zipcode": {
+ "type": "string"
+ },
+ "include_provider_security_contact_email": {
+ "type": "boolean"
+ },
+ "include_provider_security_contact_email_val": {
+ "format": "email",
+ "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "include_security_measures_accountability": {
+ "type": "boolean"
+ },
+ "include_security_measures_accountability_val": {
+ "type": "string"
+ },
+ "include_security_measures_certification_or_assurance": {
+ "type": "boolean"
+ },
+ "include_security_measures_certification_or_assurance_val": {
+ "type": "string"
+ },
+ "include_security_measures_confidentiality_integrity": {
+ "type": "boolean"
+ },
+ "include_security_measures_confidentiality_integrity_val": {
+ "type": "string"
+ },
+ "include_security_measures_data_at_rest": {
+ "type": "boolean"
+ },
+ "include_security_measures_data_at_rest_val": {
+ "type": "string"
+ },
+ "include_security_measures_data_minimization": {
+ "type": "boolean"
+ },
+ "include_security_measures_data_minimization_val": {
+ "type": "string"
+ },
+ "include_security_measures_data_quality": {
+ "type": "boolean"
+ },
+ "include_security_measures_data_quality_val": {
+ "type": "string"
+ },
+ "include_security_measures_data_retention": {
+ "type": "boolean"
+ },
+ "include_security_measures_data_retention_val": {
+ "type": "string"
+ },
+ "include_security_measures_data_transmission": {
+ "type": "boolean"
+ },
+ "include_security_measures_data_transmission_val": {
+ "type": "string"
+ },
+ "include_security_measures_event_logging": {
+ "type": "boolean"
+ },
+ "include_security_measures_event_logging_val": {
+ "type": "string"
+ },
+ "include_security_measures_identity_auth": {
+ "type": "boolean"
+ },
+ "include_security_measures_identity_auth_val": {
+ "type": "string"
+ },
+ "include_security_measures_it_security_governance": {
+ "type": "boolean"
+ },
+ "include_security_measures_it_security_governance_val": {
+ "type": "string"
+ },
+ "include_security_measures_physical_security": {
+ "type": "boolean"
+ },
+ "include_security_measures_physical_security_val": {
+ "type": "string"
+ },
+ "include_security_measures_portability_and_erasure": {
+ "type": "boolean"
+ },
+ "include_security_measures_portability_and_erasure_val": {
+ "type": "string"
+ },
+ "include_security_measures_pseudonym_encryption": {
+ "type": "boolean"
+ },
+ "include_security_measures_pseudonym_encryption_val": {
+ "type": "string"
+ },
+ "include_security_measures_restore_data_access": {
+ "type": "boolean"
+ },
+ "include_security_measures_restore_data_access_val": {
+ "type": "string"
+ },
+ "include_security_measures_security_policy": {
+ "type": "boolean"
+ },
+ "include_security_measures_system_configuration": {
+ "type": "boolean"
+ },
+ "include_security_measures_system_configuration_val": {
+ "type": "string"
+ },
+ "include_security_measures_testing_assessment": {
+ "type": "boolean"
+ },
+ "include_security_measures_testing_assessment_val": {
+ "type": "string"
+ },
+ "include_security_policy": {
+ "type": "boolean"
+ },
+ "include_security_policy_fedramp_auth": {
+ "type": "boolean"
+ },
+ "include_security_policy_hipaa": {
+ "type": "boolean"
+ },
+ "include_security_policy_hitrust": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_other": {
+ "type": "boolean"
+ },
+ "include_security_policy_iso27001": {
+ "type": "boolean"
+ },
+ "include_security_policy_other": {
+ "type": "string"
+ },
+ "include_security_policy_pci1": {
+ "type": "boolean"
+ },
+ "include_security_policy_pci2": {
+ "type": "boolean"
+ },
+ "include_security_policy_penetration_testing": {
+ "type": "boolean"
+ },
+ "include_security_policy_soc2": {
+ "type": "boolean"
+ },
+ "include_security_policy_soc2_type2": {
+ "type": "boolean"
+ },
+ "include_sensitive_data_restrictions_custom": {
+ "type": "boolean"
+ },
+ "include_sensitive_data_restrictions_custom_val": {
+ "type": "string"
+ },
+ "include_sensitive_data_restrictions_security_policy": {
+ "type": "boolean"
+ },
+ "include_service_provider_relationship": {
+ "type": "boolean"
+ },
+ "include_special_category_data": {
+ "type": "boolean"
+ },
+ "provider": {
+ "type": "string"
+ },
+ "security_policy_available_at": {
+ "type": "string"
+ },
+ "security_policy_type": {
+ "description": "Where the Security Policy is defined. For `external`, set `security_policy_available_at`.",
+ "enum": [
+ "defined in agreement",
+ "provider service",
+ "external"
+ ],
+ "type": "string"
+ },
+ "subprocessors_attributes": {
+ "additionalProperties": {
+ "additionalProperties": false,
+ "properties": {
+ "_destroy": {
+ "description": "Set to true with `id` to remove that subprocessor.",
+ "type": "boolean"
+ },
+ "country": {
+ "type": "string"
+ },
+ "id": {
+ "description": "ID of an existing subprocessor to update or remove. Omit to add a new subprocessor.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "processing_task": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "description": "Subprocessors, keyed by string index such as \"0\", \"1\". On create these are added to the template's subprocessors. On a draft update, an entry without `id` adds a new subprocessor; pass `id` to change one and `id` with `_destroy: true` to remove one.",
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+ },
+ "underlying_agreement_id": {
+ "description": "ID of the CSA this DPA supplements when `underlying_agreement_type` is `internal`.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "underlying_agreement_type": {
+ "description": "`internal` links a CSA in Common Paper (`underlying_agreement_id`); `external` describes another agreement in `underlying_agreement_val` (required). Omit for none.",
+ "enum": [
+ "internal",
+ "external"
+ ],
+ "type": "string"
+ },
+ "underlying_agreement_val": {
+ "description": "Description of the agreement this DPA supplements. Required when `underlying_agreement_type` is `external`.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "framework_terms_description": {
+ "description": "Custom framework terms description. Only used when framework_terms_type is \"description\".",
+ "type": "string"
+ },
+ "framework_terms_type": {
+ "description": "How framework terms are specified. Use \"new\" for standard terms or \"description\" to provide a custom framework_terms_description.",
+ "enum": [
+ "new",
+ "description"
+ ],
+ "type": "string"
+ },
+ "governing_law_country": {
+ "description": "The country whose laws govern the agreement.",
+ "type": "string"
+ },
+ "governing_law_region": {
+ "description": "The state or region whose laws govern the agreement.",
+ "type": "string"
+ },
+ "include_automated_payment_reminders": {
+ "description": "When true, automatically sends payment reminder emails.",
+ "type": "boolean"
+ },
+ "include_billing_info": {
+ "description": "When true, billing contact information (billing_name, billing_email) is included.",
+ "type": "boolean"
+ },
+ "include_billing_workflow": {
+ "description": "When true, enables a billing workflow after signing.",
+ "type": "boolean"
+ },
+ "include_expiration_date": {
+ "description": "Expiration date in YYYY-MM-DD format. Use when include_expiration_type is \"date\".",
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "include_expiration_days": {
+ "description": "Number of days until the agreement expires. Use when include_expiration_type is \"days\".",
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_expiration_type": {
+ "description": "How to set expiration: \"none\" (default), \"days\" (use include_expiration_days), or \"date\" (use include_expiration_date).",
+ "enum": [
+ "none",
+ "days",
+ "date"
+ ],
+ "type": "string"
+ },
+ "include_terms": {
+ "description": "When true, the standard terms are included with the agreement.",
+ "type": "boolean"
+ },
+ "loi_attributes": {
+ "additionalProperties": false,
+ "description": "Override loi terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "confidentiality_custom": {
+ "type": "string"
+ },
+ "confidentiality_mutual_include_loi": {
+ "type": "boolean"
+ },
+ "confidentiality_nda_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "confidentiality_nda_description": {
+ "type": "string"
+ },
+ "confidentiality_nda_include_loi": {
+ "type": "boolean"
+ },
+ "confidentiality_nda_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "confidentiality_type": {
+ "enum": [
+ "mutual",
+ "nda",
+ "provider",
+ "custom"
+ ],
+ "type": "string"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_custom_details": {
+ "type": "boolean"
+ },
+ "include_custom_details_val": {
+ "type": "string"
+ },
+ "include_fees": {
+ "type": "boolean"
+ },
+ "include_fees_amount": {
+ "type": "number"
+ },
+ "include_fees_amount_duration": {
+ "enum": [
+ "month",
+ "year",
+ "quarter"
+ ],
+ "type": "string"
+ },
+ "include_fees_include_amount": {
+ "type": "boolean"
+ },
+ "include_fees_include_other": {
+ "type": "boolean"
+ },
+ "include_fees_other": {
+ "type": "string"
+ },
+ "include_functionality": {
+ "type": "boolean"
+ },
+ "include_functionality_val": {
+ "type": "string"
+ },
+ "include_launch_date": {
+ "type": "boolean"
+ },
+ "include_launch_date_custom": {
+ "type": "string"
+ },
+ "include_launch_date_date": {
+ "format": "date-time",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$",
+ "type": "string"
+ },
+ "include_launch_date_type": {
+ "enum": [
+ "date",
+ "custom"
+ ],
+ "type": "string"
+ },
+ "product_name": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "manual_send": {
+ "description": "When true, the agreement is marked as manually sent outside the platform.",
+ "type": "boolean"
+ },
+ "message": {
+ "type": "string"
+ },
+ "negotiations_allowed": {
+ "description": "When true, the recipient can propose changes to the legal terms. For agreement types without separate business terms, that covers every term. CSA order forms, PSA statements of work, partnership business terms and software license order forms have their own `negotiations_allowed` flag.",
+ "type": "boolean"
+ },
+ "partnership_attributes": {
+ "additionalProperties": false,
+ "description": "Override partnership terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "effective_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "effective_date_type": {
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "type": "string"
+ },
+ "general_cap_amount_currency_val": {
+ "type": "number"
+ },
+ "general_cap_amount_either_currency": {
+ "type": "number"
+ },
+ "general_cap_amount_either_multiple": {
+ "type": "number"
+ },
+ "general_cap_amount_multiple_val": {
+ "type": "number"
+ },
+ "general_cap_amount_type": {
+ "enum": [
+ "multiple",
+ "currency",
+ "either",
+ "base"
+ ],
+ "type": "string"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_additional_warranties": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_include_company": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_include_company_val": {
+ "type": "string"
+ },
+ "include_additional_warranties_include_partner": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_include_partner_val": {
+ "type": "string"
+ },
+ "include_brand_guidelines": {
+ "type": "boolean"
+ },
+ "include_brand_guidelines_include_company": {
+ "type": "boolean"
+ },
+ "include_brand_guidelines_include_company_val": {
+ "type": "string"
+ },
+ "include_brand_guidelines_include_partner": {
+ "type": "boolean"
+ },
+ "include_brand_guidelines_include_partner_val": {
+ "type": "string"
+ },
+ "include_covered_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_company_claims": {
+ "type": "string"
+ },
+ "include_covered_claims_include_company_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_include_partner_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_partner_claims": {
+ "type": "string"
+ },
+ "include_dpa": {
+ "type": "boolean"
+ },
+ "include_dpa_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_dpa_location": {
+ "type": "string"
+ },
+ "include_dpa_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_increased_cap_amount": {
+ "type": "boolean"
+ },
+ "include_increased_cap_amount_currency": {
+ "type": "number"
+ },
+ "include_increased_cap_amount_either_currency": {
+ "type": "number"
+ },
+ "include_increased_cap_amount_either_multiple": {
+ "type": "string"
+ },
+ "include_increased_cap_amount_multiple": {
+ "type": "string"
+ },
+ "include_increased_cap_amount_type": {
+ "enum": [
+ "multiple",
+ "currency",
+ "either"
+ ],
+ "type": "string"
+ },
+ "include_increased_claims": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_confidentiality": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_confidentiality_misconduct": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_covered_claims": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_misconduct": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_other": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_other_val": {
+ "type": "string"
+ },
+ "include_unlimited_claims": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_confidentiality": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_confidentiality_misconduct": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_covered_claims": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_misconduct": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_other": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_other_val": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "partnership_business_terms_attributes": {
+ "additionalProperties": false,
+ "description": "Override partnership business terms terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "end_date_after_effective_date_amount": {
+ "type": "number"
+ },
+ "end_date_after_effective_date_unit": {
+ "enum": [
+ "month(s)",
+ "quarter(s)",
+ "year(s)"
+ ],
+ "type": "string"
+ },
+ "end_date_date": {
+ "type": "string"
+ },
+ "end_date_type": {
+ "enum": [
+ "date",
+ "effective date"
+ ],
+ "type": "string"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_obligations_company_brand": {
+ "type": "boolean"
+ },
+ "include_obligations_company_promotion": {
+ "type": "boolean"
+ },
+ "include_obligations_company_promotion_include_activities": {
+ "type": "boolean"
+ },
+ "include_obligations_company_promotion_include_activities_val": {
+ "type": "string"
+ },
+ "include_obligations_company_promotion_include_materials": {
+ "type": "boolean"
+ },
+ "include_obligations_company_promotion_include_materials_val": {
+ "type": "string"
+ },
+ "include_obligations_company_referral": {
+ "type": "boolean"
+ },
+ "include_obligations_company_referral_include_criteria": {
+ "type": "boolean"
+ },
+ "include_obligations_company_referral_include_criteria_val": {
+ "type": "string"
+ },
+ "include_obligations_company_referral_include_pay_sch": {
+ "type": "boolean"
+ },
+ "include_obligations_company_referral_include_pay_sch_amount": {
+ "type": "number"
+ },
+ "include_obligations_company_referral_include_pay_sch_custom": {
+ "type": "string"
+ },
+ "include_obligations_company_referral_include_pay_sch_unit": {
+ "enum": [
+ "U.S. Dollars",
+ "percent"
+ ],
+ "type": "string"
+ },
+ "include_obligations_company_sponsorship": {
+ "type": "boolean"
+ },
+ "include_obligations_company_sponsorship_include_benefits": {
+ "type": "boolean"
+ },
+ "include_obligations_company_sponsorship_include_benefits_val": {
+ "type": "string"
+ },
+ "include_obligations_company_sponsorship_include_payments": {
+ "type": "boolean"
+ },
+ "include_obligations_company_sponsorship_include_payments_amount": {
+ "type": "number"
+ },
+ "include_obligations_company_sponsorship_include_payments_unit": {
+ "enum": [
+ "U.S. Dollars",
+ "percent"
+ ],
+ "type": "string"
+ },
+ "include_obligations_partner_brand": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_promotion": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_promotion_include_activities": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_promotion_include_activities_val": {
+ "type": "string"
+ },
+ "include_obligations_partner_promotion_include_materials": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_promotion_include_materials_val": {
+ "type": "string"
+ },
+ "include_obligations_partner_referral": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_referral_include_criteria": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_referral_include_criteria_val": {
+ "type": "string"
+ },
+ "include_obligations_partner_referral_include_pay_sch": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_referral_include_pay_sch_amount": {
+ "type": "number"
+ },
+ "include_obligations_partner_referral_include_pay_sch_custom": {
+ "type": "string"
+ },
+ "include_obligations_partner_referral_include_pay_sch_unit": {
+ "enum": [
+ "U.S. Dollars",
+ "percent"
+ ],
+ "type": "string"
+ },
+ "include_obligations_partner_sponsorship": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_sponsorship_include_benefits": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_sponsorship_include_benefits_val": {
+ "type": "string"
+ },
+ "include_obligations_partner_sponsorship_include_payments": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_sponsorship_include_payments_amount": {
+ "type": "number"
+ },
+ "include_obligations_partner_sponsorship_include_payments_unit": {
+ "enum": [
+ "U.S. Dollars",
+ "percent"
+ ],
+ "type": "string"
+ },
+ "include_payment_process": {
+ "type": "boolean"
+ },
+ "include_payment_process_company": {
+ "type": "boolean"
+ },
+ "include_payment_process_company_include_address": {
+ "type": "boolean"
+ },
+ "include_payment_process_company_include_address_city": {
+ "type": "string"
+ },
+ "include_payment_process_company_include_address_country": {
+ "type": "string"
+ },
+ "include_payment_process_company_include_address_state": {
+ "type": "string"
+ },
+ "include_payment_process_company_include_address_street_address": {
+ "type": "string"
+ },
+ "include_payment_process_company_include_address_zipcode": {
+ "type": "string"
+ },
+ "include_payment_process_company_include_email": {
+ "type": "boolean"
+ },
+ "include_payment_process_company_include_email_val": {
+ "type": "string"
+ },
+ "include_payment_process_partner": {
+ "type": "boolean"
+ },
+ "include_payment_process_partner_include_address": {
+ "type": "boolean"
+ },
+ "include_payment_process_partner_include_address_city": {
+ "type": "string"
+ },
+ "include_payment_process_partner_include_address_country": {
+ "type": "string"
+ },
+ "include_payment_process_partner_include_address_state": {
+ "type": "string"
+ },
+ "include_payment_process_partner_include_address_street_address": {
+ "type": "string"
+ },
+ "include_payment_process_partner_include_address_zipcode": {
+ "type": "string"
+ },
+ "include_payment_process_partner_include_email": {
+ "type": "boolean"
+ },
+ "include_payment_process_partner_include_email_val": {
+ "type": "string"
+ },
+ "include_payment_schedule": {
+ "type": "boolean"
+ },
+ "include_payment_schedule_custom": {
+ "type": "string"
+ },
+ "include_payment_schedule_specified_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_payment_schedule_specified_timeframe": {
+ "enum": [
+ "receipt",
+ "date"
+ ],
+ "type": "string"
+ },
+ "include_payment_schedule_specified_unit": {
+ "enum": [
+ "day(s)",
+ "week(s)",
+ "month(s)",
+ "quarter(s)",
+ "year(s)"
+ ],
+ "type": "string"
+ },
+ "include_payment_schedule_type": {
+ "enum": [
+ "specified",
+ "custom"
+ ],
+ "type": "string"
+ },
+ "negotiations_allowed": {
+ "description": "When true, the recipient can propose changes to the business terms, even when the agreement-level `negotiations_allowed` is false. This only covers the business terms.",
+ "type": "boolean"
+ },
+ "territory_type": {
+ "enum": [
+ "worldwide",
+ "custom"
+ ],
+ "type": "string"
+ },
+ "territory_type_val": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "payment_link_url": {
+ "description": "A payment URL shown to the recipient after signing. Requires include_billing_workflow to be true and billing_workflow_type to be \"link\".",
+ "type": "string"
+ },
+ "pilot_attributes": {
+ "additionalProperties": false,
+ "description": "Override pilot terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "fees_type": {
+ "enum": [
+ "free",
+ "pilot_period_fees"
+ ],
+ "type": "string"
+ },
+ "general_cap_amount": {
+ "type": "number"
+ },
+ "general_cap_amount_type": {
+ "enum": [
+ "preceding",
+ "base",
+ "period"
+ ],
+ "type": "string"
+ },
+ "general_cap_period_currency": {
+ "type": "number"
+ },
+ "general_cap_period_qty": {
+ "type": "number"
+ },
+ "general_cap_preceding_amount": {
+ "type": "number"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_dpa": {
+ "type": "boolean"
+ },
+ "include_dpa_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_dpa_location": {
+ "type": "string"
+ },
+ "include_dpa_type": {
+ "enum": [
+ "description",
+ "attachment",
+ "standard"
+ ],
+ "type": "string"
+ },
+ "include_payment_process": {
+ "type": "boolean"
+ },
+ "include_technical_support": {
+ "type": "boolean"
+ },
+ "payment_process_automatic_frequency": {
+ "enum": [
+ "monthly",
+ "quarterly",
+ "annually",
+ "once_per_period"
+ ],
+ "type": "string"
+ },
+ "payment_process_invoice_days": {
+ "type": "number"
+ },
+ "payment_process_invoice_from": {
+ "enum": [
+ "receipt",
+ "date"
+ ],
+ "type": "string"
+ },
+ "payment_process_invoice_timeframe": {
+ "enum": [
+ "days",
+ "weeks",
+ "months",
+ "quarters",
+ "years"
+ ],
+ "type": "string"
+ },
+ "payment_process_type": {
+ "enum": [
+ "automatic",
+ "invoice"
+ ],
+ "type": "string"
+ },
+ "pilot_period_description": {
+ "type": "string"
+ },
+ "pilot_period_fees_description": {
+ "type": "string"
+ },
+ "product_description": {
+ "type": "string"
+ },
+ "technical_support_description": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "psa_attributes": {
+ "additionalProperties": false,
+ "description": "Override psa terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "additional_changes": {
+ "type": "string"
+ },
+ "customer_description": {
+ "type": "string"
+ },
+ "effective_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "effective_date_type": {
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "type": "string"
+ },
+ "general_cap_amount": {
+ "type": "number"
+ },
+ "general_cap_amount_type": {
+ "enum": [
+ "preceding",
+ "base",
+ "period"
+ ],
+ "type": "string"
+ },
+ "general_cap_period_currency": {
+ "type": "number"
+ },
+ "general_cap_period_qty": {
+ "type": "number"
+ },
+ "general_cap_preceding_amount": {
+ "type": "number"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_additional_changes": {
+ "type": "boolean"
+ },
+ "include_additional_warranties": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_by_customer": {
+ "type": "string"
+ },
+ "include_additional_warranties_by_provider": {
+ "type": "string"
+ },
+ "include_additional_warranties_include_by_customer": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_include_by_provider": {
+ "type": "boolean"
+ },
+ "include_covered_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_customer_claims": {
+ "type": "string"
+ },
+ "include_covered_claims_include_customer_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_include_provider_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_provider_claims": {
+ "type": "string"
+ },
+ "include_customer_insurance_min": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_add_provider_com_gen_liability": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_add_provider_cyber_liability": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_add_provider_errors_omissions": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_auto_liability_aggregate": {
+ "type": "number"
+ },
+ "include_customer_insurance_min_auto_liability_minimum": {
+ "type": "number"
+ },
+ "include_customer_insurance_min_cyber_liability_aggregate": {
+ "type": "number"
+ },
+ "include_customer_insurance_min_cyber_liability_minimum": {
+ "type": "number"
+ },
+ "include_customer_insurance_min_employer_liability_aggregate": {
+ "type": "number"
+ },
+ "include_customer_insurance_min_employer_liability_minimum": {
+ "type": "number"
+ },
+ "include_customer_insurance_min_general_liability_aggregate": {
+ "type": "number"
+ },
+ "include_customer_insurance_min_general_liability_minimum": {
+ "type": "number"
+ },
+ "include_customer_insurance_min_include_add_provider": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_include_auto_liability": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_include_cyber_liability": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_include_employer_liability": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_include_general_liability": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_include_workers_comp": {
+ "type": "boolean"
+ },
+ "include_customer_policies": {
+ "type": "boolean"
+ },
+ "include_customer_policies_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_customer_policies_location": {
+ "type": "string"
+ },
+ "include_customer_policies_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_dpa": {
+ "type": "boolean"
+ },
+ "include_dpa_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_dpa_location": {
+ "type": "string"
+ },
+ "include_dpa_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_increased_cap_amount": {
+ "type": "boolean"
+ },
+ "include_increased_claims": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_confidentiality": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_confidentiality_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_privsec": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_privsec_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_other": {
+ "type": "boolean"
+ },
+ "include_increased_claims_indemnification_obligation": {
+ "type": "boolean"
+ },
+ "include_increased_claims_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_other": {
+ "type": "string"
+ },
+ "include_provider_insurance_min": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_add_customer_com_gen_liability": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_add_customer_cyber_liability": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_add_customer_errors_omissions": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_auto_liability_aggregate": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_auto_liability_minimum": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_cyber_liability_aggregate": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_cyber_liability_minimum": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_employer_liability_aggregate": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_employer_liability_minimum": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_general_liability_aggregate": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_general_liability_minimum": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_include_add_customer": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_include_auto_liability": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_include_cyber_liability": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_include_employer_liability": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_include_general_liability": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_include_workers_comp": {
+ "type": "boolean"
+ },
+ "include_publicity_rights": {
+ "type": "boolean"
+ },
+ "include_publicity_rights_type": {
+ "enum": [
+ "public",
+ "non-public"
+ ],
+ "type": "string"
+ },
+ "include_security_policy": {
+ "type": "boolean"
+ },
+ "include_security_policy_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_security_policy_fedramp_auth": {
+ "type": "boolean"
+ },
+ "include_security_policy_hitrust": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_annual_maintenance": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_other": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_other_val": {
+ "type": "string"
+ },
+ "include_security_policy_iso27001": {
+ "type": "boolean"
+ },
+ "include_security_policy_location": {
+ "type": "string"
+ },
+ "include_security_policy_pci1": {
+ "type": "boolean"
+ },
+ "include_security_policy_pci2": {
+ "type": "boolean"
+ },
+ "include_security_policy_penetration_testing": {
+ "type": "boolean"
+ },
+ "include_security_policy_soc2_type1": {
+ "type": "boolean"
+ },
+ "include_security_policy_soc2_type2": {
+ "type": "boolean"
+ },
+ "include_security_policy_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_unlimited_claims": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_confidentiality": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_confidentiality_negligence": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_privsec": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_privsec_negligence": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_include_other": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_indemnification_obligation": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_negligence": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_other": {
+ "type": "string"
+ },
+ "increased_cap_amount_currency": {
+ "type": "number"
+ },
+ "increased_cap_amount_period_currency": {
+ "type": "number"
+ },
+ "increased_cap_amount_period_qty": {
+ "type": "number"
+ },
+ "increased_cap_amount_qty": {
+ "type": "number"
+ },
+ "increased_cap_amount_type": {
+ "enum": [
+ "qty",
+ "currency",
+ "period"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "psa_statement_of_work_attributes": {
+ "additionalProperties": false,
+ "description": "Override psa statement of work terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "additional_changes": {
+ "type": "string"
+ },
+ "cost": {
+ "type": "number"
+ },
+ "description": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "fees_attributes": {
+ "additionalProperties": {
+ "anyOf": [
+ {
+ "additionalProperties": false,
+ "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": "string"
+ },
+ "include_deliverables": {
+ "type": "boolean"
+ },
+ "include_deliverables_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_deliverables_description": {
+ "type": "string"
+ },
+ "include_deliverables_include_acceptance": {
+ "type": "boolean"
+ },
+ "include_deliverables_include_attachment": {
+ "type": "boolean"
+ },
+ "include_deliverables_include_draft_deliverables": {
+ "type": "boolean"
+ },
+ "include_deliverables_rejection_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_deliverables_rejection_unit": {
+ "enum": [
+ "hours",
+ "days",
+ "weeks",
+ "months"
+ ],
+ "type": "string"
+ },
+ "include_deliverables_resubmission_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_deliverables_resubmission_unit": {
+ "enum": [
+ "hours",
+ "days",
+ "weeks",
+ "months"
+ ],
+ "type": "string"
+ },
+ "include_fees_other": {
+ "type": "boolean"
+ },
+ "include_fees_other_val": {
+ "type": "string"
+ },
+ "include_fees_table": {
+ "type": "boolean"
+ },
+ "include_fees_table_total": {
+ "type": "boolean"
+ },
+ "include_fees_travel": {
+ "type": "boolean"
+ },
+ "include_fees_travel_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_fees_travel_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_fees_travel_val": {
+ "type": "string"
+ },
+ "include_third_party_customer": {
+ "type": "boolean"
+ },
+ "include_third_party_include_description": {
+ "type": "boolean"
+ },
+ "include_third_party_include_description_val": {
+ "type": "string"
+ },
+ "include_third_party_materials": {
+ "type": "boolean"
+ },
+ "include_third_party_provider": {
+ "type": "boolean"
+ },
+ "include_time_of_assignment": {
+ "type": "boolean"
+ },
+ "include_time_of_assignment_type": {
+ "enum": [
+ "created",
+ "paid"
+ ],
+ "type": "string"
+ },
+ "invoice_period_description": {
+ "type": "string"
+ },
+ "negotiations_allowed": {
+ "description": "When true, the recipient can propose changes to the statement of work, even when the agreement-level `negotiations_allowed` is false. This only covers the statement of work.",
+ "type": "boolean"
+ },
+ "payment_period": {
+ "type": "number"
+ },
+ "payment_period_other": {
+ "type": "string"
+ },
+ "payment_period_timeframe": {
+ "enum": [
+ "receipt",
+ "invoice",
+ "Customer's receipt of invoice",
+ "date of invoice"
+ ],
+ "type": "string"
+ },
+ "payment_period_type": {
+ "enum": [
+ "standard",
+ "other"
+ ],
+ "type": "string"
+ },
+ "payment_period_unit": {
+ "enum": [
+ "day(s)",
+ "week(s)",
+ "month(s)",
+ "quarter(s)",
+ "year(s)"
+ ],
+ "type": "string"
+ },
+ "quantity": {
+ "type": "number"
+ },
+ "services_description": {
+ "type": "string"
+ },
+ "sow_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "sow_date_type": {
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "type": "string"
+ },
+ "sow_term_amount": {
+ "type": "number"
+ },
+ "sow_term_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "sow_term_type": {
+ "enum": [
+ "deliverables",
+ "period",
+ "date"
+ ],
+ "type": "string"
+ },
+ "sow_term_unit": {
+ "enum": [
+ "month(s)",
+ "quarter(s)",
+ "year(s)"
+ ],
+ "type": "string"
+ },
+ "type": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "recipient_email": {
+ "format": "email",
+ "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-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_last_to_sign": {
+ "description": "When true, your signer signs after the recipient.",
+ "type": "boolean"
+ },
+ "sender_notice_email_address": {
+ "description": "Email address for legal notices to the sender.",
+ "format": "email",
+ "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-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": {
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "type": "string"
+ },
+ "general_cap_amount": {
+ "type": "number"
+ },
+ "general_cap_amount_type": {
+ "enum": [
+ "preceding",
+ "base",
+ "period"
+ ],
+ "type": "string"
+ },
+ "general_cap_period_currency": {
+ "type": "number"
+ },
+ "general_cap_period_qty": {
+ "type": "number"
+ },
+ "general_cap_preceding_amount": {
+ "type": "number"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_additional_warranties": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_by_customer": {
+ "type": "string"
+ },
+ "include_additional_warranties_by_provider": {
+ "type": "string"
+ },
+ "include_additional_warranties_include_by_customer": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_include_by_provider": {
+ "type": "boolean"
+ },
+ "include_ai_addendum": {
+ "type": "boolean"
+ },
+ "include_ai_addendum_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_covered_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_customer_claims": {
+ "type": "string"
+ },
+ "include_covered_claims_include_customer_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_include_provider_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_provider_claims": {
+ "type": "string"
+ },
+ "include_dpa": {
+ "type": "boolean"
+ },
+ "include_dpa_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_dpa_location": {
+ "type": "string"
+ },
+ "include_dpa_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_increased_cap_amount": {
+ "type": "boolean"
+ },
+ "include_increased_claims": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_confidentiality": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_confidentiality_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_other": {
+ "type": "boolean"
+ },
+ "include_increased_claims_indemnification_obligation": {
+ "type": "boolean"
+ },
+ "include_increased_claims_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_other": {
+ "type": "string"
+ },
+ "include_increased_claims_restrictions": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_confidentiality": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_confidentiality_negligence": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_include_other": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_indemnification_obligation": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_license_or_restrictions": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_negligence": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_other": {
+ "type": "string"
+ },
+ "increased_cap_amount_currency": {
+ "type": "number"
+ },
+ "increased_cap_amount_period_currency": {
+ "type": "number"
+ },
+ "increased_cap_amount_period_qty": {
+ "type": "number"
+ },
+ "increased_cap_amount_qty": {
+ "type": "number"
+ },
+ "increased_cap_amount_type": {
+ "enum": [
+ "qty",
+ "currency",
+ "period"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "software_license_order_form_attributes": {
+ "additionalProperties": false,
+ "description": "Override software license order form terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "additional_changes": {
+ "type": "string"
+ },
+ "deletion_procedure_include_custom": {
+ "type": "boolean"
+ },
+ "deletion_procedure_include_custom_description": {
+ "type": "string"
+ },
+ "deletion_procedure_include_customer_disable": {
+ "type": "boolean"
+ },
+ "deletion_procedure_include_customer_proof": {
+ "type": "boolean"
+ },
+ "deletion_procedure_include_provider_disable": {
+ "type": "boolean"
+ },
+ "fee_custom_unit": {
+ "type": "string"
+ },
+ "fee_period": {
+ "enum": [
+ "Subscription Period",
+ "month",
+ "year",
+ "Custom unit"
+ ],
+ "type": "string"
+ },
+ "fees_attributes": {
+ "additionalProperties": {
+ "anyOf": [
+ {
+ "additionalProperties": false,
+ "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": {
+ "enum": [
+ "USD",
+ "EUR",
+ "GBP",
+ "CAD",
+ "AUD",
+ "SGD",
+ "ILS",
+ "JPY",
+ "CHF",
+ "HKD"
+ ],
+ "type": "string"
+ },
+ "fees_include_fee_increase_upon_renewal": {
+ "type": "boolean"
+ },
+ "fees_include_fee_increase_upon_renewal_fee": {
+ "type": "number"
+ },
+ "fees_include_fee_increase_upon_renewal_type": {
+ "enum": [
+ "will",
+ "may"
+ ],
+ "type": "string"
+ },
+ "fees_inclusive_of_taxes": {
+ "type": "boolean"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_additional_changes": {
+ "type": "boolean"
+ },
+ "include_license_compliance_verification": {
+ "type": "boolean"
+ },
+ "include_license_compliance_verification_description": {
+ "type": "string"
+ },
+ "include_license_limits": {
+ "type": "boolean"
+ },
+ "include_license_limits_description": {
+ "type": "string"
+ },
+ "include_payment_process_include_billing_email": {
+ "type": "boolean"
+ },
+ "include_pilot_period": {
+ "type": "boolean"
+ },
+ "include_pilot_period_duration_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_pilot_period_duration_type": {
+ "enum": [
+ "day",
+ "week",
+ "month"
+ ],
+ "type": "string"
+ },
+ "include_pilot_period_include_fees": {
+ "type": "boolean"
+ },
+ "include_pilot_period_include_fees_amount": {
+ "type": "number"
+ },
+ "include_pilot_period_include_modifications": {
+ "type": "boolean"
+ },
+ "include_pilot_period_include_modifications_description": {
+ "type": "string"
+ },
+ "include_services": {
+ "type": "boolean"
+ },
+ "include_services_description": {
+ "type": "string"
+ },
+ "negotiations_allowed": {
+ "description": "When true, the recipient can propose changes to the order form, even when the agreement-level `negotiations_allowed` is false. This only covers the order form.",
+ "type": "boolean"
+ },
+ "order_date_date": {
+ "type": "string"
+ },
+ "order_date_type": {
+ "enum": [
+ "signature",
+ "date",
+ "other"
+ ],
+ "type": "string"
+ },
+ "payment_process_automatic_frequency": {
+ "enum": [
+ "monthly",
+ "quarterly",
+ "semiannually",
+ "annually"
+ ],
+ "type": "string"
+ },
+ "payment_process_type": {
+ "enum": [
+ "automatic",
+ "invoice",
+ "custom"
+ ],
+ "type": "string"
+ },
+ "payment_process_type_custom_val": {
+ "type": "string"
+ },
+ "payment_process_type_invoice_amount": {
+ "type": "number"
+ },
+ "payment_process_type_invoice_custom_unit": {
+ "type": "string"
+ },
+ "payment_process_type_invoice_duration": {
+ "enum": [
+ "day",
+ "week",
+ "month",
+ "year",
+ "day(s)",
+ "week(s)",
+ "month(s)",
+ "year(s)"
+ ],
+ "type": "string"
+ },
+ "payment_process_type_invoice_duration_start": {
+ "enum": [
+ "Customer's receipt of invoice",
+ "date of invoice"
+ ],
+ "type": "string"
+ },
+ "payment_process_type_invoice_type": {
+ "enum": [
+ "monthly",
+ "quarterly",
+ "semiannually",
+ "annually",
+ "Custom unit"
+ ],
+ "type": "string"
+ },
+ "permitted_uses_include_custom": {
+ "type": "boolean"
+ },
+ "permitted_uses_include_custom_description": {
+ "type": "string"
+ },
+ "permitted_uses_include_customers_affiliates": {
+ "type": "boolean"
+ },
+ "permitted_uses_include_internal_business": {
+ "type": "boolean"
+ },
+ "pilot_period_stripe_product_id": {
+ "type": "string"
+ },
+ "software_description": {
+ "type": "string"
+ },
+ "subscription_auto_renew": {
+ "enum": [
+ "days",
+ "subscription_end"
+ ],
+ "type": "string"
+ },
+ "subscription_period": {
+ "type": "number"
+ },
+ "subscription_period_unit": {
+ "type": "string"
+ },
+ "subscription_renewal_notice_days": {
+ "type": "number"
+ },
+ "warranty_period_description_amount": {
+ "type": "number"
+ },
+ "warranty_period_description_duration": {
+ "enum": [
+ "day",
+ "week",
+ "month",
+ "year"
+ ],
+ "type": "string"
+ },
+ "warranty_period_description_duration_start": {
+ "enum": [
+ "initial delivery of the Software",
+ "delivery of the Software and each subsequent Update",
+ "the Order Date"
+ ],
+ "type": "string"
+ },
+ "warranty_period_type": {
+ "enum": [
+ "description",
+ "none"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "test_agreement": {
+ "description": "When true, marks the agreement as a test. Test agreements do not count against your monthly limit.",
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "recipient_name",
+ "recipient_email"
+ ],
+ "type": "object"
+ },
+ "cc_users": {
+ "items": {
+ "format": "email",
+ "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-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": {
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "type": "string"
+ },
+ "framework_terms_type": {
+ "type": "string"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "parent_agreement_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "underlying_agreement_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "underlying_agreement_type": {
+ "type": "string"
+ },
+ "underlying_agreement_val": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "baa_attributes": {
+ "additionalProperties": false,
+ "description": "Override baa terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "aggregation_limitations_permitted": {
+ "type": "boolean"
+ },
+ "aggregation_limitations_permitted_val": {
+ "type": "string"
+ },
+ "breach_notification_unit": {
+ "enum": [
+ "hours",
+ "business days",
+ "calendar days"
+ ],
+ "type": "string"
+ },
+ "breach_notification_val": {
+ "type": "number"
+ },
+ "business_associate_relationship_type": {
+ "enum": [
+ "provider",
+ "company"
+ ],
+ "type": "string"
+ },
+ "deidentification_limitations_include_purpose": {
+ "type": "boolean"
+ },
+ "deidentification_limitations_include_requirements": {
+ "type": "boolean"
+ },
+ "deidentification_limitations_permitted": {
+ "type": "boolean"
+ },
+ "deidentification_limitations_purpose_val": {
+ "type": "string"
+ },
+ "deidentification_limitations_requirements_val": {
+ "type": "string"
+ },
+ "designated_record_set_provider_maintains": {
+ "type": "boolean"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_aggregation_limitations": {
+ "type": "boolean"
+ },
+ "include_deidentification_limitations": {
+ "type": "boolean"
+ },
+ "include_limitations": {
+ "type": "boolean"
+ },
+ "include_offshore_limitations": {
+ "type": "boolean"
+ },
+ "include_subcontract_limitations": {
+ "type": "boolean"
+ },
+ "offshore_limitations_permitted": {
+ "type": "boolean"
+ },
+ "offshore_limitations_permitted_val": {
+ "type": "string"
+ },
+ "subcontract_limitations_include_notice": {
+ "type": "boolean"
+ },
+ "subcontract_limitations_include_permission": {
+ "type": "boolean"
+ },
+ "subcontract_limitations_notice_val": {
+ "type": "string"
+ },
+ "subcontract_limitations_permission_val": {
+ "type": "string"
+ },
+ "subcontract_limitations_permitted": {
+ "type": "boolean"
+ },
+ "underlying_agreement_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "underlying_agreement_type": {
+ "enum": [
+ "internal",
+ "external",
+ "none"
+ ],
+ "type": "string"
+ },
+ "underlying_agreement_val": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "billing_email": {
+ "description": "Email of the billing contact. Used when include_billing_info is true.",
+ "format": "email",
+ "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "billing_name": {
+ "description": "Name of the billing contact. Used when include_billing_info is true.",
+ "type": "string"
+ },
+ "billing_workflow_type": {
+ "description": "The type of billing workflow. Use \"link\" to provide a payment_link_url, or \"stripe\" for Stripe-managed billing.",
+ "enum": [
+ "link",
+ "stripe"
+ ],
+ "type": "string"
+ },
+ "chosen_courts_country": {
+ "description": "The country in which disputes will be resolved.",
+ "type": "string"
+ },
+ "chosen_courts_region": {
+ "description": "The state or region in which disputes will be resolved.",
+ "type": "string"
+ },
+ "csa_attributes": {
+ "additionalProperties": false,
+ "description": "Override csa terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "customer_description": {
+ "type": "string"
+ },
+ "effective_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "effective_date_marketplace": {
+ "enum": [
+ "AWS",
+ "GCP",
+ "Azure"
+ ],
+ "type": "string"
+ },
+ "effective_date_type": {
+ "enum": [
+ "signature",
+ "date",
+ "marketplace_acceptance"
+ ],
+ "type": "string"
+ },
+ "general_cap_amount": {
+ "type": "number"
+ },
+ "general_cap_amount_type": {
+ "enum": [
+ "preceding",
+ "base",
+ "period"
+ ],
+ "type": "string"
+ },
+ "general_cap_period_currency": {
+ "type": "number"
+ },
+ "general_cap_period_qty": {
+ "type": "number"
+ },
+ "general_cap_preceding_amount": {
+ "type": "number"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_acceptable_use_policy": {
+ "type": "boolean"
+ },
+ "include_acceptable_use_policy_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_acceptable_use_policy_location": {
+ "type": "string"
+ },
+ "include_acceptable_use_policy_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_additional_warranties": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_by_customer": {
+ "type": "string"
+ },
+ "include_additional_warranties_by_provider": {
+ "type": "string"
+ },
+ "include_additional_warranties_include_by_customer": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_include_by_provider": {
+ "type": "boolean"
+ },
+ "include_ai_addendum": {
+ "type": "boolean"
+ },
+ "include_ai_addendum_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_covered_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_customer_claims": {
+ "type": "string"
+ },
+ "include_covered_claims_include_customer_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_include_provider_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_provider_claims": {
+ "type": "string"
+ },
+ "include_dpa": {
+ "type": "boolean"
+ },
+ "include_dpa_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_dpa_location": {
+ "type": "string"
+ },
+ "include_dpa_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_increased_cap_amount": {
+ "type": "boolean"
+ },
+ "include_increased_claims": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_confidentiality": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_confidentiality_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_privsec": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_privsec_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_other": {
+ "type": "boolean"
+ },
+ "include_increased_claims_indemnification_obligation": {
+ "type": "boolean"
+ },
+ "include_increased_claims_other": {
+ "type": "string"
+ },
+ "include_insurance_minimums": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_add_customer": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_add_customer_com_gen_liability": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_add_customer_cyber_liability": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_add_customer_errors_omissions": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_additional_information": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_additional_information_text": {
+ "type": "string"
+ },
+ "include_insurance_minimums_cyber_liability_aggregate": {
+ "type": "number"
+ },
+ "include_insurance_minimums_cyber_liability_minimum": {
+ "type": "number"
+ },
+ "include_insurance_minimums_employer_liability_aggregate": {
+ "type": "number"
+ },
+ "include_insurance_minimums_employer_liability_minimum": {
+ "type": "number"
+ },
+ "include_insurance_minimums_general_liability_aggregate": {
+ "type": "number"
+ },
+ "include_insurance_minimums_general_liability_minimum": {
+ "type": "number"
+ },
+ "include_insurance_minimums_include_cyber_liability": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_include_employer_liability": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_include_general_liability": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_include_workers_compensation": {
+ "type": "boolean"
+ },
+ "include_publicity_rights": {
+ "type": "boolean"
+ },
+ "include_publicity_rights_type": {
+ "enum": [
+ "public",
+ "non-public"
+ ],
+ "type": "string"
+ },
+ "include_security_policy": {
+ "type": "boolean"
+ },
+ "include_security_policy_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_security_policy_fedramp_auth": {
+ "type": "boolean"
+ },
+ "include_security_policy_hipaa": {
+ "type": "boolean"
+ },
+ "include_security_policy_hitrust": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_annual_maintenance": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_location": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_other": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_reasonable_efforts": {
+ "type": "boolean"
+ },
+ "include_security_policy_iso27001": {
+ "type": "boolean"
+ },
+ "include_security_policy_location": {
+ "type": "string"
+ },
+ "include_security_policy_other": {
+ "type": "string"
+ },
+ "include_security_policy_pci1": {
+ "type": "boolean"
+ },
+ "include_security_policy_pci2": {
+ "type": "boolean"
+ },
+ "include_security_policy_penetration_testing": {
+ "type": "boolean"
+ },
+ "include_security_policy_soc2": {
+ "type": "boolean"
+ },
+ "include_security_policy_soc2_type2": {
+ "type": "boolean"
+ },
+ "include_security_policy_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_supercap": {
+ "description": "CSA 3.0 renamed `include_increased_cap_amount` to `include_supercap`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_increased_cap_amount`. Sending the other spelling returns a 422.",
+ "type": "boolean"
+ },
+ "include_uncapped_claims": {
+ "description": "CSA 3.0 renamed `include_unlimited_claims` to `include_uncapped_claims`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims`. Sending the other spelling returns a 422.",
+ "type": "boolean"
+ },
+ "include_uncapped_claims_breach_of_confidentiality": {
+ "description": "CSA 3.0 renamed `include_unlimited_claims_breach_of_confidentiality` to `include_uncapped_claims_breach_of_confidentiality`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_breach_of_confidentiality`. Sending the other spelling returns a 422.",
+ "type": "boolean"
+ },
+ "include_uncapped_claims_breach_of_confidentiality_negligence": {
+ "description": "CSA 3.0 renamed `include_unlimited_claims_breach_of_confidentiality_negligence` to `include_uncapped_claims_breach_of_confidentiality_negligence`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_breach_of_confidentiality_negligence`. Sending the other spelling returns a 422.",
+ "type": "boolean"
+ },
+ "include_uncapped_claims_breach_of_privsec": {
+ "description": "CSA 3.0 renamed `include_unlimited_claims_breach_of_privsec` to `include_uncapped_claims_breach_of_privsec`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_breach_of_privsec`. Sending the other spelling returns a 422.",
+ "type": "boolean"
+ },
+ "include_uncapped_claims_breach_of_privsec_negligence": {
+ "description": "CSA 3.0 renamed `include_unlimited_claims_breach_of_privsec_negligence` to `include_uncapped_claims_breach_of_privsec_negligence`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_breach_of_privsec_negligence`. Sending the other spelling returns a 422.",
+ "type": "boolean"
+ },
+ "include_uncapped_claims_include_other": {
+ "description": "CSA 3.0 renamed `include_unlimited_claims_include_other` to `include_uncapped_claims_include_other`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_include_other`. Sending the other spelling returns a 422.",
+ "type": "boolean"
+ },
+ "include_uncapped_claims_indemnification_obligation": {
+ "description": "CSA 3.0 renamed `include_unlimited_claims_indemnification_obligation` to `include_uncapped_claims_indemnification_obligation`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_indemnification_obligation`. Sending the other spelling returns a 422.",
+ "type": "boolean"
+ },
+ "include_uncapped_claims_other": {
+ "description": "CSA 3.0 renamed `include_unlimited_claims_other` to `include_uncapped_claims_other`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_unlimited_claims_other`. Sending the other spelling returns a 422.",
+ "type": "boolean"
+ },
+ "include_unlimited_claims": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_confidentiality": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_confidentiality_negligence": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_privsec": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_privsec_negligence": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_include_other": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_indemnification_obligation": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_other": {
+ "type": "string"
+ },
+ "increased_cap_amount_currency": {
+ "type": "number"
+ },
+ "increased_cap_amount_period_currency": {
+ "type": "number"
+ },
+ "increased_cap_amount_period_qty": {
+ "type": "number"
+ },
+ "increased_cap_amount_qty": {
+ "type": "number"
+ },
+ "increased_cap_amount_type": {
+ "enum": [
+ "qty",
+ "currency",
+ "period"
+ ],
+ "type": "string"
+ },
+ "provider": {
+ "type": "string"
+ },
+ "supercap_currency": {
+ "description": "CSA 3.0 renamed `increased_cap_amount_currency` to `supercap_currency`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `increased_cap_amount_currency`. Sending the other spelling returns a 422.",
+ "type": "number"
+ },
+ "supercap_period_currency": {
+ "description": "CSA 3.0 renamed `increased_cap_amount_period_currency` to `supercap_period_currency`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `increased_cap_amount_period_currency`. Sending the other spelling returns a 422.",
+ "type": "number"
+ },
+ "supercap_period_qty": {
+ "description": "CSA 3.0 renamed `increased_cap_amount_period_qty` to `supercap_period_qty`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `increased_cap_amount_period_qty`. Sending the other spelling returns a 422.",
+ "type": "number"
+ },
+ "supercap_qty": {
+ "description": "CSA 3.0 renamed `increased_cap_amount_qty` to `supercap_qty`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `increased_cap_amount_qty`. Sending the other spelling returns a 422.",
+ "type": "number"
+ },
+ "supercap_type": {
+ "description": "CSA 3.0 renamed `increased_cap_amount_type` to `supercap_type`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `increased_cap_amount_type`. Sending the other spelling returns a 422.",
+ "type": "number"
+ }
+ },
+ "type": "object"
+ },
+ "csa_order_form_attributes": {
+ "additionalProperties": false,
+ "description": "Override csa order form terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "additional_changes": {
+ "type": "string"
+ },
+ "additional_parameters_or_limitations": {
+ "type": "string"
+ },
+ "affiliates_as_users": {
+ "type": "boolean"
+ },
+ "cloud_service_description": {
+ "type": "string"
+ },
+ "consumption_units": {
+ "type": "string"
+ },
+ "fee_amount": {
+ "type": "number"
+ },
+ "fee_custom_unit": {
+ "type": "string"
+ },
+ "fee_period": {
+ "enum": [
+ "Subscription Period",
+ "month",
+ "year",
+ "User",
+ "Custom unit"
+ ],
+ "type": "string"
+ },
+ "fees_attributes": {
+ "additionalProperties": {
+ "anyOf": [
+ {
+ "additionalProperties": false,
+ "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": {
+ "enum": [
+ "USD",
+ "EUR",
+ "GBP",
+ "CAD",
+ "AUD",
+ "SGD",
+ "ILS",
+ "JPY",
+ "CHF",
+ "HKD"
+ ],
+ "type": "string"
+ },
+ "fees_include_fee_increase_upon_renewal": {
+ "type": "boolean"
+ },
+ "fees_include_fee_increase_upon_renewal_fee": {
+ "type": "number"
+ },
+ "fees_include_fee_increase_upon_renewal_type": {
+ "enum": [
+ "will",
+ "may"
+ ],
+ "type": "string"
+ },
+ "fees_inclusive_of_taxes": {
+ "type": "boolean"
+ },
+ "framework_terms_type": {
+ "enum": [
+ "new",
+ "existing",
+ "description"
+ ],
+ "type": "string"
+ },
+ "free_trial_days": {
+ "type": "number"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_additional_changes": {
+ "type": "boolean"
+ },
+ "include_additional_parameters_or_limitations": {
+ "type": "boolean"
+ },
+ "include_consumption": {
+ "type": "boolean"
+ },
+ "include_fees": {
+ "type": "boolean"
+ },
+ "include_fees_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_fees_include_attachment": {
+ "type": "boolean"
+ },
+ "include_fees_other": {
+ "type": "boolean"
+ },
+ "include_fees_other_val": {
+ "type": "string"
+ },
+ "include_fees_table": {
+ "type": "boolean"
+ },
+ "include_fees_table_period": {
+ "enum": [
+ "Subscription Period",
+ "month",
+ "year",
+ "User"
+ ],
+ "type": "string"
+ },
+ "include_free_trial": {
+ "type": "boolean"
+ },
+ "include_max_users": {
+ "type": "boolean"
+ },
+ "include_pilot_period": {
+ "type": "boolean"
+ },
+ "include_pilot_period_duration_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_pilot_period_duration_type": {
+ "enum": [
+ "day",
+ "week",
+ "month"
+ ],
+ "type": "string"
+ },
+ "include_pilot_period_include_fees": {
+ "type": "boolean"
+ },
+ "include_pilot_period_include_fees_amount": {
+ "type": "number"
+ },
+ "include_pilot_period_include_modifications": {
+ "type": "boolean"
+ },
+ "include_pilot_period_include_modifications_description": {
+ "type": "string"
+ },
+ "include_product_support": {
+ "type": "boolean"
+ },
+ "include_product_support_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_product_support_description": {
+ "type": "string"
+ },
+ "include_product_support_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_professional_services": {
+ "type": "boolean"
+ },
+ "include_professional_services_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_professional_services_custom_name": {
+ "type": "string"
+ },
+ "include_professional_services_description": {
+ "type": "string"
+ },
+ "include_professional_services_end_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "include_professional_services_fees_description": {
+ "type": "string"
+ },
+ "include_professional_services_include_end_date": {
+ "type": "boolean"
+ },
+ "include_professional_services_include_fees_description": {
+ "type": "boolean"
+ },
+ "include_professional_services_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_sla": {
+ "type": "boolean"
+ },
+ "include_sla_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_sla_description": {
+ "type": "string"
+ },
+ "include_sla_include_response_time": {
+ "type": "boolean"
+ },
+ "include_sla_include_response_time_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_sla_include_response_time_credit": {
+ "type": "number"
+ },
+ "include_sla_include_response_time_duration": {
+ "enum": [
+ "hour",
+ "day",
+ "week",
+ "month",
+ "hours"
+ ],
+ "type": "string"
+ },
+ "include_sla_include_response_time_support_channel": {
+ "type": "string"
+ },
+ "include_sla_include_target_uptime": {
+ "type": "boolean"
+ },
+ "include_sla_maintenance_notice": {
+ "type": "boolean"
+ },
+ "include_sla_maintenance_window": {
+ "type": "boolean"
+ },
+ "include_sla_maintenance_window_type": {
+ "enum": [
+ "standard",
+ "none"
+ ],
+ "type": "string"
+ },
+ "include_sla_standard_maintenance_notice_qty": {
+ "type": "number"
+ },
+ "include_sla_standard_maintenance_notice_unit": {
+ "enum": [
+ "hour",
+ "day",
+ "week",
+ "month"
+ ],
+ "type": "string"
+ },
+ "include_sla_standard_maintenance_window_end_time": {
+ "type": "string"
+ },
+ "include_sla_standard_maintenance_window_friday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_monday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_saturday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_start_time": {
+ "type": "string"
+ },
+ "include_sla_standard_maintenance_window_sunday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_thursday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_time_zone": {
+ "type": "string"
+ },
+ "include_sla_standard_maintenance_window_tuesday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_wednesday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_target_uptime": {
+ "type": "number"
+ },
+ "include_sla_type": {
+ "enum": [
+ "description",
+ "standard",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_subscription_start_date": {
+ "type": "boolean"
+ },
+ "include_subscription_start_date_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "include_usage_review": {
+ "type": "boolean"
+ },
+ "include_usage_review_val": {
+ "type": "string"
+ },
+ "include_use_limitations": {
+ "type": "boolean"
+ },
+ "include_use_limitations_val": {
+ "type": "string"
+ },
+ "invoice_period": {
+ "enum": [
+ "monthly",
+ "quarterly",
+ "semiannually",
+ "annually",
+ "Custom unit",
+ "Monthly",
+ "Quarterly",
+ "Semiannually",
+ "Annually"
+ ],
+ "type": "string"
+ },
+ "invoice_period_custom_unit": {
+ "type": "string"
+ },
+ "max_consumption": {
+ "type": "number"
+ },
+ "max_users": {
+ "type": "number"
+ },
+ "negotiations_allowed": {
+ "description": "When true, the recipient can propose changes to the order form, even when the agreement-level `negotiations_allowed` is false. This only covers the order form.",
+ "type": "boolean"
+ },
+ "order_date_date": {
+ "type": "string"
+ },
+ "order_date_other": {
+ "type": "string"
+ },
+ "order_date_type": {
+ "enum": [
+ "signature",
+ "date",
+ "other"
+ ],
+ "type": "string"
+ },
+ "payment_period": {
+ "type": "number"
+ },
+ "payment_period_timeframe": {
+ "enum": [
+ "Customer's receipt of invoice",
+ "date of invoice"
+ ],
+ "type": "string"
+ },
+ "payment_period_unit": {
+ "enum": [
+ "day(s)",
+ "week(s)",
+ "month(s)",
+ "marketplace_acceptance"
+ ],
+ "type": "string"
+ },
+ "payment_process_automatic_frequency": {
+ "enum": [
+ "monthly",
+ "quarterly",
+ "semiannually",
+ "annually"
+ ],
+ "type": "string"
+ },
+ "payment_process_type": {
+ "enum": [
+ "automatic",
+ "invoice",
+ "custom",
+ "marketplace_acceptance"
+ ],
+ "type": "string"
+ },
+ "payment_process_type_custom_val": {
+ "type": "string"
+ },
+ "payment_process_type_invoice_amount": {
+ "type": "number"
+ },
+ "payment_process_type_invoice_custom_unit": {
+ "type": "string"
+ },
+ "payment_process_type_invoice_duration": {
+ "enum": [
+ "day",
+ "week",
+ "month",
+ "year",
+ "day(s)",
+ "week(s)",
+ "month(s)",
+ "year(s)"
+ ],
+ "type": "string"
+ },
+ "payment_process_type_invoice_duration_start": {
+ "enum": [
+ "Customer's receipt of invoice",
+ "date of invoice"
+ ],
+ "type": "string"
+ },
+ "payment_process_type_invoice_type": {
+ "enum": [
+ "monthly",
+ "quarterly",
+ "semiannually",
+ "annually",
+ "Custom unit"
+ ],
+ "type": "string"
+ },
+ "pilot_period_stripe_product_id": {
+ "type": "string"
+ },
+ "service_credits_attributes": {
+ "additionalProperties": {
+ "additionalProperties": false,
+ "properties": {
+ "credit": {
+ "type": "number"
+ },
+ "max": {
+ "type": "number"
+ },
+ "min": {
+ "type": "number"
+ }
+ },
+ "type": "object"
+ },
+ "description": "Service credits. Use string keys such as \"0\", \"1\".",
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+ },
+ "subscription_auto_renew": {
+ "enum": [
+ "days",
+ "subscription_end"
+ ],
+ "type": "string"
+ },
+ "subscription_period": {
+ "type": "number"
+ },
+ "subscription_period_unit": {
+ "type": "string"
+ },
+ "subscription_renewal_notice_days": {
+ "type": "number"
+ },
+ "subscription_start_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "subscription_start_date_type": {
+ "enum": [
+ "effective_date",
+ "date"
+ ],
+ "type": "string"
+ },
+ "underlying_agreement_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "use_limitations_attributes": {
+ "additionalProperties": {
+ "additionalProperties": false,
+ "properties": {
+ "amount": {
+ "type": "number"
+ },
+ "limitation_type": {
+ "type": "string"
+ },
+ "unit": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "description": "Use limitations. Use string keys such as \"0\", \"1\".",
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+ }
+ },
+ "type": "object"
+ },
+ "custom_field_values": {
+ "description": "Values for a custom template's fields, keyed by the field keys defined in the template's YAML definition. Only used when template_id is a custom template. Template defaults fill any fields you omit; a required field with no default and no submitted value returns a 400 naming the field. Values are validated against the field's input type: select and radio values must be one of the field's options, multiselect values are an array of selections each of which must be one of the field's options, number and currency values must be numeric, date values must be YYYY-MM-DD, and email values must be valid addresses. An invalid value returns a 400 naming the field."
+ },
+ "design_partner_attributes": {
+ "additionalProperties": false,
+ "description": "Override design partner terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "customer_description": {
+ "type": "string"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_fees": {
+ "type": "boolean"
+ },
+ "include_fees_amount": {
+ "type": "number"
+ },
+ "include_fees_description": {
+ "type": "string"
+ },
+ "include_fees_pay_by_amount": {
+ "type": "string"
+ },
+ "include_fees_type": {
+ "enum": [
+ "default_language",
+ "description"
+ ],
+ "type": "string"
+ },
+ "include_fees_unit": {
+ "enum": [
+ "month",
+ "quarter",
+ "year",
+ "Term"
+ ],
+ "type": "string"
+ },
+ "include_program_appear_as_customer_private": {
+ "type": "boolean"
+ },
+ "include_program_appear_as_customer_public": {
+ "type": "boolean"
+ },
+ "include_program_case_study": {
+ "type": "boolean"
+ },
+ "include_program_develop_functionality": {
+ "type": "boolean"
+ },
+ "include_program_develop_functionality_val": {
+ "type": "string"
+ },
+ "include_program_discount": {
+ "type": "boolean"
+ },
+ "include_program_discount_amount": {
+ "type": "number"
+ },
+ "include_program_discount_unit": {
+ "enum": [
+ "U.S. Dollars",
+ "percent"
+ ],
+ "type": "string"
+ },
+ "include_program_participation_feedback": {
+ "type": "boolean"
+ },
+ "include_program_participation_feedback_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_program_participation_feedback_unit": {
+ "enum": [
+ "month",
+ "quarter",
+ "year",
+ "Term"
+ ],
+ "type": "string"
+ },
+ "include_program_partner_other": {
+ "type": "boolean"
+ },
+ "include_program_partner_other_val": {
+ "type": "string"
+ },
+ "include_program_provider_other": {
+ "type": "boolean"
+ },
+ "include_program_provider_other_val": {
+ "type": "string"
+ },
+ "include_program_reference": {
+ "type": "boolean"
+ },
+ "product_description": {
+ "type": "string"
+ },
+ "term_amount": {
+ "type": "number"
+ },
+ "term_unit": {
+ "enum": [
+ "day(s)",
+ "week(s)",
+ "month(s)",
+ "quarter(s)",
+ "year(s)"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "district_or_county": {
+ "description": "The district or county for dispute resolution.",
+ "type": "string"
+ },
+ "dpa_attributes": {
+ "additionalProperties": false,
+ "description": "Override dpa terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "approved_subprocessor_type": {
+ "description": "`internal` lists approved subprocessors in the agreement (`subprocessors_attributes`); `external` points to a list published elsewhere.",
+ "enum": [
+ "internal",
+ "external"
+ ],
+ "type": "string"
+ },
+ "cloud_service_product_name": {
+ "type": "string"
+ },
+ "competent_supervisory_authority": {
+ "type": "string"
+ },
+ "customer_description": {
+ "type": "string"
+ },
+ "data_exporter_address_city": {
+ "type": "string"
+ },
+ "data_exporter_address_country": {
+ "type": "string"
+ },
+ "data_exporter_address_state": {
+ "type": "string"
+ },
+ "data_exporter_address_street_address": {
+ "type": "string"
+ },
+ "data_exporter_address_zipcode": {
+ "type": "string"
+ },
+ "data_exporter_contact_details": {
+ "type": "string"
+ },
+ "data_exporter_contact_name": {
+ "type": "string"
+ },
+ "data_exporter_contact_position": {
+ "type": "string"
+ },
+ "data_exporter_role": {
+ "description": "Role of the data exporter. Overwritten to `Controller` when the agreement is created from a template.",
+ "enum": [
+ "Controller",
+ "Processor"
+ ],
+ "type": "string"
+ },
+ "data_importer_address": {
+ "type": "string"
+ },
+ "data_importer_address_city": {
+ "type": "string"
+ },
+ "data_importer_address_country": {
+ "type": "string"
+ },
+ "data_importer_address_state": {
+ "type": "string"
+ },
+ "data_importer_address_street_address": {
+ "type": "string"
+ },
+ "data_importer_address_zipcode": {
+ "type": "string"
+ },
+ "data_importer_contact_details": {
+ "type": "string"
+ },
+ "data_importer_contact_name": {
+ "type": "string"
+ },
+ "data_importer_contact_position": {
+ "type": "string"
+ },
+ "duration_of_processing": {
+ "type": "string"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_covered_claim": {
+ "type": "boolean"
+ },
+ "include_covered_claim_external_val": {
+ "type": "string"
+ },
+ "include_covered_claim_internal_val": {
+ "type": "string"
+ },
+ "include_covered_claim_type": {
+ "description": "Which covered-claim text applies: `internal` uses `include_covered_claim_internal_val`, `external` uses `include_covered_claim_external_val`. Required when `include_covered_claim` is true.",
+ "enum": [
+ "internal",
+ "external"
+ ],
+ "type": "string"
+ },
+ "include_data_subjects_custom": {
+ "type": "boolean"
+ },
+ "include_data_subjects_custom_val": {
+ "type": "string"
+ },
+ "include_data_subjects_employees": {
+ "type": "boolean"
+ },
+ "include_data_subjects_end_users": {
+ "type": "boolean"
+ },
+ "include_external_subprocessor_location": {
+ "type": "string"
+ },
+ "include_frequency_of_transfer_continuous": {
+ "type": "boolean"
+ },
+ "include_frequency_of_transfer_custom": {
+ "type": "boolean"
+ },
+ "include_frequency_of_transfer_custom_val": {
+ "type": "string"
+ },
+ "include_governing_country_eu": {
+ "type": "boolean"
+ },
+ "include_governing_country_eu_val": {
+ "type": "string"
+ },
+ "include_governing_country_uk": {
+ "type": "boolean"
+ },
+ "include_governing_country_uk_val": {
+ "type": "string"
+ },
+ "include_governing_law": {
+ "type": "boolean"
+ },
+ "include_governing_law_country": {
+ "type": "string"
+ },
+ "include_governing_law_state": {
+ "type": "string"
+ },
+ "include_increased_claim_amount": {
+ "description": "Legacy field. Stored but not shown on the DPA; use the `include_liability_cap*` fields instead.",
+ "type": "boolean"
+ },
+ "include_increased_claim_amount_currency": {
+ "description": "Legacy field. Stored but not shown on the DPA; use the `include_liability_cap*` fields instead."
+ },
+ "include_increased_claim_amount_qty": {
+ "description": "Legacy field. Stored but not shown on the DPA; use the `include_liability_cap*` fields instead."
+ },
+ "include_increased_claim_amount_type": {
+ "description": "Legacy field. Stored but not shown on the DPA; use the `include_liability_cap*` fields instead.",
+ "type": "string"
+ },
+ "include_liability_cap": {
+ "type": "boolean"
+ },
+ "include_liability_cap_amount_constant_external": {
+ "type": "string"
+ },
+ "include_liability_cap_amount_constant_internal": {
+ "type": "string"
+ },
+ "include_liability_cap_amount_currency_external": {
+ "description": "Currency amount. Numbers and numeric strings (commas allowed) are both accepted."
+ },
+ "include_liability_cap_amount_currency_internal": {
+ "description": "Currency amount. Numbers and numeric strings (commas allowed) are both accepted."
+ },
+ "include_liability_cap_csa_type": {
+ "description": "Which liability cap values apply: the `_internal` or `_external` amount fields. Required when `include_liability_cap` is true.",
+ "enum": [
+ "internal",
+ "external"
+ ],
+ "type": "string"
+ },
+ "include_personal_data_biographic_info": {
+ "type": "boolean"
+ },
+ "include_personal_data_contact_info": {
+ "type": "boolean"
+ },
+ "include_personal_data_custom": {
+ "type": "boolean"
+ },
+ "include_personal_data_custom_val": {
+ "type": "string"
+ },
+ "include_personal_data_employment_info": {
+ "type": "boolean"
+ },
+ "include_personal_data_financial_info": {
+ "type": "boolean"
+ },
+ "include_personal_data_location": {
+ "type": "boolean"
+ },
+ "include_personal_data_name": {
+ "type": "boolean"
+ },
+ "include_personal_data_transactional_info": {
+ "type": "boolean"
+ },
+ "include_personal_data_user_activity_info": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_custom": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_custom_val": {
+ "type": "string"
+ },
+ "include_processing_purpose_erasing": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_holding": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_protecting": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_receiving": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_returning": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_sharing": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_updating": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_using": {
+ "type": "boolean"
+ },
+ "include_provider_security_contact_address": {
+ "type": "boolean"
+ },
+ "include_provider_security_contact_address_city": {
+ "type": "string"
+ },
+ "include_provider_security_contact_address_country": {
+ "type": "string"
+ },
+ "include_provider_security_contact_address_state": {
+ "type": "string"
+ },
+ "include_provider_security_contact_address_street_address": {
+ "type": "string"
+ },
+ "include_provider_security_contact_address_zipcode": {
+ "type": "string"
+ },
+ "include_provider_security_contact_email": {
+ "type": "boolean"
+ },
+ "include_provider_security_contact_email_val": {
+ "format": "email",
+ "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "include_security_measures_accountability": {
+ "type": "boolean"
+ },
+ "include_security_measures_accountability_val": {
+ "type": "string"
+ },
+ "include_security_measures_certification_or_assurance": {
+ "type": "boolean"
+ },
+ "include_security_measures_certification_or_assurance_val": {
+ "type": "string"
+ },
+ "include_security_measures_confidentiality_integrity": {
+ "type": "boolean"
+ },
+ "include_security_measures_confidentiality_integrity_val": {
+ "type": "string"
+ },
+ "include_security_measures_data_at_rest": {
+ "type": "boolean"
+ },
+ "include_security_measures_data_at_rest_val": {
+ "type": "string"
+ },
+ "include_security_measures_data_minimization": {
+ "type": "boolean"
+ },
+ "include_security_measures_data_minimization_val": {
+ "type": "string"
+ },
+ "include_security_measures_data_quality": {
+ "type": "boolean"
+ },
+ "include_security_measures_data_quality_val": {
+ "type": "string"
+ },
+ "include_security_measures_data_retention": {
+ "type": "boolean"
+ },
+ "include_security_measures_data_retention_val": {
+ "type": "string"
+ },
+ "include_security_measures_data_transmission": {
+ "type": "boolean"
+ },
+ "include_security_measures_data_transmission_val": {
+ "type": "string"
+ },
+ "include_security_measures_event_logging": {
+ "type": "boolean"
+ },
+ "include_security_measures_event_logging_val": {
+ "type": "string"
+ },
+ "include_security_measures_identity_auth": {
+ "type": "boolean"
+ },
+ "include_security_measures_identity_auth_val": {
+ "type": "string"
+ },
+ "include_security_measures_it_security_governance": {
+ "type": "boolean"
+ },
+ "include_security_measures_it_security_governance_val": {
+ "type": "string"
+ },
+ "include_security_measures_physical_security": {
+ "type": "boolean"
+ },
+ "include_security_measures_physical_security_val": {
+ "type": "string"
+ },
+ "include_security_measures_portability_and_erasure": {
+ "type": "boolean"
+ },
+ "include_security_measures_portability_and_erasure_val": {
+ "type": "string"
+ },
+ "include_security_measures_pseudonym_encryption": {
+ "type": "boolean"
+ },
+ "include_security_measures_pseudonym_encryption_val": {
+ "type": "string"
+ },
+ "include_security_measures_restore_data_access": {
+ "type": "boolean"
+ },
+ "include_security_measures_restore_data_access_val": {
+ "type": "string"
+ },
+ "include_security_measures_security_policy": {
+ "type": "boolean"
+ },
+ "include_security_measures_system_configuration": {
+ "type": "boolean"
+ },
+ "include_security_measures_system_configuration_val": {
+ "type": "string"
+ },
+ "include_security_measures_testing_assessment": {
+ "type": "boolean"
+ },
+ "include_security_measures_testing_assessment_val": {
+ "type": "string"
+ },
+ "include_security_policy": {
+ "type": "boolean"
+ },
+ "include_security_policy_fedramp_auth": {
+ "type": "boolean"
+ },
+ "include_security_policy_hipaa": {
+ "type": "boolean"
+ },
+ "include_security_policy_hitrust": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_other": {
+ "type": "boolean"
+ },
+ "include_security_policy_iso27001": {
+ "type": "boolean"
+ },
+ "include_security_policy_other": {
+ "type": "string"
+ },
+ "include_security_policy_pci1": {
+ "type": "boolean"
+ },
+ "include_security_policy_pci2": {
+ "type": "boolean"
+ },
+ "include_security_policy_penetration_testing": {
+ "type": "boolean"
+ },
+ "include_security_policy_soc2": {
+ "type": "boolean"
+ },
+ "include_security_policy_soc2_type2": {
+ "type": "boolean"
+ },
+ "include_sensitive_data_restrictions_custom": {
+ "type": "boolean"
+ },
+ "include_sensitive_data_restrictions_custom_val": {
+ "type": "string"
+ },
+ "include_sensitive_data_restrictions_security_policy": {
+ "type": "boolean"
+ },
+ "include_service_provider_relationship": {
+ "type": "boolean"
+ },
+ "include_special_category_data": {
+ "type": "boolean"
+ },
+ "provider": {
+ "type": "string"
+ },
+ "security_policy_available_at": {
+ "type": "string"
+ },
+ "security_policy_type": {
+ "description": "Where the Security Policy is defined. For `external`, set `security_policy_available_at`.",
+ "enum": [
+ "defined in agreement",
+ "provider service",
+ "external"
+ ],
+ "type": "string"
+ },
+ "subprocessors_attributes": {
+ "additionalProperties": {
+ "additionalProperties": false,
+ "properties": {
+ "_destroy": {
+ "description": "Set to true with `id` to remove that subprocessor.",
+ "type": "boolean"
+ },
+ "country": {
+ "type": "string"
+ },
+ "id": {
+ "description": "ID of an existing subprocessor to update or remove. Omit to add a new subprocessor.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "processing_task": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "description": "Subprocessors, keyed by string index such as \"0\", \"1\". On create these are added to the template's subprocessors. On a draft update, an entry without `id` adds a new subprocessor; pass `id` to change one and `id` with `_destroy: true` to remove one.",
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+ },
+ "underlying_agreement_id": {
+ "description": "ID of the CSA this DPA supplements when `underlying_agreement_type` is `internal`.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "underlying_agreement_type": {
+ "description": "`internal` links a CSA in Common Paper (`underlying_agreement_id`); `external` describes another agreement in `underlying_agreement_val` (required). Omit for none.",
+ "enum": [
+ "internal",
+ "external"
+ ],
+ "type": "string"
+ },
+ "underlying_agreement_val": {
+ "description": "Description of the agreement this DPA supplements. Required when `underlying_agreement_type` is `external`.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "framework_terms_description": {
+ "description": "Custom framework terms description. Only used when framework_terms_type is \"description\".",
+ "type": "string"
+ },
+ "framework_terms_type": {
+ "description": "How framework terms are specified. Use \"new\" for standard terms or \"description\" to provide a custom framework_terms_description.",
+ "enum": [
+ "new",
+ "description"
+ ],
+ "type": "string"
+ },
+ "governing_law_country": {
+ "description": "The country whose laws govern the agreement.",
+ "type": "string"
+ },
+ "governing_law_region": {
+ "description": "The state or region whose laws govern the agreement.",
+ "type": "string"
+ },
+ "include_automated_payment_reminders": {
+ "description": "When true, automatically sends payment reminder emails.",
+ "type": "boolean"
+ },
+ "include_billing_info": {
+ "description": "When true, billing contact information (billing_name, billing_email) is included.",
+ "type": "boolean"
+ },
+ "include_billing_workflow": {
+ "description": "When true, enables a billing workflow after signing.",
+ "type": "boolean"
+ },
+ "include_expiration_date": {
+ "description": "Expiration date in YYYY-MM-DD format. Use when include_expiration_type is \"date\".",
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "include_expiration_days": {
+ "description": "Number of days until the agreement expires. Use when include_expiration_type is \"days\".",
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_expiration_type": {
+ "description": "How to set expiration: \"none\" (default), \"days\" (use include_expiration_days), or \"date\" (use include_expiration_date).",
+ "enum": [
+ "none",
+ "days",
+ "date"
+ ],
+ "type": "string"
+ },
+ "include_terms": {
+ "description": "When true, the standard terms are included with the agreement.",
+ "type": "boolean"
+ },
+ "loi_attributes": {
+ "additionalProperties": false,
+ "description": "Override loi terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "confidentiality_custom": {
+ "type": "string"
+ },
+ "confidentiality_mutual_include_loi": {
+ "type": "boolean"
+ },
+ "confidentiality_nda_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "confidentiality_nda_description": {
+ "type": "string"
+ },
+ "confidentiality_nda_include_loi": {
+ "type": "boolean"
+ },
+ "confidentiality_nda_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "confidentiality_type": {
+ "enum": [
+ "mutual",
+ "nda",
+ "provider",
+ "custom"
+ ],
+ "type": "string"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_custom_details": {
+ "type": "boolean"
+ },
+ "include_custom_details_val": {
+ "type": "string"
+ },
+ "include_fees": {
+ "type": "boolean"
+ },
+ "include_fees_amount": {
+ "type": "number"
+ },
+ "include_fees_amount_duration": {
+ "enum": [
+ "month",
+ "year",
+ "quarter"
+ ],
+ "type": "string"
+ },
+ "include_fees_include_amount": {
+ "type": "boolean"
+ },
+ "include_fees_include_other": {
+ "type": "boolean"
+ },
+ "include_fees_other": {
+ "type": "string"
+ },
+ "include_functionality": {
+ "type": "boolean"
+ },
+ "include_functionality_val": {
+ "type": "string"
+ },
+ "include_launch_date": {
+ "type": "boolean"
+ },
+ "include_launch_date_custom": {
+ "type": "string"
+ },
+ "include_launch_date_date": {
+ "format": "date-time",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$",
+ "type": "string"
+ },
+ "include_launch_date_type": {
+ "enum": [
+ "date",
+ "custom"
+ ],
+ "type": "string"
+ },
+ "product_name": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "manual_send": {
+ "description": "When true, the agreement is marked as manually sent outside the platform.",
+ "type": "boolean"
+ },
+ "message": {
+ "type": "string"
+ },
+ "negotiations_allowed": {
+ "description": "When true, the recipient can propose changes to the legal terms. For agreement types without separate business terms, that covers every term. CSA order forms, PSA statements of work, partnership business terms and software license order forms have their own `negotiations_allowed` flag.",
+ "type": "boolean"
+ },
+ "partnership_attributes": {
+ "additionalProperties": false,
+ "description": "Override partnership terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "effective_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "effective_date_type": {
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "type": "string"
+ },
+ "general_cap_amount_currency_val": {
+ "type": "number"
+ },
+ "general_cap_amount_either_currency": {
+ "type": "number"
+ },
+ "general_cap_amount_either_multiple": {
+ "type": "number"
+ },
+ "general_cap_amount_multiple_val": {
+ "type": "number"
+ },
+ "general_cap_amount_type": {
+ "enum": [
+ "multiple",
+ "currency",
+ "either",
+ "base"
+ ],
+ "type": "string"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_additional_warranties": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_include_company": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_include_company_val": {
+ "type": "string"
+ },
+ "include_additional_warranties_include_partner": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_include_partner_val": {
+ "type": "string"
+ },
+ "include_brand_guidelines": {
+ "type": "boolean"
+ },
+ "include_brand_guidelines_include_company": {
+ "type": "boolean"
+ },
+ "include_brand_guidelines_include_company_val": {
+ "type": "string"
+ },
+ "include_brand_guidelines_include_partner": {
+ "type": "boolean"
+ },
+ "include_brand_guidelines_include_partner_val": {
+ "type": "string"
+ },
+ "include_covered_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_company_claims": {
+ "type": "string"
+ },
+ "include_covered_claims_include_company_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_include_partner_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_partner_claims": {
+ "type": "string"
+ },
+ "include_dpa": {
+ "type": "boolean"
+ },
+ "include_dpa_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_dpa_location": {
+ "type": "string"
+ },
+ "include_dpa_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_increased_cap_amount": {
+ "type": "boolean"
+ },
+ "include_increased_cap_amount_currency": {
+ "type": "number"
+ },
+ "include_increased_cap_amount_either_currency": {
+ "type": "number"
+ },
+ "include_increased_cap_amount_either_multiple": {
+ "type": "string"
+ },
+ "include_increased_cap_amount_multiple": {
+ "type": "string"
+ },
+ "include_increased_cap_amount_type": {
+ "enum": [
+ "multiple",
+ "currency",
+ "either"
+ ],
+ "type": "string"
+ },
+ "include_increased_claims": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_confidentiality": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_confidentiality_misconduct": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_covered_claims": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_misconduct": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_other": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_other_val": {
+ "type": "string"
+ },
+ "include_unlimited_claims": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_confidentiality": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_confidentiality_misconduct": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_covered_claims": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_misconduct": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_other": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_other_val": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "partnership_business_terms_attributes": {
+ "additionalProperties": false,
+ "description": "Override partnership business terms terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "end_date_after_effective_date_amount": {
+ "type": "number"
+ },
+ "end_date_after_effective_date_unit": {
+ "enum": [
+ "month(s)",
+ "quarter(s)",
+ "year(s)"
+ ],
+ "type": "string"
+ },
+ "end_date_date": {
+ "type": "string"
+ },
+ "end_date_type": {
+ "enum": [
+ "date",
+ "effective date"
+ ],
+ "type": "string"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_obligations_company_brand": {
+ "type": "boolean"
+ },
+ "include_obligations_company_promotion": {
+ "type": "boolean"
+ },
+ "include_obligations_company_promotion_include_activities": {
+ "type": "boolean"
+ },
+ "include_obligations_company_promotion_include_activities_val": {
+ "type": "string"
+ },
+ "include_obligations_company_promotion_include_materials": {
+ "type": "boolean"
+ },
+ "include_obligations_company_promotion_include_materials_val": {
+ "type": "string"
+ },
+ "include_obligations_company_referral": {
+ "type": "boolean"
+ },
+ "include_obligations_company_referral_include_criteria": {
+ "type": "boolean"
+ },
+ "include_obligations_company_referral_include_criteria_val": {
+ "type": "string"
+ },
+ "include_obligations_company_referral_include_pay_sch": {
+ "type": "boolean"
+ },
+ "include_obligations_company_referral_include_pay_sch_amount": {
+ "type": "number"
+ },
+ "include_obligations_company_referral_include_pay_sch_custom": {
+ "type": "string"
+ },
+ "include_obligations_company_referral_include_pay_sch_unit": {
+ "enum": [
+ "U.S. Dollars",
+ "percent"
+ ],
+ "type": "string"
+ },
+ "include_obligations_company_sponsorship": {
+ "type": "boolean"
+ },
+ "include_obligations_company_sponsorship_include_benefits": {
+ "type": "boolean"
+ },
+ "include_obligations_company_sponsorship_include_benefits_val": {
+ "type": "string"
+ },
+ "include_obligations_company_sponsorship_include_payments": {
+ "type": "boolean"
+ },
+ "include_obligations_company_sponsorship_include_payments_amount": {
+ "type": "number"
+ },
+ "include_obligations_company_sponsorship_include_payments_unit": {
+ "enum": [
+ "U.S. Dollars",
+ "percent"
+ ],
+ "type": "string"
+ },
+ "include_obligations_partner_brand": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_promotion": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_promotion_include_activities": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_promotion_include_activities_val": {
+ "type": "string"
+ },
+ "include_obligations_partner_promotion_include_materials": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_promotion_include_materials_val": {
+ "type": "string"
+ },
+ "include_obligations_partner_referral": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_referral_include_criteria": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_referral_include_criteria_val": {
+ "type": "string"
+ },
+ "include_obligations_partner_referral_include_pay_sch": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_referral_include_pay_sch_amount": {
+ "type": "number"
+ },
+ "include_obligations_partner_referral_include_pay_sch_custom": {
+ "type": "string"
+ },
+ "include_obligations_partner_referral_include_pay_sch_unit": {
+ "enum": [
+ "U.S. Dollars",
+ "percent"
+ ],
+ "type": "string"
+ },
+ "include_obligations_partner_sponsorship": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_sponsorship_include_benefits": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_sponsorship_include_benefits_val": {
+ "type": "string"
+ },
+ "include_obligations_partner_sponsorship_include_payments": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_sponsorship_include_payments_amount": {
+ "type": "number"
+ },
+ "include_obligations_partner_sponsorship_include_payments_unit": {
+ "enum": [
+ "U.S. Dollars",
+ "percent"
+ ],
+ "type": "string"
+ },
+ "include_payment_process": {
+ "type": "boolean"
+ },
+ "include_payment_process_company": {
+ "type": "boolean"
+ },
+ "include_payment_process_company_include_address": {
+ "type": "boolean"
+ },
+ "include_payment_process_company_include_address_city": {
+ "type": "string"
+ },
+ "include_payment_process_company_include_address_country": {
+ "type": "string"
+ },
+ "include_payment_process_company_include_address_state": {
+ "type": "string"
+ },
+ "include_payment_process_company_include_address_street_address": {
+ "type": "string"
+ },
+ "include_payment_process_company_include_address_zipcode": {
+ "type": "string"
+ },
+ "include_payment_process_company_include_email": {
+ "type": "boolean"
+ },
+ "include_payment_process_company_include_email_val": {
+ "type": "string"
+ },
+ "include_payment_process_partner": {
+ "type": "boolean"
+ },
+ "include_payment_process_partner_include_address": {
+ "type": "boolean"
+ },
+ "include_payment_process_partner_include_address_city": {
+ "type": "string"
+ },
+ "include_payment_process_partner_include_address_country": {
+ "type": "string"
+ },
+ "include_payment_process_partner_include_address_state": {
+ "type": "string"
+ },
+ "include_payment_process_partner_include_address_street_address": {
+ "type": "string"
+ },
+ "include_payment_process_partner_include_address_zipcode": {
+ "type": "string"
+ },
+ "include_payment_process_partner_include_email": {
+ "type": "boolean"
+ },
+ "include_payment_process_partner_include_email_val": {
+ "type": "string"
+ },
+ "include_payment_schedule": {
+ "type": "boolean"
+ },
+ "include_payment_schedule_custom": {
+ "type": "string"
+ },
+ "include_payment_schedule_specified_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_payment_schedule_specified_timeframe": {
+ "enum": [
+ "receipt",
+ "date"
+ ],
+ "type": "string"
+ },
+ "include_payment_schedule_specified_unit": {
+ "enum": [
+ "day(s)",
+ "week(s)",
+ "month(s)",
+ "quarter(s)",
+ "year(s)"
+ ],
+ "type": "string"
+ },
+ "include_payment_schedule_type": {
+ "enum": [
+ "specified",
+ "custom"
+ ],
+ "type": "string"
+ },
+ "negotiations_allowed": {
+ "description": "When true, the recipient can propose changes to the business terms, even when the agreement-level `negotiations_allowed` is false. This only covers the business terms.",
+ "type": "boolean"
+ },
+ "territory_type": {
+ "enum": [
+ "worldwide",
+ "custom"
+ ],
+ "type": "string"
+ },
+ "territory_type_val": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "payment_link_url": {
+ "description": "A payment URL shown to the recipient after signing. Requires include_billing_workflow to be true and billing_workflow_type to be \"link\".",
+ "type": "string"
+ },
+ "pilot_attributes": {
+ "additionalProperties": false,
+ "description": "Override pilot terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "fees_type": {
+ "enum": [
+ "free",
+ "pilot_period_fees"
+ ],
+ "type": "string"
+ },
+ "general_cap_amount": {
+ "type": "number"
+ },
+ "general_cap_amount_type": {
+ "enum": [
+ "preceding",
+ "base",
+ "period"
+ ],
+ "type": "string"
+ },
+ "general_cap_period_currency": {
+ "type": "number"
+ },
+ "general_cap_period_qty": {
+ "type": "number"
+ },
+ "general_cap_preceding_amount": {
+ "type": "number"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_dpa": {
+ "type": "boolean"
+ },
+ "include_dpa_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_dpa_location": {
+ "type": "string"
+ },
+ "include_dpa_type": {
+ "enum": [
+ "description",
+ "attachment",
+ "standard"
+ ],
+ "type": "string"
+ },
+ "include_payment_process": {
+ "type": "boolean"
+ },
+ "include_technical_support": {
+ "type": "boolean"
+ },
+ "payment_process_automatic_frequency": {
+ "enum": [
+ "monthly",
+ "quarterly",
+ "annually",
+ "once_per_period"
+ ],
+ "type": "string"
+ },
+ "payment_process_invoice_days": {
+ "type": "number"
+ },
+ "payment_process_invoice_from": {
+ "enum": [
+ "receipt",
+ "date"
+ ],
+ "type": "string"
+ },
+ "payment_process_invoice_timeframe": {
+ "enum": [
+ "days",
+ "weeks",
+ "months",
+ "quarters",
+ "years"
+ ],
+ "type": "string"
+ },
+ "payment_process_type": {
+ "enum": [
+ "automatic",
+ "invoice"
+ ],
+ "type": "string"
+ },
+ "pilot_period_description": {
+ "type": "string"
+ },
+ "pilot_period_fees_description": {
+ "type": "string"
+ },
+ "product_description": {
+ "type": "string"
+ },
+ "technical_support_description": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "psa_attributes": {
+ "additionalProperties": false,
+ "description": "Override psa terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "additional_changes": {
+ "type": "string"
+ },
+ "customer_description": {
+ "type": "string"
+ },
+ "effective_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "effective_date_type": {
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "type": "string"
+ },
+ "general_cap_amount": {
+ "type": "number"
+ },
+ "general_cap_amount_type": {
+ "enum": [
+ "preceding",
+ "base",
+ "period"
+ ],
+ "type": "string"
+ },
+ "general_cap_period_currency": {
+ "type": "number"
+ },
+ "general_cap_period_qty": {
+ "type": "number"
+ },
+ "general_cap_preceding_amount": {
+ "type": "number"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_additional_changes": {
+ "type": "boolean"
+ },
+ "include_additional_warranties": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_by_customer": {
+ "type": "string"
+ },
+ "include_additional_warranties_by_provider": {
+ "type": "string"
+ },
+ "include_additional_warranties_include_by_customer": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_include_by_provider": {
+ "type": "boolean"
+ },
+ "include_covered_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_customer_claims": {
+ "type": "string"
+ },
+ "include_covered_claims_include_customer_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_include_provider_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_provider_claims": {
+ "type": "string"
+ },
+ "include_customer_insurance_min": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_add_provider_com_gen_liability": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_add_provider_cyber_liability": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_add_provider_errors_omissions": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_auto_liability_aggregate": {
+ "type": "number"
+ },
+ "include_customer_insurance_min_auto_liability_minimum": {
+ "type": "number"
+ },
+ "include_customer_insurance_min_cyber_liability_aggregate": {
+ "type": "number"
+ },
+ "include_customer_insurance_min_cyber_liability_minimum": {
+ "type": "number"
+ },
+ "include_customer_insurance_min_employer_liability_aggregate": {
+ "type": "number"
+ },
+ "include_customer_insurance_min_employer_liability_minimum": {
+ "type": "number"
+ },
+ "include_customer_insurance_min_general_liability_aggregate": {
+ "type": "number"
+ },
+ "include_customer_insurance_min_general_liability_minimum": {
+ "type": "number"
+ },
+ "include_customer_insurance_min_include_add_provider": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_include_auto_liability": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_include_cyber_liability": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_include_employer_liability": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_include_general_liability": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_include_workers_comp": {
+ "type": "boolean"
+ },
+ "include_customer_policies": {
+ "type": "boolean"
+ },
+ "include_customer_policies_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_customer_policies_location": {
+ "type": "string"
+ },
+ "include_customer_policies_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_dpa": {
+ "type": "boolean"
+ },
+ "include_dpa_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_dpa_location": {
+ "type": "string"
+ },
+ "include_dpa_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_increased_cap_amount": {
+ "type": "boolean"
+ },
+ "include_increased_claims": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_confidentiality": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_confidentiality_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_privsec": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_privsec_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_other": {
+ "type": "boolean"
+ },
+ "include_increased_claims_indemnification_obligation": {
+ "type": "boolean"
+ },
+ "include_increased_claims_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_other": {
+ "type": "string"
+ },
+ "include_provider_insurance_min": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_add_customer_com_gen_liability": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_add_customer_cyber_liability": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_add_customer_errors_omissions": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_auto_liability_aggregate": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_auto_liability_minimum": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_cyber_liability_aggregate": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_cyber_liability_minimum": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_employer_liability_aggregate": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_employer_liability_minimum": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_general_liability_aggregate": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_general_liability_minimum": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_include_add_customer": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_include_auto_liability": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_include_cyber_liability": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_include_employer_liability": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_include_general_liability": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_include_workers_comp": {
+ "type": "boolean"
+ },
+ "include_publicity_rights": {
+ "type": "boolean"
+ },
+ "include_publicity_rights_type": {
+ "enum": [
+ "public",
+ "non-public"
+ ],
+ "type": "string"
+ },
+ "include_security_policy": {
+ "type": "boolean"
+ },
+ "include_security_policy_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_security_policy_fedramp_auth": {
+ "type": "boolean"
+ },
+ "include_security_policy_hitrust": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_annual_maintenance": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_other": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_other_val": {
+ "type": "string"
+ },
+ "include_security_policy_iso27001": {
+ "type": "boolean"
+ },
+ "include_security_policy_location": {
+ "type": "string"
+ },
+ "include_security_policy_pci1": {
+ "type": "boolean"
+ },
+ "include_security_policy_pci2": {
+ "type": "boolean"
+ },
+ "include_security_policy_penetration_testing": {
+ "type": "boolean"
+ },
+ "include_security_policy_soc2_type1": {
+ "type": "boolean"
+ },
+ "include_security_policy_soc2_type2": {
+ "type": "boolean"
+ },
+ "include_security_policy_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_unlimited_claims": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_confidentiality": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_confidentiality_negligence": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_privsec": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_privsec_negligence": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_include_other": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_indemnification_obligation": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_negligence": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_other": {
+ "type": "string"
+ },
+ "increased_cap_amount_currency": {
+ "type": "number"
+ },
+ "increased_cap_amount_period_currency": {
+ "type": "number"
+ },
+ "increased_cap_amount_period_qty": {
+ "type": "number"
+ },
+ "increased_cap_amount_qty": {
+ "type": "number"
+ },
+ "increased_cap_amount_type": {
+ "enum": [
+ "qty",
+ "currency",
+ "period"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "psa_statement_of_work_attributes": {
+ "additionalProperties": false,
+ "description": "Override psa statement of work terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "additional_changes": {
+ "type": "string"
+ },
+ "cost": {
+ "type": "number"
+ },
+ "description": {
+ "type": "string"
+ },
+ "fee_type": {
+ "type": "string"
+ },
+ "fees_attributes": {
+ "additionalProperties": {
+ "anyOf": [
+ {
+ "additionalProperties": false,
+ "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": "string"
+ },
+ "include_deliverables": {
+ "type": "boolean"
+ },
+ "include_deliverables_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_deliverables_description": {
+ "type": "string"
+ },
+ "include_deliverables_include_acceptance": {
+ "type": "boolean"
+ },
+ "include_deliverables_include_attachment": {
+ "type": "boolean"
+ },
+ "include_deliverables_include_draft_deliverables": {
+ "type": "boolean"
+ },
+ "include_deliverables_rejection_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_deliverables_rejection_unit": {
+ "enum": [
+ "hours",
+ "days",
+ "weeks",
+ "months"
+ ],
+ "type": "string"
+ },
+ "include_deliverables_resubmission_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_deliverables_resubmission_unit": {
+ "enum": [
+ "hours",
+ "days",
+ "weeks",
+ "months"
+ ],
+ "type": "string"
+ },
+ "include_fees_other": {
+ "type": "boolean"
+ },
+ "include_fees_other_val": {
+ "type": "string"
+ },
+ "include_fees_table": {
+ "type": "boolean"
+ },
+ "include_fees_table_total": {
+ "type": "boolean"
+ },
+ "include_fees_travel": {
+ "type": "boolean"
+ },
+ "include_fees_travel_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_fees_travel_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_fees_travel_val": {
+ "type": "string"
+ },
+ "include_third_party_customer": {
+ "type": "boolean"
+ },
+ "include_third_party_include_description": {
+ "type": "boolean"
+ },
+ "include_third_party_include_description_val": {
+ "type": "string"
+ },
+ "include_third_party_materials": {
+ "type": "boolean"
+ },
+ "include_third_party_provider": {
+ "type": "boolean"
+ },
+ "include_time_of_assignment": {
+ "type": "boolean"
+ },
+ "include_time_of_assignment_type": {
+ "enum": [
+ "created",
+ "paid"
+ ],
+ "type": "string"
+ },
+ "invoice_period_description": {
+ "type": "string"
+ },
+ "negotiations_allowed": {
+ "description": "When true, the recipient can propose changes to the statement of work, even when the agreement-level `negotiations_allowed` is false. This only covers the statement of work.",
+ "type": "boolean"
+ },
+ "payment_period": {
+ "type": "number"
+ },
+ "payment_period_other": {
+ "type": "string"
+ },
+ "payment_period_timeframe": {
+ "enum": [
+ "receipt",
+ "invoice",
+ "Customer's receipt of invoice",
+ "date of invoice"
+ ],
+ "type": "string"
+ },
+ "payment_period_type": {
+ "enum": [
+ "standard",
+ "other"
+ ],
+ "type": "string"
+ },
+ "payment_period_unit": {
+ "enum": [
+ "day(s)",
+ "week(s)",
+ "month(s)",
+ "quarter(s)",
+ "year(s)"
+ ],
+ "type": "string"
+ },
+ "quantity": {
+ "type": "number"
+ },
+ "services_description": {
+ "type": "string"
+ },
+ "sow_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "sow_date_type": {
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "type": "string"
+ },
+ "sow_term_amount": {
+ "type": "number"
+ },
+ "sow_term_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "sow_term_type": {
+ "enum": [
+ "deliverables",
+ "period",
+ "date"
+ ],
+ "type": "string"
+ },
+ "sow_term_unit": {
+ "enum": [
+ "month(s)",
+ "quarter(s)",
+ "year(s)"
+ ],
+ "type": "string"
+ },
+ "type": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "recipient_email": {
+ "format": "email",
+ "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-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_last_to_sign": {
+ "description": "When true, your signer signs after the recipient.",
+ "type": "boolean"
+ },
+ "sender_notice_email_address": {
+ "description": "Email address for legal notices to the sender.",
+ "format": "email",
+ "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-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": {
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "type": "string"
+ },
+ "general_cap_amount": {
+ "type": "number"
+ },
+ "general_cap_amount_type": {
+ "enum": [
+ "preceding",
+ "base",
+ "period"
+ ],
+ "type": "string"
+ },
+ "general_cap_period_currency": {
+ "type": "number"
+ },
+ "general_cap_period_qty": {
+ "type": "number"
+ },
+ "general_cap_preceding_amount": {
+ "type": "number"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_additional_warranties": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_by_customer": {
+ "type": "string"
+ },
+ "include_additional_warranties_by_provider": {
+ "type": "string"
+ },
+ "include_additional_warranties_include_by_customer": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_include_by_provider": {
+ "type": "boolean"
+ },
+ "include_ai_addendum": {
+ "type": "boolean"
+ },
+ "include_ai_addendum_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_covered_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_customer_claims": {
+ "type": "string"
+ },
+ "include_covered_claims_include_customer_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_include_provider_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_provider_claims": {
+ "type": "string"
+ },
+ "include_dpa": {
+ "type": "boolean"
+ },
+ "include_dpa_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_dpa_location": {
+ "type": "string"
+ },
+ "include_dpa_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_increased_cap_amount": {
+ "type": "boolean"
+ },
+ "include_increased_claims": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_confidentiality": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_confidentiality_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_other": {
+ "type": "boolean"
+ },
+ "include_increased_claims_indemnification_obligation": {
+ "type": "boolean"
+ },
+ "include_increased_claims_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_other": {
+ "type": "string"
+ },
+ "include_increased_claims_restrictions": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_confidentiality": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_confidentiality_negligence": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_include_other": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_indemnification_obligation": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_license_or_restrictions": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_negligence": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_other": {
+ "type": "string"
+ },
+ "increased_cap_amount_currency": {
+ "type": "number"
+ },
+ "increased_cap_amount_period_currency": {
+ "type": "number"
+ },
+ "increased_cap_amount_period_qty": {
+ "type": "number"
+ },
+ "increased_cap_amount_qty": {
+ "type": "number"
+ },
+ "increased_cap_amount_type": {
+ "enum": [
+ "qty",
+ "currency",
+ "period"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "software_license_order_form_attributes": {
+ "additionalProperties": false,
+ "description": "Override software license order form terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "additional_changes": {
+ "type": "string"
+ },
+ "deletion_procedure_include_custom": {
+ "type": "boolean"
+ },
+ "deletion_procedure_include_custom_description": {
+ "type": "string"
+ },
+ "deletion_procedure_include_customer_disable": {
+ "type": "boolean"
+ },
+ "deletion_procedure_include_customer_proof": {
+ "type": "boolean"
+ },
+ "deletion_procedure_include_provider_disable": {
+ "type": "boolean"
+ },
+ "fee_custom_unit": {
+ "type": "string"
+ },
+ "fee_period": {
+ "enum": [
+ "Subscription Period",
+ "month",
+ "year",
+ "Custom unit"
+ ],
+ "type": "string"
+ },
+ "fees_attributes": {
+ "additionalProperties": {
+ "anyOf": [
+ {
+ "additionalProperties": false,
+ "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": {
+ "enum": [
+ "USD",
+ "EUR",
+ "GBP",
+ "CAD",
+ "AUD",
+ "SGD",
+ "ILS",
+ "JPY",
+ "CHF",
+ "HKD"
+ ],
+ "type": "string"
+ },
+ "fees_include_fee_increase_upon_renewal": {
+ "type": "boolean"
+ },
+ "fees_include_fee_increase_upon_renewal_fee": {
+ "type": "number"
+ },
+ "fees_include_fee_increase_upon_renewal_type": {
+ "enum": [
+ "will",
+ "may"
+ ],
+ "type": "string"
+ },
+ "fees_inclusive_of_taxes": {
+ "type": "boolean"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_additional_changes": {
+ "type": "boolean"
+ },
+ "include_license_compliance_verification": {
+ "type": "boolean"
+ },
+ "include_license_compliance_verification_description": {
+ "type": "string"
+ },
+ "include_license_limits": {
+ "type": "boolean"
+ },
+ "include_license_limits_description": {
+ "type": "string"
+ },
+ "include_payment_process_include_billing_email": {
+ "type": "boolean"
+ },
+ "include_pilot_period": {
+ "type": "boolean"
+ },
+ "include_pilot_period_duration_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_pilot_period_duration_type": {
+ "enum": [
+ "day",
+ "week",
+ "month"
+ ],
+ "type": "string"
+ },
+ "include_pilot_period_include_fees": {
+ "type": "boolean"
+ },
+ "include_pilot_period_include_fees_amount": {
+ "type": "number"
+ },
+ "include_pilot_period_include_modifications": {
+ "type": "boolean"
+ },
+ "include_pilot_period_include_modifications_description": {
+ "type": "string"
+ },
+ "include_services": {
+ "type": "boolean"
+ },
+ "include_services_description": {
+ "type": "string"
+ },
+ "negotiations_allowed": {
+ "description": "When true, the recipient can propose changes to the order form, even when the agreement-level `negotiations_allowed` is false. This only covers the order form.",
+ "type": "boolean"
+ },
+ "order_date_date": {
+ "type": "string"
+ },
+ "order_date_type": {
+ "enum": [
+ "signature",
+ "date",
+ "other"
+ ],
+ "type": "string"
+ },
+ "payment_process_automatic_frequency": {
+ "enum": [
+ "monthly",
+ "quarterly",
+ "semiannually",
+ "annually"
+ ],
+ "type": "string"
+ },
+ "payment_process_type": {
+ "enum": [
+ "automatic",
+ "invoice",
+ "custom"
+ ],
+ "type": "string"
+ },
+ "payment_process_type_custom_val": {
+ "type": "string"
+ },
+ "payment_process_type_invoice_amount": {
+ "type": "number"
+ },
+ "payment_process_type_invoice_custom_unit": {
+ "type": "string"
+ },
+ "payment_process_type_invoice_duration": {
+ "enum": [
+ "day",
+ "week",
+ "month",
+ "year",
+ "day(s)",
+ "week(s)",
+ "month(s)",
+ "year(s)"
+ ],
+ "type": "string"
+ },
+ "payment_process_type_invoice_duration_start": {
+ "enum": [
+ "Customer's receipt of invoice",
+ "date of invoice"
+ ],
+ "type": "string"
+ },
+ "payment_process_type_invoice_type": {
+ "enum": [
+ "monthly",
+ "quarterly",
+ "semiannually",
+ "annually",
+ "Custom unit"
+ ],
+ "type": "string"
+ },
+ "permitted_uses_include_custom": {
+ "type": "boolean"
+ },
+ "permitted_uses_include_custom_description": {
+ "type": "string"
+ },
+ "permitted_uses_include_customers_affiliates": {
+ "type": "boolean"
+ },
+ "permitted_uses_include_internal_business": {
+ "type": "boolean"
+ },
+ "pilot_period_stripe_product_id": {
+ "type": "string"
+ },
+ "software_description": {
+ "type": "string"
+ },
+ "subscription_auto_renew": {
+ "enum": [
+ "days",
+ "subscription_end"
+ ],
+ "type": "string"
+ },
+ "subscription_period": {
+ "type": "number"
+ },
+ "subscription_period_unit": {
+ "type": "string"
+ },
+ "subscription_renewal_notice_days": {
+ "type": "number"
+ },
+ "warranty_period_description_amount": {
+ "type": "number"
+ },
+ "warranty_period_description_duration": {
+ "enum": [
+ "day",
+ "week",
+ "month",
+ "year"
+ ],
+ "type": "string"
+ },
+ "warranty_period_description_duration_start": {
+ "enum": [
+ "initial delivery of the Software",
+ "delivery of the Software and each subsequent Update",
+ "the Order Date"
+ ],
+ "type": "string"
+ },
+ "warranty_period_type": {
+ "enum": [
+ "description",
+ "none"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "test_agreement": {
+ "description": "When true, marks the agreement as a test. Test agreements do not count against your monthly limit.",
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "recipient_name",
+ "recipient_email"
+ ],
+ "type": "object"
+ },
+ "cc_users": {
+ "items": {
+ "format": "email",
+ "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-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.",
- "enum": [
- "signature",
- "date"
- ],
- "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.",
- "enum": [
- "signature",
- "date"
- ],
- "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.",
- "enum": [
- "signature",
- "date"
- ],
- "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.",
- "enum": [
- "signature",
- "date"
- ],
- "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.",
- "enum": [
- "signature",
- "date"
- ],
- "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.",
- "enum": [
- "signature",
- "date"
- ],
- "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.",
- "enum": [
- "signature",
- "date"
- ],
- "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.",
- "enum": [
- "signature",
- "date"
- ],
- "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.",
- "enum": [
- "signature",
- "date"
- ],
- "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.",
- "enum": [
- "signature",
- "date"
- ],
- "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.",
- "enum": [
- "signature",
- "date"
- ],
- "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.",
- "enum": [
- "signature",
- "date"
- ],
- "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"
- }
-]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.",
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "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"
+ },
+ "include_terms": {
+ "description": "When true, the standard terms are included 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 to the legal terms. For agreement types without separate business terms, that covers every term. CSA order forms, PSA statements of work, partnership business terms and software license order forms have their own `negotiations_allowed` flag.",
+ "type": "boolean"
+ },
+ "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.",
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "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"
+ },
+ "include_terms": {
+ "description": "When true, the standard terms are included 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 to the legal terms. For agreement types without separate business terms, that covers every term. CSA order forms, PSA statements of work, partnership business terms and software license order forms have their own `negotiations_allowed` flag.",
+ "type": "boolean"
+ },
+ "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.",
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "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"
+ },
+ "include_terms": {
+ "description": "When true, the standard terms are included 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 to the legal terms. For agreement types without separate business terms, that covers every term. CSA order forms, PSA statements of work, partnership business terms and software license order forms have their own `negotiations_allowed` flag.",
+ "type": "boolean"
+ },
+ "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.",
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "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"
+ },
+ "include_terms": {
+ "description": "When true, the standard terms are included 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 to the legal terms. For agreement types without separate business terms, that covers every term. CSA order forms, PSA statements of work, partnership business terms and software license order forms have their own `negotiations_allowed` flag.",
+ "type": "boolean"
+ },
+ "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.",
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "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"
+ },
+ "include_terms": {
+ "description": "When true, the standard terms are included 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 to the legal terms. For agreement types without separate business terms, that covers every term. CSA order forms, PSA statements of work, partnership business terms and software license order forms have their own `negotiations_allowed` flag.",
+ "type": "boolean"
+ },
+ "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.",
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "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"
+ },
+ "include_terms": {
+ "description": "When true, the standard terms are included 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 to the legal terms. For agreement types without separate business terms, that covers every term. CSA order forms, PSA statements of work, partnership business terms and software license order forms have their own `negotiations_allowed` flag.",
+ "type": "boolean"
+ },
+ "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.",
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "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"
+ },
+ "include_terms": {
+ "description": "When true, the standard terms are included 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 to the legal terms. For agreement types without separate business terms, that covers every term. CSA order forms, PSA statements of work, partnership business terms and software license order forms have their own `negotiations_allowed` flag.",
+ "type": "boolean"
+ },
+ "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.",
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "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"
+ },
+ "include_terms": {
+ "description": "When true, the standard terms are included 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 to the legal terms. For agreement types without separate business terms, that covers every term. CSA order forms, PSA statements of work, partnership business terms and software license order forms have their own `negotiations_allowed` flag.",
+ "type": "boolean"
+ },
+ "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.",
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "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"
+ },
+ "include_terms": {
+ "description": "When true, the standard terms are included 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 to the legal terms. For agreement types without separate business terms, that covers every term. CSA order forms, PSA statements of work, partnership business terms and software license order forms have their own `negotiations_allowed` flag.",
+ "type": "boolean"
+ },
+ "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.",
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "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"
+ },
+ "include_terms": {
+ "description": "When true, the standard terms are included 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 to the legal terms. For agreement types without separate business terms, that covers every term. CSA order forms, PSA statements of work, partnership business terms and software license order forms have their own `negotiations_allowed` flag.",
+ "type": "boolean"
+ },
+ "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.",
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "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"
+ },
+ "include_terms": {
+ "description": "When true, the standard terms are included 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 to the legal terms. For agreement types without separate business terms, that covers every term. CSA order forms, PSA statements of work, partnership business terms and software license order forms have their own `negotiations_allowed` flag.",
+ "type": "boolean"
+ },
+ "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.",
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "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"
+ },
+ "include_terms": {
+ "description": "When true, the standard terms are included 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 to the legal terms. For agreement types without separate business terms, that covers every term. CSA order forms, PSA statements of work, partnership business terms and software license order forms have their own `negotiations_allowed` flag.",
+ "type": "boolean"
+ },
+ "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"
+ }
+]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": {
- "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"
- }
-]New value: +[
+ {
+ "additionalProperties": false,
+ "properties": {
+ "agreement": {
+ "additionalProperties": {},
+ "properties": {
+ "amendment_attributes": {
+ "additionalProperties": false,
+ "description": "Override amendment terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "amended_terms_attributes": {
+ "additionalProperties": {
+ "additionalProperties": false,
+ "properties": {
+ "description": {
+ "type": "string"
+ },
+ "term": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "description": "Amended terms. Use string keys such as \"0\", \"1\".",
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+ },
+ "amendment_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "amendment_date_type": {
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "type": "string"
+ },
+ "framework_terms_type": {
+ "type": "string"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "parent_agreement_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "underlying_agreement_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "underlying_agreement_type": {
+ "type": "string"
+ },
+ "underlying_agreement_val": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "baa_attributes": {
+ "additionalProperties": false,
+ "description": "Override baa terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "aggregation_limitations_permitted": {
+ "type": "boolean"
+ },
+ "aggregation_limitations_permitted_val": {
+ "type": "string"
+ },
+ "breach_notification_unit": {
+ "enum": [
+ "hours",
+ "business days",
+ "calendar days"
+ ],
+ "type": "string"
+ },
+ "breach_notification_val": {
+ "type": "number"
+ },
+ "business_associate_relationship_type": {
+ "enum": [
+ "provider",
+ "company"
+ ],
+ "type": "string"
+ },
+ "deidentification_limitations_include_purpose": {
+ "type": "boolean"
+ },
+ "deidentification_limitations_include_requirements": {
+ "type": "boolean"
+ },
+ "deidentification_limitations_permitted": {
+ "type": "boolean"
+ },
+ "deidentification_limitations_purpose_val": {
+ "type": "string"
+ },
+ "deidentification_limitations_requirements_val": {
+ "type": "string"
+ },
+ "designated_record_set_provider_maintains": {
+ "type": "boolean"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_aggregation_limitations": {
+ "type": "boolean"
+ },
+ "include_deidentification_limitations": {
+ "type": "boolean"
+ },
+ "include_limitations": {
+ "type": "boolean"
+ },
+ "include_offshore_limitations": {
+ "type": "boolean"
+ },
+ "include_subcontract_limitations": {
+ "type": "boolean"
+ },
+ "offshore_limitations_permitted": {
+ "type": "boolean"
+ },
+ "offshore_limitations_permitted_val": {
+ "type": "string"
+ },
+ "subcontract_limitations_include_notice": {
+ "type": "boolean"
+ },
+ "subcontract_limitations_include_permission": {
+ "type": "boolean"
+ },
+ "subcontract_limitations_notice_val": {
+ "type": "string"
+ },
+ "subcontract_limitations_permission_val": {
+ "type": "string"
+ },
+ "subcontract_limitations_permitted": {
+ "type": "boolean"
+ },
+ "underlying_agreement_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "underlying_agreement_type": {
+ "enum": [
+ "internal",
+ "external",
+ "none"
+ ],
+ "type": "string"
+ },
+ "underlying_agreement_val": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "billing_email": {
+ "description": "Email of the billing contact. Used when include_billing_info is true.",
+ "format": "email",
+ "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-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": {
+ "enum": [
+ "AWS",
+ "GCP",
+ "Azure"
+ ],
+ "type": "string"
+ },
+ "effective_date_type": {
+ "enum": [
+ "signature",
+ "date",
+ "marketplace_acceptance"
+ ],
+ "type": "string"
+ },
+ "general_cap_amount": {
+ "type": "number"
+ },
+ "general_cap_amount_type": {
+ "enum": [
+ "preceding",
+ "base",
+ "period"
+ ],
+ "type": "string"
+ },
+ "general_cap_period_currency": {
+ "type": "number"
+ },
+ "general_cap_period_qty": {
+ "type": "number"
+ },
+ "general_cap_preceding_amount": {
+ "type": "number"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_acceptable_use_policy": {
+ "type": "boolean"
+ },
+ "include_acceptable_use_policy_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_acceptable_use_policy_location": {
+ "type": "string"
+ },
+ "include_acceptable_use_policy_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_additional_warranties": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_by_customer": {
+ "type": "string"
+ },
+ "include_additional_warranties_by_provider": {
+ "type": "string"
+ },
+ "include_additional_warranties_include_by_customer": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_include_by_provider": {
+ "type": "boolean"
+ },
+ "include_ai_addendum": {
+ "type": "boolean"
+ },
+ "include_ai_addendum_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_covered_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_customer_claims": {
+ "type": "string"
+ },
+ "include_covered_claims_include_customer_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_include_provider_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_provider_claims": {
+ "type": "string"
+ },
+ "include_dpa": {
+ "type": "boolean"
+ },
+ "include_dpa_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_dpa_location": {
+ "type": "string"
+ },
+ "include_dpa_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_increased_cap_amount": {
+ "type": "boolean"
+ },
+ "include_increased_claims": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_confidentiality": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_confidentiality_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_privsec": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_privsec_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_other": {
+ "type": "boolean"
+ },
+ "include_increased_claims_indemnification_obligation": {
+ "type": "boolean"
+ },
+ "include_increased_claims_other": {
+ "type": "string"
+ },
+ "include_insurance_minimums": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_add_customer": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_add_customer_com_gen_liability": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_add_customer_cyber_liability": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_add_customer_errors_omissions": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_additional_information": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_additional_information_text": {
+ "type": "string"
+ },
+ "include_insurance_minimums_cyber_liability_aggregate": {
+ "type": "number"
+ },
+ "include_insurance_minimums_cyber_liability_minimum": {
+ "type": "number"
+ },
+ "include_insurance_minimums_employer_liability_aggregate": {
+ "type": "number"
+ },
+ "include_insurance_minimums_employer_liability_minimum": {
+ "type": "number"
+ },
+ "include_insurance_minimums_general_liability_aggregate": {
+ "type": "number"
+ },
+ "include_insurance_minimums_general_liability_minimum": {
+ "type": "number"
+ },
+ "include_insurance_minimums_include_cyber_liability": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_include_employer_liability": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_include_general_liability": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_include_workers_compensation": {
+ "type": "boolean"
+ },
+ "include_publicity_rights": {
+ "type": "boolean"
+ },
+ "include_publicity_rights_type": {
+ "enum": [
+ "public",
+ "non-public"
+ ],
+ "type": "string"
+ },
+ "include_security_policy": {
+ "type": "boolean"
+ },
+ "include_security_policy_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_security_policy_fedramp_auth": {
+ "type": "boolean"
+ },
+ "include_security_policy_hipaa": {
+ "type": "boolean"
+ },
+ "include_security_policy_hitrust": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_annual_maintenance": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_location": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_other": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_reasonable_efforts": {
+ "type": "boolean"
+ },
+ "include_security_policy_iso27001": {
+ "type": "boolean"
+ },
+ "include_security_policy_location": {
+ "type": "string"
+ },
+ "include_security_policy_other": {
+ "type": "string"
+ },
+ "include_security_policy_pci1": {
+ "type": "boolean"
+ },
+ "include_security_policy_pci2": {
+ "type": "boolean"
+ },
+ "include_security_policy_penetration_testing": {
+ "type": "boolean"
+ },
+ "include_security_policy_soc2": {
+ "type": "boolean"
+ },
+ "include_security_policy_soc2_type2": {
+ "type": "boolean"
+ },
+ "include_security_policy_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_supercap": {
+ "description": "CSA 3.0 renamed `include_increased_cap_amount` to `include_supercap`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_increased_cap_amount`. Sending the other spelling returns a 422.",
+ "type": "boolean"
+ },
+ "include_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": "string"
+ },
+ "increased_cap_amount_currency": {
+ "type": "number"
+ },
+ "increased_cap_amount_period_currency": {
+ "type": "number"
+ },
+ "increased_cap_amount_period_qty": {
+ "type": "number"
+ },
+ "increased_cap_amount_qty": {
+ "type": "number"
+ },
+ "increased_cap_amount_type": {
+ "enum": [
+ "qty",
+ "currency",
+ "period"
+ ],
+ "type": "string"
+ },
+ "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": "string"
+ },
+ "affiliates_as_users": {
+ "type": "boolean"
+ },
+ "cloud_service_description": {
+ "type": "string"
+ },
+ "consumption_units": {
+ "type": "string"
+ },
+ "fee_amount": {
+ "type": "number"
+ },
+ "fee_custom_unit": {
+ "type": "string"
+ },
+ "fee_period": {
+ "enum": [
+ "Subscription Period",
+ "month",
+ "year",
+ "User",
+ "Custom unit"
+ ],
+ "type": "string"
+ },
+ "fees_attributes": {
+ "additionalProperties": {
+ "anyOf": [
+ {
+ "additionalProperties": false,
+ "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": {
+ "enum": [
+ "USD",
+ "EUR",
+ "GBP",
+ "CAD",
+ "AUD",
+ "SGD",
+ "ILS",
+ "JPY",
+ "CHF",
+ "HKD"
+ ],
+ "type": "string"
+ },
+ "fees_include_fee_increase_upon_renewal": {
+ "type": "boolean"
+ },
+ "fees_include_fee_increase_upon_renewal_fee": {
+ "type": "number"
+ },
+ "fees_include_fee_increase_upon_renewal_type": {
+ "enum": [
+ "will",
+ "may"
+ ],
+ "type": "string"
+ },
+ "fees_inclusive_of_taxes": {
+ "type": "boolean"
+ },
+ "framework_terms_type": {
+ "enum": [
+ "new",
+ "existing",
+ "description"
+ ],
+ "type": "string"
+ },
+ "free_trial_days": {
+ "type": "number"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_additional_changes": {
+ "type": "boolean"
+ },
+ "include_additional_parameters_or_limitations": {
+ "type": "boolean"
+ },
+ "include_consumption": {
+ "type": "boolean"
+ },
+ "include_fees": {
+ "type": "boolean"
+ },
+ "include_fees_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_fees_include_attachment": {
+ "type": "boolean"
+ },
+ "include_fees_other": {
+ "type": "boolean"
+ },
+ "include_fees_other_val": {
+ "type": "string"
+ },
+ "include_fees_table": {
+ "type": "boolean"
+ },
+ "include_fees_table_period": {
+ "enum": [
+ "Subscription Period",
+ "month",
+ "year",
+ "User"
+ ],
+ "type": "string"
+ },
+ "include_free_trial": {
+ "type": "boolean"
+ },
+ "include_max_users": {
+ "type": "boolean"
+ },
+ "include_pilot_period": {
+ "type": "boolean"
+ },
+ "include_pilot_period_duration_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_pilot_period_duration_type": {
+ "enum": [
+ "day",
+ "week",
+ "month"
+ ],
+ "type": "string"
+ },
+ "include_pilot_period_include_fees": {
+ "type": "boolean"
+ },
+ "include_pilot_period_include_fees_amount": {
+ "type": "number"
+ },
+ "include_pilot_period_include_modifications": {
+ "type": "boolean"
+ },
+ "include_pilot_period_include_modifications_description": {
+ "type": "string"
+ },
+ "include_product_support": {
+ "type": "boolean"
+ },
+ "include_product_support_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_product_support_description": {
+ "type": "string"
+ },
+ "include_product_support_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_professional_services": {
+ "type": "boolean"
+ },
+ "include_professional_services_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_professional_services_custom_name": {
+ "type": "string"
+ },
+ "include_professional_services_description": {
+ "type": "string"
+ },
+ "include_professional_services_end_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "include_professional_services_fees_description": {
+ "type": "string"
+ },
+ "include_professional_services_include_end_date": {
+ "type": "boolean"
+ },
+ "include_professional_services_include_fees_description": {
+ "type": "boolean"
+ },
+ "include_professional_services_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_sla": {
+ "type": "boolean"
+ },
+ "include_sla_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_sla_description": {
+ "type": "string"
+ },
+ "include_sla_include_response_time": {
+ "type": "boolean"
+ },
+ "include_sla_include_response_time_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_sla_include_response_time_credit": {
+ "type": "number"
+ },
+ "include_sla_include_response_time_duration": {
+ "enum": [
+ "hour",
+ "day",
+ "week",
+ "month",
+ "hours"
+ ],
+ "type": "string"
+ },
+ "include_sla_include_response_time_support_channel": {
+ "type": "string"
+ },
+ "include_sla_include_target_uptime": {
+ "type": "boolean"
+ },
+ "include_sla_maintenance_notice": {
+ "type": "boolean"
+ },
+ "include_sla_maintenance_window": {
+ "type": "boolean"
+ },
+ "include_sla_maintenance_window_type": {
+ "enum": [
+ "standard",
+ "none"
+ ],
+ "type": "string"
+ },
+ "include_sla_standard_maintenance_notice_qty": {
+ "type": "number"
+ },
+ "include_sla_standard_maintenance_notice_unit": {
+ "enum": [
+ "hour",
+ "day",
+ "week",
+ "month"
+ ],
+ "type": "string"
+ },
+ "include_sla_standard_maintenance_window_end_time": {
+ "type": "string"
+ },
+ "include_sla_standard_maintenance_window_friday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_monday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_saturday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_start_time": {
+ "type": "string"
+ },
+ "include_sla_standard_maintenance_window_sunday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_thursday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_time_zone": {
+ "type": "string"
+ },
+ "include_sla_standard_maintenance_window_tuesday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_wednesday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_target_uptime": {
+ "type": "number"
+ },
+ "include_sla_type": {
+ "enum": [
+ "description",
+ "standard",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_subscription_start_date": {
+ "type": "boolean"
+ },
+ "include_subscription_start_date_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "include_usage_review": {
+ "type": "boolean"
+ },
+ "include_usage_review_val": {
+ "type": "string"
+ },
+ "include_use_limitations": {
+ "type": "boolean"
+ },
+ "include_use_limitations_val": {
+ "type": "string"
+ },
+ "invoice_period": {
+ "enum": [
+ "monthly",
+ "quarterly",
+ "semiannually",
+ "annually",
+ "Custom unit",
+ "Monthly",
+ "Quarterly",
+ "Semiannually",
+ "Annually"
+ ],
+ "type": "string"
+ },
+ "invoice_period_custom_unit": {
+ "type": "string"
+ },
+ "max_consumption": {
+ "type": "number"
+ },
+ "max_users": {
+ "type": "number"
+ },
+ "negotiations_allowed": {
+ "type": "boolean"
+ },
+ "order_date_date": {
+ "type": "string"
+ },
+ "order_date_other": {
+ "type": "string"
+ },
+ "order_date_type": {
+ "enum": [
+ "signature",
+ "date",
+ "other"
+ ],
+ "type": "string"
+ },
+ "payment_period": {
+ "type": "number"
+ },
+ "payment_period_timeframe": {
+ "enum": [
+ "Customer's receipt of invoice",
+ "date of invoice"
+ ],
+ "type": "string"
+ },
+ "payment_period_unit": {
+ "enum": [
+ "day(s)",
+ "week(s)",
+ "month(s)",
+ "marketplace_acceptance"
+ ],
+ "type": "string"
+ },
+ "payment_process_automatic_frequency": {
+ "enum": [
+ "monthly",
+ "quarterly",
+ "semiannually",
+ "annually"
+ ],
+ "type": "string"
+ },
+ "payment_process_type": {
+ "enum": [
+ "automatic",
+ "invoice",
+ "custom",
+ "marketplace_acceptance"
+ ],
+ "type": "string"
+ },
+ "payment_process_type_custom_val": {
+ "type": "string"
+ },
+ "payment_process_type_invoice_amount": {
+ "type": "number"
+ },
+ "payment_process_type_invoice_custom_unit": {
+ "type": "string"
+ },
+ "payment_process_type_invoice_duration": {
+ "enum": [
+ "day",
+ "week",
+ "month",
+ "year",
+ "day(s)",
+ "week(s)",
+ "month(s)",
+ "year(s)"
+ ],
+ "type": "string"
+ },
+ "payment_process_type_invoice_duration_start": {
+ "enum": [
+ "Customer's receipt of invoice",
+ "date of invoice"
+ ],
+ "type": "string"
+ },
+ "payment_process_type_invoice_type": {
+ "enum": [
+ "monthly",
+ "quarterly",
+ "semiannually",
+ "annually",
+ "Custom unit"
+ ],
+ "type": "string"
+ },
+ "pilot_period_stripe_product_id": {
+ "type": "string"
+ },
+ "service_credits_attributes": {
+ "additionalProperties": {
+ "additionalProperties": false,
+ "properties": {
+ "credit": {
+ "type": "number"
+ },
+ "max": {
+ "type": "number"
+ },
+ "min": {
+ "type": "number"
+ }
+ },
+ "type": "object"
+ },
+ "description": "Service credits. Use string keys such as \"0\", \"1\".",
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+ },
+ "subscription_auto_renew": {
+ "enum": [
+ "days",
+ "subscription_end"
+ ],
+ "type": "string"
+ },
+ "subscription_period": {
+ "type": "number"
+ },
+ "subscription_period_unit": {
+ "type": "string"
+ },
+ "subscription_renewal_notice_days": {
+ "type": "number"
+ },
+ "subscription_start_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "subscription_start_date_type": {
+ "enum": [
+ "effective_date",
+ "date"
+ ],
+ "type": "string"
+ },
+ "underlying_agreement_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "use_limitations_attributes": {
+ "additionalProperties": {
+ "additionalProperties": false,
+ "properties": {
+ "amount": {
+ "type": "number"
+ },
+ "limitation_type": {
+ "type": "string"
+ },
+ "unit": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "description": "Use limitations. Use string keys such as \"0\", \"1\".",
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+ }
+ },
+ "type": "object"
+ },
+ "custom_field_values": {
+ "description": "Values for a custom template's fields, keyed by the field keys defined in the template's YAML definition. Only used when template_id is a custom template. Template defaults fill any fields you omit; a required field with no default and no submitted value returns a 400 naming the field. Values are validated against the field's input type: select and radio values must be one of the field's options, multiselect values are an array of selections each of which must be one of the field's options, number and currency values must be numeric, date values must be YYYY-MM-DD, and email values must be valid addresses. An invalid value returns a 400 naming the field."
+ },
+ "design_partner_attributes": {
+ "additionalProperties": false,
+ "description": "Override design partner terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "customer_description": {
+ "type": "string"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_fees": {
+ "type": "boolean"
+ },
+ "include_fees_amount": {
+ "type": "number"
+ },
+ "include_fees_description": {
+ "type": "string"
+ },
+ "include_fees_pay_by_amount": {
+ "type": "string"
+ },
+ "include_fees_type": {
+ "enum": [
+ "default_language",
+ "description"
+ ],
+ "type": "string"
+ },
+ "include_fees_unit": {
+ "enum": [
+ "month",
+ "quarter",
+ "year",
+ "Term"
+ ],
+ "type": "string"
+ },
+ "include_program_appear_as_customer_private": {
+ "type": "boolean"
+ },
+ "include_program_appear_as_customer_public": {
+ "type": "boolean"
+ },
+ "include_program_case_study": {
+ "type": "boolean"
+ },
+ "include_program_develop_functionality": {
+ "type": "boolean"
+ },
+ "include_program_develop_functionality_val": {
+ "type": "string"
+ },
+ "include_program_discount": {
+ "type": "boolean"
+ },
+ "include_program_discount_amount": {
+ "type": "number"
+ },
+ "include_program_discount_unit": {
+ "enum": [
+ "U.S. Dollars",
+ "percent"
+ ],
+ "type": "string"
+ },
+ "include_program_participation_feedback": {
+ "type": "boolean"
+ },
+ "include_program_participation_feedback_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_program_participation_feedback_unit": {
+ "enum": [
+ "month",
+ "quarter",
+ "year",
+ "Term"
+ ],
+ "type": "string"
+ },
+ "include_program_partner_other": {
+ "type": "boolean"
+ },
+ "include_program_partner_other_val": {
+ "type": "string"
+ },
+ "include_program_provider_other": {
+ "type": "boolean"
+ },
+ "include_program_provider_other_val": {
+ "type": "string"
+ },
+ "include_program_reference": {
+ "type": "boolean"
+ },
+ "product_description": {
+ "type": "string"
+ },
+ "term_amount": {
+ "type": "number"
+ },
+ "term_unit": {
+ "enum": [
+ "day(s)",
+ "week(s)",
+ "month(s)",
+ "quarter(s)",
+ "year(s)"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "district_or_county": {
+ "description": "The district or county for dispute resolution.",
+ "type": "string"
+ },
+ "dpa_attributes": {
+ "additionalProperties": false,
+ "description": "Override dpa terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "approved_subprocessor_type": {
+ "description": "`internal` lists approved subprocessors in the agreement (`subprocessors_attributes`); `external` points to a list published elsewhere.",
+ "enum": [
+ "internal",
+ "external"
+ ],
+ "type": "string"
+ },
+ "cloud_service_product_name": {
+ "type": "string"
+ },
+ "competent_supervisory_authority": {
+ "type": "string"
+ },
+ "customer_description": {
+ "type": "string"
+ },
+ "data_exporter_address_city": {
+ "type": "string"
+ },
+ "data_exporter_address_country": {
+ "type": "string"
+ },
+ "data_exporter_address_state": {
+ "type": "string"
+ },
+ "data_exporter_address_street_address": {
+ "type": "string"
+ },
+ "data_exporter_address_zipcode": {
+ "type": "string"
+ },
+ "data_exporter_contact_details": {
+ "type": "string"
+ },
+ "data_exporter_contact_name": {
+ "type": "string"
+ },
+ "data_exporter_contact_position": {
+ "type": "string"
+ },
+ "data_exporter_role": {
+ "description": "Role of the data exporter. Overwritten to `Controller` when the agreement is created from a template.",
+ "enum": [
+ "Controller",
+ "Processor"
+ ],
+ "type": "string"
+ },
+ "data_importer_address": {
+ "type": "string"
+ },
+ "data_importer_address_city": {
+ "type": "string"
+ },
+ "data_importer_address_country": {
+ "type": "string"
+ },
+ "data_importer_address_state": {
+ "type": "string"
+ },
+ "data_importer_address_street_address": {
+ "type": "string"
+ },
+ "data_importer_address_zipcode": {
+ "type": "string"
+ },
+ "data_importer_contact_details": {
+ "type": "string"
+ },
+ "data_importer_contact_name": {
+ "type": "string"
+ },
+ "data_importer_contact_position": {
+ "type": "string"
+ },
+ "duration_of_processing": {
+ "type": "string"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_covered_claim": {
+ "type": "boolean"
+ },
+ "include_covered_claim_external_val": {
+ "type": "string"
+ },
+ "include_covered_claim_internal_val": {
+ "type": "string"
+ },
+ "include_covered_claim_type": {
+ "description": "Which covered-claim text applies: `internal` uses `include_covered_claim_internal_val`, `external` uses `include_covered_claim_external_val`. Required when `include_covered_claim` is true.",
+ "enum": [
+ "internal",
+ "external"
+ ],
+ "type": "string"
+ },
+ "include_data_subjects_custom": {
+ "type": "boolean"
+ },
+ "include_data_subjects_custom_val": {
+ "type": "string"
+ },
+ "include_data_subjects_employees": {
+ "type": "boolean"
+ },
+ "include_data_subjects_end_users": {
+ "type": "boolean"
+ },
+ "include_external_subprocessor_location": {
+ "type": "string"
+ },
+ "include_frequency_of_transfer_continuous": {
+ "type": "boolean"
+ },
+ "include_frequency_of_transfer_custom": {
+ "type": "boolean"
+ },
+ "include_frequency_of_transfer_custom_val": {
+ "type": "string"
+ },
+ "include_governing_country_eu": {
+ "type": "boolean"
+ },
+ "include_governing_country_eu_val": {
+ "type": "string"
+ },
+ "include_governing_country_uk": {
+ "type": "boolean"
+ },
+ "include_governing_country_uk_val": {
+ "type": "string"
+ },
+ "include_governing_law": {
+ "type": "boolean"
+ },
+ "include_governing_law_country": {
+ "type": "string"
+ },
+ "include_governing_law_state": {
+ "type": "string"
+ },
+ "include_increased_claim_amount": {
+ "description": "Legacy field. Stored but not shown on the DPA; use the `include_liability_cap*` fields instead.",
+ "type": "boolean"
+ },
+ "include_increased_claim_amount_currency": {
+ "description": "Legacy field. Stored but not shown on the DPA; use the `include_liability_cap*` fields instead."
+ },
+ "include_increased_claim_amount_qty": {
+ "description": "Legacy field. Stored but not shown on the DPA; use the `include_liability_cap*` fields instead."
+ },
+ "include_increased_claim_amount_type": {
+ "description": "Legacy field. Stored but not shown on the DPA; use the `include_liability_cap*` fields instead.",
+ "type": "string"
+ },
+ "include_liability_cap": {
+ "type": "boolean"
+ },
+ "include_liability_cap_amount_constant_external": {
+ "type": "string"
+ },
+ "include_liability_cap_amount_constant_internal": {
+ "type": "string"
+ },
+ "include_liability_cap_amount_currency_external": {
+ "description": "Currency amount. Numbers and numeric strings (commas allowed) are both accepted."
+ },
+ "include_liability_cap_amount_currency_internal": {
+ "description": "Currency amount. Numbers and numeric strings (commas allowed) are both accepted."
+ },
+ "include_liability_cap_csa_type": {
+ "description": "Which liability cap values apply: the `_internal` or `_external` amount fields. Required when `include_liability_cap` is true.",
+ "enum": [
+ "internal",
+ "external"
+ ],
+ "type": "string"
+ },
+ "include_personal_data_biographic_info": {
+ "type": "boolean"
+ },
+ "include_personal_data_contact_info": {
+ "type": "boolean"
+ },
+ "include_personal_data_custom": {
+ "type": "boolean"
+ },
+ "include_personal_data_custom_val": {
+ "type": "string"
+ },
+ "include_personal_data_employment_info": {
+ "type": "boolean"
+ },
+ "include_personal_data_financial_info": {
+ "type": "boolean"
+ },
+ "include_personal_data_location": {
+ "type": "boolean"
+ },
+ "include_personal_data_name": {
+ "type": "boolean"
+ },
+ "include_personal_data_transactional_info": {
+ "type": "boolean"
+ },
+ "include_personal_data_user_activity_info": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_custom": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_custom_val": {
+ "type": "string"
+ },
+ "include_processing_purpose_erasing": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_holding": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_protecting": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_receiving": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_returning": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_sharing": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_updating": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_using": {
+ "type": "boolean"
+ },
+ "include_provider_security_contact_address": {
+ "type": "boolean"
+ },
+ "include_provider_security_contact_address_city": {
+ "type": "string"
+ },
+ "include_provider_security_contact_address_country": {
+ "type": "string"
+ },
+ "include_provider_security_contact_address_state": {
+ "type": "string"
+ },
+ "include_provider_security_contact_address_street_address": {
+ "type": "string"
+ },
+ "include_provider_security_contact_address_zipcode": {
+ "type": "string"
+ },
+ "include_provider_security_contact_email": {
+ "type": "boolean"
+ },
+ "include_provider_security_contact_email_val": {
+ "format": "email",
+ "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-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": "boolean"
+ },
+ "confidentiality_nda_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "confidentiality_nda_description": {
+ "type": "string"
+ },
+ "confidentiality_nda_include_loi": {
+ "type": "boolean"
+ },
+ "confidentiality_nda_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "confidentiality_type": {
+ "enum": [
+ "mutual",
+ "nda",
+ "provider",
+ "custom"
+ ],
+ "type": "string"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_custom_details": {
+ "type": "boolean"
+ },
+ "include_custom_details_val": {
+ "type": "string"
+ },
+ "include_fees": {
+ "type": "boolean"
+ },
+ "include_fees_amount": {
+ "type": "number"
+ },
+ "include_fees_amount_duration": {
+ "enum": [
+ "month",
+ "year",
+ "quarter"
+ ],
+ "type": "string"
+ },
+ "include_fees_include_amount": {
+ "type": "boolean"
+ },
+ "include_fees_include_other": {
+ "type": "boolean"
+ },
+ "include_fees_other": {
+ "type": "string"
+ },
+ "include_functionality": {
+ "type": "boolean"
+ },
+ "include_functionality_val": {
+ "type": "string"
+ },
+ "include_launch_date": {
+ "type": "boolean"
+ },
+ "include_launch_date_custom": {
+ "type": "string"
+ },
+ "include_launch_date_date": {
+ "format": "date-time",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$",
+ "type": "string"
+ },
+ "include_launch_date_type": {
+ "enum": [
+ "date",
+ "custom"
+ ],
+ "type": "string"
+ },
+ "product_name": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "manual_send": {
+ "description": "When true, the agreement is marked as manually sent outside the platform.",
+ "type": "boolean"
+ },
+ "message": {
+ "type": "string"
+ },
+ "partnership_attributes": {
+ "additionalProperties": false,
+ "description": "Override partnership terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "effective_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "effective_date_type": {
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "type": "string"
+ },
+ "general_cap_amount_currency_val": {
+ "type": "number"
+ },
+ "general_cap_amount_either_currency": {
+ "type": "number"
+ },
+ "general_cap_amount_either_multiple": {
+ "type": "number"
+ },
+ "general_cap_amount_multiple_val": {
+ "type": "number"
+ },
+ "general_cap_amount_type": {
+ "enum": [
+ "multiple",
+ "currency",
+ "either",
+ "base"
+ ],
+ "type": "string"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_additional_warranties": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_include_company": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_include_company_val": {
+ "type": "string"
+ },
+ "include_additional_warranties_include_partner": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_include_partner_val": {
+ "type": "string"
+ },
+ "include_brand_guidelines": {
+ "type": "boolean"
+ },
+ "include_brand_guidelines_include_company": {
+ "type": "boolean"
+ },
+ "include_brand_guidelines_include_company_val": {
+ "type": "string"
+ },
+ "include_brand_guidelines_include_partner": {
+ "type": "boolean"
+ },
+ "include_brand_guidelines_include_partner_val": {
+ "type": "string"
+ },
+ "include_covered_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_company_claims": {
+ "type": "string"
+ },
+ "include_covered_claims_include_company_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_include_partner_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_partner_claims": {
+ "type": "string"
+ },
+ "include_dpa": {
+ "type": "boolean"
+ },
+ "include_dpa_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_dpa_location": {
+ "type": "string"
+ },
+ "include_dpa_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_increased_cap_amount": {
+ "type": "boolean"
+ },
+ "include_increased_cap_amount_currency": {
+ "type": "number"
+ },
+ "include_increased_cap_amount_either_currency": {
+ "type": "number"
+ },
+ "include_increased_cap_amount_either_multiple": {
+ "type": "string"
+ },
+ "include_increased_cap_amount_multiple": {
+ "type": "string"
+ },
+ "include_increased_cap_amount_type": {
+ "enum": [
+ "multiple",
+ "currency",
+ "either"
+ ],
+ "type": "string"
+ },
+ "include_increased_claims": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_confidentiality": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_confidentiality_misconduct": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_covered_claims": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_misconduct": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_other": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_other_val": {
+ "type": "string"
+ },
+ "include_unlimited_claims": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_confidentiality": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_confidentiality_misconduct": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_covered_claims": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_misconduct": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_other": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_other_val": {
+ "type": "string"
+ },
+ "negotiations_allowed": {
+ "type": "boolean"
+ }
+ },
+ "type": "object"
+ },
+ "partnership_business_terms_attributes": {
+ "additionalProperties": false,
+ "description": "Override partnership business terms terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "end_date_after_effective_date_amount": {
+ "type": "number"
+ },
+ "end_date_after_effective_date_unit": {
+ "enum": [
+ "month(s)",
+ "quarter(s)",
+ "year(s)"
+ ],
+ "type": "string"
+ },
+ "end_date_date": {
+ "type": "string"
+ },
+ "end_date_type": {
+ "enum": [
+ "date",
+ "effective date"
+ ],
+ "type": "string"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_obligations_company_brand": {
+ "type": "boolean"
+ },
+ "include_obligations_company_promotion": {
+ "type": "boolean"
+ },
+ "include_obligations_company_promotion_include_activities": {
+ "type": "boolean"
+ },
+ "include_obligations_company_promotion_include_activities_val": {
+ "type": "string"
+ },
+ "include_obligations_company_promotion_include_materials": {
+ "type": "boolean"
+ },
+ "include_obligations_company_promotion_include_materials_val": {
+ "type": "string"
+ },
+ "include_obligations_company_referral": {
+ "type": "boolean"
+ },
+ "include_obligations_company_referral_include_criteria": {
+ "type": "boolean"
+ },
+ "include_obligations_company_referral_include_criteria_val": {
+ "type": "string"
+ },
+ "include_obligations_company_referral_include_pay_sch": {
+ "type": "boolean"
+ },
+ "include_obligations_company_referral_include_pay_sch_amount": {
+ "type": "number"
+ },
+ "include_obligations_company_referral_include_pay_sch_custom": {
+ "type": "string"
+ },
+ "include_obligations_company_referral_include_pay_sch_unit": {
+ "enum": [
+ "U.S. Dollars",
+ "percent"
+ ],
+ "type": "string"
+ },
+ "include_obligations_company_sponsorship": {
+ "type": "boolean"
+ },
+ "include_obligations_company_sponsorship_include_benefits": {
+ "type": "boolean"
+ },
+ "include_obligations_company_sponsorship_include_benefits_val": {
+ "type": "string"
+ },
+ "include_obligations_company_sponsorship_include_payments": {
+ "type": "boolean"
+ },
+ "include_obligations_company_sponsorship_include_payments_amount": {
+ "type": "number"
+ },
+ "include_obligations_company_sponsorship_include_payments_unit": {
+ "enum": [
+ "U.S. Dollars",
+ "percent"
+ ],
+ "type": "string"
+ },
+ "include_obligations_partner_brand": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_promotion": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_promotion_include_activities": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_promotion_include_activities_val": {
+ "type": "string"
+ },
+ "include_obligations_partner_promotion_include_materials": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_promotion_include_materials_val": {
+ "type": "string"
+ },
+ "include_obligations_partner_referral": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_referral_include_criteria": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_referral_include_criteria_val": {
+ "type": "string"
+ },
+ "include_obligations_partner_referral_include_pay_sch": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_referral_include_pay_sch_amount": {
+ "type": "number"
+ },
+ "include_obligations_partner_referral_include_pay_sch_custom": {
+ "type": "string"
+ },
+ "include_obligations_partner_referral_include_pay_sch_unit": {
+ "enum": [
+ "U.S. Dollars",
+ "percent"
+ ],
+ "type": "string"
+ },
+ "include_obligations_partner_sponsorship": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_sponsorship_include_benefits": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_sponsorship_include_benefits_val": {
+ "type": "string"
+ },
+ "include_obligations_partner_sponsorship_include_payments": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_sponsorship_include_payments_amount": {
+ "type": "number"
+ },
+ "include_obligations_partner_sponsorship_include_payments_unit": {
+ "enum": [
+ "U.S. Dollars",
+ "percent"
+ ],
+ "type": "string"
+ },
+ "include_payment_process": {
+ "type": "boolean"
+ },
+ "include_payment_process_company": {
+ "type": "boolean"
+ },
+ "include_payment_process_company_include_address": {
+ "type": "boolean"
+ },
+ "include_payment_process_company_include_address_city": {
+ "type": "string"
+ },
+ "include_payment_process_company_include_address_country": {
+ "type": "string"
+ },
+ "include_payment_process_company_include_address_state": {
+ "type": "string"
+ },
+ "include_payment_process_company_include_address_street_address": {
+ "type": "string"
+ },
+ "include_payment_process_company_include_address_zipcode": {
+ "type": "string"
+ },
+ "include_payment_process_company_include_email": {
+ "type": "boolean"
+ },
+ "include_payment_process_company_include_email_val": {
+ "type": "string"
+ },
+ "include_payment_process_partner": {
+ "type": "boolean"
+ },
+ "include_payment_process_partner_include_address": {
+ "type": "boolean"
+ },
+ "include_payment_process_partner_include_address_city": {
+ "type": "string"
+ },
+ "include_payment_process_partner_include_address_country": {
+ "type": "string"
+ },
+ "include_payment_process_partner_include_address_state": {
+ "type": "string"
+ },
+ "include_payment_process_partner_include_address_street_address": {
+ "type": "string"
+ },
+ "include_payment_process_partner_include_address_zipcode": {
+ "type": "string"
+ },
+ "include_payment_process_partner_include_email": {
+ "type": "boolean"
+ },
+ "include_payment_process_partner_include_email_val": {
+ "type": "string"
+ },
+ "include_payment_schedule": {
+ "type": "boolean"
+ },
+ "include_payment_schedule_custom": {
+ "type": "string"
+ },
+ "include_payment_schedule_specified_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_payment_schedule_specified_timeframe": {
+ "enum": [
+ "receipt",
+ "date"
+ ],
+ "type": "string"
+ },
+ "include_payment_schedule_specified_unit": {
+ "enum": [
+ "day(s)",
+ "week(s)",
+ "month(s)",
+ "quarter(s)",
+ "year(s)"
+ ],
+ "type": "string"
+ },
+ "include_payment_schedule_type": {
+ "enum": [
+ "specified",
+ "custom"
+ ],
+ "type": "string"
+ },
+ "negotiations_allowed": {
+ "type": "boolean"
+ },
+ "territory_type": {
+ "enum": [
+ "worldwide",
+ "custom"
+ ],
+ "type": "string"
+ },
+ "territory_type_val": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "payment_link_url": {
+ "description": "A payment URL shown to the recipient after signing. Requires include_billing_workflow to be true and billing_workflow_type to be \"link\".",
+ "type": "string"
+ },
+ "pilot_attributes": {
+ "additionalProperties": false,
+ "description": "Override pilot terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "fees_type": {
+ "enum": [
+ "free",
+ "pilot_period_fees"
+ ],
+ "type": "string"
+ },
+ "general_cap_amount": {
+ "type": "number"
+ },
+ "general_cap_amount_type": {
+ "enum": [
+ "preceding",
+ "base",
+ "period"
+ ],
+ "type": "string"
+ },
+ "general_cap_period_currency": {
+ "type": "number"
+ },
+ "general_cap_period_qty": {
+ "type": "number"
+ },
+ "general_cap_preceding_amount": {
+ "type": "number"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_dpa": {
+ "type": "boolean"
+ },
+ "include_dpa_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_dpa_location": {
+ "type": "string"
+ },
+ "include_dpa_type": {
+ "enum": [
+ "description",
+ "attachment",
+ "standard"
+ ],
+ "type": "string"
+ },
+ "include_payment_process": {
+ "type": "boolean"
+ },
+ "include_technical_support": {
+ "type": "boolean"
+ },
+ "negotiations_allowed": {
+ "type": "boolean"
+ },
+ "payment_process_automatic_frequency": {
+ "enum": [
+ "monthly",
+ "quarterly",
+ "annually",
+ "once_per_period"
+ ],
+ "type": "string"
+ },
+ "payment_process_invoice_days": {
+ "type": "number"
+ },
+ "payment_process_invoice_from": {
+ "enum": [
+ "receipt",
+ "date"
+ ],
+ "type": "string"
+ },
+ "payment_process_invoice_timeframe": {
+ "enum": [
+ "days",
+ "weeks",
+ "months",
+ "quarters",
+ "years"
+ ],
+ "type": "string"
+ },
+ "payment_process_type": {
+ "enum": [
+ "automatic",
+ "invoice"
+ ],
+ "type": "string"
+ },
+ "pilot_period_description": {
+ "type": "string"
+ },
+ "pilot_period_fees_description": {
+ "type": "string"
+ },
+ "product_description": {
+ "type": "string"
+ },
+ "technical_support_description": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "psa_attributes": {
+ "additionalProperties": false,
+ "description": "Override psa terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "additional_changes": {
+ "type": "string"
+ },
+ "customer_description": {
+ "type": "string"
+ },
+ "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": {
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "type": "string"
+ },
+ "general_cap_amount": {
+ "type": "number"
+ },
+ "general_cap_amount_type": {
+ "enum": [
+ "preceding",
+ "base",
+ "period"
+ ],
+ "type": "string"
+ },
+ "general_cap_period_currency": {
+ "type": "number"
+ },
+ "general_cap_period_qty": {
+ "type": "number"
+ },
+ "general_cap_preceding_amount": {
+ "type": "number"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_additional_changes": {
+ "type": "boolean"
+ },
+ "include_additional_warranties": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_by_customer": {
+ "type": "string"
+ },
+ "include_additional_warranties_by_provider": {
+ "type": "string"
+ },
+ "include_additional_warranties_include_by_customer": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_include_by_provider": {
+ "type": "boolean"
+ },
+ "include_covered_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_customer_claims": {
+ "type": "string"
+ },
+ "include_covered_claims_include_customer_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_include_provider_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_provider_claims": {
+ "type": "string"
+ },
+ "include_customer_insurance_min": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_add_provider_com_gen_liability": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_add_provider_cyber_liability": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_add_provider_errors_omissions": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_auto_liability_aggregate": {
+ "type": "number"
+ },
+ "include_customer_insurance_min_auto_liability_minimum": {
+ "type": "number"
+ },
+ "include_customer_insurance_min_cyber_liability_aggregate": {
+ "type": "number"
+ },
+ "include_customer_insurance_min_cyber_liability_minimum": {
+ "type": "number"
+ },
+ "include_customer_insurance_min_employer_liability_aggregate": {
+ "type": "number"
+ },
+ "include_customer_insurance_min_employer_liability_minimum": {
+ "type": "number"
+ },
+ "include_customer_insurance_min_general_liability_aggregate": {
+ "type": "number"
+ },
+ "include_customer_insurance_min_general_liability_minimum": {
+ "type": "number"
+ },
+ "include_customer_insurance_min_include_add_provider": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_include_auto_liability": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_include_cyber_liability": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_include_employer_liability": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_include_general_liability": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_include_workers_comp": {
+ "type": "boolean"
+ },
+ "include_customer_policies": {
+ "type": "boolean"
+ },
+ "include_customer_policies_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_customer_policies_location": {
+ "type": "string"
+ },
+ "include_customer_policies_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_dpa": {
+ "type": "boolean"
+ },
+ "include_dpa_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_dpa_location": {
+ "type": "string"
+ },
+ "include_dpa_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_increased_cap_amount": {
+ "type": "boolean"
+ },
+ "include_increased_claims": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_confidentiality": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_confidentiality_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_privsec": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_privsec_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_other": {
+ "type": "boolean"
+ },
+ "include_increased_claims_indemnification_obligation": {
+ "type": "boolean"
+ },
+ "include_increased_claims_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_other": {
+ "type": "string"
+ },
+ "include_provider_insurance_min": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_add_customer_com_gen_liability": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_add_customer_cyber_liability": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_add_customer_errors_omissions": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_auto_liability_aggregate": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_auto_liability_minimum": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_cyber_liability_aggregate": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_cyber_liability_minimum": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_employer_liability_aggregate": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_employer_liability_minimum": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_general_liability_aggregate": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_general_liability_minimum": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_include_add_customer": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_include_auto_liability": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_include_cyber_liability": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_include_employer_liability": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_include_general_liability": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_include_workers_comp": {
+ "type": "boolean"
+ },
+ "include_publicity_rights": {
+ "type": "boolean"
+ },
+ "include_publicity_rights_type": {
+ "enum": [
+ "public",
+ "non-public"
+ ],
+ "type": "string"
+ },
+ "include_security_policy": {
+ "type": "boolean"
+ },
+ "include_security_policy_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_security_policy_fedramp_auth": {
+ "type": "boolean"
+ },
+ "include_security_policy_hitrust": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_annual_maintenance": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_other": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_other_val": {
+ "type": "string"
+ },
+ "include_security_policy_iso27001": {
+ "type": "boolean"
+ },
+ "include_security_policy_location": {
+ "type": "string"
+ },
+ "include_security_policy_pci1": {
+ "type": "boolean"
+ },
+ "include_security_policy_pci2": {
+ "type": "boolean"
+ },
+ "include_security_policy_penetration_testing": {
+ "type": "boolean"
+ },
+ "include_security_policy_soc2_type1": {
+ "type": "boolean"
+ },
+ "include_security_policy_soc2_type2": {
+ "type": "boolean"
+ },
+ "include_security_policy_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_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": "string"
+ },
+ "increased_cap_amount_currency": {
+ "type": "number"
+ },
+ "increased_cap_amount_period_currency": {
+ "type": "number"
+ },
+ "increased_cap_amount_period_qty": {
+ "type": "number"
+ },
+ "increased_cap_amount_qty": {
+ "type": "number"
+ },
+ "increased_cap_amount_type": {
+ "enum": [
+ "qty",
+ "currency",
+ "period"
+ ],
+ "type": "string"
+ },
+ "negotiations_allowed": {
+ "type": "boolean"
+ },
+ "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": "string"
+ },
+ "include_deliverables": {
+ "type": "boolean"
+ },
+ "include_deliverables_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_deliverables_description": {
+ "type": "string"
+ },
+ "include_deliverables_include_acceptance": {
+ "type": "boolean"
+ },
+ "include_deliverables_include_attachment": {
+ "type": "boolean"
+ },
+ "include_deliverables_include_draft_deliverables": {
+ "type": "boolean"
+ },
+ "include_deliverables_rejection_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_deliverables_rejection_unit": {
+ "enum": [
+ "hours",
+ "days",
+ "weeks",
+ "months"
+ ],
+ "type": "string"
+ },
+ "include_deliverables_resubmission_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_deliverables_resubmission_unit": {
+ "enum": [
+ "hours",
+ "days",
+ "weeks",
+ "months"
+ ],
+ "type": "string"
+ },
+ "include_fees_other": {
+ "type": "boolean"
+ },
+ "include_fees_other_val": {
+ "type": "string"
+ },
+ "include_fees_table": {
+ "type": "boolean"
+ },
+ "include_fees_table_total": {
+ "type": "boolean"
+ },
+ "include_fees_travel": {
+ "type": "boolean"
+ },
+ "include_fees_travel_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_fees_travel_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_fees_travel_val": {
+ "type": "string"
+ },
+ "include_third_party_customer": {
+ "type": "boolean"
+ },
+ "include_third_party_include_description": {
+ "type": "boolean"
+ },
+ "include_third_party_include_description_val": {
+ "type": "string"
+ },
+ "include_third_party_materials": {
+ "type": "boolean"
+ },
+ "include_third_party_provider": {
+ "type": "boolean"
+ },
+ "include_time_of_assignment": {
+ "type": "boolean"
+ },
+ "include_time_of_assignment_type": {
+ "enum": [
+ "created",
+ "paid"
+ ],
+ "type": "string"
+ },
+ "invoice_period_description": {
+ "type": "string"
+ },
+ "negotiations_allowed": {
+ "type": "boolean"
+ },
+ "payment_period": {
+ "type": "number"
+ },
+ "payment_period_other": {
+ "type": "string"
+ },
+ "payment_period_timeframe": {
+ "enum": [
+ "receipt",
+ "invoice",
+ "Customer's receipt of invoice",
+ "date of invoice"
+ ],
+ "type": "string"
+ },
+ "payment_period_type": {
+ "enum": [
+ "standard",
+ "other"
+ ],
+ "type": "string"
+ },
+ "payment_period_unit": {
+ "enum": [
+ "day(s)",
+ "week(s)",
+ "month(s)",
+ "quarter(s)",
+ "year(s)"
+ ],
+ "type": "string"
+ },
+ "quantity": {
+ "type": "number"
+ },
+ "services_description": {
+ "type": "string"
+ },
+ "sow_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "sow_date_type": {
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "type": "string"
+ },
+ "sow_term_amount": {
+ "type": "number"
+ },
+ "sow_term_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "sow_term_type": {
+ "enum": [
+ "deliverables",
+ "period",
+ "date"
+ ],
+ "type": "string"
+ },
+ "sow_term_unit": {
+ "enum": [
+ "month(s)",
+ "quarter(s)",
+ "year(s)"
+ ],
+ "type": "string"
+ },
+ "type": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "recipient_email": {
+ "format": "email",
+ "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-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": {
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "type": "string"
+ },
+ "general_cap_amount": {
+ "type": "number"
+ },
+ "general_cap_amount_type": {
+ "enum": [
+ "preceding",
+ "base",
+ "period"
+ ],
+ "type": "string"
+ },
+ "general_cap_period_currency": {
+ "type": "number"
+ },
+ "general_cap_period_qty": {
+ "type": "number"
+ },
+ "general_cap_preceding_amount": {
+ "type": "number"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_additional_warranties": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_by_customer": {
+ "type": "string"
+ },
+ "include_additional_warranties_by_provider": {
+ "type": "string"
+ },
+ "include_additional_warranties_include_by_customer": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_include_by_provider": {
+ "type": "boolean"
+ },
+ "include_ai_addendum": {
+ "type": "boolean"
+ },
+ "include_ai_addendum_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_covered_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_customer_claims": {
+ "type": "string"
+ },
+ "include_covered_claims_include_customer_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_include_provider_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_provider_claims": {
+ "type": "string"
+ },
+ "include_dpa": {
+ "type": "boolean"
+ },
+ "include_dpa_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_dpa_location": {
+ "type": "string"
+ },
+ "include_dpa_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_increased_cap_amount": {
+ "type": "boolean"
+ },
+ "include_increased_claims": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_confidentiality": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_confidentiality_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_other": {
+ "type": "boolean"
+ },
+ "include_increased_claims_indemnification_obligation": {
+ "type": "boolean"
+ },
+ "include_increased_claims_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_other": {
+ "type": "string"
+ },
+ "include_increased_claims_restrictions": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_confidentiality": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_confidentiality_negligence": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_include_other": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_indemnification_obligation": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_license_or_restrictions": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_negligence": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_other": {
+ "type": "string"
+ },
+ "increased_cap_amount_currency": {
+ "type": "number"
+ },
+ "increased_cap_amount_period_currency": {
+ "type": "number"
+ },
+ "increased_cap_amount_period_qty": {
+ "type": "number"
+ },
+ "increased_cap_amount_qty": {
+ "type": "number"
+ },
+ "increased_cap_amount_type": {
+ "enum": [
+ "qty",
+ "currency",
+ "period"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "software_license_order_form_attributes": {
+ "additionalProperties": false,
+ "description": "Override software license order form terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "additional_changes": {
+ "type": "string"
+ },
+ "deletion_procedure_include_custom": {
+ "type": "boolean"
+ },
+ "deletion_procedure_include_custom_description": {
+ "type": "string"
+ },
+ "deletion_procedure_include_customer_disable": {
+ "type": "boolean"
+ },
+ "deletion_procedure_include_customer_proof": {
+ "type": "boolean"
+ },
+ "deletion_procedure_include_provider_disable": {
+ "type": "boolean"
+ },
+ "fee_custom_unit": {
+ "type": "string"
+ },
+ "fee_period": {
+ "enum": [
+ "Subscription Period",
+ "month",
+ "year",
+ "Custom unit"
+ ],
+ "type": "string"
+ },
+ "fees_attributes": {
+ "additionalProperties": {
+ "anyOf": [
+ {
+ "additionalProperties": false,
+ "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": {
+ "enum": [
+ "USD",
+ "EUR",
+ "GBP",
+ "CAD",
+ "AUD",
+ "SGD",
+ "ILS",
+ "JPY",
+ "CHF",
+ "HKD"
+ ],
+ "type": "string"
+ },
+ "fees_include_fee_increase_upon_renewal": {
+ "type": "boolean"
+ },
+ "fees_include_fee_increase_upon_renewal_fee": {
+ "type": "number"
+ },
+ "fees_include_fee_increase_upon_renewal_type": {
+ "enum": [
+ "will",
+ "may"
+ ],
+ "type": "string"
+ },
+ "fees_inclusive_of_taxes": {
+ "type": "boolean"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_additional_changes": {
+ "type": "boolean"
+ },
+ "include_license_compliance_verification": {
+ "type": "boolean"
+ },
+ "include_license_compliance_verification_description": {
+ "type": "string"
+ },
+ "include_license_limits": {
+ "type": "boolean"
+ },
+ "include_license_limits_description": {
+ "type": "string"
+ },
+ "include_payment_process_include_billing_email": {
+ "type": "boolean"
+ },
+ "include_pilot_period": {
+ "type": "boolean"
+ },
+ "include_pilot_period_duration_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_pilot_period_duration_type": {
+ "enum": [
+ "day",
+ "week",
+ "month"
+ ],
+ "type": "string"
+ },
+ "include_pilot_period_include_fees": {
+ "type": "boolean"
+ },
+ "include_pilot_period_include_fees_amount": {
+ "type": "number"
+ },
+ "include_pilot_period_include_modifications": {
+ "type": "boolean"
+ },
+ "include_pilot_period_include_modifications_description": {
+ "type": "string"
+ },
+ "include_services": {
+ "type": "boolean"
+ },
+ "include_services_description": {
+ "type": "string"
+ },
+ "negotiations_allowed": {
+ "type": "boolean"
+ },
+ "order_date_date": {
+ "type": "string"
+ },
+ "order_date_type": {
+ "enum": [
+ "signature",
+ "date",
+ "other"
+ ],
+ "type": "string"
+ },
+ "payment_process_automatic_frequency": {
+ "enum": [
+ "monthly",
+ "quarterly",
+ "semiannually",
+ "annually"
+ ],
+ "type": "string"
+ },
+ "payment_process_type": {
+ "enum": [
+ "automatic",
+ "invoice",
+ "custom"
+ ],
+ "type": "string"
+ },
+ "payment_process_type_custom_val": {
+ "type": "string"
+ },
+ "payment_process_type_invoice_amount": {
+ "type": "number"
+ },
+ "payment_process_type_invoice_custom_unit": {
+ "type": "string"
+ },
+ "payment_process_type_invoice_duration": {
+ "enum": [
+ "day",
+ "week",
+ "month",
+ "year",
+ "day(s)",
+ "week(s)",
+ "month(s)",
+ "year(s)"
+ ],
+ "type": "string"
+ },
+ "payment_process_type_invoice_duration_start": {
+ "enum": [
+ "Customer's receipt of invoice",
+ "date of invoice"
+ ],
+ "type": "string"
+ },
+ "payment_process_type_invoice_type": {
+ "enum": [
+ "monthly",
+ "quarterly",
+ "semiannually",
+ "annually",
+ "Custom unit"
+ ],
+ "type": "string"
+ },
+ "permitted_uses_include_custom": {
+ "type": "boolean"
+ },
+ "permitted_uses_include_custom_description": {
+ "type": "string"
+ },
+ "permitted_uses_include_customers_affiliates": {
+ "type": "boolean"
+ },
+ "permitted_uses_include_internal_business": {
+ "type": "boolean"
+ },
+ "pilot_period_stripe_product_id": {
+ "type": "string"
+ },
+ "software_description": {
+ "type": "string"
+ },
+ "subscription_auto_renew": {
+ "enum": [
+ "days",
+ "subscription_end"
+ ],
+ "type": "string"
+ },
+ "subscription_period": {
+ "type": "number"
+ },
+ "subscription_period_unit": {
+ "type": "string"
+ },
+ "subscription_renewal_notice_days": {
+ "type": "number"
+ },
+ "warranty_period_description_amount": {
+ "type": "number"
+ },
+ "warranty_period_description_duration": {
+ "enum": [
+ "day",
+ "week",
+ "month",
+ "year"
+ ],
+ "type": "string"
+ },
+ "warranty_period_description_duration_start": {
+ "enum": [
+ "initial delivery of the Software",
+ "delivery of the Software and each subsequent Update",
+ "the Order Date"
+ ],
+ "type": "string"
+ },
+ "warranty_period_type": {
+ "enum": [
+ "description",
+ "none"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "test_agreement": {
+ "description": "When true, marks the agreement as a test. Test agreements do not count against your monthly limit.",
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "recipient_name",
+ "recipient_email"
+ ],
+ "type": "object"
+ },
+ "cc_users": {
+ "items": {
+ "format": "email",
+ "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-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": {
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "type": "string"
+ },
+ "framework_terms_type": {
+ "type": "string"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "parent_agreement_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "underlying_agreement_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "underlying_agreement_type": {
+ "type": "string"
+ },
+ "underlying_agreement_val": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "baa_attributes": {
+ "additionalProperties": false,
+ "description": "Override baa terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "aggregation_limitations_permitted": {
+ "type": "boolean"
+ },
+ "aggregation_limitations_permitted_val": {
+ "type": "string"
+ },
+ "breach_notification_unit": {
+ "enum": [
+ "hours",
+ "business days",
+ "calendar days"
+ ],
+ "type": "string"
+ },
+ "breach_notification_val": {
+ "type": "number"
+ },
+ "business_associate_relationship_type": {
+ "enum": [
+ "provider",
+ "company"
+ ],
+ "type": "string"
+ },
+ "deidentification_limitations_include_purpose": {
+ "type": "boolean"
+ },
+ "deidentification_limitations_include_requirements": {
+ "type": "boolean"
+ },
+ "deidentification_limitations_permitted": {
+ "type": "boolean"
+ },
+ "deidentification_limitations_purpose_val": {
+ "type": "string"
+ },
+ "deidentification_limitations_requirements_val": {
+ "type": "string"
+ },
+ "designated_record_set_provider_maintains": {
+ "type": "boolean"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_aggregation_limitations": {
+ "type": "boolean"
+ },
+ "include_deidentification_limitations": {
+ "type": "boolean"
+ },
+ "include_limitations": {
+ "type": "boolean"
+ },
+ "include_offshore_limitations": {
+ "type": "boolean"
+ },
+ "include_subcontract_limitations": {
+ "type": "boolean"
+ },
+ "offshore_limitations_permitted": {
+ "type": "boolean"
+ },
+ "offshore_limitations_permitted_val": {
+ "type": "string"
+ },
+ "subcontract_limitations_include_notice": {
+ "type": "boolean"
+ },
+ "subcontract_limitations_include_permission": {
+ "type": "boolean"
+ },
+ "subcontract_limitations_notice_val": {
+ "type": "string"
+ },
+ "subcontract_limitations_permission_val": {
+ "type": "string"
+ },
+ "subcontract_limitations_permitted": {
+ "type": "boolean"
+ },
+ "underlying_agreement_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "underlying_agreement_type": {
+ "enum": [
+ "internal",
+ "external",
+ "none"
+ ],
+ "type": "string"
+ },
+ "underlying_agreement_val": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "billing_email": {
+ "description": "Email of the billing contact. Used when include_billing_info is true.",
+ "format": "email",
+ "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-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": {
+ "enum": [
+ "AWS",
+ "GCP",
+ "Azure"
+ ],
+ "type": "string"
+ },
+ "effective_date_type": {
+ "enum": [
+ "signature",
+ "date",
+ "marketplace_acceptance"
+ ],
+ "type": "string"
+ },
+ "general_cap_amount": {
+ "type": "number"
+ },
+ "general_cap_amount_type": {
+ "enum": [
+ "preceding",
+ "base",
+ "period"
+ ],
+ "type": "string"
+ },
+ "general_cap_period_currency": {
+ "type": "number"
+ },
+ "general_cap_period_qty": {
+ "type": "number"
+ },
+ "general_cap_preceding_amount": {
+ "type": "number"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_acceptable_use_policy": {
+ "type": "boolean"
+ },
+ "include_acceptable_use_policy_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_acceptable_use_policy_location": {
+ "type": "string"
+ },
+ "include_acceptable_use_policy_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_additional_warranties": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_by_customer": {
+ "type": "string"
+ },
+ "include_additional_warranties_by_provider": {
+ "type": "string"
+ },
+ "include_additional_warranties_include_by_customer": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_include_by_provider": {
+ "type": "boolean"
+ },
+ "include_ai_addendum": {
+ "type": "boolean"
+ },
+ "include_ai_addendum_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_covered_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_customer_claims": {
+ "type": "string"
+ },
+ "include_covered_claims_include_customer_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_include_provider_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_provider_claims": {
+ "type": "string"
+ },
+ "include_dpa": {
+ "type": "boolean"
+ },
+ "include_dpa_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_dpa_location": {
+ "type": "string"
+ },
+ "include_dpa_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_increased_cap_amount": {
+ "type": "boolean"
+ },
+ "include_increased_claims": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_confidentiality": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_confidentiality_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_privsec": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_privsec_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_other": {
+ "type": "boolean"
+ },
+ "include_increased_claims_indemnification_obligation": {
+ "type": "boolean"
+ },
+ "include_increased_claims_other": {
+ "type": "string"
+ },
+ "include_insurance_minimums": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_add_customer": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_add_customer_com_gen_liability": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_add_customer_cyber_liability": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_add_customer_errors_omissions": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_additional_information": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_additional_information_text": {
+ "type": "string"
+ },
+ "include_insurance_minimums_cyber_liability_aggregate": {
+ "type": "number"
+ },
+ "include_insurance_minimums_cyber_liability_minimum": {
+ "type": "number"
+ },
+ "include_insurance_minimums_employer_liability_aggregate": {
+ "type": "number"
+ },
+ "include_insurance_minimums_employer_liability_minimum": {
+ "type": "number"
+ },
+ "include_insurance_minimums_general_liability_aggregate": {
+ "type": "number"
+ },
+ "include_insurance_minimums_general_liability_minimum": {
+ "type": "number"
+ },
+ "include_insurance_minimums_include_cyber_liability": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_include_employer_liability": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_include_general_liability": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_include_workers_compensation": {
+ "type": "boolean"
+ },
+ "include_publicity_rights": {
+ "type": "boolean"
+ },
+ "include_publicity_rights_type": {
+ "enum": [
+ "public",
+ "non-public"
+ ],
+ "type": "string"
+ },
+ "include_security_policy": {
+ "type": "boolean"
+ },
+ "include_security_policy_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_security_policy_fedramp_auth": {
+ "type": "boolean"
+ },
+ "include_security_policy_hipaa": {
+ "type": "boolean"
+ },
+ "include_security_policy_hitrust": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_annual_maintenance": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_location": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_other": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_reasonable_efforts": {
+ "type": "boolean"
+ },
+ "include_security_policy_iso27001": {
+ "type": "boolean"
+ },
+ "include_security_policy_location": {
+ "type": "string"
+ },
+ "include_security_policy_other": {
+ "type": "string"
+ },
+ "include_security_policy_pci1": {
+ "type": "boolean"
+ },
+ "include_security_policy_pci2": {
+ "type": "boolean"
+ },
+ "include_security_policy_penetration_testing": {
+ "type": "boolean"
+ },
+ "include_security_policy_soc2": {
+ "type": "boolean"
+ },
+ "include_security_policy_soc2_type2": {
+ "type": "boolean"
+ },
+ "include_security_policy_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_supercap": {
+ "description": "CSA 3.0 renamed `include_increased_cap_amount` to `include_supercap`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_increased_cap_amount`. Sending the other spelling returns a 422.",
+ "type": "boolean"
+ },
+ "include_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": "string"
+ },
+ "increased_cap_amount_currency": {
+ "type": "number"
+ },
+ "increased_cap_amount_period_currency": {
+ "type": "number"
+ },
+ "increased_cap_amount_period_qty": {
+ "type": "number"
+ },
+ "increased_cap_amount_qty": {
+ "type": "number"
+ },
+ "increased_cap_amount_type": {
+ "enum": [
+ "qty",
+ "currency",
+ "period"
+ ],
+ "type": "string"
+ },
+ "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": "string"
+ },
+ "affiliates_as_users": {
+ "type": "boolean"
+ },
+ "cloud_service_description": {
+ "type": "string"
+ },
+ "consumption_units": {
+ "type": "string"
+ },
+ "fee_amount": {
+ "type": "number"
+ },
+ "fee_custom_unit": {
+ "type": "string"
+ },
+ "fee_period": {
+ "enum": [
+ "Subscription Period",
+ "month",
+ "year",
+ "User",
+ "Custom unit"
+ ],
+ "type": "string"
+ },
+ "fees_attributes": {
+ "additionalProperties": {
+ "anyOf": [
+ {
+ "additionalProperties": false,
+ "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": {
+ "enum": [
+ "USD",
+ "EUR",
+ "GBP",
+ "CAD",
+ "AUD",
+ "SGD",
+ "ILS",
+ "JPY",
+ "CHF",
+ "HKD"
+ ],
+ "type": "string"
+ },
+ "fees_include_fee_increase_upon_renewal": {
+ "type": "boolean"
+ },
+ "fees_include_fee_increase_upon_renewal_fee": {
+ "type": "number"
+ },
+ "fees_include_fee_increase_upon_renewal_type": {
+ "enum": [
+ "will",
+ "may"
+ ],
+ "type": "string"
+ },
+ "fees_inclusive_of_taxes": {
+ "type": "boolean"
+ },
+ "framework_terms_type": {
+ "enum": [
+ "new",
+ "existing",
+ "description"
+ ],
+ "type": "string"
+ },
+ "free_trial_days": {
+ "type": "number"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_additional_changes": {
+ "type": "boolean"
+ },
+ "include_additional_parameters_or_limitations": {
+ "type": "boolean"
+ },
+ "include_consumption": {
+ "type": "boolean"
+ },
+ "include_fees": {
+ "type": "boolean"
+ },
+ "include_fees_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_fees_include_attachment": {
+ "type": "boolean"
+ },
+ "include_fees_other": {
+ "type": "boolean"
+ },
+ "include_fees_other_val": {
+ "type": "string"
+ },
+ "include_fees_table": {
+ "type": "boolean"
+ },
+ "include_fees_table_period": {
+ "enum": [
+ "Subscription Period",
+ "month",
+ "year",
+ "User"
+ ],
+ "type": "string"
+ },
+ "include_free_trial": {
+ "type": "boolean"
+ },
+ "include_max_users": {
+ "type": "boolean"
+ },
+ "include_pilot_period": {
+ "type": "boolean"
+ },
+ "include_pilot_period_duration_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_pilot_period_duration_type": {
+ "enum": [
+ "day",
+ "week",
+ "month"
+ ],
+ "type": "string"
+ },
+ "include_pilot_period_include_fees": {
+ "type": "boolean"
+ },
+ "include_pilot_period_include_fees_amount": {
+ "type": "number"
+ },
+ "include_pilot_period_include_modifications": {
+ "type": "boolean"
+ },
+ "include_pilot_period_include_modifications_description": {
+ "type": "string"
+ },
+ "include_product_support": {
+ "type": "boolean"
+ },
+ "include_product_support_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_product_support_description": {
+ "type": "string"
+ },
+ "include_product_support_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_professional_services": {
+ "type": "boolean"
+ },
+ "include_professional_services_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_professional_services_custom_name": {
+ "type": "string"
+ },
+ "include_professional_services_description": {
+ "type": "string"
+ },
+ "include_professional_services_end_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "include_professional_services_fees_description": {
+ "type": "string"
+ },
+ "include_professional_services_include_end_date": {
+ "type": "boolean"
+ },
+ "include_professional_services_include_fees_description": {
+ "type": "boolean"
+ },
+ "include_professional_services_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_sla": {
+ "type": "boolean"
+ },
+ "include_sla_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_sla_description": {
+ "type": "string"
+ },
+ "include_sla_include_response_time": {
+ "type": "boolean"
+ },
+ "include_sla_include_response_time_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_sla_include_response_time_credit": {
+ "type": "number"
+ },
+ "include_sla_include_response_time_duration": {
+ "enum": [
+ "hour",
+ "day",
+ "week",
+ "month",
+ "hours"
+ ],
+ "type": "string"
+ },
+ "include_sla_include_response_time_support_channel": {
+ "type": "string"
+ },
+ "include_sla_include_target_uptime": {
+ "type": "boolean"
+ },
+ "include_sla_maintenance_notice": {
+ "type": "boolean"
+ },
+ "include_sla_maintenance_window": {
+ "type": "boolean"
+ },
+ "include_sla_maintenance_window_type": {
+ "enum": [
+ "standard",
+ "none"
+ ],
+ "type": "string"
+ },
+ "include_sla_standard_maintenance_notice_qty": {
+ "type": "number"
+ },
+ "include_sla_standard_maintenance_notice_unit": {
+ "enum": [
+ "hour",
+ "day",
+ "week",
+ "month"
+ ],
+ "type": "string"
+ },
+ "include_sla_standard_maintenance_window_end_time": {
+ "type": "string"
+ },
+ "include_sla_standard_maintenance_window_friday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_monday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_saturday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_start_time": {
+ "type": "string"
+ },
+ "include_sla_standard_maintenance_window_sunday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_thursday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_time_zone": {
+ "type": "string"
+ },
+ "include_sla_standard_maintenance_window_tuesday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_wednesday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_target_uptime": {
+ "type": "number"
+ },
+ "include_sla_type": {
+ "enum": [
+ "description",
+ "standard",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_subscription_start_date": {
+ "type": "boolean"
+ },
+ "include_subscription_start_date_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "include_usage_review": {
+ "type": "boolean"
+ },
+ "include_usage_review_val": {
+ "type": "string"
+ },
+ "include_use_limitations": {
+ "type": "boolean"
+ },
+ "include_use_limitations_val": {
+ "type": "string"
+ },
+ "invoice_period": {
+ "enum": [
+ "monthly",
+ "quarterly",
+ "semiannually",
+ "annually",
+ "Custom unit",
+ "Monthly",
+ "Quarterly",
+ "Semiannually",
+ "Annually"
+ ],
+ "type": "string"
+ },
+ "invoice_period_custom_unit": {
+ "type": "string"
+ },
+ "max_consumption": {
+ "type": "number"
+ },
+ "max_users": {
+ "type": "number"
+ },
+ "negotiations_allowed": {
+ "type": "boolean"
+ },
+ "order_date_date": {
+ "type": "string"
+ },
+ "order_date_other": {
+ "type": "string"
+ },
+ "order_date_type": {
+ "enum": [
+ "signature",
+ "date",
+ "other"
+ ],
+ "type": "string"
+ },
+ "payment_period": {
+ "type": "number"
+ },
+ "payment_period_timeframe": {
+ "enum": [
+ "Customer's receipt of invoice",
+ "date of invoice"
+ ],
+ "type": "string"
+ },
+ "payment_period_unit": {
+ "enum": [
+ "day(s)",
+ "week(s)",
+ "month(s)",
+ "marketplace_acceptance"
+ ],
+ "type": "string"
+ },
+ "payment_process_automatic_frequency": {
+ "enum": [
+ "monthly",
+ "quarterly",
+ "semiannually",
+ "annually"
+ ],
+ "type": "string"
+ },
+ "payment_process_type": {
+ "enum": [
+ "automatic",
+ "invoice",
+ "custom",
+ "marketplace_acceptance"
+ ],
+ "type": "string"
+ },
+ "payment_process_type_custom_val": {
+ "type": "string"
+ },
+ "payment_process_type_invoice_amount": {
+ "type": "number"
+ },
+ "payment_process_type_invoice_custom_unit": {
+ "type": "string"
+ },
+ "payment_process_type_invoice_duration": {
+ "enum": [
+ "day",
+ "week",
+ "month",
+ "year",
+ "day(s)",
+ "week(s)",
+ "month(s)",
+ "year(s)"
+ ],
+ "type": "string"
+ },
+ "payment_process_type_invoice_duration_start": {
+ "enum": [
+ "Customer's receipt of invoice",
+ "date of invoice"
+ ],
+ "type": "string"
+ },
+ "payment_process_type_invoice_type": {
+ "enum": [
+ "monthly",
+ "quarterly",
+ "semiannually",
+ "annually",
+ "Custom unit"
+ ],
+ "type": "string"
+ },
+ "pilot_period_stripe_product_id": {
+ "type": "string"
+ },
+ "service_credits_attributes": {
+ "additionalProperties": {
+ "additionalProperties": false,
+ "properties": {
+ "credit": {
+ "type": "number"
+ },
+ "max": {
+ "type": "number"
+ },
+ "min": {
+ "type": "number"
+ }
+ },
+ "type": "object"
+ },
+ "description": "Service credits. Use string keys such as \"0\", \"1\".",
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+ },
+ "subscription_auto_renew": {
+ "enum": [
+ "days",
+ "subscription_end"
+ ],
+ "type": "string"
+ },
+ "subscription_period": {
+ "type": "number"
+ },
+ "subscription_period_unit": {
+ "type": "string"
+ },
+ "subscription_renewal_notice_days": {
+ "type": "number"
+ },
+ "subscription_start_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "subscription_start_date_type": {
+ "enum": [
+ "effective_date",
+ "date"
+ ],
+ "type": "string"
+ },
+ "underlying_agreement_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "use_limitations_attributes": {
+ "additionalProperties": {
+ "additionalProperties": false,
+ "properties": {
+ "amount": {
+ "type": "number"
+ },
+ "limitation_type": {
+ "type": "string"
+ },
+ "unit": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "description": "Use limitations. Use string keys such as \"0\", \"1\".",
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+ }
+ },
+ "type": "object"
+ },
+ "custom_field_values": {
+ "description": "Values for a custom template's fields, keyed by the field keys defined in the template's YAML definition. Only used when template_id is a custom template. Template defaults fill any fields you omit; a required field with no default and no submitted value returns a 400 naming the field. Values are validated against the field's input type: select and radio values must be one of the field's options, multiselect values are an array of selections each of which must be one of the field's options, number and currency values must be numeric, date values must be YYYY-MM-DD, and email values must be valid addresses. An invalid value returns a 400 naming the field."
+ },
+ "design_partner_attributes": {
+ "additionalProperties": false,
+ "description": "Override design partner terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "customer_description": {
+ "type": "string"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_fees": {
+ "type": "boolean"
+ },
+ "include_fees_amount": {
+ "type": "number"
+ },
+ "include_fees_description": {
+ "type": "string"
+ },
+ "include_fees_pay_by_amount": {
+ "type": "string"
+ },
+ "include_fees_type": {
+ "enum": [
+ "default_language",
+ "description"
+ ],
+ "type": "string"
+ },
+ "include_fees_unit": {
+ "enum": [
+ "month",
+ "quarter",
+ "year",
+ "Term"
+ ],
+ "type": "string"
+ },
+ "include_program_appear_as_customer_private": {
+ "type": "boolean"
+ },
+ "include_program_appear_as_customer_public": {
+ "type": "boolean"
+ },
+ "include_program_case_study": {
+ "type": "boolean"
+ },
+ "include_program_develop_functionality": {
+ "type": "boolean"
+ },
+ "include_program_develop_functionality_val": {
+ "type": "string"
+ },
+ "include_program_discount": {
+ "type": "boolean"
+ },
+ "include_program_discount_amount": {
+ "type": "number"
+ },
+ "include_program_discount_unit": {
+ "enum": [
+ "U.S. Dollars",
+ "percent"
+ ],
+ "type": "string"
+ },
+ "include_program_participation_feedback": {
+ "type": "boolean"
+ },
+ "include_program_participation_feedback_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_program_participation_feedback_unit": {
+ "enum": [
+ "month",
+ "quarter",
+ "year",
+ "Term"
+ ],
+ "type": "string"
+ },
+ "include_program_partner_other": {
+ "type": "boolean"
+ },
+ "include_program_partner_other_val": {
+ "type": "string"
+ },
+ "include_program_provider_other": {
+ "type": "boolean"
+ },
+ "include_program_provider_other_val": {
+ "type": "string"
+ },
+ "include_program_reference": {
+ "type": "boolean"
+ },
+ "product_description": {
+ "type": "string"
+ },
+ "term_amount": {
+ "type": "number"
+ },
+ "term_unit": {
+ "enum": [
+ "day(s)",
+ "week(s)",
+ "month(s)",
+ "quarter(s)",
+ "year(s)"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "district_or_county": {
+ "description": "The district or county for dispute resolution.",
+ "type": "string"
+ },
+ "dpa_attributes": {
+ "additionalProperties": false,
+ "description": "Override dpa terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "approved_subprocessor_type": {
+ "description": "`internal` lists approved subprocessors in the agreement (`subprocessors_attributes`); `external` points to a list published elsewhere.",
+ "enum": [
+ "internal",
+ "external"
+ ],
+ "type": "string"
+ },
+ "cloud_service_product_name": {
+ "type": "string"
+ },
+ "competent_supervisory_authority": {
+ "type": "string"
+ },
+ "customer_description": {
+ "type": "string"
+ },
+ "data_exporter_address_city": {
+ "type": "string"
+ },
+ "data_exporter_address_country": {
+ "type": "string"
+ },
+ "data_exporter_address_state": {
+ "type": "string"
+ },
+ "data_exporter_address_street_address": {
+ "type": "string"
+ },
+ "data_exporter_address_zipcode": {
+ "type": "string"
+ },
+ "data_exporter_contact_details": {
+ "type": "string"
+ },
+ "data_exporter_contact_name": {
+ "type": "string"
+ },
+ "data_exporter_contact_position": {
+ "type": "string"
+ },
+ "data_exporter_role": {
+ "description": "Role of the data exporter. Overwritten to `Controller` when the agreement is created from a template.",
+ "enum": [
+ "Controller",
+ "Processor"
+ ],
+ "type": "string"
+ },
+ "data_importer_address": {
+ "type": "string"
+ },
+ "data_importer_address_city": {
+ "type": "string"
+ },
+ "data_importer_address_country": {
+ "type": "string"
+ },
+ "data_importer_address_state": {
+ "type": "string"
+ },
+ "data_importer_address_street_address": {
+ "type": "string"
+ },
+ "data_importer_address_zipcode": {
+ "type": "string"
+ },
+ "data_importer_contact_details": {
+ "type": "string"
+ },
+ "data_importer_contact_name": {
+ "type": "string"
+ },
+ "data_importer_contact_position": {
+ "type": "string"
+ },
+ "duration_of_processing": {
+ "type": "string"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_covered_claim": {
+ "type": "boolean"
+ },
+ "include_covered_claim_external_val": {
+ "type": "string"
+ },
+ "include_covered_claim_internal_val": {
+ "type": "string"
+ },
+ "include_covered_claim_type": {
+ "description": "Which covered-claim text applies: `internal` uses `include_covered_claim_internal_val`, `external` uses `include_covered_claim_external_val`. Required when `include_covered_claim` is true.",
+ "enum": [
+ "internal",
+ "external"
+ ],
+ "type": "string"
+ },
+ "include_data_subjects_custom": {
+ "type": "boolean"
+ },
+ "include_data_subjects_custom_val": {
+ "type": "string"
+ },
+ "include_data_subjects_employees": {
+ "type": "boolean"
+ },
+ "include_data_subjects_end_users": {
+ "type": "boolean"
+ },
+ "include_external_subprocessor_location": {
+ "type": "string"
+ },
+ "include_frequency_of_transfer_continuous": {
+ "type": "boolean"
+ },
+ "include_frequency_of_transfer_custom": {
+ "type": "boolean"
+ },
+ "include_frequency_of_transfer_custom_val": {
+ "type": "string"
+ },
+ "include_governing_country_eu": {
+ "type": "boolean"
+ },
+ "include_governing_country_eu_val": {
+ "type": "string"
+ },
+ "include_governing_country_uk": {
+ "type": "boolean"
+ },
+ "include_governing_country_uk_val": {
+ "type": "string"
+ },
+ "include_governing_law": {
+ "type": "boolean"
+ },
+ "include_governing_law_country": {
+ "type": "string"
+ },
+ "include_governing_law_state": {
+ "type": "string"
+ },
+ "include_increased_claim_amount": {
+ "description": "Legacy field. Stored but not shown on the DPA; use the `include_liability_cap*` fields instead.",
+ "type": "boolean"
+ },
+ "include_increased_claim_amount_currency": {
+ "description": "Legacy field. Stored but not shown on the DPA; use the `include_liability_cap*` fields instead."
+ },
+ "include_increased_claim_amount_qty": {
+ "description": "Legacy field. Stored but not shown on the DPA; use the `include_liability_cap*` fields instead."
+ },
+ "include_increased_claim_amount_type": {
+ "description": "Legacy field. Stored but not shown on the DPA; use the `include_liability_cap*` fields instead.",
+ "type": "string"
+ },
+ "include_liability_cap": {
+ "type": "boolean"
+ },
+ "include_liability_cap_amount_constant_external": {
+ "type": "string"
+ },
+ "include_liability_cap_amount_constant_internal": {
+ "type": "string"
+ },
+ "include_liability_cap_amount_currency_external": {
+ "description": "Currency amount. Numbers and numeric strings (commas allowed) are both accepted."
+ },
+ "include_liability_cap_amount_currency_internal": {
+ "description": "Currency amount. Numbers and numeric strings (commas allowed) are both accepted."
+ },
+ "include_liability_cap_csa_type": {
+ "description": "Which liability cap values apply: the `_internal` or `_external` amount fields. Required when `include_liability_cap` is true.",
+ "enum": [
+ "internal",
+ "external"
+ ],
+ "type": "string"
+ },
+ "include_personal_data_biographic_info": {
+ "type": "boolean"
+ },
+ "include_personal_data_contact_info": {
+ "type": "boolean"
+ },
+ "include_personal_data_custom": {
+ "type": "boolean"
+ },
+ "include_personal_data_custom_val": {
+ "type": "string"
+ },
+ "include_personal_data_employment_info": {
+ "type": "boolean"
+ },
+ "include_personal_data_financial_info": {
+ "type": "boolean"
+ },
+ "include_personal_data_location": {
+ "type": "boolean"
+ },
+ "include_personal_data_name": {
+ "type": "boolean"
+ },
+ "include_personal_data_transactional_info": {
+ "type": "boolean"
+ },
+ "include_personal_data_user_activity_info": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_custom": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_custom_val": {
+ "type": "string"
+ },
+ "include_processing_purpose_erasing": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_holding": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_protecting": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_receiving": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_returning": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_sharing": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_updating": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_using": {
+ "type": "boolean"
+ },
+ "include_provider_security_contact_address": {
+ "type": "boolean"
+ },
+ "include_provider_security_contact_address_city": {
+ "type": "string"
+ },
+ "include_provider_security_contact_address_country": {
+ "type": "string"
+ },
+ "include_provider_security_contact_address_state": {
+ "type": "string"
+ },
+ "include_provider_security_contact_address_street_address": {
+ "type": "string"
+ },
+ "include_provider_security_contact_address_zipcode": {
+ "type": "string"
+ },
+ "include_provider_security_contact_email": {
+ "type": "boolean"
+ },
+ "include_provider_security_contact_email_val": {
+ "format": "email",
+ "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-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": "boolean"
+ },
+ "confidentiality_nda_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "confidentiality_nda_description": {
+ "type": "string"
+ },
+ "confidentiality_nda_include_loi": {
+ "type": "boolean"
+ },
+ "confidentiality_nda_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "confidentiality_type": {
+ "enum": [
+ "mutual",
+ "nda",
+ "provider",
+ "custom"
+ ],
+ "type": "string"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_custom_details": {
+ "type": "boolean"
+ },
+ "include_custom_details_val": {
+ "type": "string"
+ },
+ "include_fees": {
+ "type": "boolean"
+ },
+ "include_fees_amount": {
+ "type": "number"
+ },
+ "include_fees_amount_duration": {
+ "enum": [
+ "month",
+ "year",
+ "quarter"
+ ],
+ "type": "string"
+ },
+ "include_fees_include_amount": {
+ "type": "boolean"
+ },
+ "include_fees_include_other": {
+ "type": "boolean"
+ },
+ "include_fees_other": {
+ "type": "string"
+ },
+ "include_functionality": {
+ "type": "boolean"
+ },
+ "include_functionality_val": {
+ "type": "string"
+ },
+ "include_launch_date": {
+ "type": "boolean"
+ },
+ "include_launch_date_custom": {
+ "type": "string"
+ },
+ "include_launch_date_date": {
+ "format": "date-time",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$",
+ "type": "string"
+ },
+ "include_launch_date_type": {
+ "enum": [
+ "date",
+ "custom"
+ ],
+ "type": "string"
+ },
+ "product_name": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "manual_send": {
+ "description": "When true, the agreement is marked as manually sent outside the platform.",
+ "type": "boolean"
+ },
+ "message": {
+ "type": "string"
+ },
+ "partnership_attributes": {
+ "additionalProperties": false,
+ "description": "Override partnership terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "effective_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "effective_date_type": {
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "type": "string"
+ },
+ "general_cap_amount_currency_val": {
+ "type": "number"
+ },
+ "general_cap_amount_either_currency": {
+ "type": "number"
+ },
+ "general_cap_amount_either_multiple": {
+ "type": "number"
+ },
+ "general_cap_amount_multiple_val": {
+ "type": "number"
+ },
+ "general_cap_amount_type": {
+ "enum": [
+ "multiple",
+ "currency",
+ "either",
+ "base"
+ ],
+ "type": "string"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_additional_warranties": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_include_company": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_include_company_val": {
+ "type": "string"
+ },
+ "include_additional_warranties_include_partner": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_include_partner_val": {
+ "type": "string"
+ },
+ "include_brand_guidelines": {
+ "type": "boolean"
+ },
+ "include_brand_guidelines_include_company": {
+ "type": "boolean"
+ },
+ "include_brand_guidelines_include_company_val": {
+ "type": "string"
+ },
+ "include_brand_guidelines_include_partner": {
+ "type": "boolean"
+ },
+ "include_brand_guidelines_include_partner_val": {
+ "type": "string"
+ },
+ "include_covered_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_company_claims": {
+ "type": "string"
+ },
+ "include_covered_claims_include_company_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_include_partner_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_partner_claims": {
+ "type": "string"
+ },
+ "include_dpa": {
+ "type": "boolean"
+ },
+ "include_dpa_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_dpa_location": {
+ "type": "string"
+ },
+ "include_dpa_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_increased_cap_amount": {
+ "type": "boolean"
+ },
+ "include_increased_cap_amount_currency": {
+ "type": "number"
+ },
+ "include_increased_cap_amount_either_currency": {
+ "type": "number"
+ },
+ "include_increased_cap_amount_either_multiple": {
+ "type": "string"
+ },
+ "include_increased_cap_amount_multiple": {
+ "type": "string"
+ },
+ "include_increased_cap_amount_type": {
+ "enum": [
+ "multiple",
+ "currency",
+ "either"
+ ],
+ "type": "string"
+ },
+ "include_increased_claims": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_confidentiality": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_confidentiality_misconduct": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_covered_claims": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_misconduct": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_other": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_other_val": {
+ "type": "string"
+ },
+ "include_unlimited_claims": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_confidentiality": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_confidentiality_misconduct": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_covered_claims": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_misconduct": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_other": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_other_val": {
+ "type": "string"
+ },
+ "negotiations_allowed": {
+ "type": "boolean"
+ }
+ },
+ "type": "object"
+ },
+ "partnership_business_terms_attributes": {
+ "additionalProperties": false,
+ "description": "Override partnership business terms terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "end_date_after_effective_date_amount": {
+ "type": "number"
+ },
+ "end_date_after_effective_date_unit": {
+ "enum": [
+ "month(s)",
+ "quarter(s)",
+ "year(s)"
+ ],
+ "type": "string"
+ },
+ "end_date_date": {
+ "type": "string"
+ },
+ "end_date_type": {
+ "enum": [
+ "date",
+ "effective date"
+ ],
+ "type": "string"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_obligations_company_brand": {
+ "type": "boolean"
+ },
+ "include_obligations_company_promotion": {
+ "type": "boolean"
+ },
+ "include_obligations_company_promotion_include_activities": {
+ "type": "boolean"
+ },
+ "include_obligations_company_promotion_include_activities_val": {
+ "type": "string"
+ },
+ "include_obligations_company_promotion_include_materials": {
+ "type": "boolean"
+ },
+ "include_obligations_company_promotion_include_materials_val": {
+ "type": "string"
+ },
+ "include_obligations_company_referral": {
+ "type": "boolean"
+ },
+ "include_obligations_company_referral_include_criteria": {
+ "type": "boolean"
+ },
+ "include_obligations_company_referral_include_criteria_val": {
+ "type": "string"
+ },
+ "include_obligations_company_referral_include_pay_sch": {
+ "type": "boolean"
+ },
+ "include_obligations_company_referral_include_pay_sch_amount": {
+ "type": "number"
+ },
+ "include_obligations_company_referral_include_pay_sch_custom": {
+ "type": "string"
+ },
+ "include_obligations_company_referral_include_pay_sch_unit": {
+ "enum": [
+ "U.S. Dollars",
+ "percent"
+ ],
+ "type": "string"
+ },
+ "include_obligations_company_sponsorship": {
+ "type": "boolean"
+ },
+ "include_obligations_company_sponsorship_include_benefits": {
+ "type": "boolean"
+ },
+ "include_obligations_company_sponsorship_include_benefits_val": {
+ "type": "string"
+ },
+ "include_obligations_company_sponsorship_include_payments": {
+ "type": "boolean"
+ },
+ "include_obligations_company_sponsorship_include_payments_amount": {
+ "type": "number"
+ },
+ "include_obligations_company_sponsorship_include_payments_unit": {
+ "enum": [
+ "U.S. Dollars",
+ "percent"
+ ],
+ "type": "string"
+ },
+ "include_obligations_partner_brand": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_promotion": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_promotion_include_activities": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_promotion_include_activities_val": {
+ "type": "string"
+ },
+ "include_obligations_partner_promotion_include_materials": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_promotion_include_materials_val": {
+ "type": "string"
+ },
+ "include_obligations_partner_referral": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_referral_include_criteria": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_referral_include_criteria_val": {
+ "type": "string"
+ },
+ "include_obligations_partner_referral_include_pay_sch": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_referral_include_pay_sch_amount": {
+ "type": "number"
+ },
+ "include_obligations_partner_referral_include_pay_sch_custom": {
+ "type": "string"
+ },
+ "include_obligations_partner_referral_include_pay_sch_unit": {
+ "enum": [
+ "U.S. Dollars",
+ "percent"
+ ],
+ "type": "string"
+ },
+ "include_obligations_partner_sponsorship": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_sponsorship_include_benefits": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_sponsorship_include_benefits_val": {
+ "type": "string"
+ },
+ "include_obligations_partner_sponsorship_include_payments": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_sponsorship_include_payments_amount": {
+ "type": "number"
+ },
+ "include_obligations_partner_sponsorship_include_payments_unit": {
+ "enum": [
+ "U.S. Dollars",
+ "percent"
+ ],
+ "type": "string"
+ },
+ "include_payment_process": {
+ "type": "boolean"
+ },
+ "include_payment_process_company": {
+ "type": "boolean"
+ },
+ "include_payment_process_company_include_address": {
+ "type": "boolean"
+ },
+ "include_payment_process_company_include_address_city": {
+ "type": "string"
+ },
+ "include_payment_process_company_include_address_country": {
+ "type": "string"
+ },
+ "include_payment_process_company_include_address_state": {
+ "type": "string"
+ },
+ "include_payment_process_company_include_address_street_address": {
+ "type": "string"
+ },
+ "include_payment_process_company_include_address_zipcode": {
+ "type": "string"
+ },
+ "include_payment_process_company_include_email": {
+ "type": "boolean"
+ },
+ "include_payment_process_company_include_email_val": {
+ "type": "string"
+ },
+ "include_payment_process_partner": {
+ "type": "boolean"
+ },
+ "include_payment_process_partner_include_address": {
+ "type": "boolean"
+ },
+ "include_payment_process_partner_include_address_city": {
+ "type": "string"
+ },
+ "include_payment_process_partner_include_address_country": {
+ "type": "string"
+ },
+ "include_payment_process_partner_include_address_state": {
+ "type": "string"
+ },
+ "include_payment_process_partner_include_address_street_address": {
+ "type": "string"
+ },
+ "include_payment_process_partner_include_address_zipcode": {
+ "type": "string"
+ },
+ "include_payment_process_partner_include_email": {
+ "type": "boolean"
+ },
+ "include_payment_process_partner_include_email_val": {
+ "type": "string"
+ },
+ "include_payment_schedule": {
+ "type": "boolean"
+ },
+ "include_payment_schedule_custom": {
+ "type": "string"
+ },
+ "include_payment_schedule_specified_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_payment_schedule_specified_timeframe": {
+ "enum": [
+ "receipt",
+ "date"
+ ],
+ "type": "string"
+ },
+ "include_payment_schedule_specified_unit": {
+ "enum": [
+ "day(s)",
+ "week(s)",
+ "month(s)",
+ "quarter(s)",
+ "year(s)"
+ ],
+ "type": "string"
+ },
+ "include_payment_schedule_type": {
+ "enum": [
+ "specified",
+ "custom"
+ ],
+ "type": "string"
+ },
+ "negotiations_allowed": {
+ "type": "boolean"
+ },
+ "territory_type": {
+ "enum": [
+ "worldwide",
+ "custom"
+ ],
+ "type": "string"
+ },
+ "territory_type_val": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "payment_link_url": {
+ "description": "A payment URL shown to the recipient after signing. Requires include_billing_workflow to be true and billing_workflow_type to be \"link\".",
+ "type": "string"
+ },
+ "pilot_attributes": {
+ "additionalProperties": false,
+ "description": "Override pilot terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "fees_type": {
+ "enum": [
+ "free",
+ "pilot_period_fees"
+ ],
+ "type": "string"
+ },
+ "general_cap_amount": {
+ "type": "number"
+ },
+ "general_cap_amount_type": {
+ "enum": [
+ "preceding",
+ "base",
+ "period"
+ ],
+ "type": "string"
+ },
+ "general_cap_period_currency": {
+ "type": "number"
+ },
+ "general_cap_period_qty": {
+ "type": "number"
+ },
+ "general_cap_preceding_amount": {
+ "type": "number"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_dpa": {
+ "type": "boolean"
+ },
+ "include_dpa_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_dpa_location": {
+ "type": "string"
+ },
+ "include_dpa_type": {
+ "enum": [
+ "description",
+ "attachment",
+ "standard"
+ ],
+ "type": "string"
+ },
+ "include_payment_process": {
+ "type": "boolean"
+ },
+ "include_technical_support": {
+ "type": "boolean"
+ },
+ "negotiations_allowed": {
+ "type": "boolean"
+ },
+ "payment_process_automatic_frequency": {
+ "enum": [
+ "monthly",
+ "quarterly",
+ "annually",
+ "once_per_period"
+ ],
+ "type": "string"
+ },
+ "payment_process_invoice_days": {
+ "type": "number"
+ },
+ "payment_process_invoice_from": {
+ "enum": [
+ "receipt",
+ "date"
+ ],
+ "type": "string"
+ },
+ "payment_process_invoice_timeframe": {
+ "enum": [
+ "days",
+ "weeks",
+ "months",
+ "quarters",
+ "years"
+ ],
+ "type": "string"
+ },
+ "payment_process_type": {
+ "enum": [
+ "automatic",
+ "invoice"
+ ],
+ "type": "string"
+ },
+ "pilot_period_description": {
+ "type": "string"
+ },
+ "pilot_period_fees_description": {
+ "type": "string"
+ },
+ "product_description": {
+ "type": "string"
+ },
+ "technical_support_description": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "psa_attributes": {
+ "additionalProperties": false,
+ "description": "Override psa terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "additional_changes": {
+ "type": "string"
+ },
+ "customer_description": {
+ "type": "string"
+ },
+ "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": {
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "type": "string"
+ },
+ "general_cap_amount": {
+ "type": "number"
+ },
+ "general_cap_amount_type": {
+ "enum": [
+ "preceding",
+ "base",
+ "period"
+ ],
+ "type": "string"
+ },
+ "general_cap_period_currency": {
+ "type": "number"
+ },
+ "general_cap_period_qty": {
+ "type": "number"
+ },
+ "general_cap_preceding_amount": {
+ "type": "number"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_additional_changes": {
+ "type": "boolean"
+ },
+ "include_additional_warranties": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_by_customer": {
+ "type": "string"
+ },
+ "include_additional_warranties_by_provider": {
+ "type": "string"
+ },
+ "include_additional_warranties_include_by_customer": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_include_by_provider": {
+ "type": "boolean"
+ },
+ "include_covered_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_customer_claims": {
+ "type": "string"
+ },
+ "include_covered_claims_include_customer_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_include_provider_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_provider_claims": {
+ "type": "string"
+ },
+ "include_customer_insurance_min": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_add_provider_com_gen_liability": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_add_provider_cyber_liability": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_add_provider_errors_omissions": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_auto_liability_aggregate": {
+ "type": "number"
+ },
+ "include_customer_insurance_min_auto_liability_minimum": {
+ "type": "number"
+ },
+ "include_customer_insurance_min_cyber_liability_aggregate": {
+ "type": "number"
+ },
+ "include_customer_insurance_min_cyber_liability_minimum": {
+ "type": "number"
+ },
+ "include_customer_insurance_min_employer_liability_aggregate": {
+ "type": "number"
+ },
+ "include_customer_insurance_min_employer_liability_minimum": {
+ "type": "number"
+ },
+ "include_customer_insurance_min_general_liability_aggregate": {
+ "type": "number"
+ },
+ "include_customer_insurance_min_general_liability_minimum": {
+ "type": "number"
+ },
+ "include_customer_insurance_min_include_add_provider": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_include_auto_liability": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_include_cyber_liability": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_include_employer_liability": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_include_general_liability": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_include_workers_comp": {
+ "type": "boolean"
+ },
+ "include_customer_policies": {
+ "type": "boolean"
+ },
+ "include_customer_policies_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_customer_policies_location": {
+ "type": "string"
+ },
+ "include_customer_policies_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_dpa": {
+ "type": "boolean"
+ },
+ "include_dpa_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_dpa_location": {
+ "type": "string"
+ },
+ "include_dpa_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_increased_cap_amount": {
+ "type": "boolean"
+ },
+ "include_increased_claims": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_confidentiality": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_confidentiality_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_privsec": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_privsec_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_other": {
+ "type": "boolean"
+ },
+ "include_increased_claims_indemnification_obligation": {
+ "type": "boolean"
+ },
+ "include_increased_claims_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_other": {
+ "type": "string"
+ },
+ "include_provider_insurance_min": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_add_customer_com_gen_liability": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_add_customer_cyber_liability": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_add_customer_errors_omissions": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_auto_liability_aggregate": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_auto_liability_minimum": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_cyber_liability_aggregate": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_cyber_liability_minimum": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_employer_liability_aggregate": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_employer_liability_minimum": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_general_liability_aggregate": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_general_liability_minimum": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_include_add_customer": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_include_auto_liability": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_include_cyber_liability": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_include_employer_liability": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_include_general_liability": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_include_workers_comp": {
+ "type": "boolean"
+ },
+ "include_publicity_rights": {
+ "type": "boolean"
+ },
+ "include_publicity_rights_type": {
+ "enum": [
+ "public",
+ "non-public"
+ ],
+ "type": "string"
+ },
+ "include_security_policy": {
+ "type": "boolean"
+ },
+ "include_security_policy_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_security_policy_fedramp_auth": {
+ "type": "boolean"
+ },
+ "include_security_policy_hitrust": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_annual_maintenance": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_other": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_other_val": {
+ "type": "string"
+ },
+ "include_security_policy_iso27001": {
+ "type": "boolean"
+ },
+ "include_security_policy_location": {
+ "type": "string"
+ },
+ "include_security_policy_pci1": {
+ "type": "boolean"
+ },
+ "include_security_policy_pci2": {
+ "type": "boolean"
+ },
+ "include_security_policy_penetration_testing": {
+ "type": "boolean"
+ },
+ "include_security_policy_soc2_type1": {
+ "type": "boolean"
+ },
+ "include_security_policy_soc2_type2": {
+ "type": "boolean"
+ },
+ "include_security_policy_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_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": "string"
+ },
+ "increased_cap_amount_currency": {
+ "type": "number"
+ },
+ "increased_cap_amount_period_currency": {
+ "type": "number"
+ },
+ "increased_cap_amount_period_qty": {
+ "type": "number"
+ },
+ "increased_cap_amount_qty": {
+ "type": "number"
+ },
+ "increased_cap_amount_type": {
+ "enum": [
+ "qty",
+ "currency",
+ "period"
+ ],
+ "type": "string"
+ },
+ "negotiations_allowed": {
+ "type": "boolean"
+ },
+ "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": "string"
+ },
+ "include_deliverables": {
+ "type": "boolean"
+ },
+ "include_deliverables_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_deliverables_description": {
+ "type": "string"
+ },
+ "include_deliverables_include_acceptance": {
+ "type": "boolean"
+ },
+ "include_deliverables_include_attachment": {
+ "type": "boolean"
+ },
+ "include_deliverables_include_draft_deliverables": {
+ "type": "boolean"
+ },
+ "include_deliverables_rejection_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_deliverables_rejection_unit": {
+ "enum": [
+ "hours",
+ "days",
+ "weeks",
+ "months"
+ ],
+ "type": "string"
+ },
+ "include_deliverables_resubmission_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_deliverables_resubmission_unit": {
+ "enum": [
+ "hours",
+ "days",
+ "weeks",
+ "months"
+ ],
+ "type": "string"
+ },
+ "include_fees_other": {
+ "type": "boolean"
+ },
+ "include_fees_other_val": {
+ "type": "string"
+ },
+ "include_fees_table": {
+ "type": "boolean"
+ },
+ "include_fees_table_total": {
+ "type": "boolean"
+ },
+ "include_fees_travel": {
+ "type": "boolean"
+ },
+ "include_fees_travel_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_fees_travel_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_fees_travel_val": {
+ "type": "string"
+ },
+ "include_third_party_customer": {
+ "type": "boolean"
+ },
+ "include_third_party_include_description": {
+ "type": "boolean"
+ },
+ "include_third_party_include_description_val": {
+ "type": "string"
+ },
+ "include_third_party_materials": {
+ "type": "boolean"
+ },
+ "include_third_party_provider": {
+ "type": "boolean"
+ },
+ "include_time_of_assignment": {
+ "type": "boolean"
+ },
+ "include_time_of_assignment_type": {
+ "enum": [
+ "created",
+ "paid"
+ ],
+ "type": "string"
+ },
+ "invoice_period_description": {
+ "type": "string"
+ },
+ "negotiations_allowed": {
+ "type": "boolean"
+ },
+ "payment_period": {
+ "type": "number"
+ },
+ "payment_period_other": {
+ "type": "string"
+ },
+ "payment_period_timeframe": {
+ "enum": [
+ "receipt",
+ "invoice",
+ "Customer's receipt of invoice",
+ "date of invoice"
+ ],
+ "type": "string"
+ },
+ "payment_period_type": {
+ "enum": [
+ "standard",
+ "other"
+ ],
+ "type": "string"
+ },
+ "payment_period_unit": {
+ "enum": [
+ "day(s)",
+ "week(s)",
+ "month(s)",
+ "quarter(s)",
+ "year(s)"
+ ],
+ "type": "string"
+ },
+ "quantity": {
+ "type": "number"
+ },
+ "services_description": {
+ "type": "string"
+ },
+ "sow_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "sow_date_type": {
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "type": "string"
+ },
+ "sow_term_amount": {
+ "type": "number"
+ },
+ "sow_term_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "sow_term_type": {
+ "enum": [
+ "deliverables",
+ "period",
+ "date"
+ ],
+ "type": "string"
+ },
+ "sow_term_unit": {
+ "enum": [
+ "month(s)",
+ "quarter(s)",
+ "year(s)"
+ ],
+ "type": "string"
+ },
+ "type": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "recipient_email": {
+ "format": "email",
+ "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-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": {
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "type": "string"
+ },
+ "general_cap_amount": {
+ "type": "number"
+ },
+ "general_cap_amount_type": {
+ "enum": [
+ "preceding",
+ "base",
+ "period"
+ ],
+ "type": "string"
+ },
+ "general_cap_period_currency": {
+ "type": "number"
+ },
+ "general_cap_period_qty": {
+ "type": "number"
+ },
+ "general_cap_preceding_amount": {
+ "type": "number"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_additional_warranties": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_by_customer": {
+ "type": "string"
+ },
+ "include_additional_warranties_by_provider": {
+ "type": "string"
+ },
+ "include_additional_warranties_include_by_customer": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_include_by_provider": {
+ "type": "boolean"
+ },
+ "include_ai_addendum": {
+ "type": "boolean"
+ },
+ "include_ai_addendum_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_covered_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_customer_claims": {
+ "type": "string"
+ },
+ "include_covered_claims_include_customer_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_include_provider_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_provider_claims": {
+ "type": "string"
+ },
+ "include_dpa": {
+ "type": "boolean"
+ },
+ "include_dpa_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_dpa_location": {
+ "type": "string"
+ },
+ "include_dpa_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_increased_cap_amount": {
+ "type": "boolean"
+ },
+ "include_increased_claims": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_confidentiality": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_confidentiality_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_other": {
+ "type": "boolean"
+ },
+ "include_increased_claims_indemnification_obligation": {
+ "type": "boolean"
+ },
+ "include_increased_claims_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_other": {
+ "type": "string"
+ },
+ "include_increased_claims_restrictions": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_confidentiality": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_confidentiality_negligence": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_include_other": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_indemnification_obligation": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_license_or_restrictions": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_negligence": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_other": {
+ "type": "string"
+ },
+ "increased_cap_amount_currency": {
+ "type": "number"
+ },
+ "increased_cap_amount_period_currency": {
+ "type": "number"
+ },
+ "increased_cap_amount_period_qty": {
+ "type": "number"
+ },
+ "increased_cap_amount_qty": {
+ "type": "number"
+ },
+ "increased_cap_amount_type": {
+ "enum": [
+ "qty",
+ "currency",
+ "period"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "software_license_order_form_attributes": {
+ "additionalProperties": false,
+ "description": "Override software license order form terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "additional_changes": {
+ "type": "string"
+ },
+ "deletion_procedure_include_custom": {
+ "type": "boolean"
+ },
+ "deletion_procedure_include_custom_description": {
+ "type": "string"
+ },
+ "deletion_procedure_include_customer_disable": {
+ "type": "boolean"
+ },
+ "deletion_procedure_include_customer_proof": {
+ "type": "boolean"
+ },
+ "deletion_procedure_include_provider_disable": {
+ "type": "boolean"
+ },
+ "fee_custom_unit": {
+ "type": "string"
+ },
+ "fee_period": {
+ "enum": [
+ "Subscription Period",
+ "month",
+ "year",
+ "Custom unit"
+ ],
+ "type": "string"
+ },
+ "fees_attributes": {
+ "additionalProperties": {
+ "anyOf": [
+ {
+ "additionalProperties": false,
+ "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": {
+ "enum": [
+ "USD",
+ "EUR",
+ "GBP",
+ "CAD",
+ "AUD",
+ "SGD",
+ "ILS",
+ "JPY",
+ "CHF",
+ "HKD"
+ ],
+ "type": "string"
+ },
+ "fees_include_fee_increase_upon_renewal": {
+ "type": "boolean"
+ },
+ "fees_include_fee_increase_upon_renewal_fee": {
+ "type": "number"
+ },
+ "fees_include_fee_increase_upon_renewal_type": {
+ "enum": [
+ "will",
+ "may"
+ ],
+ "type": "string"
+ },
+ "fees_inclusive_of_taxes": {
+ "type": "boolean"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_additional_changes": {
+ "type": "boolean"
+ },
+ "include_license_compliance_verification": {
+ "type": "boolean"
+ },
+ "include_license_compliance_verification_description": {
+ "type": "string"
+ },
+ "include_license_limits": {
+ "type": "boolean"
+ },
+ "include_license_limits_description": {
+ "type": "string"
+ },
+ "include_payment_process_include_billing_email": {
+ "type": "boolean"
+ },
+ "include_pilot_period": {
+ "type": "boolean"
+ },
+ "include_pilot_period_duration_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_pilot_period_duration_type": {
+ "enum": [
+ "day",
+ "week",
+ "month"
+ ],
+ "type": "string"
+ },
+ "include_pilot_period_include_fees": {
+ "type": "boolean"
+ },
+ "include_pilot_period_include_fees_amount": {
+ "type": "number"
+ },
+ "include_pilot_period_include_modifications": {
+ "type": "boolean"
+ },
+ "include_pilot_period_include_modifications_description": {
+ "type": "string"
+ },
+ "include_services": {
+ "type": "boolean"
+ },
+ "include_services_description": {
+ "type": "string"
+ },
+ "negotiations_allowed": {
+ "type": "boolean"
+ },
+ "order_date_date": {
+ "type": "string"
+ },
+ "order_date_type": {
+ "enum": [
+ "signature",
+ "date",
+ "other"
+ ],
+ "type": "string"
+ },
+ "payment_process_automatic_frequency": {
+ "enum": [
+ "monthly",
+ "quarterly",
+ "semiannually",
+ "annually"
+ ],
+ "type": "string"
+ },
+ "payment_process_type": {
+ "enum": [
+ "automatic",
+ "invoice",
+ "custom"
+ ],
+ "type": "string"
+ },
+ "payment_process_type_custom_val": {
+ "type": "string"
+ },
+ "payment_process_type_invoice_amount": {
+ "type": "number"
+ },
+ "payment_process_type_invoice_custom_unit": {
+ "type": "string"
+ },
+ "payment_process_type_invoice_duration": {
+ "enum": [
+ "day",
+ "week",
+ "month",
+ "year",
+ "day(s)",
+ "week(s)",
+ "month(s)",
+ "year(s)"
+ ],
+ "type": "string"
+ },
+ "payment_process_type_invoice_duration_start": {
+ "enum": [
+ "Customer's receipt of invoice",
+ "date of invoice"
+ ],
+ "type": "string"
+ },
+ "payment_process_type_invoice_type": {
+ "enum": [
+ "monthly",
+ "quarterly",
+ "semiannually",
+ "annually",
+ "Custom unit"
+ ],
+ "type": "string"
+ },
+ "permitted_uses_include_custom": {
+ "type": "boolean"
+ },
+ "permitted_uses_include_custom_description": {
+ "type": "string"
+ },
+ "permitted_uses_include_customers_affiliates": {
+ "type": "boolean"
+ },
+ "permitted_uses_include_internal_business": {
+ "type": "boolean"
+ },
+ "pilot_period_stripe_product_id": {
+ "type": "string"
+ },
+ "software_description": {
+ "type": "string"
+ },
+ "subscription_auto_renew": {
+ "enum": [
+ "days",
+ "subscription_end"
+ ],
+ "type": "string"
+ },
+ "subscription_period": {
+ "type": "number"
+ },
+ "subscription_period_unit": {
+ "type": "string"
+ },
+ "subscription_renewal_notice_days": {
+ "type": "number"
+ },
+ "warranty_period_description_amount": {
+ "type": "number"
+ },
+ "warranty_period_description_duration": {
+ "enum": [
+ "day",
+ "week",
+ "month",
+ "year"
+ ],
+ "type": "string"
+ },
+ "warranty_period_description_duration_start": {
+ "enum": [
+ "initial delivery of the Software",
+ "delivery of the Software and each subsequent Update",
+ "the Order Date"
+ ],
+ "type": "string"
+ },
+ "warranty_period_type": {
+ "enum": [
+ "description",
+ "none"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "test_agreement": {
+ "description": "When true, marks the agreement as a test. Test agreements do not count against your monthly limit.",
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "recipient_name",
+ "recipient_email"
+ ],
+ "type": "object"
+ },
+ "cc_users": {
+ "items": {
+ "format": "email",
+ "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "draft": {
+ "description": "When true, the agreement is saved as a draft and not sent to the recipient. Use POST /v1/agreements/{id}/send to send a draft agreement later.",
+ "type": "boolean"
+ },
+ "owner_email": {
+ "description": "Email address of the agreement owner (sender).",
+ "type": "string"
+ },
+ "signer_id": {
+ "description": "User id of the signer from the owner's organization.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "template_id": {
+ "description": "UUID of a template from `GET /v1/templates`. Accepts both Common Paper standard templates and uploaded PDF templates (`type` `uploaded_template`).",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ }
+ },
+ "required": [
+ "template_id",
+ "owner_email",
+ "signer_id",
+ "agreement"
+ ],
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "agreement": {
+ "additionalProperties": {},
+ "properties": {
+ "amendment_attributes": {
+ "additionalProperties": false,
+ "description": "Override amendment terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "amended_terms_attributes": {
+ "additionalProperties": {
+ "additionalProperties": false,
+ "properties": {
+ "description": {
+ "type": "string"
+ },
+ "term": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "description": "Amended terms. Use string keys such as \"0\", \"1\".",
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+ },
+ "amendment_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "amendment_date_type": {
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "type": "string"
+ },
+ "framework_terms_type": {
+ "type": "string"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "parent_agreement_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "underlying_agreement_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "underlying_agreement_type": {
+ "type": "string"
+ },
+ "underlying_agreement_val": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "baa_attributes": {
+ "additionalProperties": false,
+ "description": "Override baa terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "aggregation_limitations_permitted": {
+ "type": "boolean"
+ },
+ "aggregation_limitations_permitted_val": {
+ "type": "string"
+ },
+ "breach_notification_unit": {
+ "enum": [
+ "hours",
+ "business days",
+ "calendar days"
+ ],
+ "type": "string"
+ },
+ "breach_notification_val": {
+ "type": "number"
+ },
+ "business_associate_relationship_type": {
+ "enum": [
+ "provider",
+ "company"
+ ],
+ "type": "string"
+ },
+ "deidentification_limitations_include_purpose": {
+ "type": "boolean"
+ },
+ "deidentification_limitations_include_requirements": {
+ "type": "boolean"
+ },
+ "deidentification_limitations_permitted": {
+ "type": "boolean"
+ },
+ "deidentification_limitations_purpose_val": {
+ "type": "string"
+ },
+ "deidentification_limitations_requirements_val": {
+ "type": "string"
+ },
+ "designated_record_set_provider_maintains": {
+ "type": "boolean"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_aggregation_limitations": {
+ "type": "boolean"
+ },
+ "include_deidentification_limitations": {
+ "type": "boolean"
+ },
+ "include_limitations": {
+ "type": "boolean"
+ },
+ "include_offshore_limitations": {
+ "type": "boolean"
+ },
+ "include_subcontract_limitations": {
+ "type": "boolean"
+ },
+ "offshore_limitations_permitted": {
+ "type": "boolean"
+ },
+ "offshore_limitations_permitted_val": {
+ "type": "string"
+ },
+ "subcontract_limitations_include_notice": {
+ "type": "boolean"
+ },
+ "subcontract_limitations_include_permission": {
+ "type": "boolean"
+ },
+ "subcontract_limitations_notice_val": {
+ "type": "string"
+ },
+ "subcontract_limitations_permission_val": {
+ "type": "string"
+ },
+ "subcontract_limitations_permitted": {
+ "type": "boolean"
+ },
+ "underlying_agreement_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "underlying_agreement_type": {
+ "enum": [
+ "internal",
+ "external",
+ "none"
+ ],
+ "type": "string"
+ },
+ "underlying_agreement_val": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "billing_email": {
+ "description": "Email of the billing contact. Used when include_billing_info is true.",
+ "format": "email",
+ "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-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": {
+ "enum": [
+ "AWS",
+ "GCP",
+ "Azure"
+ ],
+ "type": "string"
+ },
+ "effective_date_type": {
+ "enum": [
+ "signature",
+ "date",
+ "marketplace_acceptance"
+ ],
+ "type": "string"
+ },
+ "general_cap_amount": {
+ "type": "number"
+ },
+ "general_cap_amount_type": {
+ "enum": [
+ "preceding",
+ "base",
+ "period"
+ ],
+ "type": "string"
+ },
+ "general_cap_period_currency": {
+ "type": "number"
+ },
+ "general_cap_period_qty": {
+ "type": "number"
+ },
+ "general_cap_preceding_amount": {
+ "type": "number"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_acceptable_use_policy": {
+ "type": "boolean"
+ },
+ "include_acceptable_use_policy_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_acceptable_use_policy_location": {
+ "type": "string"
+ },
+ "include_acceptable_use_policy_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_additional_warranties": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_by_customer": {
+ "type": "string"
+ },
+ "include_additional_warranties_by_provider": {
+ "type": "string"
+ },
+ "include_additional_warranties_include_by_customer": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_include_by_provider": {
+ "type": "boolean"
+ },
+ "include_ai_addendum": {
+ "type": "boolean"
+ },
+ "include_ai_addendum_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_covered_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_customer_claims": {
+ "type": "string"
+ },
+ "include_covered_claims_include_customer_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_include_provider_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_provider_claims": {
+ "type": "string"
+ },
+ "include_dpa": {
+ "type": "boolean"
+ },
+ "include_dpa_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_dpa_location": {
+ "type": "string"
+ },
+ "include_dpa_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_increased_cap_amount": {
+ "type": "boolean"
+ },
+ "include_increased_claims": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_confidentiality": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_confidentiality_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_privsec": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_privsec_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_other": {
+ "type": "boolean"
+ },
+ "include_increased_claims_indemnification_obligation": {
+ "type": "boolean"
+ },
+ "include_increased_claims_other": {
+ "type": "string"
+ },
+ "include_insurance_minimums": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_add_customer": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_add_customer_com_gen_liability": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_add_customer_cyber_liability": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_add_customer_errors_omissions": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_additional_information": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_additional_information_text": {
+ "type": "string"
+ },
+ "include_insurance_minimums_cyber_liability_aggregate": {
+ "type": "number"
+ },
+ "include_insurance_minimums_cyber_liability_minimum": {
+ "type": "number"
+ },
+ "include_insurance_minimums_employer_liability_aggregate": {
+ "type": "number"
+ },
+ "include_insurance_minimums_employer_liability_minimum": {
+ "type": "number"
+ },
+ "include_insurance_minimums_general_liability_aggregate": {
+ "type": "number"
+ },
+ "include_insurance_minimums_general_liability_minimum": {
+ "type": "number"
+ },
+ "include_insurance_minimums_include_cyber_liability": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_include_employer_liability": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_include_general_liability": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_include_workers_compensation": {
+ "type": "boolean"
+ },
+ "include_publicity_rights": {
+ "type": "boolean"
+ },
+ "include_publicity_rights_type": {
+ "enum": [
+ "public",
+ "non-public"
+ ],
+ "type": "string"
+ },
+ "include_security_policy": {
+ "type": "boolean"
+ },
+ "include_security_policy_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_security_policy_fedramp_auth": {
+ "type": "boolean"
+ },
+ "include_security_policy_hipaa": {
+ "type": "boolean"
+ },
+ "include_security_policy_hitrust": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_annual_maintenance": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_location": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_other": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_reasonable_efforts": {
+ "type": "boolean"
+ },
+ "include_security_policy_iso27001": {
+ "type": "boolean"
+ },
+ "include_security_policy_location": {
+ "type": "string"
+ },
+ "include_security_policy_other": {
+ "type": "string"
+ },
+ "include_security_policy_pci1": {
+ "type": "boolean"
+ },
+ "include_security_policy_pci2": {
+ "type": "boolean"
+ },
+ "include_security_policy_penetration_testing": {
+ "type": "boolean"
+ },
+ "include_security_policy_soc2": {
+ "type": "boolean"
+ },
+ "include_security_policy_soc2_type2": {
+ "type": "boolean"
+ },
+ "include_security_policy_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_supercap": {
+ "description": "CSA 3.0 renamed `include_increased_cap_amount` to `include_supercap`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_increased_cap_amount`. Sending the other spelling returns a 422.",
+ "type": "boolean"
+ },
+ "include_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": "string"
+ },
+ "increased_cap_amount_currency": {
+ "type": "number"
+ },
+ "increased_cap_amount_period_currency": {
+ "type": "number"
+ },
+ "increased_cap_amount_period_qty": {
+ "type": "number"
+ },
+ "increased_cap_amount_qty": {
+ "type": "number"
+ },
+ "increased_cap_amount_type": {
+ "enum": [
+ "qty",
+ "currency",
+ "period"
+ ],
+ "type": "string"
+ },
+ "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": "string"
+ },
+ "affiliates_as_users": {
+ "type": "boolean"
+ },
+ "cloud_service_description": {
+ "type": "string"
+ },
+ "consumption_units": {
+ "type": "string"
+ },
+ "fee_amount": {
+ "type": "number"
+ },
+ "fee_custom_unit": {
+ "type": "string"
+ },
+ "fee_period": {
+ "enum": [
+ "Subscription Period",
+ "month",
+ "year",
+ "User",
+ "Custom unit"
+ ],
+ "type": "string"
+ },
+ "fees_attributes": {
+ "additionalProperties": {
+ "anyOf": [
+ {
+ "additionalProperties": false,
+ "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": {
+ "enum": [
+ "USD",
+ "EUR",
+ "GBP",
+ "CAD",
+ "AUD",
+ "SGD",
+ "ILS",
+ "JPY",
+ "CHF",
+ "HKD"
+ ],
+ "type": "string"
+ },
+ "fees_include_fee_increase_upon_renewal": {
+ "type": "boolean"
+ },
+ "fees_include_fee_increase_upon_renewal_fee": {
+ "type": "number"
+ },
+ "fees_include_fee_increase_upon_renewal_type": {
+ "enum": [
+ "will",
+ "may"
+ ],
+ "type": "string"
+ },
+ "fees_inclusive_of_taxes": {
+ "type": "boolean"
+ },
+ "framework_terms_type": {
+ "enum": [
+ "new",
+ "existing",
+ "description"
+ ],
+ "type": "string"
+ },
+ "free_trial_days": {
+ "type": "number"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_additional_changes": {
+ "type": "boolean"
+ },
+ "include_additional_parameters_or_limitations": {
+ "type": "boolean"
+ },
+ "include_consumption": {
+ "type": "boolean"
+ },
+ "include_fees": {
+ "type": "boolean"
+ },
+ "include_fees_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_fees_include_attachment": {
+ "type": "boolean"
+ },
+ "include_fees_other": {
+ "type": "boolean"
+ },
+ "include_fees_other_val": {
+ "type": "string"
+ },
+ "include_fees_table": {
+ "type": "boolean"
+ },
+ "include_fees_table_period": {
+ "enum": [
+ "Subscription Period",
+ "month",
+ "year",
+ "User"
+ ],
+ "type": "string"
+ },
+ "include_free_trial": {
+ "type": "boolean"
+ },
+ "include_max_users": {
+ "type": "boolean"
+ },
+ "include_pilot_period": {
+ "type": "boolean"
+ },
+ "include_pilot_period_duration_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_pilot_period_duration_type": {
+ "enum": [
+ "day",
+ "week",
+ "month"
+ ],
+ "type": "string"
+ },
+ "include_pilot_period_include_fees": {
+ "type": "boolean"
+ },
+ "include_pilot_period_include_fees_amount": {
+ "type": "number"
+ },
+ "include_pilot_period_include_modifications": {
+ "type": "boolean"
+ },
+ "include_pilot_period_include_modifications_description": {
+ "type": "string"
+ },
+ "include_product_support": {
+ "type": "boolean"
+ },
+ "include_product_support_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_product_support_description": {
+ "type": "string"
+ },
+ "include_product_support_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_professional_services": {
+ "type": "boolean"
+ },
+ "include_professional_services_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_professional_services_custom_name": {
+ "type": "string"
+ },
+ "include_professional_services_description": {
+ "type": "string"
+ },
+ "include_professional_services_end_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "include_professional_services_fees_description": {
+ "type": "string"
+ },
+ "include_professional_services_include_end_date": {
+ "type": "boolean"
+ },
+ "include_professional_services_include_fees_description": {
+ "type": "boolean"
+ },
+ "include_professional_services_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_sla": {
+ "type": "boolean"
+ },
+ "include_sla_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_sla_description": {
+ "type": "string"
+ },
+ "include_sla_include_response_time": {
+ "type": "boolean"
+ },
+ "include_sla_include_response_time_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_sla_include_response_time_credit": {
+ "type": "number"
+ },
+ "include_sla_include_response_time_duration": {
+ "enum": [
+ "hour",
+ "day",
+ "week",
+ "month",
+ "hours"
+ ],
+ "type": "string"
+ },
+ "include_sla_include_response_time_support_channel": {
+ "type": "string"
+ },
+ "include_sla_include_target_uptime": {
+ "type": "boolean"
+ },
+ "include_sla_maintenance_notice": {
+ "type": "boolean"
+ },
+ "include_sla_maintenance_window": {
+ "type": "boolean"
+ },
+ "include_sla_maintenance_window_type": {
+ "enum": [
+ "standard",
+ "none"
+ ],
+ "type": "string"
+ },
+ "include_sla_standard_maintenance_notice_qty": {
+ "type": "number"
+ },
+ "include_sla_standard_maintenance_notice_unit": {
+ "enum": [
+ "hour",
+ "day",
+ "week",
+ "month"
+ ],
+ "type": "string"
+ },
+ "include_sla_standard_maintenance_window_end_time": {
+ "type": "string"
+ },
+ "include_sla_standard_maintenance_window_friday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_monday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_saturday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_start_time": {
+ "type": "string"
+ },
+ "include_sla_standard_maintenance_window_sunday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_thursday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_time_zone": {
+ "type": "string"
+ },
+ "include_sla_standard_maintenance_window_tuesday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_wednesday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_target_uptime": {
+ "type": "number"
+ },
+ "include_sla_type": {
+ "enum": [
+ "description",
+ "standard",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_subscription_start_date": {
+ "type": "boolean"
+ },
+ "include_subscription_start_date_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "include_usage_review": {
+ "type": "boolean"
+ },
+ "include_usage_review_val": {
+ "type": "string"
+ },
+ "include_use_limitations": {
+ "type": "boolean"
+ },
+ "include_use_limitations_val": {
+ "type": "string"
+ },
+ "invoice_period": {
+ "enum": [
+ "monthly",
+ "quarterly",
+ "semiannually",
+ "annually",
+ "Custom unit",
+ "Monthly",
+ "Quarterly",
+ "Semiannually",
+ "Annually"
+ ],
+ "type": "string"
+ },
+ "invoice_period_custom_unit": {
+ "type": "string"
+ },
+ "max_consumption": {
+ "type": "number"
+ },
+ "max_users": {
+ "type": "number"
+ },
+ "negotiations_allowed": {
+ "type": "boolean"
+ },
+ "order_date_date": {
+ "type": "string"
+ },
+ "order_date_other": {
+ "type": "string"
+ },
+ "order_date_type": {
+ "enum": [
+ "signature",
+ "date",
+ "other"
+ ],
+ "type": "string"
+ },
+ "payment_period": {
+ "type": "number"
+ },
+ "payment_period_timeframe": {
+ "enum": [
+ "Customer's receipt of invoice",
+ "date of invoice"
+ ],
+ "type": "string"
+ },
+ "payment_period_unit": {
+ "enum": [
+ "day(s)",
+ "week(s)",
+ "month(s)",
+ "marketplace_acceptance"
+ ],
+ "type": "string"
+ },
+ "payment_process_automatic_frequency": {
+ "enum": [
+ "monthly",
+ "quarterly",
+ "semiannually",
+ "annually"
+ ],
+ "type": "string"
+ },
+ "payment_process_type": {
+ "enum": [
+ "automatic",
+ "invoice",
+ "custom",
+ "marketplace_acceptance"
+ ],
+ "type": "string"
+ },
+ "payment_process_type_custom_val": {
+ "type": "string"
+ },
+ "payment_process_type_invoice_amount": {
+ "type": "number"
+ },
+ "payment_process_type_invoice_custom_unit": {
+ "type": "string"
+ },
+ "payment_process_type_invoice_duration": {
+ "enum": [
+ "day",
+ "week",
+ "month",
+ "year",
+ "day(s)",
+ "week(s)",
+ "month(s)",
+ "year(s)"
+ ],
+ "type": "string"
+ },
+ "payment_process_type_invoice_duration_start": {
+ "enum": [
+ "Customer's receipt of invoice",
+ "date of invoice"
+ ],
+ "type": "string"
+ },
+ "payment_process_type_invoice_type": {
+ "enum": [
+ "monthly",
+ "quarterly",
+ "semiannually",
+ "annually",
+ "Custom unit"
+ ],
+ "type": "string"
+ },
+ "pilot_period_stripe_product_id": {
+ "type": "string"
+ },
+ "service_credits_attributes": {
+ "additionalProperties": {
+ "additionalProperties": false,
+ "properties": {
+ "credit": {
+ "type": "number"
+ },
+ "max": {
+ "type": "number"
+ },
+ "min": {
+ "type": "number"
+ }
+ },
+ "type": "object"
+ },
+ "description": "Service credits. Use string keys such as \"0\", \"1\".",
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+ },
+ "subscription_auto_renew": {
+ "enum": [
+ "days",
+ "subscription_end"
+ ],
+ "type": "string"
+ },
+ "subscription_period": {
+ "type": "number"
+ },
+ "subscription_period_unit": {
+ "type": "string"
+ },
+ "subscription_renewal_notice_days": {
+ "type": "number"
+ },
+ "subscription_start_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "subscription_start_date_type": {
+ "enum": [
+ "effective_date",
+ "date"
+ ],
+ "type": "string"
+ },
+ "underlying_agreement_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "use_limitations_attributes": {
+ "additionalProperties": {
+ "additionalProperties": false,
+ "properties": {
+ "amount": {
+ "type": "number"
+ },
+ "limitation_type": {
+ "type": "string"
+ },
+ "unit": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "description": "Use limitations. Use string keys such as \"0\", \"1\".",
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+ }
+ },
+ "type": "object"
+ },
+ "custom_field_values": {
+ "description": "Values for a custom template's fields, keyed by the field keys defined in the template's YAML definition. Only used when template_id is a custom template. Template defaults fill any fields you omit; a required field with no default and no submitted value returns a 400 naming the field. Values are validated against the field's input type: select and radio values must be one of the field's options, multiselect values are an array of selections each of which must be one of the field's options, number and currency values must be numeric, date values must be YYYY-MM-DD, and email values must be valid addresses. An invalid value returns a 400 naming the field."
+ },
+ "design_partner_attributes": {
+ "additionalProperties": false,
+ "description": "Override design partner terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "customer_description": {
+ "type": "string"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_fees": {
+ "type": "boolean"
+ },
+ "include_fees_amount": {
+ "type": "number"
+ },
+ "include_fees_description": {
+ "type": "string"
+ },
+ "include_fees_pay_by_amount": {
+ "type": "string"
+ },
+ "include_fees_type": {
+ "enum": [
+ "default_language",
+ "description"
+ ],
+ "type": "string"
+ },
+ "include_fees_unit": {
+ "enum": [
+ "month",
+ "quarter",
+ "year",
+ "Term"
+ ],
+ "type": "string"
+ },
+ "include_program_appear_as_customer_private": {
+ "type": "boolean"
+ },
+ "include_program_appear_as_customer_public": {
+ "type": "boolean"
+ },
+ "include_program_case_study": {
+ "type": "boolean"
+ },
+ "include_program_develop_functionality": {
+ "type": "boolean"
+ },
+ "include_program_develop_functionality_val": {
+ "type": "string"
+ },
+ "include_program_discount": {
+ "type": "boolean"
+ },
+ "include_program_discount_amount": {
+ "type": "number"
+ },
+ "include_program_discount_unit": {
+ "enum": [
+ "U.S. Dollars",
+ "percent"
+ ],
+ "type": "string"
+ },
+ "include_program_participation_feedback": {
+ "type": "boolean"
+ },
+ "include_program_participation_feedback_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_program_participation_feedback_unit": {
+ "enum": [
+ "month",
+ "quarter",
+ "year",
+ "Term"
+ ],
+ "type": "string"
+ },
+ "include_program_partner_other": {
+ "type": "boolean"
+ },
+ "include_program_partner_other_val": {
+ "type": "string"
+ },
+ "include_program_provider_other": {
+ "type": "boolean"
+ },
+ "include_program_provider_other_val": {
+ "type": "string"
+ },
+ "include_program_reference": {
+ "type": "boolean"
+ },
+ "product_description": {
+ "type": "string"
+ },
+ "term_amount": {
+ "type": "number"
+ },
+ "term_unit": {
+ "enum": [
+ "day(s)",
+ "week(s)",
+ "month(s)",
+ "quarter(s)",
+ "year(s)"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "district_or_county": {
+ "description": "The district or county for dispute resolution.",
+ "type": "string"
+ },
+ "dpa_attributes": {
+ "additionalProperties": false,
+ "description": "Override dpa terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "approved_subprocessor_type": {
+ "description": "`internal` lists approved subprocessors in the agreement (`subprocessors_attributes`); `external` points to a list published elsewhere.",
+ "enum": [
+ "internal",
+ "external"
+ ],
+ "type": "string"
+ },
+ "cloud_service_product_name": {
+ "type": "string"
+ },
+ "competent_supervisory_authority": {
+ "type": "string"
+ },
+ "customer_description": {
+ "type": "string"
+ },
+ "data_exporter_address_city": {
+ "type": "string"
+ },
+ "data_exporter_address_country": {
+ "type": "string"
+ },
+ "data_exporter_address_state": {
+ "type": "string"
+ },
+ "data_exporter_address_street_address": {
+ "type": "string"
+ },
+ "data_exporter_address_zipcode": {
+ "type": "string"
+ },
+ "data_exporter_contact_details": {
+ "type": "string"
+ },
+ "data_exporter_contact_name": {
+ "type": "string"
+ },
+ "data_exporter_contact_position": {
+ "type": "string"
+ },
+ "data_exporter_role": {
+ "description": "Role of the data exporter. Overwritten to `Controller` when the agreement is created from a template.",
+ "enum": [
+ "Controller",
+ "Processor"
+ ],
+ "type": "string"
+ },
+ "data_importer_address": {
+ "type": "string"
+ },
+ "data_importer_address_city": {
+ "type": "string"
+ },
+ "data_importer_address_country": {
+ "type": "string"
+ },
+ "data_importer_address_state": {
+ "type": "string"
+ },
+ "data_importer_address_street_address": {
+ "type": "string"
+ },
+ "data_importer_address_zipcode": {
+ "type": "string"
+ },
+ "data_importer_contact_details": {
+ "type": "string"
+ },
+ "data_importer_contact_name": {
+ "type": "string"
+ },
+ "data_importer_contact_position": {
+ "type": "string"
+ },
+ "duration_of_processing": {
+ "type": "string"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_covered_claim": {
+ "type": "boolean"
+ },
+ "include_covered_claim_external_val": {
+ "type": "string"
+ },
+ "include_covered_claim_internal_val": {
+ "type": "string"
+ },
+ "include_covered_claim_type": {
+ "description": "Which covered-claim text applies: `internal` uses `include_covered_claim_internal_val`, `external` uses `include_covered_claim_external_val`. Required when `include_covered_claim` is true.",
+ "enum": [
+ "internal",
+ "external"
+ ],
+ "type": "string"
+ },
+ "include_data_subjects_custom": {
+ "type": "boolean"
+ },
+ "include_data_subjects_custom_val": {
+ "type": "string"
+ },
+ "include_data_subjects_employees": {
+ "type": "boolean"
+ },
+ "include_data_subjects_end_users": {
+ "type": "boolean"
+ },
+ "include_external_subprocessor_location": {
+ "type": "string"
+ },
+ "include_frequency_of_transfer_continuous": {
+ "type": "boolean"
+ },
+ "include_frequency_of_transfer_custom": {
+ "type": "boolean"
+ },
+ "include_frequency_of_transfer_custom_val": {
+ "type": "string"
+ },
+ "include_governing_country_eu": {
+ "type": "boolean"
+ },
+ "include_governing_country_eu_val": {
+ "type": "string"
+ },
+ "include_governing_country_uk": {
+ "type": "boolean"
+ },
+ "include_governing_country_uk_val": {
+ "type": "string"
+ },
+ "include_governing_law": {
+ "type": "boolean"
+ },
+ "include_governing_law_country": {
+ "type": "string"
+ },
+ "include_governing_law_state": {
+ "type": "string"
+ },
+ "include_increased_claim_amount": {
+ "description": "Legacy field. Stored but not shown on the DPA; use the `include_liability_cap*` fields instead.",
+ "type": "boolean"
+ },
+ "include_increased_claim_amount_currency": {
+ "description": "Legacy field. Stored but not shown on the DPA; use the `include_liability_cap*` fields instead."
+ },
+ "include_increased_claim_amount_qty": {
+ "description": "Legacy field. Stored but not shown on the DPA; use the `include_liability_cap*` fields instead."
+ },
+ "include_increased_claim_amount_type": {
+ "description": "Legacy field. Stored but not shown on the DPA; use the `include_liability_cap*` fields instead.",
+ "type": "string"
+ },
+ "include_liability_cap": {
+ "type": "boolean"
+ },
+ "include_liability_cap_amount_constant_external": {
+ "type": "string"
+ },
+ "include_liability_cap_amount_constant_internal": {
+ "type": "string"
+ },
+ "include_liability_cap_amount_currency_external": {
+ "description": "Currency amount. Numbers and numeric strings (commas allowed) are both accepted."
+ },
+ "include_liability_cap_amount_currency_internal": {
+ "description": "Currency amount. Numbers and numeric strings (commas allowed) are both accepted."
+ },
+ "include_liability_cap_csa_type": {
+ "description": "Which liability cap values apply: the `_internal` or `_external` amount fields. Required when `include_liability_cap` is true.",
+ "enum": [
+ "internal",
+ "external"
+ ],
+ "type": "string"
+ },
+ "include_personal_data_biographic_info": {
+ "type": "boolean"
+ },
+ "include_personal_data_contact_info": {
+ "type": "boolean"
+ },
+ "include_personal_data_custom": {
+ "type": "boolean"
+ },
+ "include_personal_data_custom_val": {
+ "type": "string"
+ },
+ "include_personal_data_employment_info": {
+ "type": "boolean"
+ },
+ "include_personal_data_financial_info": {
+ "type": "boolean"
+ },
+ "include_personal_data_location": {
+ "type": "boolean"
+ },
+ "include_personal_data_name": {
+ "type": "boolean"
+ },
+ "include_personal_data_transactional_info": {
+ "type": "boolean"
+ },
+ "include_personal_data_user_activity_info": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_custom": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_custom_val": {
+ "type": "string"
+ },
+ "include_processing_purpose_erasing": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_holding": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_protecting": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_receiving": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_returning": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_sharing": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_updating": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_using": {
+ "type": "boolean"
+ },
+ "include_provider_security_contact_address": {
+ "type": "boolean"
+ },
+ "include_provider_security_contact_address_city": {
+ "type": "string"
+ },
+ "include_provider_security_contact_address_country": {
+ "type": "string"
+ },
+ "include_provider_security_contact_address_state": {
+ "type": "string"
+ },
+ "include_provider_security_contact_address_street_address": {
+ "type": "string"
+ },
+ "include_provider_security_contact_address_zipcode": {
+ "type": "string"
+ },
+ "include_provider_security_contact_email": {
+ "type": "boolean"
+ },
+ "include_provider_security_contact_email_val": {
+ "format": "email",
+ "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-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": "boolean"
+ },
+ "confidentiality_nda_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "confidentiality_nda_description": {
+ "type": "string"
+ },
+ "confidentiality_nda_include_loi": {
+ "type": "boolean"
+ },
+ "confidentiality_nda_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "confidentiality_type": {
+ "enum": [
+ "mutual",
+ "nda",
+ "provider",
+ "custom"
+ ],
+ "type": "string"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_custom_details": {
+ "type": "boolean"
+ },
+ "include_custom_details_val": {
+ "type": "string"
+ },
+ "include_fees": {
+ "type": "boolean"
+ },
+ "include_fees_amount": {
+ "type": "number"
+ },
+ "include_fees_amount_duration": {
+ "enum": [
+ "month",
+ "year",
+ "quarter"
+ ],
+ "type": "string"
+ },
+ "include_fees_include_amount": {
+ "type": "boolean"
+ },
+ "include_fees_include_other": {
+ "type": "boolean"
+ },
+ "include_fees_other": {
+ "type": "string"
+ },
+ "include_functionality": {
+ "type": "boolean"
+ },
+ "include_functionality_val": {
+ "type": "string"
+ },
+ "include_launch_date": {
+ "type": "boolean"
+ },
+ "include_launch_date_custom": {
+ "type": "string"
+ },
+ "include_launch_date_date": {
+ "format": "date-time",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$",
+ "type": "string"
+ },
+ "include_launch_date_type": {
+ "enum": [
+ "date",
+ "custom"
+ ],
+ "type": "string"
+ },
+ "product_name": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "manual_send": {
+ "description": "When true, the agreement is marked as manually sent outside the platform.",
+ "type": "boolean"
+ },
+ "message": {
+ "type": "string"
+ },
+ "partnership_attributes": {
+ "additionalProperties": false,
+ "description": "Override partnership terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "effective_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "effective_date_type": {
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "type": "string"
+ },
+ "general_cap_amount_currency_val": {
+ "type": "number"
+ },
+ "general_cap_amount_either_currency": {
+ "type": "number"
+ },
+ "general_cap_amount_either_multiple": {
+ "type": "number"
+ },
+ "general_cap_amount_multiple_val": {
+ "type": "number"
+ },
+ "general_cap_amount_type": {
+ "enum": [
+ "multiple",
+ "currency",
+ "either",
+ "base"
+ ],
+ "type": "string"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_additional_warranties": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_include_company": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_include_company_val": {
+ "type": "string"
+ },
+ "include_additional_warranties_include_partner": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_include_partner_val": {
+ "type": "string"
+ },
+ "include_brand_guidelines": {
+ "type": "boolean"
+ },
+ "include_brand_guidelines_include_company": {
+ "type": "boolean"
+ },
+ "include_brand_guidelines_include_company_val": {
+ "type": "string"
+ },
+ "include_brand_guidelines_include_partner": {
+ "type": "boolean"
+ },
+ "include_brand_guidelines_include_partner_val": {
+ "type": "string"
+ },
+ "include_covered_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_company_claims": {
+ "type": "string"
+ },
+ "include_covered_claims_include_company_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_include_partner_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_partner_claims": {
+ "type": "string"
+ },
+ "include_dpa": {
+ "type": "boolean"
+ },
+ "include_dpa_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_dpa_location": {
+ "type": "string"
+ },
+ "include_dpa_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_increased_cap_amount": {
+ "type": "boolean"
+ },
+ "include_increased_cap_amount_currency": {
+ "type": "number"
+ },
+ "include_increased_cap_amount_either_currency": {
+ "type": "number"
+ },
+ "include_increased_cap_amount_either_multiple": {
+ "type": "string"
+ },
+ "include_increased_cap_amount_multiple": {
+ "type": "string"
+ },
+ "include_increased_cap_amount_type": {
+ "enum": [
+ "multiple",
+ "currency",
+ "either"
+ ],
+ "type": "string"
+ },
+ "include_increased_claims": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_confidentiality": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_confidentiality_misconduct": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_covered_claims": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_misconduct": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_other": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_other_val": {
+ "type": "string"
+ },
+ "include_unlimited_claims": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_confidentiality": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_confidentiality_misconduct": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_covered_claims": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_misconduct": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_other": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_other_val": {
+ "type": "string"
+ },
+ "negotiations_allowed": {
+ "type": "boolean"
+ }
+ },
+ "type": "object"
+ },
+ "partnership_business_terms_attributes": {
+ "additionalProperties": false,
+ "description": "Override partnership business terms terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "end_date_after_effective_date_amount": {
+ "type": "number"
+ },
+ "end_date_after_effective_date_unit": {
+ "enum": [
+ "month(s)",
+ "quarter(s)",
+ "year(s)"
+ ],
+ "type": "string"
+ },
+ "end_date_date": {
+ "type": "string"
+ },
+ "end_date_type": {
+ "enum": [
+ "date",
+ "effective date"
+ ],
+ "type": "string"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_obligations_company_brand": {
+ "type": "boolean"
+ },
+ "include_obligations_company_promotion": {
+ "type": "boolean"
+ },
+ "include_obligations_company_promotion_include_activities": {
+ "type": "boolean"
+ },
+ "include_obligations_company_promotion_include_activities_val": {
+ "type": "string"
+ },
+ "include_obligations_company_promotion_include_materials": {
+ "type": "boolean"
+ },
+ "include_obligations_company_promotion_include_materials_val": {
+ "type": "string"
+ },
+ "include_obligations_company_referral": {
+ "type": "boolean"
+ },
+ "include_obligations_company_referral_include_criteria": {
+ "type": "boolean"
+ },
+ "include_obligations_company_referral_include_criteria_val": {
+ "type": "string"
+ },
+ "include_obligations_company_referral_include_pay_sch": {
+ "type": "boolean"
+ },
+ "include_obligations_company_referral_include_pay_sch_amount": {
+ "type": "number"
+ },
+ "include_obligations_company_referral_include_pay_sch_custom": {
+ "type": "string"
+ },
+ "include_obligations_company_referral_include_pay_sch_unit": {
+ "enum": [
+ "U.S. Dollars",
+ "percent"
+ ],
+ "type": "string"
+ },
+ "include_obligations_company_sponsorship": {
+ "type": "boolean"
+ },
+ "include_obligations_company_sponsorship_include_benefits": {
+ "type": "boolean"
+ },
+ "include_obligations_company_sponsorship_include_benefits_val": {
+ "type": "string"
+ },
+ "include_obligations_company_sponsorship_include_payments": {
+ "type": "boolean"
+ },
+ "include_obligations_company_sponsorship_include_payments_amount": {
+ "type": "number"
+ },
+ "include_obligations_company_sponsorship_include_payments_unit": {
+ "enum": [
+ "U.S. Dollars",
+ "percent"
+ ],
+ "type": "string"
+ },
+ "include_obligations_partner_brand": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_promotion": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_promotion_include_activities": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_promotion_include_activities_val": {
+ "type": "string"
+ },
+ "include_obligations_partner_promotion_include_materials": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_promotion_include_materials_val": {
+ "type": "string"
+ },
+ "include_obligations_partner_referral": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_referral_include_criteria": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_referral_include_criteria_val": {
+ "type": "string"
+ },
+ "include_obligations_partner_referral_include_pay_sch": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_referral_include_pay_sch_amount": {
+ "type": "number"
+ },
+ "include_obligations_partner_referral_include_pay_sch_custom": {
+ "type": "string"
+ },
+ "include_obligations_partner_referral_include_pay_sch_unit": {
+ "enum": [
+ "U.S. Dollars",
+ "percent"
+ ],
+ "type": "string"
+ },
+ "include_obligations_partner_sponsorship": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_sponsorship_include_benefits": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_sponsorship_include_benefits_val": {
+ "type": "string"
+ },
+ "include_obligations_partner_sponsorship_include_payments": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_sponsorship_include_payments_amount": {
+ "type": "number"
+ },
+ "include_obligations_partner_sponsorship_include_payments_unit": {
+ "enum": [
+ "U.S. Dollars",
+ "percent"
+ ],
+ "type": "string"
+ },
+ "include_payment_process": {
+ "type": "boolean"
+ },
+ "include_payment_process_company": {
+ "type": "boolean"
+ },
+ "include_payment_process_company_include_address": {
+ "type": "boolean"
+ },
+ "include_payment_process_company_include_address_city": {
+ "type": "string"
+ },
+ "include_payment_process_company_include_address_country": {
+ "type": "string"
+ },
+ "include_payment_process_company_include_address_state": {
+ "type": "string"
+ },
+ "include_payment_process_company_include_address_street_address": {
+ "type": "string"
+ },
+ "include_payment_process_company_include_address_zipcode": {
+ "type": "string"
+ },
+ "include_payment_process_company_include_email": {
+ "type": "boolean"
+ },
+ "include_payment_process_company_include_email_val": {
+ "type": "string"
+ },
+ "include_payment_process_partner": {
+ "type": "boolean"
+ },
+ "include_payment_process_partner_include_address": {
+ "type": "boolean"
+ },
+ "include_payment_process_partner_include_address_city": {
+ "type": "string"
+ },
+ "include_payment_process_partner_include_address_country": {
+ "type": "string"
+ },
+ "include_payment_process_partner_include_address_state": {
+ "type": "string"
+ },
+ "include_payment_process_partner_include_address_street_address": {
+ "type": "string"
+ },
+ "include_payment_process_partner_include_address_zipcode": {
+ "type": "string"
+ },
+ "include_payment_process_partner_include_email": {
+ "type": "boolean"
+ },
+ "include_payment_process_partner_include_email_val": {
+ "type": "string"
+ },
+ "include_payment_schedule": {
+ "type": "boolean"
+ },
+ "include_payment_schedule_custom": {
+ "type": "string"
+ },
+ "include_payment_schedule_specified_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_payment_schedule_specified_timeframe": {
+ "enum": [
+ "receipt",
+ "date"
+ ],
+ "type": "string"
+ },
+ "include_payment_schedule_specified_unit": {
+ "enum": [
+ "day(s)",
+ "week(s)",
+ "month(s)",
+ "quarter(s)",
+ "year(s)"
+ ],
+ "type": "string"
+ },
+ "include_payment_schedule_type": {
+ "enum": [
+ "specified",
+ "custom"
+ ],
+ "type": "string"
+ },
+ "negotiations_allowed": {
+ "type": "boolean"
+ },
+ "territory_type": {
+ "enum": [
+ "worldwide",
+ "custom"
+ ],
+ "type": "string"
+ },
+ "territory_type_val": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "payment_link_url": {
+ "description": "A payment URL shown to the recipient after signing. Requires include_billing_workflow to be true and billing_workflow_type to be \"link\".",
+ "type": "string"
+ },
+ "pilot_attributes": {
+ "additionalProperties": false,
+ "description": "Override pilot terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "fees_type": {
+ "enum": [
+ "free",
+ "pilot_period_fees"
+ ],
+ "type": "string"
+ },
+ "general_cap_amount": {
+ "type": "number"
+ },
+ "general_cap_amount_type": {
+ "enum": [
+ "preceding",
+ "base",
+ "period"
+ ],
+ "type": "string"
+ },
+ "general_cap_period_currency": {
+ "type": "number"
+ },
+ "general_cap_period_qty": {
+ "type": "number"
+ },
+ "general_cap_preceding_amount": {
+ "type": "number"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_dpa": {
+ "type": "boolean"
+ },
+ "include_dpa_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_dpa_location": {
+ "type": "string"
+ },
+ "include_dpa_type": {
+ "enum": [
+ "description",
+ "attachment",
+ "standard"
+ ],
+ "type": "string"
+ },
+ "include_payment_process": {
+ "type": "boolean"
+ },
+ "include_technical_support": {
+ "type": "boolean"
+ },
+ "negotiations_allowed": {
+ "type": "boolean"
+ },
+ "payment_process_automatic_frequency": {
+ "enum": [
+ "monthly",
+ "quarterly",
+ "annually",
+ "once_per_period"
+ ],
+ "type": "string"
+ },
+ "payment_process_invoice_days": {
+ "type": "number"
+ },
+ "payment_process_invoice_from": {
+ "enum": [
+ "receipt",
+ "date"
+ ],
+ "type": "string"
+ },
+ "payment_process_invoice_timeframe": {
+ "enum": [
+ "days",
+ "weeks",
+ "months",
+ "quarters",
+ "years"
+ ],
+ "type": "string"
+ },
+ "payment_process_type": {
+ "enum": [
+ "automatic",
+ "invoice"
+ ],
+ "type": "string"
+ },
+ "pilot_period_description": {
+ "type": "string"
+ },
+ "pilot_period_fees_description": {
+ "type": "string"
+ },
+ "product_description": {
+ "type": "string"
+ },
+ "technical_support_description": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "psa_attributes": {
+ "additionalProperties": false,
+ "description": "Override psa terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "additional_changes": {
+ "type": "string"
+ },
+ "customer_description": {
+ "type": "string"
+ },
+ "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": {
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "type": "string"
+ },
+ "general_cap_amount": {
+ "type": "number"
+ },
+ "general_cap_amount_type": {
+ "enum": [
+ "preceding",
+ "base",
+ "period"
+ ],
+ "type": "string"
+ },
+ "general_cap_period_currency": {
+ "type": "number"
+ },
+ "general_cap_period_qty": {
+ "type": "number"
+ },
+ "general_cap_preceding_amount": {
+ "type": "number"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_additional_changes": {
+ "type": "boolean"
+ },
+ "include_additional_warranties": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_by_customer": {
+ "type": "string"
+ },
+ "include_additional_warranties_by_provider": {
+ "type": "string"
+ },
+ "include_additional_warranties_include_by_customer": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_include_by_provider": {
+ "type": "boolean"
+ },
+ "include_covered_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_customer_claims": {
+ "type": "string"
+ },
+ "include_covered_claims_include_customer_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_include_provider_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_provider_claims": {
+ "type": "string"
+ },
+ "include_customer_insurance_min": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_add_provider_com_gen_liability": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_add_provider_cyber_liability": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_add_provider_errors_omissions": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_auto_liability_aggregate": {
+ "type": "number"
+ },
+ "include_customer_insurance_min_auto_liability_minimum": {
+ "type": "number"
+ },
+ "include_customer_insurance_min_cyber_liability_aggregate": {
+ "type": "number"
+ },
+ "include_customer_insurance_min_cyber_liability_minimum": {
+ "type": "number"
+ },
+ "include_customer_insurance_min_employer_liability_aggregate": {
+ "type": "number"
+ },
+ "include_customer_insurance_min_employer_liability_minimum": {
+ "type": "number"
+ },
+ "include_customer_insurance_min_general_liability_aggregate": {
+ "type": "number"
+ },
+ "include_customer_insurance_min_general_liability_minimum": {
+ "type": "number"
+ },
+ "include_customer_insurance_min_include_add_provider": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_include_auto_liability": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_include_cyber_liability": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_include_employer_liability": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_include_general_liability": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_include_workers_comp": {
+ "type": "boolean"
+ },
+ "include_customer_policies": {
+ "type": "boolean"
+ },
+ "include_customer_policies_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_customer_policies_location": {
+ "type": "string"
+ },
+ "include_customer_policies_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_dpa": {
+ "type": "boolean"
+ },
+ "include_dpa_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_dpa_location": {
+ "type": "string"
+ },
+ "include_dpa_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_increased_cap_amount": {
+ "type": "boolean"
+ },
+ "include_increased_claims": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_confidentiality": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_confidentiality_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_privsec": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_privsec_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_other": {
+ "type": "boolean"
+ },
+ "include_increased_claims_indemnification_obligation": {
+ "type": "boolean"
+ },
+ "include_increased_claims_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_other": {
+ "type": "string"
+ },
+ "include_provider_insurance_min": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_add_customer_com_gen_liability": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_add_customer_cyber_liability": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_add_customer_errors_omissions": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_auto_liability_aggregate": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_auto_liability_minimum": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_cyber_liability_aggregate": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_cyber_liability_minimum": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_employer_liability_aggregate": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_employer_liability_minimum": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_general_liability_aggregate": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_general_liability_minimum": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_include_add_customer": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_include_auto_liability": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_include_cyber_liability": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_include_employer_liability": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_include_general_liability": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_include_workers_comp": {
+ "type": "boolean"
+ },
+ "include_publicity_rights": {
+ "type": "boolean"
+ },
+ "include_publicity_rights_type": {
+ "enum": [
+ "public",
+ "non-public"
+ ],
+ "type": "string"
+ },
+ "include_security_policy": {
+ "type": "boolean"
+ },
+ "include_security_policy_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_security_policy_fedramp_auth": {
+ "type": "boolean"
+ },
+ "include_security_policy_hitrust": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_annual_maintenance": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_other": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_other_val": {
+ "type": "string"
+ },
+ "include_security_policy_iso27001": {
+ "type": "boolean"
+ },
+ "include_security_policy_location": {
+ "type": "string"
+ },
+ "include_security_policy_pci1": {
+ "type": "boolean"
+ },
+ "include_security_policy_pci2": {
+ "type": "boolean"
+ },
+ "include_security_policy_penetration_testing": {
+ "type": "boolean"
+ },
+ "include_security_policy_soc2_type1": {
+ "type": "boolean"
+ },
+ "include_security_policy_soc2_type2": {
+ "type": "boolean"
+ },
+ "include_security_policy_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_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": "string"
+ },
+ "increased_cap_amount_currency": {
+ "type": "number"
+ },
+ "increased_cap_amount_period_currency": {
+ "type": "number"
+ },
+ "increased_cap_amount_period_qty": {
+ "type": "number"
+ },
+ "increased_cap_amount_qty": {
+ "type": "number"
+ },
+ "increased_cap_amount_type": {
+ "enum": [
+ "qty",
+ "currency",
+ "period"
+ ],
+ "type": "string"
+ },
+ "negotiations_allowed": {
+ "type": "boolean"
+ },
+ "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": "string"
+ },
+ "include_deliverables": {
+ "type": "boolean"
+ },
+ "include_deliverables_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_deliverables_description": {
+ "type": "string"
+ },
+ "include_deliverables_include_acceptance": {
+ "type": "boolean"
+ },
+ "include_deliverables_include_attachment": {
+ "type": "boolean"
+ },
+ "include_deliverables_include_draft_deliverables": {
+ "type": "boolean"
+ },
+ "include_deliverables_rejection_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_deliverables_rejection_unit": {
+ "enum": [
+ "hours",
+ "days",
+ "weeks",
+ "months"
+ ],
+ "type": "string"
+ },
+ "include_deliverables_resubmission_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_deliverables_resubmission_unit": {
+ "enum": [
+ "hours",
+ "days",
+ "weeks",
+ "months"
+ ],
+ "type": "string"
+ },
+ "include_fees_other": {
+ "type": "boolean"
+ },
+ "include_fees_other_val": {
+ "type": "string"
+ },
+ "include_fees_table": {
+ "type": "boolean"
+ },
+ "include_fees_table_total": {
+ "type": "boolean"
+ },
+ "include_fees_travel": {
+ "type": "boolean"
+ },
+ "include_fees_travel_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_fees_travel_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_fees_travel_val": {
+ "type": "string"
+ },
+ "include_third_party_customer": {
+ "type": "boolean"
+ },
+ "include_third_party_include_description": {
+ "type": "boolean"
+ },
+ "include_third_party_include_description_val": {
+ "type": "string"
+ },
+ "include_third_party_materials": {
+ "type": "boolean"
+ },
+ "include_third_party_provider": {
+ "type": "boolean"
+ },
+ "include_time_of_assignment": {
+ "type": "boolean"
+ },
+ "include_time_of_assignment_type": {
+ "enum": [
+ "created",
+ "paid"
+ ],
+ "type": "string"
+ },
+ "invoice_period_description": {
+ "type": "string"
+ },
+ "negotiations_allowed": {
+ "type": "boolean"
+ },
+ "payment_period": {
+ "type": "number"
+ },
+ "payment_period_other": {
+ "type": "string"
+ },
+ "payment_period_timeframe": {
+ "enum": [
+ "receipt",
+ "invoice",
+ "Customer's receipt of invoice",
+ "date of invoice"
+ ],
+ "type": "string"
+ },
+ "payment_period_type": {
+ "enum": [
+ "standard",
+ "other"
+ ],
+ "type": "string"
+ },
+ "payment_period_unit": {
+ "enum": [
+ "day(s)",
+ "week(s)",
+ "month(s)",
+ "quarter(s)",
+ "year(s)"
+ ],
+ "type": "string"
+ },
+ "quantity": {
+ "type": "number"
+ },
+ "services_description": {
+ "type": "string"
+ },
+ "sow_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "sow_date_type": {
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "type": "string"
+ },
+ "sow_term_amount": {
+ "type": "number"
+ },
+ "sow_term_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "sow_term_type": {
+ "enum": [
+ "deliverables",
+ "period",
+ "date"
+ ],
+ "type": "string"
+ },
+ "sow_term_unit": {
+ "enum": [
+ "month(s)",
+ "quarter(s)",
+ "year(s)"
+ ],
+ "type": "string"
+ },
+ "type": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "recipient_email": {
+ "format": "email",
+ "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-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": {
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "type": "string"
+ },
+ "general_cap_amount": {
+ "type": "number"
+ },
+ "general_cap_amount_type": {
+ "enum": [
+ "preceding",
+ "base",
+ "period"
+ ],
+ "type": "string"
+ },
+ "general_cap_period_currency": {
+ "type": "number"
+ },
+ "general_cap_period_qty": {
+ "type": "number"
+ },
+ "general_cap_preceding_amount": {
+ "type": "number"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_additional_warranties": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_by_customer": {
+ "type": "string"
+ },
+ "include_additional_warranties_by_provider": {
+ "type": "string"
+ },
+ "include_additional_warranties_include_by_customer": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_include_by_provider": {
+ "type": "boolean"
+ },
+ "include_ai_addendum": {
+ "type": "boolean"
+ },
+ "include_ai_addendum_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_covered_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_customer_claims": {
+ "type": "string"
+ },
+ "include_covered_claims_include_customer_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_include_provider_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_provider_claims": {
+ "type": "string"
+ },
+ "include_dpa": {
+ "type": "boolean"
+ },
+ "include_dpa_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_dpa_location": {
+ "type": "string"
+ },
+ "include_dpa_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_increased_cap_amount": {
+ "type": "boolean"
+ },
+ "include_increased_claims": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_confidentiality": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_confidentiality_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_other": {
+ "type": "boolean"
+ },
+ "include_increased_claims_indemnification_obligation": {
+ "type": "boolean"
+ },
+ "include_increased_claims_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_other": {
+ "type": "string"
+ },
+ "include_increased_claims_restrictions": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_confidentiality": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_confidentiality_negligence": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_include_other": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_indemnification_obligation": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_license_or_restrictions": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_negligence": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_other": {
+ "type": "string"
+ },
+ "increased_cap_amount_currency": {
+ "type": "number"
+ },
+ "increased_cap_amount_period_currency": {
+ "type": "number"
+ },
+ "increased_cap_amount_period_qty": {
+ "type": "number"
+ },
+ "increased_cap_amount_qty": {
+ "type": "number"
+ },
+ "increased_cap_amount_type": {
+ "enum": [
+ "qty",
+ "currency",
+ "period"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "software_license_order_form_attributes": {
+ "additionalProperties": false,
+ "description": "Override software license order form terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "additional_changes": {
+ "type": "string"
+ },
+ "deletion_procedure_include_custom": {
+ "type": "boolean"
+ },
+ "deletion_procedure_include_custom_description": {
+ "type": "string"
+ },
+ "deletion_procedure_include_customer_disable": {
+ "type": "boolean"
+ },
+ "deletion_procedure_include_customer_proof": {
+ "type": "boolean"
+ },
+ "deletion_procedure_include_provider_disable": {
+ "type": "boolean"
+ },
+ "fee_custom_unit": {
+ "type": "string"
+ },
+ "fee_period": {
+ "enum": [
+ "Subscription Period",
+ "month",
+ "year",
+ "Custom unit"
+ ],
+ "type": "string"
+ },
+ "fees_attributes": {
+ "additionalProperties": {
+ "anyOf": [
+ {
+ "additionalProperties": false,
+ "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": {
+ "enum": [
+ "USD",
+ "EUR",
+ "GBP",
+ "CAD",
+ "AUD",
+ "SGD",
+ "ILS",
+ "JPY",
+ "CHF",
+ "HKD"
+ ],
+ "type": "string"
+ },
+ "fees_include_fee_increase_upon_renewal": {
+ "type": "boolean"
+ },
+ "fees_include_fee_increase_upon_renewal_fee": {
+ "type": "number"
+ },
+ "fees_include_fee_increase_upon_renewal_type": {
+ "enum": [
+ "will",
+ "may"
+ ],
+ "type": "string"
+ },
+ "fees_inclusive_of_taxes": {
+ "type": "boolean"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_additional_changes": {
+ "type": "boolean"
+ },
+ "include_license_compliance_verification": {
+ "type": "boolean"
+ },
+ "include_license_compliance_verification_description": {
+ "type": "string"
+ },
+ "include_license_limits": {
+ "type": "boolean"
+ },
+ "include_license_limits_description": {
+ "type": "string"
+ },
+ "include_payment_process_include_billing_email": {
+ "type": "boolean"
+ },
+ "include_pilot_period": {
+ "type": "boolean"
+ },
+ "include_pilot_period_duration_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_pilot_period_duration_type": {
+ "enum": [
+ "day",
+ "week",
+ "month"
+ ],
+ "type": "string"
+ },
+ "include_pilot_period_include_fees": {
+ "type": "boolean"
+ },
+ "include_pilot_period_include_fees_amount": {
+ "type": "number"
+ },
+ "include_pilot_period_include_modifications": {
+ "type": "boolean"
+ },
+ "include_pilot_period_include_modifications_description": {
+ "type": "string"
+ },
+ "include_services": {
+ "type": "boolean"
+ },
+ "include_services_description": {
+ "type": "string"
+ },
+ "negotiations_allowed": {
+ "type": "boolean"
+ },
+ "order_date_date": {
+ "type": "string"
+ },
+ "order_date_type": {
+ "enum": [
+ "signature",
+ "date",
+ "other"
+ ],
+ "type": "string"
+ },
+ "payment_process_automatic_frequency": {
+ "enum": [
+ "monthly",
+ "quarterly",
+ "semiannually",
+ "annually"
+ ],
+ "type": "string"
+ },
+ "payment_process_type": {
+ "enum": [
+ "automatic",
+ "invoice",
+ "custom"
+ ],
+ "type": "string"
+ },
+ "payment_process_type_custom_val": {
+ "type": "string"
+ },
+ "payment_process_type_invoice_amount": {
+ "type": "number"
+ },
+ "payment_process_type_invoice_custom_unit": {
+ "type": "string"
+ },
+ "payment_process_type_invoice_duration": {
+ "enum": [
+ "day",
+ "week",
+ "month",
+ "year",
+ "day(s)",
+ "week(s)",
+ "month(s)",
+ "year(s)"
+ ],
+ "type": "string"
+ },
+ "payment_process_type_invoice_duration_start": {
+ "enum": [
+ "Customer's receipt of invoice",
+ "date of invoice"
+ ],
+ "type": "string"
+ },
+ "payment_process_type_invoice_type": {
+ "enum": [
+ "monthly",
+ "quarterly",
+ "semiannually",
+ "annually",
+ "Custom unit"
+ ],
+ "type": "string"
+ },
+ "permitted_uses_include_custom": {
+ "type": "boolean"
+ },
+ "permitted_uses_include_custom_description": {
+ "type": "string"
+ },
+ "permitted_uses_include_customers_affiliates": {
+ "type": "boolean"
+ },
+ "permitted_uses_include_internal_business": {
+ "type": "boolean"
+ },
+ "pilot_period_stripe_product_id": {
+ "type": "string"
+ },
+ "software_description": {
+ "type": "string"
+ },
+ "subscription_auto_renew": {
+ "enum": [
+ "days",
+ "subscription_end"
+ ],
+ "type": "string"
+ },
+ "subscription_period": {
+ "type": "number"
+ },
+ "subscription_period_unit": {
+ "type": "string"
+ },
+ "subscription_renewal_notice_days": {
+ "type": "number"
+ },
+ "warranty_period_description_amount": {
+ "type": "number"
+ },
+ "warranty_period_description_duration": {
+ "enum": [
+ "day",
+ "week",
+ "month",
+ "year"
+ ],
+ "type": "string"
+ },
+ "warranty_period_description_duration_start": {
+ "enum": [
+ "initial delivery of the Software",
+ "delivery of the Software and each subsequent Update",
+ "the Order Date"
+ ],
+ "type": "string"
+ },
+ "warranty_period_type": {
+ "enum": [
+ "description",
+ "none"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "test_agreement": {
+ "description": "When true, marks the agreement as a test. Test agreements do not count against your monthly limit.",
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "recipient_name",
+ "recipient_email"
+ ],
+ "type": "object"
+ },
+ "cc_users": {
+ "items": {
+ "format": "email",
+ "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-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": {
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "type": "string"
+ },
+ "framework_terms_type": {
+ "type": "string"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "parent_agreement_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "underlying_agreement_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "underlying_agreement_type": {
+ "type": "string"
+ },
+ "underlying_agreement_val": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "baa_attributes": {
+ "additionalProperties": false,
+ "description": "Override baa terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "aggregation_limitations_permitted": {
+ "type": "boolean"
+ },
+ "aggregation_limitations_permitted_val": {
+ "type": "string"
+ },
+ "breach_notification_unit": {
+ "enum": [
+ "hours",
+ "business days",
+ "calendar days"
+ ],
+ "type": "string"
+ },
+ "breach_notification_val": {
+ "type": "number"
+ },
+ "business_associate_relationship_type": {
+ "enum": [
+ "provider",
+ "company"
+ ],
+ "type": "string"
+ },
+ "deidentification_limitations_include_purpose": {
+ "type": "boolean"
+ },
+ "deidentification_limitations_include_requirements": {
+ "type": "boolean"
+ },
+ "deidentification_limitations_permitted": {
+ "type": "boolean"
+ },
+ "deidentification_limitations_purpose_val": {
+ "type": "string"
+ },
+ "deidentification_limitations_requirements_val": {
+ "type": "string"
+ },
+ "designated_record_set_provider_maintains": {
+ "type": "boolean"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_aggregation_limitations": {
+ "type": "boolean"
+ },
+ "include_deidentification_limitations": {
+ "type": "boolean"
+ },
+ "include_limitations": {
+ "type": "boolean"
+ },
+ "include_offshore_limitations": {
+ "type": "boolean"
+ },
+ "include_subcontract_limitations": {
+ "type": "boolean"
+ },
+ "offshore_limitations_permitted": {
+ "type": "boolean"
+ },
+ "offshore_limitations_permitted_val": {
+ "type": "string"
+ },
+ "subcontract_limitations_include_notice": {
+ "type": "boolean"
+ },
+ "subcontract_limitations_include_permission": {
+ "type": "boolean"
+ },
+ "subcontract_limitations_notice_val": {
+ "type": "string"
+ },
+ "subcontract_limitations_permission_val": {
+ "type": "string"
+ },
+ "subcontract_limitations_permitted": {
+ "type": "boolean"
+ },
+ "underlying_agreement_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "underlying_agreement_type": {
+ "enum": [
+ "internal",
+ "external",
+ "none"
+ ],
+ "type": "string"
+ },
+ "underlying_agreement_val": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "billing_email": {
+ "description": "Email of the billing contact. Used when include_billing_info is true.",
+ "format": "email",
+ "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-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": {
+ "enum": [
+ "AWS",
+ "GCP",
+ "Azure"
+ ],
+ "type": "string"
+ },
+ "effective_date_type": {
+ "enum": [
+ "signature",
+ "date",
+ "marketplace_acceptance"
+ ],
+ "type": "string"
+ },
+ "general_cap_amount": {
+ "type": "number"
+ },
+ "general_cap_amount_type": {
+ "enum": [
+ "preceding",
+ "base",
+ "period"
+ ],
+ "type": "string"
+ },
+ "general_cap_period_currency": {
+ "type": "number"
+ },
+ "general_cap_period_qty": {
+ "type": "number"
+ },
+ "general_cap_preceding_amount": {
+ "type": "number"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_acceptable_use_policy": {
+ "type": "boolean"
+ },
+ "include_acceptable_use_policy_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_acceptable_use_policy_location": {
+ "type": "string"
+ },
+ "include_acceptable_use_policy_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_additional_warranties": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_by_customer": {
+ "type": "string"
+ },
+ "include_additional_warranties_by_provider": {
+ "type": "string"
+ },
+ "include_additional_warranties_include_by_customer": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_include_by_provider": {
+ "type": "boolean"
+ },
+ "include_ai_addendum": {
+ "type": "boolean"
+ },
+ "include_ai_addendum_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_covered_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_customer_claims": {
+ "type": "string"
+ },
+ "include_covered_claims_include_customer_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_include_provider_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_provider_claims": {
+ "type": "string"
+ },
+ "include_dpa": {
+ "type": "boolean"
+ },
+ "include_dpa_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_dpa_location": {
+ "type": "string"
+ },
+ "include_dpa_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_increased_cap_amount": {
+ "type": "boolean"
+ },
+ "include_increased_claims": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_confidentiality": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_confidentiality_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_privsec": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_privsec_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_other": {
+ "type": "boolean"
+ },
+ "include_increased_claims_indemnification_obligation": {
+ "type": "boolean"
+ },
+ "include_increased_claims_other": {
+ "type": "string"
+ },
+ "include_insurance_minimums": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_add_customer": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_add_customer_com_gen_liability": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_add_customer_cyber_liability": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_add_customer_errors_omissions": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_additional_information": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_additional_information_text": {
+ "type": "string"
+ },
+ "include_insurance_minimums_cyber_liability_aggregate": {
+ "type": "number"
+ },
+ "include_insurance_minimums_cyber_liability_minimum": {
+ "type": "number"
+ },
+ "include_insurance_minimums_employer_liability_aggregate": {
+ "type": "number"
+ },
+ "include_insurance_minimums_employer_liability_minimum": {
+ "type": "number"
+ },
+ "include_insurance_minimums_general_liability_aggregate": {
+ "type": "number"
+ },
+ "include_insurance_minimums_general_liability_minimum": {
+ "type": "number"
+ },
+ "include_insurance_minimums_include_cyber_liability": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_include_employer_liability": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_include_general_liability": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_include_workers_compensation": {
+ "type": "boolean"
+ },
+ "include_publicity_rights": {
+ "type": "boolean"
+ },
+ "include_publicity_rights_type": {
+ "enum": [
+ "public",
+ "non-public"
+ ],
+ "type": "string"
+ },
+ "include_security_policy": {
+ "type": "boolean"
+ },
+ "include_security_policy_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_security_policy_fedramp_auth": {
+ "type": "boolean"
+ },
+ "include_security_policy_hipaa": {
+ "type": "boolean"
+ },
+ "include_security_policy_hitrust": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_annual_maintenance": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_location": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_other": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_reasonable_efforts": {
+ "type": "boolean"
+ },
+ "include_security_policy_iso27001": {
+ "type": "boolean"
+ },
+ "include_security_policy_location": {
+ "type": "string"
+ },
+ "include_security_policy_other": {
+ "type": "string"
+ },
+ "include_security_policy_pci1": {
+ "type": "boolean"
+ },
+ "include_security_policy_pci2": {
+ "type": "boolean"
+ },
+ "include_security_policy_penetration_testing": {
+ "type": "boolean"
+ },
+ "include_security_policy_soc2": {
+ "type": "boolean"
+ },
+ "include_security_policy_soc2_type2": {
+ "type": "boolean"
+ },
+ "include_security_policy_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_supercap": {
+ "description": "CSA 3.0 renamed `include_increased_cap_amount` to `include_supercap`. Use this name when the agreement's `standard_version` is 3.x; on earlier versions use `include_increased_cap_amount`. Sending the other spelling returns a 422.",
+ "type": "boolean"
+ },
+ "include_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": "string"
+ },
+ "increased_cap_amount_currency": {
+ "type": "number"
+ },
+ "increased_cap_amount_period_currency": {
+ "type": "number"
+ },
+ "increased_cap_amount_period_qty": {
+ "type": "number"
+ },
+ "increased_cap_amount_qty": {
+ "type": "number"
+ },
+ "increased_cap_amount_type": {
+ "enum": [
+ "qty",
+ "currency",
+ "period"
+ ],
+ "type": "string"
+ },
+ "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": "string"
+ },
+ "affiliates_as_users": {
+ "type": "boolean"
+ },
+ "cloud_service_description": {
+ "type": "string"
+ },
+ "consumption_units": {
+ "type": "string"
+ },
+ "fee_amount": {
+ "type": "number"
+ },
+ "fee_custom_unit": {
+ "type": "string"
+ },
+ "fee_period": {
+ "enum": [
+ "Subscription Period",
+ "month",
+ "year",
+ "User",
+ "Custom unit"
+ ],
+ "type": "string"
+ },
+ "fees_attributes": {
+ "additionalProperties": {
+ "anyOf": [
+ {
+ "additionalProperties": false,
+ "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": {
+ "enum": [
+ "USD",
+ "EUR",
+ "GBP",
+ "CAD",
+ "AUD",
+ "SGD",
+ "ILS",
+ "JPY",
+ "CHF",
+ "HKD"
+ ],
+ "type": "string"
+ },
+ "fees_include_fee_increase_upon_renewal": {
+ "type": "boolean"
+ },
+ "fees_include_fee_increase_upon_renewal_fee": {
+ "type": "number"
+ },
+ "fees_include_fee_increase_upon_renewal_type": {
+ "enum": [
+ "will",
+ "may"
+ ],
+ "type": "string"
+ },
+ "fees_inclusive_of_taxes": {
+ "type": "boolean"
+ },
+ "framework_terms_type": {
+ "enum": [
+ "new",
+ "existing",
+ "description"
+ ],
+ "type": "string"
+ },
+ "free_trial_days": {
+ "type": "number"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_additional_changes": {
+ "type": "boolean"
+ },
+ "include_additional_parameters_or_limitations": {
+ "type": "boolean"
+ },
+ "include_consumption": {
+ "type": "boolean"
+ },
+ "include_fees": {
+ "type": "boolean"
+ },
+ "include_fees_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_fees_include_attachment": {
+ "type": "boolean"
+ },
+ "include_fees_other": {
+ "type": "boolean"
+ },
+ "include_fees_other_val": {
+ "type": "string"
+ },
+ "include_fees_table": {
+ "type": "boolean"
+ },
+ "include_fees_table_period": {
+ "enum": [
+ "Subscription Period",
+ "month",
+ "year",
+ "User"
+ ],
+ "type": "string"
+ },
+ "include_free_trial": {
+ "type": "boolean"
+ },
+ "include_max_users": {
+ "type": "boolean"
+ },
+ "include_pilot_period": {
+ "type": "boolean"
+ },
+ "include_pilot_period_duration_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_pilot_period_duration_type": {
+ "enum": [
+ "day",
+ "week",
+ "month"
+ ],
+ "type": "string"
+ },
+ "include_pilot_period_include_fees": {
+ "type": "boolean"
+ },
+ "include_pilot_period_include_fees_amount": {
+ "type": "number"
+ },
+ "include_pilot_period_include_modifications": {
+ "type": "boolean"
+ },
+ "include_pilot_period_include_modifications_description": {
+ "type": "string"
+ },
+ "include_product_support": {
+ "type": "boolean"
+ },
+ "include_product_support_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_product_support_description": {
+ "type": "string"
+ },
+ "include_product_support_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_professional_services": {
+ "type": "boolean"
+ },
+ "include_professional_services_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_professional_services_custom_name": {
+ "type": "string"
+ },
+ "include_professional_services_description": {
+ "type": "string"
+ },
+ "include_professional_services_end_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "include_professional_services_fees_description": {
+ "type": "string"
+ },
+ "include_professional_services_include_end_date": {
+ "type": "boolean"
+ },
+ "include_professional_services_include_fees_description": {
+ "type": "boolean"
+ },
+ "include_professional_services_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_sla": {
+ "type": "boolean"
+ },
+ "include_sla_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_sla_description": {
+ "type": "string"
+ },
+ "include_sla_include_response_time": {
+ "type": "boolean"
+ },
+ "include_sla_include_response_time_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_sla_include_response_time_credit": {
+ "type": "number"
+ },
+ "include_sla_include_response_time_duration": {
+ "enum": [
+ "hour",
+ "day",
+ "week",
+ "month",
+ "hours"
+ ],
+ "type": "string"
+ },
+ "include_sla_include_response_time_support_channel": {
+ "type": "string"
+ },
+ "include_sla_include_target_uptime": {
+ "type": "boolean"
+ },
+ "include_sla_maintenance_notice": {
+ "type": "boolean"
+ },
+ "include_sla_maintenance_window": {
+ "type": "boolean"
+ },
+ "include_sla_maintenance_window_type": {
+ "enum": [
+ "standard",
+ "none"
+ ],
+ "type": "string"
+ },
+ "include_sla_standard_maintenance_notice_qty": {
+ "type": "number"
+ },
+ "include_sla_standard_maintenance_notice_unit": {
+ "enum": [
+ "hour",
+ "day",
+ "week",
+ "month"
+ ],
+ "type": "string"
+ },
+ "include_sla_standard_maintenance_window_end_time": {
+ "type": "string"
+ },
+ "include_sla_standard_maintenance_window_friday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_monday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_saturday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_start_time": {
+ "type": "string"
+ },
+ "include_sla_standard_maintenance_window_sunday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_thursday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_time_zone": {
+ "type": "string"
+ },
+ "include_sla_standard_maintenance_window_tuesday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_wednesday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_target_uptime": {
+ "type": "number"
+ },
+ "include_sla_type": {
+ "enum": [
+ "description",
+ "standard",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_subscription_start_date": {
+ "type": "boolean"
+ },
+ "include_subscription_start_date_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "include_usage_review": {
+ "type": "boolean"
+ },
+ "include_usage_review_val": {
+ "type": "string"
+ },
+ "include_use_limitations": {
+ "type": "boolean"
+ },
+ "include_use_limitations_val": {
+ "type": "string"
+ },
+ "invoice_period": {
+ "enum": [
+ "monthly",
+ "quarterly",
+ "semiannually",
+ "annually",
+ "Custom unit",
+ "Monthly",
+ "Quarterly",
+ "Semiannually",
+ "Annually"
+ ],
+ "type": "string"
+ },
+ "invoice_period_custom_unit": {
+ "type": "string"
+ },
+ "max_consumption": {
+ "type": "number"
+ },
+ "max_users": {
+ "type": "number"
+ },
+ "negotiations_allowed": {
+ "type": "boolean"
+ },
+ "order_date_date": {
+ "type": "string"
+ },
+ "order_date_other": {
+ "type": "string"
+ },
+ "order_date_type": {
+ "enum": [
+ "signature",
+ "date",
+ "other"
+ ],
+ "type": "string"
+ },
+ "payment_period": {
+ "type": "number"
+ },
+ "payment_period_timeframe": {
+ "enum": [
+ "Customer's receipt of invoice",
+ "date of invoice"
+ ],
+ "type": "string"
+ },
+ "payment_period_unit": {
+ "enum": [
+ "day(s)",
+ "week(s)",
+ "month(s)",
+ "marketplace_acceptance"
+ ],
+ "type": "string"
+ },
+ "payment_process_automatic_frequency": {
+ "enum": [
+ "monthly",
+ "quarterly",
+ "semiannually",
+ "annually"
+ ],
+ "type": "string"
+ },
+ "payment_process_type": {
+ "enum": [
+ "automatic",
+ "invoice",
+ "custom",
+ "marketplace_acceptance"
+ ],
+ "type": "string"
+ },
+ "payment_process_type_custom_val": {
+ "type": "string"
+ },
+ "payment_process_type_invoice_amount": {
+ "type": "number"
+ },
+ "payment_process_type_invoice_custom_unit": {
+ "type": "string"
+ },
+ "payment_process_type_invoice_duration": {
+ "enum": [
+ "day",
+ "week",
+ "month",
+ "year",
+ "day(s)",
+ "week(s)",
+ "month(s)",
+ "year(s)"
+ ],
+ "type": "string"
+ },
+ "payment_process_type_invoice_duration_start": {
+ "enum": [
+ "Customer's receipt of invoice",
+ "date of invoice"
+ ],
+ "type": "string"
+ },
+ "payment_process_type_invoice_type": {
+ "enum": [
+ "monthly",
+ "quarterly",
+ "semiannually",
+ "annually",
+ "Custom unit"
+ ],
+ "type": "string"
+ },
+ "pilot_period_stripe_product_id": {
+ "type": "string"
+ },
+ "service_credits_attributes": {
+ "additionalProperties": {
+ "additionalProperties": false,
+ "properties": {
+ "credit": {
+ "type": "number"
+ },
+ "max": {
+ "type": "number"
+ },
+ "min": {
+ "type": "number"
+ }
+ },
+ "type": "object"
+ },
+ "description": "Service credits. Use string keys such as \"0\", \"1\".",
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+ },
+ "subscription_auto_renew": {
+ "enum": [
+ "days",
+ "subscription_end"
+ ],
+ "type": "string"
+ },
+ "subscription_period": {
+ "type": "number"
+ },
+ "subscription_period_unit": {
+ "type": "string"
+ },
+ "subscription_renewal_notice_days": {
+ "type": "number"
+ },
+ "subscription_start_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "subscription_start_date_type": {
+ "enum": [
+ "effective_date",
+ "date"
+ ],
+ "type": "string"
+ },
+ "underlying_agreement_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "use_limitations_attributes": {
+ "additionalProperties": {
+ "additionalProperties": false,
+ "properties": {
+ "amount": {
+ "type": "number"
+ },
+ "limitation_type": {
+ "type": "string"
+ },
+ "unit": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "description": "Use limitations. Use string keys such as \"0\", \"1\".",
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+ }
+ },
+ "type": "object"
+ },
+ "custom_field_values": {
+ "description": "Values for a custom template's fields, keyed by the field keys defined in the template's YAML definition. Only used when template_id is a custom template. Template defaults fill any fields you omit; a required field with no default and no submitted value returns a 400 naming the field. Values are validated against the field's input type: select and radio values must be one of the field's options, multiselect values are an array of selections each of which must be one of the field's options, number and currency values must be numeric, date values must be YYYY-MM-DD, and email values must be valid addresses. An invalid value returns a 400 naming the field."
+ },
+ "design_partner_attributes": {
+ "additionalProperties": false,
+ "description": "Override design partner terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "customer_description": {
+ "type": "string"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_fees": {
+ "type": "boolean"
+ },
+ "include_fees_amount": {
+ "type": "number"
+ },
+ "include_fees_description": {
+ "type": "string"
+ },
+ "include_fees_pay_by_amount": {
+ "type": "string"
+ },
+ "include_fees_type": {
+ "enum": [
+ "default_language",
+ "description"
+ ],
+ "type": "string"
+ },
+ "include_fees_unit": {
+ "enum": [
+ "month",
+ "quarter",
+ "year",
+ "Term"
+ ],
+ "type": "string"
+ },
+ "include_program_appear_as_customer_private": {
+ "type": "boolean"
+ },
+ "include_program_appear_as_customer_public": {
+ "type": "boolean"
+ },
+ "include_program_case_study": {
+ "type": "boolean"
+ },
+ "include_program_develop_functionality": {
+ "type": "boolean"
+ },
+ "include_program_develop_functionality_val": {
+ "type": "string"
+ },
+ "include_program_discount": {
+ "type": "boolean"
+ },
+ "include_program_discount_amount": {
+ "type": "number"
+ },
+ "include_program_discount_unit": {
+ "enum": [
+ "U.S. Dollars",
+ "percent"
+ ],
+ "type": "string"
+ },
+ "include_program_participation_feedback": {
+ "type": "boolean"
+ },
+ "include_program_participation_feedback_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_program_participation_feedback_unit": {
+ "enum": [
+ "month",
+ "quarter",
+ "year",
+ "Term"
+ ],
+ "type": "string"
+ },
+ "include_program_partner_other": {
+ "type": "boolean"
+ },
+ "include_program_partner_other_val": {
+ "type": "string"
+ },
+ "include_program_provider_other": {
+ "type": "boolean"
+ },
+ "include_program_provider_other_val": {
+ "type": "string"
+ },
+ "include_program_reference": {
+ "type": "boolean"
+ },
+ "product_description": {
+ "type": "string"
+ },
+ "term_amount": {
+ "type": "number"
+ },
+ "term_unit": {
+ "enum": [
+ "day(s)",
+ "week(s)",
+ "month(s)",
+ "quarter(s)",
+ "year(s)"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "district_or_county": {
+ "description": "The district or county for dispute resolution.",
+ "type": "string"
+ },
+ "dpa_attributes": {
+ "additionalProperties": false,
+ "description": "Override dpa terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "approved_subprocessor_type": {
+ "description": "`internal` lists approved subprocessors in the agreement (`subprocessors_attributes`); `external` points to a list published elsewhere.",
+ "enum": [
+ "internal",
+ "external"
+ ],
+ "type": "string"
+ },
+ "cloud_service_product_name": {
+ "type": "string"
+ },
+ "competent_supervisory_authority": {
+ "type": "string"
+ },
+ "customer_description": {
+ "type": "string"
+ },
+ "data_exporter_address_city": {
+ "type": "string"
+ },
+ "data_exporter_address_country": {
+ "type": "string"
+ },
+ "data_exporter_address_state": {
+ "type": "string"
+ },
+ "data_exporter_address_street_address": {
+ "type": "string"
+ },
+ "data_exporter_address_zipcode": {
+ "type": "string"
+ },
+ "data_exporter_contact_details": {
+ "type": "string"
+ },
+ "data_exporter_contact_name": {
+ "type": "string"
+ },
+ "data_exporter_contact_position": {
+ "type": "string"
+ },
+ "data_exporter_role": {
+ "description": "Role of the data exporter. Overwritten to `Controller` when the agreement is created from a template.",
+ "enum": [
+ "Controller",
+ "Processor"
+ ],
+ "type": "string"
+ },
+ "data_importer_address": {
+ "type": "string"
+ },
+ "data_importer_address_city": {
+ "type": "string"
+ },
+ "data_importer_address_country": {
+ "type": "string"
+ },
+ "data_importer_address_state": {
+ "type": "string"
+ },
+ "data_importer_address_street_address": {
+ "type": "string"
+ },
+ "data_importer_address_zipcode": {
+ "type": "string"
+ },
+ "data_importer_contact_details": {
+ "type": "string"
+ },
+ "data_importer_contact_name": {
+ "type": "string"
+ },
+ "data_importer_contact_position": {
+ "type": "string"
+ },
+ "duration_of_processing": {
+ "type": "string"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_covered_claim": {
+ "type": "boolean"
+ },
+ "include_covered_claim_external_val": {
+ "type": "string"
+ },
+ "include_covered_claim_internal_val": {
+ "type": "string"
+ },
+ "include_covered_claim_type": {
+ "description": "Which covered-claim text applies: `internal` uses `include_covered_claim_internal_val`, `external` uses `include_covered_claim_external_val`. Required when `include_covered_claim` is true.",
+ "enum": [
+ "internal",
+ "external"
+ ],
+ "type": "string"
+ },
+ "include_data_subjects_custom": {
+ "type": "boolean"
+ },
+ "include_data_subjects_custom_val": {
+ "type": "string"
+ },
+ "include_data_subjects_employees": {
+ "type": "boolean"
+ },
+ "include_data_subjects_end_users": {
+ "type": "boolean"
+ },
+ "include_external_subprocessor_location": {
+ "type": "string"
+ },
+ "include_frequency_of_transfer_continuous": {
+ "type": "boolean"
+ },
+ "include_frequency_of_transfer_custom": {
+ "type": "boolean"
+ },
+ "include_frequency_of_transfer_custom_val": {
+ "type": "string"
+ },
+ "include_governing_country_eu": {
+ "type": "boolean"
+ },
+ "include_governing_country_eu_val": {
+ "type": "string"
+ },
+ "include_governing_country_uk": {
+ "type": "boolean"
+ },
+ "include_governing_country_uk_val": {
+ "type": "string"
+ },
+ "include_governing_law": {
+ "type": "boolean"
+ },
+ "include_governing_law_country": {
+ "type": "string"
+ },
+ "include_governing_law_state": {
+ "type": "string"
+ },
+ "include_increased_claim_amount": {
+ "description": "Legacy field. Stored but not shown on the DPA; use the `include_liability_cap*` fields instead.",
+ "type": "boolean"
+ },
+ "include_increased_claim_amount_currency": {
+ "description": "Legacy field. Stored but not shown on the DPA; use the `include_liability_cap*` fields instead."
+ },
+ "include_increased_claim_amount_qty": {
+ "description": "Legacy field. Stored but not shown on the DPA; use the `include_liability_cap*` fields instead."
+ },
+ "include_increased_claim_amount_type": {
+ "description": "Legacy field. Stored but not shown on the DPA; use the `include_liability_cap*` fields instead.",
+ "type": "string"
+ },
+ "include_liability_cap": {
+ "type": "boolean"
+ },
+ "include_liability_cap_amount_constant_external": {
+ "type": "string"
+ },
+ "include_liability_cap_amount_constant_internal": {
+ "type": "string"
+ },
+ "include_liability_cap_amount_currency_external": {
+ "description": "Currency amount. Numbers and numeric strings (commas allowed) are both accepted."
+ },
+ "include_liability_cap_amount_currency_internal": {
+ "description": "Currency amount. Numbers and numeric strings (commas allowed) are both accepted."
+ },
+ "include_liability_cap_csa_type": {
+ "description": "Which liability cap values apply: the `_internal` or `_external` amount fields. Required when `include_liability_cap` is true.",
+ "enum": [
+ "internal",
+ "external"
+ ],
+ "type": "string"
+ },
+ "include_personal_data_biographic_info": {
+ "type": "boolean"
+ },
+ "include_personal_data_contact_info": {
+ "type": "boolean"
+ },
+ "include_personal_data_custom": {
+ "type": "boolean"
+ },
+ "include_personal_data_custom_val": {
+ "type": "string"
+ },
+ "include_personal_data_employment_info": {
+ "type": "boolean"
+ },
+ "include_personal_data_financial_info": {
+ "type": "boolean"
+ },
+ "include_personal_data_location": {
+ "type": "boolean"
+ },
+ "include_personal_data_name": {
+ "type": "boolean"
+ },
+ "include_personal_data_transactional_info": {
+ "type": "boolean"
+ },
+ "include_personal_data_user_activity_info": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_custom": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_custom_val": {
+ "type": "string"
+ },
+ "include_processing_purpose_erasing": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_holding": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_protecting": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_receiving": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_returning": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_sharing": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_updating": {
+ "type": "boolean"
+ },
+ "include_processing_purpose_using": {
+ "type": "boolean"
+ },
+ "include_provider_security_contact_address": {
+ "type": "boolean"
+ },
+ "include_provider_security_contact_address_city": {
+ "type": "string"
+ },
+ "include_provider_security_contact_address_country": {
+ "type": "string"
+ },
+ "include_provider_security_contact_address_state": {
+ "type": "string"
+ },
+ "include_provider_security_contact_address_street_address": {
+ "type": "string"
+ },
+ "include_provider_security_contact_address_zipcode": {
+ "type": "string"
+ },
+ "include_provider_security_contact_email": {
+ "type": "boolean"
+ },
+ "include_provider_security_contact_email_val": {
+ "format": "email",
+ "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-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": "boolean"
+ },
+ "confidentiality_nda_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "confidentiality_nda_description": {
+ "type": "string"
+ },
+ "confidentiality_nda_include_loi": {
+ "type": "boolean"
+ },
+ "confidentiality_nda_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "confidentiality_type": {
+ "enum": [
+ "mutual",
+ "nda",
+ "provider",
+ "custom"
+ ],
+ "type": "string"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_custom_details": {
+ "type": "boolean"
+ },
+ "include_custom_details_val": {
+ "type": "string"
+ },
+ "include_fees": {
+ "type": "boolean"
+ },
+ "include_fees_amount": {
+ "type": "number"
+ },
+ "include_fees_amount_duration": {
+ "enum": [
+ "month",
+ "year",
+ "quarter"
+ ],
+ "type": "string"
+ },
+ "include_fees_include_amount": {
+ "type": "boolean"
+ },
+ "include_fees_include_other": {
+ "type": "boolean"
+ },
+ "include_fees_other": {
+ "type": "string"
+ },
+ "include_functionality": {
+ "type": "boolean"
+ },
+ "include_functionality_val": {
+ "type": "string"
+ },
+ "include_launch_date": {
+ "type": "boolean"
+ },
+ "include_launch_date_custom": {
+ "type": "string"
+ },
+ "include_launch_date_date": {
+ "format": "date-time",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$",
+ "type": "string"
+ },
+ "include_launch_date_type": {
+ "enum": [
+ "date",
+ "custom"
+ ],
+ "type": "string"
+ },
+ "product_name": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "manual_send": {
+ "description": "When true, the agreement is marked as manually sent outside the platform.",
+ "type": "boolean"
+ },
+ "message": {
+ "type": "string"
+ },
+ "partnership_attributes": {
+ "additionalProperties": false,
+ "description": "Override partnership terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "effective_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "effective_date_type": {
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "type": "string"
+ },
+ "general_cap_amount_currency_val": {
+ "type": "number"
+ },
+ "general_cap_amount_either_currency": {
+ "type": "number"
+ },
+ "general_cap_amount_either_multiple": {
+ "type": "number"
+ },
+ "general_cap_amount_multiple_val": {
+ "type": "number"
+ },
+ "general_cap_amount_type": {
+ "enum": [
+ "multiple",
+ "currency",
+ "either",
+ "base"
+ ],
+ "type": "string"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_additional_warranties": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_include_company": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_include_company_val": {
+ "type": "string"
+ },
+ "include_additional_warranties_include_partner": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_include_partner_val": {
+ "type": "string"
+ },
+ "include_brand_guidelines": {
+ "type": "boolean"
+ },
+ "include_brand_guidelines_include_company": {
+ "type": "boolean"
+ },
+ "include_brand_guidelines_include_company_val": {
+ "type": "string"
+ },
+ "include_brand_guidelines_include_partner": {
+ "type": "boolean"
+ },
+ "include_brand_guidelines_include_partner_val": {
+ "type": "string"
+ },
+ "include_covered_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_company_claims": {
+ "type": "string"
+ },
+ "include_covered_claims_include_company_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_include_partner_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_partner_claims": {
+ "type": "string"
+ },
+ "include_dpa": {
+ "type": "boolean"
+ },
+ "include_dpa_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_dpa_location": {
+ "type": "string"
+ },
+ "include_dpa_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_increased_cap_amount": {
+ "type": "boolean"
+ },
+ "include_increased_cap_amount_currency": {
+ "type": "number"
+ },
+ "include_increased_cap_amount_either_currency": {
+ "type": "number"
+ },
+ "include_increased_cap_amount_either_multiple": {
+ "type": "string"
+ },
+ "include_increased_cap_amount_multiple": {
+ "type": "string"
+ },
+ "include_increased_cap_amount_type": {
+ "enum": [
+ "multiple",
+ "currency",
+ "either"
+ ],
+ "type": "string"
+ },
+ "include_increased_claims": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_confidentiality": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_confidentiality_misconduct": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_covered_claims": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_misconduct": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_other": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_other_val": {
+ "type": "string"
+ },
+ "include_unlimited_claims": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_confidentiality": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_confidentiality_misconduct": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_covered_claims": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_misconduct": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_other": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_other_val": {
+ "type": "string"
+ },
+ "negotiations_allowed": {
+ "type": "boolean"
+ }
+ },
+ "type": "object"
+ },
+ "partnership_business_terms_attributes": {
+ "additionalProperties": false,
+ "description": "Override partnership business terms terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "end_date_after_effective_date_amount": {
+ "type": "number"
+ },
+ "end_date_after_effective_date_unit": {
+ "enum": [
+ "month(s)",
+ "quarter(s)",
+ "year(s)"
+ ],
+ "type": "string"
+ },
+ "end_date_date": {
+ "type": "string"
+ },
+ "end_date_type": {
+ "enum": [
+ "date",
+ "effective date"
+ ],
+ "type": "string"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_obligations_company_brand": {
+ "type": "boolean"
+ },
+ "include_obligations_company_promotion": {
+ "type": "boolean"
+ },
+ "include_obligations_company_promotion_include_activities": {
+ "type": "boolean"
+ },
+ "include_obligations_company_promotion_include_activities_val": {
+ "type": "string"
+ },
+ "include_obligations_company_promotion_include_materials": {
+ "type": "boolean"
+ },
+ "include_obligations_company_promotion_include_materials_val": {
+ "type": "string"
+ },
+ "include_obligations_company_referral": {
+ "type": "boolean"
+ },
+ "include_obligations_company_referral_include_criteria": {
+ "type": "boolean"
+ },
+ "include_obligations_company_referral_include_criteria_val": {
+ "type": "string"
+ },
+ "include_obligations_company_referral_include_pay_sch": {
+ "type": "boolean"
+ },
+ "include_obligations_company_referral_include_pay_sch_amount": {
+ "type": "number"
+ },
+ "include_obligations_company_referral_include_pay_sch_custom": {
+ "type": "string"
+ },
+ "include_obligations_company_referral_include_pay_sch_unit": {
+ "enum": [
+ "U.S. Dollars",
+ "percent"
+ ],
+ "type": "string"
+ },
+ "include_obligations_company_sponsorship": {
+ "type": "boolean"
+ },
+ "include_obligations_company_sponsorship_include_benefits": {
+ "type": "boolean"
+ },
+ "include_obligations_company_sponsorship_include_benefits_val": {
+ "type": "string"
+ },
+ "include_obligations_company_sponsorship_include_payments": {
+ "type": "boolean"
+ },
+ "include_obligations_company_sponsorship_include_payments_amount": {
+ "type": "number"
+ },
+ "include_obligations_company_sponsorship_include_payments_unit": {
+ "enum": [
+ "U.S. Dollars",
+ "percent"
+ ],
+ "type": "string"
+ },
+ "include_obligations_partner_brand": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_promotion": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_promotion_include_activities": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_promotion_include_activities_val": {
+ "type": "string"
+ },
+ "include_obligations_partner_promotion_include_materials": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_promotion_include_materials_val": {
+ "type": "string"
+ },
+ "include_obligations_partner_referral": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_referral_include_criteria": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_referral_include_criteria_val": {
+ "type": "string"
+ },
+ "include_obligations_partner_referral_include_pay_sch": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_referral_include_pay_sch_amount": {
+ "type": "number"
+ },
+ "include_obligations_partner_referral_include_pay_sch_custom": {
+ "type": "string"
+ },
+ "include_obligations_partner_referral_include_pay_sch_unit": {
+ "enum": [
+ "U.S. Dollars",
+ "percent"
+ ],
+ "type": "string"
+ },
+ "include_obligations_partner_sponsorship": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_sponsorship_include_benefits": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_sponsorship_include_benefits_val": {
+ "type": "string"
+ },
+ "include_obligations_partner_sponsorship_include_payments": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_sponsorship_include_payments_amount": {
+ "type": "number"
+ },
+ "include_obligations_partner_sponsorship_include_payments_unit": {
+ "enum": [
+ "U.S. Dollars",
+ "percent"
+ ],
+ "type": "string"
+ },
+ "include_payment_process": {
+ "type": "boolean"
+ },
+ "include_payment_process_company": {
+ "type": "boolean"
+ },
+ "include_payment_process_company_include_address": {
+ "type": "boolean"
+ },
+ "include_payment_process_company_include_address_city": {
+ "type": "string"
+ },
+ "include_payment_process_company_include_address_country": {
+ "type": "string"
+ },
+ "include_payment_process_company_include_address_state": {
+ "type": "string"
+ },
+ "include_payment_process_company_include_address_street_address": {
+ "type": "string"
+ },
+ "include_payment_process_company_include_address_zipcode": {
+ "type": "string"
+ },
+ "include_payment_process_company_include_email": {
+ "type": "boolean"
+ },
+ "include_payment_process_company_include_email_val": {
+ "type": "string"
+ },
+ "include_payment_process_partner": {
+ "type": "boolean"
+ },
+ "include_payment_process_partner_include_address": {
+ "type": "boolean"
+ },
+ "include_payment_process_partner_include_address_city": {
+ "type": "string"
+ },
+ "include_payment_process_partner_include_address_country": {
+ "type": "string"
+ },
+ "include_payment_process_partner_include_address_state": {
+ "type": "string"
+ },
+ "include_payment_process_partner_include_address_street_address": {
+ "type": "string"
+ },
+ "include_payment_process_partner_include_address_zipcode": {
+ "type": "string"
+ },
+ "include_payment_process_partner_include_email": {
+ "type": "boolean"
+ },
+ "include_payment_process_partner_include_email_val": {
+ "type": "string"
+ },
+ "include_payment_schedule": {
+ "type": "boolean"
+ },
+ "include_payment_schedule_custom": {
+ "type": "string"
+ },
+ "include_payment_schedule_specified_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_payment_schedule_specified_timeframe": {
+ "enum": [
+ "receipt",
+ "date"
+ ],
+ "type": "string"
+ },
+ "include_payment_schedule_specified_unit": {
+ "enum": [
+ "day(s)",
+ "week(s)",
+ "month(s)",
+ "quarter(s)",
+ "year(s)"
+ ],
+ "type": "string"
+ },
+ "include_payment_schedule_type": {
+ "enum": [
+ "specified",
+ "custom"
+ ],
+ "type": "string"
+ },
+ "negotiations_allowed": {
+ "type": "boolean"
+ },
+ "territory_type": {
+ "enum": [
+ "worldwide",
+ "custom"
+ ],
+ "type": "string"
+ },
+ "territory_type_val": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "payment_link_url": {
+ "description": "A payment URL shown to the recipient after signing. Requires include_billing_workflow to be true and billing_workflow_type to be \"link\".",
+ "type": "string"
+ },
+ "pilot_attributes": {
+ "additionalProperties": false,
+ "description": "Override pilot terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "fees_type": {
+ "enum": [
+ "free",
+ "pilot_period_fees"
+ ],
+ "type": "string"
+ },
+ "general_cap_amount": {
+ "type": "number"
+ },
+ "general_cap_amount_type": {
+ "enum": [
+ "preceding",
+ "base",
+ "period"
+ ],
+ "type": "string"
+ },
+ "general_cap_period_currency": {
+ "type": "number"
+ },
+ "general_cap_period_qty": {
+ "type": "number"
+ },
+ "general_cap_preceding_amount": {
+ "type": "number"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_dpa": {
+ "type": "boolean"
+ },
+ "include_dpa_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_dpa_location": {
+ "type": "string"
+ },
+ "include_dpa_type": {
+ "enum": [
+ "description",
+ "attachment",
+ "standard"
+ ],
+ "type": "string"
+ },
+ "include_payment_process": {
+ "type": "boolean"
+ },
+ "include_technical_support": {
+ "type": "boolean"
+ },
+ "negotiations_allowed": {
+ "type": "boolean"
+ },
+ "payment_process_automatic_frequency": {
+ "enum": [
+ "monthly",
+ "quarterly",
+ "annually",
+ "once_per_period"
+ ],
+ "type": "string"
+ },
+ "payment_process_invoice_days": {
+ "type": "number"
+ },
+ "payment_process_invoice_from": {
+ "enum": [
+ "receipt",
+ "date"
+ ],
+ "type": "string"
+ },
+ "payment_process_invoice_timeframe": {
+ "enum": [
+ "days",
+ "weeks",
+ "months",
+ "quarters",
+ "years"
+ ],
+ "type": "string"
+ },
+ "payment_process_type": {
+ "enum": [
+ "automatic",
+ "invoice"
+ ],
+ "type": "string"
+ },
+ "pilot_period_description": {
+ "type": "string"
+ },
+ "pilot_period_fees_description": {
+ "type": "string"
+ },
+ "product_description": {
+ "type": "string"
+ },
+ "technical_support_description": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "psa_attributes": {
+ "additionalProperties": false,
+ "description": "Override psa terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "additional_changes": {
+ "type": "string"
+ },
+ "customer_description": {
+ "type": "string"
+ },
+ "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": {
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "type": "string"
+ },
+ "general_cap_amount": {
+ "type": "number"
+ },
+ "general_cap_amount_type": {
+ "enum": [
+ "preceding",
+ "base",
+ "period"
+ ],
+ "type": "string"
+ },
+ "general_cap_period_currency": {
+ "type": "number"
+ },
+ "general_cap_period_qty": {
+ "type": "number"
+ },
+ "general_cap_preceding_amount": {
+ "type": "number"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_additional_changes": {
+ "type": "boolean"
+ },
+ "include_additional_warranties": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_by_customer": {
+ "type": "string"
+ },
+ "include_additional_warranties_by_provider": {
+ "type": "string"
+ },
+ "include_additional_warranties_include_by_customer": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_include_by_provider": {
+ "type": "boolean"
+ },
+ "include_covered_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_customer_claims": {
+ "type": "string"
+ },
+ "include_covered_claims_include_customer_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_include_provider_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_provider_claims": {
+ "type": "string"
+ },
+ "include_customer_insurance_min": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_add_provider_com_gen_liability": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_add_provider_cyber_liability": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_add_provider_errors_omissions": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_auto_liability_aggregate": {
+ "type": "number"
+ },
+ "include_customer_insurance_min_auto_liability_minimum": {
+ "type": "number"
+ },
+ "include_customer_insurance_min_cyber_liability_aggregate": {
+ "type": "number"
+ },
+ "include_customer_insurance_min_cyber_liability_minimum": {
+ "type": "number"
+ },
+ "include_customer_insurance_min_employer_liability_aggregate": {
+ "type": "number"
+ },
+ "include_customer_insurance_min_employer_liability_minimum": {
+ "type": "number"
+ },
+ "include_customer_insurance_min_general_liability_aggregate": {
+ "type": "number"
+ },
+ "include_customer_insurance_min_general_liability_minimum": {
+ "type": "number"
+ },
+ "include_customer_insurance_min_include_add_provider": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_include_auto_liability": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_include_cyber_liability": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_include_employer_liability": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_include_general_liability": {
+ "type": "boolean"
+ },
+ "include_customer_insurance_min_include_workers_comp": {
+ "type": "boolean"
+ },
+ "include_customer_policies": {
+ "type": "boolean"
+ },
+ "include_customer_policies_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_customer_policies_location": {
+ "type": "string"
+ },
+ "include_customer_policies_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_dpa": {
+ "type": "boolean"
+ },
+ "include_dpa_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_dpa_location": {
+ "type": "string"
+ },
+ "include_dpa_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_increased_cap_amount": {
+ "type": "boolean"
+ },
+ "include_increased_claims": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_confidentiality": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_confidentiality_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_privsec": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_privsec_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_other": {
+ "type": "boolean"
+ },
+ "include_increased_claims_indemnification_obligation": {
+ "type": "boolean"
+ },
+ "include_increased_claims_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_other": {
+ "type": "string"
+ },
+ "include_provider_insurance_min": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_add_customer_com_gen_liability": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_add_customer_cyber_liability": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_add_customer_errors_omissions": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_auto_liability_aggregate": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_auto_liability_minimum": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_cyber_liability_aggregate": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_cyber_liability_minimum": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_employer_liability_aggregate": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_employer_liability_minimum": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_general_liability_aggregate": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_general_liability_minimum": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_include_add_customer": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_include_auto_liability": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_include_cyber_liability": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_include_employer_liability": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_include_general_liability": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_include_workers_comp": {
+ "type": "boolean"
+ },
+ "include_publicity_rights": {
+ "type": "boolean"
+ },
+ "include_publicity_rights_type": {
+ "enum": [
+ "public",
+ "non-public"
+ ],
+ "type": "string"
+ },
+ "include_security_policy": {
+ "type": "boolean"
+ },
+ "include_security_policy_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_security_policy_fedramp_auth": {
+ "type": "boolean"
+ },
+ "include_security_policy_hitrust": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_annual_maintenance": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_other": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_other_val": {
+ "type": "string"
+ },
+ "include_security_policy_iso27001": {
+ "type": "boolean"
+ },
+ "include_security_policy_location": {
+ "type": "string"
+ },
+ "include_security_policy_pci1": {
+ "type": "boolean"
+ },
+ "include_security_policy_pci2": {
+ "type": "boolean"
+ },
+ "include_security_policy_penetration_testing": {
+ "type": "boolean"
+ },
+ "include_security_policy_soc2_type1": {
+ "type": "boolean"
+ },
+ "include_security_policy_soc2_type2": {
+ "type": "boolean"
+ },
+ "include_security_policy_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_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": "string"
+ },
+ "increased_cap_amount_currency": {
+ "type": "number"
+ },
+ "increased_cap_amount_period_currency": {
+ "type": "number"
+ },
+ "increased_cap_amount_period_qty": {
+ "type": "number"
+ },
+ "increased_cap_amount_qty": {
+ "type": "number"
+ },
+ "increased_cap_amount_type": {
+ "enum": [
+ "qty",
+ "currency",
+ "period"
+ ],
+ "type": "string"
+ },
+ "negotiations_allowed": {
+ "type": "boolean"
+ },
+ "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": "string"
+ },
+ "include_deliverables": {
+ "type": "boolean"
+ },
+ "include_deliverables_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_deliverables_description": {
+ "type": "string"
+ },
+ "include_deliverables_include_acceptance": {
+ "type": "boolean"
+ },
+ "include_deliverables_include_attachment": {
+ "type": "boolean"
+ },
+ "include_deliverables_include_draft_deliverables": {
+ "type": "boolean"
+ },
+ "include_deliverables_rejection_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_deliverables_rejection_unit": {
+ "enum": [
+ "hours",
+ "days",
+ "weeks",
+ "months"
+ ],
+ "type": "string"
+ },
+ "include_deliverables_resubmission_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_deliverables_resubmission_unit": {
+ "enum": [
+ "hours",
+ "days",
+ "weeks",
+ "months"
+ ],
+ "type": "string"
+ },
+ "include_fees_other": {
+ "type": "boolean"
+ },
+ "include_fees_other_val": {
+ "type": "string"
+ },
+ "include_fees_table": {
+ "type": "boolean"
+ },
+ "include_fees_table_total": {
+ "type": "boolean"
+ },
+ "include_fees_travel": {
+ "type": "boolean"
+ },
+ "include_fees_travel_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_fees_travel_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_fees_travel_val": {
+ "type": "string"
+ },
+ "include_third_party_customer": {
+ "type": "boolean"
+ },
+ "include_third_party_include_description": {
+ "type": "boolean"
+ },
+ "include_third_party_include_description_val": {
+ "type": "string"
+ },
+ "include_third_party_materials": {
+ "type": "boolean"
+ },
+ "include_third_party_provider": {
+ "type": "boolean"
+ },
+ "include_time_of_assignment": {
+ "type": "boolean"
+ },
+ "include_time_of_assignment_type": {
+ "enum": [
+ "created",
+ "paid"
+ ],
+ "type": "string"
+ },
+ "invoice_period_description": {
+ "type": "string"
+ },
+ "negotiations_allowed": {
+ "type": "boolean"
+ },
+ "payment_period": {
+ "type": "number"
+ },
+ "payment_period_other": {
+ "type": "string"
+ },
+ "payment_period_timeframe": {
+ "enum": [
+ "receipt",
+ "invoice",
+ "Customer's receipt of invoice",
+ "date of invoice"
+ ],
+ "type": "string"
+ },
+ "payment_period_type": {
+ "enum": [
+ "standard",
+ "other"
+ ],
+ "type": "string"
+ },
+ "payment_period_unit": {
+ "enum": [
+ "day(s)",
+ "week(s)",
+ "month(s)",
+ "quarter(s)",
+ "year(s)"
+ ],
+ "type": "string"
+ },
+ "quantity": {
+ "type": "number"
+ },
+ "services_description": {
+ "type": "string"
+ },
+ "sow_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "sow_date_type": {
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "type": "string"
+ },
+ "sow_term_amount": {
+ "type": "number"
+ },
+ "sow_term_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "sow_term_type": {
+ "enum": [
+ "deliverables",
+ "period",
+ "date"
+ ],
+ "type": "string"
+ },
+ "sow_term_unit": {
+ "enum": [
+ "month(s)",
+ "quarter(s)",
+ "year(s)"
+ ],
+ "type": "string"
+ },
+ "type": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "recipient_email": {
+ "format": "email",
+ "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-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": {
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "type": "string"
+ },
+ "general_cap_amount": {
+ "type": "number"
+ },
+ "general_cap_amount_type": {
+ "enum": [
+ "preceding",
+ "base",
+ "period"
+ ],
+ "type": "string"
+ },
+ "general_cap_period_currency": {
+ "type": "number"
+ },
+ "general_cap_period_qty": {
+ "type": "number"
+ },
+ "general_cap_preceding_amount": {
+ "type": "number"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_additional_warranties": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_by_customer": {
+ "type": "string"
+ },
+ "include_additional_warranties_by_provider": {
+ "type": "string"
+ },
+ "include_additional_warranties_include_by_customer": {
+ "type": "boolean"
+ },
+ "include_additional_warranties_include_by_provider": {
+ "type": "boolean"
+ },
+ "include_ai_addendum": {
+ "type": "boolean"
+ },
+ "include_ai_addendum_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_covered_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_customer_claims": {
+ "type": "string"
+ },
+ "include_covered_claims_include_customer_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_include_provider_claims": {
+ "type": "boolean"
+ },
+ "include_covered_claims_provider_claims": {
+ "type": "string"
+ },
+ "include_dpa": {
+ "type": "boolean"
+ },
+ "include_dpa_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_dpa_location": {
+ "type": "string"
+ },
+ "include_dpa_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_increased_cap_amount": {
+ "type": "boolean"
+ },
+ "include_increased_claims": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_confidentiality": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_confidentiality_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_other": {
+ "type": "boolean"
+ },
+ "include_increased_claims_indemnification_obligation": {
+ "type": "boolean"
+ },
+ "include_increased_claims_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_other": {
+ "type": "string"
+ },
+ "include_increased_claims_restrictions": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_confidentiality": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_breach_of_confidentiality_negligence": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_include_other": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_indemnification_obligation": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_license_or_restrictions": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_negligence": {
+ "type": "boolean"
+ },
+ "include_unlimited_claims_other": {
+ "type": "string"
+ },
+ "increased_cap_amount_currency": {
+ "type": "number"
+ },
+ "increased_cap_amount_period_currency": {
+ "type": "number"
+ },
+ "increased_cap_amount_period_qty": {
+ "type": "number"
+ },
+ "increased_cap_amount_qty": {
+ "type": "number"
+ },
+ "increased_cap_amount_type": {
+ "enum": [
+ "qty",
+ "currency",
+ "period"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "software_license_order_form_attributes": {
+ "additionalProperties": false,
+ "description": "Override software license order form terms when creating from a matching template. Only fields you include override template defaults. Invalid if the template type does not match.",
+ "properties": {
+ "additional_changes": {
+ "type": "string"
+ },
+ "deletion_procedure_include_custom": {
+ "type": "boolean"
+ },
+ "deletion_procedure_include_custom_description": {
+ "type": "string"
+ },
+ "deletion_procedure_include_customer_disable": {
+ "type": "boolean"
+ },
+ "deletion_procedure_include_customer_proof": {
+ "type": "boolean"
+ },
+ "deletion_procedure_include_provider_disable": {
+ "type": "boolean"
+ },
+ "fee_custom_unit": {
+ "type": "string"
+ },
+ "fee_period": {
+ "enum": [
+ "Subscription Period",
+ "month",
+ "year",
+ "Custom unit"
+ ],
+ "type": "string"
+ },
+ "fees_attributes": {
+ "additionalProperties": {
+ "anyOf": [
+ {
+ "additionalProperties": false,
+ "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": {
+ "enum": [
+ "USD",
+ "EUR",
+ "GBP",
+ "CAD",
+ "AUD",
+ "SGD",
+ "ILS",
+ "JPY",
+ "CHF",
+ "HKD"
+ ],
+ "type": "string"
+ },
+ "fees_include_fee_increase_upon_renewal": {
+ "type": "boolean"
+ },
+ "fees_include_fee_increase_upon_renewal_fee": {
+ "type": "number"
+ },
+ "fees_include_fee_increase_upon_renewal_type": {
+ "enum": [
+ "will",
+ "may"
+ ],
+ "type": "string"
+ },
+ "fees_inclusive_of_taxes": {
+ "type": "boolean"
+ },
+ "id": {
+ "description": "The UUID of the term record the agreement already owns. Required when updating a draft (`PATCH /v1/agreements/{id}`) and must match the id returned by `GET /v1/agreements/{id}`; the request is rejected otherwise. Not used when creating an agreement.",
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_additional_changes": {
+ "type": "boolean"
+ },
+ "include_license_compliance_verification": {
+ "type": "boolean"
+ },
+ "include_license_compliance_verification_description": {
+ "type": "string"
+ },
+ "include_license_limits": {
+ "type": "boolean"
+ },
+ "include_license_limits_description": {
+ "type": "string"
+ },
+ "include_payment_process_include_billing_email": {
+ "type": "boolean"
+ },
+ "include_pilot_period": {
+ "type": "boolean"
+ },
+ "include_pilot_period_duration_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_pilot_period_duration_type": {
+ "enum": [
+ "day",
+ "week",
+ "month"
+ ],
+ "type": "string"
+ },
+ "include_pilot_period_include_fees": {
+ "type": "boolean"
+ },
+ "include_pilot_period_include_fees_amount": {
+ "type": "number"
+ },
+ "include_pilot_period_include_modifications": {
+ "type": "boolean"
+ },
+ "include_pilot_period_include_modifications_description": {
+ "type": "string"
+ },
+ "include_services": {
+ "type": "boolean"
+ },
+ "include_services_description": {
+ "type": "string"
+ },
+ "negotiations_allowed": {
+ "type": "boolean"
+ },
+ "order_date_date": {
+ "type": "string"
+ },
+ "order_date_type": {
+ "enum": [
+ "signature",
+ "date",
+ "other"
+ ],
+ "type": "string"
+ },
+ "payment_process_automatic_frequency": {
+ "enum": [
+ "monthly",
+ "quarterly",
+ "semiannually",
+ "annually"
+ ],
+ "type": "string"
+ },
+ "payment_process_type": {
+ "enum": [
+ "automatic",
+ "invoice",
+ "custom"
+ ],
+ "type": "string"
+ },
+ "payment_process_type_custom_val": {
+ "type": "string"
+ },
+ "payment_process_type_invoice_amount": {
+ "type": "number"
+ },
+ "payment_process_type_invoice_custom_unit": {
+ "type": "string"
+ },
+ "payment_process_type_invoice_duration": {
+ "enum": [
+ "day",
+ "week",
+ "month",
+ "year",
+ "day(s)",
+ "week(s)",
+ "month(s)",
+ "year(s)"
+ ],
+ "type": "string"
+ },
+ "payment_process_type_invoice_duration_start": {
+ "enum": [
+ "Customer's receipt of invoice",
+ "date of invoice"
+ ],
+ "type": "string"
+ },
+ "payment_process_type_invoice_type": {
+ "enum": [
+ "monthly",
+ "quarterly",
+ "semiannually",
+ "annually",
+ "Custom unit"
+ ],
+ "type": "string"
+ },
+ "permitted_uses_include_custom": {
+ "type": "boolean"
+ },
+ "permitted_uses_include_custom_description": {
+ "type": "string"
+ },
+ "permitted_uses_include_customers_affiliates": {
+ "type": "boolean"
+ },
+ "permitted_uses_include_internal_business": {
+ "type": "boolean"
+ },
+ "pilot_period_stripe_product_id": {
+ "type": "string"
+ },
+ "software_description": {
+ "type": "string"
+ },
+ "subscription_auto_renew": {
+ "enum": [
+ "days",
+ "subscription_end"
+ ],
+ "type": "string"
+ },
+ "subscription_period": {
+ "type": "number"
+ },
+ "subscription_period_unit": {
+ "type": "string"
+ },
+ "subscription_renewal_notice_days": {
+ "type": "number"
+ },
+ "warranty_period_description_amount": {
+ "type": "number"
+ },
+ "warranty_period_description_duration": {
+ "enum": [
+ "day",
+ "week",
+ "month",
+ "year"
+ ],
+ "type": "string"
+ },
+ "warranty_period_description_duration_start": {
+ "enum": [
+ "initial delivery of the Software",
+ "delivery of the Software and each subsequent Update",
+ "the Order Date"
+ ],
+ "type": "string"
+ },
+ "warranty_period_type": {
+ "enum": [
+ "description",
+ "none"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "test_agreement": {
+ "description": "When true, marks the agreement as a test. Test agreements do not count against your monthly limit.",
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "recipient_name",
+ "recipient_email"
+ ],
+ "type": "object"
+ },
+ "cc_users": {
+ "items": {
+ "format": "email",
+ "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-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": {
- "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"
- }
-]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": {
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "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": {
+ "enum": [
+ "stripe",
+ "link"
+ ],
+ "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": {
+ "enum": [
+ "AWS",
+ "GCP",
+ "Azure"
+ ],
+ "type": "string"
+ },
+ "effective_date_type": {
+ "enum": [
+ "signature",
+ "date",
+ "marketplace_acceptance"
+ ],
+ "type": "string"
+ },
+ "general_cap_amount": {
+ "type": "number"
+ },
+ "general_cap_amount_type": {
+ "enum": [
+ "preceding",
+ "base",
+ "period"
+ ],
+ "type": "string"
+ },
+ "general_cap_period_currency": {
+ "type": "number"
+ },
+ "general_cap_period_qty": {
+ "type": "number"
+ },
+ "general_cap_preceding_amount": {
+ "type": "number"
+ },
+ "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": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "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": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_increased_cap_amount": {
+ "type": "boolean"
+ },
+ "include_increased_claims": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_confidentiality": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_confidentiality_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_privsec": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_privsec_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_other": {
+ "type": "boolean"
+ },
+ "include_increased_claims_indemnification_obligation": {
+ "type": "boolean"
+ },
+ "include_increased_claims_other": {
+ "type": "string"
+ },
+ "include_insurance_minimums": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_add_customer": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_add_customer_com_gen_liability": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_add_customer_cyber_liability": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_add_customer_errors_omissions": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_additional_information": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_additional_information_text": {
+ "type": "string"
+ },
+ "include_insurance_minimums_cyber_liability_aggregate": {
+ "type": "number"
+ },
+ "include_insurance_minimums_cyber_liability_minimum": {
+ "type": "number"
+ },
+ "include_insurance_minimums_employer_liability_aggregate": {
+ "type": "number"
+ },
+ "include_insurance_minimums_employer_liability_minimum": {
+ "type": "number"
+ },
+ "include_insurance_minimums_general_liability_aggregate": {
+ "type": "number"
+ },
+ "include_insurance_minimums_general_liability_minimum": {
+ "type": "number"
+ },
+ "include_insurance_minimums_include_cyber_liability": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_include_employer_liability": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_include_general_liability": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_include_workers_compensation": {
+ "type": "boolean"
+ },
+ "include_publicity_rights": {
+ "type": "boolean"
+ },
+ "include_publicity_rights_type": {
+ "enum": [
+ "public",
+ "non-public"
+ ],
+ "type": "string"
+ },
+ "include_security_policy": {
+ "type": "boolean"
+ },
+ "include_security_policy_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_security_policy_fedramp_auth": {
+ "type": "boolean"
+ },
+ "include_security_policy_hipaa": {
+ "type": "boolean"
+ },
+ "include_security_policy_hitrust": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_annual_maintenance": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_location": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_other": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_reasonable_efforts": {
+ "type": "boolean"
+ },
+ "include_security_policy_iso27001": {
+ "type": "boolean"
+ },
+ "include_security_policy_location": {
+ "type": "string"
+ },
+ "include_security_policy_other": {
+ "type": "string"
+ },
+ "include_security_policy_pci1": {
+ "type": "boolean"
+ },
+ "include_security_policy_pci2": {
+ "type": "boolean"
+ },
+ "include_security_policy_penetration_testing": {
+ "type": "boolean"
+ },
+ "include_security_policy_soc2": {
+ "type": "boolean"
+ },
+ "include_security_policy_soc2_type2": {
+ "type": "boolean"
+ },
+ "include_security_policy_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_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": {
+ "type": "number"
+ },
+ "increased_cap_amount_qty": {
+ "type": "number"
+ },
+ "increased_cap_amount_type": {
+ "enum": [
+ "qty",
+ "currency",
+ "period"
+ ],
+ "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": {
+ "enum": [
+ "automatic",
+ "invoice"
+ ],
+ "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": {
+ "enum": [
+ "Subscription Period",
+ "month",
+ "year",
+ "User",
+ "Custom unit"
+ ],
+ "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": {
+ "enum": [
+ "USD",
+ "EUR",
+ "GBP",
+ "CAD",
+ "AUD",
+ "SGD",
+ "ILS",
+ "JPY",
+ "CHF",
+ "HKD"
+ ],
+ "type": "string"
+ },
+ "fees_include_fee_increase_upon_renewal": {
+ "type": "boolean"
+ },
+ "fees_include_fee_increase_upon_renewal_fee": {
+ "type": "number"
+ },
+ "fees_include_fee_increase_upon_renewal_type": {
+ "enum": [
+ "will",
+ "may"
+ ],
+ "type": "string"
+ },
+ "fees_inclusive_of_taxes": {
+ "type": "boolean"
+ },
+ "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": {
+ "enum": [
+ "Subscription Period",
+ "month",
+ "year",
+ "User"
+ ],
+ "type": "string"
+ },
+ "include_free_trial": {
+ "type": "boolean"
+ },
+ "include_max_users": {
+ "type": "boolean"
+ },
+ "include_pilot_period": {
+ "type": "boolean"
+ },
+ "include_pilot_period_duration_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_pilot_period_duration_type": {
+ "enum": [
+ "day",
+ "week",
+ "month"
+ ],
+ "type": "string"
+ },
+ "include_pilot_period_include_fees": {
+ "type": "boolean"
+ },
+ "include_pilot_period_include_fees_amount": {
+ "type": "number"
+ },
+ "include_pilot_period_include_modifications": {
+ "type": "boolean"
+ },
+ "include_pilot_period_include_modifications_description": {
+ "type": "string"
+ },
+ "include_product_support": {
+ "type": "boolean"
+ },
+ "include_product_support_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_product_support_description": {
+ "type": "string"
+ },
+ "include_product_support_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_professional_services": {
+ "type": "boolean"
+ },
+ "include_professional_services_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_professional_services_custom_name": {
+ "type": "string"
+ },
+ "include_professional_services_description": {
+ "type": "string"
+ },
+ "include_professional_services_end_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "include_professional_services_fees_description": {
+ "type": "string"
+ },
+ "include_professional_services_include_end_date": {
+ "type": "boolean"
+ },
+ "include_professional_services_include_fees_description": {
+ "type": "boolean"
+ },
+ "include_professional_services_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_sla": {
+ "type": "boolean"
+ },
+ "include_sla_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_sla_description": {
+ "type": "string"
+ },
+ "include_sla_include_response_time": {
+ "type": "boolean"
+ },
+ "include_sla_include_response_time_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_sla_include_response_time_credit": {
+ "type": "number"
+ },
+ "include_sla_include_response_time_duration": {
+ "enum": [
+ "hour",
+ "day",
+ "week",
+ "month",
+ "hours"
+ ],
+ "type": "string"
+ },
+ "include_sla_include_response_time_support_channel": {
+ "type": "string"
+ },
+ "include_sla_include_target_uptime": {
+ "type": "boolean"
+ },
+ "include_sla_maintenance_notice": {
+ "type": "boolean"
+ },
+ "include_sla_maintenance_window": {
+ "type": "boolean"
+ },
+ "include_sla_maintenance_window_type": {
+ "enum": [
+ "standard",
+ "none"
+ ],
+ "type": "string"
+ },
+ "include_sla_standard_maintenance_notice_qty": {
+ "type": "number"
+ },
+ "include_sla_standard_maintenance_notice_unit": {
+ "enum": [
+ "hour",
+ "day",
+ "week",
+ "month"
+ ],
+ "type": "string"
+ },
+ "include_sla_standard_maintenance_window_end_time": {
+ "type": "string"
+ },
+ "include_sla_standard_maintenance_window_friday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_monday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_saturday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_start_time": {
+ "type": "string"
+ },
+ "include_sla_standard_maintenance_window_sunday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_thursday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_time_zone": {
+ "type": "string"
+ },
+ "include_sla_standard_maintenance_window_tuesday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_wednesday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_target_uptime": {
+ "type": "number"
+ },
+ "include_sla_type": {
+ "enum": [
+ "description",
+ "standard",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_subscription_start_date": {
+ "type": "boolean"
+ },
+ "include_subscription_start_date_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "include_usage_review": {
+ "type": "boolean"
+ },
+ "include_usage_review_val": {
+ "type": "string"
+ },
+ "include_use_limitations": {
+ "type": "boolean"
+ },
+ "include_use_limitations_val": {
+ "type": "string"
+ },
+ "invoice_period": {
+ "enum": [
+ "monthly",
+ "quarterly",
+ "semiannually",
+ "annually",
+ "Custom unit",
+ "Monthly",
+ "Quarterly",
+ "Semiannually",
+ "Annually"
+ ],
+ "type": "string"
+ },
+ "invoice_period_custom_unit": {
+ "type": "string"
+ },
+ "max_consumption": {
+ "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": {
+ "enum": [
+ "signature",
+ "date",
+ "other"
+ ],
+ "type": "string"
+ },
+ "payment_period": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "payment_period_timeframe": {
+ "enum": [
+ "Customer's receipt of invoice",
+ "date of invoice"
+ ],
+ "type": "string"
+ },
+ "payment_period_unit": {
+ "enum": [
+ "day(s)",
+ "week(s)",
+ "month(s)",
+ "marketplace_acceptance"
+ ],
+ "type": "string"
+ },
+ "payment_process_automatic_frequency": {
+ "enum": [
+ "monthly",
+ "quarterly",
+ "semiannually",
+ "annually"
+ ],
+ "type": "string"
+ },
+ "payment_process_type": {
+ "enum": [
+ "automatic",
+ "invoice",
+ "custom",
+ "marketplace_acceptance"
+ ],
+ "type": "string"
+ },
+ "payment_process_type_custom_val": {
+ "type": "string"
+ },
+ "payment_process_type_invoice_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "payment_process_type_invoice_custom_unit": {
+ "type": "string"
+ },
+ "payment_process_type_invoice_duration": {
+ "enum": [
+ "day",
+ "week",
+ "month",
+ "year",
+ "day(s)",
+ "week(s)",
+ "month(s)",
+ "year(s)"
+ ],
+ "type": "string"
+ },
+ "payment_process_type_invoice_duration_start": {
+ "enum": [
+ "Customer's receipt of invoice",
+ "date of invoice"
+ ],
+ "type": "string"
+ },
+ "payment_process_type_invoice_type": {
+ "enum": [
+ "monthly",
+ "quarterly",
+ "semiannually",
+ "annually",
+ "Custom unit"
+ ],
+ "type": "string"
+ },
+ "pilot_period_stripe_product_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-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": {
+ "enum": [
+ "days",
+ "subscription_end"
+ ],
+ "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": {
+ "enum": [
+ "effective_date",
+ "date"
+ ],
+ "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": {
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "type": "string"
+ },
+ "general_cap_amount": {
+ "type": "number"
+ },
+ "general_cap_amount_type": {
+ "enum": [
+ "preceding",
+ "base",
+ "period"
+ ],
+ "type": "string"
+ },
+ "general_cap_period_currency": {
+ "type": "number"
+ },
+ "general_cap_period_qty": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "general_cap_preceding_amount": {
+ "type": "number"
+ },
+ "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": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_dpa": {
+ "type": "boolean"
+ },
+ "include_dpa_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_dpa_location": {
+ "type": "string"
+ },
+ "include_dpa_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_increased_cap_amount": {
+ "type": "boolean"
+ },
+ "include_increased_claims": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_confidentiality": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_confidentiality_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_privsec": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_privsec_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_other": {
+ "type": "boolean"
+ },
+ "include_increased_claims_indemnification_obligation": {
+ "type": "boolean"
+ },
+ "include_increased_claims_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_other": {
+ "type": "string"
+ },
+ "include_provider_insurance_min": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_add_customer_com_gen_liability": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_add_customer_cyber_liability": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_add_customer_errors_omissions": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_auto_liability_aggregate": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_auto_liability_minimum": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_cyber_liability_aggregate": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_cyber_liability_minimum": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_employer_liability_aggregate": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_employer_liability_minimum": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_general_liability_aggregate": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_general_liability_minimum": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_include_add_customer": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_include_auto_liability": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_include_cyber_liability": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_include_employer_liability": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_include_general_liability": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_include_workers_comp": {
+ "type": "boolean"
+ },
+ "include_publicity_rights": {
+ "type": "boolean"
+ },
+ "include_publicity_rights_type": {
+ "enum": [
+ "public",
+ "non-public"
+ ],
+ "type": "string"
+ },
+ "include_security_policy": {
+ "type": "boolean"
+ },
+ "include_security_policy_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_security_policy_fedramp_auth": {
+ "type": "boolean"
+ },
+ "include_security_policy_hitrust": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_annual_maintenance": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_other": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_other_val": {
+ "type": "string"
+ },
+ "include_security_policy_iso27001": {
+ "type": "boolean"
+ },
+ "include_security_policy_location": {
+ "type": "string"
+ },
+ "include_security_policy_pci1": {
+ "type": "boolean"
+ },
+ "include_security_policy_pci2": {
+ "type": "boolean"
+ },
+ "include_security_policy_penetration_testing": {
+ "type": "boolean"
+ },
+ "include_security_policy_soc2_type1": {
+ "type": "boolean"
+ },
+ "include_security_policy_soc2_type2": {
+ "type": "boolean"
+ },
+ "include_security_policy_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_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": {
+ "enum": [
+ "qty",
+ "currency",
+ "period"
+ ],
+ "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": {
+ "enum": [
+ "hours",
+ "days",
+ "weeks",
+ "months"
+ ],
+ "type": "string"
+ },
+ "include_deliverables_resubmission_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_deliverables_resubmission_unit": {
+ "enum": [
+ "hours",
+ "days",
+ "weeks",
+ "months"
+ ],
+ "type": "string"
+ },
+ "include_fees_other": {
+ "type": "boolean"
+ },
+ "include_fees_other_val": {
+ "type": "string"
+ },
+ "include_fees_table": {
+ "type": "boolean"
+ },
+ "include_fees_table_total": {
+ "type": "boolean"
+ },
+ "include_fees_travel": {
+ "type": "boolean"
+ },
+ "include_fees_travel_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_fees_travel_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_fees_travel_val": {
+ "type": "string"
+ },
+ "include_third_party_customer": {
+ "type": "boolean"
+ },
+ "include_third_party_include_description": {
+ "type": "boolean"
+ },
+ "include_third_party_include_description_val": {
+ "type": "string"
+ },
+ "include_third_party_materials": {
+ "type": "boolean"
+ },
+ "include_third_party_provider": {
+ "type": "boolean"
+ },
+ "include_time_of_assignment": {
+ "type": "boolean"
+ },
+ "include_time_of_assignment_type": {
+ "enum": [
+ "created",
+ "paid"
+ ],
+ "type": "string"
+ },
+ "invoice_period_description": {
+ "type": "string"
+ },
+ "negotiations_allowed": {
+ "description": "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": {
+ "enum": [
+ "receipt",
+ "invoice",
+ "Customer's receipt of invoice",
+ "date of invoice"
+ ],
+ "type": "string"
+ },
+ "payment_period_type": {
+ "enum": [
+ "standard",
+ "other"
+ ],
+ "type": "string"
+ },
+ "payment_period_unit": {
+ "enum": [
+ "day(s)",
+ "week(s)",
+ "month(s)",
+ "quarter(s)",
+ "year(s)"
+ ],
+ "type": "string"
+ },
+ "services_description": {
+ "type": "string"
+ },
+ "sow_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "sow_date_type": {
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "type": "string"
+ },
+ "sow_term_amount": {
+ "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": {
+ "enum": [
+ "deliverables",
+ "period",
+ "date"
+ ],
+ "type": "string"
+ },
+ "sow_term_unit": {
+ "enum": [
+ "month(s)",
+ "quarter(s)",
+ "year(s)"
+ ],
+ "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": {
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "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": {
+ "enum": [
+ "default_language",
+ "description"
+ ],
+ "type": "string"
+ },
+ "include_fees_unit": {
+ "enum": [
+ "month",
+ "quarter",
+ "year",
+ "Term"
+ ],
+ "type": "string"
+ },
+ "include_program_appear_as_customer_private": {
+ "type": "boolean"
+ },
+ "include_program_appear_as_customer_public": {
+ "type": "boolean"
+ },
+ "include_program_case_study": {
+ "type": "boolean"
+ },
+ "include_program_develop_functionality": {
+ "type": "boolean"
+ },
+ "include_program_develop_functionality_val": {
+ "type": "string"
+ },
+ "include_program_discount": {
+ "type": "boolean"
+ },
+ "include_program_discount_amount": {
+ "type": "number"
+ },
+ "include_program_discount_unit": {
+ "enum": [
+ "U.S. Dollars",
+ "percent"
+ ],
+ "type": "string"
+ },
+ "include_program_participation_feedback": {
+ "type": "boolean"
+ },
+ "include_program_participation_feedback_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_program_participation_feedback_unit": {
+ "enum": [
+ "month",
+ "quarter",
+ "year",
+ "Term"
+ ],
+ "type": "string"
+ },
+ "include_program_partner_other": {
+ "type": "boolean"
+ },
+ "include_program_partner_other_val": {
+ "type": "string"
+ },
+ "include_program_provider_other": {
+ "type": "boolean"
+ },
+ "include_program_provider_other_val": {
+ "type": "string"
+ },
+ "include_program_reference": {
+ "type": "boolean"
+ },
+ "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": {
+ "enum": [
+ "day(s)",
+ "week(s)",
+ "month(s)",
+ "quarter(s)",
+ "year(s)"
+ ],
+ "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": {
+ "enum": [
+ "stripe",
+ "link"
+ ],
+ "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": {
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "type": "string"
+ },
+ "general_cap_amount": {
+ "type": "number"
+ },
+ "general_cap_amount_type": {
+ "enum": [
+ "preceding",
+ "base",
+ "period"
+ ],
+ "type": "string"
+ },
+ "general_cap_period_currency": {
+ "type": "number"
+ },
+ "general_cap_period_qty": {
+ "type": "number"
+ },
+ "general_cap_preceding_amount": {
+ "type": "number"
+ },
+ "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": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_increased_cap_amount": {
+ "type": "boolean"
+ },
+ "include_increased_claims": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_confidentiality": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_confidentiality_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_other": {
+ "type": "boolean"
+ },
+ "include_increased_claims_indemnification_obligation": {
+ "type": "boolean"
+ },
+ "include_increased_claims_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_other": {
+ "type": "string"
+ },
+ "include_increased_claims_restrictions": {
+ "type": "boolean"
+ },
+ "include_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": {
+ "enum": [
+ "qty",
+ "currency",
+ "period"
+ ],
+ "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": {
+ "enum": [
+ "automatic",
+ "manual"
+ ],
+ "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": {
+ "enum": [
+ "automatic",
+ "invoice"
+ ],
+ "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": {
+ "enum": [
+ "Subscription Period",
+ "month",
+ "year",
+ "Custom unit"
+ ],
+ "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": {
+ "enum": [
+ "USD",
+ "EUR",
+ "GBP",
+ "CAD",
+ "AUD",
+ "SGD",
+ "ILS",
+ "JPY",
+ "CHF",
+ "HKD"
+ ],
+ "type": "string"
+ },
+ "fees_include_fee_increase_upon_renewal": {
+ "type": "boolean"
+ },
+ "fees_include_fee_increase_upon_renewal_fee": {
+ "type": "number"
+ },
+ "fees_include_fee_increase_upon_renewal_type": {
+ "enum": [
+ "will",
+ "may"
+ ],
+ "type": "string"
+ },
+ "fees_inclusive_of_taxes": {
+ "type": "boolean"
+ },
+ "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": {
+ "enum": [
+ "day",
+ "week",
+ "month"
+ ],
+ "type": "string"
+ },
+ "include_pilot_period_include_fees": {
+ "type": "boolean"
+ },
+ "include_pilot_period_include_fees_amount": {
+ "type": "number"
+ },
+ "include_pilot_period_include_modifications": {
+ "type": "boolean"
+ },
+ "include_pilot_period_include_modifications_description": {
+ "type": "string"
+ },
+ "include_services": {
+ "type": "boolean"
+ },
+ "include_services_description": {
+ "type": "string"
+ },
+ "negotiations_allowed": {
+ "description": "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": {
+ "enum": [
+ "signature",
+ "date",
+ "other"
+ ],
+ "type": "string"
+ },
+ "payment_process_automatic_frequency": {
+ "enum": [
+ "monthly",
+ "quarterly",
+ "semiannually",
+ "annually"
+ ],
+ "type": "string"
+ },
+ "payment_process_type": {
+ "enum": [
+ "automatic",
+ "invoice",
+ "custom"
+ ],
+ "type": "string"
+ },
+ "payment_process_type_custom_val": {
+ "type": "string"
+ },
+ "payment_process_type_invoice_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "payment_process_type_invoice_custom_unit": {
+ "type": "string"
+ },
+ "payment_process_type_invoice_duration": {
+ "enum": [
+ "day",
+ "week",
+ "month",
+ "year",
+ "day(s)",
+ "week(s)",
+ "month(s)",
+ "year(s)"
+ ],
+ "type": "string"
+ },
+ "payment_process_type_invoice_duration_start": {
+ "enum": [
+ "Customer's receipt of invoice",
+ "date of invoice"
+ ],
+ "type": "string"
+ },
+ "payment_process_type_invoice_type": {
+ "enum": [
+ "monthly",
+ "quarterly",
+ "semiannually",
+ "annually",
+ "Custom unit"
+ ],
+ "type": "string"
+ },
+ "permitted_uses_include_custom": {
+ "type": "boolean"
+ },
+ "permitted_uses_include_custom_description": {
+ "type": "string"
+ },
+ "permitted_uses_include_customers_affiliates": {
+ "type": "boolean"
+ },
+ "permitted_uses_include_internal_business": {
+ "type": "boolean"
+ },
+ "pilot_period_stripe_product_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-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": {
+ "enum": [
+ "days",
+ "subscription_end"
+ ],
+ "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": {
+ "enum": [
+ "day",
+ "week",
+ "month",
+ "year"
+ ],
+ "type": "string"
+ },
+ "warranty_period_description_duration_start": {
+ "enum": [
+ "initial delivery of the Software",
+ "delivery of the Software and each subsequent Update",
+ "the Order Date"
+ ],
+ "type": "string"
+ },
+ "warranty_period_type": {
+ "enum": [
+ "description",
+ "none"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "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": {
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "type": "string"
+ },
+ "fees_type": {
+ "enum": [
+ "free",
+ "pilot_period_fees"
+ ],
+ "type": "string"
+ },
+ "general_cap_amount": {
+ "type": "number"
+ },
+ "general_cap_amount_type": {
+ "enum": [
+ "preceding",
+ "base",
+ "period"
+ ],
+ "type": "string"
+ },
+ "general_cap_period_currency": {
+ "type": "number"
+ },
+ "general_cap_period_qty": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "general_cap_preceding_amount": {
+ "type": "number"
+ },
+ "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": {
+ "enum": [
+ "description",
+ "attachment",
+ "standard"
+ ],
+ "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": {
+ "enum": [
+ "monthly",
+ "quarterly",
+ "annually",
+ "once_per_period"
+ ],
+ "type": "string"
+ },
+ "payment_process_invoice_days": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "payment_process_invoice_from": {
+ "enum": [
+ "receipt",
+ "date"
+ ],
+ "type": "string"
+ },
+ "payment_process_invoice_timeframe": {
+ "enum": [
+ "days",
+ "weeks",
+ "months",
+ "quarters",
+ "years"
+ ],
+ "type": "string"
+ },
+ "payment_process_type": {
+ "enum": [
+ "automatic",
+ "invoice"
+ ],
+ "type": "string"
+ },
+ "pilot_period_description": {
+ "type": "string"
+ },
+ "pilot_period_fees_description": {
+ "type": "string"
+ },
+ "product_description": {
+ "type": "string"
+ },
+ "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": {
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "type": "string"
+ },
+ "general_cap_amount_currency_val": {
+ "type": "number"
+ },
+ "general_cap_amount_either_currency": {
+ "type": "number"
+ },
+ "general_cap_amount_either_multiple": {
+ "type": "number"
+ },
+ "general_cap_amount_multiple_val": {
+ "type": "number"
+ },
+ "general_cap_amount_type": {
+ "enum": [
+ "multiple",
+ "currency",
+ "either",
+ "base"
+ ],
+ "type": "string"
+ },
+ "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": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_increased_cap_amount": {
+ "type": "boolean"
+ },
+ "include_increased_cap_amount_currency": {
+ "type": "number"
+ },
+ "include_increased_cap_amount_either_currency": {
+ "type": "number"
+ },
+ "include_increased_cap_amount_either_multiple": {},
+ "include_increased_cap_amount_multiple": {},
+ "include_increased_cap_amount_type": {
+ "enum": [
+ "multiple",
+ "currency",
+ "either"
+ ],
+ "type": "string"
+ },
+ "include_increased_claims": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_confidentiality": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_confidentiality_misconduct": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_covered_claims": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_misconduct": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_other": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_other_val": {
+ "type": "string"
+ },
+ "include_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": {
+ "enum": [
+ "month(s)",
+ "quarter(s)",
+ "year(s)"
+ ],
+ "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": {
+ "enum": [
+ "date",
+ "effective date"
+ ],
+ "type": "string"
+ },
+ "include_obligations_company_brand": {
+ "type": "boolean"
+ },
+ "include_obligations_company_promotion": {
+ "type": "boolean"
+ },
+ "include_obligations_company_promotion_include_activities": {
+ "type": "boolean"
+ },
+ "include_obligations_company_promotion_include_activities_val": {
+ "type": "string"
+ },
+ "include_obligations_company_promotion_include_materials": {
+ "type": "boolean"
+ },
+ "include_obligations_company_promotion_include_materials_val": {
+ "type": "string"
+ },
+ "include_obligations_company_referral": {
+ "type": "boolean"
+ },
+ "include_obligations_company_referral_include_criteria": {
+ "type": "boolean"
+ },
+ "include_obligations_company_referral_include_criteria_val": {
+ "type": "string"
+ },
+ "include_obligations_company_referral_include_pay_sch": {
+ "type": "boolean"
+ },
+ "include_obligations_company_referral_include_pay_sch_amount": {
+ "type": "number"
+ },
+ "include_obligations_company_referral_include_pay_sch_custom": {
+ "type": "string"
+ },
+ "include_obligations_company_referral_include_pay_sch_unit": {
+ "enum": [
+ "U.S. Dollars",
+ "percent"
+ ],
+ "type": "string"
+ },
+ "include_obligations_company_sponsorship": {
+ "type": "boolean"
+ },
+ "include_obligations_company_sponsorship_include_benefits": {
+ "type": "boolean"
+ },
+ "include_obligations_company_sponsorship_include_benefits_val": {
+ "type": "string"
+ },
+ "include_obligations_company_sponsorship_include_payments": {
+ "type": "boolean"
+ },
+ "include_obligations_company_sponsorship_include_payments_amount": {
+ "type": "number"
+ },
+ "include_obligations_company_sponsorship_include_payments_unit": {
+ "enum": [
+ "U.S. Dollars",
+ "percent"
+ ],
+ "type": "string"
+ },
+ "include_obligations_partner_brand": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_promotion": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_promotion_include_activities": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_promotion_include_activities_val": {
+ "type": "string"
+ },
+ "include_obligations_partner_promotion_include_materials": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_promotion_include_materials_val": {
+ "type": "string"
+ },
+ "include_obligations_partner_referral": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_referral_include_criteria": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_referral_include_criteria_val": {
+ "type": "string"
+ },
+ "include_obligations_partner_referral_include_pay_sch": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_referral_include_pay_sch_amount": {
+ "type": "number"
+ },
+ "include_obligations_partner_referral_include_pay_sch_custom": {
+ "type": "string"
+ },
+ "include_obligations_partner_referral_include_pay_sch_unit": {
+ "enum": [
+ "U.S. Dollars",
+ "percent"
+ ],
+ "type": "string"
+ },
+ "include_obligations_partner_sponsorship": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_sponsorship_include_benefits": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_sponsorship_include_benefits_val": {
+ "type": "string"
+ },
+ "include_obligations_partner_sponsorship_include_payments": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_sponsorship_include_payments_amount": {
+ "type": "number"
+ },
+ "include_obligations_partner_sponsorship_include_payments_unit": {
+ "enum": [
+ "U.S. Dollars",
+ "percent"
+ ],
+ "type": "string"
+ },
+ "include_payment_process": {
+ "type": "boolean"
+ },
+ "include_payment_process_company": {
+ "type": "boolean"
+ },
+ "include_payment_process_company_include_address": {
+ "type": "boolean"
+ },
+ "include_payment_process_company_include_address_city": {
+ "type": "string"
+ },
+ "include_payment_process_company_include_address_country": {
+ "type": "string"
+ },
+ "include_payment_process_company_include_address_state": {
+ "type": "string"
+ },
+ "include_payment_process_company_include_address_street_address": {
+ "type": "string"
+ },
+ "include_payment_process_company_include_address_zipcode": {
+ "type": "string"
+ },
+ "include_payment_process_company_include_email": {
+ "type": "boolean"
+ },
+ "include_payment_process_company_include_email_val": {
+ "format": "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": {
+ "enum": [
+ "receipt",
+ "date"
+ ],
+ "type": "string"
+ },
+ "include_payment_schedule_specified_unit": {
+ "enum": [
+ "day(s)",
+ "week(s)",
+ "month(s)",
+ "quarter(s)",
+ "year(s)"
+ ],
+ "type": "string"
+ },
+ "include_payment_schedule_type": {
+ "enum": [
+ "specified",
+ "custom"
+ ],
+ "type": "string"
+ },
+ "negotiations_allowed": {
+ "description": "Whether counterparties can propose changes to agreements created from this template.",
+ "type": "boolean"
+ },
+ "territory_type": {
+ "enum": [
+ "worldwide",
+ "custom"
+ ],
+ "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": {
+ "enum": [
+ "hours",
+ "business days",
+ "calendar days"
+ ],
+ "type": "string"
+ },
+ "breach_notification_val": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "business_associate_relationship_type": {
+ "enum": [
+ "provider",
+ "company"
+ ],
+ "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": {
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "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": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "confidentiality_type": {
+ "enum": [
+ "mutual",
+ "nda",
+ "provider",
+ "custom"
+ ],
+ "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": {
+ "enum": [
+ "month",
+ "year",
+ "quarter"
+ ],
+ "type": "string"
+ },
+ "include_fees_include_amount": {
+ "type": "boolean"
+ },
+ "include_fees_include_other": {
+ "type": "boolean"
+ },
+ "include_fees_other": {
+ "type": "string"
+ },
+ "include_functionality": {
+ "type": "boolean"
+ },
+ "include_functionality_val": {
+ "type": "string"
+ },
+ "include_launch_date": {
+ "type": "boolean"
+ },
+ "include_launch_date_custom": {
+ "type": "string"
+ },
+ "include_launch_date_date": {
+ "format": "date-time",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$",
+ "type": "string"
+ },
+ "include_launch_date_type": {
+ "enum": [
+ "date",
+ "custom"
+ ],
+ "type": "string"
+ },
+ "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-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": {
- "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"
- }
-]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.",
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "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.",
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "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.",
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "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.",
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "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.",
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "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.",
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "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.",
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "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.",
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "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.",
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "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.",
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "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.",
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "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.",
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "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"
+ }
+]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": {
- "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"
- }
-]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": {
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "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": {
+ "enum": [
+ "stripe",
+ "link"
+ ],
+ "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": {
+ "enum": [
+ "AWS",
+ "GCP",
+ "Azure"
+ ],
+ "type": "string"
+ },
+ "effective_date_type": {
+ "enum": [
+ "signature",
+ "date",
+ "marketplace_acceptance"
+ ],
+ "type": "string"
+ },
+ "general_cap_amount": {
+ "type": "number"
+ },
+ "general_cap_amount_type": {
+ "enum": [
+ "preceding",
+ "base",
+ "period"
+ ],
+ "type": "string"
+ },
+ "general_cap_period_currency": {
+ "type": "number"
+ },
+ "general_cap_period_qty": {
+ "type": "number"
+ },
+ "general_cap_preceding_amount": {
+ "type": "number"
+ },
+ "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": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "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": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_increased_cap_amount": {
+ "type": "boolean"
+ },
+ "include_increased_claims": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_confidentiality": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_confidentiality_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_privsec": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_privsec_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_other": {
+ "type": "boolean"
+ },
+ "include_increased_claims_indemnification_obligation": {
+ "type": "boolean"
+ },
+ "include_increased_claims_other": {
+ "type": "string"
+ },
+ "include_insurance_minimums": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_add_customer": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_add_customer_com_gen_liability": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_add_customer_cyber_liability": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_add_customer_errors_omissions": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_additional_information": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_additional_information_text": {
+ "type": "string"
+ },
+ "include_insurance_minimums_cyber_liability_aggregate": {
+ "type": "number"
+ },
+ "include_insurance_minimums_cyber_liability_minimum": {
+ "type": "number"
+ },
+ "include_insurance_minimums_employer_liability_aggregate": {
+ "type": "number"
+ },
+ "include_insurance_minimums_employer_liability_minimum": {
+ "type": "number"
+ },
+ "include_insurance_minimums_general_liability_aggregate": {
+ "type": "number"
+ },
+ "include_insurance_minimums_general_liability_minimum": {
+ "type": "number"
+ },
+ "include_insurance_minimums_include_cyber_liability": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_include_employer_liability": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_include_general_liability": {
+ "type": "boolean"
+ },
+ "include_insurance_minimums_include_workers_compensation": {
+ "type": "boolean"
+ },
+ "include_publicity_rights": {
+ "type": "boolean"
+ },
+ "include_publicity_rights_type": {
+ "enum": [
+ "public",
+ "non-public"
+ ],
+ "type": "string"
+ },
+ "include_security_policy": {
+ "type": "boolean"
+ },
+ "include_security_policy_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_security_policy_fedramp_auth": {
+ "type": "boolean"
+ },
+ "include_security_policy_hipaa": {
+ "type": "boolean"
+ },
+ "include_security_policy_hitrust": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_annual_maintenance": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_location": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_other": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_reasonable_efforts": {
+ "type": "boolean"
+ },
+ "include_security_policy_iso27001": {
+ "type": "boolean"
+ },
+ "include_security_policy_location": {
+ "type": "string"
+ },
+ "include_security_policy_other": {
+ "type": "string"
+ },
+ "include_security_policy_pci1": {
+ "type": "boolean"
+ },
+ "include_security_policy_pci2": {
+ "type": "boolean"
+ },
+ "include_security_policy_penetration_testing": {
+ "type": "boolean"
+ },
+ "include_security_policy_soc2": {
+ "type": "boolean"
+ },
+ "include_security_policy_soc2_type2": {
+ "type": "boolean"
+ },
+ "include_security_policy_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_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": {
+ "type": "number"
+ },
+ "increased_cap_amount_qty": {
+ "type": "number"
+ },
+ "increased_cap_amount_type": {
+ "enum": [
+ "qty",
+ "currency",
+ "period"
+ ],
+ "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": {
+ "enum": [
+ "automatic",
+ "invoice"
+ ],
+ "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": {
+ "enum": [
+ "Subscription Period",
+ "month",
+ "year",
+ "User",
+ "Custom unit"
+ ],
+ "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": {
+ "enum": [
+ "USD",
+ "EUR",
+ "GBP",
+ "CAD",
+ "AUD",
+ "SGD",
+ "ILS",
+ "JPY",
+ "CHF",
+ "HKD"
+ ],
+ "type": "string"
+ },
+ "fees_include_fee_increase_upon_renewal": {
+ "type": "boolean"
+ },
+ "fees_include_fee_increase_upon_renewal_fee": {
+ "type": "number"
+ },
+ "fees_include_fee_increase_upon_renewal_type": {
+ "enum": [
+ "will",
+ "may"
+ ],
+ "type": "string"
+ },
+ "fees_inclusive_of_taxes": {
+ "type": "boolean"
+ },
+ "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": {
+ "enum": [
+ "Subscription Period",
+ "month",
+ "year",
+ "User"
+ ],
+ "type": "string"
+ },
+ "include_free_trial": {
+ "type": "boolean"
+ },
+ "include_max_users": {
+ "type": "boolean"
+ },
+ "include_pilot_period": {
+ "type": "boolean"
+ },
+ "include_pilot_period_duration_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_pilot_period_duration_type": {
+ "enum": [
+ "day",
+ "week",
+ "month"
+ ],
+ "type": "string"
+ },
+ "include_pilot_period_include_fees": {
+ "type": "boolean"
+ },
+ "include_pilot_period_include_fees_amount": {
+ "type": "number"
+ },
+ "include_pilot_period_include_modifications": {
+ "type": "boolean"
+ },
+ "include_pilot_period_include_modifications_description": {
+ "type": "string"
+ },
+ "include_product_support": {
+ "type": "boolean"
+ },
+ "include_product_support_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_product_support_description": {
+ "type": "string"
+ },
+ "include_product_support_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_professional_services": {
+ "type": "boolean"
+ },
+ "include_professional_services_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_professional_services_custom_name": {
+ "type": "string"
+ },
+ "include_professional_services_description": {
+ "type": "string"
+ },
+ "include_professional_services_end_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "include_professional_services_fees_description": {
+ "type": "string"
+ },
+ "include_professional_services_include_end_date": {
+ "type": "boolean"
+ },
+ "include_professional_services_include_fees_description": {
+ "type": "boolean"
+ },
+ "include_professional_services_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_sla": {
+ "type": "boolean"
+ },
+ "include_sla_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_sla_description": {
+ "type": "string"
+ },
+ "include_sla_include_response_time": {
+ "type": "boolean"
+ },
+ "include_sla_include_response_time_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_sla_include_response_time_credit": {
+ "type": "number"
+ },
+ "include_sla_include_response_time_duration": {
+ "enum": [
+ "hour",
+ "day",
+ "week",
+ "month",
+ "hours"
+ ],
+ "type": "string"
+ },
+ "include_sla_include_response_time_support_channel": {
+ "type": "string"
+ },
+ "include_sla_include_target_uptime": {
+ "type": "boolean"
+ },
+ "include_sla_maintenance_notice": {
+ "type": "boolean"
+ },
+ "include_sla_maintenance_window": {
+ "type": "boolean"
+ },
+ "include_sla_maintenance_window_type": {
+ "enum": [
+ "standard",
+ "none"
+ ],
+ "type": "string"
+ },
+ "include_sla_standard_maintenance_notice_qty": {
+ "type": "number"
+ },
+ "include_sla_standard_maintenance_notice_unit": {
+ "enum": [
+ "hour",
+ "day",
+ "week",
+ "month"
+ ],
+ "type": "string"
+ },
+ "include_sla_standard_maintenance_window_end_time": {
+ "type": "string"
+ },
+ "include_sla_standard_maintenance_window_friday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_monday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_saturday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_start_time": {
+ "type": "string"
+ },
+ "include_sla_standard_maintenance_window_sunday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_thursday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_time_zone": {
+ "type": "string"
+ },
+ "include_sla_standard_maintenance_window_tuesday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_maintenance_window_wednesday": {
+ "type": "boolean"
+ },
+ "include_sla_standard_target_uptime": {
+ "type": "number"
+ },
+ "include_sla_type": {
+ "enum": [
+ "description",
+ "standard",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_subscription_start_date": {
+ "type": "boolean"
+ },
+ "include_subscription_start_date_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "include_usage_review": {
+ "type": "boolean"
+ },
+ "include_usage_review_val": {
+ "type": "string"
+ },
+ "include_use_limitations": {
+ "type": "boolean"
+ },
+ "include_use_limitations_val": {
+ "type": "string"
+ },
+ "invoice_period": {
+ "enum": [
+ "monthly",
+ "quarterly",
+ "semiannually",
+ "annually",
+ "Custom unit",
+ "Monthly",
+ "Quarterly",
+ "Semiannually",
+ "Annually"
+ ],
+ "type": "string"
+ },
+ "invoice_period_custom_unit": {
+ "type": "string"
+ },
+ "max_consumption": {
+ "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": {
+ "enum": [
+ "signature",
+ "date",
+ "other"
+ ],
+ "type": "string"
+ },
+ "payment_period": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "payment_period_timeframe": {
+ "enum": [
+ "Customer's receipt of invoice",
+ "date of invoice"
+ ],
+ "type": "string"
+ },
+ "payment_period_unit": {
+ "enum": [
+ "day(s)",
+ "week(s)",
+ "month(s)",
+ "marketplace_acceptance"
+ ],
+ "type": "string"
+ },
+ "payment_process_automatic_frequency": {
+ "enum": [
+ "monthly",
+ "quarterly",
+ "semiannually",
+ "annually"
+ ],
+ "type": "string"
+ },
+ "payment_process_type": {
+ "enum": [
+ "automatic",
+ "invoice",
+ "custom",
+ "marketplace_acceptance"
+ ],
+ "type": "string"
+ },
+ "payment_process_type_custom_val": {
+ "type": "string"
+ },
+ "payment_process_type_invoice_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "payment_process_type_invoice_custom_unit": {
+ "type": "string"
+ },
+ "payment_process_type_invoice_duration": {
+ "enum": [
+ "day",
+ "week",
+ "month",
+ "year",
+ "day(s)",
+ "week(s)",
+ "month(s)",
+ "year(s)"
+ ],
+ "type": "string"
+ },
+ "payment_process_type_invoice_duration_start": {
+ "enum": [
+ "Customer's receipt of invoice",
+ "date of invoice"
+ ],
+ "type": "string"
+ },
+ "payment_process_type_invoice_type": {
+ "enum": [
+ "monthly",
+ "quarterly",
+ "semiannually",
+ "annually",
+ "Custom unit"
+ ],
+ "type": "string"
+ },
+ "pilot_period_stripe_product_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-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": {
+ "enum": [
+ "days",
+ "subscription_end"
+ ],
+ "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": {
+ "enum": [
+ "effective_date",
+ "date"
+ ],
+ "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": {
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "type": "string"
+ },
+ "general_cap_amount": {
+ "type": "number"
+ },
+ "general_cap_amount_type": {
+ "enum": [
+ "preceding",
+ "base",
+ "period"
+ ],
+ "type": "string"
+ },
+ "general_cap_period_currency": {
+ "type": "number"
+ },
+ "general_cap_period_qty": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "general_cap_preceding_amount": {
+ "type": "number"
+ },
+ "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": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_dpa": {
+ "type": "boolean"
+ },
+ "include_dpa_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_dpa_location": {
+ "type": "string"
+ },
+ "include_dpa_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_increased_cap_amount": {
+ "type": "boolean"
+ },
+ "include_increased_claims": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_confidentiality": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_confidentiality_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_privsec": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_privsec_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_other": {
+ "type": "boolean"
+ },
+ "include_increased_claims_indemnification_obligation": {
+ "type": "boolean"
+ },
+ "include_increased_claims_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_other": {
+ "type": "string"
+ },
+ "include_provider_insurance_min": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_add_customer_com_gen_liability": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_add_customer_cyber_liability": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_add_customer_errors_omissions": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_auto_liability_aggregate": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_auto_liability_minimum": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_cyber_liability_aggregate": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_cyber_liability_minimum": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_employer_liability_aggregate": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_employer_liability_minimum": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_general_liability_aggregate": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_general_liability_minimum": {
+ "type": "number"
+ },
+ "include_provider_insurance_min_include_add_customer": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_include_auto_liability": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_include_cyber_liability": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_include_employer_liability": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_include_general_liability": {
+ "type": "boolean"
+ },
+ "include_provider_insurance_min_include_workers_comp": {
+ "type": "boolean"
+ },
+ "include_publicity_rights": {
+ "type": "boolean"
+ },
+ "include_publicity_rights_type": {
+ "enum": [
+ "public",
+ "non-public"
+ ],
+ "type": "string"
+ },
+ "include_security_policy": {
+ "type": "boolean"
+ },
+ "include_security_policy_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_security_policy_fedramp_auth": {
+ "type": "boolean"
+ },
+ "include_security_policy_hitrust": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_annual_maintenance": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_other": {
+ "type": "boolean"
+ },
+ "include_security_policy_include_other_val": {
+ "type": "string"
+ },
+ "include_security_policy_iso27001": {
+ "type": "boolean"
+ },
+ "include_security_policy_location": {
+ "type": "string"
+ },
+ "include_security_policy_pci1": {
+ "type": "boolean"
+ },
+ "include_security_policy_pci2": {
+ "type": "boolean"
+ },
+ "include_security_policy_penetration_testing": {
+ "type": "boolean"
+ },
+ "include_security_policy_soc2_type1": {
+ "type": "boolean"
+ },
+ "include_security_policy_soc2_type2": {
+ "type": "boolean"
+ },
+ "include_security_policy_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_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": {
+ "enum": [
+ "qty",
+ "currency",
+ "period"
+ ],
+ "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": {
+ "enum": [
+ "hours",
+ "days",
+ "weeks",
+ "months"
+ ],
+ "type": "string"
+ },
+ "include_deliverables_resubmission_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_deliverables_resubmission_unit": {
+ "enum": [
+ "hours",
+ "days",
+ "weeks",
+ "months"
+ ],
+ "type": "string"
+ },
+ "include_fees_other": {
+ "type": "boolean"
+ },
+ "include_fees_other_val": {
+ "type": "string"
+ },
+ "include_fees_table": {
+ "type": "boolean"
+ },
+ "include_fees_table_total": {
+ "type": "boolean"
+ },
+ "include_fees_travel": {
+ "type": "boolean"
+ },
+ "include_fees_travel_attachment_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
+ "type": "string"
+ },
+ "include_fees_travel_type": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_fees_travel_val": {
+ "type": "string"
+ },
+ "include_third_party_customer": {
+ "type": "boolean"
+ },
+ "include_third_party_include_description": {
+ "type": "boolean"
+ },
+ "include_third_party_include_description_val": {
+ "type": "string"
+ },
+ "include_third_party_materials": {
+ "type": "boolean"
+ },
+ "include_third_party_provider": {
+ "type": "boolean"
+ },
+ "include_time_of_assignment": {
+ "type": "boolean"
+ },
+ "include_time_of_assignment_type": {
+ "enum": [
+ "created",
+ "paid"
+ ],
+ "type": "string"
+ },
+ "invoice_period_description": {
+ "type": "string"
+ },
+ "negotiations_allowed": {
+ "description": "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": {
+ "enum": [
+ "receipt",
+ "invoice",
+ "Customer's receipt of invoice",
+ "date of invoice"
+ ],
+ "type": "string"
+ },
+ "payment_period_type": {
+ "enum": [
+ "standard",
+ "other"
+ ],
+ "type": "string"
+ },
+ "payment_period_unit": {
+ "enum": [
+ "day(s)",
+ "week(s)",
+ "month(s)",
+ "quarter(s)",
+ "year(s)"
+ ],
+ "type": "string"
+ },
+ "services_description": {
+ "type": "string"
+ },
+ "sow_date": {
+ "format": "date",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
+ "type": "string"
+ },
+ "sow_date_type": {
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "type": "string"
+ },
+ "sow_term_amount": {
+ "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": {
+ "enum": [
+ "deliverables",
+ "period",
+ "date"
+ ],
+ "type": "string"
+ },
+ "sow_term_unit": {
+ "enum": [
+ "month(s)",
+ "quarter(s)",
+ "year(s)"
+ ],
+ "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": {
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "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": {
+ "enum": [
+ "default_language",
+ "description"
+ ],
+ "type": "string"
+ },
+ "include_fees_unit": {
+ "enum": [
+ "month",
+ "quarter",
+ "year",
+ "Term"
+ ],
+ "type": "string"
+ },
+ "include_program_appear_as_customer_private": {
+ "type": "boolean"
+ },
+ "include_program_appear_as_customer_public": {
+ "type": "boolean"
+ },
+ "include_program_case_study": {
+ "type": "boolean"
+ },
+ "include_program_develop_functionality": {
+ "type": "boolean"
+ },
+ "include_program_develop_functionality_val": {
+ "type": "string"
+ },
+ "include_program_discount": {
+ "type": "boolean"
+ },
+ "include_program_discount_amount": {
+ "type": "number"
+ },
+ "include_program_discount_unit": {
+ "enum": [
+ "U.S. Dollars",
+ "percent"
+ ],
+ "type": "string"
+ },
+ "include_program_participation_feedback": {
+ "type": "boolean"
+ },
+ "include_program_participation_feedback_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "include_program_participation_feedback_unit": {
+ "enum": [
+ "month",
+ "quarter",
+ "year",
+ "Term"
+ ],
+ "type": "string"
+ },
+ "include_program_partner_other": {
+ "type": "boolean"
+ },
+ "include_program_partner_other_val": {
+ "type": "string"
+ },
+ "include_program_provider_other": {
+ "type": "boolean"
+ },
+ "include_program_provider_other_val": {
+ "type": "string"
+ },
+ "include_program_reference": {
+ "type": "boolean"
+ },
+ "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": {
+ "enum": [
+ "day(s)",
+ "week(s)",
+ "month(s)",
+ "quarter(s)",
+ "year(s)"
+ ],
+ "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": {
+ "enum": [
+ "stripe",
+ "link"
+ ],
+ "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": {
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "type": "string"
+ },
+ "general_cap_amount": {
+ "type": "number"
+ },
+ "general_cap_amount_type": {
+ "enum": [
+ "preceding",
+ "base",
+ "period"
+ ],
+ "type": "string"
+ },
+ "general_cap_period_currency": {
+ "type": "number"
+ },
+ "general_cap_period_qty": {
+ "type": "number"
+ },
+ "general_cap_preceding_amount": {
+ "type": "number"
+ },
+ "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": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_increased_cap_amount": {
+ "type": "boolean"
+ },
+ "include_increased_claims": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_confidentiality": {
+ "type": "boolean"
+ },
+ "include_increased_claims_breach_of_confidentiality_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_other": {
+ "type": "boolean"
+ },
+ "include_increased_claims_indemnification_obligation": {
+ "type": "boolean"
+ },
+ "include_increased_claims_negligence": {
+ "type": "boolean"
+ },
+ "include_increased_claims_other": {
+ "type": "string"
+ },
+ "include_increased_claims_restrictions": {
+ "type": "boolean"
+ },
+ "include_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": {
+ "enum": [
+ "qty",
+ "currency",
+ "period"
+ ],
+ "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": {
+ "enum": [
+ "automatic",
+ "manual"
+ ],
+ "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": {
+ "enum": [
+ "automatic",
+ "invoice"
+ ],
+ "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": {
+ "enum": [
+ "Subscription Period",
+ "month",
+ "year",
+ "Custom unit"
+ ],
+ "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": {
+ "enum": [
+ "USD",
+ "EUR",
+ "GBP",
+ "CAD",
+ "AUD",
+ "SGD",
+ "ILS",
+ "JPY",
+ "CHF",
+ "HKD"
+ ],
+ "type": "string"
+ },
+ "fees_include_fee_increase_upon_renewal": {
+ "type": "boolean"
+ },
+ "fees_include_fee_increase_upon_renewal_fee": {
+ "type": "number"
+ },
+ "fees_include_fee_increase_upon_renewal_type": {
+ "enum": [
+ "will",
+ "may"
+ ],
+ "type": "string"
+ },
+ "fees_inclusive_of_taxes": {
+ "type": "boolean"
+ },
+ "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": {
+ "enum": [
+ "day",
+ "week",
+ "month"
+ ],
+ "type": "string"
+ },
+ "include_pilot_period_include_fees": {
+ "type": "boolean"
+ },
+ "include_pilot_period_include_fees_amount": {
+ "type": "number"
+ },
+ "include_pilot_period_include_modifications": {
+ "type": "boolean"
+ },
+ "include_pilot_period_include_modifications_description": {
+ "type": "string"
+ },
+ "include_services": {
+ "type": "boolean"
+ },
+ "include_services_description": {
+ "type": "string"
+ },
+ "negotiations_allowed": {
+ "description": "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": {
+ "enum": [
+ "signature",
+ "date",
+ "other"
+ ],
+ "type": "string"
+ },
+ "payment_process_automatic_frequency": {
+ "enum": [
+ "monthly",
+ "quarterly",
+ "semiannually",
+ "annually"
+ ],
+ "type": "string"
+ },
+ "payment_process_type": {
+ "enum": [
+ "automatic",
+ "invoice",
+ "custom"
+ ],
+ "type": "string"
+ },
+ "payment_process_type_custom_val": {
+ "type": "string"
+ },
+ "payment_process_type_invoice_amount": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "payment_process_type_invoice_custom_unit": {
+ "type": "string"
+ },
+ "payment_process_type_invoice_duration": {
+ "enum": [
+ "day",
+ "week",
+ "month",
+ "year",
+ "day(s)",
+ "week(s)",
+ "month(s)",
+ "year(s)"
+ ],
+ "type": "string"
+ },
+ "payment_process_type_invoice_duration_start": {
+ "enum": [
+ "Customer's receipt of invoice",
+ "date of invoice"
+ ],
+ "type": "string"
+ },
+ "payment_process_type_invoice_type": {
+ "enum": [
+ "monthly",
+ "quarterly",
+ "semiannually",
+ "annually",
+ "Custom unit"
+ ],
+ "type": "string"
+ },
+ "permitted_uses_include_custom": {
+ "type": "boolean"
+ },
+ "permitted_uses_include_custom_description": {
+ "type": "string"
+ },
+ "permitted_uses_include_customers_affiliates": {
+ "type": "boolean"
+ },
+ "permitted_uses_include_internal_business": {
+ "type": "boolean"
+ },
+ "pilot_period_stripe_product_id": {
+ "format": "uuid",
+ "pattern": "^([0-9a-fA-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": {
+ "enum": [
+ "days",
+ "subscription_end"
+ ],
+ "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": {
+ "enum": [
+ "day",
+ "week",
+ "month",
+ "year"
+ ],
+ "type": "string"
+ },
+ "warranty_period_description_duration_start": {
+ "enum": [
+ "initial delivery of the Software",
+ "delivery of the Software and each subsequent Update",
+ "the Order Date"
+ ],
+ "type": "string"
+ },
+ "warranty_period_type": {
+ "enum": [
+ "description",
+ "none"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ }
+ },
+ "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": {
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "type": "string"
+ },
+ "fees_type": {
+ "enum": [
+ "free",
+ "pilot_period_fees"
+ ],
+ "type": "string"
+ },
+ "general_cap_amount": {
+ "type": "number"
+ },
+ "general_cap_amount_type": {
+ "enum": [
+ "preceding",
+ "base",
+ "period"
+ ],
+ "type": "string"
+ },
+ "general_cap_period_currency": {
+ "type": "number"
+ },
+ "general_cap_period_qty": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "general_cap_preceding_amount": {
+ "type": "number"
+ },
+ "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": {
+ "enum": [
+ "description",
+ "attachment",
+ "standard"
+ ],
+ "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": {
+ "enum": [
+ "monthly",
+ "quarterly",
+ "annually",
+ "once_per_period"
+ ],
+ "type": "string"
+ },
+ "payment_process_invoice_days": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "payment_process_invoice_from": {
+ "enum": [
+ "receipt",
+ "date"
+ ],
+ "type": "string"
+ },
+ "payment_process_invoice_timeframe": {
+ "enum": [
+ "days",
+ "weeks",
+ "months",
+ "quarters",
+ "years"
+ ],
+ "type": "string"
+ },
+ "payment_process_type": {
+ "enum": [
+ "automatic",
+ "invoice"
+ ],
+ "type": "string"
+ },
+ "pilot_period_description": {
+ "type": "string"
+ },
+ "pilot_period_fees_description": {
+ "type": "string"
+ },
+ "product_description": {
+ "type": "string"
+ },
+ "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": {
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "type": "string"
+ },
+ "general_cap_amount_currency_val": {
+ "type": "number"
+ },
+ "general_cap_amount_either_currency": {
+ "type": "number"
+ },
+ "general_cap_amount_either_multiple": {
+ "type": "number"
+ },
+ "general_cap_amount_multiple_val": {
+ "type": "number"
+ },
+ "general_cap_amount_type": {
+ "enum": [
+ "multiple",
+ "currency",
+ "either",
+ "base"
+ ],
+ "type": "string"
+ },
+ "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": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "include_increased_cap_amount": {
+ "type": "boolean"
+ },
+ "include_increased_cap_amount_currency": {
+ "type": "number"
+ },
+ "include_increased_cap_amount_either_currency": {
+ "type": "number"
+ },
+ "include_increased_cap_amount_either_multiple": {},
+ "include_increased_cap_amount_multiple": {},
+ "include_increased_cap_amount_type": {
+ "enum": [
+ "multiple",
+ "currency",
+ "either"
+ ],
+ "type": "string"
+ },
+ "include_increased_claims": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_confidentiality": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_confidentiality_misconduct": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_covered_claims": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_misconduct": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_other": {
+ "type": "boolean"
+ },
+ "include_increased_claims_include_other_val": {
+ "type": "string"
+ },
+ "include_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": {
+ "enum": [
+ "month(s)",
+ "quarter(s)",
+ "year(s)"
+ ],
+ "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": {
+ "enum": [
+ "date",
+ "effective date"
+ ],
+ "type": "string"
+ },
+ "include_obligations_company_brand": {
+ "type": "boolean"
+ },
+ "include_obligations_company_promotion": {
+ "type": "boolean"
+ },
+ "include_obligations_company_promotion_include_activities": {
+ "type": "boolean"
+ },
+ "include_obligations_company_promotion_include_activities_val": {
+ "type": "string"
+ },
+ "include_obligations_company_promotion_include_materials": {
+ "type": "boolean"
+ },
+ "include_obligations_company_promotion_include_materials_val": {
+ "type": "string"
+ },
+ "include_obligations_company_referral": {
+ "type": "boolean"
+ },
+ "include_obligations_company_referral_include_criteria": {
+ "type": "boolean"
+ },
+ "include_obligations_company_referral_include_criteria_val": {
+ "type": "string"
+ },
+ "include_obligations_company_referral_include_pay_sch": {
+ "type": "boolean"
+ },
+ "include_obligations_company_referral_include_pay_sch_amount": {
+ "type": "number"
+ },
+ "include_obligations_company_referral_include_pay_sch_custom": {
+ "type": "string"
+ },
+ "include_obligations_company_referral_include_pay_sch_unit": {
+ "enum": [
+ "U.S. Dollars",
+ "percent"
+ ],
+ "type": "string"
+ },
+ "include_obligations_company_sponsorship": {
+ "type": "boolean"
+ },
+ "include_obligations_company_sponsorship_include_benefits": {
+ "type": "boolean"
+ },
+ "include_obligations_company_sponsorship_include_benefits_val": {
+ "type": "string"
+ },
+ "include_obligations_company_sponsorship_include_payments": {
+ "type": "boolean"
+ },
+ "include_obligations_company_sponsorship_include_payments_amount": {
+ "type": "number"
+ },
+ "include_obligations_company_sponsorship_include_payments_unit": {
+ "enum": [
+ "U.S. Dollars",
+ "percent"
+ ],
+ "type": "string"
+ },
+ "include_obligations_partner_brand": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_promotion": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_promotion_include_activities": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_promotion_include_activities_val": {
+ "type": "string"
+ },
+ "include_obligations_partner_promotion_include_materials": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_promotion_include_materials_val": {
+ "type": "string"
+ },
+ "include_obligations_partner_referral": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_referral_include_criteria": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_referral_include_criteria_val": {
+ "type": "string"
+ },
+ "include_obligations_partner_referral_include_pay_sch": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_referral_include_pay_sch_amount": {
+ "type": "number"
+ },
+ "include_obligations_partner_referral_include_pay_sch_custom": {
+ "type": "string"
+ },
+ "include_obligations_partner_referral_include_pay_sch_unit": {
+ "enum": [
+ "U.S. Dollars",
+ "percent"
+ ],
+ "type": "string"
+ },
+ "include_obligations_partner_sponsorship": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_sponsorship_include_benefits": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_sponsorship_include_benefits_val": {
+ "type": "string"
+ },
+ "include_obligations_partner_sponsorship_include_payments": {
+ "type": "boolean"
+ },
+ "include_obligations_partner_sponsorship_include_payments_amount": {
+ "type": "number"
+ },
+ "include_obligations_partner_sponsorship_include_payments_unit": {
+ "enum": [
+ "U.S. Dollars",
+ "percent"
+ ],
+ "type": "string"
+ },
+ "include_payment_process": {
+ "type": "boolean"
+ },
+ "include_payment_process_company": {
+ "type": "boolean"
+ },
+ "include_payment_process_company_include_address": {
+ "type": "boolean"
+ },
+ "include_payment_process_company_include_address_city": {
+ "type": "string"
+ },
+ "include_payment_process_company_include_address_country": {
+ "type": "string"
+ },
+ "include_payment_process_company_include_address_state": {
+ "type": "string"
+ },
+ "include_payment_process_company_include_address_street_address": {
+ "type": "string"
+ },
+ "include_payment_process_company_include_address_zipcode": {
+ "type": "string"
+ },
+ "include_payment_process_company_include_email": {
+ "type": "boolean"
+ },
+ "include_payment_process_company_include_email_val": {
+ "format": "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": {
+ "enum": [
+ "receipt",
+ "date"
+ ],
+ "type": "string"
+ },
+ "include_payment_schedule_specified_unit": {
+ "enum": [
+ "day(s)",
+ "week(s)",
+ "month(s)",
+ "quarter(s)",
+ "year(s)"
+ ],
+ "type": "string"
+ },
+ "include_payment_schedule_type": {
+ "enum": [
+ "specified",
+ "custom"
+ ],
+ "type": "string"
+ },
+ "negotiations_allowed": {
+ "description": "Whether counterparties can propose changes to agreements created from this template.",
+ "type": "boolean"
+ },
+ "territory_type": {
+ "enum": [
+ "worldwide",
+ "custom"
+ ],
+ "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": {
+ "enum": [
+ "hours",
+ "business days",
+ "calendar days"
+ ],
+ "type": "string"
+ },
+ "breach_notification_val": {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ "business_associate_relationship_type": {
+ "enum": [
+ "provider",
+ "company"
+ ],
+ "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": {
+ "enum": [
+ "signature",
+ "date"
+ ],
+ "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": {
+ "enum": [
+ "description",
+ "attachment"
+ ],
+ "type": "string"
+ },
+ "confidentiality_type": {
+ "enum": [
+ "mutual",
+ "nda",
+ "provider",
+ "custom"
+ ],
+ "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": {
+ "enum": [
+ "month",
+ "year",
+ "quarter"
+ ],
+ "type": "string"
+ },
+ "include_fees_include_amount": {
+ "type": "boolean"
+ },
+ "include_fees_include_other": {
+ "type": "boolean"
+ },
+ "include_fees_other": {
+ "type": "string"
+ },
+ "include_functionality": {
+ "type": "boolean"
+ },
+ "include_functionality_val": {
+ "type": "string"
+ },
+ "include_launch_date": {
+ "type": "boolean"
+ },
+ "include_launch_date_custom": {
+ "type": "string"
+ },
+ "include_launch_date_date": {
+ "format": "date-time",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$",
+ "type": "string"
+ },
+ "include_launch_date_type": {
+ "enum": [
+ "date",
+ "custom"
+ ],
+ "type": "string"
+ },
+ "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"
+ }
+]get-me1 field changedOutput schema / examplesPrevious value: -[
- {
- "data": {
- "attributes": {
- "created_at": "2021-09-01T21:23:24.838Z",
- "email": "admin@xample.com",
- "email_verified": true,
- "id": "USER_UUID_1",
- "name": "Ben Garvey",
- "role": "admin",
- "title": "CTO",
- "updated_at": "2022-04-14T16:51:07.975Z"
- },
- "id": "USER_UUID_1",
- "type": "user"
- }
- }
-]New value: +[
+ {
+ "data": {
+ "attributes": {
+ "created_at": "2021-09-01T21:23:24.838Z",
+ "email": "admin@xample.com",
+ "email_verified": true,
+ "id": "USER_UUID_1",
+ "name": "Ben Garvey",
+ "organization_id": "ORGANIZATION_UUID",
+ "organization_name": "RJMetrics",
+ "role": "admin",
+ "title": "CTO",
+ "updated_at": "2022-04-14T16:51:07.975Z"
+ },
+ "id": "USER_UUID_1",
+ "type": "user"
+ }
+ }
+]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.
Send documents for legally binding e-signature and manage the reusable templates behind them.
Add one secure layer between your agents and this server.
