Schemas

The agreement object

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.

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.

When true, marks the agreement as a test. Test agreements do not count against your monthly limit.

How to set expiration: "none" (default), "days" (use include_expiration_days), or "date" (use include_expiration_date).

Number of days until the agreement expires. Use when include_expiration_type is "days".

Expiration date in YYYY-MM-DD format. Use when include_expiration_type is "date".

When true, enables a billing workflow after signing.

The type of billing workflow. Use "link" to provide a payment_link_url, or "stripe" for Stripe-managed billing.

A payment URL shown to the recipient after signing. Requires include_billing_workflow to be true and billing_workflow_type to be "link".

When true, automatically sends payment reminder emails.

The country whose laws govern the agreement.

The state or region whose laws govern the agreement.

The country in which disputes will be resolved.

The state or region in which disputes will be resolved.

The district or county for dispute resolution.

When true, billing contact information (billing_name, billing_email) is included.

Name of the billing contact. Used when include_billing_info is true.

Email of the billing contact. Used when include_billing_info is true.

Email address for legal notices to the sender.

Email address for legal notices to the recipient.

The ID of an earlier Common Paper agreement this one builds on. For an amendment (agreement_type: "Amendment"), the agreement being amended. For a CSA or software license renewal, the agreement whose framework terms carry over; also set framework_terms_type to existing.

What the agreement builds on. agreement means the Common Paper agreement in parent_agreement_id, and is set automatically when parent_agreement_id is present. For an amendment, description amends an agreement outside Common Paper, described in underlying_agreement_val.

For an amendment, a description of the agreement being amended. Used when underlying_agreement_type is description.

How framework terms are specified. Use "new" for standard terms or "description" to provide a custom framework_terms_description.

Custom framework terms description. Only used when framework_terms_type is "description".

When true, the agreement is marked as manually sent outside the platform.

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.

When true, your signer signs after the recipient.

When true, the standard terms are included with the agreement.

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.

Override template defaults for dpa. Only valid when creating from a matching template.

Override template defaults for csa. Only valid when creating from a matching template.

Override template defaults for csa order form. Only valid when creating from a matching template.

Override template defaults for design partner. Only valid when creating from a matching template.

Override template defaults for pilot. Only valid when creating from a matching template.

Override template defaults for psa. Only valid when creating from a matching template.

Override template defaults for psa statement of work. Only valid when creating from a matching template.

Override template defaults for partnership. Only valid when creating from a matching template.

Override template defaults for partnership business terms. Only valid when creating from a matching template.

Override template defaults for baa. Only valid when creating from a matching template.

Override template defaults for loi. Only valid when creating from a matching template.

Override template defaults for software license. Only valid when creating from a matching template.

Override template defaults for software license order form. Only valid when creating from a matching template.

Override template defaults for amendment. Only valid when creating from a matching template.

Email address of the agreement owner (sender).

Email address of the signer from the owner's organization.

UUID of a template from GET /v1/templates. Accepts both Common Paper standard templates and uploaded PDF templates (type uploaded_template). Required unless agreement_type is Amendment.

Set to Amendment to create an amendment without a template. Omit template_id, set agreement.negotiations_allowed, and set agreement.parent_agreement_id to the agreement being amended, or set agreement.underlying_agreement_type to description with agreement.underlying_agreement_val for an agreement outside Common Paper. Put the amendment terms in agreement.amendment_attributes.

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.

Email address of the agreement owner (sender).

User id of the signer from the owner's organization.

UUID of a template from GET /v1/templates. Accepts both Common Paper standard templates and uploaded PDF templates (type uploaded_template). Required unless agreement_type is Amendment.

Set to Amendment to create an amendment without a template. Omit template_id, set agreement.negotiations_allowed, and set agreement.parent_agreement_id to the agreement being amended, or set agreement.underlying_agreement_type to description with agreement.underlying_agreement_val for an agreement outside Common Paper. Put the amendment terms in agreement.amendment_attributes.

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.

User id of the agreement owner (sender).

Email address of the signer from the owner's organization.

UUID of a template from GET /v1/templates. Accepts both Common Paper standard templates and uploaded PDF templates (type uploaded_template). Required unless agreement_type is Amendment.

Set to Amendment to create an amendment without a template. Omit template_id, set agreement.negotiations_allowed, and set agreement.parent_agreement_id to the agreement being amended, or set agreement.underlying_agreement_type to description with agreement.underlying_agreement_val for an agreement outside Common Paper. Put the amendment terms in agreement.amendment_attributes.

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.

User id of the agreement owner (sender).

User id of the signer from the owner's organization.

UUID of a template from GET /v1/templates. Accepts both Common Paper standard templates and uploaded PDF templates (type uploaded_template). Required unless agreement_type is Amendment.

Set to Amendment to create an amendment without a template. Omit template_id, set agreement.negotiations_allowed, and set agreement.parent_agreement_id to the agreement being amended, or set agreement.underlying_agreement_type to description with agreement.underlying_agreement_val for an agreement outside Common Paper. Put the amendment terms in agreement.amendment_attributes.

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.

The counterparty's full name.

The counterparty's email address.

The counterparty's organization.

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.

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.

The counterparty's job title.

The counterparty's street address.

The counterparty's city.

The counterparty's state or region.

The counterparty's postal code.

The counterparty's country.

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.

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.

The purpose of the agreement (NDA).

The length of the agreement term in years (NDA).

When true, the term runs perpetually and term is ignored (NDA).

How many years confidentiality obligations last (NDA).

When true, confidentiality obligations are perpetual (NDA).

When confidentiality obligations begin (NDA).

How the effective date is determined.

The effective date, when set explicitly.

The country whose laws govern the agreement.

The state or region whose laws govern the agreement.

The country in which disputes will be resolved.

The state or region in which disputes will be resolved.

The district or county for dispute resolution.

When true, additional_changes is included on the cover page.

Free-text changes shown on the cover page.

When true, message is sent with the agreement.

The message sent to the recipient.

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.

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.

How the agreement expires: "none" (default), "days" (use include_expiration_days), or "date" (use include_expiration_date).

Days until the agreement expires. Use with include_expiration_type "days".

Expiration date in YYYY-MM-DD format. Use with include_expiration_type "date".

When true, reminder emails are sent automatically.

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.

When true, your signer signs after the recipient.

When true, the standard terms are included with the agreement.

When true, the agreement is marked as sent outside the platform.

When true, marks the agreement as a test. Test agreements do not count against your monthly limit.

When true, enables a billing workflow after signing.

The type of billing workflow. Use "link" with payment_link_url, or "stripe" for Stripe-managed billing.

A payment URL shown to the recipient after signing. Requires include_billing_workflow and billing_workflow_type "link".

When true, payment reminder emails are sent automatically.

When true, billing_name and billing_email are included.

Name of the billing contact.

Email of the billing contact.

Email address for legal notices to your organization.

Email address for legal notices to the recipient.

How framework terms are specified. Use "new" for standard terms or "description" with framework_terms_description.

Custom framework terms description. Only used when framework_terms_type is "description".

The UUIDs of the attachments to include, from POST /v1/attachments. Replaces the current list.

The draft fields to change.

The draft fields to change.

The draft fields to change.

The draft fields to change.

The draft fields to change.

The draft fields to change.

The draft fields to change.

The draft fields to change.

The draft fields to change.

The draft fields to change.

The draft fields to change.

The draft fields to change.

A name for the custom template.

The YAML definition of the template's title, sections, and fields. Saved as the template's first version. See Custom Templates for the full YAML reference.

Email of the user in your organization recorded as the version's creator. Provide user_email or user_id.

ID of the user in your organization recorded as the version's creator. Provide user_email or user_id.

ID of custom terms in your organization to attach to the template. Agreements created from the template include those terms.

The new name for the custom template.

ID of custom terms in your organization to attach to the template, so agreements created from the template include those terms. Pass an empty string to unlink the terms, which is why this field is not constrained to the uuid format. Changing the terms publishes a new template version recording the change.

ID of the user in your organization to record as the publisher when a terms change publishes a new version. Optional; an id that does not identify a user in your organization returns 422.

The YAML definition for the new version. See Custom Templates for the full YAML reference.

Email of the user in your organization recorded as the version's creator. Provide user_email or user_id.

ID of the user in your organization recorded as the version's creator. Provide user_email or user_id.

A name for the custom terms.

The terms text, in markdown. Published as released version 1.

Use "text" with a JSON body. File terms are created with a multipart/form-data request instead; see the multipart request body.

Email of the user in your organization recorded as the version's creator. Provide user_email or user_id.

ID of the user in your organization recorded as the version's creator. Provide user_email or user_id.

The new name for the custom terms. Only the name can change here; the terms text changes by publishing a new version.

The terms text for the new version, in markdown.

Email of the user in your organization recorded as the version's creator. Provide user_email or user_id.

ID of the user in your organization recorded as the version's creator. Provide user_email or user_id.

The invitation to create.

Attributes for the API key to create. When authenticated via OAuth (including MCP), the key is created for the current user and user_id is not required.

The attachment to create. In multipart/form-data, send each field as attachment[pdf], attachment[name], attachment[description], and attachment[uploaded_by].

The attachment to create

The organization attributes to update. Only the fields you provide are changed; omitted fields keep their current values.

ID of an existing subprocessor to update or remove. Omit to add a new subprocessor.

Set to true with id to remove that subprocessor.

The UUID of the term record the agreement already owns. Required when updating a draft (PATCH /v1/agreements/{id}) and must match the id returned by GET /v1/agreements/{id}; the request is rejected otherwise. Not used when creating an agreement.

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.

ID of the CSA this DPA supplements when underlying_agreement_type is internal.

Description of the agreement this DPA supplements. Required when underlying_agreement_type is external.

Role of the data exporter. Overwritten to Controller when the agreement is created from a template.

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.

Where the Security Policy is defined. For external, set security_policy_available_at.

Which liability cap values apply: the _internal or _external amount fields. Required when include_liability_cap is true.

Currency amount. Numbers and numeric strings (commas allowed) are both accepted.

Currency amount. Numbers and numeric strings (commas allowed) are both accepted.

internal lists approved subprocessors in the agreement (subprocessors_attributes); external points to a list published elsewhere.

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.

The UUID of the term record the agreement already owns. Required when updating a draft (PATCH /v1/agreements/{id}) and must match the id returned by GET /v1/agreements/{id}; the request is rejected otherwise. Not used when creating an agreement.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

The UUID of the term record the agreement already owns. Required when updating a draft (PATCH /v1/agreements/{id}) and must match the id returned by GET /v1/agreements/{id}; the request is rejected otherwise. Not used when creating an agreement.

Whether to include a custom Scheduled Downtime description. When Target Uptime is included, at least one of include_sla_maintenance_window, include_sla_maintenance_notice or include_sla_maintenance_custom must be true. CSA 2.x and 3.x only. Default: false.

Custom Scheduled Downtime description (markdown). Rendered on its own when it is the only Scheduled Downtime option chosen, otherwise added as the last bullet of the Scheduled Downtime list. Blank renders nothing. CSA 2.x and 3.x only.

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.

Service credits. Use string keys such as "0", "1".

Use limitations. Use string keys such as "0", "1".

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.

The UUID of the term record the agreement already owns. Required when updating a draft (PATCH /v1/agreements/{id}) and must match the id returned by GET /v1/agreements/{id}; the request is rejected otherwise. Not used when creating an agreement.